2 * Copyright 2010, INRIA, University of Copenhagen
3 * Julia Lawall, Rene Rydhof Hansen, Gilles Muller, Nicolas Palix
4 * Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen
5 * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
6 * This file is part of Coccinelle.
8 * Coccinelle is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, according to version 2 of the License.
12 * Coccinelle is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Coccinelle. If not, see <http://www.gnu.org/licenses/>.
20 * The authors reserve the right to distribute this or future versions of
21 * Coccinelle under other licenses.
25 (* --------------------------------------------------------------------- *)
28 type arity
= OPT
| UNIQUE
| NONE
31 { tline_start
: int; tline_end
: int;
32 left_offset
: int; right_offset
: int }
33 val default_token_info
: token_info
36 MINUS
of (Ast_cocci.anything list list
* token_info
) ref
37 | PLUS
of Ast_cocci.count
38 | CONTEXT
of (Ast_cocci.anything
Ast_cocci.befaft
*
39 token_info
* token_info
) ref
40 | MIXED
of (Ast_cocci.anything
Ast_cocci.befaft
*
41 token_info
* token_info
) ref
43 type position_info
= { line_start
: int; line_end
: int;
44 logical_start
: int; logical_end
: int;
45 column
: int; offset
: int; }
47 type info
= { pos_info
: position_info
;
48 attachable_start
: bool; attachable_end
: bool;
49 mcode_start
: mcodekind list
; mcode_end
: mcodekind list
;
50 (* the following are only for + code *)
51 strings_before
: (Ast_cocci.added_string
* position_info
) list
;
52 strings_after
: (Ast_cocci.added_string
* position_info
) list
}
55 'a
* arity
* info
* mcodekind
* meta_pos
ref (* pos, - only *) *
56 int (* adjacency_index *)
62 mcodekind
: mcodekind
ref;
63 exp_ty
: Type_cocci.typeC
option ref; (* only for expressions *)
64 bef_aft
: dots_bef_aft
; (* only for statements *)
65 true_if_arg
: bool; (* true if "arg_exp", only for exprs *)
66 true_if_test
: bool; (* true if "test position", only for exprs *)
67 true_if_test_exp
: bool;(* true if "test_exp from iso", only for exprs *)
68 (*nonempty if this represents the use of an iso*)
69 iso_info
: (string*anything
) list
}
72 NoDots
| AddingBetweenDots
of statement
| DroppingBetweenDots
of statement
74 (* for iso metavariables, true if they can only match nonmodified, unitary
76 for SP metavariables, true if the metavariable is unitary (valid up to
77 isomorphism phase only) *)
78 and pure
= Impure
| Pure
| Context
| PureContext
(* pure and only context *)
80 (* --------------------------------------------------------------------- *)
81 (* --------------------------------------------------------------------- *)
89 and 'a dots
= 'a base_dots wrap
91 (* --------------------------------------------------------------------- *)
96 | MetaId
of Ast_cocci.meta_name mcode
* Ast_cocci.idconstraint
* pure
97 | MetaFunc
of Ast_cocci.meta_name mcode
* Ast_cocci.idconstraint
* pure
98 | MetaLocalFunc
of Ast_cocci.meta_name mcode
* Ast_cocci.idconstraint
* pure
100 | UniqueIdent
of ident
102 and ident
= base_ident wrap
104 (* --------------------------------------------------------------------- *)
107 and base_expression
=
109 | Constant
of Ast_cocci.constant mcode
110 | FunCall
of expression
* string mcode
(* ( *) *
111 expression dots
* string mcode
(* ) *)
112 | Assignment
of expression
* Ast_cocci.assignOp mcode
* expression
*
113 bool (* true if it can match an initialization *)
114 | CondExpr
of expression
* string mcode
(* ? *) * expression
option *
115 string mcode
(* : *) * expression
116 | Postfix
of expression
* Ast_cocci.fixOp mcode
117 | Infix
of expression
* Ast_cocci.fixOp mcode
118 | Unary
of expression
* Ast_cocci.unaryOp mcode
119 | Binary
of expression
* Ast_cocci.binaryOp mcode
* expression
120 | Nested
of expression
* Ast_cocci.binaryOp mcode
* expression
121 | Paren
of string mcode
(* ( *) * expression
*
123 | ArrayAccess
of expression
* string mcode
(* [ *) * expression
*
125 | RecordAccess
of expression
* string mcode
(* . *) * ident
126 | RecordPtAccess
of expression
* string mcode
(* -> *) * ident
127 | Cast
of string mcode
(* ( *) * typeC
* string mcode
(* ) *) *
129 | SizeOfExpr
of string mcode
(* sizeof *) * expression
130 | SizeOfType
of string mcode
(* sizeof *) * string mcode
(* ( *) *
131 typeC
* string mcode
(* ) *)
133 | MetaErr
of Ast_cocci.meta_name mcode
* constraints
* pure
134 | MetaExpr
of Ast_cocci.meta_name mcode
* constraints
*
135 Type_cocci.typeC list
option * Ast_cocci.form
* pure
136 | MetaExprList
of Ast_cocci.meta_name mcode
(* only in arglists *) *
138 | EComma
of string mcode
(* only in arglists *)
139 | DisjExpr
of string mcode
* expression list
* string mcode list
*
141 | NestExpr
of string mcode
* expression dots
* string mcode
*
142 expression
option * Ast_cocci.multi
143 | Edots
of string mcode
(* ... *) * expression
option
144 | Ecircles
of string mcode
(* ooo *) * expression
option
145 | Estars
of string mcode
(* *** *) * expression
option
146 | OptExp
of expression
147 | UniqueExp
of expression
149 and expression
= base_expression wrap
153 | NotIdCstrt
of Ast_cocci.reconstraint
154 | NotExpCstrt
of expression list
155 | SubExpCstrt
of Ast_cocci.meta_name list
158 MetaListLen
of Ast_cocci.meta_name mcode
162 (* --------------------------------------------------------------------- *)
166 ConstVol
of Ast_cocci.const_vol mcode
* typeC
167 | BaseType
of Ast_cocci.baseType
* string mcode list
168 | Signed
of Ast_cocci.sign mcode
* typeC
option
169 | Pointer
of typeC
* string mcode
(* * *)
170 | FunctionPointer
of typeC
*
171 string mcode
(* ( *)*string mcode
(* * *)*string mcode
(* ) *)*
172 string mcode
(* ( *)*parameter_list
*string mcode
(* ) *)
173 | FunctionType
of typeC
option *
174 string mcode
(* ( *) * parameter_list
*
176 | Array
of typeC
* string mcode
(* [ *) *
177 expression
option * string mcode
(* ] *)
178 | EnumName
of string mcode
(*enum*) * ident
option (* name *)
179 | EnumDef
of typeC
(* either StructUnionName or metavar *) *
180 string mcode
(* { *) * expression dots
* string mcode
(* } *)
181 | StructUnionName
of Ast_cocci.structUnion mcode
* ident
option (* name *)
182 | StructUnionDef
of typeC
(* either StructUnionName or metavar *) *
183 string mcode
(* { *) * declaration dots
* string mcode
(* } *)
184 | TypeName
of string mcode
185 | MetaType
of Ast_cocci.meta_name mcode
* pure
186 | DisjType
of string mcode
* typeC list
* (* only after iso *)
187 string mcode list
(* the |s *) * string mcode
189 | UniqueType
of typeC
191 and typeC
= base_typeC wrap
193 (* --------------------------------------------------------------------- *)
194 (* Variable declaration *)
195 (* Even if the Cocci program specifies a list of declarations, they are
196 split out into multiple declarations of a single variable each. *)
198 and base_declaration
=
199 MetaDecl
of Ast_cocci.meta_name mcode
* pure
200 | MetaField
of Ast_cocci.meta_name mcode
* pure
(* structure fields *)
201 | Init
of Ast_cocci.storage mcode
option * typeC
* ident
*
202 string mcode
(*=*) * initialiser
* string mcode
(*;*)
203 | UnInit
of Ast_cocci.storage mcode
option * typeC
* ident
*
205 | TyDecl
of typeC
* string mcode
(* ; *)
206 | MacroDecl
of ident
(* name *) * string mcode
(* ( *) *
207 expression dots
* string mcode
(* ) *) * string mcode
(* ; *)
208 | Typedef
of string mcode
(* typedef *) * typeC
* typeC
* string mcode
(*;*)
209 | DisjDecl
of string mcode
* declaration list
* string mcode list
*
211 | Ddots
of string mcode
(* ... *) * declaration
option (* whencode *)
212 | OptDecl
of declaration
213 | UniqueDecl
of declaration
215 and declaration
= base_declaration wrap
217 (* --------------------------------------------------------------------- *)
220 and base_initialiser
=
221 MetaInit
of Ast_cocci.meta_name mcode
* pure
222 | InitExpr
of expression
223 | InitList
of string mcode
(*{*) * initialiser_list
* string mcode
(*}*) *
224 bool (* true if ordered, false if unordered *)
226 designator list
(* name *) * string mcode
(*=*) *
227 initialiser
(* gccext: *)
228 | InitGccName
of ident
(* name *) * string mcode
(*:*) *
230 | IComma
of string mcode
231 | Idots
of string mcode
(* ... *) * initialiser
option (* whencode *)
232 | OptIni
of initialiser
233 | UniqueIni
of initialiser
236 DesignatorField
of string mcode
(* . *) * ident
237 | DesignatorIndex
of string mcode
(* [ *) * expression
* string mcode
(* ] *)
239 string mcode
(* [ *) * expression
* string mcode
(* ... *) *
240 expression
* string mcode
(* ] *)
242 and initialiser
= base_initialiser wrap
244 and initialiser_list
= initialiser dots
246 (* --------------------------------------------------------------------- *)
249 and base_parameterTypeDef
=
251 | Param
of typeC
* ident
option
252 | MetaParam
of Ast_cocci.meta_name mcode
* pure
253 | MetaParamList
of Ast_cocci.meta_name mcode
* listlen
* pure
254 | PComma
of string mcode
255 | Pdots
of string mcode
(* ... *)
256 | Pcircles
of string mcode
(* ooo *)
257 | OptParam
of parameterTypeDef
258 | UniqueParam
of parameterTypeDef
260 and parameterTypeDef
= base_parameterTypeDef wrap
262 and parameter_list
= parameterTypeDef dots
264 (* --------------------------------------------------------------------- *)
265 (* #define Parameters *)
267 and base_define_param
=
269 | DPComma
of string mcode
270 | DPdots
of string mcode
(* ... *)
271 | DPcircles
of string mcode
(* ooo *)
272 | OptDParam
of define_param
273 | UniqueDParam
of define_param
275 and define_param
= base_define_param wrap
277 and base_define_parameters
=
279 | DParams
of string mcode
(*( *) * define_param dots
* string mcode
(* )*)
281 and define_parameters
= base_define_parameters wrap
283 (* --------------------------------------------------------------------- *)
287 Decl
of (info
* mcodekind
) (* before the decl *) * declaration
288 | Seq
of string mcode
(* { *) * statement dots
*
290 | ExprStatement
of expression
* string mcode
(*;*)
291 | IfThen
of string mcode
(* if *) * string mcode
(* ( *) *
292 expression
* string mcode
(* ) *) *
293 statement
* (info
* mcodekind
)
294 | IfThenElse
of string mcode
(* if *) * string mcode
(* ( *) *
295 expression
* string mcode
(* ) *) *
296 statement
* string mcode
(* else *) * statement
*
298 | While
of string mcode
(* while *) * string mcode
(* ( *) *
299 expression
* string mcode
(* ) *) *
300 statement
* (info
* mcodekind
) (* after info *)
301 | Do
of string mcode
(* do *) * statement
*
302 string mcode
(* while *) * string mcode
(* ( *) *
303 expression
* string mcode
(* ) *) *
305 | For
of string mcode
(* for *) * string mcode
(* ( *) *
306 expression
option * string mcode
(*;*) *
307 expression
option * string mcode
(*;*) *
308 expression
option * string mcode
(* ) *) * statement
*
309 (info
* mcodekind
) (* after info *)
310 | Iterator
of ident
(* name *) * string mcode
(* ( *) *
311 expression dots
* string mcode
(* ) *) *
312 statement
* (info
* mcodekind
) (* after info *)
313 | Switch
of string mcode
(* switch *) * string mcode
(* ( *) *
314 expression
* string mcode
(* ) *) * string mcode
(* { *) *
315 statement
(*decl*) dots
*
316 case_line dots
* string mcode
(* } *)
317 | Break
of string mcode
(* break *) * string mcode
(* ; *)
318 | Continue
of string mcode
(* continue *) * string mcode
(* ; *)
319 | Label
of ident
* string mcode
(* : *)
320 | Goto
of string mcode
(* goto *) * ident
* string mcode
(* ; *)
321 | Return
of string mcode
(* return *) * string mcode
(* ; *)
322 | ReturnExpr
of string mcode
(* return *) * expression
*
324 | MetaStmt
of Ast_cocci.meta_name mcode
* pure
325 | MetaStmtList
of Ast_cocci.meta_name mcode
(*only in statement lists*) *
327 | Exp
of expression
(* only in dotted statement lists *)
328 | TopExp
of expression
(* for macros body *)
329 | Ty
of typeC
(* only at top level *)
330 | TopInit
of initialiser
(* only at top level *)
331 | Disj
of string mcode
* statement dots list
* string mcode list
*
333 | Nest
of string mcode
* statement dots
* string mcode
*
334 (statement dots
,statement
) whencode list
* Ast_cocci.multi
335 | Dots
of string mcode
(* ... *) *
336 (statement dots
,statement
) whencode list
337 | Circles
of string mcode
(* ooo *) *
338 (statement dots
,statement
) whencode list
339 | Stars
of string mcode
(* *** *) *
340 (statement dots
,statement
) whencode list
341 | FunDecl
of (info
* mcodekind
) (* before the function decl *) *
342 fninfo list
* ident
(* name *) *
343 string mcode
(* ( *) * parameter_list
* string mcode
(* ) *) *
344 string mcode
(* { *) * statement dots
*
346 | Include
of string mcode
(* #include *) * Ast_cocci.inc_file mcode
(* file *)
347 | Undef
of string mcode
(* #define *) * ident
(* name *)
348 | Define
of string mcode
(* #define *) * ident
(* name *) *
349 define_parameters
(*params*) * statement dots
350 | OptStm
of statement
351 | UniqueStm
of statement
354 FStorage
of Ast_cocci.storage mcode
356 | FInline
of string mcode
357 | FAttr
of string mcode
359 and ('a
,'b
) whencode
=
362 | WhenModifier
of Ast_cocci.when_modifier
363 | WhenNotTrue
of expression
364 | WhenNotFalse
of expression
366 and statement
= base_statement wrap
369 Default
of string mcode
(* default *) * string mcode
(*:*) * statement dots
370 | Case
of string mcode
(* case *) * expression
* string mcode
(*:*) *
372 | DisjCase
of string mcode
* case_line list
*
373 string mcode list
(* the |s *) * string mcode
374 | OptCase
of case_line
376 and case_line
= base_case_line wrap
378 (* --------------------------------------------------------------------- *)
382 MetaPos
of Ast_cocci.meta_name mcode
* Ast_cocci.meta_name list
*
383 Ast_cocci.meta_collect
386 (* --------------------------------------------------------------------- *)
391 | CODE
of statement dots
392 | FILEINFO
of string mcode
(* old file *) * string mcode
(* new file *)
393 | ERRORWORDS
of expression list
394 | OTHER
of statement
(* temporary, disappears after top_level.ml *)
396 and top_level
= base_top_level wrap
397 and rule
= top_level list
401 (rule
* Ast_cocci.metavar list
*
402 (string list
* string list
* Ast_cocci.dependency
* string *
404 (rule
* Ast_cocci.metavar list
) * Ast_cocci.ruletype
405 | ScriptRule
of string (* name *) *
406 string * Ast_cocci.dependency
*
407 (Ast_cocci.script_meta_name
*
408 Ast_cocci.meta_name
* Ast_cocci.metavar
) list
(*inherited vars*) *
409 Ast_cocci.meta_name list
(*script vars*) *
411 | InitialScriptRule
of string (* name *) *
412 string (*language*) * Ast_cocci.dependency
* string (*code*)
413 | FinalScriptRule
of string (* name *) *
414 string (*language*) * Ast_cocci.dependency
* string (*code*)
416 (* --------------------------------------------------------------------- *)
419 DotsExprTag
of expression dots
420 | DotsInitTag
of initialiser dots
421 | DotsParamTag
of parameterTypeDef dots
422 | DotsStmtTag
of statement dots
423 | DotsDeclTag
of declaration dots
424 | DotsCaseTag
of case_line dots
426 | ExprTag
of expression
427 | ArgExprTag
of expression
(* for isos *)
428 | TestExprTag
of expression
(* for isos *)
430 | ParamTag
of parameterTypeDef
431 | InitTag
of initialiser
432 | DeclTag
of declaration
433 | StmtTag
of statement
434 | CaseLineTag
of case_line
435 | TopTag
of top_level
436 | IsoWhenTag
of Ast_cocci.when_modifier
(*only for when code, in iso phase*)
437 | IsoWhenTTag
of expression
(*only for when code, in iso phase*)
438 | IsoWhenFTag
of expression
(*only for when code, in iso phase*)
439 | MetaPosTag
of meta_pos
(* only in iso phase *)
441 val dotsExpr
: expression dots
-> anything
442 val dotsInit
: initialiser dots
-> anything
443 val dotsParam
: parameterTypeDef dots
-> anything
444 val dotsStmt
: statement dots
-> anything
445 val dotsDecl
: declaration dots
-> anything
446 val dotsCase
: case_line dots
-> anything
447 val ident
: ident
-> anything
448 val expr
: expression
-> anything
449 val typeC
: typeC
-> anything
450 val param
: parameterTypeDef
-> anything
451 val ini
: initialiser
-> anything
452 val decl
: declaration
-> anything
453 val stmt
: statement
-> anything
454 val case_line
: case_line
-> anything
455 val top
: top_level
-> anything
457 (* --------------------------------------------------------------------- *)
459 val undots
: 'a dots
-> 'a list
461 (* --------------------------------------------------------------------- *)
462 (* Avoid cluttering the parser. Calculated in compute_lines.ml. *)
464 val default_info
: unit -> info
465 val default_befaft
: unit -> mcodekind
466 val context_befaft
: unit -> mcodekind
467 val wrap
: 'a
-> 'a wrap
468 val context_wrap
: 'a
-> 'a wrap
469 val unwrap
: 'a wrap
-> 'a
470 val unwrap_mcode
: 'a mcode
-> 'a
471 val rewrap
: 'a wrap
-> 'b
-> 'b wrap
472 val rewrap_mcode
: 'a mcode
-> 'b
-> 'b mcode
473 val copywrap
: 'a wrap
-> 'b
-> 'b wrap
474 val get_pos
: 'a mcode
-> meta_pos
475 val get_pos_ref
: 'a mcode
-> meta_pos
ref
476 val set_pos
: meta_pos
-> 'a mcode
-> 'a mcode
477 val get_info
: 'a wrap
-> info
478 val set_info
: 'a wrap
-> info
-> 'a wrap
479 val get_index
: 'a wrap
-> int
480 val set_index
: 'a wrap
-> int -> unit
481 val get_line
: 'a wrap
-> int
482 val get_line_end
: 'a wrap
-> int
483 val get_mcodekind
: 'a wrap
-> mcodekind
484 val get_mcode_mcodekind
: 'a mcode
-> mcodekind
485 val get_mcodekind_ref
: 'a wrap
-> mcodekind
ref
486 val set_mcodekind
: 'a wrap
-> mcodekind
-> unit
487 val set_type
: 'a wrap
-> Type_cocci.typeC
option -> unit
488 val get_type
: 'a wrap
-> Type_cocci.typeC
option
489 val set_dots_bef_aft
: statement
-> dots_bef_aft
-> statement
490 val get_dots_bef_aft
: 'a wrap
-> dots_bef_aft
491 val set_arg_exp
: expression
-> expression
492 val get_arg_exp
: expression
-> bool
493 val set_test_pos
: expression
-> expression
494 val get_test_pos
: 'a wrap
-> bool
495 val set_test_exp
: expression
-> expression
496 val get_test_exp
: 'a wrap
-> bool
497 val set_iso
: 'a wrap
-> (string*anything
) list
-> 'a wrap
498 val get_iso
: 'a wrap
-> (string*anything
) list
499 val fresh_index
: unit -> int
500 val set_mcode_data
: 'a
-> 'a mcode
-> 'a mcode
501 val make_mcode
: 'a
-> 'a mcode
502 val make_mcode_info
: 'a
-> info
-> 'a mcode
503 val make_minus_mcode
: 'a
-> 'a mcode
505 val ast0_type_to_type
: typeC
-> Type_cocci.typeC
506 val reverse_type
: Type_cocci.typeC
-> base_typeC
509 val lub_pure
: pure
-> pure
-> pure
511 (* --------------------------------------------------------------------- *)
513 val rule_name
: string ref (* for the convenience of the parser *)