saveClassConfig.h File Reference

#include <fstream>
#include "PClassConfig.h"

Include dependency graph for saveClassConfig.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
PString	createGetterDecl (const PString &varType, const PString &varName, const PString &className, bool isConst, bool isPtr)
	Creates a function decl for setters. More...
PString	createSetterDecl (const PString &varType, const PString &varName, const PString &className, bool isPtr)
	Creates a function decl for setters. More...
bool	getIsSimpleType (const PString &varType)
	Check if the given type is a simple type. More...
PString	makeVarType (const PString &varType, bool isSetter, bool isConst, bool isRef, bool isPtr)
	Makes the var type by taking account of the type. More...
void	saveClassConstructorImpl (std::ofstream &fs, const PClassConfig &classConfig)
void	saveClassCopyConstructorImpl (std::ofstream &fs, const PClassConfig &classConfig)
void	saveClassCopyFunctionImpl (std::ofstream &fs, const PClassConfig &classConfig)
bool	saveClassDecl (const std::vector< PClassConfig > &classConfig, const PPath &headerFile, const PVecPath &listInclude, bool enableDataStream, bool enableTypeStream)
void	saveClassDecl (std::ofstream &fs, const PClassConfig &classConfig, bool enableDataStream, bool enableTypeStream)
	Creates header file. More...
void	saveClassDestructorImpl (std::ofstream &fs, const PClassConfig &classConfig)
void	saveClassEqualOperatorImpl (std::ofstream &fs, const PClassConfig &classConfig)
void	saveClassGettersImpl (std::ofstream &fs, const PClassConfig &classConfig)
bool	saveClassImpl (const std::vector< PClassConfig > &classConfig, const PPath &sourceFile, const PPath &headerFile)
void	saveClassImpl (std::ofstream &fs, const PClassConfig &classConfig)
bool	saveClassImplDecl (const std::vector< PClassConfig > &classConfig, const PPath &baseFileName, const PVecPath &listInclude=PVecPath(), bool enableDataStream=false, bool enableTypeStream=false)
	Creates header file. More...
void	saveClassSettersImpl (std::ofstream &fs, const PClassConfig &classConfig)
void	saveDeclGetters (std::ofstream &fs, const PClassConfig &classConfig)
	Creates getters header file. More...
void	saveDeclSetters (std::ofstream &fs, const PClassConfig &classConfig)
	Creates setters header file. More...

Function Documentation

createGetterDecl()

PString createGetterDecl	(	const PString &	varType,
		const PString &	varName,
		const PString &	className,
		bool	isConst,
		bool	isPtr
	)

Creates a function decl for setters.

Parameters

varType	: type of the var to set
varName	: name of the var to set
className	: name of the class
isConst	: true if the function must be const
isPtr	: true if te variable is a pointer

Returns

setters function decl

Definition at line 102 of file saveClassConfig.cpp.

                                                                                                                               {
        PString functionDecl("");
        functionDecl += makeVarType(varType, false, isConst, !isConst, isPtr) + " ";
        if(className != "") functionDecl += className + "::";
        functionDecl += "get" + varName.firstToUpper() + "()";
        return functionDecl;
}

References PString::firstToUpper(), and makeVarType().

Referenced by saveClassGettersImpl(), and saveDeclGetters().

Here is the call graph for this function:

Here is the caller graph for this function:

createSetterDecl()

PString createSetterDecl	(	const PString &	varType,
		const PString &	varName,
		const PString &	className,
		bool	isPtr
	)

Creates a function decl for setters.

Parameters

varType	: type of the var to set
varName	: name of the var to set
className	: name of the class
isPtr	: true if te variable is a pointer

Returns

setters function decl

Definition at line 85 of file saveClassConfig.cpp.

                                                                                                                 {
        PString functionDecl("void ");
        if(className != "") functionDecl += className + "::";
        functionDecl += "set" + varName.firstToUpper() + "(";
        functionDecl += makeVarType(varType, true, true, false, isPtr);
        functionDecl += " " + varName + ")";
        return functionDecl;
}

References PString::firstToUpper(), and makeVarType().

Referenced by saveClassSettersImpl(), and saveDeclSetters().

Here is the call graph for this function:

Here is the caller graph for this function:

getIsSimpleType()

bool getIsSimpleType

(

const PString &

varType

)

Check if the given type is a simple type.

Parameters

varType

: type to be checked

Returns

true if the given type is a simple type, false otherwise

Definition at line 15 of file saveClassConfig.cpp.

                                             {
        PString restVarName(varType.replace("unsigned", "").eraseChar(" \n\t*&"));
        return (restVarName == "char" || restVarName == "short" || restVarName == "int" || restVarName == "float" || restVarName == "double" || restVarName == "bool" || restVarName == "long" || restVarName == "longint" || restVarName == "size_t" || restVarName == "ssize_t" || restVarName == "void");
}

References PString::eraseChar(), and PString::replace().

