librevenge::DirEntry Class Reference

Public Types
enum	{ End = 0xffffffff }

Public Member Functions
	DirEntry ()
	constructor
bool	is_dir () const
	returns true for a directory
std::string	name () const
	returns the simplified file name
std::string const &	filename () const
	returns the string which was store inside the file.
void	setName (std::string const &nm)
	sets the file name
void	load (unsigned char *buffer, unsigned len)
	reads a entry content in buffer
void	save (unsigned char *buffer) const
	saves a entry content in buffer *‍/

Static Public Member Functions
static unsigned	saveSize ()
	returns space required to save a dir entry

Public Attributes
bool	m_valid
bool	m_macRootEntry
	false if invalid (should be skipped)
unsigned	m_type
	true if this is a classic mac directory entry
unsigned	m_colour
	the type
unsigned long	m_size
	the red/black color: 0 means red
unsigned long	m_start
	size (not valid if directory)
unsigned	m_right
	starting block
unsigned	m_left
	previous sibling
unsigned	m_child
	next sibling
DirInfo	m_info
	first child

Protected Attributes
std::string	m_name
	the file information

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
End

Constructor & Destructor Documentation

DirEntry()

librevenge::DirEntry::DirEntry ( )

inline

constructor

Referenced by load().

Member Function Documentation

filename()

std::string const & librevenge::DirEntry::filename ( ) const

inline

returns the string which was store inside the file.

Note

: either name() or a index (unknown) followed by name()

Referenced by librevenge::DirTree::getSubStreamList().

is_dir()

bool librevenge::DirEntry::is_dir ( ) const

inline

returns true for a directory

Referenced by librevenge::IStream::createOleFromDirectory(), librevenge::DirTree::getSubStreamList(), and librevenge::IStorage::isSubStream().

load()

void librevenge::DirEntry::load	(	unsigned char *	buffer,
		unsigned	len )

reads a entry content in buffer

Referenced by librevenge::DirTree::load().

name()

std::string librevenge::DirEntry::name ( ) const

inline

returns the simplified file name

Referenced by librevenge::DirTree::find_child(), and librevenge::DirTree::CompareEntryName::operator()().

save()

void librevenge::DirEntry::save

(

unsigned char *

buffer

)

const

saves a entry content in buffer *‍/

Referenced by librevenge::DirTree::save().

saveSize()

unsigned librevenge::DirEntry::saveSize ( )

inlinestatic

returns space required to save a dir entry

Referenced by librevenge::DirTree::save(), and librevenge::DirTree::saveSize().

setName()

void librevenge::DirEntry::setName ( std::string const & nm )

inline

sets the file name

Referenced by librevenge::DirTree::index().

Member Data Documentation

m_child

unsigned librevenge::DirEntry::m_child

next sibling

Referenced by librevenge::IStream::createOleFromDirectory(), DirEntry(), librevenge::DirTree::find_child(), librevenge::DirTree::getSubStreamList(), load(), save(), and librevenge::DirTree::setInRedBlackTreeForm().

m_colour

unsigned librevenge::DirEntry::m_colour

the type

Referenced by DirEntry(), load(), save(), librevenge::DirTree::setInRBTForm(), and librevenge::DirTree::setInRedBlackTreeForm().

m_info

DirInfo librevenge::DirEntry::m_info

first child

Referenced by librevenge::IStream::createOleFromDirectory(), DirEntry(), load(), save(), and librevenge::OStorage::setInformation().

m_left

unsigned librevenge::DirEntry::m_left

previous sibling

Referenced by DirEntry(), librevenge::DirTree::get_siblings(), librevenge::DirTree::index(), load(), save(), and librevenge::DirTree::setInRBTForm().

m_macRootEntry

bool librevenge::DirEntry::m_macRootEntry

false if invalid (should be skipped)

Referenced by DirEntry(), load(), and save().

m_name

std::string librevenge::DirEntry::m_name

protected

the file information

Referenced by DirEntry(), filename(), load(), name(), save(), and setName().

m_right

unsigned librevenge::DirEntry::m_right

starting block

Referenced by DirEntry(), librevenge::DirTree::get_siblings(), load(), save(), and librevenge::DirTree::setInRBTForm().

m_size

unsigned long librevenge::DirEntry::m_size

the red/black color: 0 means red

Referenced by librevenge::OStorage::addStream(), librevenge::IStream::createOleFromDirectory(), DirEntry(), load(), save(), and librevenge::OStorage::updateToSave().

m_start

unsigned long librevenge::DirEntry::m_start

size (not valid if directory)

Referenced by librevenge::OStorage::addStream(), DirEntry(), load(), save(), and librevenge::OStorage::updateToSave().

m_type

unsigned librevenge::DirEntry::m_type

true if this is a classic mac directory entry

Referenced by librevenge::OStorage::addDirectory(), DirEntry(), librevenge::DirTree::index(), is_dir(), load(), and save().

m_valid

bool librevenge::DirEntry::m_valid

Referenced by librevenge::IStream::createOleFromDirectory(), DirEntry(), librevenge::DirTree::find_child(), librevenge::DirTree::getSubStreamList(), librevenge::DirTree::index(), load(), and librevenge::DirTree::setInRedBlackTreeForm().

---

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

• RVNGOLEStream.cpp