TekFileASCIIBare Class Reference

Inheritance diagram for TekFileASCIIBare:

Inheritance graph
[legend]
Collaboration diagram for TekFileASCIIBare:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TekFileASCIIBare ()
 ~TekFileASCIIBare ()
virtual TEKERR ReadLine (uchar_t **Buffer, unsigned long ReadMax)
virtual TEKERR WriteLine (const uchar_t *Buffer)
virtual TEKERR Close ()
virtual TEKERR Flush ()
virtual TEKERR get_FILE (FILE **FileDescriptor)
virtual TEKERR get_Filename (uchar_t **Name)
virtual TEKERR get_Mode (TekFileMode *ModeID)
virtual TEKERR get_Type (TekFileType *FileTypePointer)
virtual TEKERR Open ()
virtual TEKERR Open64 ()
virtual TEKERR put_FILE (FILE *FileDescriptor)
virtual TEKERR put_Filename (uchar_t *Name)
virtual TEKERR put_Mode (TekFileMode ModeID)
virtual TEKERR Read64 (void *Buffer, uint64_t BytesToRead, uint64_t *BytesRead)
virtual TEKERR Read (void *Buffer, unsigned long BytesToRead, unsigned long *BytesRead)
virtual TEKERR Seek64 (TekFileSeek SeekWhere, int64_t NewLocation)
virtual TEKERR Seek (TekFileSeek SeekWhere, signed long NewLocation)
virtual TEKERR Write64 (void *Buffer, uint64_t BytesToWrite, uint64_t *BytesWrote)
virtual TEKERR Write (void *Buffer, unsigned long BytesToWrite, unsigned long *BytesWrote)
virtual TEKERR get_Location (unsigned long *Location)
virtual TEKERR get_Location64 (uint64_t *Location)

Public Attributes

 TEKSTD_HEADER_VARS

Detailed Description

This is the bare-bones implementation of reading and writing ASCII files.

This interface is FINAL.

Author:
Kevin McBride

Definition at line 38 of file tekfileasciibare.h.


Constructor & Destructor Documentation

TekFileASCIIBare TekFileASCIIBare  ) 
 

Instantizer.

Definition at line 43 of file TekFileASCIIBare.cpp.

~TekFileASCIIBare  ) 
 

Destructor.

Definition at line 72 of file TekFileASCIIBare.cpp.


Member Function Documentation

TEKERR Close  )  [virtual]
 

Closes the file.

Implements TekFileASCII.

Definition at line 451 of file TekFileASCIIBare.cpp.

TEKERR Flush  )  [virtual]
 

Flushes the buffer.

Implements TekFileASCII.

Definition at line 505 of file TekFileASCIIBare.cpp.

TEKERR get_FILE FILE **  FileDescriptor  )  [virtual]
 

Obtains the handle used to access the open file.

Implements TekFileASCII.

Definition at line 343 of file TekFileASCIIBare.cpp.

TEKERR get_Filename uchar_t **  Name  )  [virtual]
 

Obtains the filename in the form of a uchar.

Implements TekFileASCII.

Definition at line 361 of file TekFileASCIIBare.cpp.

TEKERR get_Location unsigned long *  Location  )  [virtual]
 

Retrieves the location.

Implements TekFileASCII.

Definition at line 823 of file TekFileASCIIBare.cpp.

TEKERR get_Location64 uint64_t *  Location  )  [virtual]
 

Retrieves the location and stores it in a 64-bit variable.

Implements TekFileASCII.

Definition at line 859 of file TekFileASCIIBare.cpp.

TEKERR get_Mode TekFileMode *  ModeID  )  [virtual]
 

Retrieves the mode currently set.

Implements TekFileASCII.

Definition at line 487 of file TekFileASCIIBare.cpp.

TEKERR get_Type TekFileType *  FileTypePointer  )  [virtual]
 

Gets the file type.

Implements TekFileASCII.

Definition at line 429 of file TekFileASCIIBare.cpp.

TEKERR Open  )  [virtual]
 

Open the file.

Implements TekFileASCII.

Definition at line 539 of file TekFileASCIIBare.cpp.

TEKERR Open64  )  [virtual]
 

