1.59.1 Instance variables

file <-> bom: [bool]

BOM (Byte Order Mark) handling of the file. Initial @default. If the file is opened for reading in text-mode and file<-bom is not @off, the file is checked for a UNICODE BOM signature. If found, file<-bom is set to @on and the source_sink<-encoding is set accordingly.

If the file is opened for writing and file<-bom = @on and the encoding is a UNICODE encoding, a BOM marker is written to the file.

Note that this default behaviour returns consistent results on the sequence below. If a BOM is detected on reading, one will be added on writing the file and the encoding of the file will not be changed.

send(View, load, File),
...
send(View, save).

file-fd: alien:FILE *

Pointer to the C stream associated to this file.

file <-> filter: command=name*

Name of the filter used as input- or output filter. See file->open for details.

See also

file->open

file <- name: name=name

Name of the (Unix) file. Filled from the first argument of file->initialise . When the name is changed and the file already exists, the Unix file is renamed accordingly. file->name cannot move files across file-systems.

See also

- file<-base_name
- file<-directory_name
- file->name

file <-> newline_mode: {posix,dos,detect}

Defines newline representation similar to SWI-Prolog's newline property on streams. In read mode, posix read untranslated. Both dos and detect delete \r from the input. The detect mode sets the mode of the file to dos or posix. In write mode posix does not perform translation, while dos emits \n as \r\n.

BUG: detection is only provided by text_buffer->insert_file.

file <-> path: path=[name]

This variable holds the full path name of the file after file->absolute_path or file->find.

The Unix file opened is the name of this variable when not @default and file<-name after expansion of _~_ and $var constructs if this variable holds @default

file <- status: {closed,read,write,tmp_write}

Current status of the file:

closed

Currently not open (-fd is 0). See file->close.

read

Currently open for reading. See file->open.

write

Currently open for writing. May be opened write or append. See file->open.