On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package camlpdf
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Reading PDF Files
val pdf_of_input :
?revision:int ->
string option ->
string option ->
Pdfio.input ->
Pdf.tRead a PDF from a Pdfio.input, with an optional user password which, if absent, is assumed to be the empty string, and optional owner password.
val pdf_of_input_lazy :
?revision:int ->
string option ->
string option ->
Pdfio.input ->
Pdf.tSame as pdf_of_input, but delay loading of streams and parsing of objects (they will be loaded and parsed when needed). Useful if we only intend to do something simple, like read metadata.
val pdf_of_channel :
?revision:int ->
?source:string ->
string option ->
string option ->
in_channel ->
Pdf.tSame as pdf_of_input, but from an OCaml channel.
val pdf_of_channel_lazy :
?revision:int ->
?source:string ->
string option ->
string option ->
in_channel ->
Pdf.tAs pdf_of_channel, but delay loading of streams and parsing of objects like pdf_of_input_lazy.
val pdf_of_file :
?revision:int ->
string option ->
string option ->
string ->
Pdf.tRead a PDF from the given filename with optional user and owner passwords.
Configuration and debugging
val read_debug : bool refIf set, some debug output is produced.
val error_on_malformed : bool refIf set, a malformed PDF will cause an error, not an attempt to read using the malformed PDF reader.
val debug_always_treat_malformed : bool refIf set, we always use the malformed PDF reader. For debug.
Low level functions
val revisions : Pdfio.input -> intRead the number of revisions of the document, by performing a dummy read. For example, if this function returns 3, then appropriate values to pass to ?revision in a subsequent call to pdf_of_input are 1, 2, and 3.
val what_encryption : Pdf.t -> Pdfwrite.encryption_method optionReturn encryption method in use
val permissions : Pdf.t -> Pdfcrypt.permission listReturn list of permissions
val is_linearized : Pdfio.input -> boolGiven a filename, see if the file is linearized.
val read_header : Pdfio.input -> int * intRead a PDF header
val getuntil_white_or_delimiter : Pdfio.input -> char listval getuntil_white_or_delimiter_string : Pdfio.input -> stringval getuntil : bool -> (char -> bool) -> Pdfio.input -> char listRead characters until a predicate is true. If the boolean is set, end of input is considered a delimiter.
val ignoreuntil : bool -> (char -> bool) -> Pdfio.input -> unitThrow away characters until a predicate is true. If the boolean is set, end of input is considered a delimiter.
val dropwhite : Pdfio.input -> unitDrop whitespace characters from an input.
val lex_name : Pdfio.input -> Pdfgenlex.tLex a name, assuming there is one to lex.
val lex_number : Pdfio.input -> Pdfgenlex.tLex a number, assuming there is one to lex.
val lex_string : Pdfio.input -> Pdfgenlex.tLex a string, assuming there is one to lex.
val lex_hexstring : Pdfio.input -> Pdfgenlex.tLex a hexadecimal string, assuming there is one to lex.
val lex_comment : Pdfio.input -> Pdfgenlex.tLex a comment, assuming there is one to lex.
val lex_dictionary : Pdfio.input -> Pdfgenlex.t listLex a dictinonary, assuming there is one to lex.
val lex_stream_data : Pdfio.input -> int -> bool -> Pdfgenlex.tLex stream data of the given length. If the boolean is true, then actually read the data. If not, merely record the intention to.
val parse : ?failure_is_ok:bool -> Pdfgenlex.t list -> int * Pdf.pdfobjectParse a PDF object. If failure_is_ok is set, a null object with high object number is returned, instead of an exception being raised.
val parse_single_object : string -> Pdf.pdfobjectParse a single object.
val string_of_lexeme : Pdfgenlex.t -> stringString representation of a lexeme
val print_lexeme : Pdfgenlex.t -> unitPrint a lexeme to Standard Output with a space after it, for debug.
On This Page