platexobj_formulae.h File Reference

#include <string>
#include <map>
#include "PPath.h"
#include "dico_replace_var.h"
#include "PLatexObj.h"
#include "platexobj_utils.h"

Include dependency graph for platexobj_formulae.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	POutoutMode
	Output mode of the html backend. More...

Macros
#define	FORMULAE_RECOVER_FILE   ".formulae_recover.map"
	Define the name of the file which contains the formulae and the path to the created file. More...

Typedefs
typedef std::map< PString, PString >	PMapFormula
	Map of the formulae generated by the ptex2html which can be reused by other PLatexObj which have the same formula. More...

Functions
PString	platexobj_htmlStrInlineMath (POutoutMode &outputMode, const PLatexObj &obj)
	Convert a PLatexObj into a string. More...
PString	platexobj_htmlStrLatex (POutoutMode &outputMode, const PLatexObj &obj, const PString &latexEnv)
	Convert a PLatexObj into a string. More...
void	platexobj_loadFormulaeMap (PMapFormula &mapFormula)
	Load the map file of all the formulae if it exists. More...
void	platexobj_saveFormulaeMap (const PMapFormula &mapFormula)
	Save the map file of the formulae to avoid extra latex call. More...
PString	platexobj_theme_createPage (POutoutMode &outputMode)
	Create the page from variables in POutoutMode. More...
void	platexobj_theme_init_var (POutoutMode &outputMode)
	Initialise basic variables of POutoutMode. More...
void	platexobj_theme_set_var (POutoutMode &outputMode, const PString &varName, const PString &value)
	Set a variable in the map of variable for theme (will take account the IS_XXX_BEGIN accordingly if the value is empty or not) More...
void	platexobj_theme_update_var (POutoutMode &outputMode, const PString &pageLink, const PString &pageTitle, const PString &prevSecLink, const PString &prevSecTitle, const PString &nextSecLink, const PString &nextSecTitle, const PString &parentSecLink, const PString &parentSecTitle, const PPath &currentSourceFile, size_t currentSourceLine)
	Update var of POutoutMode for current section. More...
void	platexobj_update_theme (POutoutMode &outputMode, const PPath &themeBaseFile)
	Update the theme of the generated website. More...

Macro Definition Documentation

FORMULAE_RECOVER_FILE

#define FORMULAE_RECOVER_FILE   ".formulae_recover.map"

Define the name of the file which contains the formulae and the path to the created file.

Definition at line 18 of file platexobj_formulae.h.

Typedef Documentation

PMapFormula

typedef std::map<PString,PString> PMapFormula

Map of the formulae generated by the ptex2html which can be reused by other PLatexObj which have the same formula.

Definition at line 21 of file platexobj_formulae.h.

Function Documentation

platexobj_htmlStrInlineMath()

PString platexobj_htmlStrInlineMath	(	POutoutMode &	outputMode,
		const PLatexObj &	obj
	)

Convert a PLatexObj into a string.

Parameters

[out]	outputMode	: output mode of the html backend
	obj	: PLatexObj to be converted into a string

Returns

output string which contains the PLatexObj

Definition at line 160 of file platexobj_formulae.cpp.

                                                                                    {
        PString body("");
        if(outputMode.isMathJaxMode){
                body += "$"+obj.getText()+"$\n";
        }else{
                PString fileNamePng(platexObj_createFormulaTex(outputMode, obj.getId(), "$", obj.getText()));
                body += "<span class=\"inlineformula\" /><img src=\"" + fileNamePng + "\" alt=\""+obj.getText()+"\" /></span>";
        }
        return body;
}

References PLatexObj::getId(), PLatexObj::getText(), POutoutMode::isMathJaxMode, and platexObj_createFormulaTex().

Here is the call graph for this function:

platexobj_htmlStrLatex()

PString platexobj_htmlStrLatex	(	POutoutMode &	outputMode,
		const PLatexObj &	obj,
		const PString &	latexEnv
	)

Convert a PLatexObj into a string.

Parameters

[out]	outputMode	: output mode of the html backend
	obj	: PLatexObj to be converted into a string
	latexEnv	: name of the latex environement to be used

Returns

output string which contains the PLatexObj

