top | up | prev | next

Project Class

Definition at line 33 of Project.hpp

Constructors

Project(const std::string& docFilePath_)

Member Functions

bool	BuildAst(bool verbose, bool rebuild)
void	BuildSymbolTable()
void	Clean(bool verbose, bool single)
void	GenerateAst(bool verbose, bool rebuild, bool readAst)
void	GenerateContent(bool verbose, bool rebuild, bool endMessage, bool single)
void	GenerateContentXml(bool verbose, bool rebuild)
void	GenerateHtmlCodeFiles(bool verbose, bool rebuild)
void	GenerateHtmlContent(bool verbose, bool rebuild)
void	GenerateStyleSheet()
SourceFileNode*	GetSourceFile(const std::string& sourceFilePath) const override
void	ImportAsts(bool verbose)
void	MakeDirectories()
void	Process(bool verbose, bool rebuild, bool single)
void	ReadAst(bool verbose)
void	ReadChildren()
void	ReadContentXml(bool verbose)
void	ReadDocumentationXml(bool verbose, bool& rebuild)
void	ReadFilePaths(bool verbose)
void	ReadFilter()
void	ReadGrammarXmlFiles(bool verbose)
void	ReadImports()
void	ReadIncludePath()
void	ReadName()
void	ReadParentNameAndSiblings()
void	ReadTop()
std::string	ResolveContentFilePath(const std::u32string& currentProjectName, const std::u32string& projectName, const std::string& relativeContentDirPath, const std::u32string& symbolId) override
void	RunChildren(bool verbose, bool rebuild, bool clean, bool single)
void	RunChildrenSingle(bool verbose, bool rebuild, bool clean, bool ast, bool content)
void	RunChildrenWithFlags(bool verbose, bool rebuild, const std::string& flags)
void	SetAstFilePath()
void	SetContentXmlFilePath()
void	SetHtmlFilePath()
void	WriteAst(bool verbose)
void	WriteContentXml(bool verbose)

Member Variables

std::unique_ptr<Node>	ast
std::string	astFilePath
bool	astGenerated
std::vector<std::u32string>	childNames
std::vector<std::u32string>	childProjects
std::vector<std::string>	children
bool	childrenRead
std::string	contentDir
std::unique_ptr<Document>	contentXml
std::string	contentXmlFilePath
bool	contentXmlUpToDate
Context	context
std::unique_ptr<Document>	doc
std::string	docFilePath
std::unique_ptr<Document>	documentationXml
std::string	documentationXmlFileName
std::string	fileDir
std::vector<File>	filePaths
FilterList	filters
std::vector<Grammar>	grammars
std::unique_ptr<Document>	grammarsXmlDoc
std::string	grammarsXmlFilePath
ProjectHeaderFileSet	headerFiles
std::string	htmlDir
std::string	htmlFilePath
std::vector<std::string>	importAstFilePaths
std::vector<std::unique_ptr<Node>>	importAsts
std::map<std::u32string, Import*>	importMap
std::vector<std::vector<SourceFileNode*>>	importSourceFiles
std::vector<std::unique_ptr<Import>>	imports
std::string	includePath
std::unordered_map<std::u32string, std::unique_ptr<Element>>	inlineCodeMap
std::vector<std::unique_ptr<Lexer>>	lexers
std::u32string	name
std::u32string	parentName
std::string	projectRoot
std::string	rootDir
std::vector<std::u32string>	siblingProjects
std::map<std::string, SourceFileNode*>	sourceFileMap
std::vector<SourceFileNode*>	sourceFiles
std::string	styleDir
std::string	styleDirName
std::string	styleFileName
SymbolTable	symbolTable
int	thisProjectIndex
std::u32string	topLink
bool	upToDate

Constructor Details

Project Constructor

gendoc::Project::Project(const std::string& docFilePath_)

Definition at line 43 of Project.cpp
Declaration at line 36 of Project.hpp

Member Function Details

BuildAst Member Function

bool gendoc::Project::BuildAst(bool verbose, bool rebuild)

Definition at line 783 of Project.cpp
Declaration at line 55 of Project.hpp

Calls: SourceFileParser::Parse , gendoc::File::Included , gendoc::File::Name , gendoc::File::Path , sngcpp::pp::PP::Define , soulng::util::Path::GetExtension

Called by: gendoc::Project::GenerateAst

BuildSymbolTable Member Function

void gendoc::Project::BuildSymbolTable()

Definition at line 904 of Project.cpp
Declaration at line 59 of Project.hpp

Calls: gendoc::Import::Name , sngcpp::binder::TypeBinder::ClassesHavingVirtualFunctions , sngcpp::binder::TypeBinder::SourceFileMap , sngcpp::binder::TypeBinder::SourceFiles , sngcpp::symbols::SymbolTable::SetGendocMode

Called by: gendoc::Project::GenerateContent

Clean Member Function

void gendoc::Project::Clean(bool verbose, bool single)

Definition at line 57 of Project.cpp
Declaration at line 38 of Project.hpp

