]> matita.cs.unibo.it Git - helm.git/blobdiff - helm/ocaml/getter/http_getter_env.mli
ocaml 3.09 transition
[helm.git] / helm / ocaml / getter / http_getter_env.mli
index 5e5a0496cb0ac4336d57d71208f88734f3355bc5..fa90d354a8b6c7d69518402f51c444a3dcf94420 100644 (file)
@@ -1,74 +1,48 @@
-(*
- * Copyright (C) 2003-2004:
- *    Stefano Zacchiroli <zack@cs.unibo.it>
- *    for the HELM Team http://helm.cs.unibo.it/
+(* Copyright (C) 2005, HELM Team.
+ * 
+ * This file is part of HELM, an Hypertextual, Electronic
+ * Library of Mathematics, developed at the Computer Science
+ * Department, University of Bologna, Italy.
+ * 
+ * HELM is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ * 
+ * HELM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  *
- *  This file is part of HELM, an Hypertextual, Electronic
- *  Library of Mathematics, developed at the Computer Science
- *  Department, University of Bologna, Italy.
- *
- *  HELM is free software; you can redistribute it and/or
- *  modify it under the terms of the GNU General Public License
- *  as published by the Free Software Foundation; either version 2
- *  of the License, or (at your option) any later version.
- *
- *  HELM is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU General Public License
- *  along with HELM; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place - Suite 330, Boston,
- *  MA  02111-1307, USA.
- *
- *  For details, see the HELM World-Wide-Web page,
- *  http://helm.cs.unibo.it/
+ * You should have received a copy of the GNU General Public License
+ * along with HELM; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA  02111-1307, USA.
+ * 
+ * For details, see the HELM World-Wide-Web page,
+ * http://helm.cs.unibo.it/
  *)
 
-open Http_getter_types;;
-
-  (* {2 general information} *)
+  (** {2 general information} *)
 
 val version       : string        (* getter version *)
 
-  (* {2 environment gathered data} *)
+  (** {2 environment gathered data} *)
+  (** all *_dir values are returned with trailing "/" *)
 
-val cic_dbm       : string lazy_t         (* XML map DBM file for CIC *)
-val nuprl_dbm     : string lazy_t         (* XML map DBM file for NuPRL *)
-val rdf_dbm       : string lazy_t         (* RDF map DBM file *)
-val xsl_dbm       : string lazy_t         (* XSL map DBM file *)
-val xml_index     : string lazy_t         (* XMLs' index *)
-val rdf_index     : string lazy_t         (* RDFs' index *)
-val xsl_index     : string lazy_t         (* XSLTs' index *)
-val cic_dir       : string lazy_t         (* XMLs' directory  for CIC*)
-val nuprl_dir     : string lazy_t         (* XMLs' directory for NuPRL*)
-val rdf_dir       : string lazy_t         (* RDFs' directory *)
+val cache_dir     : string lazy_t         (* cache root *)
 val dtd_dir       : string lazy_t         (* DTDs' root directory *)
-val servers_file  : string option lazy_t  (* servers.txt file *)
 val port          : int lazy_t            (* port on which getter listens *)
 val dtd_base_urls : string list lazy_t    (* base URLs for document patching *)
+val prefixes      : (string * string) list lazy_t (* prefix map uri -> url *)
 
   (* {2 derived data} *)
 
 val host          : string lazy_t         (* host on which getter listens *)
 val my_own_url    : string lazy_t         (* URL at which contact getter *)
-val servers       : unit -> (int * string) list
-                                    (* (position * server) list *)
-val cache_mode    : encoding lazy_t       (* cached files encoding *)
-
-  (* {2 dynamic configuration changes} *)
-
-  (* add a server to servers list in a given position (defaults to "after the
-  last server", change servers file accordingly and reload servers list *)
-val add_server: ?position:int -> string -> unit
-  (* remove a server from servers list, change servers file accordingly and
-  reload servers list *)
-val remove_server: int -> unit
 
   (* {2 misc} *)
 
-val reload: unit -> unit            (* reload configuration information *)
 val env_to_string : unit -> string  (* dump a textual representation of the
                                     current http_getter settings on an output
                                     channel *)