RustTraitGetterSetter Class Reference

Rust trait generating getters and setters for every attribute. More...

#include <RustTraitGetterSetter.h>

Inheritance diagram for RustTraitGetterSetter:

Collaboration diagram for RustTraitGetterSetter:

Public Member Functions
virtual void	classExtraDeclaration (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
virtual void	headerExtraInclude (std::ofstream &fs, const GeneratorMode &mode) const
virtual void	implMethodDeclaration (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
	Implementation of the impl block methods.
	RustTraitGetterSetter ()
	Consctructor of RustTraitGetterSetter.
virtual void	testFunction (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
	Implementation of test function.
virtual	~RustTraitGetterSetter ()
	Desctructor of RustTraitGetterSetter.

Detailed Description

Rust trait generating getters and setters for every attribute.

Definition at line 14 of file RustTraitGetterSetter.h.

Constructor & Destructor Documentation

RustTraitGetterSetter()

RustTraitGetterSetter::RustTraitGetterSetter

(

)

Consctructor of RustTraitGetterSetter.

Definition at line 11 of file RustTraitGetterSetter.cpp.

        :PAbstractRustTraitBackend()
{}

References PAbstractRustTraitBackend::PAbstractRustTraitBackend().

Here is the call graph for this function:

~RustTraitGetterSetter()

RustTraitGetterSetter::~RustTraitGetterSetter ( )

virtual

Desctructor of RustTraitGetterSetter.

Definition at line 16 of file RustTraitGetterSetter.cpp.

{}

Member Function Documentation

classExtraDeclaration()

virtual void PAbstractRustTraitBackend::classExtraDeclaration ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

inlinevirtualinherited

Definition at line 94 of file PAbstractTraitBackend.h.

{}

headerExtraInclude()

virtual void PAbstractRustTraitBackend::headerExtraInclude ( std::ofstream & fs, const GeneratorMode & mode ) const

inlinevirtualinherited

Reimplemented in RustTraitCheckStream, RustTraitDataStream, and RustTraitTypeStream.

Definition at line 90 of file PAbstractTraitBackend.h.

{}

implMethodDeclaration()

void RustTraitGetterSetter::implMethodDeclaration ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Implementation of the impl block methods.

Parameters

[out]	fs	: file to be completed
	classConfig	: PClassConfig to be used
	mode	: mode of the generator

Reimplemented from PAbstractRustTraitBackend.

Definition at line 23 of file RustTraitGetterSetter.cpp.

                                                                                                                                     {
        if(classConfig.getIsEnum()){return;}
        const PVecClassAttribute & vecAttr(classConfig.getListAttribute());
        for(PVecClassAttribute::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                PString varType(it->getType()), fieldName(it->getName().toSnakeCase());
                if(getIsPointerType(varType)){
                        PString pointeeType(getRustType(varType.eraseFirstLastChar(" \n\t*")));
                        if(mode.enableGetter){
                                fs << "\t///Gets the " << it->getName() << " of the " << classConfig.getName() << "\n";
                                fs << "\tpub fn get_" << fieldName << "(&self) -> Option<&" << pointeeType << ">{\n";
                                fs << "\t\tself." << fieldName << ".as_deref()\n";
                                fs << "\t}\n\n";
                                fs << "\t///Gets a mutable reference to the " << it->getName() << " of the " << classConfig.getName() << "\n";
                                fs << "\tpub fn get_" << fieldName << "_mut(&mut self) -> Option<&mut " << pointeeType << ">{\n";
                                fs << "\t\tself." << fieldName << ".as_deref_mut()\n";
                                fs << "\t}\n\n";
                        }
                        if(mode.enableSetter){
                                fs << "\t///Sets the " << it->getName() << " of the " << classConfig.getName() << "\n";
                                fs << "\tpub fn set_" << fieldName << "(&mut self, " << fieldName << ": " << pointeeType << "){\n";
                                fs << "\t\tself." << fieldName << " = Some(Box::new(" << fieldName << "));\n";
                                fs << "\t}\n\n";
                        }
                        continue;
                }
                PString rustType(getRustType(varType));
                bool isCopy(getRustTypeIsCopy(varType));
                if(mode.enableGetter){
                        fs << "\t///Gets the " << it->getName() << " of the " << classConfig.getName() << "\n";
                        if(isCopy){
                                fs << "\tpub fn get_" << fieldName << "(&self) -> " << rustType << "{\n";
                                fs << "\t\tself." << fieldName << "\n";
                        }else{
                                fs << "\tpub fn get_" << fieldName << "(&self) -> &" << rustType << "{\n";
                                fs << "\t\t&self." << fieldName << "\n";
                        }
                        fs << "\t}\n\n";
                        if(!isCopy){
                                fs << "\t///Gets a mutable reference to the " << it->getName() << " of the " << classConfig.getName() << "\n";
                                fs << "\tpub fn get_" << fieldName << "_mut(&mut self) -> &mut " << rustType << "{\n";
                                fs << "\t\t&mut self." << fieldName << "\n";
                                fs << "\t}\n\n";
                        }
                }
                if(mode.enableSetter){
                        fs << "\t///Sets the " << it->getName() << " of the " << classConfig.getName() << "\n";
                        fs << "\tpub fn set_" << fieldName << "(&mut self, " << fieldName << ": " << rustType << "){\n";
                        fs << "\t\tself." << fieldName << " = " << fieldName << ";\n";
                        fs << "\t}\n\n";
                }
        }
}

References GeneratorMode::enableGetter, GeneratorMode::enableSetter, PClassConfig::getIsEnum(), getIsPointerType(), PClassConfig::getListAttribute(), PClassConfig::getName(), getRustType(), and getRustTypeIsCopy().

Here is the call graph for this function:

testFunction()

void RustTraitGetterSetter::testFunction ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Implementation of test function.

Parameters

[out]	fs	: file to be completed
	classConfig	: PClassConfig to be used
	mode	: mode of the generator

Reimplemented from PAbstractRustTraitBackend.

Definition at line 81 of file RustTraitGetterSetter.cpp.

                                                                                                                            {
        if(classConfig.getIsEnum() || !mode.enableUnitTest || (!mode.enableGetter && !mode.enableSetter)){return;}
        PString name(classConfig.getName());
        fs << "#[test]\n";
        fs << "fn test_" << name.toSnakeCase() << "_getter_setter(){\n";
        fs << "\tlet mut obj = " << name << "::default();\n";
        const PVecClassAttribute & vecAttr(classConfig.getListAttribute());
        for(PVecClassAttribute::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                PString varType(it->getType()), fieldName(it->getName().toSnakeCase());
                if(getIsPointerType(varType)){
                        PString pointeeType(getRustType(varType.eraseFirstLastChar(" \n\t*")));
                        fs << "\tlet next_" << fieldName << " = " << pointeeType << "::default();\n";
                        fs << "\tobj.set_" << fieldName << "(next_" << fieldName << ".clone());\n";
                        fs << "\tassert_eq!(*obj.get_" << fieldName << "().unwrap(), next_" << fieldName << ");\n";
                        continue;
                }
                PString testValue(getRustTestValue(*it));
                if(testValue == ""){continue;} //list/nested type : no generic literal test value, skip
                bool isCopy(getRustTypeIsCopy(varType));
                fs << "\tobj.set_" << fieldName << "(" << testValue << ");\n";
                if(isCopy){
                        fs << "\tassert_eq!(obj.get_" << fieldName << "(), " << testValue << ");\n";
                }else{
                        fs << "\tassert_eq!(*obj.get_" << fieldName << "(), " << testValue << ");\n";
                }
        }
        fs << "}\n\n";
}

References GeneratorMode::enableGetter, GeneratorMode::enableSetter, GeneratorMode::enableUnitTest, PClassConfig::getIsEnum(), getIsPointerType(), PClassConfig::getListAttribute(), PClassConfig::getName(), getRustTestValue(), getRustType(), and getRustTypeIsCopy().

Here is the call graph for this function:

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/code-generator/PhoenixGenerator/src/TraitBackEnd/Rust/RustTraitGetterSetter/RustTraitGetterSetter.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/code-generator/PhoenixGenerator/src/TraitBackEnd/Rust/RustTraitGetterSetter/RustTraitGetterSetter.cpp