forked from bruderstein/nppPluginManager
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPlugin.h
More file actions
155 lines (129 loc) · 5.47 KB
/
Plugin.h
File metadata and controls
155 lines (129 loc) · 5.47 KB
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
/*
This file is part of Plugin Manager Plugin for Notepad++
Copyright (C)2009-2010 Dave Brotherstone <davegb@pobox.com>
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
of the License, 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 this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef _PLUGIN_H
#define _PLUGIN_H
#include "tinyxml/tinyxml.h"
#include "PluginVersion.h"
#include "libinstall/InstallStep.h"
class VariableHandler;
class ModuleInfo;
enum InstallStatus {
INSTALL_SUCCESS,
INSTALL_NEEDRESTART,
INSTALL_FAIL
};
class Plugin
{
public:
Plugin(void);
~Plugin(void);
/* Setters */
void setName (const TCHAR* name);
void setName (const tstring& name);
void setVersion (const PluginVersion &version);
void setDescription (const TCHAR* description);
void setFilename (const TCHAR* filename);
void setFilename (const tstring& filename);
void setInstalledVersion(const PluginVersion &version);
void setInstalledVersionFromHash(const tstring &hash);
void setAuthor(const TCHAR* author);
void setHomepage(const TCHAR* homepage);
void setSourceUrl(const TCHAR* sourceUrl);
void setCategory(const TCHAR* category);
void setLatestUpdate(const TCHAR* latestUpdate);
void setStability(const TCHAR* stability);
void setInstalledForAllUsers(BOOL installedForAllUsers);
void setIsLibrary(BOOL isLibrary) { _isLibrary = isLibrary; }
/* Getters */
tstring& getName();
PluginVersion& getVersion();
tstring& getDescription();
tstring& getFilename();
PluginVersion& getInstalledVersion();
tstring& getAuthor();
tstring& getCategory();
tstring& getLatestUpdate();
tstring& getStability();
tstring& getUpdateDescription();
BOOL getInstalledForAllUsers();
BOOL getIsLibrary() { return _isLibrary; }
/* General methods */
BOOL isInstalled();
void addVersion(const TCHAR* hash, const PluginVersion &version);
void addBadVersion(const PluginVersion &version, const TCHAR* report);
/* installation */
void addInstallStep(std::shared_ptr<InstallStep> step);
size_t getInstallStepCount();
InstallStatus install(tstring& basePath, TiXmlElement* forGpup,
std::function<void(const TCHAR*)> setStatus,
std::function<void(const int)> stepProgress,
std::function<void()> stepComplete,
const ModuleInfo* moduleInfo,
VariableHandler* variableHandler,
CancelToken& cancelToken);
/* removal */
size_t getRemoveStepCount();
void addRemoveStep(std::shared_ptr<InstallStep> step);
InstallStatus remove(tstring& basePath, TiXmlElement* forGpup,
std::function<void(const TCHAR*)> setStatus,
std::function<void(const int)> stepProgress,
std::function<void()> stepComplete,
const ModuleInfo* moduleInfo,
VariableHandler* variableHandler,
CancelToken& cancelToken);
/* dependencies */
void addDependency(const TCHAR* pluginName);
BOOL hasDependencies();
const std::list<tstring>& getDependencies();
private:
tstring _name;
tstring _unicodeUrl;
tstring _ansiUrl;
PluginVersion _version;
tstring _description;
tstring _filename;
PluginVersion _installedVersion;
tstring _author;
tstring _category;
tstring _homepage;
tstring _sourceUrl;
tstring _latestUpdate;
tstring _stability;
tstring _updateDescription;
BOOL _isInstalled;
BOOL _detailsAdded;
BOOL _updateDetailsAdded;
BOOL _installedForAllUsers;
BOOL _isLibrary;
/* Dependencies on other plugins */
std::list<tstring> _dependencies;
std::map<tstring, PluginVersion> _versionMap;
std::map<PluginVersion, tstring> _badVersionMap;
typedef std::list<std::shared_ptr<InstallStep> > InstallStepContainer;
InstallStepContainer _installSteps;
InstallStepContainer _removeSteps;
/* Private methods */
void replaceNewlines(tstring &str);
/* Step Runner for install/remove */
InstallStatus runSteps(InstallStepContainer steps, tstring& basePath, TiXmlElement* forGpup,
std::function<void(const TCHAR*)> setStatus,
std::function<void(const int)> stepProgress,
std::function<void()> stepComplete,
const ModuleInfo* moduleInfo,
VariableHandler* variableHandler,
CancelToken& cancelToken);
};
#endif