helm/software/components/acic_content/cicNotationPp.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 (** ZACK
  27  * This module does not print terms and object properly, it has been created
  28  * mainly for debugging reason. There is no guarantee that printed strings are
  29  * re-parsable. Moreover, actually there is no way at all to proper print
  30  * objects in a way that is re-parsable.
  31  *
  32  * TODO the proper implementation of a pp_obj function like the one below should
  33  * be as follows. Change its type to
  34  *  pp_obj: CicNotationPt.obj -> CicNotationPres.markup
  35  * and parametrize it over a function with the following type
  36  *  pp_term: CicNotationPt.term -> CicNotationPres.markup
  37  * The obtained markup can then be printed using CicNotationPres.print_xml or
  38  * BoxPp.render_to_string(s)
  39  *)
  40
  41 val pp_term: CicNotationPt.term -> string
  42 val pp_obj: ('term -> string) -> 'term CicNotationPt.obj -> string
  43
  44 val pp_env: CicNotationEnv.t -> string
  45 val pp_value: CicNotationEnv.value -> string
  46 val pp_value_type: CicNotationEnv.value_type -> string
  47
  48 val pp_pos: CicNotationPt.child_pos -> string
  49 val pp_attribute: CicNotationPt.term_attribute -> string
  50
  51 val pp_cic_appl_pattern: CicNotationPt.cic_appl_pattern -> string
  52
  53  (** non re-entrant change of pp_term function above *)
  54 val set_pp_term: (CicNotationPt.term -> string) -> unit
  55