Script.h

Aller à la documentation de ce fichier.

/*! \file Script.h
    \brief Interpréteur de script.

    Interprete des scripts structurés en fonctions.

    \author     aerith (www.aerith.fr)
    \version    1.0
    \date       20/11/2007
*/

#ifndef INCLUDE_RSRC_SCRIPT
#define INCLUDE_RSRC_SCRIPT

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

#define     SCRIPT_BUFFER           10240

#define     SCRIPT_TYPE_STRING      1
#define     SCRIPT_TYPE_INT         2
#define     SCRIPT_TYPE_FLOAT       3

//! Information sur une variable.
/*! Information sur une variable de l'interpréteur.
*/
typedef struct _ScriptVar
{
    char            *Name;                  /*!< Nom de la variable.                    */
    String          Value;                  /*!< Valeur de la variable.                 */
    unsigned int    Type;                   /*!< Type de la variable.                   */
} ScriptVar;

//! Parametres pour une fonction.
/*! Parametres pour une fonction.
*/
typedef struct _ScriptParam
{
    std::vector<String>         Params;         /*!< Chaque ligne est un parametre.         */
    std::vector<ScriptVar *>    *Vars;          /*!< Liste des variables.                   */
} ScriptParam;

typedef String  (*SCRIPT_ROUTINE)(ScriptParam); /*!< Pointeur sur une fonction.                 */

//! Information sur une fonction.
/*! Information sur une fonction de l'interpréteur.
*/
typedef struct _ScriptFunc
{
    char            *Name;                      /*!< Nom de la fonction.                    */
    unsigned int    NbParam;                    /*!< Nombre de paramètre de la fonction.    */
    SCRIPT_ROUTINE  Function;                   /*!< Fonction à éxécuté.                    */
} ScriptFunc;

//! Interpréteur de script.
/*! Interprete des scripts structurés en fonctions.
*/
class Script
{
private :
    std::vector<ScriptFunc *>   Functions;      /*!< Chaque lignes est une fonction.            */
    std::vector<ScriptVar *>    Vars;           /*!< Chaque lignes est une variable.            */
    static unsigned int         ScriptInstance; /*!< Compte les instance de la class.           */
    static MUTEX                ScriptMutex;    /*!< Utiliser des que l'on accede à un fichier. */
    unsigned int                NoLine;         /*!< Numéro de la ligne en cour de traitement.  */
    unsigned int                NoCar;          /*!< Numéro du carractère en cour d'analise.    */

    //! Afiche une erreur de parsage.
    /*! Affiche des informations sur une erreur lors du parsage d'un fichier.
        \param pDesc déscription de l'erreur.
    */
    void    LogError(char *pDesc);


public  :
    /*! Initialise avec des paramétres par defaut.
    */
    Script();

    /*! Libère la mémoire proprement
    */
    ~Script();

    //! Ajoute une fonction.
    /*! Ajoute une tonction.
        \param pName nom de la fonction.
        \param iNb nombre de paramètre de la fonction.
        \param pFunction fonction a lier.
        \return code d'erreur
        \sa DelFunction() et GetNbFunction().
    */
    int     AddFunction(char *pName, unsigned int iNb, SCRIPT_ROUTINE pFunction);

    //! Supprime une fonction.
    /*! Supprime la fonction à la position \a iPos.
        \param iPos position de la fonction.
        \return code d'erreur
        \sa AddFunction() et GetNbFunction().
    */
    int     DelFunction(unsigned int iPos);

    //! Supprime une fonction.
    /*! Supprime la fonction ayant le nom \a pName.
        \param pName nom de la fonction.
        \return code d'erreur
        \sa AddFunction() et GetNbFunction().
    */
    int     DelFunction(char *pName);

    //! Retourne le nom de la fonction.
    /*! Retourne le nom de la fonction numéro \a iPos.
        \param iPos position de la fonction.
        \return pointeur sur le nom de la fonction \a Name.
    */
    char    *GetName(unsigned int iPos);

    //! Retourne le nombre de parametre d'une fonction.
    /*! Retourne le nombre de parametre de la fonction numéro \a iPos.
        \param pName nom de la fonction.
        \return nombre de paramètre de la fonction \a NbParam.
    */
    int     GetNbParam(unsigned int iPos);

    //! Retourne le nombre de parametre d'une fonction.
    /*! Retourne le nombre de parametre de la fonction \a pName.
        \param pName nom de la fonction.
        \return nombre de paramètre de la fonction \a NbParam.
    */
    int     GetNbParam(char *pName);

    //! Retourne le nombre de fonction.
    /*! Retourne le nombre de fonction de l'interpreteur.
        \return nombre de fonction de l'interpréteur.
    */
    int     GetNbFunction();

    //! Parse un fichier.
    /*! Parse un fichier, recherche et éxécute des fonctions.
        \param pName nom du fichier à parser.
        \return chaine de carractère résultat.
    */
    String  ParseFile(char *pName);

    //! Parse un buffer.
    /*! Parse un buffer, recherche et éxécute des fonctions.
        \param pBuffer buffer à parser.
        \return chaine de carractère résultat.
    */
    String  Parse(String pBuffer);
};


#endif

---