XMLPacketGen Class Reference

XML Packet Generator class. More...

#include "XMLPacketGen.h"

Inheritance diagram for XMLPacketGen:

Collaboration diagram for XMLPacketGen:

Public Member Functions
	XMLPacketGen (const char *header="", const char *source="")
	Primary constructor. More...
	~XMLPacketGen ()
	Destructory; closes output files. More...
void	SetHeaderFile (const char *header)
	Sets header file. More...
void	SetSourceFile (const char *source)
	Sets source file. More...
Public Member Functions inherited from XMLParserEx
template<typename T >
void	AddMemberParser (const char *name, T &instance, bool(T::*method)(const TiXmlElement *))
	Adds a member parser. More...
template<typename T >
void	AddValueParser (const char *name, T &value)
	Adds a value parser. More...
Public Member Functions inherited from XMLParser
	XMLParser ()
	Primary constructor. More...
virtual	~XMLParser ()
	A destructor. More...
bool	ParseFile (const char *file)
	Parses file using registered parsers. More...
bool	ParseElement (const TiXmlElement *element) const
	Parses element using registered parsers. More...
bool	ParseElementChildren (const TiXmlElement *element, size_t max=0) const
	Parses element's children using registered parsers. More...
void	AddParser (const char *name, ElementParser *parser)
	Adds a parser. More...
void	RemoveParser (const char *name)
	Removes a parser. More...
void	ClearParsers ()
	Clears all parsers. More...

Protected Member Functions
bool	ParseElements (const TiXmlElement *field)
bool	ParseInclude (const TiXmlElement *field)
bool	ParseElementDef (const TiXmlElement *field)
Protected Member Functions inherited from XMLParserEx
template<typename T >
void	AddMemberParser (const char *name, bool(T::*method)(const TiXmlElement *))
	Adds a member parser, assuming that instance is this. More...

Private Member Functions
bool	OpenFiles ()
	Opens output files. More...

Static Private Member Functions
static std::string	FNameToDef (const char *buf)

Private Attributes
FILE *	mHeaderFile
std::string	mHeaderFileName
FILE *	mSourceFile
std::string	mSourceFileName
ClassCloneGenerator	mClone
ClassConstructGenerator	mConstruct
ClassDecodeGenerator	mDecode
ClassDestructGenerator	mDestruct
ClassDumpGenerator	mDump
ClassEncodeGenerator	mEncode
ClassHeaderGenerator	mHeader

Static Private Attributes
static const char *const	smGenFileComment

Additional Inherited Members
Public Attributes inherited from XMLParser
std::unique_ptr< TiXmlDocument >	m_pXML_Document

Detailed Description

XML Packet Generator class.

Top-level class, controls the generation.

Author

Zhur, Bloody.Rabbit

Definition at line 45 of file XMLPacketGen.h.

Constructor & Destructor Documentation

XMLPacketGen::XMLPacketGen	(	const char *	header = "",
		const char *	source = ""
	)

Primary constructor.

Parameters

[in]	header	Header file to be generated.
[in]	source	Source file to be generated.

Definition at line 62 of file XMLPacketGen.cpp.

References XMLParserEx::AddMemberParser(), ParseElementDef(), ParseElements(), and ParseInclude().

: mHeaderFile( NULL ),
  mHeaderFileName( header ),
  mSourceFile( NULL ),
  mSourceFileName( source )
{
    AddMemberParser( "elements",   &XMLPacketGen::ParseElements );
    AddMemberParser( "include",    &XMLPacketGen::ParseInclude );
    AddMemberParser( "elementDef", &XMLPacketGen::ParseElementDef );
}

Here is the call graph for this function:

XMLPacketGen::~XMLPacketGen

(

)

Destructory; closes output files.

Definition at line 73 of file XMLPacketGen.cpp.

References SetHeaderFile(), and SetSourceFile().

{
    // Close the files
    SetHeaderFile( "" );
    SetSourceFile( "" );
}

Here is the call graph for this function:

Member Function Documentation

std::string XMLPacketGen::FNameToDef ( const char *  buf )

staticprivate

Definition at line 235 of file XMLPacketGen.cpp.

References IsPrintable().

Referenced by ParseElements().

