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 cic_dbm_real  : string lazy_t         (* XML map DBM file for CIC ^ ".pag"*)
  39 val nuprl_dbm     : string lazy_t         (* XML map DBM file for NuPRL *)
  40 val rdf_dbm       : string lazy_t         (* RDF map DBM file *)
  41 val xsl_dbm       : string lazy_t         (* XSL map DBM file *)
  42 val dump_file     : string lazy_t         (* CIC DBM tree dump file *)
  43 val prefetch      : bool lazy_t           (* prefetch URIs tree? *)
  44 val xml_index     : string lazy_t         (* XMLs' index *)
  45 val rdf_index     : string lazy_t         (* RDFs' index *)
  46 val xsl_index     : string lazy_t         (* XSLTs' index *)
  47 val cic_dir       : string lazy_t         (* XMLs' directory  for CIC*)
  48 val nuprl_dir     : string lazy_t         (* XMLs' directory for NuPRL*)
  49 val rdf_dir       : string lazy_t         (* RDFs' directory *)
  50 val dtd_dir       : string lazy_t         (* DTDs' root directory *)
  51 val servers_file  : string option lazy_t  (* servers.txt file *)
  52 val port          : int lazy_t            (* port on which getter listens *)
  53 val dtd_base_urls : string list lazy_t    (* base URLs for document patching *)
  54
  55   (* {2 derived data} *)
  56
  57 val host          : string lazy_t         (* host on which getter listens *)
  58 val my_own_url    : string lazy_t         (* URL at which contact getter *)
  59 val servers       : unit -> (int * string) list
  60                                     (* (position * server) list *)
  61 val cache_mode    : encoding lazy_t       (* cached files encoding *)
  62
  63   (* {2 dynamic configuration changes} *)
  64
  65   (* add a server to servers list in a given position (defaults to "after the
  66   last server", change servers file accordingly and reload servers list *)
  67 val add_server: ?position:int -> string -> unit
  68   (* remove a server from servers list, change servers file accordingly and
  69   reload servers list *)
  70 val remove_server: int -> unit
  71
  72   (* {2 misc} *)
  73
  74 val reload: unit -> unit            (* reload configuration information *)
  75 val env_to_string : unit -> string  (* dump a textual representation of the
  76                                     current http_getter settings on an output
  77                                     channel *)
  78