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
|
/*******************************************************************************
* Copyright (c) 2011 protos software gmbh (http://www.protos.de).
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* CONTRIBUTORS:
* Thomas Jung, Thomas Schuetz (initial contribution)
*
*******************************************************************************/
package org.eclipse.etrice.generator.doc.gen
import com.google.inject.Inject
import com.google.inject.Singleton
import java.util.List
import java.io.File
import org.eclipse.etrice.core.room.RoomModel
import org.eclipse.etrice.core.room.Documentation
import org.eclipse.etrice.core.room.ActorClass
import org.eclipse.etrice.core.room.ProtocolClass
import org.eclipse.etrice.core.room.DataClass
import org.eclipse.etrice.core.room.Operation
import org.eclipse.etrice.core.room.Attribute
import org.eclipse.etrice.core.room.Message
import org.eclipse.etrice.core.room.StandardOperation
import org.eclipse.etrice.generator.base.ILogger
import org.eclipse.etrice.generator.base.IRoomGenerator
import org.eclipse.etrice.generator.etricegen.Root
import org.eclipse.xtext.generator.JavaIoFileSystemAccess
import org.eclipse.etrice.generator.extensions.RoomExtensions
@Singleton
class DocGen implements IRoomGenerator {
@Inject extension JavaIoFileSystemAccess fileAccess
@Inject extension RoomExtensions roomExt
@Inject ILogger logger
override doGenerate(Root root) {
for (model: root.models) {
var path = model.docGenerationTargetPath
var file = model.name+".tex"
logger.logInfo("generating LaTeX documentation: '"+file+"' in '"+path+"'")
fileAccess.setOutputPath(path)
fileAccess.generateFile(file, root.generateModelDoc(model))
}
}
def generateModelDoc(Root root, RoomModel model) {'''
\documentclass[titlepage]{article}
\usepackage{graphicx}
\makeatletter
\newcommand\level[1]{%
\ifcase#1\relax\expandafter\chapter\or
\expandafter\section\or
\expandafter\subsection\or
\expandafter\subsubsection\else
\def\next{\@level{#1}}\expandafter\next
\fi}
\newcommand{\@level}[1]{%
\@startsection{level#1}
{#1}
{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\normalfont\normalsize\bfseries}}
\newdimen\@leveldim
\newdimen\@dotsdim
{\normalfont\normalsize
\sbox\z@{0}\global\@leveldim=\wd\z@
\sbox\z@{.}\global\@dotsdim=\wd\z@
}
\newcounter{level4}[subsubsection]
\@namedef{thelevel4}{\thesubsubsection.\arabic{level4}}
\@namedef{level4mark}#1{}
\def\l@section{\@dottedtocline{1}{0pt}{\dimexpr\@leveldim*4+\@dotsdim*1+6pt\relax}}
\def\l@subsection{\@dottedtocline{2}{0pt}{\dimexpr\@leveldim*5+\@dotsdim*2+6pt\relax}}
\def\l@subsubsection{\@dottedtocline{3}{0pt}{\dimexpr\@leveldim*6+\@dotsdim*3+6pt\relax}}
\@namedef{l@level4}{\@dottedtocline{4}{0pt}{\dimexpr\@leveldim*7+\@dotsdim*4+6pt\relax}}
\count@=4
\def\@ncp#1{\number\numexpr\count@+#1\relax}
\loop\ifnum\count@<100
\begingroup\edef\x{\endgroup
\noexpand\newcounter{level\@ncp{1}}[level\number\count@]
\noexpand\@namedef{thelevel\@ncp{1}}{%
\noexpand\@nameuse{thelevel\@ncp{0}}.\noexpand\arabic{level\@ncp{0}}}
\noexpand\@namedef{level\@ncp{1}mark}####1{}%
\noexpand\@namedef{l@level\@ncp{1}}%
{\noexpand\@dottedtocline{\@ncp{1}}{0pt}{\the\dimexpr\@leveldim*\@ncp{5}+\@dotsdim*\@ncp{0}\relax}}}%
\x
\advance\count@\@ne
\repeat
\makeatother
\setcounter{secnumdepth}{100}
\setcounter{tocdepth}{100}
\title{«model.name» Modeldocumentation}
\date{\today}
\author{generated by eTrice}
\begin{document}
\pagestyle{plain}
\maketitle
\tableofcontents
\newpage
\listoffigures
\newpage
\section{Modeldescription}
«model.docu.generateDocText»
\section{Protocol Class Description}
«root.generateAllProtocolClassDocs(model)»
\section{Data Class Description}
«root.generateAllDataClassDocs(model)»
\section{Actor Class Description}
«root.generateAllActorClassDocs(model)»
\end{document}
'''
}
def generateAllDataClassDocs(Root root, RoomModel model){'''
«FOR dc : model.dataClasses»
«root.generateDataClassDoc(dc)»
«ENDFOR»
'''}
def generateDataClassDoc(Root root, DataClass dc) {'''
\subsection {«dc.name»}
«dc.docu.generateDocText»
\level{3}{Attributes}
«dc.attributes.generateAttributesDoc»
\level{3}{Operations}
«dc.operations.generateOperationsDoc»
'''
}
def generateAllProtocolClassDocs(Root root, RoomModel model) {'''
«FOR pc : model.protocolClasses»
«root.generateProtocolClassDoc(pc)»
«ENDFOR»
'''
}
def generateProtocolClassDoc(Root root, ProtocolClass pc) {'''
\subsection {«pc.name»}
«pc.docu.generateDocText»
\level{3}{Incoming Messages}
\begin{tabular}[ht]{|l|l|l|}
\hline
Message & Data & Description\\
«FOR ims : pc.allIncomingMessages»
\hline
«ims.name» & «IF ims.data != null» «ims.data.name» «ENDIF» & «ims.docu.generateDocText»\\
«ENDFOR»
\hline
\end{tabular}
\level{3}{Outgoing Messages}
\begin{tabular}[ht]{|l|l|l|}
\hline
Message & Data & Description\\
«FOR oms : pc.allOutgoingMessages»
\hline
«oms.name» & «IF oms.data != null» «oms.data.name» «ENDIF» & «oms.docu.generateDocText»\\
«ENDFOR»
\hline
\end{tabular}
'''
}
def generateAllActorClassDocs(Root root, RoomModel model) {'''
«FOR ac : model.actorClasses»
«root.generateActorClassDoc(model,ac)»
«ENDFOR»
'''
}
/*
«IF fileExists(ac.name) == "true"»
«ENDIF» */
def generateActorClassDoc(Root root, RoomModel model, ActorClass ac) {
var filename = model.docGenerationTargetPath + "images\\" + ac.name + ".jpg"
filename = filename.replaceAll("\\\\","/");
var filename1 = filename.replaceAll("/","//")
'''
\subsection{«ac.name»}
«ac.docu.generateDocText»
\level{3}{Structure}
«IF fileExists(filename).equals("true")»
\begin{figure}[h]
\begin{center}
\includegraphics[scale=0.6]{«filename1»}
\caption{Blinky Toplevel Structure}
\end{center}
\end{figure}
«ENDIF»
\level{4}{Attributes}
«ac.attributes.generateAttributesDoc»
\level{3}{Behavior}
\level{4}{Operations}
«ac.operations.generateOperationsDoc»
\level{4}{Statemachine}
'''
}
def generateAttributesDoc(List<Attribute> attributes) {
'''
«IF !attributes.empty»
\begin{tabular}[ht]{|l|l|l|}
\hline
Name & Type & Description\\
«FOR at : attributes»
\hline
«at.name» & «at.refType.type.name» & «generateDocText(at.docu)»\\
«ENDFOR»
\hline
\end{tabular}
«ENDIF»
'''
}
def generateOperationsDoc(List<StandardOperation> operations) {
'''
«FOR op : operations»
\begin{tabular}[ht]{|l|l|}
\hline
Name: & «op.name»\\
\hline
ReturnType: & «IF op.returntype != null»«op.returntype.type.name»«ELSE»void«ENDIF»\\
\hline
Arguments: & «FOR pa : op.arguments SEPARATOR ", "»«pa.name»:«pa.refType.type.name»«ENDFOR»\\
«IF op.docu != null»
\hline
\multicolumn{2} {|l|} {«generateDocText(op.docu)»}\\
«ENDIF»
\hline
\end{tabular}
\newline\newline\newline
«ENDFOR»
'''
}
def generateDocText(Documentation doc){'''
«IF doc!=null»
«doc.text.join()»
«ENDIF»
'''
}
def fileExists(String f){
val exist = (new File(f)).exists();
if (exist == true) {
// File or directory exists
logger.logInfo("File found ! " + f);
return "true"
} else {
// File or directory does not exist
logger.logInfo("File not found ! " + f);
return "false"
}
}
def irgendwas(Root root, ActorClass ac){
return ac.name + ".bla"
}
}
|
