(*
 * Copyright (C) 2003-2004:
 *    Stefano Zacchiroli <zack@cs.unibo.it>
 *    for the HELM Team http://helm.cs.unibo.it/
 *
 *  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/
 *)

open Http_getter_types

  (** {2 Loggers} *)

type logger_callback = HelmLogger.html_tag -> unit

val stdout_logger: logger_callback

  (** {2 Getter Web Service interface as API *)

val help: unit -> string

  (** @raise Http_getter_types.Unresolvable_URI _
  * @raise Http_getter_types.Key_not_found _ *)
val resolve: string -> string (* uri -> url *)

  (** @raise Http_getter_types.Key_already_in _ *)
val register: uri:string -> url:string -> unit

  (** does not fail if given uri does not exist *)
val unregister: string -> unit

val update: ?logger:logger_callback -> unit -> unit

  (** @param format defaults to `Gzipped
   * @param patch_dtd defaults to false *)
val getxml  : ?format:encoding -> ?patch_dtd:bool -> string -> string
val getxslt : ?patch_dtd:bool -> string -> string
val getdtd  : ?patch_dtd:bool -> string -> string
val clean_cache: unit -> unit
val list_servers: unit -> (int * string) list
val add_server: ?logger:logger_callback -> ?position:int -> string -> unit
val remove_server: ?logger:logger_callback -> int -> unit
val getalluris: unit -> string list
val getallrdfuris: [ `Forward | `Backward ] -> string list

  (** @param regexp regular expression (PCRE syntax) over HELM URIs *)
val ls: string -> ls_item list

  (** {2 Shorthands} *)

val getxml'     : UriManager.uri -> string  (* `Gzipped format, no DTD patch *)
val resolve'    : UriManager.uri -> string
val register'   : UriManager.uri -> string -> unit
val unregister' : UriManager.uri -> unit

  (** {2 Misc} *)

val close_maps: unit -> unit
val update_from_one_server: ?logger:logger_callback -> string -> unit
val has_server: int -> bool (* does a server with a given position exists? *)
val init: unit -> unit

  (** cal this at exit() *)
val sync_dump_file: unit -> unit