helm/ocaml/cic_notation/cicNotationMatcher.mli

   1 (* Copyright (C) 2004-2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM 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.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 type pattern_kind = Variable | Constructor
  27 type tag_t = int
  28
  29 module type PATTERN =
  30 sig
  31   type pattern_t
  32   type term_t
  33
  34   val classify : pattern_t -> pattern_kind
  35   val tag_of_pattern : pattern_t -> tag_t * pattern_t list
  36   val tag_of_term : term_t -> tag_t * term_t list
  37
  38   (** {3 Debugging} *)
  39   val string_of_term: term_t -> string
  40   val string_of_pattern: pattern_t -> string
  41 end
  42
  43 module Matcher (P: PATTERN) :
  44 sig
  45   (** @param patterns pattern matrix (pairs <pattern, pattern_id>)
  46    * @param success_cb callback invoked in case of matching.
  47    *  Its argument are the list of pattern who matches the input term, the list
  48    *  of terms bound in them, the list of terms which matched constructors.
  49    *  Its return value is Some _ if the matching is valid, None otherwise; the
  50    *  latter kind of return value will trigger backtracking in the pattern
  51    *  matching algorithm
  52    * @param failure_cb callback invoked in case of matching failure
  53    * @param term term on which pattern match on *)
  54   val compiler:
  55     (P.pattern_t * int) list ->
  56     ((P.pattern_t list * int) list -> P.term_t list -> P.term_t list ->
  57       'a option) ->                   (* terms *)    (* constructors *)
  58     (unit -> 'a option) ->
  59       (P.term_t -> 'a option)
  60 end
  61
  62 module Matcher21:
  63 sig
  64   (** @param l2_patterns level 2 (AST) patterns *)
  65   val compiler :
  66     (CicNotationPt.term * int) list ->
  67       (CicNotationPt.term ->
  68         (CicNotationEnv.t * CicNotationPt.term list * int) option)
  69 end
  70
  71 module Matcher32:
  72 sig
  73   (** @param l3_patterns level 3 (CIC) patterns (AKA cic_appl_pattern) *)
  74   val compiler :
  75     (CicNotationPt.cic_appl_pattern * int) list ->
  76       (Cic.annterm ->
  77         ((string * Cic.annterm) list * Cic.annterm list * int) option)
  78 end
  79