git.sesse.net Git - vlc/blob - modules/gui/skins2/parser/interpreter.hpp

   1 /*****************************************************************************
   2  * interpreter.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
   8  *          Olivier Teulière <ipkiss@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef INTERPRETER_HPP
  26 #define INTERPRETER_HPP
  27
  28 #include "../commands/cmd_generic.hpp"
  29 #include <map>
  30
  31 class Theme;
  32 class VarBool;
  33 class VarList;
  34 class VarTree;
  35 class VarPercent;
  36
  37
  38 /// Command interpreter for scripts in the XML
  39 class Interpreter: public SkinObject
  40 {
  41     public:
  42         /// Get the instance of Interpreter
  43         static Interpreter *instance( intf_thread_t *pIntf );
  44
  45         /// Delete the instance of Interpreter
  46         static void destroy( intf_thread_t *pIntf );
  47
  48         /// Parse an action tag and returns a pointer on a command
  49         /// (the intepreter takes care of deleting it, don't do it
  50         ///  yourself !)
  51         CmdGeneric *parseAction( const string &rAction, Theme *pTheme );
  52
  53         /// Returns the boolean variable corresponding to the given name
  54         VarBool *getVarBool( const string &rName, Theme *pTheme );
  55
  56
  57         /// Returns the percent variable corresponding to the given name
  58         VarPercent *getVarPercent( const string &rName, Theme *pTheme );
  59
  60         /// Returns the list variable corresponding to the given name
  61         VarList *getVarList( const string &rName, Theme *pTheme );
  62
  63         /// Returns the tree variable corresponding to the given name
  64         VarTree *getVarTree( const string &rName, Theme *pTheme );
  65
  66     private:
  67         /// Map of global commands
  68         map<string, CmdGenericPtr> m_commandMap;
  69
  70         // Private because it is a singleton
  71         Interpreter( intf_thread_t *pIntf );
  72         virtual ~Interpreter() {}
  73 };
  74
  75 #endif