git.sesse.net Git - vlc/blob - modules/gui/skins2/commands/cmd_generic.hpp

   1 /*****************************************************************************
   2  * cmd_generic.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 CMD_GENERIC_HPP
  26 #define CMD_GENERIC_HPP
  27
  28 #include "../src/skin_common.hpp"
  29 #include "../utils/pointer.hpp"
  30
  31 #include <string>
  32
  33
  34 /// Macro to define the prototype of simple commands
  35 #define DEFINE_COMMAND( name, type ) \
  36 class Cmd##name: public CmdGeneric \
  37 { \
  38     public: \
  39         Cmd##name( intf_thread_t *pIntf ): CmdGeneric( pIntf ) {} \
  40         virtual ~Cmd##name() {} \
  41         virtual void execute(); \
  42         virtual string getType() const { return type; } \
  43 \
  44 };
  45
  46
  47 /// Macro to define a "callback" command inside a class
  48 #define DEFINE_CALLBACK( parent, action ) \
  49 class Cmd##action: public CmdGeneric \
  50 { \
  51     public: \
  52         Cmd##action( parent *pParent ): \
  53             CmdGeneric( pParent->getIntf() ), m_pParent( pParent ) {} \
  54         virtual ~Cmd##action() {} \
  55         virtual void execute(); \
  56         virtual string getType() const { return "Cmd" #parent #action; } \
  57     private: \
  58         parent *m_pParent; \
  59 \
  60 } m_cmd##action; \
  61 friend class Cmd##action;
  62
  63
  64 /// Base class for skins commands
  65 class CmdGeneric: public SkinObject
  66 {
  67     public:
  68         virtual ~CmdGeneric() {}
  69
  70         /// This method does the real job of the command
  71         virtual void execute() = 0;
  72
  73         /// Return the type of the command
  74         virtual string getType() const { return ""; }
  75
  76         /// During queue reductions, check if we really want to remove
  77         /// this command.
  78         virtual bool checkRemove( CmdGeneric * ) const { return true; }
  79
  80     protected:
  81         CmdGeneric( intf_thread_t *pIntf ): SkinObject( pIntf ) {}
  82 };
  83
  84
  85 typedef CountedPtr<CmdGeneric> CmdGenericPtr;
  86
  87
  88 #endif