RagTime5Zone Class Reference

main zone in a RagTime v5-v6 document More...

#include <RagTime5StructManager.hxx>

Public Member Functions

 RagTime5Zone (MWAWInputStreamPtr const &input, libmwaw::DebugFile &asc)
 constructor
 
virtual ~RagTime5Zone ()
 destructor
 
std::string getZoneName () const
 returns the zone name
 
std::string getKindLastPart (bool main=true) const
 returns the main type
 
MWAWInputStreamPtr getInput ()
 returns the current input
 
void setInput (MWAWInputStreamPtr const &input)
 reset the current input
 
bool isMainInput () const
 returns true if the input correspond to the basic file
 
libmwaw::DebugFileascii ()
 returns the current ascii file
 
void setAsciiFileName (std::string const &name)
 defines the ascii name
 
void createAsciiFile ()
 creates the ascii file
 
void addErrorInDebugFile (std::string const &zoneName)
 mark a zone as bad
 

Public Attributes

int m_level
 the zone level
 
std::string m_parentName
 the parent name
 
long m_defPosition
 the position of the definition in the main zones
 
std::string m_kinds [2]
 the zone types: normal and packing
 
MWAWEntry m_entry
 the zone entry
 
std::string m_name
 the zone name ( mainly used for debugging)
 
bool m_hiLoEndian
 true if the endian is hilo
 
int m_ids [3]
 the zone id
 
int m_idsFlag [3]
 the zone flag
 
std::vector< MWAWEntrym_entriesList
 the list of original entries
 
std::map< int, std::shared_ptr< RagTime5Zone > > m_childIdToZoneMap
 the child zones
 
int m_variableD [2]
 the content of the zone D if it exists
 
bool m_isInitialised
 a flag to know if the zone is initialised (stream, hiLoEndian)
 
bool m_isParsed
 a flag to know if the zone is parsed
 
std::string m_extra
 extra data
 

Protected Attributes

MWAWInputStreamPtr m_input
 the main input
 
MWAWInputStreamPtr m_defaultInput
 the main file input
 
std::string m_asciiName
 the ascii file name ( used if we need to create a ascii file)
 
libmwaw::DebugFilem_asciiFile
 the ascii file corresponding to an input
 
libmwaw::DebugFilem_mainAsciiFile
 the main ascii file (used to print error)
 
std::shared_ptr< libmwaw::DebugFilem_localAsciiFile
 the local ascii file ( if we need to create a new input)
 

Private Member Functions

 RagTime5Zone (RagTime5Zone const &orig)=delete
 
RagTime5Zoneoperator= (RagTime5Zone const &orig)=delete
 

Friends

std::ostream & operator<< (std::ostream &o, RagTime5Zone const &z)
 operator<<
 

Detailed Description

main zone in a RagTime v5-v6 document

Constructor & Destructor Documentation

◆ RagTime5Zone() [1/2]

RagTime5Zone::RagTime5Zone ( MWAWInputStreamPtr const &  input,
libmwaw::DebugFile asc 
)
inline

constructor

◆ ~RagTime5Zone()

RagTime5Zone::~RagTime5Zone ( )
virtual

destructor

◆ RagTime5Zone() [2/2]

RagTime5Zone::RagTime5Zone ( RagTime5Zone const &  orig)
privatedelete

Member Function Documentation

◆ addErrorInDebugFile()

void RagTime5Zone::addErrorInDebugFile ( std::string const &  zoneName)

mark a zone as bad

Referenced by RagTime5Document::readScriptComment().

◆ ascii()

◆ createAsciiFile()

void RagTime5Zone::createAsciiFile ( )

creates the ascii file

Referenced by ascii().

◆ getInput()

◆ getKindLastPart()

std::string RagTime5Zone::getKindLastPart ( bool  main = true) const
inline

◆ getZoneName()

std::string RagTime5Zone::getZoneName ( ) const

returns the zone name

Referenced by RagTime5Document::updateZoneInput().

◆ isMainInput()

bool RagTime5Zone::isMainInput ( ) const
inline

returns true if the input correspond to the basic file

Referenced by ascii(), and RagTime5Graph::readPictureData().

◆ operator=()

RagTime5Zone & RagTime5Zone::operator= ( RagTime5Zone const &  orig)
privatedelete

◆ setAsciiFileName()

void RagTime5Zone::setAsciiFileName ( std::string const &  name)
inline

defines the ascii name

Referenced by RagTime5Document::updateZoneInput().

◆ setInput()

void RagTime5Zone::setInput ( MWAWInputStreamPtr const &  input)
inline

reset the current input

Referenced by RagTime5Document::unpackZone(), and RagTime5Document::updateZoneInput().

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  o,
RagTime5Zone const &  z 
)
friend

operator<<

Member Data Documentation

◆ m_asciiFile

libmwaw::DebugFile* RagTime5Zone::m_asciiFile
protected

the ascii file corresponding to an input

Referenced by ascii().

◆ m_asciiName

std::string RagTime5Zone::m_asciiName
protected

the ascii file name ( used if we need to create a ascii file)

Referenced by setAsciiFileName().

◆ m_childIdToZoneMap

◆ m_defaultInput

MWAWInputStreamPtr RagTime5Zone::m_defaultInput
protected

the main file input

Referenced by isMainInput().

◆ m_defPosition

◆ m_entriesList

std::vector<MWAWEntry> RagTime5Zone::m_entriesList

the list of original entries

Referenced by RagTime5Document::updateZoneInput().

◆ m_entry

◆ m_extra

std::string RagTime5Zone::m_extra

extra data

Referenced by RagTime5Document::unpackZone().

◆ m_hiLoEndian

◆ m_ids

◆ m_idsFlag

int RagTime5Zone::m_idsFlag[3]

the zone flag

Referenced by RagTime5Zone().

◆ m_input

MWAWInputStreamPtr RagTime5Zone::m_input
protected

the main input

Referenced by getInput(), isMainInput(), and setInput().

◆ m_isInitialised

bool RagTime5Zone::m_isInitialised
mutable

a flag to know if the zone is initialised (stream, hiLoEndian)

◆ m_isParsed

◆ m_kinds

◆ m_level

int RagTime5Zone::m_level

the zone level

Referenced by RagTime5Document::readZoneData().

◆ m_localAsciiFile

std::shared_ptr<libmwaw::DebugFile> RagTime5Zone::m_localAsciiFile
protected

the local ascii file ( if we need to create a new input)

Referenced by ascii().

◆ m_mainAsciiFile

libmwaw::DebugFile* RagTime5Zone::m_mainAsciiFile
protected

the main ascii file (used to print error)

◆ m_name

std::string RagTime5Zone::m_name

the zone name ( mainly used for debugging)

Referenced by RagTime5ClusterManager::readCluster(), RagTime5Graph::readPictureList(), and RagTime5Graph::readPictureMatch().

◆ m_parentName

std::string RagTime5Zone::m_parentName

the parent name

◆ m_variableD

int RagTime5Zone::m_variableD[2]

the content of the zone D if it exists

Referenced by RagTime5Zone(), and RagTime5Graph::readPictureList().


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

Generated on Wed May 3 2023 07:18:29 for libmwaw by doxygen 1.9.6