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