File Class Reference

#include <File.h>

Collaboration diagram for File:

Public Member Functions
	File ()
	File (const char *filename, const char *mode)
	~File ()
bool	open (const char *filename, const char *mode)
bool	seek (long offset)
int	get ()
bool	put (int c)
std::string	getline (bool strip_crlf=false)
bool	next_line (std::string &line, bool strip_crlf)
bool	enum_lines (bool(*callback)(const std::string &line, int line_number, long lparam), long lparam, bool strip_crlf)
bool	read (void *data, unsigned len)
bool	write (const void *data, unsigned len)
size_t	length ()
void	close ()
bool	isopened ()
bool	eof ()
FILE *	operator* ()

Static Public Member Functions
static bool	LoadIntoString (std::string &s, const char *filename)
static bool	SaveFromString (const char *filename, const std::string &s, bool binary)

Private Member Functions
	File (const File &)
const File &	operator= (const File &)

Private Attributes
FILE *	_f

Detailed Description

Definition at line 15 of file File.h.

Constructor & Destructor Documentation

File() [1/3]

File::File ( )

inline

Definition at line 18 of file File.h.

           : _f(0)
    {
    }

Referenced by CCabinet::ExtractFile(), FatDeferredFlush(), CCabinet::GetAbsoluteOffset(), CCabinet::GetAttributesOnFile(), CCabinet::GetFileTimes(), CCabinet::ReadFileTable(), and CCabinet::WriteFileEntries().

File() [2/3]

File::File ( const char *  filename, const char *  mode  )

inline

Definition at line 22 of file File.h.

                                                    : _f(0)
    {
        open ( filename, mode );
    }

~File()

File::~File ( )

inline

Definition at line 27 of file File.h.

    {
        close();
    }

File() [3/3]

File::File ( const File &  )

inlineprivate

Definition at line 105 of file File.h.

{}

Member Function Documentation

close()

void File::close

(

)

Definition at line 99 of file File.cpp.

{
    if ( _f )
    {
        fclose(_f);
        _f = 0;
    }
}

Referenced by close(), open(), QMyDialog::SaveClicked(), and ~File().

enum_lines()

bool File::enum_lines	(	bool(*)(const std::string &line, int line_number, long lparam)	callback,
		long	lparam,
		bool	strip_crlf
	)

Definition at line 69 of file File.cpp.

{
    int line_number = 0;
    for ( ;; )
    {
        std::string s = getline(strip_crlf);
        line_number++;
        if ( !s.size() )
        {
            if ( eof() )
                return true;
            else
                continue;
        }
        if ( !(*callback) ( s, line_number, lparam ) )
            return false;
    }
}

Referenced by enum_lines().

eof()

bool File::eof ( )

inline

Definition at line 91 of file File.h.

    {
        return feof(_f) ? true : false;
    }

Referenced by enum_lines(), and next_line().

get()

int File::get ( )

inline

Definition at line 39 of file File.h.

    {
        return fgetc ( _f );
    }

getline()

std::string File::getline

(

bool

strip_crlf = false

)

Definition at line 17 of file File.cpp.

{
    std::string s = "";
    char buf[256];
    for ( ;; )
    {
        *buf = 0;
        fgets ( buf, sizeof(buf)-1, _f );
        if ( !*buf )
            break;
        s += buf;
        if ( strchr ( "\r\n", buf[strlen(buf)-1] ) )
            break;
    }
    if ( strip_crlf )
    {
        char* p = strpbrk ( &s[0], "\r\n" );
        if ( p )
        {
            *p = '\0';
            s.resize ( p-&s[0] );
        }
    }
    return s;
}

Referenced by getline().

isopened()

bool File::isopened ( )

inline

Definition at line 86 of file File.h.

    {
        return _f != 0;
    }

length()

size_t File::length

(

)

Definition at line 88 of file File.cpp.

{
#ifdef WIN32
    return _filelength ( _fileno(_f) );
#elif defined(UNIX)
    struct stat file_stat;
    verify(fstat(fileno(_f), &file_stat) == 0);
    return file_stat.st_size;
#endif
}

Referenced by CCabinet::GetAttributesOnFile(), CCabinet::GetFileTimes(), and length().

LoadIntoString()

bool File::LoadIntoString ( std::string &  s, const char *  filename  )

static

Definition at line 108 of file File.cpp.

{
    File in ( filename, "rb" );
    if ( !in.isopened() )
        return false;
    size_t len = in.length();
    s.resize ( len + 1 );
    if ( !in.read ( &s[0], len ) )
        return false;
    s[len] = '\0';
    s.resize ( len );
    return true;
}

Referenced by LoadIntoString().

next_line()

bool File::next_line	(	std::string &	line,
		bool	strip_crlf
	)

Definition at line 47 of file File.cpp.

{
    line = getline(strip_crlf);
    // indicate that we're done *if*:
    // 1) there's no more data, *and*
    // 2) we're at the end of the file
    return line.size()>0 || !eof();
}

Referenced by next_line().

open()

bool File::open	(	const char *	filename,
		const char *	mode
	)

Definition at line 10 of file File.cpp.

{
    close();
    _f = fopen ( filename, mode );
    return _f != 0;
}

Referenced by generate_random(), open(), QMyDialog::QMyDialog(), and QMyDialog::SaveClicked().

operator*()

FILE * File::operator* ( )

inline

Definition at line 96 of file File.h.

    {
        return _f;
    }

operator=()

const File & File::operator= ( const File &  )

inlineprivate

Definition at line 106 of file File.h.

{ return *this; }

put()

bool File::put ( int  c )

inline

Definition at line 44 of file File.h.

    {
        return fputc ( c, _f ) != EOF;
    }

read()

bool File::read ( void *  data, unsigned  len  )

inline

Definition at line 72 of file File.h.

    {
        return len == fread ( data, 1, len, _f );
    }

SaveFromString()

bool File::SaveFromString ( const char *  filename, const std::string &  s, bool  binary  )

static

Definition at line 122 of file File.cpp.

{
    File out ( filename, binary ? "wb" : "w" );
    if ( !out.isopened() )
        return false;
    out.write ( s.c_str(), s.size() );
    return true;
}

Referenced by SaveFromString().

seek()

bool File::seek ( long  offset )

inline

Definition at line 34 of file File.h.

    {
        return !fseek ( _f, offset, SEEK_SET );
    }

write()

bool File::write ( const void *  data, unsigned  len  )

inline

Definition at line 77 of file File.h.

    {
        return len == fwrite ( data, 1, len, _f );
    }

Member Data Documentation

_f

FILE* File::_f

private

Definition at line 108 of file File.h.

Referenced by close(), eof(), get(), getline(), isopened(), length(), open(), operator*(), put(), read(), seek(), and write().

---

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

• modules/rosapps/applications/sysutils/utils/sdkparse/File.h
• modules/rosapps/applications/sysutils/utils/sdkparse/File.cpp