* Playtree start. Basic functionalities work. Still needs a lot of
[vlc.git] / modules / gui / skins2 / parser / skin_parser.cpp
1 /*****************************************************************************
2  * skin_parser.cpp
3  *****************************************************************************
4  * Copyright (C) 2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 #include "skin_parser.hpp"
25 #include <math.h>
26
27 SkinParser::SkinParser( intf_thread_t *pIntf, const string &rFileName,
28                         const string &rPath ):
29     XMLParser( pIntf, rFileName ), m_xOffset( 0 ), m_yOffset( 0 ),
30     m_path( rPath )
31 {
32 }
33
34
35 void SkinParser::handleBeginElement( const string &rName, AttrList_t &attr )
36 {
37 #define CheckDefault( a, b ) \
38     if( attr.find(a) == attr.end() ) attr[strdup(a)] = strdup(b);
39 #define RequireDefault( a ) \
40     if( attr.find(a) == attr.end() ) \
41     { \
42         msg_Err( getIntf(), "Bad theme (element: %s, missing attribute: %s)", \
43                  rName.c_str(), a ); \
44         m_errors = true; return; \
45     }
46
47     if( rName == "Anchor" )
48     {
49         RequireDefault( "priority" );
50         CheckDefault( "x", "0" );
51         CheckDefault( "y", "0" );
52         CheckDefault( "points", "(0,0)" );
53         CheckDefault( "range", "10" );
54
55         const BuilderData::Anchor anchor( atoi( attr["x"] ) + m_xOffset,
56                 atoi( attr["y"] ) + m_yOffset, atoi( attr["range"] ),
57                 atoi( attr["priority"] ), attr["points"], m_curLayoutId );
58         m_data.m_listAnchor.push_back( anchor );
59     }
60
61     else if( rName == "Bitmap" )
62     {
63         RequireDefault( "id" );
64         RequireDefault( "file" );
65         RequireDefault( "alphacolor" );
66
67         const BuilderData::Bitmap bitmap( uniqueId( attr["id"] ),
68                 convertFileName( attr["file"] ),
69                 convertColor( attr["alphacolor"] ) );
70         m_data.m_listBitmap.push_back( bitmap );
71     }
72
73     else if( rName == "BitmapFont" )
74     {
75         RequireDefault( "id" );
76         RequireDefault( "file" );
77         CheckDefault( "type", "digits" );
78
79         const BuilderData::BitmapFont font( uniqueId( attr["id"] ),
80                 convertFileName( attr["file"] ),
81                 attr["type"] );
82         m_data.m_listBitmapFont.push_back( font );
83     }
84
85     else if( rName == "Button" )
86     {
87         RequireDefault( "up" );
88         CheckDefault( "id", "none" );
89         CheckDefault( "visible", "true" );
90         CheckDefault( "x", "0" );
91         CheckDefault( "y", "0" );
92         CheckDefault( "lefttop", "lefttop" );
93         CheckDefault( "rightbottom", "lefttop" );
94         CheckDefault( "down", "none" );
95         CheckDefault( "over", "none" );
96         CheckDefault( "action", "none" );
97         CheckDefault( "tooltiptext", "" );
98         CheckDefault( "help", "" );
99
100         const BuilderData::Button button( uniqueId( attr["id"] ),
101                 atoi( attr["x"] ) + m_xOffset, atoi( attr["y"] ) + m_yOffset,
102                 attr["lefttop"], attr["rightbottom"], attr["visible"],
103                 attr["up"], attr["down"], attr["over"], attr["action"],
104                 attr["tooltiptext"], attr["help"],
105                 m_curLayer, m_curWindowId, m_curLayoutId );
106         m_curLayer++;
107         m_data.m_listButton.push_back( button );
108     }
109
110     else if( rName == "Checkbox" )
111     {
112         RequireDefault( "up1" );
113         RequireDefault( "up2" );
114         RequireDefault( "state" );
115         CheckDefault( "id", "none" );
116         CheckDefault( "visible", "true" );
117         CheckDefault( "x", "0" );
118         CheckDefault( "y", "0" );
119         CheckDefault( "lefttop", "lefttop" );
120         CheckDefault( "rightbottom", "lefttop" );
121         CheckDefault( "down1", "none" );
122         CheckDefault( "over1", "none" );
123         CheckDefault( "down2", "none" );
124         CheckDefault( "over2", "none" );
125         CheckDefault( "action1", "none" );
126         CheckDefault( "action2", "none" );
127         CheckDefault( "tooltiptext1", "" );
128         CheckDefault( "tooltiptext2", "" );
129         CheckDefault( "help", "" );
130
131         const BuilderData::Checkbox checkbox( uniqueId( attr["id"] ),
132                 atoi( attr["x"] ) + m_xOffset, atoi( attr["y"] ) + m_yOffset,
133                 attr["lefttop"], attr["rightbottom"], attr["visible"],
134                 attr["up1"], attr["down1"], attr["over1"],
135                 attr["up2"], attr["down2"], attr["over2"], attr["state"],
136                 attr["action1"], attr["action2"], attr["tooltiptext1"],
137                 attr["tooltiptext2"], attr["help"], m_curLayer, m_curWindowId,
138                 m_curLayoutId );
139         m_curLayer++;
140         m_data.m_listCheckbox.push_back( checkbox );
141     }
142
143     else if( rName == "Font" )
144     {
145         RequireDefault( "id" );
146         RequireDefault( "file" );
147         CheckDefault( "size", "12" );
148
149         const BuilderData::Font fontData( uniqueId( attr["id"] ),
150                 convertFileName( attr["file"] ),
151                 atoi( attr["size"] ) );
152         m_data.m_listFont.push_back( fontData );
153     }
154
155     else if( rName == "Group" )
156     {
157         CheckDefault( "x", "0" );
158         CheckDefault( "y", "0" );
159
160         m_xOffset += atoi( attr["x"] );
161         m_yOffset += atoi( attr["y"] );
162         m_xOffsetList.push_back( atoi( attr["x"] ) );
163         m_yOffsetList.push_back( atoi( attr["y"] ) );
164     }
165
166     else if( rName == "Image" )
167     {
168         RequireDefault( "image" );
169         CheckDefault( "id", "none" );
170         CheckDefault( "visible", "true" );
171         CheckDefault( "x", "0" );
172         CheckDefault( "y", "0" );
173         CheckDefault( "lefttop", "lefttop" );
174         CheckDefault( "rightbottom", "lefttop" );
175         CheckDefault( "action", "none" );
176         CheckDefault( "resize", "mosaic" );
177         CheckDefault( "help", "" );
178
179         const BuilderData::Image imageData( uniqueId( attr["id"] ),
180                 atoi( attr["x"] ) + m_xOffset, atoi( attr["y"] ) + m_yOffset,
181                 attr["lefttop"], attr["rightbottom"], attr["visible"],
182                 attr["image"], attr["action"], attr["resize"], attr["help"],
183                 m_curLayer, m_curWindowId, m_curLayoutId );
184         m_curLayer++;
185         m_data.m_listImage.push_back( imageData );
186     }
187
188     else if( rName == "Layout" )
189     {
190         RequireDefault( "width" );
191         RequireDefault( "height" );
192         CheckDefault( "id", "none" );
193         CheckDefault( "minwidth", "-1" );
194         CheckDefault( "maxwidth", "-1" );
195         CheckDefault( "minheight", "-1" );
196         CheckDefault( "maxheight", "-1" );
197
198         m_curLayoutId = uniqueId( attr["id"] );
199         const BuilderData::Layout layout( m_curLayoutId, atoi( attr["width"] ),
200                 atoi( attr["height"] ), atoi( attr["minwidth"] ),
201                 atoi( attr["maxwidth"] ), atoi( attr["minheight"] ),
202                 atoi( attr["maxheight"] ), m_curWindowId );
203         m_data.m_listLayout.push_back( layout );
204         m_curLayer = 0;
205     }
206
207     else if( rName == "Playlist" )
208     {
209         RequireDefault( "id" );
210         RequireDefault( "font" );
211         CheckDefault( "visible", "true" );
212         CheckDefault( "x", "0" );
213         CheckDefault( "y", "0" );
214         CheckDefault( "width", "0" );
215         CheckDefault( "height", "0" );
216         CheckDefault( "lefttop", "lefttop" );
217         CheckDefault( "rightbottom", "lefttop" );
218         CheckDefault( "bgimage", "none" );
219         CheckDefault( "fgcolor", "#000000" );
220         CheckDefault( "playcolor", "#FF0000" );
221         CheckDefault( "bgcolor1", "#FFFFFF" );
222         CheckDefault( "bgcolor2", "#FFFFFF" );
223         CheckDefault( "selcolor", "#0000FF" );
224         CheckDefault( "help", "" );
225
226         m_curListId = uniqueId( attr["id"] );
227         const BuilderData::List listData( m_curListId, atoi( attr["x"] ) +
228                 m_xOffset, atoi( attr["y"] ) + m_yOffset, attr["visible"],
229                 atoi( attr["width"]), atoi( attr["height"] ),
230                 attr["lefttop"], attr["rightbottom"],
231                 attr["font"], "playlist", attr["bgimage"],
232                 convertColor( attr["fgcolor"] ),
233                 convertColor( attr["playcolor"] ),
234                 convertColor( attr["bgcolor1"] ),
235                 convertColor( attr["bgcolor2"] ),
236                 convertColor( attr["selcolor"] ), attr["help"],
237                 m_curLayer, m_curWindowId, m_curLayoutId );
238         m_curLayer++;
239         m_data.m_listList.push_back( listData );
240     }
241
242     else if( rName == "Playtree" )
243     {
244         RequireDefault( "id" );
245         RequireDefault( "font" );
246         CheckDefault( "visible", "true" );
247         CheckDefault( "x", "0" );
248         CheckDefault( "y", "0" );
249         CheckDefault( "width", "0" );
250         CheckDefault( "height", "0" );
251         CheckDefault( "lefttop", "lefttop" );
252         CheckDefault( "rightbottom", "lefttop" );
253         CheckDefault( "bgimage", "none" );
254         CheckDefault( "itemimage", "none" );
255         CheckDefault( "openimage", "none" );
256         CheckDefault( "closedimage", "none" );
257         CheckDefault( "fgcolor", "#000000" );
258         CheckDefault( "playcolor", "#FF0000" );
259         CheckDefault( "bgcolor1", "#FFFFFF" );
260         CheckDefault( "bgcolor2", "#FFFFFF" );
261         CheckDefault( "selcolor", "#0000FF" );
262         CheckDefault( "help", "" );
263
264         m_curListId = uniqueId( attr["id"] );
265         const BuilderData::Tree treeData( m_curListId, atoi( attr["x"] ) +
266                 m_xOffset, atoi( attr["y"] ) + m_yOffset, attr["visible"],
267                 atoi( attr["width"]), atoi( attr["height"] ),
268                 attr["lefttop"], attr["rightbottom"],
269                 attr["font"], "playtree",
270                 attr["bgimage"], attr["itemimage"],
271                 attr["openimage"], attr["closedimage"],
272                 convertColor( attr["fgcolor"] ),
273                 convertColor( attr["playcolor"] ),
274                 convertColor( attr["bgcolor1"] ),
275                 convertColor( attr["bgcolor2"] ),
276                 convertColor( attr["selcolor"] ), attr["help"],
277                 m_curLayer, m_curWindowId, m_curLayoutId );
278         m_curLayer++;
279         m_data.m_listTree.push_back( treeData );
280     }
281
282     else if( rName == "RadialSlider" )
283     {
284         RequireDefault( "sequence" );
285         RequireDefault( "nbimages" );
286         CheckDefault( "id", "none" );
287         CheckDefault( "visible", "true" );
288         CheckDefault( "x", "0" );
289         CheckDefault( "y", "0" );
290         CheckDefault( "lefttop", "lefttop" );
291         CheckDefault( "rightbottom", "lefttop" );
292         CheckDefault( "minangle", "0" );
293         CheckDefault( "maxangle", "360" );
294         CheckDefault( "value", "none" );
295         CheckDefault( "tooltiptext", "" );
296         CheckDefault( "help", "" );
297
298         const BuilderData::RadialSlider radial( uniqueId( attr["id"] ),
299                 attr["visible"],
300                 atoi( attr["x"] ) + m_xOffset, atoi( attr["y"] ) + m_yOffset,
301                 attr["lefttop"], attr["rightbottom"], attr["sequence"],
302                 atoi( attr["nbImages"] ), atof( attr["minAngle"] ) * M_PI /180,
303                 atof( attr["maxAngle"] ) * M_PI / 180, attr["value"],
304                 attr["tooltiptext"], attr["help"], m_curLayer, m_curWindowId,
305                 m_curLayoutId );
306         m_curLayer++;
307         m_data.m_listRadialSlider.push_back( radial );
308     }
309
310     else if( rName == "Slider" )
311     {
312         RequireDefault( "up" );
313         RequireDefault( "points" );
314         CheckDefault( "id", "none" );
315         CheckDefault( "visible", "true" );
316         CheckDefault( "x", "0" );
317         CheckDefault( "y", "0" );
318         CheckDefault( "width", "0" );
319         CheckDefault( "height", "0" );
320         CheckDefault( "lefttop", "lefttop" );
321         CheckDefault( "rightbottom", "lefttop" );
322         CheckDefault( "down", "none" );
323         CheckDefault( "over", "none" );
324         CheckDefault( "thickness", "10" );
325         CheckDefault( "value", "none" );
326         CheckDefault( "tooltiptext", "" );
327         CheckDefault( "help", "" );
328
329         string newValue = attr["value"];
330         if( m_curListId != "" )
331         {
332             // Slider associated to a list
333             newValue = "playlist.slider";
334             // FIXME
335             newValue = "playtree.slider";
336         }
337         const BuilderData::Slider slider( uniqueId( attr["id"] ),
338                 attr["visible"],
339                 atoi( attr["x"] ) + m_xOffset, atoi( attr["y"] ) + m_yOffset,
340                 attr["lefttop"], attr["rightbottom"], attr["up"], attr["down"],
341                 attr["over"], attr["points"], atoi( attr["thickness"] ),
342                 newValue, attr["tooltiptext"], attr["help"], m_curLayer,
343                 m_curWindowId, m_curLayoutId );
344         m_curLayer++;
345         m_data.m_listSlider.push_back( slider );
346     }
347
348     else if( rName == "Text" )
349     {
350         RequireDefault( "font" );
351         CheckDefault( "id", "none" );
352         CheckDefault( "visible", "true" );
353         CheckDefault( "x", "0" );
354         CheckDefault( "y", "0" );
355         CheckDefault( "text", "" );
356         CheckDefault( "color", "#000000" );
357         CheckDefault( "width", "0" );
358         CheckDefault( "lefttop", "lefttop" );
359         CheckDefault( "rightbottom", "lefttop" );
360         CheckDefault( "help", "" );
361
362         const BuilderData::Text textData( uniqueId( attr["id"] ),
363                 atoi( attr["x"] ) + m_xOffset, atoi( attr["y"] ) + m_yOffset,
364                 attr["visible"], attr["font"],
365                 attr["text"], atoi( attr["width"] ),
366                 attr["lefttop"], attr["rightbottom"],
367                 convertColor( attr["color"] ), attr["help"], m_curLayer,
368                 m_curWindowId, m_curLayoutId );
369         m_curLayer++;
370         m_data.m_listText.push_back( textData );
371     }
372
373     else if( rName == "Theme" )
374     {
375         RequireDefault( "version" );
376         CheckDefault( "tooltipfont", "defaultfont" );
377         CheckDefault( "magnet", "15" );
378         CheckDefault( "alpha", "255" );
379         CheckDefault( "movealpha", "255" );
380
381         // Check the version
382         if( strcmp( attr["version"], SKINS_DTD_VERSION ) )
383         {
384             msg_Err( getIntf(), "Bad theme version : %s (you need version %s)",
385                      attr["version"], SKINS_DTD_VERSION );
386             m_errors = true;
387             return;
388         }
389         const BuilderData::Theme theme( attr["tooltipfont"],
390                 atoi( attr["magnet"] ),
391                 convertInRange( attr["alpha"], 1, 255, "alpha" ),
392                 convertInRange( attr["movealpha"], 1, 255, "movealpha" ) );
393         m_data.m_listTheme.push_back( theme );
394     }
395
396     else if( rName == "ThemeInfo" )
397     {
398         msg_Info( getIntf(), "skin: %s  author: %s", attr["name"],
399                   attr["author"] );
400     }
401
402     else if( rName == "Video" )
403     {
404         CheckDefault( "id", "none" );
405         CheckDefault( "visible", "true" );
406         CheckDefault( "x", "0" );
407         CheckDefault( "y", "0" );
408         CheckDefault( "width", "0" );
409         CheckDefault( "height", "0" );
410         CheckDefault( "lefttop", "lefttop" );
411         CheckDefault( "rightbottom", "lefttop" );
412         CheckDefault( "help", "" );
413
414         const BuilderData::Video videoData( uniqueId( attr["id"] ),
415                 atoi( attr["x"] ) + m_xOffset, atoi( attr["y"] ) + m_yOffset,
416                 atoi( attr["width"] ), atoi( attr["height" ]),
417                 attr["lefttop"], attr["rightbottom"],
418                 attr["visible"], attr["help"], m_curLayer,
419                 m_curWindowId, m_curLayoutId );
420         m_curLayer++;
421         m_data.m_listVideo.push_back( videoData );
422     }
423
424     else if( rName == "Window" )
425     {
426         CheckDefault( "id", "none" );
427         CheckDefault( "visible", "true" );
428         CheckDefault( "x", "0" );
429         CheckDefault( "y", "0" );
430         CheckDefault( "dragdrop", "true" );
431         CheckDefault( "playondrop", "true" );
432
433         m_curWindowId = uniqueId( attr["id"] );
434         const BuilderData::Window window( m_curWindowId,
435                 atoi( attr["x"] ) + m_xOffset, atoi( attr["y"] ) + m_yOffset,
436                 convertBoolean( attr["visible"] ),
437                 convertBoolean( attr["dragdrop"] ),
438                 convertBoolean( attr["playondrop"] ) );
439         m_data.m_listWindow.push_back( window );
440     }
441 }
442
443
444 void SkinParser::handleEndElement( const string &rName )
445 {
446     if( rName == "Group" )
447     {
448         m_xOffset -= m_xOffsetList.back();
449         m_yOffset -= m_yOffsetList.back();
450         m_xOffsetList.pop_back();
451         m_yOffsetList.pop_back();
452     }
453
454     else if( rName == "Playlist" || rName == "Playtree" )
455     {
456         m_curListId = "";
457     }
458 }
459
460
461 bool SkinParser::convertBoolean( const char *value ) const
462 {
463     return strcmp( value, "true" ) == 0;
464 }
465
466
467 int SkinParser::convertColor( const char *transcolor ) const
468 {
469     unsigned long iRed, iGreen, iBlue;
470     iRed = iGreen = iBlue = 0;
471     sscanf( transcolor, "#%2lX%2lX%2lX", &iRed, &iGreen, &iBlue );
472     return ( iRed << 16 | iGreen << 8 | iBlue );
473 }
474
475
476 string SkinParser::convertFileName( const char *fileName ) const
477 {
478     return m_path + string( fileName );
479 }
480
481
482 int SkinParser::convertInRange( const char *value, int minValue, int maxValue,
483                                 const string &rAttribute ) const
484 {
485     int intValue = atoi( value );
486
487     if( intValue < minValue )
488     {
489         msg_Warn( getIntf(), "Value of \"%s\" attribute (%i) is out of the "
490                   "expected range [%i, %i], using %i instead",
491                   rAttribute.c_str(), intValue, minValue, maxValue, minValue );
492         return minValue;
493     }
494     else if( intValue > maxValue )
495     {
496         msg_Warn( getIntf(), "Value of \"%s\" attribute (%i) is out of the "
497                   "expected range [%i, %i], using %i instead",
498                   rAttribute.c_str(), intValue, minValue, maxValue, maxValue );
499         return maxValue;
500     }
501     else
502     {
503         return intValue;
504     }
505 }
506
507
508 const string SkinParser::generateId() const
509 {
510     static int i = 1;
511
512     char genId[5];
513     snprintf( genId, 4, "%i", i++ );
514
515     string base = "_ReservedId_" + (string)genId;
516
517     return base;
518 }
519
520
521 const string SkinParser::uniqueId( const string &id )
522 {
523     string newId;
524
525     if( m_idSet.find( id ) != m_idSet.end() )
526     {
527         // The id was already used
528         if( id != "none" )
529         {
530             msg_Warn( getIntf(), "Non unique id: %s", id.c_str() );
531         }
532         newId = generateId();
533     }
534     else
535     {
536         // OK, this is a new id
537         newId = id;
538     }
539
540     // Add the id to the set
541     m_idSet.insert( newId );
542
543     return newId;
544 }