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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
/*******************************************************************************
* Copyright (c) 2014 Willink Transformations and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* E.D.Willink - initial API and implementation
*******************************************************************************/
package org.eclipse.ocl.examples.build.latex
import org.eclipse.ocl.pivot.Class
import org.eclipse.ocl.pivot.Element
import org.eclipse.ocl.pivot.Namespace
import org.eclipse.ocl.pivot.Package
import org.eclipse.xtext.AbstractElement
import org.eclipse.xtext.AbstractMetamodelDeclaration
import org.eclipse.xtext.Action
import org.eclipse.xtext.Alternatives
import org.eclipse.xtext.Assignment
import org.eclipse.xtext.CharacterRange
import org.eclipse.xtext.CrossReference
import org.eclipse.xtext.Grammar
import org.eclipse.xtext.Group
import org.eclipse.xtext.Keyword
import org.eclipse.xtext.NegatedToken
import org.eclipse.xtext.RuleCall
import org.eclipse.xtext.TypeRef
import org.eclipse.xtext.UntilToken
import org.eclipse.xtext.Wildcard
import org.eclipse.ocl.pivot.utilities.ClassUtil
import org.eclipse.ocl.pivot.utilities.NameUtil
class GenerateLaTeXForCSModelXtend extends GenerateLaTeXForCSModel
{
/*@NonNull*/ protected override String generateLaTeX(/*@NonNull*/ Package asPackage,
/*@NonNull*/ Grammar grammar, /*@Nullable*/ Package cs2asPackage,
/*@Nullable*/ Package cs2csPackage) {
'''
«emitClasses(asPackage, grammar, cs2asPackage, cs2csPackage)»
«emitExternalModels(grammar)»
«emitTerminalRules(grammar)»
'''
}
protected def String emitAbstractElement(/*@NonNull*/ AbstractElement abstractElement, boolean atRoot) {
switch abstractElement {
Action: return emitAction(abstractElement)
Alternatives: return emitAlternatives(abstractElement, atRoot)
Assignment: return emitAssignment(abstractElement)
CharacterRange: return emitCharacterRange(abstractElement)
CrossReference: return emitCrossReference(abstractElement)
Group: return emitGroup(abstractElement, atRoot)
Keyword: return emitKeyword(abstractElement)
NegatedToken: return '!' + emitAbstractElement(abstractElement.terminal, false) + emitCardinality(abstractElement)
RuleCall: return emitRuleRef(abstractElement.rule) + emitCardinality(abstractElement)
UntilToken: return '-> ' + emitAbstractElement(abstractElement.terminal, false)
Wildcard: return '.' + emitCardinality(abstractElement)
default: return "<<<" + abstractElement.eClass.name + ">>>"
}
}
protected def String emitAction(/*@NonNull*/ Action action) {
if (action.feature !== null) {
return "\n{" + emitTypeRef(action.type) + action.feature + action.operator + "current}";
}
else {
return ""; // "\n{" + emitTypeRef(action.type) + "}";
}
}
protected def String emitAlternatives(/*@NonNull*/ Alternatives alternatives, boolean atRoot) {
if (atRoot && (alternatives.cardinality === null)) {
'''«FOR element : alternatives.elements SEPARATOR '\n| '»«emitAbstractElement(element, false)»«ENDFOR»'''
}
else {
'''«FOR element : alternatives.elements BEFORE '(' SEPARATOR '\n| ' AFTER ')'»«emitAbstractElement(element, false)»«ENDFOR»«alternatives.cardinality»'''
}
}
protected def String emitAssignment(/*@NonNull*/ Assignment assignment) {
return assignment.feature + assignment.operator + emitAbstractElement(assignment.terminal, false) + emitCardinality(assignment) + "\n";
}
protected def emitAssociations(/*@NonNull*/ Class asClass) {
var asAssociations = getSortedAssociations(asClass);
if (asAssociations.size() > 0) {
'''
«emitHeading0a("Associations")»
«FOR asAssociation : asAssociations»
«emitHeading0b(prettyPrint(asAssociation, asClass))»
«emitComment(asAssociation, asClass)»
«ENDFOR»
'''
}
}
protected def emitAttributes(/*@NonNull*/ Class asClass) {
var asAttributes = getSortedAttributes(asClass);
if ( asAttributes.size() > 0) {
'''
«emitHeading0a("Attributes")»
«FOR asAttribute : asAttributes»
«emitHeading0b(prettyPrint(asAttribute, asClass))»
«emitComment(asAttribute, asClass)»
«ENDFOR»
'''
}
}
protected def emitCS2AS(/*@NonNull*/ Class asClass, /*@NonNull*/ Package cs2asPackage) {
var cs2asClass = NameUtil.getNameable(cs2asPackage.getOwnedClasses(), asClass.getName());
if (cs2asClass !== null) {
'''
«emitHeading0a("Abstract Syntax Synthesis")»
«FOR asOperation : ClassUtil.nonNullState(cs2asClass).getOwnedOperations()»
«emitHeading0b(prettyPrint(asOperation, cs2asClass))»
«emitComment(asOperation, asClass)»
«IF asOperation.bodyExpression !== null»
«emitAllTT((asOperation.bodyExpression.getBody().trim()).replace("\n", "\n "))»
«ENDIF»
«ENDFOR»
'''
}
}
protected def emitCS2CS(/*@NonNull*/ Class asClass, /*@NonNull*/ Package cs2asPackage) {
var cs2csClass = NameUtil.getNameable(cs2asPackage.getOwnedClasses(), asClass.getName());
if (cs2csClass !== null) {
'''
«emitHeading0a("Concrete Syntax Disambiguation")»
«FOR asOperation : ClassUtil.nonNullState(cs2csClass).getOwnedOperations()»
«emitHeading0b(prettyPrint(asOperation, cs2csClass))»
«emitComment(asOperation, asClass)»
«IF asOperation.bodyExpression !== null»
«emitAllTT((asOperation.bodyExpression.getBody().trim()).replace("\n", "\n "))»
«ENDIF»
«ENDFOR»
'''
}
}
protected def String emitCardinality(/*@NonNull*/ AbstractElement abstractElement) {
if (abstractElement.cardinality !== null) {
return abstractElement.cardinality;
}
else {
return "";
}
}
protected def String emitCharacterRange(/*@NonNull*/ CharacterRange characterRange) {
if (characterRange.cardinality === null) {
return emitKeyword(characterRange.left) + '..' + emitKeyword(characterRange.right)
}
else {
return "(" + emitKeyword(characterRange.left) + '..' + emitKeyword(characterRange.right) + ")" + characterRange.cardinality
}
}
protected def emitClasses(/*@NonNull*/ Package asPackage,
/*@NonNull*/ Grammar grammar, /*@Nullable*/ Package cs2asPackage,
/*@Nullable*/ Package cs2csPackage) {
var asClasses = getSortedClasses(asPackage);
'''
«FOR asClass : asClasses»
«emitHeading3(prettyPrint(asClass, asClass), null) + emitClassDef(asClass)»
«emitComment(asClass, asClass)»
«emitSuperclasses(asClass)»
«emitAttributes(asClass)»
«emitAssociations(asClass)»
«emitOperations(asClass)»
«emitParserRules(asClass, grammar)»
«IF cs2csPackage !== null»
«emitCS2CS(asClass, ClassUtil.nonNullState(cs2csPackage))»
«ENDIF»
«IF cs2asPackage !== null»
«emitCS2AS(asClass, ClassUtil.nonNullState(cs2asPackage))»
«ENDIF»
«ENDFOR»
'''
}
protected def emitComment(/*@NonNull*/ Element asElement, /*@NonNull*/ Namespace asNamespace) {
if (asElement.getOwnedComments().size() > 0) {
'''
«FOR asComment : asElement.getOwnedComments()»
«prettyPrint(asComment, asNamespace)»
«ENDFOR»
'''
}
}
protected def String emitCrossReference(/*@NonNull*/ CrossReference crossReference) {
return "[" + emitTypeRef(crossReference.type) + '|' + emitAbstractElement(crossReference.terminal, false) + "]" + emitCardinality(crossReference)
}
protected def String emitGroup(/*@NonNull*/ Group group, boolean atRoot) {
if (atRoot && (group.cardinality === null)) {
'''«FOR element : group.elements SEPARATOR ' '»«emitAbstractElement(element, false)»«ENDFOR»'''
}
else {
'''«FOR element : group.elements BEFORE '(' SEPARATOR ' ' AFTER ')'»«emitAbstractElement(element, false)»«ENDFOR»«group.cardinality»'''
}
}
protected def emitExternalModels(/*@NonNull*/ Grammar grammar) {
var metamodelDeclarations = getSortedMetamodelDeclarations(grammar);
'''
«emitHeading3("External Models", labelPrefix + "ExternalModels")»
The following aliases and metamodel URIs are used in the grammar.
«FOR metamodelDeclaration : metamodelDeclarations»
«emitMetamodelDeclaration(metamodelDeclaration)»
«ENDFOR»
'''
}
protected def String emitKeyword(/*@NonNull*/ Keyword keyword) {
return "'" + emitCharacters(keyword.value) + "'" + emitCardinality(keyword)
}
protected def emitMetamodelDeclaration(/*@NonNull*/ AbstractMetamodelDeclaration metamodelDeclaration) {
if (metamodelDeclaration.alias === null) {
return metamodelDeclaration.EPackage.nsURI + " (default)";
}
else {
return metamodelDeclaration.alias + " : " + metamodelDeclaration.EPackage.nsURI;
}
}
protected def emitOperations(/*@NonNull*/ Class asClass) {
var asOperations = getSortedOperations(asClass);
if (asOperations.size() > 0) {
'''
«emitHeading0a("Operations")»
«FOR asOperation : asOperations»
«emitHeading0b(prettyPrint(asOperation, asClass) /*+ (asOperation.isInvalidating ? " invalidating" : "") + (asOperation.isValidating ? " validating" : "")*/)»
«IF asOperation.precedence !== null»
precedence: «emitHeading0b(asOperation.precedence.name)»
«ENDIF»
«emitComment(asOperation, asClass)»
«FOR asConstraint : getSortedPreconditions(asOperation)»
«emitBeginDefinition»
«prettyPrint(asConstraint, asClass)»
«emitEndDefinition»
«ENDFOR»
«IF asOperation.bodyExpression !== null»
«emitBeginDefinition»
body: «asOperation.bodyExpression.getBody()»
«emitEndDefinition»
«ENDIF»
«FOR asConstraint : getSortedPostconditions(asOperation)»
«emitBeginDefinition»
«prettyPrint(asConstraint, asClass)»
«emitEndDefinition»
«ENDFOR»
«ENDFOR»
'''
}
}
/* protected def String emitParserRule(@NonNull org.eclipse.ocl.pivot.Class asClass, @NonNull Collection<ParserRule> parserRules) {
'''
«asClass.name» ::=
«FOR parserRule : parserRules BEFORE " " SEPARATOR "\n|"» «parserRule.name»«ENDFOR»
'''
} */
protected def emitParserRules(/*@NonNull*/ Grammar grammar) {
var parserRules = getSortedParserRules(grammar);
'''
«emitHeading3("Parser Rules", labelPrefix + "ParserRules")»
The parser rules define the parser mapping from parser tokens to generalized concrete syntax elements.
«FOR parserRule : parserRules»
«emitHeading4(parserRule.name, labelPrefix + "ParserRule:" + parserRule.name)»
«emitComment(parserRule)»
Token type: «emitTypeRef(parserRule.type)»
«emitAllTT(emitAbstractElement(parserRule.alternatives, true))»
«ENDFOR»
'''
}
protected def emitParserRules(/*@NonNull*/ Class asClass, /*@NonNull*/ Grammar grammar) {
var parserRules = getSortedParserRules(asClass, grammar);
if (parserRules.size() > 0) {
'''
«IF parserRules.size() > 1»
«emitHeading0a("Parser Rules")»
«ELSE»
«emitHeading0a("Parser Rule")»
«ENDIF»
«FOR parserRule : parserRules»
«IF parserRules.size() > 1»
«emitHeading0b(parserRule.name)»
«ENDIF»
«emitComment(parserRule)»
«emitAllTT((emitRuleDef(parserRule) + " ::=\n" + emitAbstractElement(parserRule.alternatives, true).trim()).replace("\n", "\n "))»
«ENDFOR»
'''
}
}
protected def emitSuperclasses(/*@NonNull*/ Class asClass) {
var asSuperClasses = asClass.getSuperClasses();
if (asSuperClasses.size() > 0) {
'''
«emitHeading0a("Superclasses")»
«FOR asSuperClass : asSuperClasses SEPARATOR ', '»«emitClassRef(asSuperClass)»«ENDFOR»
'''
}
}
protected def emitTerminalRules(/*@NonNull*/ Grammar grammar) {
var terminalRules = getSortedTerminalRules(grammar);
'''
«emitHeading3("Terminal Rules", labelPrefix + "TerminalRules")»
The terminal rules define the lexer mapping from character sequences to parser tokens.
«FOR terminalRule : terminalRules»
«emitHeading4(terminalRule.name, labelPrefix + "TerminalRule:" + terminalRule.name)»
«emitComment(terminalRule)»
Token type: «emitTypeRef(terminalRule.type)»
«emitAllTT(emitAbstractElement(terminalRule.alternatives, true))»
«ENDFOR»
'''
}
protected def emitTypeRef(/*@NonNull*/ TypeRef typeRef) {
if ((typeRef.metamodel.alias == "ecore") && (typeRef.classifier.name == "EString")) {
return "String";
}
else if ((typeRef.metamodel.alias == "ecore") && (typeRef.classifier.name == "EInt")) {
return "Integer";
}
else if (typeRef.metamodel.alias === null) {
return typeRef.classifier.name;
}
else {
return typeRef.metamodel.alias + "::" + typeRef.classifier.name;
}
}
}
|
