platexobj_menu.cpp File Reference

#include "platexobj_html.h"
#include "platexobj_text.h"
#include "platexobj_menu.h"

Include dependency graph for platexobj_menu.cpp:

Go to the source code of this file.

Functions
bool	platexobg_isMenuExtanded (const PFullMenu &menu, const PString &currentLink)
	Say if the current menu has to be extended. More...
void	platexobj_makeExpandMenu (PFullMenu &menu, const PString &currentLink)
	Update menus which are supposed to be extended. More...
PString	platexobj_menuToHtml (const PFullMenu &menu, const PString &currentLink, bool isBibliography)
	Convert a PFullMenu to html. More...
PString	platexobj_menuToHtmlChapter (const PFullMenu &menu, const PString &indentation)
	Convert a PFullMenu to html. More...
PFullMenu	platexobj_toMenu (const PLatexObj &obj, const PLatexObj &mainPageLink)
	Convert a PLatexObj into a menu. More...
void	platexobj_toMenuAll (PFullMenu &menu, const PLatexObj &obj)
	Convert a PLatexObj into a menu. More...

Function Documentation

platexobg_isMenuExtanded()

bool platexobg_isMenuExtanded	(	const PFullMenu &	menu,
		const PString &	currentLink
	)

Say if the current menu has to be extended.

Parameters

menu	: PFullMenu to be checked
currentLink	: link of the menu to be expanded

Definition at line 104 of file platexobj_menu.cpp.

                                                                                  {
        return menu.getLink() == currentLink;
}

References PFullMenu::getLink().

Referenced by platexobj_makeExpandMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_makeExpandMenu()

void platexobj_makeExpandMenu	(	PFullMenu &	menu,
		const PString &	currentLink
	)

Update menus which are supposed to be extended.

Parameters

menu	: PFullMenu to be converted
currentLink	: link of the current menu

Definition at line 112 of file platexobj_menu.cpp.

                                                                            {
        bool isFirstExtended(platexobg_isMenuExtanded(menu, currentLink));      //Check if the current section has to be expanded
        menu.setIsFirstExpanded(isFirstExtended);
        bool isExtended(isFirstExtended);
        std::vector<PFullMenu> & vecSubMenu = menu.getVecSubMenu();
        std::vector<PFullMenu>::iterator it(vecSubMenu.begin());
        while(!isExtended && it != vecSubMenu.end()){
                platexobj_makeExpandMenu(*it, currentLink);
                isExtended = it->getIsExpanded();
                ++it;
        }
        menu.setIsExpanded(isExtended);
}

References PFullMenu::getVecSubMenu(), platexobg_isMenuExtanded(), PFullMenu::setIsExpanded(), and PFullMenu::setIsFirstExpanded().

Referenced by platexobj_menuToHtml().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_menuToHtml()

PString platexobj_menuToHtml	(	const PFullMenu &	menu,
		const PString &	currentLink,
		bool	isBibliography
	)

Convert a PFullMenu to html.

Parameters

menu	: PFullMenu to be converted
currentLink	: link of the current menu
isBibliography	: true if there is a bibliography, false if not

Returns

corresponding html

Definition at line 132 of file platexobj_menu.cpp.

                                                                                                      {
        PFullMenu expandedMenu(menu);
        platexobj_makeExpandMenu(expandedMenu, currentLink);
        
        PString body(""), indentation("\t\t");
        body += indentation+"<nav id=\"sidebar\" class=\"sidebar\" aria-label=\"Table of contents\">\n";
        body += indentation+"\t<div class=\"sidebar-scrollbox\">\n";
        body += indentation+"\t\t<ol class=\"chapter\">\n";
        body += indentation + "\t\t\t<li class=\"chapter-item \"><a href=\"index.html\">"+menu.getMainPageLink()+"</a></li>\n";
        const std::vector<PFullMenu> & vecSubMenu = expandedMenu.getVecSubMenu();
        for(std::vector<PFullMenu>::const_iterator it(vecSubMenu.begin()); it != vecSubMenu.end(); ++it){
                body += platexobj_menuToHtmlChapter(*it, indentation+"\t\t\t");
        }
        if(isBibliography){
                body += indentation + "\t\t\t<li class=\"chapter-item \"><a href=\"bibliography.html\">Bibliography</a></li>\n";
        }
        
        body += indentation+"\t\t</ol>\n";
        body += indentation+"\t</div>\n";
        body += indentation+"\t<div id=\"sidebar-resize-handle\" class=\"sidebar-resize-handle\"></div>\n";
        body += indentation+"</nav>\n";
        return body;
}

References PFullMenu::getMainPageLink(), PFullMenu::getVecSubMenu(), platexobj_makeExpandMenu(), and platexobj_menuToHtmlChapter().

Referenced by platexobj_theme_update_var().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_menuToHtmlChapter()

PString platexobj_menuToHtmlChapter	(	const PFullMenu &	menu,
		const PString &	indentation
	)

Convert a PFullMenu to html.

Parameters

menu	: PFullMenu to be converted
indentation	: display indentation

Returns

corresponding html

