HelpCompiler Class Reference

#include <HelpCompiler.hxx>

Collaboration diagram for HelpCompiler:

Public Member Functions
	HelpCompiler (StreamTable &streamTable, fs::path in_inputFile, fs::path in_src, fs::path in_zipdir, fs::path in_resCompactStylesheet, fs::path in_resEmbStylesheet, std::string in_module, std::string in_lang, bool in_bExtensionMode)
void	compile ()

Private Member Functions
xmlDocPtr	getSourceDocument (const fs::path &filePath)
xmlDocPtr	compactXhpForJar (xmlDocPtr doc)
void	saveXhpForJar (xmlDocPtr doc, const fs::path &filePath)
xmlNodePtr	clone (xmlNodePtr node, const std::string &appl)

Static Private Member Functions
static void	tagBasicCodeExamples (xmlDocPtr doc)

Private Attributes
StreamTable &	streamTable
const fs::path	inputFile
const fs::path	src
const fs::path	zipdir
const std::string	module
const std::string	lang
const fs::path	resCompactStylesheet
const fs::path	resEmbStylesheet
bool	bExtensionMode
std::string	gui

Detailed Description

Definition at line 177 of file HelpCompiler.hxx.

Constructor & Destructor Documentation

HelpCompiler()

HelpCompiler::HelpCompiler	(	StreamTable &	streamTable,
		fs::path	in_inputFile,
		fs::path	in_src,
		fs::path	in_zipdir,
		fs::path	in_resCompactStylesheet,
		fs::path	in_resEmbStylesheet,
		std::string	in_module,
		std::string	in_lang,
		bool	in_bExtensionMode
	)

Definition at line 34 of file HelpCompiler.cxx.

References gui, and module.

Member Function Documentation

clone()

xmlNodePtr HelpCompiler::clone ( xmlNodePtr  node, const std::string &  appl  )

private

Definition at line 151 of file HelpCompiler.cxx.

References clone(), and gui.

Referenced by clone(), and compile().

compactXhpForJar()

xmlDocPtr HelpCompiler::compactXhpForJar ( xmlDocPtr  doc )

private

Definition at line 65 of file HelpCompiler.cxx.

References fs::path::native_file_string(), and resCompactStylesheet.

Referenced by saveXhpForJar().

compile()

void HelpCompiler::compile

(

)

Exceptions

HelpProcessingException
BasicCodeTagger::TaggerException

Definition at line 431 of file HelpCompiler.cxx.

References StreamTable::appl_doc, StreamTable::appl_helptexts, StreamTable::appl_hidlist, StreamTable::appl_keywords, bExtensionMode, clone(), StreamTable::document_module, StreamTable::document_path, StreamTable::document_title, StreamTable::dropappl(), General, getSourceDocument(), HCDBG, i, inputFile, module, fs::path::native_file_string(), and streamTable.

Referenced by HelpLinker::link().

getSourceDocument()

xmlDocPtr HelpCompiler::getSourceDocument ( const fs::path &  filePath )

private

Definition at line 113 of file HelpCompiler.cxx.

References bExtensionMode, filePath, fs::path::native_file_string(), resEmbStylesheet, saveXhpForJar(), src, and fs::path::toUTF8().

Referenced by compile().

saveXhpForJar()

void HelpCompiler::saveXhpForJar ( xmlDocPtr  doc, const fs::path &  filePath  )

private

Definition at line 81 of file HelpCompiler.cxx.

References compactXhpForJar(), fs::create_directory(), filePath, module, fs::native, fs::path::native_file_string(), pos, src, tagBasicCodeExamples(), and zipdir.

Referenced by getSourceDocument().

tagBasicCodeExamples()

void HelpCompiler::tagBasicCodeExamples ( xmlDocPtr  doc )

staticprivate

Definition at line 51 of file HelpCompiler.cxx.

References BasicCodeTagger::EMPTY_DOCUMENT, ex, and BasicCodeTagger::tagBasicCodes().

Referenced by saveXhpForJar().

Member Data Documentation

bExtensionMode

bool HelpCompiler::bExtensionMode

private

Definition at line 203 of file HelpCompiler.hxx.

Referenced by compile(), and getSourceDocument().

gui

std::string HelpCompiler::gui

private

Definition at line 204 of file HelpCompiler.hxx.

Referenced by clone(), and HelpCompiler().

inputFile

const fs::path HelpCompiler::inputFile

private

Definition at line 199 of file HelpCompiler.hxx.

Referenced by compile().

lang

const std::string HelpCompiler::lang

private

Definition at line 200 of file HelpCompiler.hxx.

module

const std::string HelpCompiler::module

private

Definition at line 200 of file HelpCompiler.hxx.

Referenced by compile(), and saveXhpForJar().

resCompactStylesheet

const fs::path HelpCompiler::resCompactStylesheet

private

Definition at line 201 of file HelpCompiler.hxx.

Referenced by compactXhpForJar().

resEmbStylesheet

const fs::path HelpCompiler::resEmbStylesheet

private

Definition at line 202 of file HelpCompiler.hxx.

Referenced by getSourceDocument().

src

const fs::path HelpCompiler::src

private

Definition at line 199 of file HelpCompiler.hxx.

Referenced by getSourceDocument(), and saveXhpForJar().

streamTable

StreamTable& HelpCompiler::streamTable

private

Definition at line 198 of file HelpCompiler.hxx.

Referenced by compile().

zipdir

const fs::path HelpCompiler::zipdir

private

Definition at line 199 of file HelpCompiler.hxx.

Referenced by saveXhpForJar().

---

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

• HelpCompiler.hxx
• HelpCompiler.cxx