Pdf.Core

Low level API for parsing PDF file.

See Pdf.Core.Writer for basic API for writing new PDF file or incrementally updating existing one.

Documentation

data File

Pdf file is a collection of Objects

withPdfFile :: FilePath -> (File -> IO a) -> IO a

Open Pdf file

You may want to check encryptionStatus and setUserPassword if file is encrypted.

lastTrailer :: File -> IO Dict

The last trailer is an entry point to PDF file. All other objects usually are referensed from it, directly or indirectly.

findObject :: File -> Ref -> IO Object

Get an object with the specified ref.

data Object

Any pdf object

Constructors

Number Scientific

Bool Bool

Name Name

Dict Dict

Array Array

String ByteString

Stream Stream

Ref Ref

Null

Instances

Eq Object

Defined in Pdf.Core.Object

Methods

(==) :: Object -> Object -> Bool

(/=) :: Object -> Object -> Bool

Show Object

Defined in Pdf.Core.Object

Methods

showsPrec :: Int -> Object -> ShowS

show :: Object -> String

showList :: [Object] -> ShowS

data Name

Names usually are used as keys in dictionaries

Byte 0 is not allowed inside names

Instances

Eq Name

Defined in Pdf.Core.Name

Methods

(==) :: Name -> Name -> Bool

(/=) :: Name -> Name -> Bool

Ord Name

Defined in Pdf.Core.Name

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

(<=) :: Name -> Name -> Bool

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

Show Name

Defined in Pdf.Core.Name

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

IsString Name

Defined in Pdf.Core.Name

Methods

fromString :: String -> Name

Semigroup Name

Defined in Pdf.Core.Name

Methods

(<>) :: Name -> Name -> Name

sconcat :: NonEmpty Name -> Name

stimes :: Integral b => b -> Name -> Name

Monoid Name

Defined in Pdf.Core.Name

Methods

mempty :: Name

mappend :: Name -> Name -> Name

mconcat :: [Name] -> Name

Hashable Name

Defined in Pdf.Core.Name

Methods

hashWithSalt :: Int -> Name -> Int

hash :: Name -> Int

type Dict = HashMap Name Object

Dictionary

type Array = Vector Object

An array

data Ref

Object reference, contains object index and generation

Constructors

R Int Int

Instances

Eq Ref

Defined in Pdf.Core.Object

Methods

(==) :: Ref -> Ref -> Bool

(/=) :: Ref -> Ref -> Bool

Ord Ref

Defined in Pdf.Core.Object

Methods

compare :: Ref -> Ref -> Ordering

(<) :: Ref -> Ref -> Bool

(<=) :: Ref -> Ref -> Bool

(>) :: Ref -> Ref -> Bool

(>=) :: Ref -> Ref -> Bool

max :: Ref -> Ref -> Ref

min :: Ref -> Ref -> Ref

Show Ref

Defined in Pdf.Core.Object

Methods

showsPrec :: Int -> Ref -> ShowS

show :: Ref -> String

showList :: [Ref] -> ShowS

Hashable Ref

Defined in Pdf.Core.Object

Methods

hashWithSalt :: Int -> Ref -> Int

hash :: Ref -> Int

data Stream

Contains stream dictionary and an offset in file

Constructors

S Dict Int64

Instances

Eq Stream

Defined in Pdf.Core.Object

Methods

(==) :: Stream -> Stream -> Bool

(/=) :: Stream -> Stream -> Bool

Show Stream

Defined in Pdf.Core.Object

Methods

showsPrec :: Int -> Stream -> ShowS

show :: Stream -> String

showList :: [Stream] -> ShowS

streamContent :: File -> Ref -> Stream -> IO (InputStream ByteString)

Get content of the stream

It's decrypted and decoded using registered StreamFilters if necessary.

data EncryptionStatus

Describes wether PDF file is encrypted, plain or already decrypted

Constructors

Encrypted

requires decryption

Decrypted

already decrypted

Plain

doesn't require decryption

Instances

Enum EncryptionStatus

Defined in Pdf.Core.File

Methods

succ :: EncryptionStatus -> EncryptionStatus

pred :: EncryptionStatus -> EncryptionStatus

toEnum :: Int -> EncryptionStatus

fromEnum :: EncryptionStatus -> Int

enumFrom :: EncryptionStatus -> [EncryptionStatus]

enumFromThen :: EncryptionStatus -> EncryptionStatus -> [EncryptionStatus]

enumFromTo :: EncryptionStatus -> EncryptionStatus -> [EncryptionStatus]

enumFromThenTo :: EncryptionStatus -> EncryptionStatus -> EncryptionStatus -> [EncryptionStatus]

Eq EncryptionStatus

Defined in Pdf.Core.File

Methods

(==) :: EncryptionStatus -> EncryptionStatus -> Bool

(/=) :: EncryptionStatus -> EncryptionStatus -> Bool

Show EncryptionStatus

Defined in Pdf.Core.File

Methods

showsPrec :: Int -> EncryptionStatus -> ShowS

show :: EncryptionStatus -> String

showList :: [EncryptionStatus] -> ShowS

encryptionStatus :: File -> IO EncryptionStatus

Get encryption status.

If it's Encrypted, you may want to setUserPassword to decrypt it.

setUserPassword :: File -> ByteString -> IO Bool

Set user password to decrypt PDF file.

Use empty bytestring to set the default password. Returns True on success. See also setDecryptor.

defaultUserPassword :: ByteString

The default user password