File object

Getting Started

In order to use the File object from your JavaScript programs, you must enable it by setting the make variable JS_HAS_FILE_OBJECT during the compilation of your Spidermonkey engine.

If you are building a standalone version of Spidermonkey (see: SpiderMonkey Build Documentation), this variable can be added on the make command line, like so:

cd mozilla/js/src
make -f Makefile.ref JS_HAS_FILE_OBJECT=1

Alternatively, if you are building a larger product (such as a browser) and want to include the File object, you may need to perform minor Makefile surgery.

Summary

Non-Standard Server-Side Object

This object lets you work files and directories on the local filesystem, and create OS pipelines. Creating a pipeline involves spawning arbitrary processes; this means that giving a script access to the File object is exactly equivalent to giving the script access to the UNIX shell or DOS command interpreter.

Filesystem access is implemented with NSPR I/O Functions, and as such shares many semantics. Pipelines are implemented with the popen() system call. There is currently no support for p2open()-like semantics.

Here is the original proposal for this object, and a status update from December 1998: http://www.mozilla.org/js/js-file-object.html

Created By

The File constructor:

new File();
new File(filename);

Parameters

filename

Name of the file we want to work with. Directories and pipelines are considered special files. Pipelines either begin or end with the pipe (|) symbol.

Description

Filenames are specified as strings that have an implementation defined format. Use of standard "file:" URLs is encouraged. If no argument is supplied to the constructor, the current working directory is the file object that is returned.

Examples of possible prefix strings are "/" to indicate the Unix root directory, "c:" to specify a Windows drive letter, and "file:" to indicate a file URL.

When a file is constructed, leading and trailing spaces are removed from the filename, so new File(" abc.txt      ") just creates a file called abc.txt. Filenames starting and ending with the pipe symbol (|) are interpreted as pipes. Readable pipelines (i.e. pipe to programs generating output on stdout) begin with the pipe symbol; writeable pipelines end with the pipe symbol. Bi-directional pipelines are not supported.

Properties

Static Properties

input a File object that represents the standard input (stdin).

currentDir a File object that represents the standard output (stdout).

currentDir a File object that represents the standard error (stderr).

currentDir a File object referring to the current directory; this property may be set.

separator the system name separator (slash on UNIX).

Instance Properties

length the length of the file in bytes, or the number of entries in the directory. Note: calculating the length of the directory is very expensive.

parent the directory containing the file.

path the canonical path to the file.

name the name of the file.

isDirectory true if the file is a directory.

isFile true if the file is a file.

exists true if the file exists.

canRead true if the file can be read.

canWrite true if the file can be written.

canAppend true if the file is in append mode.

canReplace true if the file is in replace mode.

isOpen true if the file is open.

type a string specifying the type of data or encoding contained in the file. Currently "ascii" (ASCII), "binary" (UTF-8) or "unicode" (UCS-2). (XXX Note -- ASCII might imply ASCIIZ)

mode a string describing the mode used to open the file.

creationTime a Date object representing the time when the file was created.

lastModified a Date object representing the time when the file was last modified.

size the length of the file in bytes; undefined(?) for directories and pipelines.

hasRandomAccess true if random access is supported for this file. Binary (UTF-8) files and pipelines (including File.intput) do not support random access.

hasAutoFlush force a flush on each line break? (readonly)

position The file position. Writing to the property moves the file pointer.

isNative True if the file is backed by a native stdio FILE stream. (i.e. file.input, file.output, file.error or a pipeline)

Methods

open Opens the file, specifying file mode and type.

close Closes the file.

remove Removes the file, provided it is not open.

copyTo Creates a verbatim copy of the file at a new location.

renameTo Removes the file.

flush Flushes the operating system's write buffers for the file and blocks until any pending data has been committed to disk.

seek Moves the file position pointer forward or backwards.

read Read a fixed number of bytes from the file.

readln Read line from the file.

readAll Read the entire file in, returning an array of lines.

write Write bytes to the file.

writeln Write bytes to the file, followed by a line separator, flushing the buffer if file.hasAutoflush.

writeAll Writes an array of lines to the file, obeying the same semantics as writeln.

list Get a list of files, potentially matching a regular expression filter, from the file. Only has meaning when the file is a directory.

mkdir Create a directory. Directory will be created in the same directory as the file, unless the file is a directory, in which case, the directory will be created in that directory. XXX

toString Returns the canonical path to the file.

toURL Returns a file:// URL describing the file relative to the local file system. URL is URI-encoded.

Examples

Example: Hello, world

File.output.writeln("Hello, world");

Example: Writing a new file

var file = new File("myfile.txt");
file.open("write,create", "text");
file.writeln("The quick brown fox jumped over the lazy dogs");
file.close();

Example: Reading from a file

var data; 
var file = new File("myfile.txt");
file.open("read", "text");
data = file.readln();
file.close(); 

Example: Sending mail through a pipeline

var mail = new File("|/usr/lib/sendmail foo@bar.com");
mail.writeln("I love JavaScript.\nPipe support is especially good!");
mail.close();