platexobj_utils.h File Reference

#include <map>
#include "PLatexObj.h"
#include "PLatexObj_def.h"
#include "platexobj_formulae.h"

Include dependency graph for platexobj_utils.h:

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

Go to the source code of this file.

Typedefs
typedef PVecPath	PListFile
	List of file. More...
typedef std::map< PString, PEnvironement >	PMapExtraEnv
	Vector of extra environement. More...
typedef std::vector< PContext >	PVecContext
	Vector of context. More...
typedef std::vector< PLatexEnv >	PVecLatexEnv
	Vector of env. More...
typedef std::vector< PLatexFunc >	PVecLatexFunc
	Vector of functions. More...
typedef std::vector< PLatexObj >	PVecLatexObj
	Vector of obj. More...
typedef std::vector< PLatexMenu >	PVecMenu
	Vector of PLatexMenu. More...
typedef std::vector< long unsigned int >	PVecNumber
	Vector of section number. More...
typedef std::vector< PLatexObj * >	PVecPtrSection
	Vector of section pointer. More...

Functions
void	appendVecContent (std::vector< PLatexObj > &vecContent, const PLatexObj &obj)
	Append a PLatexObj in the given vector of content. More...
void	appendVecContent (std::vector< PLatexObj > &vecContent, const std::vector< PLatexObj > &vecObj)
	Append a vector of PLatexObj in the given vector of content. More...
PString	convertBackSlahedStr (const PString &str)
	Convert all the echaped char. More...
PString	getSecNumberFromFileName (const PPath &fileName)
	Get the section number from its file name. More...
long unsigned int	getSectionLevel (const PLatexObj &obj)
	Return the section level. More...
PString	getSectionTitle (POutoutMode &outputMode, const PLatexObj &obj)
	Get the title of a part/chapter/section etc. More...
bool	isNewLine (const PLatexObj &obj)
	Say if the PLatexObj is a newline or not. More...
bool	isSection (const PLatexObj &obj)
	Say if the PLatexObj is a part, charpter, section, subsection or subsubsection. More...
bool	isSectionOrSeparator (const PLatexObj &obj)
	Say if the PLatexObj is a part, charpter, section, subsection, subsubsection or a book separator. More...
bool	isSeparator (const PLatexObj &obj)
	Say if the PLatexObj is a book separator. More...

Typedef Documentation

PListFile

typedef PVecPath PListFile

List of file.

Definition at line 23 of file platexobj_utils.h.

PMapExtraEnv

typedef std::map<PString, PEnvironement> PMapExtraEnv

Vector of extra environement.

Definition at line 26 of file platexobj_utils.h.

PVecContext

typedef std::vector<PContext> PVecContext

Vector of context.

Definition at line 29 of file platexobj_utils.h.

PVecLatexEnv

typedef std::vector<PLatexEnv> PVecLatexEnv

Vector of env.

Definition at line 18 of file platexobj_utils.h.

PVecLatexFunc

typedef std::vector<PLatexFunc> PVecLatexFunc

Vector of functions.

Definition at line 20 of file platexobj_utils.h.

PVecLatexObj

typedef std::vector<PLatexObj> PVecLatexObj

Vector of obj.

Definition at line 16 of file platexobj_utils.h.

PVecMenu

typedef std::vector<PLatexMenu> PVecMenu

Vector of PLatexMenu.

Definition at line 38 of file platexobj_utils.h.

PVecNumber

typedef std::vector<long unsigned int> PVecNumber

Vector of section number.

Definition at line 35 of file platexobj_utils.h.

PVecPtrSection

typedef std::vector<PLatexObj*> PVecPtrSection

Vector of section pointer.

Definition at line 32 of file platexobj_utils.h.

Function Documentation

appendVecContent() [1/2]

void appendVecContent	(	std::vector< PLatexObj > &	vecContent,
		const PLatexObj &	obj
	)

