added homepage URL, now we have one

[helm.git] / helm / ocaml / getter / http_getter_common.mli

diff --git a/helm/ocaml/getter/http_getter_common.mli b/helm/ocaml/getter/http_getter_common.mli
index 1828c82e84b1908eefe07d48897a4a2519de4df7..d1bc66f7669843c10985220f883028f83efb3fe3 100644 (file)
--- a/helm/ocaml/getter/http_getter_common.mli
+++ b/helm/ocaml/getter/http_getter_common.mli
@@ -32,15 +32,20 @@ val string_of_ls_flag: ls_flag -> string
 val string_of_encoding: encoding -> string
 
 val is_cic_uri: string -> bool
+val is_cic_obj_uri: string -> bool
+val is_theory_uri: string -> bool
 val is_nuprl_uri: string -> bool
 val is_rdf_uri: string -> bool
 val is_xsl_uri: string -> bool
 
 val uri_of_string: string -> uri
 
-val patch_xml : string -> string
-val patch_xsl : string -> string
-val patch_dtd : string -> string
+  (** @param xmlbases (xml base URI * xml base URL) *)
+val patch_xml :
+  ?via_http:bool -> ?xmlbases:(string * string) -> unit -> (string -> string)
+val patch_dtd : ?via_http:bool -> unit -> (string -> string)
+  (* TODO via_http not yet supported for patch_xsl *)
+val patch_xsl : ?via_http:bool -> unit -> (string -> string)
 
   (**
   @param fname name of the file to be sent
@@ -48,13 +53,18 @@ val patch_dtd : string -> string
   @param contenc Content-Enconding header value
   @param patch_fun function used to patch file contents
   @param gunzip is meaningful only if a patch function is provided. If gunzip
-  is true patch_fun is applied to the uncompressed version of the file. The file
-  is then compressed again and send to client
+  is true and patch_fun is given (i.e. is not None), then patch_fun is applied
+  to the uncompressed version of the file. The file is then compressed again and
+  send to client
+  @param via_http (default: true) if true http specific communications are used
+  (e.g. headers, crlf before body) and sent via outchan, otherwise they're not.
+  Set it to false when saving to a local file
   @param outchan output channel over which sent file fname *)
 val return_file:
   fname:string ->
   ?contype:string -> ?contenc:string ->
-  ?patch_fun:(string -> string) -> ?gunzip:bool ->
+  ?patch_fun:(string -> string) -> ?gunzip:bool -> ?via_http:bool ->
+  enc:encoding ->
   out_channel ->
     unit