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