Append a PLatexObj in the given vector of content.

Parameters

[out]	vecContent	: vector of content to be updated
	obj	: PLatexObj to be appended

Definition at line 120 of file platexobj_utils.cpp.

                                                                               {
        if(obj.getType() == PLatexType::NONE){
                appendVecContent(vecContent, obj.getVecContent());
        }else{
                vecContent.push_back(obj);
        }
}

References appendVecContent(), PLatexObj::getType(), PLatexObj::getVecContent(), and PLatexType::NONE.

Here is the call graph for this function:

appendVecContent() [2/2]

void appendVecContent	(	std::vector< PLatexObj > &	vecContent,
		const std::vector< PLatexObj > &	vecObj
	)

Append a vector of PLatexObj in the given vector of content.

Parameters

[out]	vecContent	: vector of content to be updated
	vecObj	: vector of PLatexObj to be appended

Definition at line 110 of file platexobj_utils.cpp.

                                                                                             {
        for(std::vector<PLatexObj>::const_iterator it(vecObj.begin()); it != vecObj.end(); ++it){
                vecContent.push_back(*it);
        }
}

Referenced by appendVecContent(), platexobj_createItem(), platexobj_createParagraph(), platexobj_createRef(), platexobj_createTimetableBlock(), and pspeaker_texSpeaker().

Here is the caller graph for this function:

convertBackSlahedStr()

PString convertBackSlahedStr

(

const PString &

str

)

Convert all the echaped char.

Parameters

str

: string

Returns

string

Definition at line 65 of file platexobj_utils.cpp.

                                                 {
        PString out(str.replace("\\n", "\n"));
        out = out.replace("\\t", "\t");
        out = out.replace("\\r", "\r");
        out = out.replace("&lt;", "<");
        out = out.replace("&gt;", ">");
        out = out.replace("&bsol;", "\\");
        out = out.replace("&#126;", "~");
        out = out.replace("&amp;", "&");
        return out;
}

References PString::replace().

Referenced by PGenericParser::loadDirExtraParserFile().

Here is the call graph for this function:

Here is the caller graph for this function:

getSecNumberFromFileName()

PString getSecNumberFromFileName

(

const PPath &

fileName

)

Get the section number from its file name.

Parameters

fileName

: input filename

Returns

corresponding section number

Definition at line 81 of file platexobj_utils.cpp.

                                                        {
        if(fileName.size() <= 1lu){return fileName;}
        long unsigned int begin(fileName.size() - 1lu);
        
        while(begin > 0lu && begin < fileName.size()){
                char ch = fileName[begin];
                if(ch == '-'){
                        break;
                }
                --begin;
        }
        
        PString out(fileName.substr(0lu, begin));
        return out;
}

Referenced by vecMenuToHtml().

Here is the caller graph for this function:

getSectionLevel()

long unsigned int getSectionLevel

(

const PLatexObj &

obj

)

Return the section level.

Parameters

obj	: PLatexObj to be checked

Returns

level of the PLatexObj

Definition at line 50 of file platexobj_utils.cpp.

                                                        {
        PLatexType::PLatexType type(obj.getType());
        if(type == PLatexType::PART){return 0lu;}
        else if(type == PLatexType::CHAPTER){return 1lu;}
        else if(type == PLatexType::SECTION){return 2lu;}
        else if(type == PLatexType::SUBSECTION){return 3lu;}
        else if(type == PLatexType::SUBSUBSECTION){return 4lu;}
        else if(type == PLatexType::BOOKPARTSEPARATOR){return 0lu;}
        return -1lu;
}

References PLatexType::BOOKPARTSEPARATOR, PLatexType::CHAPTER, PLatexObj::getType(), PLatexType::PART, PLatexType::SECTION, PLatexType::SUBSECTION, and PLatexType::SUBSUBSECTION.

