Main Page   Alphabetical List   Data Structures   File List   Data Fields   Globals  

dt_stream_text.c File Reference

Go to the source code of this file.

Data Structures

struct  dt_reader_text
 Data stored by a text reader object. More...

struct  dt_writer_text
 Data stored by a text writer object. More...


Enumerations

enum  {
  eCommentMark = '#', ePasQuote = '\'', eArrayOpen = '(', eArrayClose = ')',
  eRecordOpen = '{', eRecordClose = '}', eKeyMark = ':'
}
 Special characters defining the structure of a PasText file. More...


Functions

dt_readerdt_create_text_reader (FILE *src, dt_text_mode_flags flags)
 Create a reader that will decode the condents of the specified file.

dt_writerdt_create_text_writer (FILE *dst, dt_text_mode_flags mode)
 Create a writer that will decode the condents of the specified file.


Enumeration Type Documentation

anonymous enum
 

Special characters defining the structure of a PasText file.

Enumeration values:
eCommentMark  Start of a comment extending to the end of the line.
ePasQuote  Start of a quoted string.
eArrayOpen  Start of an array of values.
eArrayClose  End of an array of values.
eRecordOpen  Start of record with key:value pairs.
eRecordClose  End of record with key:value pairs.
eKeyMark  Immediately follows a key, and separates it from the value.

Definition at line 11 of file dt_stream_text.c.


Function Documentation

dt_reader* dt_create_text_reader FILE *  src,
dt_text_mode_flags  mode
 

Create a reader that will decode the condents of the specified file.

The caller retains ownership of the source file handle (src), and is responsible for closing it after destruction of the reader object.

Note:
This reader object only checks the structure, not the syntax, of the input file. For most purposes, it is useful to filter its ouput using a stream validator (
See also:
dt_stream_validator).

Definition at line 56 of file dt_stream_text.c.

dt_writer* dt_create_text_writer FILE *  dst,
dt_text_mode_flags  mode
 

Create a writer that will decode the condents of the specified file.

The caller retains ownership of the output file handle (src), and is responsible for closing it after destruction of the writer object.

Definition at line 223 of file dt_stream_text.c.


Generated on Sun Jun 1 16:35:38 2003 for datatree by doxygen 1.3.1