ea001984c1ecfbde8f364c70196d33b35216b05f
[vlc.git] / modules / gui / skins2 / src / theme_loader.hpp
1 /*****************************************************************************
2  * theme_loader.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
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #ifndef THEME_LOADER_HPP
26 #define THEME_LOADER_HPP
27
28 #include "skin_common.hpp"
29 #include <string>
30 #if defined( HAVE_ZLIB_H )
31 #   include "../unzip/unzip.h"
32 #endif
33
34 class ThemeLoader: public SkinObject
35 {
36     public:
37         ThemeLoader( intf_thread_t *pIntf ): SkinObject( pIntf ) {}
38         virtual ~ThemeLoader() {}
39
40         /**
41          * The expected fileName must be an UTF-8 string (usually the result of
42          * a call to FromLocale())
43          */
44         bool load( const string &fileName );
45
46     private:
47 #if defined( HAVE_ZLIB_H )
48         /// Extract files from an archive (handles tar.gz and zip)
49         /**
50          * Expects a string from the current locale.
51          */
52         bool extract( const string &fileName );
53
54         /// Extract files from a tar.gz archive
55         /**
56          * Expects strings from the current locale.
57          */
58         bool extractTarGz( const string &tarFile, const string &rootDir );
59
60         /// Extract files from a .zip archive
61         /**
62          * Expects strings from the current locale.
63          */
64         bool extractZip( const string &zipFile, const string &rootDir );
65
66         /// Extract the current file from a .zip archive
67         /**
68          * Expects a string from the current locale.
69          */
70         bool extractFileInZip( unzFile file, const string &rootDir );
71
72         /// Clean up the temporary files created by the extraction
73         /**
74          * Expects a string from the current locale.
75          */
76         void deleteTempFiles( const string &path );
77 #endif
78
79         /// Parse the XML file given as a parameter and build the skin
80         /**
81          * Expects UTF8 strings
82          */
83         bool parse( const string &path, const string &xmlFile );
84
85         /// Recursively look for the XML file from rootDir.
86         /**
87          * The first corresponding file found will be chosen and themeFilePath
88          * will be updated accordingly.
89          * The method returns true if a theme file was found, false otherwise.
90          * rootDir and rFilename must both be strings in the current locale,
91          * whereas themeFilePath will be in UTF8.
92          */
93         bool findFile( const string &rootDir, const string &rFileName,
94                        string &themeFilePath );
95
96         /// Get the base path of a file
97         string getFilePath( const string &rFullPath );
98
99         /// Replace '/' separators by the actual separator of the OS
100         string fixDirSeparators( const string &rPath );
101 };
102
103 #endif