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

   1 /*****************************************************************************
   2  * skin_common.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 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #ifndef SKIN_COMMON_HPP
  30 #define SKIN_COMMON_HPP
  31
  32 #include <vlc_common.h>
  33 #include <vlc_interface.h>
  34 #include <vlc_charset.h>
  35
  36 #include <string>
  37 using namespace std;
  38
  39 class AsyncQueue;
  40 class Logger;
  41 class Dialogs;
  42 class Interpreter;
  43 class OSFactory;
  44 class OSLoop;
  45 class VarManager;
  46 class VlcProc;
  47 class VoutManager;
  48 class Theme;
  49 class ThemeRepository;
  50
  51 #ifndef M_PI
  52 #   define M_PI 3.14159265358979323846
  53 #endif
  54
  55 #ifdef _MSC_VER
  56 // turn off 'warning C4355: 'this' : used in base member initializer list'
  57 #pragma warning ( disable:4355 )
  58 // turn off 'identifier was truncated to '255' characters in the debug info'
  59 #pragma warning ( disable:4786 )
  60 #endif
  61
  62 // Useful macros
  63 #define SKINS_DELETE( p ) \
  64    if( p ) \
  65    { \
  66        delete p; \
  67    } \
  68    else \
  69    { \
  70        msg_Err( getIntf(), "delete NULL pointer in %s at line %d", \
  71                 __FILE__, __LINE__ ); \
  72    }
  73
  74
  75 /// Wrapper around FromLocale, to avoid the need to call LocaleFree()
  76 static inline string sFromLocale( const string &rLocale )
  77 {
  78     char *s = FromLocale( rLocale.c_str() );
  79     string res = s;
  80     LocaleFree( s );
  81     return res;
  82 }
  83
  84 #ifdef WIN32
  85 /// Wrapper around FromWide, to avoid the need to call free()
  86 static inline string sFromWide( const wstring &rWide )
  87 {
  88     char *s = FromWide( rWide.c_str() );
  89     string res = s;
  90     free( s );
  91     return res;
  92 }
  93 #endif
  94
  95 /// Wrapper around ToLocale, to avoid the need to call LocaleFree()
  96 static inline string sToLocale( const string &rUTF8 )
  97 {
  98     char *s = ToLocale( rUTF8.c_str() );
  99     string res = s;
 100     LocaleFree( s );
 101     return res;
 102 }
 103
 104
 105 //---------------------------------------------------------------------------
 106 // intf_sys_t: description and status of skin interface
 107 //---------------------------------------------------------------------------
 108 struct intf_sys_t
 109 {
 110     /// The input thread
 111     input_thread_t *p_input;
 112
 113     /// The playlist thread
 114     playlist_t *p_playlist;
 115
 116     /// Message bank subscription
 117     msg_subscription_t *p_sub;
 118
 119     // "Singleton" objects: MUST be initialized to NULL !
 120     /// Logger
 121     Logger *p_logger;
 122     /// Asynchronous command queue
 123     AsyncQueue *p_queue;
 124     /// Dialog provider
 125     Dialogs *p_dialogs;
 126     /// Script interpreter
 127     Interpreter *p_interpreter;
 128     /// Factory for OS specific classes
 129     OSFactory *p_osFactory;
 130     /// Main OS specific message loop
 131     OSLoop *p_osLoop;
 132     /// Variable manager
 133     VarManager *p_varManager;
 134     /// VLC state handler
 135     VlcProc *p_vlcProc;
 136     /// Vout manager
 137     VoutManager *p_voutManager;
 138     /// Theme repository
 139     ThemeRepository *p_repository;
 140
 141     /// Current theme
 142     Theme *p_theme;
 143
 144     /// synchronisation at start of interface
 145     vlc_thread_t thread;
 146     vlc_mutex_t  init_lock;
 147     vlc_cond_t   init_wait;
 148     bool         b_ready;
 149 };
 150
 151
 152 /// Base class for all skin classes
 153 class SkinObject
 154 {
 155     public:
 156         SkinObject( intf_thread_t *pIntf ): m_pIntf( pIntf ) {}
 157         virtual ~SkinObject() {}
 158
 159         /// Getter (public because it is used in C callbacks in the win32
 160         /// interface)
 161         intf_thread_t *getIntf() const { return m_pIntf; }
 162
 163     private:
 164         intf_thread_t *m_pIntf;
 165 };
 166
 167
 168 #endif