forked from modelica/ModelicaSpecification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
syntax.tex
423 lines (338 loc) · 11.7 KB
/
syntax.tex
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
\chapter{Modelica Concrete Syntax}\doublelabel{modelica-concrete-syntax}
\section{Lexical conventions}\doublelabel{lexical-conventions}
The following syntactic meta symbols are used (extended BNF):
\begin{lstlisting}[language=grammar]
[ ] optional
{ } repeat zero or more times
| or
"text" The text is treated as a single token (no whitespace between any characters)
\end{lstlisting}
The following lexical units are defined (the ones in boldface are the
ones used in the grammar, the rest are just internal to the definition
of other lexical units):
\begin{lstlisting}[language=grammar,mathescape=false]
IDENT = NONDIGIT { DIGIT | NONDIGIT } | Q-IDENT
Q-IDENT = "'" ( Q-CHAR | S-ESCAPE ) { Q-CHAR | S-ESCAPE | """ } "'"
NONDIGIT = "_" | letters "a" to "z" | letters "A" to "Z"
STRING = """ { S-CHAR | S-ESCAPE } """
S-CHAR = see below
Q-CHAR = NONDIGIT | DIGIT | "!" | "#" | "$" | "%" | "&" | "(" | ")" | "*" | "+" | "," |
"-" | "." | "/" | ":" | ";" | "<" | ">" | "=" | "?" | "@" | "[" | "]" | "^" |
"{" | "}" | "|" | "~" | " "
S-ESCAPE = "\'" | "\"" | "\?" | "\\" |
"\a" | "\b" | "\f" | "\n" | "\r" | "\t" | "\v"
DIGIT = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
UNSIGNED-INTEGER = DIGIT { DIGIT }
UNSIGNED-REAL = UNSIGNED-INTEGER "." [ UNSIGNED-INTEGER ]
| UNSIGNED_INTEGER [ "." [ UNSIGNED_INTEGER ] ] ( "e" | "E" ) [ "+" | "-" ] UNSIGNED-INTEGER
| "." UNSIGNED-INTEGER [ ( "e" | "E" ) [ "+" | "-" ] UNSIGNED-INTEGER ]
\end{lstlisting}
\textrm{S-CHAR} is any member of the Unicode character set
(\url{http://www.unicode.org}; see \autoref{mapping-package-class-structures-to-a-hierarchical-file-system} for storing as UTF-8 on files) except double-quote """, and backslash "\textbackslash{}"
For identifiers the redundant escapes (`\lstinline!\?!' and `\lstinline!\"!') are the same as the corresponding non-escaped
variants (`\lstinline!?!' and '\lstinline!"!'). The single quotes are part of an identifier. E.g.\ \lstinline!'x'! and
\lstinline!x! are different IDENTs.
Note:
\begin{itemize}
\item
Whitespace and comments can be used between separate lexical units
and/or symbols, and also separates them. Each lexical unit will consume the maximum number of characters from the input stream.
Whitespace and comments
cannot be used inside other lexical units, except for STRING and
Q-IDENT where they are treated as part of the STRING or Q-IDENT
lexical unit.
\item
String constant concatenation \lstinline!"a" "b"! becoming \lstinline!"ab"! (as in C) is
replaced by the \lstinline!"+"! operator in Modelica.
\item
Modelica uses the same comment syntax as C++ and Java (i.e., \lstinline!//!
signals the start of a line comment and \lstinline!/*! .... \lstinline!*/! is a multi-line
comment); comments may contain any Unicode character. Modelica also
has structured comments in the form of annotations and string
comments.
\item
Each description-string or string in annotations (= STRING with production annotation-clause in the
grammar) may contain any member of the Unicode character set. All
other strings have to contain only the sub-set of Unicode characters
identical with the 7-bit US-ASCII character set.
\begin{nonnormative}
As a consequence, operators like `\textgreater{}' or `\textless{}', and external functions only operate on ASCII strings and not on Unicode-strings.
Within a description-string the tags \lstinline!<HTML>! and \lstinline!</HTML>! or \lstinline!<html>! and \lstinline!</html>! define optionally begin
and end of content that is HTML encoded.
\end{nonnormative}
\item
Boldface denotes keywords of the Modelica language. Keywords are
reserved words and may not be used as identifiers.
\item
Productions use hyphen as separator both in the grammar and in the
text. Previously the grammar used underscore.
\end{itemize}
\section{Grammar}\doublelabel{grammar}
\subsection{Stored Definition -- Within}\doublelabel{stored-definition-within}
\begin{lstlisting}[language=grammar]
stored-definition:
[ within [ name ] ";" ]
{ [ final ] class-definition ";" }
\end{lstlisting}
\subsection{Class Definition}\doublelabel{class-definition}
\begin{lstlisting}[language=grammar]
class-definition :
[ encapsulated ] class-prefixes
class-specifier
class-prefixes :
[ partial ]
( class | model | [ operator ] record | block | [ expandable ] connector | type |
package | [ pure | impure ] [ operator ] function | operator )
class-specifier :
long-class-specifier | short-class-specifier | der-class-specifier
long-class-specifier :
IDENT description-string composition end IDENT
| extends IDENT [ class-modification ] description-string composition
end IDENT
short-class-specifier :
IDENT "=" base-prefix type-specifier [ array-subscripts ]
[ class-modification ] description
| IDENT "=" enumeration "(" ( [ enum-list ] | ":" ) ")" description
der-class-specifier :
IDENT "=" der "(" type-specifier "," IDENT { "," IDENT } ")" description
base-prefix :
[ input | output ]
enum-list : enumeration-literal { "," enumeration-literal}
enumeration-literal : IDENT description
composition :
element-list
{ public element-list |
protected element-list |
equation-section |
algorithm-section
}
[ external [ language-specification ]
[ external-function-call ] [ annotation-clause ] ";" ]
[ annotation-clause ";" ]
language-specification :
STRING
external-function-call :
[ component-reference "=" ]
IDENT "(" [ expression-list ] ")"
element-list :
{ element ";" }
element :
import-clause |
extends-clause |
[ redeclare ]
[ final ]
[ inner ] [ outer ]
( class-definition | component-clause |
replaceable ( class-definition | component-clause )
[ constraining-clause description ] )
import-clause :
import ( IDENT "=" name | name [ ".*" | "." ( "*" | "{" import-list "}" ) ] ) description
import-list :
IDENT { "," IDENT }
\end{lstlisting}
\subsection{Extends}\doublelabel{extends}
\begin{lstlisting}[language=grammar]
extends-clause :
extends type-specifier [ class-modification ] [ annotation-clause ]
constraining-clause :
constrainedby type-specifier [ class-modification ]
\end{lstlisting}
\subsection{Component Clause}\doublelabel{component-clause}
\begin{lstlisting}[language=grammar]
component-clause:
type-prefix type-specifier [ array-subscripts ] component-list
type-prefix :
[ flow | stream ]
[ discrete | parameter | constant ] [ input | output ]
component-list :
component-declaration { "," component-declaration }
component-declaration :
declaration [ condition-attribute ] description
condition-attribute:
if expression
declaration :
IDENT [ array-subscripts ] [ modification ]
\end{lstlisting}
\subsection{Modification}\doublelabel{modification}
\begin{lstlisting}[language=grammar]
modification :
class-modification [ "=" expression ]
| "=" expression
| ":=" expression
class-modification :
"(" [ argument-list ] ")"
argument-list :
argument { "," argument }
argument :
element-modification-or-replaceable
| element-redeclaration
element-modification-or-replaceable:
[ each ] [ final ] ( element-modification | element-replaceable )
element-modification :
name [ modification ] description-string
element-redeclaration :
redeclare [ each ] [ final ]
( short-class-definition | component-clause1 | element-replaceable )
element-replaceable:
replaceable ( short-class-definition | component-clause1 )
[ constraining-clause ]
component-clause1 :
type-prefix type-specifier component-declaration1
component-declaration1 :
declaration description
short-class-definition :
class-prefixes short-class-specifier
\end{lstlisting}
\subsection{Equations}\doublelabel{equations1}
\begin{lstlisting}[language=grammar]
equation-section :
[ initial ] equation { equation ";" }
algorithm-section :
[ initial ] algorithm { statement ";" }
equation :
( simple-expression "=" expression
| if-equation
| for-equation
| connect-clause
| when-equation
| component-reference function-call-args )
description
statement :
( component-reference ( ":=" expression | function-call-args )
| "(" output-expression-list ")" ":=" component-reference function-call-args
| break
| return
| if-statement
| for-statement
| while-statement
| when-statement )
description
if-equation :
if expression then
{ equation ";" }
{ elseif expression then
{ equation ";" }
}
[ else
{ equation ";" }
]
end if
if-statement :
if expression then
{ statement ";" }
{ elseif expression then
{ statement ";" }
}
[ else
{ statement ";" }
]
end if
for-equation :
for for-indices loop
{ equation ";" }
end for
for-statement :
for for-indices loop
{ statement ";" }
end for
for-indices :
for-index {"," for-index}
for-index:
IDENT [ in expression ]
while-statement :
while expression loop
{ statement ";" }
end while
when-equation :
when expression then
{ equation ";" }
{ elsewhen expression then
{ equation ";" } }
end when
when-statement :
when expression then
{ statement ";" }
{ elsewhen expression then
{ statement ";" } }
end when
connect-clause :
connect "(" component-reference "," component-reference ")"
\end{lstlisting}
\subsection{Expressions}\doublelabel{expressions1}
\begin{lstlisting}[language=grammar]
expression :
simple-expression
| if expression then expression { elseif expression then expression }
else expression
simple-expression :
logical-expression [ ":" logical-expression [ ":" logical-expression ] ]
logical-expression :
logical-term { or logical-term }
logical-term :
logical-factor { and logical-factor }
logical-factor :
[ not ] relation
relation :
arithmetic-expression [ relational-operator arithmetic-expression ]
relational-operator :
"<" | "<=" | ">" | ">=" | "==" | "<>"
arithmetic-expression :
[ add-operator ] term { add-operator term }
add-operator :
"+" | "-" | ".+" | ".-"
term :
factor { mul-operator factor }
mul-operator :
"*" | "/" | ".*" | "./"
factor :
primary [ ("^" | ".^") primary ]
primary :
UNSIGNED-NUMBER
| STRING
| false
| true
| ( component-reference | der | initial | pure ) function-call-args
| component-reference
| "(" output-expression-list ")"
| "[" expression-list { ";" expression-list } "]"
| "{" array-arguments "}"
| end
UNSIGNED-NUMBER : UNSIGNED-INTEGER | UNSIGNED-REAL
type-specifier : ["."] name
name : IDENT { "." IDENT }
component-reference :
[ "." ] IDENT [ array-subscripts ] { "." IDENT [ array-subscripts ] }
function-call-args :
"(" [ function-arguments ] ")"
function-arguments :
expression [ "," function-arguments-non-first | for for-indices ]
| function-partial-application [ "," function-arguments-non-first ]
| named-arguments
function-arguments-non-first :
function-argument [ "," function-arguments-non-first ]
| named-arguments
array-arguments :
expression [ "," array-arguments-non-first | for for-indices ]
array-arguments-non-first :
expression [ "," array-arguments-non-first ]
named-arguments: named-argument [ "," named-arguments ]
named-argument: IDENT "=" function-argument
function-argument :
function-partial-application | expression
function-partial-application :
function type-specifier "(" [ named-arguments ] ")"
output-expression-list:
[ expression ] { "," [ expression ] }
expression-list :
expression { "," expression }
array-subscripts :
"[" subscript { "," subscript } "]"
subscript :
":" | expression
description :
description-string [ annotation-clause ]
description-string :
[ STRING { "+" STRING } ]
annotation-clause :
annotation class-modification
\end{lstlisting}