{
    std::string res;
    res += "__";

    for(; '\0' != *buf; ++buf )
    {
        if( !IsPrintable( *buf ) || *buf == '/' || *buf == '\\' || *buf == ':' || *buf == '.' || *buf == '-' )
            res += '_';
        else
            res += (char)toupper( *buf );
    }

    res += "__";
    return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool XMLPacketGen::OpenFiles ( )

private

Opens output files.

Return values

true	Open succeeded.
false	Open failed.

Definition at line 197 of file XMLPacketGen.cpp.

References mClone, mConstruct, mDecode, mDestruct, mDump, mEncode, mHeader, mHeaderFile, mHeaderFileName, mSourceFile, mSourceFileName, and Generator::SetOutputFile().

Referenced by ParseElements().

{
    bool res = true;

    if( !mHeaderFileName.empty() && ( NULL == mHeaderFile ) )
    {
        mHeaderFile = fopen( mHeaderFileName.c_str(), "w" );

        if( NULL == mHeaderFile )
            res = false;
        else
        {
            // propagate the change to the generators
            mHeader.SetOutputFile( mHeaderFile );
        }
    }

    if( !mSourceFileName.empty() && ( NULL == mSourceFile ) )
    {
        mSourceFile = fopen( mSourceFileName.c_str(), "w" );

        if( NULL == mSourceFile )
            res = false;
        else
        {
            // propagate the change to the generators
            mClone.SetOutputFile( mSourceFile );
            mConstruct.SetOutputFile( mSourceFile );
            mDecode.SetOutputFile( mSourceFile );
            mDestruct.SetOutputFile( mSourceFile );
            mDump.SetOutputFile( mSourceFile );
            mEncode.SetOutputFile( mSourceFile );
        }
    }

    return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool XMLPacketGen::ParseElementDef ( const TiXmlElement *  field )

protected

Definition at line 145 of file XMLPacketGen.cpp.

References mClone, mConstruct, mDecode, mDestruct, mDump, mEncode, mHeader, and XMLParser::ParseElement().

Referenced by XMLPacketGen().

{
    bool res = ( mClone.ParseElement( field )
                 && mConstruct.ParseElement( field )
                 && mDecode.ParseElement( field )
                 && mDestruct.ParseElement( field )
                 && mDump.ParseElement( field )
                 && mEncode.ParseElement( field )
                 && mHeader.ParseElement( field ) );

    return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool XMLPacketGen::ParseElements ( const TiXmlElement *  field )

protected

Definition at line 80 of file XMLPacketGen.cpp.

References FNameToDef(), mHeaderFile, mHeaderFileName, mSourceFile, OpenFiles(), XMLParser::ParseElementChildren(), sLog, and smGenFileComment.

Referenced by XMLPacketGen().

{
    if( !OpenFiles() )
    {
        sLog.Error( "XMLPacketGen", "Unable to open output files: %s.", strerror( errno ) );
        return false;
    }

    const std::string def = FNameToDef( mHeaderFileName.c_str() );

    //headers:
    fprintf( mHeaderFile,
        "%s\n"
        "\n"
        "#ifndef %s\n"
        "#define %s\n"
        "\n"
        "#include \"python/PyVisitor.h\"\n"
        "#include \"python/PyRep.h\"\n"
        "\n",
        smGenFileComment,
        def.c_str(),
        def.c_str()
    );
    fprintf( mSourceFile,
        "%s\n"
        "\n"
        "#include \"eve-common.h\"\n"
        "\n"
        "#include \"%s\"\n"
        "\n",
        smGenFileComment,
        mHeaderFileName.c_str()
    );

    //content
    bool res = ParseElementChildren( field );

    //footers:
    fprintf( mHeaderFile,
        "#endif /* !%s */\n"
        "\n",
        def.c_str()
    );

    return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool XMLPacketGen::ParseInclude ( const TiXmlElement *  field )

protected

Definition at line 128 of file XMLPacketGen.cpp.

References _log, and mHeaderFile.

Referenced by XMLPacketGen().

{
    const char* file = field->Attribute( "file" );
    if( file == NULL )
    {
        _log( COMMON__ERROR, "field at line %d is missing the file attribute, skipping.", field->Row() );
        return false;
    }

    fprintf( mHeaderFile,
        "#include \"%s\"\n"
        "\n",
        file
    );
    return true;
}

Here is the caller graph for this function:

void XMLPacketGen::SetHeaderFile

(

const char *

header

)

Sets header file.

Parameters

[in]

header

Header file to be generated.

Definition at line 158 of file XMLPacketGen.cpp.

References mHeader, mHeaderFile, mHeaderFileName, and Generator::SetOutputFile().

Referenced by main(), and ~XMLPacketGen().

{
    if( mHeaderFileName != header )
    {
        if( NULL != mHeaderFile )
        {
            fclose( mHeaderFile );
            mHeaderFile = NULL;

            // propagate the change to the generators
            mHeader.SetOutputFile( NULL );
        }

        mHeaderFileName = header;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void XMLPacketGen::SetSourceFile

(

const char *

source

)

Sets source file.

Parameters

[in]

source

Source file to be generated.

Definition at line 175 of file XMLPacketGen.cpp.

References mClone, mConstruct, mDecode, mDestruct, mDump, mEncode, mSourceFile, mSourceFileName, and Generator::SetOutputFile().

Referenced by main(), and ~XMLPacketGen().

{
    if( mSourceFileName != source )
    {
        if( NULL != mSourceFile )
        {
            fclose( mSourceFile );
            mSourceFile = NULL;

            // propagate the change to the generators
            mClone.SetOutputFile( NULL );
            mConstruct.SetOutputFile( NULL );
            mDecode.SetOutputFile( NULL );
            mDestruct.SetOutputFile( NULL );
            mDump.SetOutputFile( NULL );
            mEncode.SetOutputFile( NULL );
        }

        mSourceFileName = source;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ClassCloneGenerator XMLPacketGen::mClone

private

Definition at line 94 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElementDef(), and SetSourceFile().

ClassConstructGenerator XMLPacketGen::mConstruct

private

Definition at line 95 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElementDef(), and SetSourceFile().

ClassDecodeGenerator XMLPacketGen::mDecode

private

Definition at line 96 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElementDef(), and SetSourceFile().

ClassDestructGenerator XMLPacketGen::mDestruct

private

Definition at line 97 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElementDef(), and SetSourceFile().

ClassDumpGenerator XMLPacketGen::mDump

private

Definition at line 98 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElementDef(), and SetSourceFile().

ClassEncodeGenerator XMLPacketGen::mEncode

private

Definition at line 99 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElementDef(), and SetSourceFile().

ClassHeaderGenerator XMLPacketGen::mHeader

private

Definition at line 100 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElementDef(), and SetHeaderFile().

FILE* XMLPacketGen::mHeaderFile

private

Definition at line 89 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElements(), ParseInclude(), and SetHeaderFile().

std::string XMLPacketGen::mHeaderFileName

private

Definition at line 90 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElements(), and SetHeaderFile().

FILE* XMLPacketGen::mSourceFile

private

Definition at line 91 of file XMLPacketGen.h.

Referenced by OpenFiles(), ParseElements(), and SetSourceFile().

std::string XMLPacketGen::mSourceFileName

private

Definition at line 92 of file XMLPacketGen.h.

Referenced by OpenFiles(), and SetSourceFile().

const char *const XMLPacketGen::smGenFileComment

staticprivate

Initial value:

=
"/*  EVEmu: EVE Online Server Emulator\n"
"  \n"
"  **************************************************************\n"
"  This file is automatically generated, DO NOT EDIT IT DIRECTLY.\n"
"  **************************************************************\n"
"  \n"
"  (If you need to customize an object, you must copy that object\n"
"  into another source file, and give up the ability to generate it)\n"
"  \n"
"  \n"
"  This program is free software; you can redistribute it and/or modify\n"
"  it under the terms of the GNU General Public License as published by\n"
"  the Free Software Foundation; version 2 of the License.\n"
"  \n"
"  This program is distributed in the hope that it will be useful,\n"
"  but WITHOUT ANY WARRANTY except by those people which sell it, which\n"
"  are required to give you total support for your newly bought product;\n"
"  without even the implied warranty of MERCHANTABILITY or FITNESS FOR\n"
"  A PARTICULAR PURPOSE.  See the GNU General Public License for more details.\n"
"  \n"
"  You should have received a copy of the GNU General Public License\n"
"  along with this program; if not, write to the Free Software\n"
"  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\n"
"  \n\n"
"  Updated by Allan, 2016 - 2020"
"  \n"
"*/"

Definition at line 104 of file XMLPacketGen.h.

Referenced by ParseElements().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-xmlpktgen/XMLPacketGen.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-xmlpktgen/XMLPacketGen.cpp