Referenced by createCheckClassEquality(), makeVarType(), project_wrapper_attributeDef(), project_wrapper_classAttributeFromMessage(), project_wrapper_classAttributeGetSize(), project_wrapper_classAttributeToMessage(), project_wrapper_classGetterSetterDef(), project_wrapper_classImpl(), project_wrapper_classImplCheck(), project_wrapper_classImplDealloc(), project_wrapper_classImplGetterSetter(), project_wrapper_classImplNewc(), and saveClassInitialisationFunctionImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

makeVarType()

PString makeVarType	(	const PString &	varType,
		bool	isSetter,
		bool	isConst,
		bool	isRef,
		bool	isPtr
	)

Makes the var type by taking account of the type.

Parameters

varType	: variable type name
isSetter	: true if the type is made for a setter
isConst	: true if the type must be const
isRef	: true if the variable is a reference
isPtr	: true if te variable is a pointer

Returns

var type by taking account of the type

Definition at line 63 of file saveClassConfig.cpp.

                                                                                                 {
        PString varTypeName("");
//      std::cout << "makeVarType : varType = '" << varType << "'" << std::endl;
        bool isSimpleType = getIsSimpleType(varType);
        if(isSimpleType || isPtr){
                if(isConst && !isSetter && (!isSimpleType || isPtr)) varTypeName += "const ";
                varTypeName += varType;
                if(isRef && !isPtr) varTypeName += " &";
        }else{
                if(isConst && !isPtr) varTypeName += "const ";
                varTypeName += varType + " &";
        }
        return varTypeName;
}

References getIsSimpleType().

Referenced by createGetterDecl(), and createSetterDecl().

Here is the call graph for this function:

Here is the caller graph for this function:

saveClassConstructorImpl()

void saveClassConstructorImpl	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

saveClassCopyConstructorImpl()

void saveClassCopyConstructorImpl	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

saveClassCopyFunctionImpl()

void saveClassCopyFunctionImpl	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

saveClassDecl() [1/2]

bool saveClassDecl	(	const std::vector< PClassConfig > &	classConfig,
		const PPath &	headerFile,
		const PVecPath &	listInclude,
		bool	enableDataStream,
		bool	enableTypeStream
	)

saveClassDecl() [2/2]

void saveClassDecl	(	std::ofstream &	fs,
		const PClassConfig &	classConfig,
		bool	enableDataStream,
		bool	enableTypeStream
	)

Creates header file.

Parameters

[out]	fs	: header file name
	classConfig	: class config we want to save
	enableDataStream	: true to enable the serialization/deserialization with DataStream, false otherwise
	enableTypeStream	: true to enable the phoenix_getTypeName function creation

Definition at line 279 of file saveClassConfig.cpp.

                                                                                                                    {
        if(classConfig.getClassDocumentation() != "") fs << classConfig.getClassDocumentation() << std::endl;
        PString name(classConfig.getName());
        const PVecString & listTemplate = classConfig.getListTemplate();
        if(listTemplate.size() != 0lu){
                fs << getClassDeclTempalteDef(listTemplate);
        }
        fs << "class " << name;
        if(classConfig.getListParentClass().size() != 0lu){
                PVecString::const_iterator it(classConfig.getListParentClass().begin());
                fs << " : public " << *it;
                if(classConfig.getListParentClass().size() > 1lu){
                        while(it != classConfig.getListParentClass().end()){
                                fs << ", " << *it;
                                ++it;
                        }
                }
        }
        fs << "{" << std::endl;
        fs << "\tpublic:" << std::endl;
        fs << "\t\t" << name << "();" << std::endl;
        fs << "\t\t" << name << "(const " << name << " & other);" << std::endl;
        fs << "\t\tvirtual ~" << name << "();" << std::endl;
        fs << "\t\t" << name << " & operator = (const " << name << " & other);" << std::endl;
        saveDeclSetters(fs, classConfig);
        saveDeclGetters(fs, classConfig);
        
        if(enableDataStream){
                saveClassDataStreamMethod(fs, classConfig);
        }
        
        fs << "\tprotected:" << std::endl;
        fs << "\t\tvoid copy" << name << "(const " << name << " & other);" << std::endl;
        
        fs << "\tprivate:" << std::endl;
        fs << "\t\tvoid initialisation" << name << "();" << std::endl;
        const std::vector<PClassAttribute> & listAttr(classConfig.getListAttribute());
        for(std::vector<PClassAttribute>::const_iterator it(listAttr.begin()); it != listAttr.end(); ++it){
                if(it->getDocumentation() != "") fs << "\t\t" << it->getDocumentation() << std::endl;
                
                fs << "\t\t" << it->getType() << " p_" << it->getName() << ";" << std::endl;
        }
        fs << "};" << std::endl << std::endl;
        
        if(enableDataStream){
                saveClassDataStreamGenericFunction(fs, classConfig);
                fs << std::endl << std::endl;
        }
        if(enableTypeStream){
                if(listTemplate.size() != 0lu){
                        fs << "///Get the name of the class " << name << std::endl;
                        fs << "/**\t@return name of the class " << name << std::endl;
                        fs << "*/" << std::endl;
                        fs << getClassDeclTempalteDef(listTemplate);
                        fs << "std::string phoenix_getTypeName<"<<name << getClassDefTemplate(listTemplate) <<" >(){" << std::endl;
                        fs << "\treturn \""<<name<<"\"";
                        fs << " + \"<\"";
                        for(PVecString::const_iterator it(listTemplate.begin()); it != listTemplate.end(); ++it){
                                fs  << " + phoenix_getTypeToStr<"<<it->split(' ').back()<<">()";
                        }
                        fs << " + \">\"";
                        fs << ";" << std::endl;
                        fs << "}" << std::endl << std::endl;
                        
                }else{
                        fs << "template<>" << std::endl;
                        fs << "std::string phoenix_getTypeName<"<<name<<">();" << std::endl << std::endl;
                }
        }
}

