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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/* This file is part of KDevelop
Copyright 2012 Miha Čančula <miha@noughmad.eu>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KDEVPLATFORM_TEMPLATECLASSGENERATOR_H
#define KDEVPLATFORM_TEMPLATECLASSGENERATOR_H
#include <QHash>
#include <QVariantHash>
#include <language/languageexport.h>
#include <language/duchain/duchainpointer.h>
class QUrl;
namespace KTextEditor {
class Cursor;
}
namespace KDevelop {
struct ClassDescription;
class TemplateRenderer;
class SourceFileTemplate;
class DocumentChangeSet;
class TemplateClassGeneratorPrivate;
/**
* Generates new classes from templates
*
*
* @section Variables Variables Passed to Templates
*
* TemplateClassGenerator makes use of the ClassDescription returned by ClassGenerator::description().
* From this description, it constructs the following variables:
* @li @c description (ClassDescription) - the class description
* @li @c name (QString) - the class name, same as @c description.name
* @li @c namespaces (QStringList) - the list of nested namespaces in which the class will be declared
* @li @c identifier (QString) - the full class identifier, composed of namespaces and name
* @li @c members (VariableDescriptionList) - data members, same as @c description.members
* @li @c functions (FunctionDescriptionList) - function members, same as @c description.methods
* @li @c base_classes (InheritanceDescriptionList) - directly inherited classes, same as @c description.baseClasses
* @li @c license (QString) - the license for this class, including author copyright, without comment characters or indentation. It is recommended to use the "lines_prepend" filters from library "kdev_filters" to format it.
*
* For each output file, TemplateRenderer add two variables named @c output_file_x
* and @c output_file_x_absolute, where @c x is replaced
* with the file name specified in the template description file.
* See TemplateRenderer::renderFileTemplate() for details.
*
* If the templates uses custom options, these options are added to the template variables. Their names match the
* names specified in the options file, and their values to the values entered by the user.
*
* Subclasses can override templateVariables() and insert additional variables.
*
**/
class KDEVPLATFORMLANGUAGE_EXPORT TemplateClassGenerator
{
public:
using UrlHash = QHash<QString, QUrl>;
/**
* Creates a new generator.
*
* You should call setTemplateDescription() before any other template-related functions.
*
* @param baseUrl the folder where new files will be created
**/
explicit TemplateClassGenerator(const QUrl& baseUrl);
virtual ~TemplateClassGenerator();
/**
* @brief Selects the template to be used
*
* This function must be called before using any other functions.
*
* The passed @p templateDescription should be an absolute path to a template description (.desktop) file.
* TemplateClassGenerator will attempt to find a template archive with a matching name.
*
* @param templateDescription the template description file
**/
void setTemplateDescription(const SourceFileTemplate& templateDescription);
/**
* Set the name (without namespace) for this class
*/
void setName(const QString&);
/**
* \return The name of the class to generate (excluding namespaces)
*/
QString name() const;
/**
* \param identifier The Qualified identifier that the class will have
*/
virtual void setIdentifier(const QString& identifier);
/**
* \return The Identifier of the class to generate (including all used namespaces)
*/
virtual QString identifier() const;
/**
* \param namespaces The list of nested namespaces in which this class is to be declared
*/
virtual void setNamespaces(const QStringList& namespaces);
/**
* \return The list of nested namespace in which this class will be declared
*/
virtual QStringList namespaces() const;
void addBaseClass(const QString& base);
void setBaseClasses(const QList<QString>& bases);
QList<DeclarationPointer> directBaseClasses() const;
QList<DeclarationPointer> allBaseClasses() const;
void setLicense(const QString& license);
QString license() const;
void setDescription(const ClassDescription& description);
ClassDescription description() const;
virtual DocumentChangeSet generate();
QHash<QString, QString> fileLabels() const;
QUrl baseUrl() const;
UrlHash fileUrls() const;
void setFileUrl(const QString& outputFile, const QUrl& url);
QUrl fileUrl(const QString& outputFile) const;
void setFilePosition(const QString& outputFile, const KTextEditor::Cursor& position);
KTextEditor::Cursor filePosition(const QString& outputFile) const;
SourceFileTemplate sourceFileTemplate() const;
/**
* Adds variables @p variables to the context passed to all template files.
*
* The variable values must be of a type registered with Grantlee::registerMetaType()
*
* @param variables additional variables to be passed to all templates
**/
void addVariables(const QVariantHash& variables);
/**
* Convenience function to render a string @p text as a Grantlee template
**/
QString renderString(const QString& text) const;
/**
* The template renderer used to render all the templates for this class.
*
* This function is useful if you want a rendeder with all current template variables.
*/
TemplateRenderer* renderer() const;
private:
const QScopedPointer<class TemplateClassGeneratorPrivate> d_ptr;
Q_DECLARE_PRIVATE(TemplateClassGenerator)
};
}
#endif // KDEVPLATFORM_TEMPLATECLASSGENERATOR_H
|
