Référence de la classe castor::FileParserContext

#include <FileParserContext.hpp>

Graphe d'héritage de castor::FileParserContext:

Graphe de collaboration de castor::FileParserContext:

Fonctions membres publiques
CU_API	FileParserContext (FileParser &parser, Path const &path)
	Constructeur.
virtual CU_API	~FileParserContext () noexcept=default
	Destructeur.
CU_API void	registerUserContext (String const &name, void *data)
	Enregistre un contexte utilisateur.
CU_API void *	unregisterUserContext (String const &name)
	Désenregistre un contexte utilisateur.
CU_API bool	hasUserContext (String const &name)
	Récupère un contexte utilisateur.
CU_API void *	getUserContext (String const &name)
	Récupère un contexte utilisateur.

Attributs publics
Path	file {}
unsigned long long	line {}
Deque< SectionId >	sections {}
Deque< void * >	blocks {}
SectionId	pendingSection {}
void *	pendingBlock {}
String	functionName {}
StringMap< void * >	userContexts {}
FileParser *	parser {}
LoggerInstance *	logger {}
PreprocessedFile *	preprocessed {}
Vector< BlockContext >	allocatedBlocks

Membres hérités additionnels
Fonctions membres protégées hérités de castor::NonMovable
	NonMovable ()=default
	Constructeur.
	~NonMovable () noexcept=default
	Destructeur.

Documentation des constructeurs et destructeur

FileParserContext()

CU_API castor::FileParserContext::FileParserContext ( FileParser & parser, Path const & path )

explicit

Constructeur.

Paramètres

[in]	parser	L'analyseur.
[in]	path	Le chemin d'accès au fichier.

~FileParserContext()

virtual CU_API castor::FileParserContext::~FileParserContext ( )

virtualdefaultnoexcept

Destructeur.

Documentation des fonctions membres

getUserContext()

CU_API void * castor::FileParserContext::getUserContext

(

String const &

name

)

Récupère un contexte utilisateur.

Paramètres

[in]

name

Le nom du contexte.

Renvoie

Les données du contexte utilisateur.

hasUserContext()

CU_API bool castor::FileParserContext::hasUserContext

(

String const &

name

)

Récupère un contexte utilisateur.

Paramètres

[in]

name

Le nom du contexte.

Renvoie

Les données du contexte utilisateur.

registerUserContext()

CU_API void castor::FileParserContext::registerUserContext	(	String const &	name,
		void *	data )

Enregistre un contexte utilisateur.

Paramètres

[in]	name	Le nom du contexte, doit être unique.
[in]	data	Les données du contexte utilisateur.

unregisterUserContext()

CU_API void * castor::FileParserContext::unregisterUserContext

(

String const &

name

)

Désenregistre un contexte utilisateur.

Paramètres

[in]

name

Le nom du contexte.

Renvoie

Les données du contexte utilisateur.

Documentation des données membres

allocatedBlocks

Vector< BlockContext > castor::FileParserContext::allocatedBlocks

Les contextes de bloc alloués.

blocks

Deque< void * > castor::FileParserContext::blocks {}

La pile de contextes de blocs.

file

Path castor::FileParserContext::file {}

Le fichier en cours d'analyse.

functionName

String castor::FileParserContext::functionName {}

Le nom de la fonction actuelle.

line

unsigned long long castor::FileParserContext::line {}

La ligne en cours d'analyse.

logger

LoggerInstance* castor::FileParserContext::logger {}

L'instance de logger.

parser

FileParser* castor::FileParserContext::parser {}

Le parseur.

pendingBlock

void* castor::FileParserContext::pendingBlock {}

Le contexte de bloc à mettre sur la pile.

pendingSection

SectionId castor::FileParserContext::pendingSection {}

La section à mettre sur la pile.

preprocessed

PreprocessedFile* castor::FileParserContext::preprocessed {}

Le fichier prétraité.

sections

Deque< SectionId > castor::FileParserContext::sections {}

La pile de sections.

userContexts

StringMap< void * > castor::FileParserContext::userContexts {}

Les données de contexte utilisateur, utile dans les plug-ins.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• CastorUtils/FileParser/FileParserContext.hpp