Coccinelle release-1.0.0-rc11

[bpt/coccinelle.git] / ctl / ast_ctl.ml

(*
 * 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 <http://www.gnu.org/licenses/>.
 *
 * The authors reserve the right to distribute this or future versions of
 * Coccinelle under other licenses.
 *)



(* ---------------------------------------------------------------------- *)
(* Types                                                                  *)
(* ---------------------------------------------------------------------- *)

type strict = STRICT | NONSTRICT

type keep_binding = bool (* true = put in witness tree *)

(* CTL parameterised on basic predicates and metavar's*)
type ('pred,'mvar,'anno) generic_ctl =
  | False
  | True
  | Pred of 'pred
  | Not of (('pred,'mvar,'anno) generic_ctl)
  | Exists of keep_binding * 'mvar * (('pred,'mvar,'anno) generic_ctl)
  | And of strict * (('pred,'mvar,'anno) generic_ctl) *
      (('pred,'mvar,'anno) generic_ctl)
  | AndAny of direction * strict * (('pred,'mvar,'anno) generic_ctl) *
      (('pred,'mvar,'anno) generic_ctl)
  | HackForStmt of direction * strict * (('pred,'mvar,'anno) generic_ctl) *
      (('pred,'mvar,'anno) generic_ctl)
  | Or  of (('pred,'mvar,'anno) generic_ctl) *
      (('pred,'mvar,'anno) generic_ctl)
  | Implies of (('pred,'mvar,'anno) generic_ctl) *
      (('pred,'mvar,'anno) generic_ctl)
  | AF of direction * strict * (('pred,'mvar,'anno) generic_ctl)
  | AX of direction * strict * (('pred,'mvar,'anno) generic_ctl)
  | AG of direction * strict * (('pred,'mvar,'anno) generic_ctl)
  | AW of direction * strict *
	(* versions with exists v *)
	(('pred,'mvar,'anno) generic_ctl) * (('pred,'mvar,'anno) generic_ctl)
  | AU of direction * strict *
	(* versions with exists v *)
	(('pred,'mvar,'anno) generic_ctl) * (('pred,'mvar,'anno) generic_ctl)
  | EF of direction * (('pred,'mvar,'anno) generic_ctl)
  | EX of direction * (('pred,'mvar,'anno) generic_ctl)
  | EG of direction * (('pred,'mvar,'anno) generic_ctl)
  | EU of direction * (('pred,'mvar,'anno) generic_ctl) *
      (('pred,'mvar,'anno) generic_ctl)
  | Let of string *
      (('pred,'mvar,'anno) generic_ctl) *
      (('pred,'mvar,'anno) generic_ctl)
  | LetR of direction * string * (* evals phi1 wrt reachable states *)
      (('pred,'mvar,'anno) generic_ctl) *
      (('pred,'mvar,'anno) generic_ctl)
  | Ref of string
  | SeqOr of (('pred,'mvar,'anno) generic_ctl) *
      (('pred,'mvar,'anno) generic_ctl)
  | Uncheck of (('pred,'mvar,'anno) generic_ctl)
  | InnerAnd of (('pred,'mvar,'anno) generic_ctl)
  | XX of (('pred,'mvar,'anno) generic_ctl) (* fake, used in asttoctl *)

and direction = FORWARD (* the normal way *) | BACKWARD (* toward the start *)

let unwrap (ctl,_) = ctl
let rewrap (_,model) ctl = (ctl,model)
let get_line (_,l) = l


(* NOTE: No explicit representation of the bottom subst., i.e., FALSE *)
type ('mvar,'value) generic_subst =
  | Subst of 'mvar * 'value
  | NegSubst of 'mvar * 'value
type ('mvar,'value) generic_substitution = ('mvar,'value) generic_subst list

type ('state,'subst,'anno) generic_witnesstree =
    Wit of
      'state * 'subst * 'anno * ('state,'subst,'anno) generic_witnesstree list
  | NegWit of ('state,'subst,'anno) generic_witnesstree

(* ---------------------------------------------------------------------- *)

type 'a modif = Modif of 'a | UnModif of 'a | Control

(* ---------------------------------------------------------------------- *)