779347 - wrap OpenFile and ReadCompleteFile in a nice RAII interface

Status: RESOLVED FIXED

Description

[:Benjamin Peterson]

(Bug 779038 followup)

This patch provides a class that automatically handles the closing (or not closing of stdin) of FILE* jsapi creates.

Comment 1

[:Benjamin Peterson]

Created attachment 647749 [details] [diff] [review]
add FileWrapper

Comment 2

[Jim Blandy :jimb]

Comment on attachment 647749 [details] [diff] [review]
add FileWrapper

Review of attachment 647749 [details] [diff] [review]:
-----------------------------------------------------------------

Hurrah! Some comments; see what you think.

::: js/src/jsapi.cpp
@@ +5057,5 @@
>  
>      return true;
>  }
>  
> +class FileWrapper

It's my impression that classes intended mostly to guarantee cleanup from some local scope get names beginning with "Auto".

@@ +5085,5 @@
>   * Open a source file for reading. Supports "-" and NULL to mean stdin. The
>   * return value must be fclosed unless it is stdin.
>   */
> +static bool
> +OpenFile(JSContext *cx, const char *filename, FileWrapper &fw)

I think OpenFile would work nicely as a member function of FileWrapper.

@@ +5669,5 @@
> +    {
> +        FileWrapper fw;
> +        if (!OpenFile(cx, filename, fw))
> +            return NULL;
> +        bool ok = fw.readAll(cx, buffer);

There's no need for 'ok' any more, since the fclose is gone.

Comment 3

[:Benjamin Peterson]

I
- zapped ok
- renamed FileWrapper -> AutoFile
- OpenFile -> AutoFile::open

https://hg.mozilla.org/integration/mozilla-inbound/rev/162b401d8774

Comment 4

[Jim Blandy :jimb]

Yeah, that's the stuff.

Comment 5

[Ed Morley [:emorley]]

https://hg.mozilla.org/mozilla-central/rev/162b401d8774