helm/http_getter/http_getter_misc.mli

   1 (*
   2  * Copyright (C) 2003:
   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  (** 'mkdir' failed, arguments are: name of the directory to be created and
  30  failure reason *)
  31 exception Mkdir_failure of string * string
  32
  33  (** "fold_left" like function on file lines, trailing newline is not passed to
  34  the given function *)
  35 val fold_file : ('a -> string -> 'a) -> 'a -> string -> 'a
  36  (* "iter" like function on file lines, trailing newline is not passed to the
  37  given function *)
  38 val iter_file : (string -> unit) -> string -> unit
  39
  40   (** like Hashtbl.fold but keys are processed ordered *)
  41 val hashtbl_sorted_fold :
  42   ('a -> 'b -> 'c -> 'c) -> ('a, 'b) Hashtbl.t -> 'c -> 'c
  43
  44   (** cp frontend *)
  45 val cp: string -> string -> unit
  46   (** wget frontend, if output is given it is the destination file, otherwise
  47   standard wget rules are used. Additionally this function support also the
  48   "file://" scheme for file system addressing *)
  49 val wget: ?output: string -> string -> unit
  50   (** gzip frontend, if keep = true original file will be kept *)
  51 val gzip: ?keep: bool -> string -> unit
  52   (** gunzip frontend, if keep = true original file will be kept *)
  53 val gunzip: ?keep: bool -> string -> unit
  54   (** tempfile frontend, return the name of created file. A special purpose
  55   suffix is used (actually "_http_getter" *)
  56 val tempfile: unit -> string
  57   (** mkdir frontend, if parents = true also parent directories will be created.
  58   If the given directory already exists doesn't act *)
  59 val mkdir: ?parents: bool -> string -> unit
  60
  61   (** pretty printer for Unix.process_status values *)
  62 val string_of_proc_status : Unix.process_status -> string
  63
  64   (** raw HTTP downloader, return Some the contents of downloaded resource or
  65   None if an error occured while downloading. This function support also
  66   "file://" scheme for filesystem resources *)
  67 val http_get: string -> string option
  68   (** 'iter' like method that iter over string slices (unspecified length) of a
  69   remote resources fetched via HTTP GET requests *)
  70 val http_get_iter_buf: callback:(string -> unit) -> string -> unit
  71