← Back to branch summary

~ubuntu-branches/ubuntu/wily/opencollada/wily-proposed

« back to all changes in this revision

Viewing changes to xsd2cppsax/src/de/netallied/xsd2cppsax/printers/AbstractParserImplementationPrinter.java

  • Committer: Package Import Robot
  • Author(s): Matteo F. Vescovi
  • Date: 2015-05-14 17:23:27 UTC
  • Revision ID: package-import@ubuntu.com-20150514172327-f862u8envms01fra
Tags: upstream-0.1.0~20140703.ddf8f47+dfsg1
Import upstream version 0.1.0~20140703.ddf8f47+dfsg1

Show diffs side-by-side

added added

removed removed

Lines of Context:
xsd2cppsax/src/de/netallied/xsd2cppsax/printers/AbstractParserImplementationPrinter.java
 
1
/**
 
2
 *   Copyright © 2008-2012 NetAllied Systems GmbH, Ravensburg, Germany. 
 
3
 *       
 
4
 *   Licensed under the MIT Open Source License, 
 
5
 *   for details please see LICENSE file or the website
 
6
 *   http://www.opensource.org/licenses/mit-license.php
 
7
*/
 
8
package de.netallied.xsd2cppsax.printers;
 
9
 
 
10
import java.io.PrintStream;
 
11
import java.util.ArrayList;
 
12
import java.util.List;
 
13
import java.util.Map;
 
14
import java.util.SortedMap;
 
15
 
 
16
import org.apache.xerces.xs.XSElementDeclaration;
 
17
 
 
18
import de.netallied.xsd2cppsax.Config;
 
19
import de.netallied.xsd2cppsax.IGenerationDataProvider;
 
20
 
 
21
/**
 
22
 * Abstract base class which prints an implementation of the generated parser.
 
23
 * 
 
24
 */
 
