* Added use of channel server for skins: still experimental
[vlc.git] / modules / gui / skins / src / event.cpp
1 /*****************************************************************************
2  * event.cpp: Event class
3  *****************************************************************************
4  * Copyright (C) 2003 VideoLAN
5  * $Id: event.cpp,v 1.7 2003/04/14 10:00:38 karibu Exp $
6  *
7  * Authors: Olivier Teulière <ipkiss@via.ecp.fr>
8  *          Emmanuel Puig    <karibu@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., 59 Temple Place - Suite 330, Boston, MA  02111,
23  * USA.
24  *****************************************************************************/
25
26
27 //--- VLC -------------------------------------------------------------------
28 #include <vlc/intf.h>
29
30 //--- SKIN ------------------------------------------------------------------
31 #include "os_api.h"
32 #include "skin_common.h"
33 #include "banks.h"
34 #include "generic.h"
35 #include "window.h"
36 #include "theme.h"
37 #include "event.h"
38 #include "os_event.h"
39
40
41
42 //---------------------------------------------------------------------------
43 //   VLC Event
44 //---------------------------------------------------------------------------
45 Event::Event( intf_thread_t *_p_intf, string Desc, string shortcut )
46 {
47     p_intf = _p_intf;
48     EventDesc = Desc;
49     Message   = VLC_NOTHING;
50     Param1    = 0;
51     Param2    = 0;
52     Shortcut  = shortcut;
53 }
54 //---------------------------------------------------------------------------
55 Event::Event( intf_thread_t *_p_intf, unsigned int msg, unsigned int par1,
56               long par2 )
57 {
58     p_intf = _p_intf;
59     Message  = msg;
60     Param1   = par1;
61     Param2   = par2;
62     Shortcut = "none";
63 }
64 //---------------------------------------------------------------------------
65 Event::~Event()
66 {
67 }
68 //---------------------------------------------------------------------------
69 void Event::DestructParameters( bool force )
70 {
71     switch( Message )
72     {
73         case CTRL_SYNCHRO:
74             if( Param2 == (int)true || force )
75                 delete (Event *)Param1;
76             break;
77
78         case CTRL_SET_TEXT:
79             delete[] (char *)Param2;
80             break;
81
82         case VLC_NET_ADDCS:
83             if( Param2 == (int)true || force )
84                 delete[] (char *)Param1;
85             break;
86     }
87
88 }
89 //---------------------------------------------------------------------------
90 bool Event::IsEqual( Event *evt )
91 {
92     return( evt->GetMessage() == Message && evt->GetParam1() == Param1 &&
93             evt->GetParam2()  == Param2 );
94 }
95 //---------------------------------------------------------------------------
96 void Event::PostSynchroMessage( bool autodelete )
97 {
98     OSAPI_PostMessage( NULL, CTRL_SYNCHRO, (unsigned int)this,
99                       (long)autodelete );
100 }
101 //---------------------------------------------------------------------------
102 void Event::PostTextMessage( string text )
103 {
104     char *txt = new char[text.size()+1];
105     strcpy( txt, text.c_str() );
106     OSAPI_PostMessage( NULL, CTRL_SET_TEXT, (unsigned int)this, (long)txt );
107 }
108 //---------------------------------------------------------------------------
109 unsigned int Event::GetMessageType( string Desc )
110 {
111     if( Desc == "VLC_NOTHING" )
112         return VLC_NOTHING;
113
114     // VLC messages
115     else if( Desc == "VLC_QUIT" )
116         return VLC_QUIT;
117     else if( Desc == "VLC_HIDE" )
118         return VLC_HIDE;
119     else if( Desc == "VLC_OPEN" )
120         return VLC_OPEN;
121     else if( Desc == "VLC_LOAD_SKIN" )
122         return VLC_LOAD_SKIN;
123     else if( Desc == "VLC_CHANGE_TRAY" )
124         return VLC_CHANGE_TRAY;
125     else if( Desc == "VLC_CHANGE_TASKBAR" )
126         return VLC_CHANGE_TASKBAR;
127
128     // Stream control
129     else if( Desc == "VLC_PLAY" )
130         return VLC_PLAY;
131     else if( Desc == "VLC_STOP" )
132         return VLC_STOP;
133     else if( Desc == "VLC_PAUSE" )
134         return VLC_PAUSE;
135     else if( Desc == "VLC_NEXT" )
136         return VLC_NEXT;
137     else if( Desc == "VLC_PREV" )
138         return VLC_PREV;
139     else if( Desc == "VLC_STREAMPOS" )
140         return VLC_STREAMPOS;
141     else if( Desc == "VLC_ENDSTREAMPOS" )
142         return VLC_ENDSTREAMPOS;
143     else if( Desc == "VLC_TOTALSTREAMPOS" )
144         return VLC_TOTALSTREAMPOS;
145     else if( Desc == "VLC_STREAMNAME" )
146         return VLC_STREAMNAME;
147     else if( Desc == "VLC_HELP_TEXT" )
148         return VLC_HELP_TEXT;
149
150     // Volume control
151     else if( Desc == "VLC_VOLUME_CHANGE" )
152         return VLC_VOLUME_CHANGE;
153     else if( Desc == "VLC_VOLUME_MUTE" )
154         return VLC_VOLUME_MUTE;
155     else if( Desc == "VLC_VOLUME_UP" )
156         return VLC_VOLUME_UP;
157     else if( Desc == "VLC_VOLUME_DOWN" )
158         return VLC_VOLUME_DOWN;
159     else if( Desc == "VLC_VOLUME_SET" )
160         return VLC_VOLUME_SET;
161
162     // Logs
163     else if( Desc == "VLC_LOG_SHOW" )
164         return VLC_LOG_SHOW;
165     else if( Desc == "VLC_LOG_CLEAR" )
166         return VLC_LOG_CLEAR;
167
168     // Playlist events
169     else if( Desc == "VLC_PLAYLIST_ADD_FILE" )
170         return VLC_PLAYLIST_ADD_FILE;
171
172     // Video output events
173     else if( Desc == "VLC_FULLSCREEN" )
174         return VLC_FULLSCREEN;
175
176     // Network events
177     else if( Desc == "VLC_NET_ADDUDP" )
178         return VLC_NET_ADDUDP;
179     else if( Desc == "VLC_NET_ADDCS" )
180         return VLC_NET_ADDCS;
181
182     // Window event
183     else if( Desc == "WINDOW_MOVE" )
184         return WINDOW_MOVE;
185     else if( Desc == "WINDOW_OPEN" )
186         return WINDOW_OPEN;
187     else if( Desc == "WINDOW_CLOSE" )
188         return WINDOW_CLOSE;
189     else if( Desc == "WINDOW_SHOW" )
190         return WINDOW_SHOW;
191     else if( Desc == "WINDOW_HIDE" )
192         return WINDOW_HIDE;
193     else if( Desc == "WINDOW_FADE" )
194         return WINDOW_FADE;
195
196     // Control event
197     else if( Desc == "CTRL_ENABLED" )
198         return CTRL_ENABLED;
199     else if( Desc == "CTRL_VISIBLE" )
200         return CTRL_VISIBLE;
201     else if( Desc == "CTRL_SYNCHRO" )
202         return CTRL_SYNCHRO;
203     else if( Desc == "CTRL_SET_TEXT" )
204         return CTRL_SET_TEXT;
205     else if( Desc == "CTRL_SET_SLIDER" )
206         return CTRL_SET_SLIDER;
207
208
209     // Control event by ID
210     else if( Desc == "CTRL_ID_VISIBLE" )
211         return CTRL_ID_VISIBLE;
212     else if( Desc == "CTRL_ID_ENABLED" )
213         return CTRL_ID_ENABLED;
214     else if( Desc == "CTRL_ID_MOVE" )
215         return CTRL_ID_MOVE;
216
217     // Control definition
218     else if( Desc == "CTRL_SLIDER" )
219         return CTRL_SLIDER;
220     else if( Desc == "CTRL_TIME" )
221         return CTRL_TIME;
222     else if( Desc == "CTRL_PLAYLIST" )
223         return CTRL_PLAYLIST;
224
225     // Playlist
226     else if( Desc == "PLAYLIST_ID_DEL" )
227         return PLAYLIST_ID_DEL;
228
229     // Not found
230     else
231     {
232         msg_Warn( p_intf, "Theme: Unknown event (%s)", EventDesc.c_str() );
233         return VLC_NOTHING;
234     }
235 }
236 //---------------------------------------------------------------------------
237 void Event::CreateEvent()
238 {
239     // Initialization
240     int x, y;
241     char *msg   = new char[MAX_EVENT_SIZE];
242     char *para1 = new char[MAX_PARAM_SIZE];
243     char *para2 = new char[MAX_PARAM_SIZE];
244     char *para3 = new char[MAX_PARAM_SIZE];
245
246     // Buffer to create strings
247     char *buf;
248
249     // Scan the event
250     int scan = sscanf( EventDesc.c_str(),
251         "%[^(](%[^,)],%[^,)],%[^,)])", msg, para1, para2, para3 );
252
253     // Check parameters
254     if( scan < 1 )
255         strcpy( msg, "VLC_NOTHING" );
256     if( scan < 2 )
257         strcpy( para1, "" );
258     if( scan < 3 )
259         strcpy( para2, "" );
260     if( scan < 4 )
261         strcpy( para3, "" );
262
263     // Find Message type
264     Message = GetMessageType( msg );
265
266     // Find Parameters
267     switch( Message )
268     {
269         case VLC_HIDE:
270             Param1 = GetMessageType( para1 );
271             break;
272
273         case VLC_VOLUME_CHANGE:
274             if( strcmp( para1, "MUTE" ) == 0 )
275                 Param1 = VLC_VOLUME_MUTE;
276             else if( strcmp( para1, "UP" ) == 0 )
277                 Param1 = VLC_VOLUME_UP;
278             else if( strcmp( para1, "DOWN" ) == 0 )
279                 Param1 = VLC_VOLUME_DOWN;
280             else if( strcmp( para1, "SET" ) == 0 )
281             {
282                 Param1 = VLC_VOLUME_SET;
283                 Param2 = atoi( para2 ) * AOUT_VOLUME_MAX / 100;
284             }
285             break;
286
287         case VLC_LOG_SHOW:
288             Param2 = GetBool( para1 );
289             break;
290
291         case VLC_NET_ADDUDP:
292             Param2 = atoi( para1 );
293             break;
294
295         case VLC_NET_ADDCS:
296             buf = new char[MAX_PARAM_SIZE + 7];
297             sprintf( buf, "%s:%s", para1, para2 );
298             Param1 = (unsigned int)buf;
299             Param2 = (int)false;
300             break;
301
302         case CTRL_ID_VISIBLE:
303             Param1 = (unsigned int)FindControl( para1 );
304             Param2 = GetBool( para2 );
305             break;
306
307         case CTRL_ID_ENABLED:
308             Param1 = (unsigned int)FindControl( para1 );
309             Param2 = GetBool( para2 );
310             break;
311
312         case CTRL_ID_MOVE:
313             Param1 = (unsigned int)FindControl( para1 );
314             x = atoi( para2 );
315             y = atoi( para3 );
316             if( x < 0 )
317                 x = -x + 0x8000;
318             if( y < 0 )
319                 y = -y + 0x8000;
320             Param2 = ( y << 16 ) | x;
321             break;
322
323         case WINDOW_OPEN:
324             Param1 = GetBool( para2 );
325             break;
326
327         case WINDOW_CLOSE:
328             Param1 = GetBool( para2 );
329             break;
330
331         case PLAYLIST_ID_DEL:
332             Param1 = (unsigned int)FindControl( para1 );
333             break;
334
335         default:
336             break;
337     }
338
339     // Get OS specific parameters
340     CreateOSEvent( para1, para2, para3 );
341
342     // Free memory
343     delete[] msg;
344     delete[] para1;
345     delete[] para2;
346     delete[] para3;
347
348     // Create shortcut
349     CreateShortcut();
350
351 }
352 //---------------------------------------------------------------------------
353 GenericControl * Event::FindControl( string id )
354 {
355     list<Window *>::const_iterator win;
356     unsigned int i;
357
358     for( win = p_intf->p_sys->p_theme->WindowList.begin();
359          win != p_intf->p_sys->p_theme->WindowList.end(); win++ )
360     {
361         for( i = 0; i < (*win)->ControlList.size(); i++ )
362         {
363             if( (*win)->ControlList[i]->IsID( id ) )
364                 return (*win)->ControlList[i];
365         }
366     }
367     return NULL;
368
369 }
370 //---------------------------------------------------------------------------
371 int Event::GetBool( string expr )
372 {
373     if( expr == "FALSE" )
374     {
375         return 0;
376     }
377     else if( expr == "TRUE" )
378     {
379         return 1;
380     }
381     else if( expr == "CHANGE" )
382     {
383         return 2;
384     }
385     return 1;
386 }
387 //---------------------------------------------------------------------------
388 void Event::CreateShortcut()
389 {
390     if( Shortcut == "none" )
391         return;
392
393     // Initiatization
394     char *mod = new char[4];
395     char *key = new char[4];
396
397     // Scan the event
398     int scan = sscanf( Shortcut.c_str(), "%[^+]+%s", mod, key );
399
400     // Check parameters
401     if( scan == 2 )
402     {
403         Key = (int)key[0];
404         if( (string)mod == "ALT" )
405             KeyModifier = 1;
406         else if( (string)mod == "CTRL" )
407             KeyModifier = 2;
408         else
409             KeyModifier = 0;
410     }
411     else if( scan == 1 )
412     {
413         Key = (int)mod[0];
414         KeyModifier = 0;
415     }
416
417     delete[] mod;
418     delete[] key;
419 }
420 //---------------------------------------------------------------------------
421 bool Event::MatchShortcut( int key, int mod )
422 {
423     // Modifier
424     // None    = 0
425     // ALT     = 1
426     // CONTROL = 2
427     if( Shortcut != "none" && key == Key && mod == KeyModifier )
428         return true;
429     else
430         return false;
431 }
432 //---------------------------------------------------------------------------
433
434
435
436
437 //---------------------------------------------------------------------------
438 // Action
439 //---------------------------------------------------------------------------
440 Action::Action( intf_thread_t *_p_intf, string code )
441 {
442     p_intf = _p_intf;
443
444     // Initiatization
445     int scan;
446     char *evt  = new char[MAX_EVENT_SIZE];
447     char *next = new char[MAX_PARAM_SIZE];
448
449     // Create events separated with a semicolon
450     while( code != "none" )
451     {
452         scan  = sscanf( code.c_str(), "%[^;];%s", evt, next );
453         EventList.push_back( p_intf->p_sys->p_theme->EvtBank->Get( evt ) );
454
455         // Check if script is finished
456         if( scan < 2 )
457             code = "none";
458         else
459             code = next;
460     }
461
462     // Free memory
463     delete[] evt;
464     delete[] next;
465
466 }
467 //---------------------------------------------------------------------------
468 Action::~Action()
469 {
470
471 }
472 //---------------------------------------------------------------------------
473 bool Action::SendEvent()
474 {
475     bool res = false;
476     for( list<Event *>::const_iterator evt = EventList.begin();
477          evt != EventList.end(); evt++ )
478     {
479         res |= (*evt)->SendEvent();
480     }
481     return res;
482 }
483 //---------------------------------------------------------------------------
484 bool Action::MatchEvent( Event *evt, int flag )
485 {
486     list<Event *>::const_iterator event;
487
488     switch( flag )
489     {
490         case ACTION_MATCH_ALL:
491             for( event = EventList.begin(); event != EventList.end(); event++ )
492                 if( !(*event)->IsEqual( evt ) )
493                     return false;
494             break;
495
496         case ACTION_MATCH_ONE:
497             for( event = EventList.begin(); event != EventList.end(); event++ )
498                 if( (*event)->IsEqual( evt ) )
499                     return true;
500             return false;
501             break;
502
503         case ACTION_MATCH_FIRST:
504             if( !(*EventList.begin())->IsEqual( evt ) )
505                 return false;
506             break;
507     }
508     return true;
509 }
510 //---------------------------------------------------------------------------
511