File I/O utilities

Author(s): The CLIP Group.

Version: 1.11#222 (2004/5/24, 13:8:7 CEST)

Version of last change: 1.11#93 (2003/12/21, 2:30:33 CET)

This module implements the file I/O utilities.

• Usage and interface (file_utils)
• Documentation on exports (file_utils)

Usage and interface (file_utils)

Documentation on exports (file_utils)

PREDICATE: file_terms/2:

Usage 1: file_terms(File, Terms)

• Description: Transform a file File to/from a list of terms Terms.
• The following properties should hold upon exit: File is a source name. (streams_basic:sourcename/1) Terms is a list. (basic_props:list/1)
• The following properties should hold globally: File is not further instantiated. (basic_props:not_further_inst/2)

Usage 2: file_terms(File, Terms)

• Description: Unifies Terms with the list of all terms in File.
• The following properties should hold at call time: File is a source name. (streams_basic:sourcename/1) Terms is a free variable. (term_typing:var/1)
• The following properties should hold upon exit: File is a source name. (streams_basic:sourcename/1) Terms is a list. (basic_props:list/1)

Usage 3: file_terms(File, Terms)

• Description: Writes the terms in list Terms (including the ending '.') onto file File.
• The following properties should hold at call time: File is a source name. (streams_basic:sourcename/1) Terms is a list. (basic_props:list/1)
• The following properties should hold upon exit: File is a source name. (streams_basic:sourcename/1) Terms is a list. (basic_props:list/1)

PREDICATE: copy_stdout/1:

Usage: copy_stdout(File)

• Description: Copies file File to standard output.
• The following properties should hold at call time: File is currently a term which is not a free variable. (term_typing:nonvar/1)
• The following properties should hold upon exit: File is a source name. (streams_basic:sourcename/1)

PREDICATE: file_to_string/2:

Usage: file_to_string(FileName, String)

• Description: Reads all the characters from the file FileName and returns them in String.
• Call and exit should be compatible with: FileName is a source name. (streams_basic:sourcename/1) String is a string (a list of character codes). (basic_props:string/1)
• The following properties should hold at call time: FileName is currently a term which is not a free variable. (term_typing:nonvar/1) String is a free variable. (term_typing:var/1)

PREDICATE: stream_to_string/2:

Usage: stream_to_string(Stream, String)

• Description: Reads all the characters from Stream and returns them in String.
• Call and exit should be compatible with: Stream is an open stream. (streams_basic:stream/1) String is a string (a list of character codes). (basic_props:string/1)
• The following properties should hold at call time: Stream is currently a term which is not a free variable. (term_typing:nonvar/1) String is a free variable. (term_typing:var/1)

Go to the first, previous, next, last section, table of contents.