pinkscape_slide.h File Reference

#include <map>
#include "PPath.h"

Include dependency graph for pinkscape_slide.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	SLIDE_RECOVER_FILE   "_slide_recover.slide"
	Define the name of the file which contains the formulae and the path to the created file.

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

Functions
bool	pinkscape_isSlideKnown (POutoutMode &outputMode, const PPath &outputSlide, const PString &slideContent)
	Check if the slide we are going to save was already saved (with the same content) or not.
void	pinkscape_loadSlideMap (PMapSlide &mapFormula, const PPath &baseOutputName)
	Load the map file of all the formulae if it exists.
void	pinkscape_saveSlideMap (const PMapSlide &mapFormula, const PPath &baseOutputName)
	Save the map file of the formulae to avoid extra latex call.

Macro Definition Documentation

SLIDE_RECOVER_FILE

#define SLIDE_RECOVER_FILE   "_slide_recover.slide"

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

Definition at line 14 of file pinkscape_slide.h.

Referenced by pinkscape_loadSlideMap(), and pinkscape_saveSlideMap().

Typedef Documentation

PMapSlide

typedef std::map<PPath,PPath> PMapSlide

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

Definition at line 17 of file pinkscape_slide.h.

Function Documentation

pinkscape_isSlideKnown()

bool pinkscape_isSlideKnown	(	POutoutMode &	outputMode,
		const PPath &	outputSlide,
		const PString &	slideContent )

Check if the slide we are going to save was already saved (with the same content) or not.

Parameters

[out]	outputMode	: output mode to be checked and/or updated
	outputSlide	: output file name of the current slide
	slideContent	: content of the slide in svg

Definition at line 37 of file pinkscape_slide.cpp.

                                                                                                              {
        PMapSlide & mapSlide = outputMode.mapSlide;
        PMapSlide::iterator it(mapSlide.find(outputSlide));
        if(it != mapSlide.end()){       //The slide is already known
                if(it->second == slideContent){ //If the slide content is the same
                        if(outputSlide.isFileExist()){  //We do not need to save it because it already exist
                                return true;
                        }else{
                                std::cout << "pinkscape_isSlideKnown : file '"<<outputSlide<<"' does not exist" << std::endl;
                        }
                }else{
                        std::cout << "pinkscape_isSlideKnown : '"<<outputSlide<<" 'slide content changed" << std::endl;
                }
        }
        //The slide is not known
        
        //Let's update the slide content (or create it)
        mapSlide[outputSlide] = slideContent;
        return false;
}

References POutoutMode::mapSlide.

Referenced by saveSlides().

Here is the caller graph for this function:

pinkscape_loadSlideMap()

void pinkscape_loadSlideMap	(	PMapSlide &	mapFormula,
		const PPath &	baseOutputName )

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 19 of file pinkscape_slide.cpp.

                                                                                 {
        PPath fileName(baseOutputName + PPath(SLIDE_RECOVER_FILE));
        if(!data_load(fileName, mapFormula)){return;}
}

References SLIDE_RECOVER_FILE.

Referenced by processFileSvg().

Here is the caller graph for this function:

pinkscape_saveSlideMap()

void pinkscape_saveSlideMap	(	const PMapSlide &	mapFormula,
		const PPath &	baseOutputName )

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

Parameters

[out]

mapFormula

: map of formulae to be saved

Definition at line 27 of file pinkscape_slide.cpp.

                                                                                       {
        PPath fileName(baseOutputName + PPath(SLIDE_RECOVER_FILE));
        if(!data_save(fileName, mapFormula)){return;}
}

References SLIDE_RECOVER_FILE.

Referenced by processFileSvg().

Here is the caller graph for this function: