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