Calls: gendoc::Project::ReadName , gendoc::Project::RunChildren , gendoc::Project::SetAstFilePath , gendoc::Project::SetContentXmlFilePath , gendoc::Project::SetHtmlFilePath , soulng::util::Path::Combine

Called by: gendoc::Project::RunChildrenSingle

GenerateAst Member Function

void gendoc::Project::GenerateAst(bool verbose, bool rebuild, bool readAst)

Definition at line 284 of Project.cpp
Declaration at line 43 of Project.hpp

Calls: gendoc::Project::BuildAst , gendoc::Project::ReadAst , gendoc::Project::ReadChildren , gendoc::Project::ReadFilePaths , gendoc::Project::ReadFilter , gendoc::Project::ReadImports , gendoc::Project::ReadIncludePath , gendoc::Project::ReadName , gendoc::Project::ReadParentNameAndSiblings , gendoc::Project::ReadTop , gendoc::Project::SetAstFilePath , gendoc::Project::SetContentXmlFilePath , gendoc::Project::WriteAst

Called by: gendoc::Project::Process , gendoc::Project::RunChildrenSingle

GenerateContent Member Function

void gendoc::Project::GenerateContent(bool verbose, bool rebuild, bool endMessage, bool single)

GenerateContentXml Member Function

void gendoc::Project::GenerateContentXml(bool verbose, bool rebuild)

Definition at line 940 of Project.cpp
Declaration at line 60 of Project.hpp

Calls: gendoc::Project::ReadContentXml , gendoc::Project::WriteContentXml

Called by: gendoc::Project::GenerateContent

GenerateHtmlCodeFiles Member Function

void gendoc::Project::GenerateHtmlCodeFiles(bool verbose, bool rebuild)

Definition at line 1033 of Project.cpp
Declaration at line 65 of Project.hpp

Calls: soulng::util::Path::Combine

Called by: gendoc::Project::GenerateContent

GenerateHtmlContent Member Function

void gendoc::Project::GenerateHtmlContent(bool verbose, bool rebuild)

Definition at line 1143 of Project.cpp
Declaration at line 67 of Project.hpp

Calls: gendoc::Project::ReadDocumentationXml

Called by: gendoc::Project::GenerateContent

GenerateStyleSheet Member Function

void gendoc::Project::GenerateStyleSheet()

Definition at line 1028 of Project.cpp
Declaration at line 64 of Project.hpp

Called by: gendoc::Project::GenerateContent

GetSourceFile Member Function

SourceFileNode * gendoc::Project::GetSourceFile(const std::string& sourceFilePath) const override

Definition at line 1211 of Project.cpp
Declaration at line 71 of Project.hpp

Base class overridden functions: sngcpp::binder::SourceFileResolver::GetSourceFile

ImportAsts Member Function

void gendoc::Project::ImportAsts(bool verbose)

Definition at line 888 of Project.cpp
Declaration at line 58 of Project.hpp

Calls: sngcpp::ast::Reader::ReadNode , soulng::util::Path::Combine

Called by: gendoc::Project::GenerateContent

MakeDirectories Member Function

void gendoc::Project::MakeDirectories()

Definition at line 1023 of Project.cpp
Declaration at line 63 of Project.hpp

Called by: gendoc::Project::GenerateContent

Process Member Function

void gendoc::Project::Process(bool verbose, bool rebuild, bool single)

Definition at line 49 of Project.cpp
Declaration at line 37 of Project.hpp

Calls: gendoc::Project::GenerateAst , gendoc::Project::GenerateContent , gendoc::Project::ReadName , gendoc::Project::RunChildren

ReadAst Member Function

void gendoc::Project::ReadAst(bool verbose)

Definition at line 876 of Project.cpp
Declaration at line 57 of Project.hpp

Calls: sngcpp::ast::Reader::ReadNode

Called by: gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

ReadChildren Member Function

void gendoc::Project::ReadChildren()

Definition at line 79 of Project.cpp
Declaration at line 39 of Project.hpp

Calls: sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length , soulng::util::Path::Combine

Called by: gendoc::Project::GenerateAst , gendoc::Project::GenerateContent , gendoc::Project::RunChildren

ReadContentXml Member Function

void gendoc::Project::ReadContentXml(bool verbose)

Definition at line 1014 of Project.cpp
Declaration at line 62 of Project.hpp

Called by: gendoc::Project::GenerateContentXml

ReadDocumentationXml Member Function

void gendoc::Project::ReadDocumentationXml(bool verbose, bool & rebuild)

Definition at line 1102 of Project.cpp
Declaration at line 68 of Project.hpp

Calls: sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length , soulng::util::Path::Combine , soulng::util::Path::MakeCanonical

Called by: gendoc::Project::GenerateHtmlContent

ReadFilePaths Member Function

void gendoc::Project::ReadFilePaths(bool verbose)

Definition at line 601 of Project.cpp
Declaration at line 50 of Project.hpp

Calls: gendoc::File::Included , gendoc::File::Path , gendoc::FilterList::Apply , sngcpp::pp::ProjectHeaderFileSet::AddProjectHeaderFile , sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length , soulng::util::Path::Combine , soulng::util::Path::GetDirectoryName , soulng::util::Path::GetExtension

Called by: gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

