3 * Copyright (C) 2010, University of Copenhagen DIKU and INRIA.
4 * Copyright (C) 2002, 2006, 2007, 2008, 2009 Yoann Padioleau
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License (GPL)
8 * version 2 as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * file license.txt for more details.
17 (*****************************************************************************)
18 (* The AST C related types *)
19 (*****************************************************************************)
21 * Some stuff are tagged semantic: which means that they are computed
24 * This means that some elements in this AST are present only if
25 * some annotation/transformation has been done on the original AST returned
26 * by the parser. Cf type_annotater, comment_annotater, cpp_ast_c, etc.
30 (* ------------------------------------------------------------------------- *)
32 (* ------------------------------------------------------------------------- *)
34 (* To allow some transformations over the AST, we keep as much information
35 * as possible in the AST such as the tokens content and their locations.
36 * Those info are called 'info' (how original) and can be tagged.
37 * For instance one tag may say that the unparser should remove this token.
39 * Update: Now I use a ref! in those 'info' so take care.
40 * That means that modifications of the info of tokens can have
41 * an effect on the info stored in the ast (which is sometimes
42 * convenient, cf unparse_c.ml or comment_annotater_c.ml)
44 * convention: I often use 'ii' for the name of a list of info.
46 * Sometimes we want to add someting at the beginning or at the end
47 * of a construct. For 'function' and 'decl' we want to add something
48 * to their left and for 'if' 'while' et 'for' and so on at their right.
49 * We want some kinds of "virtual placeholders" that represent the start or
50 * end of a construct. We use fakeInfo for that purpose.
51 * To identify those cases I have added a fakestart/fakeend comment.
53 * cocci: Each token will be decorated in the future by the mcodekind
54 * of cocci. It is the job of the pretty printer to look at this
55 * information and decide to print or not the token (and also the
56 * pending '+' associated sometimes with the token).
58 * The first time that we parse the original C file, the mcodekind is
59 * empty, or more precisely all is tagged as a CONTEXT with NOTHING
60 * associated. This is what I call a "clean" expr/statement/....
62 * Each token will also be decorated in the future with an environment,
63 * because the pending '+' may contain metavariables that refer to some
70 type posl
= int * int (* line-col, for MetaPosValList, for position variables *)
73 (* the virtual position is set in Parsing_hacks.insert_virtual_positions *)
74 type virtual_position
= Common.parse_info
* int (* character offset *)
78 (* Present both in ast and list of tokens *)
79 | OriginTok
of Common.parse_info
80 (* Present only in ast and generated after parsing. Used mainly
81 * by Julia, to add stuff at virtual places, beginning of func or decl *)
82 | FakeTok
of string * virtual_position
83 (* Present both in ast and list of tokens. *)
84 | ExpandedTok
of Common.parse_info
* virtual_position
86 (* Present neither in ast nor in list of tokens
87 * but only in the '+' of the mcode of some tokens. Those kind of tokens
88 * are used to be able to use '=' to compare big ast portions.
90 | AbstractLineTok
of Common.parse_info
(* local to the abstracted thing *)
96 (* this cocci_tag can be changed, which is how we can express some program
97 * transformations by tagging the tokens involved in this transformation.
99 cocci_tag
: (Ast_cocci.mcodekind
* metavars_binding list
) option ref;
100 (* set in comment_annotater_c.ml *)
101 comments_tag
: comments_around
ref;
103 (* todo? token_info : sometimes useful to know what token it was *)
107 (* wrap2 is like wrap, except that I use it often for separator such
108 * as ','. In that case the info is associated to the argument that
109 * follows, so in 'a,b' I will have in the list [(a,[]); (b,[','])].
111 * wrap3 is like wrap, except that I use it in case sometimes it
112 * will be empty because the info will be included in a nested
113 * entity (e.g. for Ident in expr because it's inlined in the name)
114 * so user should never assume List.length wrap3 > 0.
116 and 'a wrap
= 'a
* il
117 and 'a wrap2
= 'a
* il
118 and 'a wrap3
= 'a
* il
(* * evotype*)
120 (* ------------------------------------------------------------------------- *)
122 (* ------------------------------------------------------------------------- *)
124 (* was called 'ident' before, but 'name' is I think better
125 * as concatenated strings can be used not only for identifiers and for
126 * declarators, but also for fields, for labels, etc.
128 * Note: because now the info is embeded in the name, the info for
129 * expression like Ident, or types like Typename, are not anymore
130 * stored in the expression or type. Hence if you assume this,
131 * which was true before, you are now wrong. So never write code like
132 * let (unwrape,_), ii = e and use 'ii' believing it contains
133 * the local ii to e. If you want to do that, use the appropiate
134 * wrapper get_local_ii_of_expr_inlining_ii_of_name.
137 | RegularName
of string wrap
138 | CppConcatenatedName
of (string wrap
) wrap2
(* the ## separators *) list
139 (* normally only used inside list of things, as in parameters or arguments
140 * in which case, cf cpp-manual, it has a special meaning *)
141 | CppVariadicName
of string wrap
(* ## s *)
142 | CppIdentBuilder
of string wrap
(* s ( ) *) *
143 ((string wrap
) wrap2 list
) (* arguments *)
146 (* ------------------------------------------------------------------------- *)
148 (* ------------------------------------------------------------------------- *)
149 (* Could have more precise type in fullType, in expression, etc, but
150 * it requires to do too much things in parsing such as checking no
151 * conflicting structname, computing value, etc. Better to separate
152 * concern. So I put '=>' to mean what we would really like. In fact
153 * what we really like is defining another fullType, expression, etc
154 * from scratch, because many stuff are just sugar.
156 * invariant: Array and FunctionType have also typeQualifier but they
157 * dont have sense. I put this to factorise some code. If you look in
158 * the grammar, you see that we can never specify const for the array
159 * himself (but we can do it for pointer) or function, we always
160 * have in the action rule of the grammar a { (nQ, FunctionType ...) }.
163 * Because of ExprStatement, we can have more 'new scope' events, but
164 * rare I think. For instance with 'array of constExpression' there can
165 * have an exprStatement and a new (local) struct defined. Same for
171 and fullType
= typeQualifier
* typeC
172 and typeC
= typeCbis wrap
(* todo reput wrap3 *)
175 NoType
(* for c++ only *)
176 | BaseType
of baseType
178 | Pointer
of fullType
179 | Array
of constExpression
option * fullType
180 | FunctionType
of functionType
182 | Enum
of string option * enumType
183 | StructUnion
of structUnion
* string option * structType
(* new scope *)
186 | StructUnionName
of structUnion
* string
188 | TypeName
of name
* fullType
option (* semantic: filled later *)
190 | ParenType
of fullType
(* for unparser: *)
192 (* gccext: TypeOfType below may seems useless; Why declare a
193 * __typeof__(int) x; ?
194 * When used with macros, it allows to fix a problem of C which
195 * is that type declaration can be spread around the ident. Indeed it
196 * may be difficult to have a macro such as
197 * '#define macro(type, ident) type ident;'
198 * because when you want to do a
199 * macro(char[256], x),
200 * then it will generate invalid code, but with a
201 * '#define macro(type, ident) __typeof(type) ident;'
204 | TypeOfExpr
of expression
205 | TypeOfType
of fullType
207 (* cppext: IfdefType TODO *)
209 (* -------------------------------------- *)
212 | FloatType
of floatType
217 (* stdC: type section
219 * note: char and signed char are semantically different!!
221 and intType
= CChar
(* obsolete? | CWchar *)
224 and signed
= sign
* base
225 and base
= CChar2
| CShort
| CInt
| CLong
| CLongLong
(* gccext: *)
226 and sign
= Signed
| UnSigned
228 and floatType
= CFloat
| CDouble
| CLongDouble
231 (* -------------------------------------- *)
232 and structUnion
= Struct
| Union
233 and structType
= field list
235 | DeclarationField
of field_declaration
240 | MacroDeclField
of (string * argument wrap2 list
)
241 wrap
(* optional ';'*)
244 | CppDirectiveStruct
of cpp_directive
245 | IfdefStruct
of ifdef_directive
(* * field list list *)
248 (* before unparser, I didn't have a FieldDeclList but just a Field. *)
249 and field_declaration
=
250 | FieldDeclList
of fieldkind wrap2 list
(* , *) wrap
(* ; *)
252 (* At first I thought that a bitfield could be only Signed/Unsigned.
253 * But it seems that gcc allow char i:4. C rule must say that you
254 * can cast into int so enum too, ...
257 | Simple
of name
option * fullType
258 | BitField
of name
option * fullType
*
259 info
(* : *) * constExpression
260 (* fullType => BitFieldInt | BitFieldUnsigned *)
263 (* -------------------------------------- *)
264 and enumType
= oneEnumType wrap2
(* , *) list
265 (* => string * int list *)
267 and oneEnumType
= name
* (info
(* = *) * constExpression
) option
269 (* -------------------------------------- *)
270 (* return * (params * has "...") *)
271 and functionType
= fullType
* (parameterType wrap2 list
* bool wrap
)
273 { p_namei
: name
option;
274 p_register
: bool wrap
;
277 (* => (bool (register) * fullType) list * bool *)
280 and typeQualifier
= typeQualifierbis wrap
281 and typeQualifierbis
= {const
: bool; volatile
: bool}
283 (* gccext: cppext: *)
284 and attribute
= attributebis wrap
286 | Attribute
of string
288 (* ------------------------------------------------------------------------- *)
290 (* ------------------------------------------------------------------------- *)
291 and expression
= (expressionbis
* exp_info
ref (* semantic: *)) wrap3
292 and exp_info
= exp_type
option * test
293 and exp_type
= fullType
(* Type_c.completed_and_simplified *) * local
294 and local
= LocalVar
of parse_info
| StaticLocalVar
of parse_info
295 | NotLocalVar
(* cocci: *)
296 and test
= Test
| NotTest
(* cocci: *)
300 (* Ident can be a enumeration constant, a simple variable, a name of a func.
301 * With cppext, Ident can also be the name of a macro. Sparse says
302 * "an identifier with a meaning is a symbol" *)
303 | Ident
of name
(* todo? more semantic info such as LocalFunc *)
305 | Constant
of constant
306 | FunCall
of expression
* argument wrap2
(* , *) list
307 (* gccext: x ? /* empty */ : y <=> x ? x : y; hence the 'option' below *)
308 | CondExpr
of expression
* expression
option * expression
310 (* should be considered as statements, bad C langage *)
311 | Sequence
of expression
* expression
312 | Assignment
of expression
* assignOp
* expression
315 | Postfix
of expression
* fixOp
316 | Infix
of expression
* fixOp
318 | Unary
of expression
* unaryOp
319 | Binary
of expression
* binaryOp
* expression
321 | ArrayAccess
of expression
* expression
323 (* field ident access *)
324 | RecordAccess
of expression
* name
325 | RecordPtAccess
of expression
* name
326 (* redundant normally, could replace it by DeRef RecordAcces *)
328 | SizeOfExpr
of expression
329 | SizeOfType
of fullType
330 | Cast
of fullType
* expression
333 | StatementExpr
of compound wrap
(* ( ) new scope *)
334 | Constructor
of fullType
* initialiser
337 | ParenExpr
of expression
341 | Delete
of expression
343 (* cppext: IfdefExpr TODO *)
345 (* cppext: normally just expression *)
346 and argument
= (expression
, weird_argument
) Common.either
348 | ArgType
of parameterType
349 | ArgAction
of action_macro
351 (* todo: ArgStatement of statement, possibly have ghost token *)
355 (* I put string for Int and Float because int would not be enough because
356 * OCaml int are 31 bits. So simpler to do string. Same reason to have
357 * string instead of int list for the String case.
359 * note: -2 is not a constant, it is the unary operator '-'
360 * applied to constant 2. So the string must represent a positive
364 | String
of (string * isWchar
)
365 | MultiString
of string list
(* can contain MacroString, todo: more info *)
366 | Char
of (string * isWchar
) (* normally it is equivalent to Int *)
367 | Int
of (string * intType
)
368 | Float
of (string * floatType
)
370 and isWchar
= IsWchar
| IsChar
373 and unaryOp
= GetRef
| DeRef
| UnPlus
| UnMinus
| Tilde
| Not
374 | GetRefLabel
(* gccext: GetRefLabel, via &&label notation *)
375 and assignOp
= SimpleAssign
| OpAssign
of arithOp
376 and fixOp
= Dec
| Inc
378 and binaryOp
= Arith
of arithOp
| Logical
of logicalOp
381 | Plus
| Minus
| Mul
| Div
| Mod
386 | Inf
| Sup
| InfEq
| SupEq
390 and constExpression
= expression
(* => int *)
392 (* ------------------------------------------------------------------------- *)
394 (* ------------------------------------------------------------------------- *)
395 (* note: that assignement is not a statement but an expression;
396 * wonderful C langage.
398 * note: I use 'and' for type definition cos gccext allow statement as
399 * expression, so need mutual recursive type definition.
403 and statement
= statementbis wrap3
406 | Compound
of compound
(* new scope *)
407 | ExprStatement
of exprStatement
408 | Selection
of selection
(* have fakeend *)
409 | Iteration
of iteration
(* have fakeend *)
412 (* simplify cocci: only at the beginning of a compound normally *)
413 | Decl
of declaration
417 | NestedFunc
of definition
424 and labeled
= Label
of name
* statement
425 | Case
of expression
* statement
426 | CaseRange
of expression
* expression
* statement
(* gccext: *)
427 | Default
of statement
430 * old: compound = (declaration list * statement list)
431 * old: (declaration, statement) either list
432 * Simplify cocci to just have statement list, by integrating Decl in stmt.
434 * update: now introduce also the _sequencable to allow ifdef in the middle.
435 * Indeed, I now allow ifdefs in the ast but they must be only between
436 * "sequencable" elements. They can be put in a type only if this type
437 * is used in a list, like at the toplevel, used in a 'toplevel list',
438 * or inside a compound, used in a 'statement list'. I must not allow
439 * ifdef anywhere. For instance I can not make ifdef a statement
440 * cos some instruction like If accept only one statement and the
441 * ifdef directive must not take the place of a legitimate instruction.
442 * We had a similar phenomena in SmPL where we have the notion
443 * of statement and sequencable statement too. Once you have
444 * such a type of sequencable thing, then s/xx list/xx_sequencable list/
445 * and introduce the ifdef.
447 * update: those ifdefs are either passed, or present in the AST but in
448 * a flat form. To structure those flat ifdefs you have to run
449 * a transformation that will put in a tree the statements inside
450 * ifdefs branches. Cf cpp_ast_c.ml. This is for instance the difference
451 * between a IfdefStmt (flat) and IfdefStmt2 (tree structured).
454 and compound
= statement_sequencable list
456 (* cppext: easier to put at statement_list level than statement level *)
457 and statement_sequencable
=
458 | StmtElem
of statement
461 | CppDirectiveStmt
of cpp_directive
462 | IfdefStmt
of ifdef_directive
464 (* this will be build in cpp_ast_c from the previous flat IfdefStmt *)
465 | IfdefStmt2
of ifdef_directive list
* (statement_sequencable list
) list
467 and exprStatement
= expression
option
469 and declOrExpr
= ForDecl
of declaration
| ForExp
of expression
option wrap
471 (* for Switch, need check that all elements in the compound start
472 * with a case:, otherwise unreachable code.
475 | If
of expression
* statement
* statement
476 | Switch
of expression
* statement
480 | While
of expression
* statement
481 | DoWhile
of statement
* expression
482 | For
of declOrExpr
* exprStatement wrap
* exprStatement wrap
*
485 | MacroIteration
of string * argument wrap2 list
* statement
487 and jump
= Goto
of name
489 | Return
| ReturnExpr
of expression
490 | GotoComputed
of expression
(* gccext: goto *exp ';' *)
494 and asmbody
= il
(* string list *) * colon wrap
(* : *) list
495 and colon
= Colon
of colon_option wrap2 list
496 and colon_option
= colon_option_bis wrap
497 and colon_option_bis
= ColonMisc
| ColonExpr
of expression
500 (* ------------------------------------------------------------------------- *)
502 (* ------------------------------------------------------------------------- *)
503 (* (string * ...) option cos can have empty declaration or struct tag
506 * Before I had a Typedef constructor, but why make this special case and not
507 * have StructDef, EnumDef, ... so that 'struct t {...} v' will generate 2
508 * declarations ? So I try to generalise and not have Typedef either. This
509 * requires more work in parsing. Better to separate concern.
511 * Before the need for unparser, I didn't have a DeclList but just a Decl.
513 * I am not sure what it means to declare a prototype inline, but gcc
518 | DeclList
of onedecl wrap2
(* , *) list wrap
(* ; fakestart sto *)
520 (* bool is true if there is a ; at the end *)
521 | MacroDecl
of (string * argument wrap2 list
* bool) wrap
(* fakestart *)
523 (string * argument wrap2 list
* initialiser
) wrap
(* fakestart *)
526 { v_namei
: (name
* v_init
) option;
528 (* semantic: set in type annotated and used in cocci_vs_c
529 * when we transform some initialisation into affectation
531 v_type_bis
: fullType
(* Type_c.completed_and_simplified *) option ref;
533 v_local
: local_decl
; (* cocci: *)
534 v_attr
: attribute list
; (* gccext: *)
537 NoInit
| ValInit
of info
* initialiser
538 | ConstrInit
of argument wrap2
(* , *) list wrap
539 and storage
= storagebis
* bool (* gccext: inline or not *)
540 and storagebis
= NoSto
| StoTypedef
| Sto
of storageClass
541 and storageClass
= Auto
| Static
| Register
| Extern
543 and local_decl
= LocalDecl
| NotLocalDecl
545 (* fullType is the type used if the type should be converted to
546 an assignment. It can be adjusted in the type annotation
547 phase when typedef information is availalble *)
548 and initialiser
= initialiserbis wrap
550 | InitExpr
of expression
551 | InitList
of initialiser wrap2
(* , *) list
553 | InitDesignators
of designator list
* initialiser
554 | InitFieldOld
of string * initialiser
555 | InitIndexOld
of expression
* initialiser
557 (* ex: [2].y = x, or .y[2] or .y.x. They can be nested *)
558 and designator
= designatorbis wrap
560 | DesignatorField
of string
561 | DesignatorIndex
of expression
562 | DesignatorRange
of expression
* expression
564 (* ------------------------------------------------------------------------- *)
565 (* Function definition *)
566 (* ------------------------------------------------------------------------- *)
567 (* Normally we should define another type functionType2 because there
568 * are more restrictions on what can define a function than a pointer
569 * function. For instance a function declaration can omit the name of the
570 * parameter whereas a function definition can not. But, in some cases such
571 * as 'f(void) {', there is no name too, so I simplified and reused the
572 * same functionType type for both declaration and function definition.
574 * Also old style C does not have type in the parameter, so again simpler
575 * to abuse the functionType and allow missing type.
577 and definition
= definitionbis wrap
(* ( ) { } fakestart sto *)
580 f_type
: functionType
; (* less? a functionType2 ? *)
583 f_attr
: attribute list
; (* gccext: *)
584 f_old_c_style
: declaration list
option;
586 (* cppext: IfdefFunHeader TODO *)
588 (* ------------------------------------------------------------------------- *)
589 (* cppext: cpp directives, #ifdef, #define and #include body *)
590 (* ------------------------------------------------------------------------- *)
595 (*| Ifdef ? no, ifdefs are handled differently, cf ifdef_directive below *)
597 and define
= string wrap
(* #define s eol *) * (define_kind
* define_val
)
600 | DefineFunc
of ((string wrap
) wrap2 list
) wrap
(* () *)
603 (* most common case; e.g. to define int constant *)
604 | DefineExpr
of expression
606 | DefineStmt
of statement
607 | DefineType
of fullType
608 | DefineDoWhileZero
of (statement
* expression
) wrap
(* do { } while(0) *)
610 | DefineFunction
of definition
611 | DefineInit
of initialiser
(* in practice only { } with possible ',' *)
613 (* TODO DefineMulti of define_val list *)
615 | DefineText
of string wrap
623 { i_include
: inc_file wrap
; (* #include s *)
624 (* cocci: computed in ? *)
625 i_rel_pos
: include_rel_pos
option ref;
626 (* cocci: cf -test incl *)
628 (* cf cpp_ast_c.ml. set to None at parsing time. *)
629 i_content
: (Common.filename
(* full path *) * program
) option;
632 | Local
of inc_elem list
633 | NonLocal
of inc_elem list
634 | Weird
of string (* ex: #include SYSTEM_H *)
635 and inc_elem
= string
637 (* cocci: to tag the first of #include <xx/> and last of #include <yy/>
639 * The first_of and last_of store the list of prefixes that was
640 * introduced by the include. On #include <a/b/x>, if the include was
641 * the first in the file, it would give in first_of the following
642 * prefixes a/b/c; a/b/; a/ ; <empty>
644 * This is set after parsing, in cocci.ml, in update_rel_pos.
646 and include_rel_pos
= {
647 first_of
: string list list
;
648 last_of
: string list list
;
653 (* todo? to specialize if someone need more info *)
654 and ifdef_directive
= (* or and 'a ifdefed = 'a list wrap *)
655 | IfdefDirective
of (ifdefkind
* matching_tag
) wrap
657 | Ifdef
(* todo? of string ? of formula_cpp ? *)
658 | IfdefElseif
(* same *)
659 | IfdefElse
(* same *)
661 (* set in Parsing_hacks.set_ifdef_parenthize_info. It internally use
662 * a global so it means if you parse the same file twice you may get
663 * different id. I try now to avoid this pb by resetting it each
664 * time I parse a file.
667 IfdefTag
of (int (* tag *) * int (* total with this tag *))
673 (* ------------------------------------------------------------------------- *)
674 (* The toplevels elements *)
675 (* ------------------------------------------------------------------------- *)
677 | Declaration
of declaration
678 | Definition
of definition
681 | CppTop
of cpp_directive
682 | IfdefTop
of ifdef_directive
(* * toplevel list *)
685 | MacroTop
of string * argument wrap2 list
* il
687 | EmptyDef
of il
(* gccext: allow redundant ';' *)
688 | NotParsedCorrectly
of il
690 | FinalDef
of info
(* EOF *)
692 (* ------------------------------------------------------------------------- *)
693 and program
= toplevel list
695 (*****************************************************************************)
697 (*****************************************************************************)
698 (* Was previously in pattern.ml, but because of the transformer,
699 * we need to decorate each token with some cocci code AND the environment
700 * for this cocci code.
702 and metavars_binding
= (Ast_cocci.meta_name
, metavar_binding_kind
) assoc
703 and metavar_binding_kind
=
704 | MetaIdVal
of string *
705 Ast_cocci.meta_name list
(* negative constraints *)
706 | MetaFuncVal
of string
707 | MetaLocalFuncVal
of string
709 | MetaExprVal
of expression
(* a "clean expr" *) *
710 (*subterm constraints, currently exprs*)
711 Ast_cocci.meta_name list
712 | MetaExprListVal
of argument wrap2 list
713 | MetaParamVal
of parameterType
714 | MetaParamListVal
of parameterType wrap2 list
716 | MetaTypeVal
of fullType
717 | MetaInitVal
of initialiser
718 | MetaInitListVal
of initialiser wrap2 list
719 | MetaDeclVal
of declaration
720 | MetaFieldVal
of field
721 | MetaFieldListVal
of field list
722 | MetaStmtVal
of statement
724 (* Could also be in Lib_engine.metavars_binding2 with the ParenVal,
725 * because don't need to have the value for a position in the env of
726 * a '+'. But ParenVal or LabelVal are used only by CTL, they are not
727 * variables accessible via SmPL whereas the position can be one day
728 * so I think it's better to put MetaPosVal here *)
729 | MetaPosVal
of (Ast_cocci.fixpos
* Ast_cocci.fixpos
) (* max, min *)
731 (Common.filename
* string (*element*) * posl
* posl
) list
(* min, max *)
732 | MetaListlenVal
of int
735 (*****************************************************************************)
737 (*****************************************************************************)
739 (* convention: I often use "m" for comments as I can not use "c"
740 * (already use for c stuff) and "com" is too long.
743 (* this type will be associated to each token.
745 and comments_around
= {
746 mbefore
: Token_c.comment_like_token list
;
747 mafter
: Token_c.comment_like_token list
;
749 (* less: could remove ? do something simpler than CComment for
750 * coccinelle, cf above. *)
751 mbefore2
: comment_and_relative_pos list
;
752 mafter2
: comment_and_relative_pos list
;
754 and comment_and_relative_pos
= {
756 minfo
: Common.parse_info
;
757 (* the int represent the number of lines of difference between the
758 * current token and the comment. When on same line, this number is 0.
759 * When previous line, -1. In some way the after/before in previous
760 * record is useless because the sign of the integer can helps
761 * do the difference too, but I keep it that way.
765 * cppbetween: bool; touse? if false positive
766 * is_alone_in_line: bool; (*for labels, to avoid false positive*)
770 and comment
= Common.parse_info
771 and com
= comment list
ref
776 (*****************************************************************************)
777 (* Some constructors *)
778 (*****************************************************************************)
779 let nullQualif = ({const
=false; volatile
= false}, [])
782 let defaultInt = (BaseType
(IntType
(Si
(Signed
, CInt
))))
784 let noType () = ref (None
,NotTest
)
785 let noInstr = (ExprStatement
(None
), [])
786 let noTypedefDef () = None
788 let emptyMetavarsBinding =
789 ([]: metavars_binding
)
791 let emptyAnnotCocci =
792 (Ast_cocci.CONTEXT
(Ast_cocci.NoPos
,Ast_cocci.NOTHING
),
793 ([] : metavars_binding list
))
796 (None
: (Ast_cocci.mcodekind
* metavars_binding list
) option)
798 (* compatibility mode *)
799 let mcode_and_env_of_cocciref aref
=
802 | None
-> emptyAnnotCocci
813 (* for include, some meta information needed by cocci *)
815 ref (None
: include_rel_pos
option)
820 (* When want add some info in ast that does not correspond to
821 * an existing C element.
822 * old: or when don't want 'synchronize' on it in unparse_c.ml
823 * (now have other mark for tha matter).
825 let no_virt_pos = ({str
="";charpos
=0;line
=0;column
=0;file
=""},-1)
828 { pinfo
= FakeTok
("",no_virt_pos);
829 cocci_tag
= ref emptyAnnot;
830 comments_tag
= ref emptyComments;
835 let noi_content = (None
: ((Common.filename
* program
) option))
837 (*****************************************************************************)
839 (*****************************************************************************)
844 let unwrap_expr ((unwrap_e
, typ
), iie
) = unwrap_e
845 let rewrap_expr ((_old_unwrap_e
, typ
), iie
) newe
= ((newe
, typ
), iie
)
847 let unwrap_typeC (qu
, (typeC
, ii
)) = typeC
848 let rewrap_typeC (qu
, (typeC
, ii
)) newtypeC
= (qu
, (newtypeC
, ii
))
850 let unwrap_typeCbis (typeC
, ii
) = typeC
852 let unwrap_st (unwrap_st, ii
) = unwrap_st
854 (* ------------------------------------------------------------------------- *)
855 let mk_e unwrap_e ii
= (unwrap_e
, noType()), ii
856 let mk_e_bis unwrap_e ty ii
= (unwrap_e
, ty
), ii
858 let mk_ty typeC ii
= nQ, (typeC
, ii
)
859 let mk_tybis typeC ii
= (typeC
, ii
)
861 let mk_st unwrap_st ii
= (unwrap_st, ii
)
863 (* ------------------------------------------------------------------------- *)
864 let get_ii_typeC_take_care (typeC
, ii
) = ii
865 let get_ii_st_take_care (st
, ii
) = ii
866 let get_ii_expr_take_care (e
, ii
) = ii
868 let get_st_and_ii (st
, ii
) = st
, ii
869 let get_ty_and_ii (qu
, (typeC
, ii
)) = qu
, (typeC
, ii
)
870 let get_e_and_ii (e
, ii
) = e
, ii
873 (* ------------------------------------------------------------------------- *)
874 let get_type_expr ((unwrap_e
, typ
), iie
) = !typ
875 let set_type_expr ((unwrap_e
, oldtyp
), iie
) newtyp
=
877 (* old: (unwrap_e, newtyp), iie *)
879 let get_onlytype_expr ((unwrap_e
, typ
), iie
) =
881 | Some
(ft
,_local
), _test
-> Some ft
884 let get_onlylocal_expr ((unwrap_e
, typ
), iie
) =
886 | Some
(ft
,local
), _test
-> Some local
889 (* ------------------------------------------------------------------------- *)
890 let rewrap_str s ii
=
893 OriginTok pi
-> OriginTok
{ pi
with Common.str
= s
;}
894 | ExpandedTok
(pi
,vpi
) -> ExpandedTok
({ pi
with Common.str
= s
;},vpi
)
895 | FakeTok
(_
,vpi
) -> FakeTok
(s
,vpi
)
896 | AbstractLineTok pi
-> OriginTok
{ pi
with Common.str
= s
;})}
898 let rewrap_pinfo pi ii
=
903 (* info about the current location *)
904 let get_pi = function
906 | ExpandedTok
(_
,(pi
,_
)) -> pi
907 | FakeTok
(_
,(pi
,_
)) -> pi
908 | AbstractLineTok pi
-> pi
911 let get_opi = function
913 | ExpandedTok
(pi
,_
) -> pi
(* diff with get_pi *)
914 | FakeTok
(_
,_
) -> failwith
"no position information"
915 | AbstractLineTok pi
-> pi
919 OriginTok pi
-> pi
.Common.str
920 | ExpandedTok
(pi
,_
) -> pi
.Common.str
922 | AbstractLineTok pi
-> pi
.Common.str
927 | ExpandedTok
(_
,(pi
,_
)) -> f pi
928 | FakeTok
(_
,(pi
,_
)) -> f pi
929 | AbstractLineTok pi
-> f pi
931 let get_orig_info f ii
=
934 | ExpandedTok
(pi
,_
) -> f pi
(* diff with get_info *)
935 | FakeTok
(_
,(pi
,_
)) -> f pi
936 | AbstractLineTok pi
-> f pi
938 let make_expanded ii
=
939 {ii
with pinfo
= ExpandedTok
(get_opi ii
.pinfo
,no_virt_pos)}
941 let pos_of_info ii
= get_info (function x
-> x
.Common.charpos
) ii
942 let opos_of_info ii
= get_orig_info (function x
-> x
.Common.charpos
) ii
943 let line_of_info ii
= get_orig_info (function x
-> x
.Common.line
) ii
944 let col_of_info ii
= get_orig_info (function x
-> x
.Common.column
) ii
945 let file_of_info ii
= get_orig_info (function x
-> x
.Common.file
) ii
946 let mcode_of_info ii
= fst
(mcode_and_env_of_cocciref ii
.cocci_tag
)
947 let pinfo_of_info ii
= ii
.pinfo
948 let parse_info_of_info ii
= get_pi ii
.pinfo
950 let strloc_of_info ii
=
951 spf
"%s:%d" (file_of_info ii
) (line_of_info ii
)
955 FakeTok
(_
,_
) -> true
958 let is_origintok ii
=
960 | OriginTok pi
-> true
963 (* ------------------------------------------------------------------------- *)
964 type posrv
= Real
of Common.parse_info
| Virt
of virtual_position
966 let compare_pos ii1 ii2
=
967 let get_pos = function
968 OriginTok pi
-> Real pi
969 | FakeTok
(s
,vpi
) -> Virt vpi
970 | ExpandedTok
(pi
,vpi
) -> Virt vpi
971 | AbstractLineTok pi
-> Real pi
in (* used for printing *)
972 let pos1 = get_pos (pinfo_of_info ii1
) in
973 let pos2 = get_pos (pinfo_of_info ii2
) in
974 match (pos1,pos2) with
975 (Real p1
, Real p2
) ->
976 compare p1
.Common.charpos p2
.Common.charpos
977 | (Virt
(p1
,_
), Real p2
) ->
978 if (compare p1
.Common.charpos p2
.Common.charpos
) =|= (-1) then (-1) else 1
979 | (Real p1
, Virt
(p2
,_
)) ->
980 if (compare p1
.Common.charpos p2
.Common.charpos
) =|= 1 then 1 else (-1)
981 | (Virt
(p1
,o1
), Virt
(p2
,o2
)) ->
982 let poi1 = p1
.Common.charpos
in
983 let poi2 = p2
.Common.charpos
in
984 match compare
poi1 poi2 with
989 let equal_posl (l1
,c1
) (l2
,c2
) =
990 (l1
=|= l2
) && (c1
=|= c2
)
992 let compare_posl (l1
,c1
) (l2
,c2
) =
997 let info_to_fixpos ii
=
998 match pinfo_of_info ii
with
999 OriginTok pi
-> Ast_cocci.Real pi
.Common.charpos
1000 | ExpandedTok
(_
,(pi
,offset
)) ->
1001 Ast_cocci.Virt
(pi
.Common.charpos
,offset
)
1002 | FakeTok
(_
,(pi
,offset
)) ->
1003 Ast_cocci.Virt
(pi
.Common.charpos
,offset
)
1004 | AbstractLineTok pi
-> failwith
"unexpected abstract"
1007 let is_test (e
: expression
) =
1008 let (_
,info
), _
= e
in
1009 let (_
,test
) = !info
in
1012 (*****************************************************************************)
1014 (*****************************************************************************)
1016 (* When we have extended the C Ast to add some info to the tokens,
1017 * such as its line number in the file, we can not use anymore the
1018 * ocaml '=' to compare Ast elements. To overcome this problem, to be
1019 * able to use again '=', we just have to get rid of all those extra
1020 * information, to "abstract those line" (al) information.
1022 * Julia then modifies it a little to have a tokenindex, so the original
1023 * true al_info is in fact real_al_info.
1026 let al_info tokenindex x
=
1029 {charpos
= tokenindex
;
1031 column
= tokenindex
;
1033 str
= str_of_info x
});
1034 cocci_tag
= ref emptyAnnot;
1035 comments_tag
= ref emptyComments;
1038 let semi_al_info x
=
1040 cocci_tag
= ref emptyAnnot;
1041 comments_tag
= ref emptyComments;
1044 let magic_real_number = -10
1046 let real_al_info x
=
1049 {charpos
= magic_real_number;
1050 line
= magic_real_number;
1051 column
= magic_real_number;
1053 str
= str_of_info x
});
1054 cocci_tag
= ref emptyAnnot;
1055 comments_tag
= ref emptyComments;
1060 List.filter
(function (Token_c.TCommentCpp _
,_
) -> true | _
-> false) l
in
1062 (x
,{i
with Common.charpos
= magic_real_number;
1063 Common.line
= magic_real_number;
1064 Common.column
= magic_real_number}) in
1065 {mbefore
= []; (* duplicates mafter of the previous token *)
1066 mafter
= List.map
al_com (keep_cpp x
.mafter
);
1071 let al_info_cpp tokenindex x
=
1074 {charpos
= tokenindex
;
1076 column
= tokenindex
;
1078 str
= str_of_info x
});
1079 cocci_tag
= ref emptyAnnot;
1080 comments_tag
= ref (al_comments !(x
.comments_tag
));
1083 let semi_al_info_cpp x
=
1085 cocci_tag
= ref emptyAnnot;
1086 comments_tag
= ref (al_comments !(x
.comments_tag
));
1089 let real_al_info_cpp x
=
1092 {charpos
= magic_real_number;
1093 line
= magic_real_number;
1094 column
= magic_real_number;
1096 str
= str_of_info x
});
1097 cocci_tag
= ref emptyAnnot;
1098 comments_tag
= ref (al_comments !(x
.comments_tag
));
1102 (*****************************************************************************)
1104 (*****************************************************************************)
1106 (* Transform a list of arguments (or parameters) where the commas are
1107 * represented via the wrap2 and associated with an element, with
1108 * a list where the comma are on their own. f(1,2,2) was
1109 * [(1,[]); (2,[,]); (2,[,])] and become [1;',';2;',';2].
1111 * Used in cocci_vs_c.ml, to have a more direct correspondance between
1112 * the ast_cocci of julia and ast_c.
1114 let rec (split_comma
: 'a wrap2 list
-> ('a
, il
) either list
) =
1119 then (Left e
)::split_comma xs
1120 else Right ii
::Left e
::split_comma xs
1122 let rec (unsplit_comma
: ('a
, il
) either list
-> 'a wrap2 list
) =
1125 | Right ii
::Left e
::xs
->
1126 (e
, ii
)::unsplit_comma xs
1128 let empty_ii = [] in
1129 (e
, empty_ii)::unsplit_comma xs
1136 (*****************************************************************************)
1137 (* Helpers, could also be put in lib_parsing_c.ml instead *)
1138 (*****************************************************************************)
1140 (* should maybe be in pretty_print_c ? *)
1142 let s_of_inc_file inc_file
=
1144 | Local xs
-> xs
+> Common.join
"/"
1145 | NonLocal xs
-> xs
+> Common.join
"/"
1148 let s_of_inc_file_bis inc_file
=
1150 | Local xs
-> "\"" ^ xs
+> Common.join
"/" ^
"\""
1151 | NonLocal xs
-> "<" ^ xs
+> Common.join
"/" ^
">"
1154 let fieldname_of_fieldkind fieldkind
=
1155 match fieldkind
with
1156 | Simple
(sopt
, ft
) -> sopt
1157 | BitField
(sopt
, ft
, info
, expr
) -> sopt
1160 let s_of_attr attr
=
1162 +> List.map
(fun (Attribute s
, ii
) -> s
)
1166 (* ------------------------------------------------------------------------- *)
1167 let str_of_name ident
=
1169 | RegularName
(s
,ii
) -> s
1170 | CppConcatenatedName xs
->
1171 xs
+> List.map
(fun (x
,iiop
) -> unwrap x
) +> Common.join
"##"
1172 | CppVariadicName
(s
, ii
) -> "##" ^ s
1173 | CppIdentBuilder
((s
,iis
), xs
) ->
1175 (xs
+> List.map
(fun ((x
,iix
), iicomma
) -> x
) +> Common.join
",") ^
1178 let get_s_and_ii_of_name name
=
1180 | RegularName
(s
, iis
) -> s
, iis
1181 | CppIdentBuilder
((s
, iis
), xs
) -> s
, iis
1182 | CppVariadicName
(s
,iis
) ->
1183 let (iop
, iis
) = Common.tuple_of_list2 iis
in
1185 | CppConcatenatedName xs
->
1187 | [] -> raise Impossible
1188 | ((s
,iis
),noiiop
)::xs
->
1192 let get_s_and_info_of_name name
=
1193 let (s
,ii
) = get_s_and_ii_of_name name
in
1196 let info_of_name name
=
1197 let (s
,ii
) = get_s_and_ii_of_name name
in
1200 let ii_of_name name
=
1201 let (s
,ii
) = get_s_and_ii_of_name name
in
1204 let get_local_ii_of_expr_inlining_ii_of_name e
=
1205 let (ebis
,_
),ii
= e
in
1207 | Ident name
, noii ->
1210 | RecordAccess
(e
, name
), ii
->
1211 ii
@ ii_of_name name
1212 | RecordPtAccess
(e
, name
), ii
->
1213 ii
@ ii_of_name name
1217 let get_local_ii_of_tybis_inlining_ii_of_name ty
=
1219 | TypeName
(name
, _typ
), [] -> ii_of_name name
1222 (* the following is used to obtain the argument to LocalVar *)
1223 let info_of_type ft
=
1224 let (qu
, ty
) = ft
in
1225 (* bugfix: because of string->name, the ii can be deeper *)
1226 let ii = get_local_ii_of_tybis_inlining_ii_of_name ty
in
1228 | ii::_
-> Some
ii.pinfo
1231 (* only Label and Goto have name *)
1232 let get_local_ii_of_st_inlining_ii_of_name st
=
1234 | Labeled
(Label
(name
, st
)), ii -> ii_of_name name
@ ii
1235 | Jump
(Goto name
), ii ->
1236 let (i1
, i3
) = Common.tuple_of_list2
ii in
1237 [i1
] @ ii_of_name name
@ [i3
]
1242 (* ------------------------------------------------------------------------- *)
1243 let name_of_parameter param
=
1244 param
.p_namei
+> Common.map_option
(str_of_name)