25
public abstract class AbstractParserImplementationPrinter implements ICodePrinter {
 
26
 
 
27
    /** {@link IGenerationDataProvider} */
 
28
    private IGenerationDataProvider dataProvider;
 
29
 
 
30
    /**
 
31
     * C-tor.
 
32
     * 
 
33
     */
 
34
    public AbstractParserImplementationPrinter(IGenerationDataProvider dataProvider) {
 
35
        this.dataProvider = dataProvider;
 
36
    }
 
37
 
 
38
    /**
 
39
     * @return List of additional base classes of printed parser.
 
40
     */
 
41
    protected abstract List<String> getAdditionalBaseClasses();
 
42
 
 
43
    /**
 
44
     * @return Class name of printed parser.
 
45
     */
 
46
    protected abstract String getClassName();
 
47
 
 
48
    /**
 
49
     * @return Configuration.
 
50
     */
 
51
    public Config getConfig() {
 
52
        return dataProvider.getConfig();
 
53
    }
 
54
 
 
55
    /**
 
56
     * @return Parameters for constructor.
 
57
     */
 
58
    abstract protected String getCtorParas();
 
59
 
 
60
    /**
 
61
     * @return Code template for C++ constructor.
 
62
     */
 
63
    abstract protected String getCtorTmpl();
 
64
 
 
65
    /**
 
66
     * @return Code template for C++ destructor.
 
67
     */
 
68
    abstract protected String getDtorTmpl();
 
69
 
 
70
    /**
 
71
     * {@inheritDoc}
 
72
     * 
 
73
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#getGenerationDataProvider()
 
74
     */
 
75
    public IGenerationDataProvider getGenerationDataProvider() {
 
76
        return dataProvider;
 
77
    }
 
78
 
 
79
    /**
 
80
     * @return C++ header file to print to.
 
81
     */
 
82
    protected abstract PrintStream getHeaderFile();
 
83
 
 
84
    /**
 
85
     * @return C++ header file name. For include in cpp file.
 
86
     */
 
87
    protected abstract String getHeaderFileName();
 
88
 
 
89
    /**
 
90
     * @return List of include files printed parser requires.
 
91
     */
 
92
    protected abstract List<String> getIncludeFiles();
 
93
 
 
94
    /**
 
95
     * @return C++ c-tor initialization list.
 
96
     */
 
97
    abstract protected List<String> getInitializationList();
 
98
 
 
99
    /**
 
100
     * @return A map of class member. Key is member name, value is member type.
 
101
     */
 
102
    abstract protected SortedMap<String, String> getMembers();
 
103
 
 
104
    /**
 
105
     * @return C++ namespace of printed parser.
 
106
     */
 
107
    protected abstract String getNamespace();
 
108
 
 
109
    /**
 
110
     * @return C++ source file to print to.
 
111
     */
 
112
    protected abstract PrintStream getSourceFile();
 
113
 
 
114
    /**
 
115
     * Prints implementation of SAX begin element method. Method head is printed
 
116
     * before.
 
117
     * 
 
118
     * @param methodName
 
119
     *            C++ method name.
 
120
     * @param parameterList
 
121
     *            C++ method parameters.
 
122
     * @param cppElementName
 
123
     *            C++ name of element.
 
124
     * @param element
 
125
     *            XSD element.
 
126
     * @param attributesRequired
 
127
     *            Indicates if element has attributes.
 
128
     */
 
129
    protected abstract void printBeginMethodImpl(String methodName, String parameterList, String cppElementName,
 
130
            XSElementDeclaration element, boolean attributesRequired);
 
131
 
 
132
    /**
 
133
     * {@inheritDoc}
 
134
     * 
 
135
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printBeginMethodToHeader(java.lang.String,
 
136
     *      java.lang.String, java.lang.String,
 
137
     *      com.sun.org.apache.xerces.internal.xs.XSElementDeclaration, boolean)
 
138
     */
 
139
    public void printBeginMethodToHeader(String methodName, String parameterList, String cppElementName,
 
140
            XSElementDeclaration element, boolean attributesRequired) {
 
141
        PrinterUtils.printBeginConvenienceMethodDeclTypeModifiers(getHeaderFile());
 
142
        getHeaderFile().print(" ");
 
143
        PrinterUtils.printBeginConvenienceMethodReturnType(getHeaderFile());
 
144
        getHeaderFile().print(" ");
 
145
        getHeaderFile().print(methodName);
 
146
        getHeaderFile().print(parameterList);
 
147
        getHeaderFile().println(";");
 
148
    }
 
149
 
 
150
    /**
 
151
     * {@inheritDoc}
 
152
     * 
 
153
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printBeginMethodToSource(java.lang.String,
 
154
     *      java.lang.String, java.lang.String,
 
155
     *      com.sun.org.apache.xerces.internal.xs.XSElementDeclaration, boolean)
 
156
     */
 
157
    public void printBeginMethodToSource(String methodName, String parameterList, String cppElementName,
 
158
            XSElementDeclaration element, boolean attributesRequired) {
 
159
        getSourceFile().println(getConfig().getOutputSourceFileMethodDelimiter());
 
160
        PrinterUtils.printBeginConvenienceMethodReturnType(getSourceFile());
 
161
        getSourceFile().print(" ");
 
162
        getSourceFile().print(getClassName() + "::");
 
163
        getSourceFile().print(methodName);
 
164
        getSourceFile().println(parameterList);
 
165
 
 
166
        printBeginMethodImpl(methodName, parameterList, cppElementName, element, attributesRequired);
 
167
 
 
168
        getSourceFile().println();
 
169
        getSourceFile().println();
 
170
    }
 
171
 
 
172
    /**
 
173
     * Prints implementation of SAX data method. Method head is printed before.
 
174
     * 
 
175
     * @param methodName
 
176
     *            C++ method name.
 
177
     * @param parameterList
 
178
     *            C++ method parameters.
 
179
     * @param cppElementName
 
180
     *            C++ name of element.
 
181
     * @param element
 
182
     *            XSD element.
 
183
     */
 
184
    protected abstract void printDataMethodImpl(String methodName, String parameterList, String cppElementName,
 
185
            XSElementDeclaration element);
 
186
 
 
187
    /**
 
188
     * {@inheritDoc}
 
189
     * 
 
190
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printDataMethodToHeader(java.lang.String,
 
191
     *      java.lang.String, java.lang.String,
 
192
     *      com.sun.org.apache.xerces.internal.xs.XSElementDeclaration)
 
193
     */
 
194
    public void printDataMethodToHeader(String methodName, String parameterList, String cppElementName,
 
195
            XSElementDeclaration element) {
 
196
        PrinterUtils.printDataConvenienceMethodDeclTypeModifiers(getHeaderFile());
 
197
        getHeaderFile().print(" ");
 
198
        PrinterUtils.printDataConvenienceMethodReturnType(getHeaderFile());
 
199
        getHeaderFile().print(" ");
 
200
        getHeaderFile().print(methodName);
 
201
        getHeaderFile().print(parameterList);
 
202
        getHeaderFile().println(";");
 
203
    }
 
204
 
 
205
    /**
 
206
     * {@inheritDoc}
 
207
     * 
 
208
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printDataMethodToSource(java.lang.String,
 
209
     *      java.lang.String, java.lang.String,
 
210
     *      com.sun.org.apache.xerces.internal.xs.XSElementDeclaration)
 
211
     */
 
212
    public void printDataMethodToSource(String methodName, String parameterList, String cppElementName,
 
213
            XSElementDeclaration element) {
 
214
        getSourceFile().println(getConfig().getOutputSourceFileMethodDelimiter());
 
215
        PrinterUtils.printDataConvenienceMethodReturnType(getSourceFile());
 
216
        getSourceFile().print(" ");
 
217
        getSourceFile().print(getClassName() + "::");
 
218
        getSourceFile().print(methodName);
 
219
        getSourceFile().println(parameterList);
 
220
 
 
221
        printDataMethodImpl(methodName, parameterList, cppElementName, element);
 
222
 
 
223
        getSourceFile().println();
 
224
        getSourceFile().println();
 
225
    }
 
226
 
 
227
    /**
 
228
     * Prints implementation of SAX end element method. Method head is printed
 
229
     * before.
 
230
     * 
 
231
     * @param methodName
 
232
     *            C++ method name.
 
233
     * @param parameterList
 
234
     *            C++ method parameters.
 
235
     * @param cppElementName
 
236
     *            C++ name of element.
 
237
     * @param element
 
238
     *            XSD element.
 
239
     */
 
240
    protected abstract void printEndMethodImpl(String methodName, String parameterList, String cppElementName,
 
241
            XSElementDeclaration element);
 
242
 
 
243
    /**
 
244
     * {@inheritDoc}
 
245
     * 
 
246
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printEndMethodToHeader(java.lang.String,
 
247
     *      java.lang.String, java.lang.String,
 
248
     *      com.sun.org.apache.xerces.internal.xs.XSElementDeclaration)
 
249
     */
 
250
    public void printEndMethodToHeader(String methodName, String parameterList, String cppElementName,
 
251
            XSElementDeclaration element) {
 
252
        PrinterUtils.printEndMethodDeclTypeModifiers(getHeaderFile());
 
253
        getHeaderFile().print(" ");
 
254
        PrinterUtils.printEndMethodReturnType(getHeaderFile());
 
255
        getHeaderFile().print(" ");
 
256
        getHeaderFile().print(methodName);
 
257
        getHeaderFile().print(parameterList);
 
258
        getHeaderFile().println(";");
 
259
    }
 
260
 
 
261
    /**
 
262
     * {@inheritDoc}
 
263
     * 
 
264
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printEndMethodToSource(java.lang.String,
 
265
     *      java.lang.String, java.lang.String,
 
266
     *      com.sun.org.apache.xerces.internal.xs.XSElementDeclaration)
 
267
     */
 
268
    public void printEndMethodToSource(String methodName, String parameterList, String cppElementName,
 
269
            XSElementDeclaration element) {
 
270
        getSourceFile().println(getConfig().getOutputSourceFileMethodDelimiter());
 
271
        PrinterUtils.printEndMethodReturnType(getSourceFile());
 
272
        getSourceFile().print(" ");
 
273
        getSourceFile().print(getClassName() + "::");
 
274
        getSourceFile().print(methodName);
 
275
        getSourceFile().println(parameterList);
 
276
 
 
277
        printEndMethodImpl(methodName, parameterList, cppElementName, element);
 
278
 
 
279
        getSourceFile().println();
 
280
        getSourceFile().println();
 
281
    }
 
282
 
 
283
    /**
 
284
     * {@inheritDoc}
 
285
     * 
 
286
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printHeaderFileBeginning()
 
287
     */
 
288
    public void printHeaderFileBeginning() {
 
289
        getHeaderFile().println(getConfig().getOutFileHeader());
 
290
        getHeaderFile().println();
 
291
        getHeaderFile().println();
 
292
        String namespace = getNamespace();
 
293
        String className = getClassName();
 
294
        PrinterUtils.printIncludeProtection(getHeaderFile(), PrinterUtils.createIncludeProtectionMacro(namespace,
 
295
                className));
 
296
        getHeaderFile().println();
 
297
        getHeaderFile().println();
 
298
        PrinterUtils.printIncludeGeneratedHeader(getHeaderFile(), getConfig().getOutputAttributesFileName());
 
299
        PrinterUtils.printIncludeGeneratedHeader(getHeaderFile(), getConfig().getOutputHeaderFileNamePublic());
 
300
        PrinterUtils.printIncludes(getHeaderFile(), getIncludeFiles());
 
301
        getHeaderFile().println();
 
302
        getHeaderFile().println();
 
303
 
 
304
        getHeaderFile().println("using namespace " + getConfig().getNamespace() + ";");
 
305
        getHeaderFile().println();
 
306
        getHeaderFile().println();
 
307
 
 
308
        PrinterUtils.printNamespaceOpen(getHeaderFile(), namespace);
 
309
        getHeaderFile().println();
 
310
 
 
311
        PrinterUtils.printConvenienceTypedefs(getHeaderFile(), false, getConfig());
 
312
        getHeaderFile().println();
 
313
        getHeaderFile().println();
 
314
 
 
315
        getHeaderFile().print("class " + className);
 
316
        getHeaderFile().print(" : public " + getConfig().getNamespace() + "::" + getConfig().getClassNamePublic());
 
317
        List<String> baseClasses = getAdditionalBaseClasses();
 
318
        if (baseClasses != null) {
 
319
            for (String baseClass : baseClasses) {
 
320
                getHeaderFile().print(", " + baseClass);
 
321
            }
 
322
        }
 
323
        getHeaderFile().println();
 
324
        getHeaderFile().println("{");
 
325
 
 
326
        getHeaderFile().println("public:");
 
327
        PrinterUtils.printCtorDtorHeaderDecl(getHeaderFile(), className, false, false, getCtorParas(), getConfig());
 
328
        getHeaderFile().println();
 
329
        getHeaderFile().println();
 
330
 
 
331
    }
 
332
 
 
333
    /**
 
334
     * {@inheritDoc}
 
335
     * 
 
336
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printHeaderFileEnd()
 
337
     */
 
338
    public void printHeaderFileEnd() {
 
339
        getHeaderFile().println();
 
340
        getHeaderFile().println();
 
341
        getHeaderFile().println("private:");
 
342
        PrinterUtils.printDisableDefaultMethods(getHeaderFile(), getClassName());
 
343
        getHeaderFile().println();
 
344
 
 
345
        SortedMap<String, String> members = getMembers();
 
346
        for (Map.Entry<String, String> entry : members.entrySet()) {
 
347
            getHeaderFile().print(entry.getValue() + " ");
 
348
            getHeaderFile().println(entry.getKey() + ";");
 
349
        }
 
350
        getHeaderFile().println();
 
351
 
 
352
        getHeaderFile().println("};");
 
353
 
 
354
        getHeaderFile().println();
 
355
        PrinterUtils.printNamespaceClose(getHeaderFile(), getConfig());
 
356
 
 
357
        getHeaderFile().println("#endif");
 
358
    }
 
359
 
 
360
    /**
 
361
     * {@inheritDoc}
 
362
     * 
 
363
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printNewLine()
 
364
     */
 
365
    public void printNewLine() {
 
366
        getHeaderFile().println();
 
367
    }
 
368
 
 
369
    /**
 
370
     * {@inheritDoc}
 
371
     * 
 
372
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printSourceFileBeginning()
 
373
     *      )
 
374
     */
 
375
    public void printSourceFileBeginning() {
 
376
        getSourceFile().println(getConfig().getOutFileHeader());
 
377
        List<String> exampleSourceIncludeList = new ArrayList<String>();
 
378
        exampleSourceIncludeList.add(getConfig().getIncludePrecompiledHeader());
 
379
        String header = getHeaderFileName();
 
380
        exampleSourceIncludeList.add(header.substring(header.lastIndexOf('/') + 1));
 
381
        PrinterUtils.printIncludes(getSourceFile(), exampleSourceIncludeList);
 
382
        getSourceFile().println();
 
383
        getSourceFile().println();
 
384
        PrinterUtils.printNamespaceOpen(getSourceFile(), getNamespace());
 
385
        getSourceFile().println();
 
386
        getSourceFile().println();
 
387
        IGenerationDataProvider dataProvoider = getGenerationDataProvider();
 
388
        PrinterUtils.printCtorDtorImpl(getSourceFile(), getClassName(), getConfig().getNamespace() + "::"
 
389
                + getConfig().getClassNamePrivate(), false, false, dataProvoider, getCtorParas(),
 
390
                getInitializationList(), getCtorTmpl(), getDtorTmpl());
 
391
        getSourceFile().println();
 
392
    }
 
393
 
 
394
    /**
 
395
     * {@inheritDoc}
 
396
     * 
 
397
     * @see de.netallied.xsd2cppsax.printers.ICodePrinter#printSourceFileEnd()
 
398
     */
 
399
    public void printSourceFileEnd() {
 
400
        getSourceFile().println();
 
401
        getSourceFile().println();
 
402
        getSourceFile().println();
 
403
        PrinterUtils.printNamespaceClose(getSourceFile(), getConfig());
 
404
    }
 
405
}