tTextFileRecorder Class Reference

text file loading recorder More...

#include <tRecorder.h>

Inheritance diagram for tTextFileRecorder:

[legend]

Collaboration diagram for tTextFileRecorder:

[legend]

List of all members.

Public Member Functions
	tTextFileRecorder ()
	~tTextFileRecorder ()
bool	Open (tPath const &searchPath, char const *fileName)
	opens a text file for reading
	tTextFileRecorder (tPath const &searchPath, char const *fileName)
	constructor, opening a file directly (status can be queried later with EndOfFile)
bool	EndOfFile () const
	end of file query
std::string	GetLine ()
	read one line, give it back as a stream
Private Member Functions
	tTextFileRecorder (tTextFileRecorder const &)
tTextFileRecorder &	operator= (tTextFileRecorder const &)
Private Attributes
std::ifstream *	stream_
bool	eof_
	the real stream to read from

---

Detailed Description

text file loading recorder

Definition at line 134 of file tRecorder.h.

---

Constructor & Destructor Documentation

tTextFileRecorder::tTextFileRecorder

(

void

)

Definition at line 687 of file tRecorder.cpp.

References NULL, and stream_.

        : stream_(NULL), eof_(false)
{
    stream_ = NULL;
}

tTextFileRecorder::~tTextFileRecorder

(

void

)

Definition at line 702 of file tRecorder.cpp.

References NULL, and stream_.

{
    delete stream_;
    stream_ = NULL;
}

tTextFileRecorder::tTextFileRecorder	(	tPath const &	searchPath,
		char const *	fileName
	)

constructor, opening a file directly (status can be queried later with EndOfFile)

Parameters:

	searchPath	the path to search for the file
	fileName	the name of the file to open

Definition at line 672 of file tRecorder.cpp.

References Open().

        : stream_(NULL), eof_(false)
{
    Open( searchPath, fileName );
}

Here is the call graph for this function:

tTextFileRecorder::tTextFileRecorder

(

tTextFileRecorder const &

)

[private]

---

Member Function Documentation

bool tTextFileRecorder::Open	(	tPath const &	searchPath,
		char const *	fileName
	)

opens a text file for reading

Parameters:

	searchPath	the path to search for the file
	fileName	the name of the file to open

Returns:

true if opening succeeded

Definition at line 642 of file tRecorder.cpp.

References eof_, tPath::Open(), tRecorder::Playback(), tRecorder::Record(), st_fileOpen, stream_, tASSERT, and tNEW.

Referenced by tTextFileRecorder().

{
    tASSERT( !stream_ );

    bool result = false;

    // try to read opening state from recording
    if ( !tRecorder::Playback( st_fileOpen, result, eof_ ) )
    {
        // open the stream (if not in recording mode)
        stream_ = tNEW( std::ifstream );
        result = searchPath.Open( *stream_, fileName );
        eof_ = !result || !stream_->good() || stream_->eof();
    }
    tRecorder::Record( st_fileOpen, result, eof_ );

    return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tTextFileRecorder::EndOfFile

(

void

)

const

end of file query

Returns:

true if the end of file (or any other error that has the same effect) has been reached

Definition at line 718 of file tRecorder.cpp.

References eof_.

Referenced by uMenuItemStringWithHistory::history_t::history_t(), and gAICharacter::LoadAll().

{
    return eof_;
}

Here is the caller graph for this function:

std::string tTextFileRecorder::GetLine

(

void

)

read one line, give it back as a stream

Returns:

the line read from the file or a recording thereof

Definition at line 733 of file tRecorder.cpp.

References eof_, tRecorder::Playback(), tString::ReadLine(), tRecorder::Record(), st_fileRead, stream_, and tASSERT.

Referenced by uMenuItemStringWithHistory::history_t::history_t(), and gAICharacter::LoadAll().

{
    // try to read opening state from recording
    tLineString line;
    if ( !tRecorder::Playback( st_fileRead, line, eof_ ) )
    {
        // read a line
        tASSERT( stream_ );
        line.ReadLine( *stream_ );
        std::ws( *stream_ );
        eof_ = !stream_->good() || stream_->eof();
    }
    tRecorder::Record( st_fileRead, line, eof_ );

    // convert and return read line
    return std::string(line);
}

Here is the call graph for this function:

Here is the caller graph for this function:

tTextFileRecorder& tTextFileRecorder::operator=

(

tTextFileRecorder const &

)

[private]

---

Member Data Documentation

std::ifstream* tTextFileRecorder::stream_ [private]

Definition at line 156 of file tRecorder.h.

Referenced by GetLine(), Open(), tTextFileRecorder(), and ~tTextFileRecorder().

bool tTextFileRecorder::eof_ [private]

the real stream to read from

Definition at line 157 of file tRecorder.h.

Referenced by EndOfFile(), GetLine(), and Open().

---

The documentation for this class was generated from the following files:

• src/tools/tRecorder.h
• src/tools/tRecorder.cpp

---