helm/ocaml/urimanager/uriManager.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 exception IllFormedUri of string;;
  27
  28 type uri
  29
  30 val eq : uri -> uri -> bool
  31 val compare : uri -> uri -> int
  32
  33 val uri_of_string : string -> uri
  34
  35 val string_of_uri : uri -> string  (* complete uri *)
  36 val name_of_uri   : uri -> string  (* name only (without extension)*)
  37 val buri_of_uri   : uri -> string  (* base uri only, without trailing '/' *)
  38
  39 (* given an uri, returns the uri of the corresponding cic file, *)
  40 (* i.e. removes the [.types][.ann] suffix                       *)
  41 val cicuri_of_uri : uri -> uri
  42
  43 val strip_xpointer: uri -> uri      (* remove trailing #xpointer..., if any *)
  44
  45 (* given an uri, returns the uri of the corresponding annotation file, *)
  46 (* i.e. adds the .ann suffix if not already present                    *)
  47 val annuri_of_uri : uri -> uri
  48
  49 val uri_is_annuri : uri -> bool
  50 val uri_is_var : uri -> bool
  51 val uri_is_con : uri -> bool
  52 val uri_is_ind : uri -> bool
  53
  54 (* given an uri of a constant, it gives back the uri of its body             *)
  55 (* it gives back None if the uri refers to a Variable or MutualInductiveType *)
  56 val bodyuri_of_uri : uri -> uri option
  57
  58 (* given an uri, it gives back the uri of its inner types             *)
  59 val innertypesuri_of_uri : uri -> uri
  60 (* given an uri, it gives back the uri of its univgraph             *)
  61 val univgraphuri_of_uri : uri -> uri
  62
  63 (* builder for MutInd and MutConstruct URIs
  64  * [uri] -> [typeno] -> [consno option]
  65  *)
  66 val uri_of_uriref :  uri -> int -> int option -> uri
  67
  68 module UriSet: Set.S with type elt = uri
  69
  70 module UriHashtbl : Hashtbl.S with type key = uri
  71