macosx: fixed potential crashes when localizing strings
[vlc.git] / modules / gui / macosx / intf.h
1 /*****************************************************************************
2  * intf.h: MacOS X interface module
3  *****************************************************************************
4  * Copyright (C) 2002-2012 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
8  *          Christophe Massiot <massiot@via.ecp.fr>
9  *          Derk-Jan Hartman <hartman at videolan dot org>
10  *          Felix Paul K├╝hne <fkuehne at videolan dot org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 #   include "config.h"
29 #endif
30
31 #import <vlc_common.h>
32 #import <vlc_interface.h>
33 #import <vlc_playlist.h>
34 #import <vlc_vout.h>
35 #import <vlc_aout.h>
36 #import <vlc_input.h>
37
38 #import <Cocoa/Cocoa.h>
39 #import "CompatibilityFixes.h"
40 #import "SPMediaKeyTap.h"                   /* for the media key support */
41 #import "misc.h"
42 #import "MainWindow.h"
43
44 /*****************************************************************************
45  * Local prototypes.
46  *****************************************************************************/
47 unsigned int CocoaKeyToVLC( unichar i_key );
48
49 #define VLCIntf [[VLCMain sharedInstance] intf]
50
51 #define _NS(s) [[VLCMain sharedInstance] localizedString: s]
52 /* Get an alternate version of the string.
53  * This string is stored as '1:string' but when displayed it only displays
54  * the translated string. the translation should be '1:translatedstring' though */
55 #define _ANS(s) [[[VLCMain sharedInstance] localizedString: _(s)] substringFromIndex:2]
56
57 #define MACOS_VERSION [[[NSDictionary dictionaryWithContentsOfFile: \
58             @"/System/Library/CoreServices/SystemVersion.plist"] \
59             objectForKey: @"ProductVersion"] floatValue]
60
61
62 // You need to release those objects after use
63 input_thread_t *getInput(void);
64 vout_thread_t *getVout(void);
65 audio_output_t *getAout(void);
66
67 /*****************************************************************************
68  * intf_sys_t: description and status of the interface
69  *****************************************************************************/
70 struct intf_sys_t
71 {
72     /* menus handlers */
73     bool b_input_update;
74     bool b_aout_update;
75     bool b_vout_update;
76
77     /* The messages window */
78     msg_subscription_t * p_sub;
79 };
80
81 /*****************************************************************************
82  * VLCMain interface
83  *****************************************************************************/
84 @class AppleRemote;
85 @class VLCInformation;
86 @class VLCEmbeddedWindow;
87 @class VLCControls;
88 @class VLCPlaylist;
89 @interface VLCMain : NSObject <NSWindowDelegate>
90 {
91     intf_thread_t *p_intf;      /* The main intf object */
92     id o_mainmenu;              /* VLCMainMenu */
93     id o_prefs;                 /* VLCPrefs       */
94     id o_sprefs;                /* VLCSimplePrefs */
95     id o_open;                  /* VLCOpen        */
96     id o_wizard;                /* VLCWizard      */
97     id o_embedded_list;         /* VLCEmbeddedList*/
98     id o_coredialogs;           /* VLCCoreDialogProvider */
99     id o_info;                  /* VLCInformation */
100     id o_eyetv;                 /* VLCEyeTVController */
101     id o_bookmarks;             /* VLCBookmarks */
102     id o_coreinteraction;       /* VLCCoreInteraction */
103     BOOL nib_main_loaded;       /* main nibfile */
104     BOOL nib_open_loaded;       /* open nibfile */
105     BOOL nib_about_loaded;      /* about nibfile */
106     BOOL nib_wizard_loaded;     /* wizard nibfile */
107     BOOL nib_prefs_loaded;      /* preferences nibfile */
108     BOOL nib_info_loaded;       /* information panel nibfile */
109     BOOL nib_coredialogs_loaded; /* CoreDialogs nibfile */
110     BOOL nib_bookmarks_loaded;   /* Bookmarks nibfile */
111     BOOL b_active_videoplayback;
112     BOOL b_nativeFullscreenMode;
113
114     VLCMainWindow *o_mainwindow;            /* VLCMainWindow */
115
116     IBOutlet VLCControls * o_controls;     /* VLCControls    */
117     IBOutlet VLCPlaylist * o_playlist;     /* VLCPlaylist    */
118
119     IBOutlet NSWindow * o_msgs_panel;           /* messages panel */
120     NSMutableArray * o_msg_arr;                 /* messages array */
121     NSLock * o_msg_lock;                        /* messages lock */
122     BOOL b_msg_arr_changed;                     /* did the array change? */
123     IBOutlet NSButton * o_msgs_crashlog_btn;    /* messages open crashlog */
124     IBOutlet NSButton * o_msgs_save_btn;        /* save the log as rtf */
125     IBOutlet NSButton * o_msgs_refresh_btn;     /* update the panel */
126     IBOutlet id o_msgs_table;
127
128     /* CrashReporter panel */
129     IBOutlet NSButton * o_crashrep_dontSend_btn;
130     IBOutlet NSButton * o_crashrep_send_btn;
131     IBOutlet NSTextView * o_crashrep_fld;
132     IBOutlet NSTextField * o_crashrep_title_txt;
133     IBOutlet NSTextField * o_crashrep_desc_txt;
134     IBOutlet NSWindow * o_crashrep_win;
135     IBOutlet NSButton * o_crashrep_includeEmail_ckb;
136     IBOutlet NSTextField * o_crashrep_includeEmail_txt;
137     NSURLConnection * crashLogURLConnection;
138
139     AppleRemote * o_remote;
140     BOOL b_remote_button_hold; /* true as long as the user holds the left,right,plus or minus on the remote control */
141
142     /* media key support */
143     BOOL b_mediaKeySupport;
144     BOOL b_mediakeyJustJumped;
145     SPMediaKeyTap * o_mediaKeyController;
146
147     NSArray *o_usedHotkeys;
148 }
149
150 + (VLCMain *)sharedInstance;
151
152 - (intf_thread_t *)intf;
153 - (void)setIntf:(intf_thread_t *)p_mainintf;
154
155 - (id)mainMenu;
156 - (id)controls;
157 - (id)bookmarks;
158 - (id)open;
159 - (id)simplePreferences;
160 - (id)preferences;
161 - (id)playlist;
162 - (id)info;
163 - (id)wizard;
164 - (id)embeddedList;
165 - (id)getVideoViewAtPositionX: (int *)pi_x Y: (int *)pi_y withWidth: (unsigned int*)pi_width andHeight: (unsigned int*)pi_height;
166 - (void)setNativeVideoSize:(NSSize)size;
167 - (id)coreDialogProvider;
168 - (id)eyeTVController;
169 - (id)appleRemoteController;
170 - (void)setActiveVideoPlayback:(BOOL)b_value;
171 - (BOOL)activeVideoPlayback;
172 - (void)applicationWillTerminate:(NSNotification *)notification;
173 - (NSString *)localizedString:(const char *)psz;
174 - (char *)delocalizeString:(NSString *)psz;
175 - (NSString *)wrapString: (NSString *)o_in_string toWidth: (int)i_width;
176 - (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event;
177 - (NSString *)VLCKeyToString:(NSString *)theString;
178 - (unsigned int)VLCModifiersToCocoa:(NSString *)theString;
179 - (void)updateCurrentlyUsedHotkeys;
180 - (void)fullscreenChanged;
181 - (void)PlaylistItemChanged;
182 - (void)playbackStatusUpdated;
183 - (void)playbackModeUpdated;
184 - (void)updateVolume;
185 - (void)updatePlaybackPosition;
186 - (void)updateName;
187 - (void)playlistUpdated;
188 - (void)updateRecordState: (BOOL)b_value;
189 - (void)updateInfoandMetaPanel;
190 - (void)updateMainMenu;
191 - (void)updateMainWindow;
192 - (void)showMainWindow;
193 - (void)showFullscreenController;
194 - (void)updateDelays;
195 - (void)initStrings;
196 - (BOOL)application:(NSApplication *)o_app openFile:(NSString *)o_filename;
197
198 - (IBAction)crashReporterAction:(id)sender;
199 - (IBAction)openCrashLog:(id)sender;
200 - (IBAction)saveDebugLog:(id)sender;
201 - (IBAction)showMessagesPanel:(id)sender;
202 - (IBAction)updateMessagesPanel:(id)sender;
203
204 - (void)processReceivedlibvlcMessage:(const msg_item_t *) item ofType: (int)type withStr: (char *)str;
205
206 - (void)updateTogglePlaylistState;
207
208 - (void)windowDidBecomeKey:(NSNotification *)o_notification;
209
210 - (void)mediaKeyTap:(SPMediaKeyTap*)keyTap receivedMediaKeyEvent:(NSEvent*)event;
211 @end
212
213 @interface VLCMain (Internal)
214 - (void)handlePortMessage:(NSPortMessage *)o_msg;
215 - (void)resetMediaKeyJump;
216 - (void)coreChangedMediaKeySupportSetting: (NSNotification *)o_notification;
217 @end
218
219 /*****************************************************************************
220  * VLCApplication interface
221  *****************************************************************************/
222
223 @interface VLCApplication : NSApplication
224 {
225 }
226 @end