References getClassDeclTempalteDef(), getClassDefTemplate(), PClassConfig::getClassDocumentation(), PClassConfig::getListAttribute(), PClassConfig::getListParentClass(), PClassConfig::getListTemplate(), PClassConfig::getName(), saveClassDataStreamGenericFunction(), saveClassDataStreamMethod(), saveDeclGetters(), saveDeclSetters(), and PString::split().

Referenced by saveClassDecl(), and saveClassImplDecl().

Here is the call graph for this function:

Here is the caller graph for this function:

saveClassDestructorImpl()

void saveClassDestructorImpl	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

saveClassEqualOperatorImpl()

void saveClassEqualOperatorImpl	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

saveClassGettersImpl()

void saveClassGettersImpl	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

saveClassImpl() [1/2]

bool saveClassImpl	(	const std::vector< PClassConfig > &	classConfig,
		const PPath &	sourceFile,
		const PPath &	headerFile
	)

saveClassImpl() [2/2]

void saveClassImpl	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

saveClassImplDecl()

bool saveClassImplDecl	(	const std::vector< PClassConfig > &	classConfig,
		const PPath &	baseFileName,
		const PVecPath &	listInclude,
		bool	enableDataStream,
		bool	enableTypeStream
	)

Creates header file.

Parameters

classConfig	: class config we want to save
baseFileName	: base file name for header or source file
listInclude	: list of the include files
enableDataStream	: true to enable the serialization/deserialization with DataStream, false otherwise
enableTypeStream	: true to enable the phoenix_getTypeName function creation

Returns

true on success, false otherwise

Definition at line 728 of file saveClassConfig.cpp.

                                                                                                                                                                           {
        if(baseFileName == "") return false;
        bool hasSource(false), hasTemplate(false);
        checkClassConfig(hasSource, hasTemplate, classConfig);
        PPath includeTemplate("");
        if(hasTemplate){
                includeTemplate = PString(baseFileName.getFileName() + "_impl.h");
        }
        
        if(!saveClassDecl(classConfig, PString(baseFileName + ".h"), listInclude, enableDataStream, enableTypeStream, includeTemplate)) return false;
        
        if(hasSource){
                if(!saveClassImpl(classConfig, PPath(baseFileName + PString(".cpp")), PPath(baseFileName + PString(".h")), enableTypeStream)) return false;
        }
        if(hasTemplate){
                if(!saveClassTemplate(classConfig, PPath(baseFileName + PString("_impl.h")), PPath(baseFileName + PString(".h")))) return false;
        }
        return true;
}

References checkClassConfig(), PPath::getFileName(), saveClassDecl(), saveClassImpl(), and saveClassTemplate().

Referenced by saveParserClassConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

saveClassSettersImpl()

void saveClassSettersImpl	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

saveDeclGetters()

void saveDeclGetters	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

Creates getters header file.

Parameters

[out]	fs	: header file name
	classConfig	: class config we want to save

Definition at line 125 of file saveClassConfig.cpp.

                                                                        {
        const std::vector<PClassAttribute> & listAttr(classConfig.getListAttribute());
        for(std::vector<PClassAttribute>::const_iterator it(listAttr.begin()); it != listAttr.end(); ++it){
                fs << "\t\t" << createGetterDecl(it->getType(), it->getName(), "", true, it->getIsPointer()) << " const;" << std::endl;
                fs << "\t\t" << createGetterDecl(it->getType(), it->getName(), "", false, it->getIsPointer()) << ";" << std::endl;
        }
}

References createGetterDecl(), and PClassConfig::getListAttribute().

Referenced by saveClassDecl().

Here is the call graph for this function:

Here is the caller graph for this function:

saveDeclSetters()

void saveDeclSetters	(	std::ofstream &	fs,
		const PClassConfig &	classConfig
	)

Creates setters header file.

Parameters

[out]	fs	: header file name
	classConfig	: class config we want to save

Definition at line 114 of file saveClassConfig.cpp.

                                                                        {
        const std::vector<PClassAttribute> & listAttr(classConfig.getListAttribute());
        for(std::vector<PClassAttribute>::const_iterator it(listAttr.begin()); it != listAttr.end(); ++it){
                fs << "\t\t" << createSetterDecl(it->getType(), it->getName(), "", it->getIsPointer()) << ";" << std::endl;
        }
}

References createSetterDecl(), and PClassConfig::getListAttribute().

Referenced by saveClassDecl().

Here is the call graph for this function:

Here is the caller graph for this function: