helm/gTopLevel/mathql.ml

   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 (*                     Domenico Lordi  <lordi@cs.unibo.it>                    *)
  32 (*                                 30/04/2002                                 *)
  33 (*                                                                            *)
  34 (*                                                                            *)
  35 (******************************************************************************)
  36
  37 exception MQInvalidURI of string
  38 exception MQConnectionFailed of string
  39 exception MQInvalidConnection of string
  40
  41 (* Input types **************************************************************)
  42 (* main type is mquery                                                      *)
  43
  44 type mqrvar = string                       (* name *)
  45
  46 type mqsvar = string                       (* name *)
  47
  48 type mquptoken =
  49    | MQString of string                     (* a constant string *)
  50    | MQSlash                                (* a slash: '/' *)
  51    | MQAnyChr                               (* Any single character: '?' *)
  52    | MQAst                                  (* single asterisk: '*' *)
  53    | MQAstAst                               (* double asterisk: '**' *)
  54
  55 type mqup = mquptoken list                  (* uri pattern (helper) *)
  56
  57 type mqfi = int option * int option
  58
  59 type mqtref = string * mqup * string * mqfi (* HELM preamble,
  60                                               uri pattern,
  61                                               extension,
  62                                               fragment identifier *)
  63
  64 type mqpattern = mqtref                     (* constant pattern *)
  65
  66 type mqfunc =
  67    | MQName                                 (* NAME *)
  68
  69 type mqstring =
  70    | MQCons of string                       (* constant *)
  71    | MQFunc of mqfunc * mqrvar              (* function, rvar *)
  72    | MQRVar of mqrvar                       (* rvar *)
  73    | MQSVar of mqsvar                       (* svar *)
  74    | MQMConclusion                          (* main conclusion *)
  75    | MQConclusion                           (* inner conclusion *)
  76
  77 type mqbool =
  78    | MQTrue
  79    | MQFalse
  80    | MQAnd of mqbool * mqbool
  81    | MQOr of mqbool * mqbool
  82    | MQNot of mqbool
  83    | MQIs of mqstring * mqstring            (* operands *)
  84
  85 type mqlist =
  86    | MQSelect of mqrvar * mqlist * mqbool   (* rvar, list, boolean *)
  87    | MQUse of mqlist * mqsvar               (* list, Position attribute *)
  88    | MQPattern of mqpattern                 (* pattern *)
  89    | MQUnion of mqlist * mqlist             (*  *)
  90    | MQIntersect of mqlist * mqlist         (*  *)
  91
  92 type mquery =
  93    | MQList of mqlist
  94
  95 (* Output types *************************************************************)
  96 (* main type is mqresult                                                    *)
  97
  98 (* TODO: usare le uri in questo formato *)
  99 type mquref = UriManager.uri * mqfi         (* uri, fragment identifier *)
 100
 101 type mqrefs = mqtref list                   (* list of references (helper) *)
 102
 103 type mqresult =
 104    | MQRefs of mqrefs