Avoid reference to deprecated FromLocale() in comments ;)
[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         // The expected fileName must be an UTF-8 string
41         bool load( const string &fileName );
42
43     private:
44 #if defined( HAVE_ZLIB_H )
45         /// Extract files from an archive (handles tar.gz and zip)
46         /**
47          * Expects a string from the current locale.
48          */
49         bool extract( const string &fileName );
50
51         /// Extract files from a tar.gz archive
52         /**
53          * Expects strings from the current locale.
54          */
55         bool extractTarGz( const string &tarFile, const string &rootDir );
56
57         /// Extract files from a .zip archive
58         /**
59          * Expects strings from the current locale.
60          */
61         bool extractZip( const string &zipFile, const string &rootDir );
62
63         /// Extract the current file from a .zip archive
64         /**
65          * Expects a string from the current locale.
66          */
67         bool extractFileInZip( unzFile file, const string &rootDir );
68
69         /// Clean up the temporary files created by the extraction
70         /**
71          * Expects a string from the current locale.
72          */
73         void deleteTempFiles( const string &path );
74 #endif
75
76         /// Parse the XML file given as a parameter and build the skin
77         /**
78          * Expects UTF8 strings
79          */
80         bool parse( const string &path, const string &xmlFile );
81
82         /// Recursively look for the XML file from rootDir.
83         /**
84          * The first corresponding file found will be chosen and themeFilePath
85          * will be updated accordingly.
86          * The method returns true if a theme file was found, false otherwise.
87          * rootDir and rFilename must both be strings in the current locale,
88          * whereas themeFilePath will be in UTF8.
89          */
90         bool findFile( const string &rootDir, const string &rFileName,
91                        string &themeFilePath );
92
93         /// Get the base path of a file
94         string getFilePath( const string &rFullPath );
95
96         /// Replace '/' separators by the actual separator of the OS
97         string fixDirSeparators( const string &rPath );
98 };
99
100 #endif