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 *)
  38 val depth_of_uri  : uri -> int     (* length of the path *)
  39
  40 (* given an uri, returns the uri of the corresponding cic file, *)
  41 (* i.e. removes the [.types][.ann] suffix                       *)
  42 val cicuri_of_uri : uri -> uri
  43
  44 val strip_xpointer: uri -> uri      (* remove trailing #xpointer..., if any *)
  45
  46 (* given an uri, returns the uri of the corresponding annotation file, *)
  47 (* i.e. adds the .ann suffix if not already present                    *)
  48 val annuri_of_uri : uri -> uri
  49
  50 (* given an uri, tells if it refers to an annotation *)
  51 val uri_is_annuri : uri -> bool
  52
  53 (* given an uri of a constant, it gives back the uri of its body             *)
  54 (* it gives back None if the uri refers to a Variable or MutualInductiveType *)
  55 val bodyuri_of_uri : uri -> uri option
  56
  57 (* given an uri, it gives back the uri of its inner types             *)
  58 val innertypesuri_of_uri : uri -> uri
  59
  60 (*
  61 val mutind_uri:       uri -> int -> uri
  62 val mutconstruct_uri: uri -> int -> int -> uri
  63 val mutind:           uri -> uri * int
  64 val mutconstruct:     uri -> uri * int * int
  65 *)
  66
  67   (* builder for MutInd and MutConstruct URIs *)
  68 type uriref = uri * (int list)
  69 val string_of_uriref : uriref -> string
  70
  71 module UriSet: Set.S with type elt = uri
  72