ReadFilter Member Function

void gendoc::Project::ReadFilter()

Definition at line 566 of Project.cpp
Declaration at line 48 of Project.hpp

Calls: gendoc::FilterList::Add , sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length

Called by: gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

ReadGrammarXmlFiles Member Function

void gendoc::Project::ReadGrammarXmlFiles(bool verbose)

Definition at line 1047 of Project.cpp
Declaration at line 66 of Project.hpp

Calls: sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length , soulng::util::Path::Combine , soulng::util::Path::GetFileNameWithoutExtension , soulng::util::Path::MakeCanonical

Called by: gendoc::Project::GenerateContent

ReadImports Member Function

void gendoc::Project::ReadImports()

Definition at line 705 of Project.cpp
Declaration at line 51 of Project.hpp

Calls: sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length , soulng::util::Path::Combine

Called by: gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

ReadIncludePath Member Function

void gendoc::Project::ReadIncludePath()

Definition at line 751 of Project.cpp
Declaration at line 49 of Project.hpp

Calls: sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length , soulng::util::Path::MakeCanonical

Called by: gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

ReadName Member Function

void gendoc::Project::ReadName()

Definition at line 411 of Project.cpp
Declaration at line 45 of Project.hpp

Calls: sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length

Called by: gendoc::Project::Clean , gendoc::Project::GenerateAst , gendoc::Project::GenerateContent , gendoc::Project::Process

ReadParentNameAndSiblings Member Function

void gendoc::Project::ReadParentNameAndSiblings()

Definition at line 483 of Project.cpp
Declaration at line 47 of Project.hpp

Calls: sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length , soulng::util::Path::Combine

Called by: gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

ReadTop Member Function

void gendoc::Project::ReadTop()

Definition at line 444 of Project.cpp
Declaration at line 46 of Project.hpp

Calls: sngxml::dom::Element::GetAttribute , sngxml::dom::Node::GetNodeType , sngxml::xpath::XPathNodeSet::Length , soulng::util::Path::Combine , soulng::util::Path::GetDirectoryName

Called by: gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

ResolveContentFilePath Member Function

std::string gendoc::Project::ResolveContentFilePath(const std::u32string& currentProjectName, const std::u32string& projectName, const std::string& relativeContentDirPath, const std::u32string& symbolId) override

Definition at line 1184 of Project.cpp
Declaration at line 69 of Project.hpp

Base class overridden functions: gendoc::html::HtmlContentFilePathResolver::ResolveContentFilePath

Calls: gendoc::Import::RelativePath , soulng::util::Path::Combine

RunChildren Member Function

void gendoc::Project::RunChildren(bool verbose, bool rebuild, bool clean, bool single)

Definition at line 133 of Project.cpp
Declaration at line 40 of Project.hpp

Calls: gendoc::Project::ReadChildren , gendoc::Project::RunChildrenSingle , gendoc::Project::RunChildrenWithFlags , soulng::util::Path::Combine , soulng::util::Path::GetDirectoryName

Called by: gendoc::Project::Clean , gendoc::Project::GenerateContent , gendoc::Project::Process

RunChildrenSingle Member Function

void gendoc::Project::RunChildrenSingle(bool verbose, bool rebuild, bool clean, bool ast, bool content)

Definition at line 205 of Project.cpp
Declaration at line 42 of Project.hpp

Calls: gendoc::Project::Clean , gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

Called by: gendoc::Project::RunChildren

RunChildrenWithFlags Member Function

void gendoc::Project::RunChildrenWithFlags(bool verbose, bool rebuild, const std::string& flags)

Definition at line 225 of Project.cpp
Declaration at line 41 of Project.hpp

Called by: gendoc::Project::RunChildren

SetAstFilePath Member Function

void gendoc::Project::SetAstFilePath()

Definition at line 396 of Project.cpp
Declaration at line 52 of Project.hpp

Calls: soulng::util::Path::Combine

Called by: gendoc::Project::Clean , gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

SetContentXmlFilePath Member Function

void gendoc::Project::SetContentXmlFilePath()

Definition at line 401 of Project.cpp
Declaration at line 53 of Project.hpp

Calls: soulng::util::Path::Combine

Called by: gendoc::Project::Clean , gendoc::Project::GenerateAst , gendoc::Project::GenerateContent

SetHtmlFilePath Member Function

void gendoc::Project::SetHtmlFilePath()

Definition at line 406 of Project.cpp
Declaration at line 54 of Project.hpp

Calls: soulng::util::Path::Combine

Called by: gendoc::Project::Clean

WriteAst Member Function

void gendoc::Project::WriteAst(bool verbose)

Definition at line 859 of Project.cpp
Declaration at line 56 of Project.hpp

Called by: gendoc::Project::GenerateAst

WriteContentXml Member Function

void gendoc::Project::WriteContentXml(bool verbose)

Definition at line 1001 of Project.cpp
Declaration at line 61 of Project.hpp

Calls: sngcpp::symbols::SymbolTable::ToDomDocument , soulng::util::CodeFormatter::SetIndentSize

Called by: gendoc::Project::GenerateContentXml

top | up | prev | next