PlantUMLFrontend

Frontend for PlantUML generator.

TODO implement --in=... for multi-file handling

class PlantUMLFrontend : Controller , Parameters , Products {}

Constructors

this
this(FilePrefix file_prefix, Path output_dir, Flag!"doStyleIncl" style_incl, Flag!"doGenDot" gen_dot, Flag!"genClassMethod" class_method, Flag!"genClassParamDependency" class_param_dep, Flag!"genClassInheritDependency" class_inherit_dep, Flag!"genClassMemberDependency" class_member_dep, Flag!"doComponentByFile" do_comp_by_file)
Undocumented in source.

Members

Functions

doComponentNameStrip
Path doComponentNameStrip(Path fname)
Undocumented in source. Be warned that the author may not have intended to support it.
doFile
bool doFile(string filename, string info)
Undocumented in source. Be warned that the author may not have intended to support it.
doGenDot
Flag!"doGenDot" doGenDot()
Undocumented in source. Be warned that the author may not have intended to support it.
doStyleIncl
Flag!"doStyleIncl" doStyleIncl()
Undocumented in source. Be warned that the author may not have intended to support it.
genClassInheritDependency
Flag!"genClassInheritDependency" genClassInheritDependency()
Undocumented in source. Be warned that the author may not have intended to support it.
genClassMemberDependency
Flag!"genClassMemberDependency" genClassMemberDependency()
Undocumented in source. Be warned that the author may not have intended to support it.
genClassMethod
Flag!"genClassMethod" genClassMethod()
Undocumented in source. Be warned that the author may not have intended to support it.
genClassParamDependency
Flag!"genClassParamDependency" genClassParamDependency()
Undocumented in source. Be warned that the author may not have intended to support it.
genStyleInclFile
Flag!"genStyleInclFile" genStyleInclFile()
Undocumented in source. Be warned that the author may not have intended to support it.
getFilePrefix
FilePrefix 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.
getOutputDirectory
Path getOutputDirectory()
Undocumented in source. Be warned that the author may not have intended to support it.
putFile
void putFile(Path fname, PlantumlRootModule root)
Undocumented in source. Be warned that the author may not have intended to support it.
putFile
void putFile(Path fname, PlantumlModule pm)
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

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

Static variables

fileExt
auto fileExt;
Undocumented in source.
inclExt
auto inclExt;
Undocumented in source.

Structs

FileData
struct FileData
Undocumented in source.

Variables

comp_strip
Regex!char comp_strip;
Undocumented in source.
do_comp_by_file
Flag!"doComponentByFile" do_comp_by_file;
Undocumented in source.
do_gen_dot
Flag!"doGenDot" do_gen_dot;
Undocumented in source.
do_style_incl
Flag!"doStyleIncl" do_style_incl;
Undocumented in source.
fileData
FileData[] fileData;

Data produced by the generator intended to be written to specified file.

fileFilter
ReFilter fileFilter;
Undocumented in source.
file_classes
Path file_classes;
Undocumented in source.
file_components
Path file_components;
Undocumented in source.
file_prefix
FilePrefix file_prefix;
Undocumented in source.
file_style
Path file_style;
Undocumented in source.
file_style_output
Path file_style_output;
Undocumented in source.
gen_class_inherit_dep
Flag!"genClassInheritDependency" gen_class_inherit_dep;
Undocumented in source.
gen_class_member_dep
Flag!"genClassMemberDependency" gen_class_member_dep;
Undocumented in source.
gen_class_method
Flag!"genClassMethod" gen_class_method;
Undocumented in source.
gen_class_param_dep
Flag!"genClassParamDependency" gen_class_param_dep;
Undocumented in source.
input_files
Path[] input_files;
Undocumented in source.
output_dir
Path output_dir;
Undocumented in source.

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.

genStyleInclFile
Flag!"genStyleInclFile" genStyleInclFile()

Determine by checking the filesystem if a templated PREFIX_style file shall be created.

doComponentNameStrip
Path doComponentNameStrip(Path fname)

Strip the filename according to user regex.

From Parameters

Files
struct Files
Undocumented in source.
getOutputDirectory
Path getOutputDirectory()

Output directory to store files in.

getFiles
Files getFiles()

Files to write generated diagram data to.

getFilePrefix
FilePrefix getFilePrefix()

Name affecting filenames.

doStyleIncl
Flag!"doStyleIncl" doStyleIncl()

In all diagrams generate an "!include" of the style file.

doGenDot
Flag!"doGenDot" doGenDot()

Generate a dot graph in the plantuml file

genClassMethod
Flag!"genClassMethod" genClassMethod()

If class methods should be part of the generated class diagrams.

genClassParamDependency
Flag!"genClassParamDependency" genClassParamDependency()

If the parameters of methods should result in directed association.

genClassInheritDependency
Flag!"genClassInheritDependency" genClassInheritDependency()

If the inheritance hierarchy between classes is generated.

genClassMemberDependency
Flag!"genClassMemberDependency" genClassMemberDependency()

If the class members result in dependency on those members.

From Products

putFile
void putFile(Path fname, PlantumlRootModule data)
void putFile(Path fname, PlantumlModule data)

Data pushed from the generator to be written to files.

Meta