git.sesse.net Git - vlc/blob - modules/gui/skins2/src/skin_common.hpp

   1 /*****************************************************************************
   2  * skin_common.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 VideoLAN
   5  * $Id: skin_common.hpp,v 1.1 2004/01/03 23:31:34 asmax Exp $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 #ifndef SKIN_COMMON_HPP
  26 #define SKIN_COMMON_HPP
  27
  28 #include <vlc/vlc.h>
  29 #include <vlc/intf.h>
  30
  31 using namespace std;
  32
  33 class AsyncQueue;
  34 class Logger;
  35 class Dialogs;
  36 class OSFactory;
  37 class OSLoop;
  38 class VarManager;
  39 class VlcProc;
  40 class Theme;
  41
  42
  43 // Useful macros
  44 #define SKINS_DELETE( p ) \
  45    if( p ) \
  46    { \
  47        delete p; \
  48    } \
  49    else \
  50    { \
  51        msg_Err( getIntf(), "delete NULL pointer in %s at line %d", \
  52                 __FILE__, __LINE__ ); \
  53    }
  54
  55
  56 //---------------------------------------------------------------------------
  57 // intf_sys_t: description and status of skin interface
  58 //---------------------------------------------------------------------------
  59 struct intf_sys_t
  60 {
  61     /// The input thread
  62     input_thread_t *p_input;
  63
  64     /// The playlist thread
  65     playlist_t *p_playlist;
  66
  67     /// Message bank subscription
  68     msg_subscription_t *p_sub;
  69
  70     // "Singleton" objects: MUST be initialized to NULL !
  71     /// Logger
  72     Logger *p_logger;
  73     /// Asynchronous command queue
  74     AsyncQueue *p_queue;
  75     /// Dialog provider
  76     Dialogs *p_dialogs;
  77     /// Factory for OS specific classes
  78     OSFactory *p_osFactory;
  79     /// Main OS specific message loop
  80     OSLoop *p_osLoop;
  81     /// Variable manager
  82     VarManager *p_varManager;
  83     /// VLC state handler
  84     VlcProc *p_vlcProc;
  85
  86     /// Current theme
  87     Theme *p_theme;
  88 };
  89
  90
  91 /// Base class for all skin classes
  92 class SkinObject
  93 {
  94     public:
  95         SkinObject( intf_thread_t *pIntf ): m_pIntf( pIntf ) {}
  96         virtual ~SkinObject() {}
  97
  98         /// Getter (public because it is used in C callbacks in the win32
  99         /// interface)
 100         intf_thread_t *getIntf() const { return m_pIntf; }
 101
 102         /// Class for callbacks
 103         class Callback {
 104             public:
 105                 /// Type for callback methods
 106                 typedef void (*CallbackFunc_t)( SkinObject* );
 107
 108                 /// Create a callback with the given object and function
 109                 Callback( SkinObject *pObj, CallbackFunc_t pFunc ):
 110                     m_pObj( pObj ), m_pFunc( pFunc ) {}
 111                 ~Callback() {}
 112
 113                 /// Getters
 114                 SkinObject *getObj() const { return m_pObj; }
 115                 CallbackFunc_t getFunc() const { return m_pFunc; }
 116
 117             private:
 118                 /// Pointer on the callback object
 119                 SkinObject *const m_pObj;
 120                 /// Pointer on the callback method
 121                 CallbackFunc_t m_pFunc;
 122         };
 123
 124     private:
 125         intf_thread_t *m_pIntf;
 126 };
 127
 128
 129 #endif