]> git.sesse.net Git - vlc/blob - modules/gui/skins2/src/skin_common.hpp
Skins2: Cosmetic.
[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 along
21  * with this program; if not, write to the Free Software Foundation, Inc.,
22  * 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
63 /// Wrapper around FromLocale, to avoid the need to call LocaleFree()
64 static inline string sFromLocale( const string &rLocale )
65 {
66     char *s = FromLocale( rLocale.c_str() );
67     string res = s;
68     LocaleFree( s );
69     return res;
70 }
71
72 #ifdef WIN32
73 /// Wrapper around FromWide, to avoid the need to call free()
74 static inline string sFromWide( const wstring &rWide )
75 {
76     char *s = FromWide( rWide.c_str() );
77     string res = s;
78     free( s );
79     return res;
80 }
81 #endif
82
83 /// Wrapper around ToLocale, to avoid the need to call LocaleFree()
84 static inline string sToLocale( const string &rUTF8 )
85 {
86     char *s = ToLocale( rUTF8.c_str() );
87     string res = s;
88     LocaleFree( s );
89     return res;
90 }
91
92
93 //---------------------------------------------------------------------------
94 // intf_sys_t: description and status of skin interface
95 //---------------------------------------------------------------------------
96 struct intf_sys_t
97 {
98     /// The input thread
99     input_thread_t *p_input;
100
101     /// The playlist thread
102     playlist_t *p_playlist;
103
104     /// Message bank subscription
105     msg_subscription_t *p_sub;
106
107     // "Singleton" objects: MUST be initialized to NULL !
108     /// Logger
109     Logger *p_logger;
110     /// Asynchronous command queue
111     AsyncQueue *p_queue;
112     /// Dialog provider
113     Dialogs *p_dialogs;
114     /// Script interpreter
115     Interpreter *p_interpreter;
116     /// Factory for OS specific classes
117     OSFactory *p_osFactory;
118     /// Main OS specific message loop
119     OSLoop *p_osLoop;
120     /// Variable manager
121     VarManager *p_varManager;
122     /// VLC state handler
123     VlcProc *p_vlcProc;
124     /// Vout manager
125     VoutManager *p_voutManager;
126     /// Theme repository
127     ThemeRepository *p_repository;
128
129     /// Current theme
130     Theme *p_theme;
131
132     /// synchronisation at start of interface
133     vlc_thread_t thread;
134     vlc_mutex_t  init_lock;
135     vlc_cond_t   init_wait;
136     bool         b_ready;
137
138     /// handle (vout windows)
139     void*        handle;
140     vlc_mutex_t  vout_lock;
141     vlc_cond_t   vout_wait;
142     bool         b_vout_ready;
143 };
144
145
146 /// Base class for all skin classes
147 class SkinObject
148 {
149 public:
150     SkinObject( intf_thread_t *pIntf ): m_pIntf( pIntf ) { }
151     virtual ~SkinObject() { }
152
153     /// Getter (public because it is used in C callbacks in the win32
154     /// interface)
155     intf_thread_t *getIntf() const { return m_pIntf; }
156
157 private:
158     intf_thread_t *m_pIntf;
159 };
160
161
162 #endif