helm/ocaml/mathql_interpreter/mQILib.mli

   1 (* Copyright (C) 2000, 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://cs.unibo.it/helm/.
  24  *)
  25
  26 (*  AUTOR: Ferruccio Guidi <fguidi@cs.unibo.it>
  27  *)
  28
  29 type arity_t = Const of int
  30              | Positive
  31              | Any
  32
  33 type eval_spec = {eval : MathQL.query -> MathQL.result;
  34                   conn : MQIConn.handle
  35                  }
  36
  37 type text_out_spec = {out    : string -> unit;
  38                       path   : (string -> unit) -> MathQL.path -> unit;
  39                       query  : (string -> unit) -> string -> MathQL.query -> unit;
  40                       result : (string -> unit) -> string -> MathQL.result -> unit
  41                      }
  42
  43 type text_in_spec = {result_in : Lexing.lexbuf -> MathQL.result}
  44
  45 val fun_arity   : MathQL.path -> int -> int -> unit
  46
  47 val fun_eval    : eval_spec -> text_out_spec -> text_in_spec ->
  48                   MathQL.path -> MathQL.path list -> MathQL.query list ->
  49                   MathQL.result
  50
  51 val fun_txt_out : text_out_spec ->
  52                   MathQL.path -> MathQL.path list -> MathQL.query list -> unit
  53
  54 val gen_arity   : MathQL.path -> int -> unit
  55
  56 val gen_eval    : eval_spec ->
  57                   MathQL.path -> MathQL.query list -> MathQL.query
  58
  59 exception ArityError of MathQL.path * arity_t * int
  60
  61 exception NameError of MathQL.path
  62
  63 exception NumberError of MathQL.result