helm/ocaml/mathql/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://www.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 mqlvar = string (* name *)
  49
  50 type mqpt = string option (* PROTOCOL TOKENS *)
  51                           (* Some = constant string *)
  52                           (* None = single star: '*' *)
  53
  54 type mqbt =               (* BODY TOKENS *)
  55    | MQBC of string       (* a constant string *)
  56    | MQBD                 (* a slash: '/' *)
  57    | MQBQ                 (* a question mark: '?' *)
  58    | MQBS                 (* a single star: '*' *)
  59    | MQBSS                (* a double star: '**' *)
  60
  61 type mqft =               (* FRAGMENT TOKENS *)
  62    | MQFC of int          (* a constant integer *)
  63    | MQFS                 (* a single star: '*' *)
  64    | MQFSS                (* a double star: '**' *)
  65
  66 type mquref = UriManager.uri * (int list) (* uri, fragment identifier *)
  67
  68 type mqtref = mqpt * (mqbt list) * (mqft list) (* tokenized pattern reference *)
  69
  70 type mqfunc =
  71    | MQName         (* Name *)
  72    | MQTheory       (* theory *)
  73    | MQTitle        (* DC properties *)
  74    | MQContributor
  75    | MQCreator
  76    | MQPublisher
  77    | MQSubject
  78    | MQDescription
  79    | MQDate
  80    | MQType
  81    | MQFormat
  82    | MQIdentifier
  83    | MQLanguage
  84    | MQRelation
  85    | MQSource
  86    | MQCoverage
  87    | MQRights
  88    | MQInstitution
  89    | MQContact
  90    | MQFirstVersion
  91    | MQModified
  92
  93 type mqstring =
  94    | MQCons of string          (* constant *)
  95    | MQFunc of mqfunc * mqrvar (* function, rvar *)
  96    | MQStringRVar of mqrvar    (* rvar *)
  97    | MQStringSVar of mqsvar    (* svar *)
  98    | MQMConclusion             (* main conclusion *)
  99    | MQConclusion              (* inner conclusion *)
 100
 101 type mqorder =
 102    | MQAsc     (* ascending order *)
 103    | MQDesc    (* descending order *)
 104
 105 type mqbool =
 106    | MQTrue                        (* true *)
 107    | MQFalse                       (* false *)
 108    | MQAnd of mqbool * mqbool      (* conjunction *)
 109    | MQOr of mqbool * mqbool       (* disjunction *)
 110    | MQNot of mqbool               (* negation *)
 111    | MQIs of mqstring * mqstring   (* case-sensitive comparison  *)
 112    | MQSetEqual of mqlist * mqlist (* the two lists denote the same set *)
 113    | MQSubset of mqlist * mqlist   (* the two lists denote two sets, the 1st subset of the 2nd *)
 114
 115 and mqlist =
 116    | MQReference of string list              (* reference list *)
 117    | MQPattern of mqtref                     (* pattern *)
 118    | MQListLVar of mqlvar                    (* lvar *)
 119    | MQListRVar of mqrvar                    (* rvar *)
 120    | MQSelect of mqrvar * mqlist * mqbool    (* rvar, list, boolean *)
 121    | MQUse of mqlist * mqsvar                (* list, Position attribute *)
 122    | MQUsedBy of mqlist * mqsvar             (* list, Position attribute *)
 123    | MQUnion of mqlist * mqlist              (* operands *)
 124    | MQIntersect of mqlist * mqlist          (* operands *)
 125    | MQSortedBy of mqlist * mqorder * mqfunc (* ordering *)
 126    | MQDiff of mqlist * mqlist               (* set difference  *)
 127    | MQLetIn of mqlvar * mqlist * mqlist     (* explicit lvar assignment *)
 128
 129 type mquery =
 130    | MQList of mqlist
 131
 132 (* Output types *************************************************************)
 133 (* main type is mqresult                                                    *)
 134
 135 type mqresult =
 136    | MQRefs of string list