CppTraitDataStream.cpp

Go to the documentation of this file.

 
/***************************************
        Auteur : Pierre Aubert
        Mail : pierre.aubert@lapp.in2p3.fr
        Licence : LGPL-3.0-only
****************************************/
 
#include "type_utils.h"
#include "CppTraitDataStream.h"

CppTraitDataStream::CppTraitDataStream()
        :PAbstractTraitBackend()
{}

CppTraitDataStream::~CppTraitDataStream(){}


void CppTraitDataStream::headerExtraInclude(std::ofstream & fs, const GeneratorMode & mode) const{
        if(!mode.enableDataStream){return;}
        fs << "#include <array>" << std::endl;
        fs << "#include <algorithm>" << std::endl;
        fs << "#include \"phoenix_data_stream.h\"" << std::endl;
}


void CppTraitDataStream::publicMethodDeclaration(std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode) const{
        if(!mode.enableDataStream || classConfig.getIsEnum()){return;}
        PString name(classConfig.getName());
        fs << std::endl;
        fs << "\t\t///Load the current "<<name<<" with a stream" << std::endl;
        fs << "\t\t/**  @param[out] ds : stream to be used" << std::endl;
        fs << "\t\t *   @return true on success, false otherwise" << std::endl;
        fs << "\t\t*/" << std::endl;
        fs << "\t\ttemplate<typename Stream, DataStreamMode::DataStreamMode Mode>" << std::endl;
        fs << "\t\tbool readWriteStream(Stream & ds){" << std::endl;
 
        const PVecClassAttribute & vecAttr(classConfig.getListAttribute());
        if(vecAttr.size() == 0lu){
                fs << "\t\t\treturn true;" << std::endl;
        }else{
                //Neither "b = f() && b" (each && counts toward SonarQube's cognitive complexity) nor "b &= f()" (SonarQube flags bitwise ops on bool) scale to many attributes.
                //Collecting every (always-evaluated, no short-circuit) result in an array and reducing it with a single std::all_of keeps cognitive complexity constant regardless of attribute count.
                fs << "\t\t\tconst std::array<bool, " << vecAttr.size() << "> vecIsOk{" << std::endl;
                PString separator("\t\t\t\t");
                for(PVecClassAttribute::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                        fs << separator << "streamAttribute<Stream, Mode>(ds, p_" << it->getName() << ")";
                        separator = ",\n\t\t\t\t";
                }
                fs << std::endl << "\t\t\t};" << std::endl;
                fs << "\t\t\treturn std::all_of(vecIsOk.begin(), vecIsOk.end(), [](bool isOk){return isOk;});" << std::endl;
        }
        fs << "\t\t}" << std::endl << std::endl;
}


void CppTraitDataStream::publicMethodImplementation(std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode) const{
        if(!mode.enableDataStream){return;}
        
}


void CppTraitDataStream::protectedMethodDeclaration(std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode) const{
        if(!mode.enableDataStream || classConfig.getIsEnum()){return;}
        fs << std::endl;
        fs << "\t\t///Streams a single attribute" << std::endl;
        fs << "\t\t/**  @param[out] ds : stream to be used" << std::endl;
        fs << "\t\t *   @param data : attribute to be streamed" << std::endl;
        fs << "\t\t *   @return true on success, false otherwise" << std::endl;
        fs << "\t\t*/" << std::endl;
        fs << "\t\ttemplate<typename Stream, DataStreamMode::DataStreamMode Mode, typename T>" << std::endl;
        fs << "\t\tstatic bool streamAttribute(Stream & ds, T & data){" << std::endl;
        fs << "\t\t\treturn DataStream<Stream, Mode, T>::data_stream(ds, data);" << std::endl;
        fs << "\t\t}" << std::endl << std::endl;
}


void CppTraitDataStream::protectedMethodImplementation(std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode) const{
        
}


void CppTraitDataStream::privateMethodDeclaration(std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode) const{
        
}


void CppTraitDataStream::privateMethodImplementation(std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode) const{
        
}


void CppTraitDataStream::classExtraFunctionDeclaration(std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode) const{
        if(!mode.enableDataStream){return;}
        PString name(classConfig.getName());
        PString fullName(classConfig.getFullName());
        if(classConfig.getIsEnum()){
                fs << "PHOENIX_DATA_STREAM_ENUM("<<name<<"::"<<name<<")" << std::endl << std::endl;
                return;
        }
        fs << "///@brief Generic "<<name<<" serialisation/deserialisation, load/save and size function for PhoenixDataStream" << std::endl;
        fs << "template<typename Stream, DataStreamMode::DataStreamMode Mode>" << std::endl;
        fs << "struct DataStream<Stream, Mode, "<<fullName<<">{" << std::endl;
        fs << "\t///Generic function to load/save/serialise/deserialise "<<name << std::endl;
        fs << "\t/**\t@param[out] ds : stream to be used" << std::endl;
        fs << "\t * \t@param data : "<<name<<" to be used" << std::endl;
        fs << "\t * \t@return true on success, false otherwise" << std::endl;
        fs << "\t*/" << std::endl;
        fs << "\tstatic bool data_stream(Stream & ds, "<<fullName<<" & data){" << std::endl;
        fs << "\t\treturn data.readWriteStream<Stream, Mode>(ds);" << std::endl;
        fs << "\t}" << std::endl;
        fs << "};" << std::endl << std::endl;
}


void CppTraitDataStream::classExtraFunctionImplementation(std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode) const{
        if(!mode.enableDataStream){return;}
        
}