Definition at line 144 of file platexobj_formulae.cpp.

                                                                                                         {
        PString body("");
        if(outputMode.isMathJaxMode){
                body += "$$\\begin{"+latexEnv+"}"+obj.getText()+"\\end{"+latexEnv+"}$$\n";
        }else{
                PString fileNamePng(platexObj_createFormulaTex(outputMode, obj.getId(), latexEnv, obj.getText()));
                body += "<div class=\"formula\" /><img src=\"" + fileNamePng + "\" alt=\"nothing\" /></div>";
        }
        return body;
}

References PLatexObj::getId(), PLatexObj::getText(), POutoutMode::isMathJaxMode, and platexObj_createFormulaTex().

Here is the call graph for this function:

platexobj_loadFormulaeMap()

void platexobj_loadFormulaeMap

(

PMapFormula &

mapFormula

)

Load the map file of all the formulae if it exists.

Parameters

[out]

mapFormula

: map of formulae to be loaded to avoid calling latex too much

Definition at line 20 of file platexobj_formulae.cpp.

                                                        {
        PString fileName(FORMULAE_RECOVER_FILE);
        if(!data_load(fileName, mapFormula)){return;}
}

References data_load(), and FORMULAE_RECOVER_FILE.

Referenced by processAllFile().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_saveFormulaeMap()

void platexobj_saveFormulaeMap

(

const PMapFormula &

mapFormula

)

Save the map file of the formulae to avoid extra latex call.

Parameters

[out]

mapFormula

: map of formulae to be saved

Definition at line 28 of file platexobj_formulae.cpp.

                                                              {
        PString fileName(FORMULAE_RECOVER_FILE);
        if(!data_save(fileName, mapFormula)){return;}
}

References data_save(), and FORMULAE_RECOVER_FILE.

Referenced by processAllFile().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_theme_createPage()

PString platexobj_theme_createPage

(

POutoutMode &

outputMode

)

Create the page from variables in POutoutMode.

Parameters

[out]

outputMode

: POutoutMode to be used

Returns

html page content

Definition at line 266 of file platexobj_formulae.cpp.

                                                            {
        PString body("");
        dico_replace_nested_call(body, outputMode.themeCall, outputMode.mapVar, "${", "}");
        return body;
}

References dico_replace_nested_call(), POutoutMode::mapVar, and POutoutMode::themeCall.

Referenced by platexobj_book_createPage(), and platexobj_bookIndexHtml().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_theme_init_var()

void platexobj_theme_init_var

(

POutoutMode &

outputMode

)

Initialise basic variables of POutoutMode.

Parameters

[out]

outputMode

: POutoutMode to init variables

Definition at line 198 of file platexobj_formulae.cpp.

                                                       {
        outputMode.mapVar["${STYLE}"] = outputMode.currentStyle;
        if(outputMode.isBookTheme){
                platexobj_theme_set_var(outputMode, "AUTHOR_EMAIL", outputMode.bookMail);
                platexobj_theme_set_var(outputMode, "GITLAB_URL", outputMode.bookGitlabUrl);
                platexobj_theme_set_var(outputMode, "GITLAB_MASTER_URL", outputMode.bookMasterProjectUrl);
                outputMode.mapVar["${BOOK_TABLE_OF_CONTENT}"] = "";
        }
        PString bibliography("");
        if(outputMode.isBibliography){
                bibliography = "bibliography.html";
        }
        platexobj_theme_set_var(outputMode, "BIBLIOGRAPHY", bibliography);
        PString remoteMathjaxFile(""), localMathjax("");
        if(outputMode.isRemoteMathjax){
                remoteMathjaxFile = "load-mathjax.js";
        }else{
                if(outputMode.isMathJaxMode){
                        localMathjax = "MathJax.js";
                }
        }
        platexobj_theme_set_var(outputMode, "REMOTE_MATHJAX", remoteMathjaxFile);
        platexobj_theme_set_var(outputMode, "LOCAL_MATHJAX", localMathjax);
}

References POutoutMode::bookGitlabUrl, POutoutMode::bookMail, POutoutMode::bookMasterProjectUrl, POutoutMode::currentStyle, POutoutMode::isBibliography, POutoutMode::isBookTheme, POutoutMode::isMathJaxMode, POutoutMode::isRemoteMathjax, POutoutMode::mapVar, and platexobj_theme_set_var().

Referenced by processAllFile().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_theme_set_var()

void platexobj_theme_set_var	(	POutoutMode &	outputMode,
		const PString &	varName,
		const PString &	value
	)

Set a variable in the map of variable for theme (will take account the IS_XXX_BEGIN accordingly if the value is empty or not)

