]> matita.cs.unibo.it Git - helm.git/blob - helm/software/components/getter/http_getter.mli
...
[helm.git] / helm / software / components / getter / http_getter.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 Loggers} *)
32
33 type logger_callback = HelmLogger.html_tag -> unit
34
35 val stdout_logger: logger_callback
36
37   (** {2 Getter Web Service interface as API *)
38
39 val help: unit -> string
40
41   (** @raise Http_getter_types.Unresolvable_URI _
42   * @raise Http_getter_types.Key_not_found _ *)
43 val resolve: local:bool -> writable:bool -> string -> string (* uri -> url *)
44
45   (** as resolve, but does not check if the resource exists
46    * @raise Http_getter_types.Key_not_found *)
47 val filename: local:bool -> writable:bool -> string -> string (* uri -> url *)
48
49 val exists: local:bool -> string -> bool
50
51 val getxml  : string -> string
52 val getxslt : string -> string
53 val getdtd  : string -> string
54 val clean_cache: unit -> unit
55 val getalluris: unit -> string list
56
57   (** @param baseuri uri to be listed, simple form or regular expressions (a
58    * single choice among parens) are permitted *)
59 val ls: local:bool -> string -> ls_item list
60
61   (** {2 UriManager shorthands} *)
62
63 val getxml'     : UriManager.uri -> string
64 val resolve'    : local:bool -> writable:bool -> UriManager.uri -> string
65 val exists'     : local:bool -> UriManager.uri -> bool
66 val filename'     : local:bool -> writable:bool -> UriManager.uri -> string
67
68   (** {2 Misc} *)
69
70 val init: unit -> unit
71