helm/software/components/acic_content/cicNotationUtil.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 val fresh_name: unit -> string
  27
  28 val variables_of_term: CicNotationPt.term -> CicNotationPt.pattern_variable list
  29 val names_of_term: CicNotationPt.term -> string list
  30
  31   (** extract all keywords (i.e. string literals) from a level 1 pattern *)
  32 val keywords_of_term: CicNotationPt.term -> string list
  33
  34 val visit_ast:
  35   ?special_k:(CicNotationPt.term -> CicNotationPt.term) ->
  36   ?map_xref_option:(CicNotationPt.href option -> CicNotationPt.href option) ->
  37   ?map_case_indty:(CicNotationPt.case_indtype option ->
  38           CicNotationPt.case_indtype option) ->
  39   ?map_case_outtype:((CicNotationPt.term -> CicNotationPt.term) ->
  40                      CicNotationPt.term option -> CicNotationPt.term
  41   option) ->
  42   (CicNotationPt.term -> CicNotationPt.term) ->
  43   CicNotationPt.term ->
  44     CicNotationPt.term
  45
  46 val visit_layout:
  47   (CicNotationPt.term -> CicNotationPt.term) ->
  48   CicNotationPt.layout_pattern ->
  49     CicNotationPt.layout_pattern
  50
  51 val visit_magic:
  52   (CicNotationPt.term -> CicNotationPt.term) ->
  53   CicNotationPt.magic_term ->
  54     CicNotationPt.magic_term
  55
  56 val visit_variable:
  57   (CicNotationPt.term -> CicNotationPt.term) ->
  58   CicNotationPt.pattern_variable ->
  59     CicNotationPt.pattern_variable
  60
  61 val strip_attributes: CicNotationPt.term -> CicNotationPt.term
  62
  63   (** @return the list of proper (i.e. non recursive) IdRef of a term *)
  64 val get_idrefs: CicNotationPt.term -> string list
  65
  66   (** generalization of List.combine to n lists *)
  67 val ncombine: 'a list list -> 'a list list
  68
  69 val string_of_literal: CicNotationPt.literal -> string
  70
  71 val dress:  sep:'a -> 'a list -> 'a list
  72 val dressn: sep:'a list -> 'a list -> 'a list
  73
  74 val boxify: CicNotationPt.term list -> CicNotationPt.term
  75 val group: CicNotationPt.term list -> CicNotationPt.term
  76 val ungroup: CicNotationPt.term list -> CicNotationPt.term list
  77
  78 val find_appl_pattern_uris:
  79   CicNotationPt.cic_appl_pattern ->
  80    [`Uri of UriManager.uri | `NRef of NReference.reference] list
  81
  82 val find_branch:
  83   CicNotationPt.term -> CicNotationPt.term
  84
  85 val cic_name_of_name: CicNotationPt.term -> Cic.name
  86 val name_of_cic_name: Cic.name -> CicNotationPt.term
  87
  88   (** Symbol/Numbers instances *)
  89
  90 val freshen_term: CicNotationPt.term -> CicNotationPt.term
  91 val freshen_obj: CicNotationPt.term CicNotationPt.obj -> CicNotationPt.term CicNotationPt.obj
  92
  93   (** Notation id handling *)
  94
  95 type notation_id
  96
  97 val fresh_id: unit -> notation_id
  98