Referenced by addSectionInVecPtrSection(), addSeparatorInVecPtrSection(), and platexobj_orderGetSmallerLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

getSectionTitle()

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

Get the title of a part/chapter/section etc.

Parameters

outputMode	: mode used to create and remember formalae
obj	: section to be used

Returns

title of the corresponding section

Definition at line 102 of file platexobj_utils.cpp.

                                                                        {
        return platexobj_htmlStr(outputMode, obj.getComplexTitle());
}

References PLatexObj::getComplexTitle(), and platexobj_htmlStr().

Referenced by createOutlineHtmlStr(), platexobj_book_createPage(), platexobj_htmlStrAllPart(), updateMenu(), updateNextPrev(), and updateParent().

Here is the call graph for this function:

Here is the caller graph for this function:

isNewLine()

bool isNewLine

(

const PLatexObj &

obj

)

Say if the PLatexObj is a newline or not.

Parameters

obj	: PLatexObj to be checked

Returns

true if the obj is a newline, false otherwise

Definition at line 41 of file platexobj_utils.cpp.

                                     {
        PLatexType::PLatexType type(obj.getType());
        return type == PLatexType::SPACEPARAGRAPH || type == PLatexType::AUTOSPACEPARAGRAPH;
}

References PLatexType::AUTOSPACEPARAGRAPH, PLatexObj::getType(), and PLatexType::SPACEPARAGRAPH.

Referenced by updateNewLineBase().

Here is the call graph for this function:

Here is the caller graph for this function:

isSection()

bool isSection

(

const PLatexObj &

obj

)

Say if the PLatexObj is a part, charpter, section, subsection or subsubsection.

Parameters

obj	: PLatexObj to be checked

Returns

true if the obj is a part, charpter, section, subsection or subsubsection, false otherwise

Definition at line 15 of file platexobj_utils.cpp.

                                     {
        PLatexType::PLatexType type(obj.getType());
        return (type == PLatexType::PART || type == PLatexType::CHAPTER || type == PLatexType::SECTION || type == PLatexType::SUBSECTION || type == PLatexType::SUBSUBSECTION);
}

References PLatexType::CHAPTER, PLatexObj::getType(), PLatexType::PART, PLatexType::SECTION, PLatexType::SUBSECTION, and PLatexType::SUBSUBSECTION.

Referenced by createOutlineHtmlStr(), isSectionOrSeparator(), platexobj_order(), platexobj_updateFileName(), platexobj_updateLink(), platexobj_updateNumber(), updateMenu(), updateNextPrev(), updateParent(), updateSectionWip(), and updateWip().

Here is the call graph for this function:

Here is the caller graph for this function:

isSectionOrSeparator()

bool isSectionOrSeparator

(

const PLatexObj &

obj

)

Say if the PLatexObj is a part, charpter, section, subsection, subsubsection or a book separator.

Parameters

obj	: PLatexObj to be checked

Returns

true if the obj is a part, charpter, section, subsection, subsubsection or a book separator, false otherwise

Definition at line 33 of file platexobj_utils.cpp.

                                                {
        return isSection(obj) || isSeparator(obj);
}

References isSection(), and isSeparator().

Referenced by platexobj_toMenuAll().

Here is the call graph for this function:

Here is the caller graph for this function:

isSeparator()

bool isSeparator

(

const PLatexObj &

obj

)

Say if the PLatexObj is a book separator.

Parameters

obj	: PLatexObj to be checked

Returns

true if the obj is a book separator, false otherwise

Definition at line 24 of file platexobj_utils.cpp.

                                       {
        PLatexType::PLatexType type(obj.getType());
        return type == PLatexType::BOOKPARTSEPARATOR;
}

References PLatexType::BOOKPARTSEPARATOR, and PLatexObj::getType().

Referenced by isSectionOrSeparator(), platexobj_order(), and PFullMenu::setIsSeparator().

Here is the call graph for this function:

Here is the caller graph for this function: