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