/*
! ** The is a simple class to read the contents of a file and will also handle
! ** any '#include' references found in the file.

! ** @Constructor Open the specified file for reading and start a counter to
! ** keep track of the number of INLCUDE files that are referenced.  The
! ** %PvxClass(path_resolver)% object will be used to expand the name of each
! ** INCLUDE file.
! ** @param inFile$ The name of file to read
! ** @param inPathResolver A reference to an instance of a %PvxClass(path_resolver)% class
! ** @param + used to expand the name of include files.
 */
def class "file_reader"
    ! ** @TYPE Reference to %PvxClass(obj_tracker)%
    property aTracker

    ! ** Get the end of file status
    ! ** @returns A boolean that is set to TRUE (1) when end of data stream has been reached.
    function getEOF()                                getEOF

    ! ** Read a line of text from the file.
    ! ** @Returns A string containing the text that was retrieved
    function read$()                                readLine

    ! ** Set a flag to disable processing of '#include' references
    ! ** @param inBoolean  (0=False, 1=True)
    function setIgnoreIncludes(inBoolean)            setIgnoreIncludes

    ! ** Get the next line from the text file; strip any $0D$ from line
    function local readRecord(aRec$)                getLine
end def