2 * Copyright (C) 2003-2004:
3 * Stefano Zacchiroli <zack@cs.unibo.it>
4 * for the HELM Team http://helm.cs.unibo.it/
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.
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.
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.
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,
25 * For details, see the HELM World-Wide-Web page,
26 * http://helm.cs.unibo.it/
29 (** 'mkdir' failed, arguments are: name of the directory to be created and
31 exception Mkdir_failure of string * string
33 (** @return Some localpart for URI belonging to the "file://" scheme, None for
35 * removes trailing ".gz", if any
36 * e.g.: local_url "file:///etc/passwd.gz" = Some "/etc/passwd"
37 * local_url "http://...." = None *)
38 val local_url: string -> string option
40 (** "fold_left" like function on file lines, trailing newline is not passed to
42 val fold_file : (string -> 'a -> 'a) -> 'a -> string -> 'a
43 (* "iter" like function on file lines, trailing newline is not passed to the
45 val iter_file : (string -> unit) -> string -> unit
47 (** like Hashtbl.fold but keys are processed ordered *)
48 val hashtbl_sorted_fold :
49 ('a -> 'b -> 'c -> 'c) -> ('a, 'b) Hashtbl.t -> 'c -> 'c
50 (** like Hashtbl.iter but keys are processed ordered *)
51 val hashtbl_sorted_iter : ('a -> 'b -> unit) -> ('a, 'b) Hashtbl.t -> unit
54 val cp: string -> string -> unit
55 (** wget frontend, if output is given it is the destination file, otherwise
56 standard wget rules are used. Additionally this function support also the
57 "file://" scheme for file system addressing *)
58 val wget: ?output: string -> string -> unit
59 (** gzip frontend. If keep = true original file will be kept, default is
60 false. output is the file on which gzipped data will be saved, default is
61 given file with an added ".gz" suffix *)
62 val gzip: ?keep: bool -> ?output: string -> string -> unit
63 (** gunzip frontend. If keep = true original file will be kept, default is
64 false. output is the file on which gunzipped data will be saved, default is
65 given file name without trailing ".gz" *)
66 val gunzip: ?keep: bool -> ?output: string -> string -> unit
67 (** tempfile frontend, return the name of created file. A special purpose
68 suffix is used (actually "_http_getter" *)
69 val tempfile: unit -> string
70 (** mkdir frontend, if parents = true also parent directories will be created.
71 If the given directory already exists doesn't act *)
72 val mkdir: ?parents: bool -> string -> unit
74 (** pretty printer for Unix.process_status values *)
75 val string_of_proc_status : Unix.process_status -> string
77 (** raw URL downloader, return Some the contents of downloaded resource or
78 None if an error occured while downloading. This function support also
79 "file://" scheme for filesystem resources *)
80 val http_get: string -> string option
82 (** true on blanks-only and #-commented lines, false otherwise *)
83 val is_blank_line: string -> bool