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
|
/*
This file is part of kdepim.
Copyright (c) 2004 Cornelius Schumacher <schumacher@kde.org>
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 KODE_PRINTER_H
#define KODE_PRINTER_H
#include "code.h"
#include "file.h"
#include "style.h"
#include <kode_export.h>
namespace KODE {
/**
* This class prints the abstract class definitions
* as C++ code to a file.
*/
class KODE_EXPORT Printer
{
public:
/**
* Creates a new printer.
*/
Printer();
/**
* Creates a new printer from @param other.
*/
Printer(const Printer &other);
/**
* Creates a new printer, which uses the given @param style
* to format the C++ code.
*/
Printer(const Style &style);
/**
* Destroys the printer.
*/
virtual ~Printer();
/**
* Assignment operator.
*/
Printer &operator=(const Printer &other);
/**
* Sets whether the implementation shall contain a comment
* which warns about changing the C++ code manually.
*/
void setCreationWarning(bool value);
/**
* Sets the name of the @param generator which shall be
* included in the C++ code.
*/
void setGenerator(const QString &generator);
/**
* Sets the directory where the decleration and implementation
* files shall be stored. If now directory is set, the current
* working directory is used.
*/
void setOutputDirectory(const QString &outputDirectory);
/**
* Sets the name of the source file which is included in
* the generator statement.
*/
void setSourceFile(const QString &sourceFile);
/**
* Sets whether labels (public:, private: etc.) should define
* an indentation level. I.e. they are indented and then their
* contents are indented even more.
*/
void setLabelsDefineIndent(bool b);
/**
* Sets whether labels should be indented.
*
* setIndentLabels(true) + setLabelsDefineIndent(false) -> label at same level as contents
* setIndentLabels(false) + setLabelsDefineIndent(false) -> Qt coding style
* setIndentLabels(true) + setLabelsDefineIndent(true) -> kdepim coding style, default here.
* setIndentLabels(false) + setLabelsDefineIndent(true) -> doesn't really make sense.
*/
void setIndentLabels(bool b);
/**
* Prints the header of the class definitions in @param file.
*/
void printHeader(const File &file);
/**
* Prints the implementation of the class definitions in @param file.
*
* @param createHeaderInclude If true, the header for the declaration of
* this implementation is included.
*/
void printImplementation(const File &file, bool createHeaderInclude = true);
/**
* Prints a automake file as defined by @param autoMakefile.
*/
// void printAutoMakefile( const AutoMakefile &autoMakefile );
/**
* Returns the function signature for the given @param function
* with class name @param className.
*
* If @param forImplementation is true, the class qualifier
* is part of the signature as well, and default args are removed.
*/
QString functionSignature(const Function &function, const QString &className = QString(),
bool forImplementation = false);
/**
* For #undef hacks for instance
*/
void setStatementsAfterIncludes(const QStringList &statements);
protected:
/**
* Returns the creation warning.
*
* Reimplement this method to provide a custom warning.
*/
virtual QString creationWarning() const;
/**
* Returns the license header for the given @param file.
*
* Reimplement this method to provide a custom license
* header.
*/
virtual QString licenseHeader(const File &file) const;
private:
class Private;
Private *d;
};
}
#endif
|
