HelpLinker Class Reference

#include <HelpLinker.hxx>

Collaboration diagram for HelpLinker:

Public Member Functions
L10N_DLLPUBLIC void	main (std::vector< std::string > &args, std::string const *pExtensionPath=nullptr, std::string const *pDestination=nullptr, const OUString *pOfficeHelpPath=nullptr)
	HelpLinker ()

Private Member Functions
void	initIndexerPreProcessor ()
void	link ()

Static Private Member Functions
static void	addBookmark (FILE *pFile_DBHelp, std::string thishid, const std::string &fileB, const std::string &anchorB, const std::string &jarfileB, const std::string &titleB)

Private Attributes
Stringtable	additionalFiles
std::vector< std::string >	helpFiles
fs::path	sourceRoot
fs::path	compactStylesheet
fs::path	embeddStylesheet
fs::path	idxCaptionStylesheet
fs::path	idxContentStylesheet
fs::path	zipdir
fs::path	outputFile
std::string	extsource
std::string	extdestination
std::string	module
std::string	lang
std::string	extensionPath
std::string	extensionDestination
bool	bExtensionMode
fs::path	indexDirParentName
std::unique_ptr< IndexerPreProcessor >	m_pIndexerPreProcessor
bool	m_bUseLangRoot
bool	m_bCreateIndex

Detailed Description

Definition at line 44 of file HelpLinker.hxx.

Constructor & Destructor Documentation

HelpLinker()

HelpLinker::HelpLinker ( )

inline

Definition at line 53 of file HelpLinker.hxx.

Member Function Documentation

addBookmark()

void HelpLinker::addBookmark ( FILE *  pFile_DBHelp, std::string  thishid, const std::string &  fileB, const std::string &  anchorB, const std::string &  jarfileB, const std::string &  titleB  )

staticprivate

Definition at line 225 of file HelpLinker.cxx.

References URLEncoder::encode(), HCDBG, i, and writeKeyValue_DBHelp().

Referenced by link().

initIndexerPreProcessor()

void HelpLinker::initIndexerPreProcessor ( )

private

Definition at line 265 of file HelpLinker.cxx.

References idxCaptionStylesheet, idxContentStylesheet, indexDirParentName, and m_pIndexerPreProcessor.

Referenced by link().

link()

void HelpLinker::link ( )

private

Exceptions

HelpProcessingException
BasicCodeTagger::TaggerException

Definition at line 271 of file HelpLinker.cxx.

References addBookmark(), additionalFiles, fs::path::append(), StreamTable::appl_doc, StreamTable::appl_helptexts, StreamTable::appl_hidlist, StreamTable::appl_keywords, bExtensionMode, compactStylesheet, HelpCompiler::compile(), fs::copy(), fs::create_directory(), StreamTable::document_module, StreamTable::document_path, StreamTable::document_title, embeddStylesheet, URLEncoder::encode(), extensionDestination, extensionPath, FILE, HCDBG, helpFiles, index, indexDirParentName, initIndexerPreProcessor(), lang, m_bCreateIndex, m_bUseLangRoot, m_pIndexerPreProcessor, module, fs::native, fs::path::native_file_string(), SAL_WARN, sourceRoot, tocharlower(), writeKeyValue_DBHelp(), and zipdir.

Referenced by main().

main()

void HelpLinker::main	(	std::vector< std::string > &	args,
		std::string const *	pExtensionPath = nullptr,
		std::string const *	pDestination = nullptr,
		const OUString *	pOfficeHelpPath = nullptr
	)

Exceptions

HelpProcessingException

extsource.empty indicates extension mode using commandline

extsource.empty indicates extension mode using commandline

Definition at line 488 of file HelpLinker.cxx.

References additionalFiles, args, bExtensionMode, compactStylesheet, compare(), embeddStylesheet, fs::path::empty(), extdestination, extensionDestination, extensionPath, extsource, General, helpFiles, i, idxCaptionStylesheet, idxContentStylesheet, lang, link(), m_bCreateIndex, m_bUseLangRoot, module, fs::native, OUStringToOString(), outputFile, p, sourceRoot, fs::path::toUTF8(), and zipdir.

Referenced by compileExtensionHelp(), and SAL_IMPLEMENT_MAIN_WITH_ARGS().

Member Data Documentation

additionalFiles

Stringtable HelpLinker::additionalFiles

private

Definition at line 60 of file HelpLinker.hxx.

Referenced by link(), and main().

bExtensionMode

bool HelpLinker::bExtensionMode

private

Definition at line 75 of file HelpLinker.hxx.

Referenced by link(), and main().

compactStylesheet

fs::path HelpLinker::compactStylesheet

private

Definition at line 63 of file HelpLinker.hxx.

Referenced by link(), and main().

embeddStylesheet

fs::path HelpLinker::embeddStylesheet

private

Definition at line 64 of file HelpLinker.hxx.

Referenced by link(), and main().

extdestination

std::string HelpLinker::extdestination

private

Definition at line 70 of file HelpLinker.hxx.

Referenced by main().

extensionDestination

std::string HelpLinker::extensionDestination

private

Definition at line 74 of file HelpLinker.hxx.

Referenced by link(), and main().

extensionPath

std::string HelpLinker::extensionPath

private

Definition at line 73 of file HelpLinker.hxx.

Referenced by link(), and main().

extsource

std::string HelpLinker::extsource

private

Definition at line 69 of file HelpLinker.hxx.

Referenced by main().

helpFiles

std::vector<std::string> HelpLinker::helpFiles

private

Definition at line 61 of file HelpLinker.hxx.

Referenced by link(), and main().

idxCaptionStylesheet

fs::path HelpLinker::idxCaptionStylesheet

private

Definition at line 65 of file HelpLinker.hxx.

Referenced by initIndexerPreProcessor(), and main().

idxContentStylesheet

fs::path HelpLinker::idxContentStylesheet

private

Definition at line 66 of file HelpLinker.hxx.

Referenced by initIndexerPreProcessor(), and main().

indexDirParentName

fs::path HelpLinker::indexDirParentName

private

Definition at line 76 of file HelpLinker.hxx.

Referenced by initIndexerPreProcessor(), and link().

lang

std::string HelpLinker::lang

private

Definition at line 72 of file HelpLinker.hxx.

Referenced by link(), and main().

m_bCreateIndex

bool HelpLinker::m_bCreateIndex

private

Definition at line 79 of file HelpLinker.hxx.

Referenced by link(), and main().

m_bUseLangRoot

bool HelpLinker::m_bUseLangRoot

private

Definition at line 78 of file HelpLinker.hxx.

Referenced by link(), and main().

m_pIndexerPreProcessor

std::unique_ptr<IndexerPreProcessor> HelpLinker::m_pIndexerPreProcessor

private

Definition at line 77 of file HelpLinker.hxx.

Referenced by initIndexerPreProcessor(), and link().

module

std::string HelpLinker::module

private

Definition at line 71 of file HelpLinker.hxx.

Referenced by link(), and main().

outputFile

fs::path HelpLinker::outputFile

private

Definition at line 68 of file HelpLinker.hxx.

Referenced by main().

sourceRoot

fs::path HelpLinker::sourceRoot

private

Definition at line 62 of file HelpLinker.hxx.

Referenced by link(), and main().

zipdir

fs::path HelpLinker::zipdir

private

Definition at line 67 of file HelpLinker.hxx.

Referenced by link(), and main().

---

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

• HelpLinker.hxx
• HelpLinker.cxx