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
  80 /// Wrapper around ToLocale, to avoid the need to call LocaleFree()
  81 static inline string sToLocale( const string &rUTF8 )
  82 {
  83     char *s = ToLocale( rUTF8.c_str() );
  84     string res = s;
  85     LocaleFree( s );
  86     return res;
  87 }
  88
  89
  90 //---------------------------------------------------------------------------
  91 // intf_sys_t: description and status of skin interface
  92 //---------------------------------------------------------------------------
  93 struct intf_sys_t
  94 {
  95     /// The input thread
  96     input_thread_t *p_input;
  97
  98     /// The playlist thread
  99     playlist_t *p_playlist;
 100
 101     /// Message bank subscription
 102     msg_subscription_t *p_sub;
 103
 104     // "Singleton" objects: MUST be initialized to NULL !
 105     /// Logger
 106     Logger *p_logger;
 107     /// Asynchronous command queue
 108     AsyncQueue *p_queue;
 109     /// Dialog provider
 110     Dialogs *p_dialogs;
 111     /// Script interpreter
 112     Interpreter *p_interpreter;
 113     /// Factory for OS specific classes
 114     OSFactory *p_osFactory;
 115     /// Main OS specific message loop
 116     OSLoop *p_osLoop;
 117     /// Variable manager
 118     VarManager *p_varManager;
 119     /// VLC state handler
 120     VlcProc *p_vlcProc;
 121     /// Theme repository
 122     ThemeRepository *p_repository;
 123
 124     /// Current theme
 125     Theme *p_theme;
 126 };
 127
 128
 129 /// Base class for all skin classes
 130 class SkinObject
 131 {
 132     public:
 133         SkinObject( intf_thread_t *pIntf ): m_pIntf( pIntf ) {}
 134         virtual ~SkinObject() {}
 135
 136         /// Getter (public because it is used in C callbacks in the win32
 137         /// interface)
 138         intf_thread_t *getIntf() const { return m_pIntf; }
 139
 140     private:
 141         intf_thread_t *m_pIntf;
 142 };
 143
 144
 145 #endif