]> matita.cs.unibo.it Git - helm.git/blob - helm/ocaml/getter/http_getter_env.mli
snapshot
[helm.git] / helm / ocaml / getter / http_getter_env.mli
1 (*
2  * Copyright (C) 2003-2004:
3  *    Stefano Zacchiroli <zack@cs.unibo.it>
4  *    for the HELM Team http://helm.cs.unibo.it/
5  *
6  *  This file is part of HELM, an Hypertextual, Electronic
7  *  Library of Mathematics, developed at the Computer Science
8  *  Department, University of Bologna, Italy.
9  *
10  *  HELM is free software; you can redistribute it and/or
11  *  modify it under the terms of the GNU General Public License
12  *  as published by the Free Software Foundation; either version 2
13  *  of the License, or (at your option) any later version.
14  *
15  *  HELM is distributed in the hope that it will be useful,
16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  *  GNU General Public License for more details.
19  *
20  *  You should have received a copy of the GNU General Public License
21  *  along with HELM; if not, write to the Free Software
22  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston,
23  *  MA  02111-1307, USA.
24  *
25  *  For details, see the HELM World-Wide-Web page,
26  *  http://helm.cs.unibo.it/
27  *)
28
29 open Http_getter_types;;
30
31   (* {2 general information} *)
32
33 val version       : string        (* getter version *)
34
35   (* {2 environment gathered data} *)
36
37 val cic_dbm       : string lazy_t         (* XML map DBM file for CIC *)
38 val nuprl_dbm     : string lazy_t         (* XML map DBM file for NuPRL *)
39 val rdf_dbm       : string lazy_t         (* RDF map DBM file *)
40 val xsl_dbm       : string lazy_t         (* XSL map DBM file *)
41 val xml_index     : string lazy_t         (* XMLs' index *)
42 val rdf_index     : string lazy_t         (* RDFs' index *)
43 val xsl_index     : string lazy_t         (* XSLTs' index *)
44 val cic_dir       : string lazy_t         (* XMLs' directory  for CIC*)
45 val nuprl_dir     : string lazy_t         (* XMLs' directory for NuPRL*)
46 val rdf_dir       : string lazy_t         (* RDFs' directory *)
47 val dtd_dir       : string lazy_t         (* DTDs' root directory *)
48 val servers_file  : string lazy_t         (* servers.txt file *)
49 val port          : int lazy_t            (* port on which getter listens *)
50 val dtd_base_urls : string list lazy_t    (* base URLs for document patching *)
51
52   (* {2 derived data} *)
53
54 val host          : string lazy_t         (* host on which getter listens *)
55 val my_own_url    : string lazy_t         (* URL at which contact getter *)
56 val servers       : unit -> (int * string) list
57                                     (* (position * server) list *)
58 val cache_mode    : encoding lazy_t       (* cached files encoding *)
59
60   (* {2 dynamic configuration changes} *)
61
62   (* add a server to servers list in a given position (defaults to "after the
63   last server", change servers file accordingly and reload servers list *)
64 val add_server: ?position:int -> string -> unit
65   (* remove a server from servers list, change servers file accordingly and
66   reload servers list *)
67 val remove_server: int -> unit
68
69   (* {2 misc} *)
70
71 val reload: unit -> unit            (* reload configuration information *)
72 val env_to_string : unit -> string  (* dump a textual representation of the
73                                     current http_getter settings on an output
74                                     channel *)
75