5bed8105481a40c7bc0095f4313c0235c5a6e0a6
[vlc.git] / modules / gui / wxwidgets / wxwidgets.hpp
1 /*****************************************************************************
2  * wxwidgets.hpp: Common headers for the wxwidges interface
3  *****************************************************************************
4  * Copyright (C) 1999-2005 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef _WXVLC_WIDGETS_H_
25 #define _WXVLC_WIDGETS_H_
26
27 #ifdef WIN32                                                 /* mingw32 hack */
28 #undef Yield
29 #undef CreateDialog
30 #endif
31
32 #ifdef _MSC_VER
33 // turn off 'identifier was truncated to '255' characters in the debug info'
34 #   pragma warning( disable:4786 )
35 #endif
36
37 /* Let vlc take care of the i18n stuff */
38 #define WXINTL_NO_GETTEXT_MACRO
39
40 #include <vlc/vlc.h>
41 #include <vlc/intf.h>
42 #include "charset.h"
43
44 #include <wx/wx.h>
45 #define SLIDER_MAX_POS 10000
46
47 /*
48 #include <wx/listctrl.h>
49 #include <wx/textctrl.h>
50 #include <wx/notebook.h>
51 #include <wx/spinctrl.h>
52 #include <wx/dnd.h>
53 #include <wx/treectrl.h>
54 #include <wx/gauge.h>
55 #include <wx/accel.h>
56 #include <wx/checkbox.h>
57 #include <wx/wizard.h>
58 #include <wx/taskbar.h>
59 #include "vlc_keys.h"
60 */
61 #if (!wxCHECK_VERSION(2,5,0))
62 typedef long wxTreeItemIdValue;
63 #endif
64
65 DECLARE_LOCAL_EVENT_TYPE( wxEVT_DIALOG, 0 );
66 DECLARE_LOCAL_EVENT_TYPE( wxEVT_INTF, 1 );
67
68 /***************************************************************************
69  * I18N macros
70  ***************************************************************************/
71
72 /* wxU is used to convert ansi/utf8 strings to unicode strings (wchar_t) */
73 #if defined( ENABLE_NLS )
74 #if wxUSE_UNICODE
75 #   define wxU(utf8) wxString(utf8, wxConvUTF8)
76 #else
77 #   define wxU(utf8) wxString(wxConvUTF8.cMB2WC(utf8), *wxConvCurrent)
78 #endif
79 #else // ENABLE_NLS
80 #if wxUSE_UNICODE
81 #   define wxU(ansi) wxString(ansi, wxConvLocal)
82 #else
83 #   define wxU(ansi) (ansi)
84 #endif
85 #endif
86
87 /* wxL2U (locale to unicode) is used to convert ansi strings to unicode
88  * strings (wchar_t) */
89 #define wxL2U(ansi) wxU(ansi)
90
91 #if wxUSE_UNICODE
92 #   define wxFromLocale(wxstring) FromUTF32(wxstring.wc_str())
93 #   define wxLocaleFree(string) free(string)
94 #else
95 #   define wxFromLocale(wxstring) FromLocale(wxstring.mb_str())
96 #   define wxLocaleFree(string) LocaleFree(string)
97 #endif
98
99 /* From Locale functions to use for File Drop targets ... go figure */
100 #ifdef wxUSE_UNICODE
101 inline const char *wxDnDFromLocale( const wxChar *stupid )
102 {
103     /*
104      * FIXME: this is yet another awful and ugly bug-to-bug work-around
105      * for the painfully broken and brain-dead wxWidgets character
106      * encoding internals. Maybe, one day the wxWidgets team will find out
107      * and we will have to remove (phew) this kludge or autodetect whether
108      * to trigger it (damn).
109      *
110      * In Unicode mode, wxWidgets will encode file names in the locale
111      * encoding with each **bytes** (rather than characters) represented
112      * by a 32 bits unsigned integer. If you are lucky enough to be using
113      * ISO-8859-1 as your local character encoding, that lame encoding
114      * scheme happens to be identical to UTF-32 with your arch native
115      * byte-endianess. If you are using anything else, including not only
116      * UTF-8 but also Windows-1252(!) and ISO-8859-15(!) or any
117      * non-western encoding, it obviously fails.
118      */
119     const wxChar *braindead;
120     for (braindead = stupid; *braindead; braindead++);
121
122     size_t i = (braindead - stupid);
123     char *psz_local = (char *)malloc( i + 1 );
124     do
125         psz_local[i] = (char)stupid[i];
126     while (i--);
127
128     const char *psz_utf8 = FromLocale( psz_local );
129     free( psz_local );
130     return psz_utf8;
131 }
132 #else
133 #   define wxDnDFromLocale( string ) wxFromLocale( string )
134 #endif
135 #define wxDnDLocaleFree(string) LocaleFree( string )
136
137 #define WRAPCOUNT 80
138
139 #define OPEN_NORMAL 0
140 #define OPEN_STREAM 1
141
142 enum
143 {
144   ID_CONTROLS_TIMER,
145   ID_SLIDER_TIMER,
146 };
147
148 namespace wxvlc {
149     class WindowSettings;
150     class VideoWindow;
151 };
152
153 using namespace wxvlc;
154
155 class DialogsProvider;
156 class PrefsTreeCtrl;
157 class AutoBuiltPanel;
158
159 /*****************************************************************************
160  * intf_sys_t: description and status of wxwindows interface
161  *****************************************************************************/
162 struct intf_sys_t
163 {
164     /* the wx parent window */
165     wxWindow            *p_wxwindow;
166     wxIcon              *p_icon;
167
168     /* window settings */
169     WindowSettings      *p_window_settings;
170
171     /* special actions */
172     vlc_bool_t          b_playing;
173     vlc_bool_t          b_intf_show;                /* interface to be shown */
174
175     /* The input thread */
176     input_thread_t *    p_input;
177
178     /* The messages window */
179     msg_subscription_t* p_sub;                  /* message bank subscription */
180
181     /* Playlist management */
182     int                 i_playing;                 /* playlist selected item */
183     unsigned            i_playlist_usage;
184
185     /* Send an event to show a dialog */
186     void (*pf_show_dialog) ( intf_thread_t *p_intf, int i_dialog, int i_arg,
187                              intf_dialog_args_t *p_arg );
188
189     /* Popup menu */
190     wxMenu              *p_popup_menu;
191
192     /* Hotkeys */
193     int                 i_first_hotkey_event;
194     int                 i_hotkeys;
195
196     /* Embedded vout */
197     VideoWindow         *p_video_window;
198     wxBoxSizer          *p_video_sizer;
199     vlc_bool_t          b_video_autosize;
200
201     /* Aout */
202     aout_instance_t     *p_aout;
203 };
204
205
206
207 wxArrayString SeparateEntries( wxString );
208 wxWindow *CreateDialogsProvider( intf_thread_t *p_intf, wxWindow *p_parent );
209
210 /*
211  * wxWindows keeps dead locking because the timer tries to lock the playlist
212  * when it's already locked somewhere else in the very wxWindows interface
213  * module. Unless someone implements a "vlc_mutex_trylock", we need that.
214  */
215 inline void LockPlaylist( intf_sys_t *p_sys, playlist_t *p_pl )
216 {
217     if( p_sys->i_playlist_usage++ == 0)
218         vlc_mutex_lock( &p_pl->object_lock );
219 }
220
221 inline void UnlockPlaylist( intf_sys_t *p_sys, playlist_t *p_pl )
222 {
223     if( --p_sys->i_playlist_usage == 0)
224         vlc_mutex_unlock( &p_pl->object_lock );
225 }
226
227 #endif