1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
#pragma once
/*
* Copyright (C) 2005-2013 Team XBMC
* http://xbmc.org
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This Program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with XBMC; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#include <vector>
#include "Addon.h"
#include "guilib/GraphicContext.h" // needed for the RESOLUTION members
#include "guilib/GUIIncludes.h" // needed for the GUIInclude member
#define CREDIT_LINE_LENGTH 50
class CSetting;
namespace ADDON
{
class CSkinInfo : public CAddon
{
public:
class CStartupWindow
{
public:
CStartupWindow(int id, const std::string &name):
m_id(id), m_name(name)
{
};
int m_id;
std::string m_name;
};
//FIXME remove this, kept for current repo handling
CSkinInfo(const AddonProps &props, const RESOLUTION_INFO &res = RESOLUTION_INFO());
CSkinInfo(const cp_extension_t *ext);
virtual ~CSkinInfo();
virtual AddonPtr Clone() const;
/*! \brief Load resultion information from directories in Path().
*/
void Start();
bool HasSkinFile(const std::string &strFile) const;
/*! \brief Get the full path to the specified file in the skin
We search for XML files in the skin folder that best matches the current resolution.
\param file XML file to look for
\param res [out] If non-NULL, the resolution that the returned XML file is in is returned. Defaults to NULL.
\param baseDir [in] If non-empty, the given directory is searched instead of the skin's directory. Defaults to empty.
\return path to the XML file
*/
std::string GetSkinPath(const std::string& file, RESOLUTION_INFO *res = NULL, const std::string& baseDir = "") const;
AddonVersion APIVersion() const { return m_version; };
/*! \brief Return whether skin debugging is enabled
\return true if skin debugging (set via <debugging>true</debugging> in skin.xml) is enabled.
*/
bool IsDebugging() const { return m_debugging; };
/*! \brief Get the id of the first window to load
The first window is generally Startup.xml unless it doesn't exist or if the skinner
has specified which start windows they support and the user is going to somewhere other
than the home screen.
\return id of the first window to load
*/
int GetFirstWindow() const;
/*! \brief Get the id of the window the user wants to start in after any skin animation
\return id of the start window
*/
int GetStartWindow() const;
/*! \brief Translate a resolution string
\param name the string to translate
\param res [out] the resolution structure if name is valid
\return true if the resolution is valid, false otherwise
*/
static bool TranslateResolution(const std::string &name, RESOLUTION_INFO &res);
void ResolveIncludes(TiXmlElement *node, std::map<INFO::InfoPtr, bool>* xmlIncludeConditions = NULL);
float GetEffectsSlowdown() const { return m_effectsSlowDown; };
const std::vector<CStartupWindow> &GetStartupWindows() const { return m_startupWindows; };
/*! \brief Retrieve the skin paths to search for skin XML files
\param paths [out] vector of paths to search, in order.
*/
void GetSkinPaths(std::vector<std::string> &paths) const;
bool IsInUse() const;
const std::string& GetCurrentAspect() const { return m_currentAspect; }
void LoadIncludes();
const INFO::CSkinVariableString* CreateSkinVariable(const std::string& name, int context);
static void SettingOptionsSkinColorsFiller(const CSetting *setting, std::vector< std::pair<std::string, std::string> > &list, std::string ¤t, void *data);
static void SettingOptionsSkinFontsFiller(const CSetting *setting, std::vector< std::pair<std::string, std::string> > &list, std::string ¤t, void *data);
static void SettingOptionsSkinSoundFiller(const CSetting *setting, std::vector< std::pair<std::string, std::string> > &list, std::string ¤t, void *data);
static void SettingOptionsSkinThemesFiller(const CSetting *setting, std::vector< std::pair<std::string, std::string> > &list, std::string ¤t, void *data);
static void SettingOptionsStartupWindowsFiller(const CSetting *setting, std::vector< std::pair<std::string, int> > &list, int ¤t, void *data);
virtual bool OnPreInstall();
virtual void OnPostInstall(bool restart, bool update, bool modal);
protected:
/*! \brief Given a resolution, retrieve the corresponding directory name
\param res RESOLUTION to translate
\return directory name for res
*/
std::string GetDirFromRes(RESOLUTION res) const;
/*! \brief grab a resolution tag from a skin's configuration data
\param props passed addoninfo structure to check for resolution
\param tag name of the tag to look for
\param res resolution to return
\return true if we find a valid resolution, false otherwise
*/
void GetDefaultResolution(const cp_extension_t *ext, const char *tag, RESOLUTION &res, const RESOLUTION &def) const;
bool LoadStartupWindows(const cp_extension_t *ext);
RESOLUTION_INFO m_defaultRes;
std::vector<RESOLUTION_INFO> m_resolutions;
AddonVersion m_version;
float m_effectsSlowDown;
CGUIIncludes m_includes;
std::string m_currentAspect;
std::vector<CStartupWindow> m_startupWindows;
bool m_debugging;
};
} /*namespace ADDON*/
extern std::shared_ptr<ADDON::CSkinInfo> g_SkinInfo;
|