Open the file using 64 bit semantics.

Implements TekFileASCII.

Definition at line 590 of file TekFileASCIIBare.cpp.

TEKERR put_FILE FILE *  FileDescriptor  )  [virtual]
 

Sets the handle used to access a file.

WARNING!!!!! DO NOT USE THE FILE DESCRIPTOR YOU PASS IN
TO THIS FUNCTION UNLESS YOU HAVE RE-RETRIEVED IT USING
TekFileASCIIBare::get_FILE()! Utilizing the descriptor in a direct fashion after a
successful call to put_FILE() will result in undefined results!!!!!

Implements TekFileASCII.

Definition at line 398 of file TekFileASCIIBare.cpp.

TEKERR put_Filename uchar_t Name  )  [virtual]
 

Sets the filename to access.

Implements TekFileASCII.

Definition at line 411 of file TekFileASCIIBare.cpp.

References _uchar_t::uchar_t_ascii.

TEKERR put_Mode TekFileMode  ModeID  )  [virtual]
 

Sets the mode used to open the file.

Implements TekFileASCII.

Definition at line 647 of file TekFileASCIIBare.cpp.

TEKERR Read void *  Buffer,
unsigned long  BytesToRead,
unsigned long *  BytesRead
[virtual]
 

Read from the file.

Implements TekFileASCII.

Definition at line 675 of file TekFileASCIIBare.cpp.

TEKERR Read64 void *  Buffer,
uint64_t  BytesToRead,
uint64_t *  BytesRead
[virtual]
 

Read from the file using 64 bit semantics.

Implements TekFileASCII.

Definition at line 664 of file TekFileASCIIBare.cpp.

TEKERR ReadLine uchar_t **  Buffer,
unsigned long  ReadMax
[virtual]
 

Reads up to ReadMax characters from a file and puts it in a uchar_t. The Buffer can be an already-created uchar_t, or can be a pointer to a uchar_t* to store the new uchar_t in.

NOTE: It is best to let this function create a uchar_t for your program/library to read from. The uchar_t passed in must be at least TEKFILEASCII_STDBUFLEN + 1 bytes long. This is for optimization reasons, so it is best to use only uchar_t's that were created from this function.

Implements TekFileASCII.

Definition at line 107 of file TekFileASCIIBare.cpp.

References _uchar_t::uchar_t_ascii, and _uchar_t::uchar_t_asciilen.

TEKERR Seek TekFileSeek  SeekWhere,
signed long  NewLocation
[virtual]
 

Seek to another position of the file.

Implements TekFileASCII.

Definition at line 728 of file TekFileASCIIBare.cpp.

TEKERR Seek64 TekFileSeek  SeekWhere,
int64_t  NewLocation
[virtual]
 

Seek to another position of the file using 64 bit semantics.

Implements TekFileASCII.

Definition at line 717 of file TekFileASCIIBare.cpp.

TEKERR Write void *  Buffer,
unsigned long  BytesToWrite,
unsigned long *  BytesWrote
[virtual]
 

Write to the file.

Implements TekFileASCII.

Definition at line 775 of file TekFileASCIIBare.cpp.

TEKERR Write64 void *  Buffer,
uint64_t  BytesToWrite,
uint64_t *  BytesWrote
[virtual]
 

Write to the file using 64 bit semantics.

Implements TekFileASCII.

Definition at line 764 of file TekFileASCIIBare.cpp.

TEKERR WriteLine const uchar_t Buffer  )  [virtual]
 

Writes a ascii-part of a uchar_t to the file.

WARNING! On Intel platforms, this function may utilize MMX for optimization purposes! Register mm6 can be modified by this function!

Implements TekFileASCII.

Definition at line 289 of file TekFileASCIIBare.cpp.

References _uchar_t::uchar_t_ascii.


Member Data Documentation

TEKSTD_HEADER_VARS
 

This macro contains the generic implementation for TekStd.
It is much easier to use as opposed to creating the
implementation by hand.

Reimplemented from TekFileASCII.

Definition at line 76 of file tekfileasciibare.h.


The documentation for this class was generated from the following files: SourceForge.net Logo  Technical Library Template Interface Project Page