Parameters

[out]	outputMode	: POutoutMode to be updated
	varName	: name of the variable to be set
	value	: value of the variable to be set

Definition at line 184 of file platexobj_formulae.cpp.

                                                                                                      {
        outputMode.mapVar["${" + varName + "}"] = value;
        if(value == ""){
                outputMode.mapVar["${IS_" + varName + "_BEGIN}"] = "<!-- ";
                outputMode.mapVar["${IS_" + varName + "_END}"] = " -->";
        }else{
                outputMode.mapVar["${IS_" + varName + "_BEGIN}"] = "";
                outputMode.mapVar["${IS_" + varName + "_END}"] = "";
        }
}

References POutoutMode::mapVar.

Referenced by platexobj_theme_init_var(), and platexobj_theme_update_var().

Here is the caller graph for this function:

platexobj_theme_update_var()

void platexobj_theme_update_var	(	POutoutMode &	outputMode,
		const PString &	pageLink,
		const PString &	pageTitle,
		const PString &	prevSecLink,
		const PString &	prevSecTitle,
		const PString &	nextSecLink,
		const PString &	nextSecTitle,
		const PString &	parentSecLink,
		const PString &	parentSecTitle,
		const PPath &	currentSourceFile,
		size_t	currentSourceLine
	)

Update var of POutoutMode for current section.

Parameters

[out]	outputMode	: POutoutMode to be modified
	pageLink	: link of the current page
	pageTitle	: title of the current page
	prevSecLink	: link of the previous section
	prevSecTitle	: title of the previous section
	nextSecLink	: link of the next section
	nextSecTitle	: title of the next section
	parentSecLink	: link of the parent section
	parentSecTitle	: title of the parent section
	currentSourceFile	: current source file of the section
	currentSourceLine	: current source line of the section

Definition at line 236 of file platexobj_formulae.cpp.

{
        outputMode.mapVar["${PAGE_LINK}"] = pageLink;
        outputMode.mapVar["${PAGE_TITLE}"] = pageTitle;
        outputMode.mapVar["${PARENT_SECTION_TITLE}"] = parentSecTitle;
        platexobj_theme_set_var(outputMode, "PARENT_SECTION", parentSecLink);
        outputMode.mapVar["${PREV_PAGE_TITLE}"] = prevSecTitle;
        platexobj_theme_set_var(outputMode, "PREV_PAGE", prevSecLink);
        outputMode.mapVar["${NEXT_PAGE_TITLE}"] = nextSecTitle;
        platexobj_theme_set_var(outputMode, "NEXT_PAGE", nextSecLink);
        
        outputMode.mapVar["${CURRENT_SOURCE_FILE}"] = currentSourceFile.makeAbsolute().simplify().getUnderPath(PPath(outputMode.bookGitlabUrl).getFileName());
        outputMode.mapVar["${CURRENT_SOURCE_LINE}"] = valueToString(currentSourceLine);
        
//      outputMode.mapVar["${MAIN_TITLE}"] = "";
//      outputMode.mapVar["${SUB_MENU}"] = "";
        
        if(outputMode.isBookTheme){
                outputMode.mapVar["${BOOK_TABLE_OF_CONTENT}"] = platexobj_menuToHtml(outputMode.fullMenu, pageLink, outputMode.isBibliography);
        }
}

References POutoutMode::bookGitlabUrl, POutoutMode::fullMenu, PPath::getFileName(), PPath::getUnderPath(), POutoutMode::isBibliography, POutoutMode::isBookTheme, PPath::makeAbsolute(), POutoutMode::mapVar, platexobj_menuToHtml(), platexobj_theme_set_var(), PPath::simplify(), and valueToString().

Referenced by platexobj_book_createPage(), and platexobj_bookIndexHtml().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_update_theme()

void platexobj_update_theme	(	POutoutMode &	outputMode,
		const PPath &	themeBaseFile
	)

Update the theme of the generated website.

Parameters

[out]	outputMode	: POutoutMode to be updated
	themeBaseFile	: file which contains the theme we want to use

Definition at line 175 of file platexobj_formulae.cpp.

                                                                                  {
        dico_create_nested_call(outputMode.themeCall, themeBaseFile.loadFileContent(), "${", "}");
}

References dico_create_nested_call(), PPath::loadFileContent(), and POutoutMode::themeCall.

Referenced by processAllFile().

Here is the call graph for this function:

Here is the caller graph for this function: