XMLObjet.h

/*! \file XML.h
    \brief Gestion de fichiers XML.

    Gestion dde fichiers XML. \n
    Si \a Type == \a XML_OBJET alors la class est un objet contenant des sous-objets (balise) : \n
        \a Size indique le nombre de sous-objets. \n
        \a Name , \a NbParam , \a Params , \a Size et \a Objets sont remplit si il le faut. \n
    Si \a Type == \a XML_DATA alors la class est une data simple (text simple entre balise) :\n
        \a Size indique la longeur de la data.\n
        \a Data est remplit avec le text brute et a une longeur de \a Size. \n
    Si \a Type == \a XML_SPECIAL alors la class est un objet spécial (ex : balise de commentaire) : \a
        \a Size indique la longeur de la data brute.\n
        \a Data est remplit avec tout le contenu de la balise et a une longeur de \a Size. \n

    \author     aerith (www.aerith.fr)
    \version    1.0
    \date       09/12/2007
*/

#ifndef INCLUDE_RSRC_XMLObjet
#define INCLUDE_RSRC_XMLObjet

#include    "../Surcouche/SurcoucheMultitache.h"
#include    "../Tools/Tools.h"
#include    "../Error/Error.h"
#include    <stdio.h>
#include    <string.h>
#include    <vector>

#define     XML_VIERGE          0       /*!< Vierge.                    */
#define     XML_OPEN_OPEN       1       /*!< '<' Ouverture.             */
#define     XML_OBJET_NAME      2       /*!< Copie nom objet.           */
#define     XML_PARAM_NAME      3       /*!< Copie nom paramètre.       */
#define     XML_PARAM_FOUND     4       /*!< '=' Paramètre trouvé.      */
#define     XML_PARAM_DATA      5       /*!< Copie data paramètre.      */
#define     XML_OPEN_CLOSE      6       /*!< '>' Fermeture.             */
#define     XML_DATA            7       /*!< Data.                      */
#define     XML_CLOSE_OPEN      8       /*!< '<' Ouverture.             */
#define     XML_CLOSE_FOUND     9       /*!< '/' Trouvé.                */
#define     XML_CLOSE_CLOSE     10      /*!< '>' Fermeture.             */
#define     XML_SPECIAL         11      /*!< Objet spécial.             */

#define     XML_TYPE_OBJET      1
#define     XML_TYPE_DATA       2
#define     XML_TYPE_SPECIAL    3

#define     XML_FILENAME        512
#define     XML_BUFFER          1024
#define     XML_NAME            256
#define     XML_TEMP            1024

typedef struct _XMLParam
{
    char    Name[XML_NAME];
    int     Size;
    char    *Data;
} XMLParam;


//! Gestion de fichiers XML.
/*! Gestion de fichiers XML.
*/
class XMLObjet
{
private :
    static int              Cur;            /*!< Position dans le fichier.                              */
    static int              NoLine;         /*!< Numéro de la ligne en traitement du fichier.           */
    static int              NoCar;          /*!< Numéro du carractère en traitement de la ligne.        */
    int                     Type;           /*!< Indique ce que stock la class.                         */
    char                    Name[XML_NAME]; /*!< Nom de l'objet.                                        */
    int                     NbParam;        /*!< Nombre de paramètre de l'objet.                        */
    std::vector<XMLParam *> Params;         /*!< Chaque ligne est un paramétre.                         */
    int                     NbObjet;        /*!< Nombre de sous-objet dans l'objet.                     */
    std::vector<XMLObjet *> Objets;         /*!< Chaque ligne est un sous-objet.                        */
    int                     Size;           /*!< Taille de \a Data.                                     */
    char                    *Data;          /*!< Data brute, si le type l'utilise.                      */

    //! Afiche une erreur de parsage.
    /*! Affiche des informations sur une erreur lors du parsage d'un fichier.
        \param iLine numéro de la ligne dans le fichier.
        \param iCar numéro du carractère dans la ligne.
        \param pDesc déscription de l'erreur.
    */
    void    LogError(int iNoLine, int iNoCar, char *pDesc);

protected :
    char            FileName[XML_FILENAME]; /*!< Nom du fichier.                                */
    static FILE     *File;          /*!< Descripteur du fichier destination.                    */
    static int      XMLInstance;    /*!< Compte les instance de la class.                       */
    static MUTEX    XMLMutex;       /*!< Utiliser des que l'on accede à un fichier.             */

public :
    /*! Initialise avec des parametres par defaut.
    */
    XMLObjet();

    /*! Libere proprement la mémoire.
    */
    ~XMLObjet();

    //! Log une erreur.
    /*! Log une erreur de parsage dans le fichier XMLError.log.
        \param pDesc descryption de l'erreur
    */
    void    LogError(char *pDesc);

    //! Charge un fichier.
    /*! Charge un fichier XML en mémoire.
        \return code d'erreur.
        \sa Save().
    */
    int     Load(int iNoLine = 1, int iNoCar = 0);

    //! Sauve dans un fichier.
    /*! Poursuit la sauvegarde vers le fichier.
        \param iDec nombre de tabulation pour l'indentation.
        \return code d'erreur.
        \sa Load().
    */
    int     Save(int iDec = 0);


    //! Retourne le nombre d'instance.
    /*! Retourne le nombre d'instance de la class (pour multitache).
        \return nombre d'instance de la class.
    */
    inline int      GetNbInstance()
    {
        return XMLInstance;
    };

    //! Retourne le nom du fichier.
    /*! Retourne le nom du fichier XML \a FileName.
        \return un pointeur sur le nom du fichier XML \a FileName.
    */
    inline char     *GetFileName()
    {
        return FileName;
    };

    //! Affiche la structure.
    /*! Enregistre la structure des objets dans le fichier \a pFileName.
        \param pFileName fichier destination.
        \return code d'erreur.
        \sa Load().
    */
    int     Print(FILE *pFile);

    //! Retourne le type de l'objet.
    /*! Retourne le type de l'objet \a Type.
        \return le type de l'objet \a Type.
    */
    inline int      GetType()
    {
        return Type;
    };

    //! Retourne le nom de l'objet.
    /*! Retourne le nom de l'objet \a Name.
        \return un pointeur sur le nom de l'objet \a Name.
        \sa SetName().
    */
    inline char     *GetName()
    {
        return Name;
    };

    //! Définie le nom de l'objet.
    /*! Définie le nom de l'objet \a Name.
        \param pName nom de l'objet.
        \return un pointeur sur le nom de l'objet \a Name.
        \sa GetName().
    */
    inline char     *SetName(char *pName)
    {
        for(int i = 0; (i < (XML_NAME - 1)) && pName[i]; i++)
            Name[i] = pName[i];

        return Name;
    };

    //! Retourne \a Size.
    /*! Retourne le nombre, \a Size , d'objet ou la taille de data.
        \return le nombre, \a Size , d'objet ou la taille de data.
    */
    inline int      GetSize()
    {
        return Size;
    };

    //! Affiche la structure.
    /*! Affiche la structure des objets vers le fichier \a File.
        \param iDec nombre de tabulation pour l'indentation.
        \return code d'erreur.
        \sa Load().
    */
    int     Print(int iDec = 0);

//********************************** Paramétre *********************************
    //! Ajoute un paramétre.
    /*! Ajoute un paramétre avec comme nom \a pName.
        \param pName nom du paramétre
        \param pData données du paramétre
        \return code d'erreur.
        \sa DelParam(), GetParam() et GetNbParam().
    */
    int     AddParam(char *pName, char *pData);

    //! Supprime un paramétre.
    /*! Supprime le paramétre étant à la position \a iPos.
        \param iPos position du paramétre.
        \return code d'erreur.
        \sa AddParam(), GetParam() et GetNbParam().
    */
    int     DelParam(int iPos);

    //! Supprime un paramétre.
    /*! Supprime le paramétre ayant le nom \a pName.
        \param pName nom du paramétre.
        \return code d'erreur.
        \sa AddParam(), GetParam() et GetNbParam().
    */
    inline int      DelParam(char *pName)
    {
        for(int i = 0; i < NbParam; i++)
        {
            if(!strcmp(Params[i]->Name, pName))
                return DelParam(i);
        }

        return ERROR_C_NOERROR;
    };

    //! Retourne un paramétre.
    /*! Retourne le paramétre étant à la position \a iPos.
        \param iPos position du paramétre.
        \return pointeur sur la structure du paramétre.
        \sa AddParam(), DelParam() et GetNbParam().
    */
    inline XMLParam     *GetParam(int iPos)
    {
        if(iPos < NbParam)
            return Params[iPos];

        return NULL;
    };

    //! Retourne un paramétre.
    /*! Retourne le paramétre ayant le nom \a pName.
        \param pName nom du paramétre.
        \return pointeur sur la structure du paramétre.
        \sa AddParam(), DelParam() et GetNbParam().
    */
    inline XMLParam     *GetParam(char *pName)
    {
        for(int i = 0; i < NbParam; i++)
        {
            if(!strcmp(Params[i]->Name, pName))
                return Params[i];
        }

        return NULL;
    };

    //! Retourne le nombre de paramétre.
    /*! Retourne le nombre de paramétre de l'objet.
        \return nombre de paramétre de l'objet.
        \sa AddParam(), DelParam() et GetParam().
    */
    inline int      GetNbParam()
    {
        return NbParam;
    };

//********************************** Objets *********************************
    //! Ajoute un objet.
    /*! Ajoute un objet de type \a XML_OBJET.
        \return code d'erreur.
        \sa Del(), GetSousObjet(), GetSPecial() et GetData().
    */
    int     Add();

    //! Supprime un objet.
    /*! Supprime l'objet étant à la position \a iPos.
        \param iPos position de l'objet.
        \return code d'erreur.
        \sa Add(), GetSousObjet(), GetSPecial() et GetData().
    */
    int     Del(int iPos);

    //! Supprime un objet.
    /*! Supprime l'objet étant à la position \a iPos.
        \param pName nom de l'objet.
        \return code d'erreur.
        \sa Add(), GetSousObjet(), GetSPecial() et GetData().
    */
    inline int      Del(char *pName)
    {
        for(int i = 0; i < NbObjet; i++)
        {
            if(Objets[i]->Type == XML_TYPE_OBJET)
                if(!strcmp(Objets[i]->Name, pName))
                    return Del(i);
        }

        return ERROR_C_NOERROR;
    };

    //! Retourne un sous-objet.
    /*! Retourne le sous-objet étant à la position \a iPos.
        \param iPos position du sous-objet.
        \return pointeur sur la structure du sous-objet.
        \sa Add() et Del().
    */
    inline XMLObjet     *GetSousObjet(int iPos)
    {
        if(iPos < NbObjet)
            if(Objets[iPos]->Type == XML_TYPE_OBJET)
                return Objets[iPos];

        return NULL;
    };

    //! Retourne un sous-objet.
    /*! Retourne le sous-objet ayant le nom \a pName.
        \param pName nom du sous-objet.
        \return pointeur sur la structure du sous-objet.
        \sa Add() et Del().
    */
    inline XMLObjet     *GetSousObjet(char *pName)
    {
        for(int i = 0; i < NbObjet; i++)
        {
            if(Objets[i]->Type == XML_TYPE_OBJET)
                if(!strcmp(Objets[i]->Name, pName))
                    return Objets[i];
        }

        return NULL;
    };

    //! Retourne un objet spécial.
    /*! Retourne l'objet spécial étant à la position \a iPos.
        \param iPos position de l'objet spécial.
        \return pointeur sur la data de l'objet spécial \a Data.
        \sa Add() et Del().
    */
    inline char     *GetSpecial(int iPos)
    {
        if(iPos < NbObjet)
            if(Objets[iPos]->Type == XML_TYPE_SPECIAL)
                return Data;

        return NULL;
    };

    //! Retourne un objet data.
    /*! Retourne l'objet data étant à la position \a iPos.
        \param iPos position de l'objet data.
        \return pointeur sur la data de l'objet data \a Data.
        \sa Add() et Del().
    */
    inline char     *GetData(int iPos)
    {
        if(iPos < NbObjet)
            if(Objets[iPos]->Type == XML_TYPE_DATA)
                return Data;

        return NULL;
    };
    
    //! Retourne le nombre de sous objet.
    /*! Retourne le nombre de sous objet de l'objet.
        \return nombre de sous objet de l'objet.
        \sa Add(), Del() et GetSousObjet().
    */
    inline int      GetNbObjet()
    {
        return NbObjet;
    };
};


#endif

---