(* * Copyright 2012, INRIA * Julia Lawall, Gilles Muller * Copyright 2010-2011, INRIA, University of Copenhagen * Julia Lawall, Rene Rydhof Hansen, Gilles Muller, Nicolas Palix * Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix * This file is part of Coccinelle. * * Coccinelle is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, according to version 2 of the License. * * Coccinelle is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Coccinelle. If not, see . * * The authors reserve the right to distribute this or future versions of * Coccinelle under other licenses. *) # 0 "./ast_cocci.mli" (* --------------------------------------------------------------------- *) (* Modified code *) type added_string = Noindent of string | Indent of string | Space of string type info = { line : int; column : int; strbef : (added_string * int (* line *) * int (* col *)) list; straft : (added_string * int (* line *) * int (* col *)) list } type line = int type meta_name = string * string type 'a wrap = {node : 'a; node_line : line; free_vars : meta_name list; (*free vars*) minus_free_vars : meta_name list; (*minus free vars*) fresh_vars : (meta_name * seed) list; (*fresh vars*) inherited : meta_name list; (*inherited vars*) saved_witness : meta_name list; (*witness vars*) bef_aft : dots_bef_aft; pos_info : meta_name mcode option; (* pos info, try not to duplicate *) true_if_test_exp : bool;(* true if "test_exp from iso", only for exprs *) (* the following is only for declarations *) safe_for_multi_decls : bool; (* isos relevant to the term; ultimately only used for rule_elems *) iso_info : (string*anything) list } and 'a befaft = BEFORE of 'a list list * count | AFTER of 'a list list * count | BEFOREAFTER of 'a list list * 'a list list * count | NOTHING and 'a replacement = REPLACEMENT of 'a list list * count | NOREPLACEMENT and 'a mcode = 'a * info * mcodekind * meta_pos list (* pos variables *) (* pos is an offset indicating where in the C code the mcodekind has an effect *) and adjacency = ALLMINUS | ADJ of int and mcodekind = MINUS of pos * int list * adjacency * anything replacement | CONTEXT of pos * anything befaft | PLUS of count and count = ONE (* + *) | MANY (* ++ *) and fixpos = Real of int (* charpos *) | Virt of int * int (* charpos + offset *) and pos = NoPos | DontCarePos | FixPos of (fixpos * fixpos) and dots_bef_aft = NoDots | AddingBetweenDots of statement * int (*index of let var*) | DroppingBetweenDots of statement * int (*index of let var*) and inherited = Type_cocci.inherited and keep_binding = Type_cocci.keep_binding and multi = bool (*true if a nest is one or more, false if it is zero or more*) and end_info = meta_name list (*free vars*) * (meta_name * seed) list (*fresh*) * meta_name list (*inherited vars*) * mcodekind (* --------------------------------------------------------------------- *) (* Metavariables *) and arity = UNIQUE | OPT | MULTI | NONE and metavar = MetaMetaDecl of arity * meta_name (* name *) | MetaIdDecl of arity * meta_name (* name *) | MetaFreshIdDecl of meta_name (* name *) * seed (* seed *) | MetaTypeDecl of arity * meta_name (* name *) | MetaInitDecl of arity * meta_name (* name *) | MetaInitListDecl of arity * meta_name (* name *) * list_len (*len*) | MetaListlenDecl of meta_name (* name *) | MetaParamDecl of arity * meta_name (* name *) | MetaParamListDecl of arity * meta_name (*name*) * list_len (*len*) | MetaConstDecl of arity * meta_name (* name *) * Type_cocci.typeC list option | MetaErrDecl of arity * meta_name (* name *) | MetaExpDecl of arity * meta_name (* name *) * Type_cocci.typeC list option | MetaIdExpDecl of arity * meta_name (* name *) * Type_cocci.typeC list option | MetaLocalIdExpDecl of arity * meta_name (* name *) * Type_cocci.typeC list option | MetaExpListDecl of arity * meta_name (*name*) * list_len (*len*) | MetaDeclDecl of arity * meta_name (* name *) | MetaFieldDecl of arity * meta_name (* name *) | MetaFieldListDecl of arity * meta_name (* name *) * list_len (*len*) | MetaStmDecl of arity * meta_name (* name *) | MetaStmListDecl of arity * meta_name (* name *) | MetaFuncDecl of arity * meta_name (* name *) | MetaLocalFuncDecl of arity * meta_name (* name *) | MetaPosDecl of arity * meta_name (* name *) | MetaAnalysisDecl of string * meta_name (* name *) | MetaDeclarerDecl of arity * meta_name (* name *) | MetaIteratorDecl of arity * meta_name (* name *) and list_len = AnyLen | MetaLen of meta_name | CstLen of int and seed = NoVal | StringSeed of string | ListSeed of seed_elem list and seed_elem = SeedString of string | SeedId of meta_name (* --------------------------------------------------------------------- *) (* --------------------------------------------------------------------- *) (* Dots *) and 'a base_dots = DOTS of 'a list | CIRCLES of 'a list | STARS of 'a list and 'a dots = 'a base_dots wrap (* --------------------------------------------------------------------- *) (* Identifier *) and base_ident = Id of string mcode | MetaId of meta_name mcode * idconstraint * keep_binding * inherited | MetaFunc of meta_name mcode * idconstraint * keep_binding * inherited | MetaLocalFunc of meta_name mcode * idconstraint * keep_binding * inherited | AsIdent of ident * ident (* as ident, always metavar *) | DisjId of ident list | OptIdent of ident | UniqueIdent of ident and ident = base_ident wrap (* --------------------------------------------------------------------- *) (* Expression *) and base_expression = Ident of ident | Constant of constant mcode | FunCall of expression * string mcode (* ( *) * expression dots * string mcode (* ) *) | Assignment of expression * assignOp mcode * expression * bool | Sequence of expression * string mcode (* , *) * expression | CondExpr of expression * string mcode (* ? *) * expression option * string mcode (* : *) * expression | Postfix of expression * fixOp mcode | Infix of expression * fixOp mcode | Unary of expression * unaryOp mcode | Binary of expression * binaryOp mcode * expression | Nested of expression * binaryOp mcode * expression | ArrayAccess of expression * string mcode (* [ *) * expression * string mcode (* ] *) | RecordAccess of expression * string mcode (* . *) * ident | RecordPtAccess of expression * string mcode (* -> *) * ident | Cast of string mcode (* ( *) * fullType * string mcode (* ) *) * expression | SizeOfExpr of string mcode (* sizeof *) * expression | SizeOfType of string mcode (* sizeof *) * string mcode (* ( *) * fullType * string mcode (* ) *) | TypeExp of fullType | Paren of string mcode (* ( *) * expression * string mcode (* ) *) | Constructor of string mcode (* ( *) * fullType * string mcode (* ) *) * initialiser | MetaErr of meta_name mcode * constraints * keep_binding * inherited | MetaExpr of meta_name mcode * constraints * keep_binding * Type_cocci.typeC list option * form * inherited | MetaExprList of meta_name mcode * listlen * keep_binding * inherited (* only in arg lists *) | AsExpr of expression * expression (* as expr, always metavar *) | EComma of string mcode (* only in arg lists *) | DisjExpr of expression list | NestExpr of string mcode (* <.../<+... *) * expression dots * string mcode (* ...>/...+> *) * expression option * multi (* can appear in arg lists, and also inside Nest, as in: if(< ... X ... Y ...>) In the following, the expression option is the WHEN *) | Edots of string mcode (* ... *) * expression option | Ecircles of string mcode (* ooo *) * expression option | Estars of string mcode (* *** *) * expression option | OptExp of expression | UniqueExp of expression and constraints = NoConstraint | NotIdCstrt of reconstraint | NotExpCstrt of expression list | SubExpCstrt of meta_name list (* Constraints on Meta-* Identifiers, Functions *) and idconstraint = IdNoConstraint | IdNegIdSet of string list * meta_name list | IdRegExpConstraint of reconstraint and reconstraint = | IdRegExp of string * Regexp.regexp | IdNotRegExp of string * Regexp.regexp and form = ANY | ID | LocalID | CONST (* form for MetaExp *) and expression = base_expression wrap and listlen = MetaListLen of meta_name mcode * keep_binding * inherited | CstListLen of int | AnyListLen and unaryOp = GetRef | GetRefLabel | DeRef | UnPlus | UnMinus | Tilde | Not and assignOp = SimpleAssign | OpAssign of arithOp and fixOp = Dec | Inc and binaryOp = Arith of arithOp | Logical of logicalOp and arithOp = Plus | Minus | Mul | Div | Mod | DecLeft | DecRight | And | Or | Xor | Min | Max and logicalOp = Inf | Sup | InfEq | SupEq | Eq | NotEq | AndLog | OrLog and constant = String of string | Char of string | Int of string | Float of string (* --------------------------------------------------------------------- *) (* Types *) and base_fullType = Type of bool (* true if all minus *) * const_vol mcode option * typeC | AsType of fullType * fullType (* as type, always metavar *) | DisjType of fullType list (* only after iso *) | OptType of fullType | UniqueType of fullType and base_typeC = BaseType of baseType * string mcode list (* Yoann style *) | SignedT of sign mcode * typeC option | Pointer of fullType * string mcode (* * *) | FunctionPointer of fullType * string mcode(* ( *)*string mcode(* * *)*string mcode(* ) *)* string mcode (* ( *)*parameter_list*string mcode(* ) *) | FunctionType of bool (* true if all minus for dropping return type *) * fullType option * string mcode (* ( *) * parameter_list * string mcode (* ) *) | Array of fullType * string mcode (* [ *) * expression option * string mcode (* ] *) | EnumName of string mcode (*enum*) * ident option (* name *) | EnumDef of fullType (* either EnumName or metavar *) * string mcode (* { *) * expression dots * string mcode (* } *) | StructUnionName of structUnion mcode * ident option (* name *) | StructUnionDef of fullType (* either StructUnionName or metavar *) * string mcode (* { *) * declaration dots * string mcode (* } *) | TypeName of string mcode | MetaType of meta_name mcode * keep_binding * inherited and fullType = base_fullType wrap and typeC = base_typeC wrap and baseType = VoidType | CharType | ShortType | ShortIntType | IntType | DoubleType | LongDoubleType | FloatType | LongType | LongIntType | LongLongType | LongLongIntType | SizeType | SSizeType | PtrDiffType and structUnion = Struct | Union and sign = Signed | Unsigned and const_vol = Const | Volatile (* --------------------------------------------------------------------- *) (* Variable declaration *) (* Even if the Cocci program specifies a list of declarations, they are split out into multiple declarations of a single variable each. *) and base_declaration = Init of storage mcode option * fullType * ident * string mcode (*=*) * initialiser * string mcode (*;*) | UnInit of storage mcode option * fullType * ident * string mcode (* ; *) | TyDecl of fullType * string mcode (* ; *) | MacroDecl of ident (* name *) * string mcode (* ( *) * expression dots * string mcode (* ) *) * string mcode (* ; *) | MacroDeclInit of ident (* name *) * string mcode (* ( *) * expression dots * string mcode (* ) *) * string mcode (*=*) * initialiser * string mcode (* ; *) | Typedef of string mcode (*typedef*) * fullType * typeC * string mcode (*;*) | DisjDecl of declaration list | Ddots of string mcode (* ... *) * declaration option (* whencode *) | MetaDecl of meta_name mcode * keep_binding * inherited | MetaField of meta_name mcode * keep_binding * inherited | MetaFieldList of meta_name mcode * listlen * keep_binding * inherited | AsDecl of declaration * declaration | OptDecl of declaration | UniqueDecl of declaration and declaration = base_declaration wrap (* --------------------------------------------------------------------- *) (* Initializers *) and base_initialiser = MetaInit of meta_name mcode * keep_binding * inherited | MetaInitList of meta_name mcode * listlen * keep_binding * inherited | AsInit of initialiser * initialiser (* as init, always metavar *) | InitExpr of expression | ArInitList of string mcode (*{*) * initialiser dots * string mcode (*}*) | StrInitList of bool (* true if all are - *) * string mcode (*{*) * initialiser list * string mcode (*}*) * initialiser list (* whencode: elements that shouldn't appear in init *) | InitGccExt of designator list (* name *) * string mcode (*=*) * initialiser (* gccext: *) | InitGccName of ident (* name *) * string mcode (*:*) * initialiser | IComma of string mcode (* , *) | Idots of string mcode (* ... *) * initialiser option (* whencode *) | OptIni of initialiser | UniqueIni of initialiser and designator = DesignatorField of string mcode (* . *) * ident | DesignatorIndex of string mcode (* [ *) * expression * string mcode (* ] *) | DesignatorRange of string mcode (* [ *) * expression * string mcode (* ... *) * expression * string mcode (* ] *) and initialiser = base_initialiser wrap (* --------------------------------------------------------------------- *) (* Parameter *) and base_parameterTypeDef = VoidParam of fullType | Param of fullType * ident option | MetaParam of meta_name mcode * keep_binding * inherited | MetaParamList of meta_name mcode * listlen * keep_binding * inherited | AsParam of parameterTypeDef * expression (* expr, always metavar *) | PComma of string mcode | Pdots of string mcode (* ... *) | Pcircles of string mcode (* ooo *) | OptParam of parameterTypeDef | UniqueParam of parameterTypeDef and parameterTypeDef = base_parameterTypeDef wrap and parameter_list = parameterTypeDef dots (* --------------------------------------------------------------------- *) (* #define Parameters *) and base_define_param = DParam of ident | DPComma of string mcode | DPdots of string mcode (* ... *) | DPcircles of string mcode (* ooo *) | OptDParam of define_param | UniqueDParam of define_param and define_param = base_define_param wrap and base_define_parameters = NoParams | DParams of string mcode(*( *) * define_param dots * string mcode(* )*) and define_parameters = base_define_parameters wrap (* --------------------------------------------------------------------- *) (* positions *) (* PER = keep bindings separate, ANY = collect them *) and meta_collect = PER | ALL and meta_pos = MetaPos of meta_name mcode * meta_name list * meta_collect * keep_binding * inherited (* --------------------------------------------------------------------- *) (* Function declaration *) and storage = Static | Auto | Register | Extern (* --------------------------------------------------------------------- *) (* Top-level code *) and base_rule_elem = FunHeader of mcodekind (* before the function header *) * bool (* true if all minus, for dropping static, etc *) * fninfo list * ident (* name *) * string mcode (* ( *) * parameter_list * string mcode (* ) *) | Decl of mcodekind (* before the decl *) * bool (* true if all minus *) * declaration | SeqStart of string mcode (* { *) | SeqEnd of string mcode (* } *) | ExprStatement of expression option * string mcode (*;*) | IfHeader of string mcode (* if *) * string mcode (* ( *) * expression * string mcode (* ) *) | Else of string mcode (* else *) | WhileHeader of string mcode (* while *) * string mcode (* ( *) * expression * string mcode (* ) *) | DoHeader of string mcode (* do *) | WhileTail of string mcode (* while *) * string mcode (* ( *) * expression * string mcode (* ) *) * string mcode (* ; *) | ForHeader of string mcode (* for *) * string mcode (* ( *) * forinfo * expression option * string mcode (*;*) * expression option * string mcode (* ) *) | IteratorHeader of ident (* name *) * string mcode (* ( *) * expression dots * string mcode (* ) *) | SwitchHeader of string mcode (* switch *) * string mcode (* ( *) * expression * string mcode (* ) *) | Break of string mcode (* break *) * string mcode (* ; *) | Continue of string mcode (* continue *) * string mcode (* ; *) | Label of ident * string mcode (* : *) | Goto of string mcode (* goto *) * ident * string mcode (* ; *) | Return of string mcode (* return *) * string mcode (* ; *) | ReturnExpr of string mcode (* return *) * expression * string mcode (* ; *) | MetaRuleElem of meta_name mcode * keep_binding * inherited | MetaStmt of meta_name mcode * keep_binding * metaStmtInfo * inherited | MetaStmtList of meta_name mcode * keep_binding * inherited | Exp of expression | TopExp of expression (* for macros body *) | Ty of fullType (* only at top level *) | TopInit of initialiser (* only at top level *) | Include of string mcode (*#include*) * inc_file mcode (*file *) | Undef of string mcode (* #define *) * ident (* name *) | DefineHeader of string mcode (* #define *) * ident (* name *) * define_parameters (*params*) | Case of string mcode (* case *) * expression * string mcode (*:*) | Default of string mcode (* default *) * string mcode (*:*) | DisjRuleElem of rule_elem list and forinfo = ForExp of expression option * string mcode (*;*) | ForDecl of mcodekind (* before the decl *) * bool (* true if all minus *) * declaration and fninfo = FStorage of storage mcode | FType of fullType | FInline of string mcode | FAttr of string mcode and metaStmtInfo = NotSequencible | SequencibleAfterDots of dots_whencode list | Sequencible and rule_elem = base_rule_elem wrap and base_statement = Seq of rule_elem (* { *) * statement dots * rule_elem (* } *) | IfThen of rule_elem (* header *) * statement * end_info | IfThenElse of rule_elem (* header *) * statement * rule_elem (* else *) * statement * end_info | While of rule_elem (* header *) * statement * end_info | Do of rule_elem (* do *) * statement * rule_elem (* tail *) | For of rule_elem (* header *) * statement * end_info | Iterator of rule_elem (* header *) * statement * end_info (*enditer*) | Switch of rule_elem (* header *) * rule_elem (* { *) * statement (*decl*) dots * case_line list * rule_elem(*}*) | Atomic of rule_elem | Disj of statement dots list | Nest of string mcode (* <.../<+... *) * statement dots * string mcode (* ...>/...+> *) * (statement dots,statement) whencode list * multi * dots_whencode list * dots_whencode list | FunDecl of rule_elem (* header *) * rule_elem (* { *) * statement dots * rule_elem (* } *) | Define of rule_elem (* header *) * statement dots | AsStmt of statement * statement (* as statement, always metavar *) | Dots of string mcode (* ... *) * (statement dots,statement) whencode list * dots_whencode list * dots_whencode list | Circles of string mcode (* ooo *) * (statement dots,statement) whencode list * dots_whencode list * dots_whencode list | Stars of string mcode (* *** *) * (statement dots,statement) whencode list * dots_whencode list * dots_whencode list | OptStm of statement | UniqueStm of statement and ('a,'b) whencode = WhenNot of 'a | WhenAlways of 'b | WhenModifier of when_modifier | WhenNotTrue of rule_elem | WhenNotFalse of rule_elem and when_modifier = WhenAny | WhenStrict | WhenForall | WhenExists and dots_whencode = WParen of rule_elem * meta_name (*pren_var*) | Other of statement | Other_dots of statement dots and statement = base_statement wrap and base_case_line = CaseLine of rule_elem (* case/default header *) * statement dots | OptCase of case_line and case_line = base_case_line wrap and inc_file = Local of inc_elem list | NonLocal of inc_elem list and inc_elem = IncPath of string | IncDots and base_top_level = NONDECL of statement (* cannot match all of a top-level declaration *) | CODE of statement dots | FILEINFO of string mcode (* old file *) * string mcode (* new file *) | ERRORWORDS of expression list and top_level = base_top_level wrap and rulename = CocciRulename of string option * dependency * string list * string list * exists * bool (* true if the whole thing is an expression *) | GeneratedRulename of string option * dependency * string list * string list * exists * bool (* true if the whole thing is an expression *) | ScriptRulename of string option (* name *) * string (* language *) * dependency | InitialScriptRulename of string option (* name *) * string (* language *) * dependency | FinalScriptRulename of string option (* name *) * string (* language *) * dependency and ruletype = Normal | Generated and rule = CocciRule of string (* name *) * (dependency * string list (* dropped isos *) * exists) * top_level list * bool list (* true if generates an exp *) * ruletype | ScriptRule of string (* name *) * string * dependency * (script_meta_name * meta_name * metavar) list * meta_name list (*script vars*) * string | InitialScriptRule of string (* name *) * string * dependency * string | FinalScriptRule of string (* name *) * string * dependency * string and script_meta_name = string option (*string*) * string option (*ast*) and dependency = Dep of string (* rule applies for the current binding *) | AntiDep of string (* rule doesn't apply for the current binding *) | EverDep of string (* rule applies for some binding *) | NeverDep of string (* rule never applies for any binding *) | AndDep of dependency * dependency | OrDep of dependency * dependency | NoDep | FailDep and rule_with_metavars = metavar list * rule and anything = FullTypeTag of fullType | BaseTypeTag of baseType | StructUnionTag of structUnion | SignTag of sign | IdentTag of ident | ExpressionTag of expression | ConstantTag of constant | UnaryOpTag of unaryOp | AssignOpTag of assignOp | FixOpTag of fixOp | BinaryOpTag of binaryOp | ArithOpTag of arithOp | LogicalOpTag of logicalOp | DeclarationTag of declaration | InitTag of initialiser | StorageTag of storage | IncFileTag of inc_file | Rule_elemTag of rule_elem | StatementTag of statement | ForInfoTag of forinfo | CaseLineTag of case_line | ConstVolTag of const_vol | Token of string * info option | Pragma of added_string list | Code of top_level | ExprDotsTag of expression dots | ParamDotsTag of parameterTypeDef dots | StmtDotsTag of statement dots | DeclDotsTag of declaration dots | TypeCTag of typeC | ParamTag of parameterTypeDef | SgrepStartTag of string | SgrepEndTag of string (* --------------------------------------------------------------------- *) and exists = Exists | Forall | Undetermined (* --------------------------------------------------------------------- *) val mkToken : string -> anything val undots : 'a dots -> 'a list val lub_count : count -> count -> count (* --------------------------------------------------------------------- *) val rewrap : 'a wrap -> 'b -> 'b wrap val rewrap_mcode : 'a mcode -> 'a -> 'a mcode val unwrap : 'a wrap -> 'a val unwrap_mcode : 'a mcode -> 'a val get_mcodekind : 'a mcode -> mcodekind val get_line : 'a wrap -> line val get_mcode_line : 'a mcode -> line val get_mcode_col : 'a mcode -> int val get_fvs : 'a wrap -> meta_name list val get_wcfvs : ('a wrap,'b wrap) whencode list -> meta_name list val set_fvs : meta_name list -> 'a wrap -> 'a wrap val get_mfvs : 'a wrap -> meta_name list val set_mfvs : meta_name list -> 'a wrap -> 'a wrap val get_fresh : 'a wrap -> (meta_name * seed) list val get_inherited : 'a wrap -> meta_name list val get_saved : 'a wrap -> meta_name list val get_dots_bef_aft : statement -> dots_bef_aft val set_dots_bef_aft : dots_bef_aft -> statement -> statement val get_pos : 'a wrap -> meta_name mcode option val set_pos : 'a wrap -> meta_name mcode option -> 'a wrap val get_test_exp : 'a wrap -> bool val set_test_exp : expression -> expression val get_safe_decl : 'a wrap -> bool val get_isos : 'a wrap -> (string*anything) list val set_isos : 'a wrap -> (string*anything) list -> 'a wrap val get_pos_var : 'a mcode -> meta_pos list val set_pos_var : meta_pos list -> 'a mcode -> 'a mcode val drop_pos : 'a mcode -> 'a mcode val get_meta_name : metavar -> meta_name val tag2c : anything -> string val no_info : info val make_meta_rule_elem : string -> mcodekind -> (meta_name list * (meta_name * seed) list * meta_name list) -> rule_elem val make_meta_decl : string -> mcodekind -> (meta_name list * (meta_name * seed) list * meta_name list) -> declaration val make_term : 'a -> 'a wrap val make_inherited_term : 'a -> meta_name list (* inherited vars *) -> 'a wrap val make_mcode : 'a -> 'a mcode val equal_pos : fixpos -> fixpos -> bool