Class Poco::CodeGeneration::Utility

Library: CodeGeneration
Package: CodeGeneration
Header: Poco/CodeGeneration/Utility.h

Description

Constants and utility functions for code generation.

Member Summary

Member Functions: createFiles, createInclude, createIncludeGuard, extractTemplateFromClassDecl, handleBaseClassesInclude, handleInclude, handleSrcInclude, hasAnyRemoteProperty, resolveParamDecl, resolveType, resolveTypeImpl, writeAccess, writeAttributes, writeClassDeclaration, writeDocumentation, writeInclude, writeIncludeGuard, writeLines, writeNameSpaceBegin, writeNameSpaceEnd, writeStdHeader

Constructors

Destructor

Member Functions

createFiles

static void createFiles(
    const std::string & fileNameCore,
    std::ofstream & hFile,
    std::ofstream & cppFile
);

Takes the fileNameCore (name without extension), appends HFILEEXTENSION, and CPPFILEEXTENSION, and opens both files In case of an error an exception is thrown

createInclude

static std::string createInclude(
const Poco::CppParser::Struct * pStruct,
bool usePocoIncludes
);

Creates an include path for the given struct.

createInclude

static std::string createInclude(
const std::string & filePath,
bool flatInclude
);

Creates an include path for the given filePath.

createIncludeGuard

static std::string createIncludeGuard(
const std::string & libraryName,
const std::string & fileName
);

Creates an include guard found at the very beginning of the h file.

extractTemplateFromClassDecl

static std::string extractTemplateFromClassDecl(
const Poco::CppParser::Struct * pStruct
);

Extracts the template name from the class.

handleBaseClassesInclude

static void handleBaseClassesInclude(
const Poco::CppParser::Struct * pStruct,
CodeGenerator & gen
);

Includes all files for the parents

handleInclude

static void handleInclude(
const Poco::CppParser::Struct * pStruct,
CodeGenerator & gen
);

Takes the absolute/relative file path from the struct as input and converts it to an include dir

handleSrcInclude

static void handleSrcInclude(
const Poco::CppParser::Struct * pStruct,
CodeGenerator & gen
);

Takes the absolute/relative file path from the struct as input and converts it to an include dir

hasAnyRemoteProperty

static bool hasAnyRemoteProperty(
const Poco::CppParser::Struct * pStruct
);

Checks if a class or a single PUBLIC method of it has remote properties.

resolveParamDecl

static std::string resolveParamDecl(
const Poco::CppParser::NameSpace * pNS,
const Poco::CppParser::Parameter * pSym
);

Returns the declaration of a parameter with resolved types.

resolveType

static std::string resolveType(
const Poco::CppParser::NameSpace * pSym,
const std::string & name
);

Resolves types by appending namespaces to them

resolveTypeImpl

static std::string resolveTypeImpl(
const Poco::CppParser::NameSpace * pSym,
const std::string & name
);

Resolves types by appending namespaces to them

writeAccess

static void writeAccess(
std::ostream & ostr,
Poco::CppParser::Symbol::Access acc
);

Writes string version of the Access.

writeAttributes

static void writeAttributes(
    std::ostream & out,
    const Poco::CppParser::Attributes & attrs,
    int indent
);

writeClassDeclaration

static void writeClassDeclaration(
    std::ostream & ostr,
    const std::string & libName,
    const std::string & className
);

Writes a class declaration. Do not use for templates!

writeClassDeclaration

static void writeClassDeclaration(
    std::ostream & ostr,
    const std::string & libName,
    const Poco::CppParser::Struct * pStruct,
    bool enableAttributes = false
);

Writes a class declaration. Works for templates.

writeDocumentation

static void writeDocumentation(
    std::ostream & out,
    const std::string & docu,
    int indent
);

writeInclude

static void writeInclude(
    std::ostream & ostr,
    const std::string & libraryName,
    const std::string & fileName
);

Writes an include.

writeIncludeGuard

static void writeIncludeGuard(
    std::ostream & ostr,
    const std::string & libraryName,
    const std::string & fileName
);

Writes an includeguard: ie. #ifndef xy #define xy

writeLines

static void writeLines(
    std::ostream & ostr,
    const std::vector < std::string > & lines,
    bool appendNewLine
);

Writes code lines to the output stream.

writeNameSpaceBegin

static void writeNameSpaceBegin(
std::ostream & out,
const std::string & nameSpace
);

Starts the namespace

writeNameSpaceEnd

static void writeNameSpaceEnd(
std::ostream & out,
const std::string & nameSpace
);

Ends the namespace

static void writeStdHeader(
    std::ostream & ostr,
    const std::string & fileName,
    const std::string & libraryName,
    const std::string & packageName,
    const std::string & moduleName,
    const std::string & copyright,
    bool writeTimestamp = true
);