Référence de la classe Castor::FileParser

Classe de base pour les analyseurs de fichier à accolades. Plus de détails...

Graphe de collaboration de Castor::FileParser:

Liste de tous les membres

Fonctions membres publiques
	FileParser (int p_iRootSectionNumber, int p_iSectionCount)
	Constructeur.
virtual	~FileParser ()
	Destructeur.
bool	ParseFile (String const &p_strFileName)
	Fonction de traitement.
bool	ParseFile (File &p_file)
	Fonction de traitement.
bool	IsIgnored () const
	Dit si les lignes suivantes doivent être ignorées.
void	Ignore ()
	Incrémente le niveau d'ignorés.
Fonctions membres publiques statiques
static void	ParseError (String const &p_strError, FileParserContextPtr p_pContext)
	Log une erreur dans le fichier de log.
static void	ParseWarning (String const &p_strWarning, FileParserContextPtr p_pContext)
	Log un avertissement dans le fichier de log.
template<typename T , std::size_t Count>
static bool	ParseVector (String &p_strParams, Point< T, Count > &p_vResult, FileParserContextPtr p_pContext)
	Extrait un vecteur à partir d'une ligne.
template<typename T , std::size_t Count>
static bool	ParsePoint (String &p_strParams, Point< T, Count > &p_ptResult)
	Extrait un point à partir d'une ligne.
Fonctions membres protégées
virtual void	DoInitialiseParser (Castor::File &p_file)=0
	Initialisation spécifique.
virtual void	DoCleanupParser ()=0
	Nettoyage spécifique.
virtual bool	DoDelegateParser (String const &p_strLine)=0
	Fonction appelée lorsque m_iSection est hors limites.
virtual void	DoDiscardParser (String const &p_strLine)=0
	Fonction appelée si aucun analyseur n'est trouvé pour traiter la ligne.
virtual void	DoValidate ()=0
	Fonction appelée si l'analyse est complétée sans erreurs.
Attributs protégés
std::map< int, AttributeParserMap >	m_mapParsers
	La map de parseurs, triés par section.
FileParserContextPtr	m_pParsingContext
	Le contexte du parseur.
bool	m_bIgnored
	Dit que les ligne slues sont ignorées.

---

Description détaillée

Classe de base pour les analyseurs de fichier à accolades.

Auteur:

Sylvain DOREMUS

Version:

0.6.1.0

Date:

19/10/2011

---

Documentation des constructeurs et destructeur

Castor::FileParser::FileParser	(	int	p_iRootSectionNumber,
		int	p_iSectionCount
	)

Constructeur.

Paramètres:

[in]	p_iRootSectionNumber	L'id de la section de root
[in]	p_iSectionCount	Le nombre de sections

virtual Castor::FileParser::~FileParser

(

)

[virtual]

Destructeur.

---

Documentation des fonctions membres

virtual void Castor::FileParser::DoCleanupParser

(

)

[protected, pure virtual]

Nettoyage spécifique.

virtual bool Castor::FileParser::DoDelegateParser

(

String const &

p_strLine

)

[protected, pure virtual]

Fonction appelée lorsque m_iSection est hors limites.

Paramètres:

[in]

p_strLine

La ligne en cours d'analyse

Renvoie:

true si une accolade doit être ouverte à la ligne suivant, false sinon

virtual void Castor::FileParser::DoDiscardParser

(

String const &

p_strLine

)

[protected, pure virtual]

Fonction appelée si aucun analyseur n'est trouvé pour traiter la ligne.

Paramètres:

[in]

p_strLine

La ligne en cours d'analyse

virtual void Castor::FileParser::DoInitialiseParser

(

Castor::File &

p_file

)

[protected, pure virtual]

Initialisation spécifique.

virtual void Castor::FileParser::DoValidate

(

)

[protected, pure virtual]

Fonction appelée si l'analyse est complétée sans erreurs.

void Castor::FileParser::Ignore

(

)

[inline]

Incrémente le niveau d'ignorés.

bool Castor::FileParser::IsIgnored

(

)

const [inline]

Dit si les lignes suivantes doivent être ignorées.

static void Castor::FileParser::ParseError	(	String const &	p_strError,
		FileParserContextPtr	p_pContext
	)			[static]

Log une erreur dans le fichier de log.

Paramètres:

[in]	p_strError	Le texte de l'erreur
[in]	p_pContext	Le context d'analyse

bool Castor::FileParser::ParseFile

(

File &

p_file

)

Fonction de traitement.

Paramètres:

[in]

p_file

Le fichier

Renvoie:

true si tout s'est bien passé

bool Castor::FileParser::ParseFile

(

String const &

p_strFileName

)

Fonction de traitement.

Paramètres:

[in]

p_strFileName

Le nom du fichier

Renvoie:

true si tout s'est bien passé

template<typename T , std::size_t Count>

static bool Castor::FileParser::ParsePoint	(	String &	p_strParams,
		Point< T, Count > &	p_ptResult
	)			[inline, static]

Extrait un point à partir d'une ligne.

Paramètres:

[in]	p_strParams	La ligne contenant le point
[out]	p_ptResult	Reçoit le résultat

template<typename T , std::size_t Count>

static bool Castor::FileParser::ParseVector	(	String &	p_strParams,
		Point< T, Count > &	p_vResult,
		FileParserContextPtr	p_pContext
	)			[inline, static]

Extrait un vecteur à partir d'une ligne.

Paramètres:

[in]	p_strParams	La ligne contenant le vecteur
[out]	p_vResult	Reçoit le résultat
[in]	p_pContext	Le context d'analyse

Renvoie:

true si tout s'est bien passé

static void Castor::FileParser::ParseWarning	(	String const &	p_strWarning,
		FileParserContextPtr	p_pContext
	)			[static]

Log un avertissement dans le fichier de log.

Paramètres:

[in]	p_strWarning	Le texte de l'avertissement
[in]	p_pContext	Le context d'analyse

---

Documentation des données membres

bool Castor::FileParser::m_bIgnored [protected]

Dit que les ligne slues sont ignorées.

std::map< int, AttributeParserMap > Castor::FileParser::m_mapParsers [protected]

La map de parseurs, triés par section.

FileParserContextPtr Castor::FileParser::m_pParsingContext [protected]

Le contexte du parseur.

---

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

• include/CastorUtils/FileParser.hpp