Definition at line 69 of file platexobj_menu.cpp.

                                                                                        {
        PString body(""), link(menu.getLink()), text(menu.getText());
        PString displayList("");
        if(menu.getIsSeparator()){
                body += indentation + "<li class=\"chapter-item affix \"><li class=\"part-title\">"+text+"</li>\n";
        }else{
                if(menu.getIsExpanded()){
                        displayList = "expanded";
                        if(menu.getIsFirstExpanded()){
                                displayList += " active";
                        }
                }
                body += indentation + "<li class=\"chapter-item "+displayList+"\"><a href=\""+link+"\">"+text+"</a>";
                
                const std::vector<PFullMenu> & vecSubMenu = menu.getVecSubMenu();
                if(vecSubMenu.size() != 0lu){
                        body += "<a class=\"toggle\"><div>❱</div></a></li>\n";
                        body += indentation + "<li>\n";
                        body += indentation + "\t<ol class=\"section\">\n";
                        for(std::vector<PFullMenu>::const_iterator it(vecSubMenu.begin()); it != vecSubMenu.end(); ++it){
                                body += platexobj_menuToHtmlChapter(*it, indentation + "\t\t");
                        }
                        body += indentation + "\t</ol>\n";
                        body += indentation + "</li>\n";
                }else{
                        body += "</li>\n";
                }
        }
        return body;
}

References PFullMenu::getIsExpanded(), PFullMenu::getIsFirstExpanded(), PFullMenu::getIsSeparator(), PFullMenu::getLink(), PFullMenu::getText(), and PFullMenu::getVecSubMenu().

Referenced by platexobj_menuToHtml().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_toMenu()

PFullMenu platexobj_toMenu	(	const PLatexObj &	obj,
		const PLatexObj &	mainPageLink
	)

Convert a PLatexObj into a menu.

Parameters

obj	: PLatexObj to be used
mainPageLink	: main page link if updated

Returns

PFullMenu

Definition at line 48 of file platexobj_menu.cpp.

                                                                                 {
        PFullMenu menu;
        platexobj_toMenuAll(menu, obj);
        if(mainPageLink.getType() == PLatexType::BOOKMAINPAGELINK){
                PString textMainPage(platexobj_text(mainPageLink.getVecContent()));
                if(textMainPage != ""){
                        menu.setMainPageLink(textMainPage);
                }else{
                        menu.setMainPageLink("Main Page");
                }
        }else{
                menu.setMainPageLink("Main Page");
        }
        return menu;
}

References PLatexType::BOOKMAINPAGELINK, PLatexObj::getType(), PLatexObj::getVecContent(), platexobj_text(), platexobj_toMenuAll(), and PFullMenu::setMainPageLink().

Referenced by processAllFile().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_toMenuAll()

void platexobj_toMenuAll	(	PFullMenu &	menu,
		const PLatexObj &	obj
	)

Convert a PLatexObj into a menu.

Parameters

[out]	menu	: PFullMenu
	obj	: PLatexObj

Definition at line 17 of file platexobj_menu.cpp.

                                                                 {
        PString complextTitle(platexobj_text(obj.getComplexTitle()));
        PString objTitle("<strong aria-hidden=\"true\">" + vecNumberToString(obj.getVecSecNumber()) + ".</strong> " + complextTitle);   //Content of the section title
        PLatexType::PLatexType type(obj.getType());
        menu.setLink(obj.getLink());
        if(type == PLatexType::PART){menu.setText(/*"Part " +*/ objTitle);}
        else if(type == PLatexType::CHAPTER){menu.setText(/*"Chapter " +*/ objTitle);}
        else if(type == PLatexType::SECTION){menu.setText(objTitle);}
        else if(type == PLatexType::SUBSECTION){menu.setText(objTitle);}
        else if(type == PLatexType::SUBSUBSECTION){menu.setText(objTitle);}
        else if(type == PLatexType::FILE){menu.setText(obj.getName());}
        else if(type == PLatexType::BOOKPARTSEPARATOR){
                menu.setText(complextTitle);
                menu.setIsSeparator(true);
        }
        
        const std::vector<PLatexObj> & vecChildren = obj.getVecContent();
        for(std::vector<PLatexObj>::const_iterator it(vecChildren.begin()); it != vecChildren.end(); ++it){
                if(!isSectionOrSeparator(*it)){continue;}
                PFullMenu subMenu;
                platexobj_toMenuAll(subMenu, *it);
                menu.getVecSubMenu().push_back(subMenu);
        }
}

References PLatexType::BOOKPARTSEPARATOR, PLatexType::CHAPTER, PLatexType::FILE, PLatexObj::getComplexTitle(), PLatexObj::getLink(), PLatexObj::getName(), PLatexObj::getType(), PLatexObj::getVecContent(), PLatexObj::getVecSecNumber(), PFullMenu::getVecSubMenu(), isSectionOrSeparator(), PLatexType::PART, platexobj_text(), PLatexType::SECTION, PFullMenu::setIsSeparator(), PFullMenu::setLink(), PFullMenu::setText(), PLatexType::SUBSECTION, PLatexType::SUBSUBSECTION, and vecNumberToString().

Referenced by platexobj_toMenu().

Here is the call graph for this function:

Here is the caller graph for this function: