CTestDoubleVariant

Test double generation of C code.

TODO Describe the options.

class CTestDoubleVariant : Controller , Parameters , Products {}

Constructors

this
this(MainFileName main_fname, Path output_dir, Regex!char strip_incl)

Design of c'tor.

Members

Functions

argCustomHeader
auto argCustomHeader(string header, string header_file)
Undocumented in source. Be warned that the author may not have intended to support it.
argFileExclude
auto argFileExclude(string[] a)
Undocumented in source. Be warned that the author may not have intended to support it.
argFileInclude
auto argFileInclude(string[] a)
Undocumented in source. Be warned that the author may not have intended to support it.
argForceTestDoubleIncludes
auto argForceTestDoubleIncludes(string[] a)

Force the includes to be those supplied by the user.

argGenerateZeroGlobals
auto argGenerateZeroGlobals(bool value)
Undocumented in source. Be warned that the author may not have intended to support it.
argGmock
auto argGmock(bool a)
Undocumented in source. Be warned that the author may not have intended to support it.
argLocationAsComment
auto argLocationAsComment(bool a)
Undocumented in source. Be warned that the author may not have intended to support it.
argMainName
auto argMainName(string s)
Undocumented in source. Be warned that the author may not have intended to support it.
argPostInclude
auto argPostInclude(bool a)
Undocumented in source. Be warned that the author may not have intended to support it.
argPreInclude
auto argPreInclude(bool a)
Undocumented in source. Be warned that the author may not have intended to support it.
argPrefix
auto argPrefix(string s)
Undocumented in source. Be warned that the author may not have intended to support it.
argXmlConfig
auto argXmlConfig(Nullable!XmlConfig conf)

Ensure that the relevant information from the xml file is extracted.

doFile
bool doFile(string filename, string info)
Undocumented in source. Be warned that the author may not have intended to support it.
doGoogleMock
bool doGoogleMock()
Undocumented in source. Be warned that the author may not have intended to support it.
doIncludeOfPostIncludes
bool doIncludeOfPostIncludes()
Undocumented in source. Be warned that the author may not have intended to support it.
doIncludeOfPreIncludes
bool doIncludeOfPreIncludes()
Undocumented in source. Be warned that the author may not have intended to support it.
doLocationAsComment
bool doLocationAsComment()
Undocumented in source. Be warned that the author may not have intended to support it.
doPostIncludes
bool doPostIncludes()
Undocumented in source. Be warned that the author may not have intended to support it.
doPreIncludes
bool doPreIncludes()
Undocumented in source. Be warned that the author may not have intended to support it.
doSymbol
bool doSymbol(string symbol)
Undocumented in source. Be warned that the author may not have intended to support it.
finalizeIncludes
void finalizeIncludes()
Undocumented in source. Be warned that the author may not have intended to support it.
generateZeroGlobals
Flag!"generateZeroGlobals" generateZeroGlobals()
Undocumented in source. Be warned that the author may not have intended to support it.
getArtifactPrefix
StubPrefix getArtifactPrefix()
Undocumented in source. Be warned that the author may not have intended to support it.
getCompileCommandFilter
CompileCommandFilter getCompileCommandFilter()
Undocumented in source. Be warned that the author may not have intended to support it.
getCustomHeader
CustomHeader getCustomHeader()
Undocumented in source. Be warned that the author may not have intended to support it.
getExcludeSymbols
FilterSymbol getExcludeSymbols()
Undocumented in source. Be warned that the author may not have intended to support it.
getFilePrefix
StubPrefix getFilePrefix()
Undocumented in source. Be warned that the author may not have intended to support it.
getFiles
Parameters.Files getFiles()
Undocumented in source. Be warned that the author may not have intended to support it.
getIncludes
Path[] getIncludes()
Undocumented in source. Be warned that the author may not have intended to support it.
getMainInterface
MainInterface getMainInterface()
Undocumented in source. Be warned that the author may not have intended to support it.
getMainName
MainName getMainName()
Undocumented in source. Be warned that the author may not have intended to support it.
getMainNs
MainNs getMainNs()
Undocumented in source. Be warned that the author may not have intended to support it.
getMissingFileCompiler
Compiler getMissingFileCompiler()
Undocumented in source. Be warned that the author may not have intended to support it.
getOutputDirectory
Path getOutputDirectory()
Undocumented in source. Be warned that the author may not have intended to support it.
getProducedFiles
FileData[] getProducedFiles()

Data produced by the generatore intented to be written to specified file.

getRestrictSymbols
FilterSymbol getRestrictSymbols()
Undocumented in source. Be warned that the author may not have intended to support it.
getSystemCompiler
Compiler getSystemCompiler()
Undocumented in source. Be warned that the author may not have intended to support it.
getToolVersion
DextoolVersion getToolVersion()
Undocumented in source. Be warned that the author may not have intended to support it.
getXmlConfigFile
Path getXmlConfigFile()

Destination of the configuration file containing how the test double was generated.

getXmlLog
Path getXmlLog()

Destination of the xml log for how dextool was ran when generatinng the test double.

processIncludes
void processIncludes()
Undocumented in source. Be warned that the author may not have intended to support it.
putFile
void putFile(Path fname, string data)
Undocumented in source. Be warned that the author may not have intended to support it.
putFile
void putFile(Path fname, CppHModule hdr_data)
Undocumented in source. Be warned that the author may not have intended to support it.
putFile
void putFile(Path fname, CppModule impl_data)
Undocumented in source. Be warned that the author may not have intended to support it.
putLocation
void putLocation(Path fname, LocationType type)
Undocumented in source. Be warned that the author may not have intended to support it.
systemCompiler
auto systemCompiler(string a)
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

makeVariant
auto makeVariant(RawConfiguration args)
Undocumented in source. Be warned that the author may not have intended to support it.

Inherited Members

From Controller

doFile
bool doFile(string filename, string info)

Query the controller with the filename of the AST node for a decision if it shall be processed.

doSymbol
bool doSymbol(string symbol)

Query the controller for a decision if it shall be processed.

getIncludes
Path[] getIncludes()

A list of includes for the test double header.

doGoogleMock
bool doGoogleMock()

Controls generation of google mock.

doPreIncludes
bool doPreIncludes()

Generate a pre_include header file from internal template?

doIncludeOfPreIncludes
bool doIncludeOfPreIncludes()

Generate a #include of the pre include header

doPostIncludes
bool doPostIncludes()

Generate a post_include header file from internal template?

doIncludeOfPostIncludes
bool doIncludeOfPostIncludes()

Generate a #include of the post include header

doLocationAsComment
bool doLocationAsComment()

Generate location of symbols as comments

From Parameters

Files
struct Files
Undocumented in source.
getIncludes
Path[] getIncludes()

Source files used to generate the test double.

getOutputDirectory
Path getOutputDirectory()

Output directory to store files in.

getFiles
Files getFiles()

Files to write generated test double data to.

getMainName
MainName getMainName()

Name affecting interface, namespace and output file.

getMainNs
MainNs getMainNs()

Namespace for the generated test double.

getMainInterface
MainInterface getMainInterface()

Name of the interface of the test double.

getFilePrefix
StubPrefix getFilePrefix()

Prefix to use for the generated files.

getArtifactPrefix
StubPrefix getArtifactPrefix()

Prefix used for test artifacts.

getToolVersion
DextoolVersion getToolVersion()

Dextool Tool version.

getCustomHeader
CustomHeader getCustomHeader()

Custom header to prepend generated files with.

generateZeroGlobals
Flag!"generateZeroGlobals" generateZeroGlobals()

If an implementation of the interface for globals that zeroes them shall be generated.

From Products

putFile
void putFile(Path fname, CppHModule hdr_data)
void putFile(Path fname, CppModule impl_data)

Data pushed from the test double generator to be written to files.

putLocation
void putLocation(Path loc, LocationType type)

During the translation phase the location of symbols that aren't filtered out are pushed to the variant.

Meta