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