helm/gTopLevel/mQueryGenerator.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 (******************************************************************************)
  27 (*                                                                            *)
  28 (*                               PROJECT HELM                                 *)
  29 (*                                                                            *)
  30 (*                     Ferruccio Guidi <fguidi@cs.unibo.it>                   *)
  31 (*                                 30/04/2002                                 *)
  32 (*                                                                            *)
  33 (*                                                                            *)
  34 (******************************************************************************)
  35
  36 exception Discard
  37
  38 type uri = string
  39 type position = string
  40 type depth = int option
  41 type sort = string
  42
  43 type r_obj = (uri * position * depth)
  44 type r_rel = (position * depth)
  45 type r_sort = (position * depth * sort)
  46
  47 type must_restrictions = (r_obj list * r_rel list * r_sort list)
  48 type only_restrictions =
  49  (r_obj list option * r_rel list option * r_sort list option)
  50
  51
  52
  53 val set_log_file      : string -> unit
  54
  55 (* the callback function must return false iff the query must be skipped *)
  56 val set_confirm_query : (MathQL.query -> bool) -> unit
  57
  58 val execute_query     : MathQL.query -> MathQL.result
  59
  60 val locate            : string -> MathQL.result
  61
  62 val searchPattern     : must_restrictions -> only_restrictions -> MathQL.result
  63
  64 val get_query_info    : unit -> string list