PureBasic Requires Chilkat v11.7.0+

Remove PDF Objects Nothing Refers To

See more PDF Optimization Examples

Demonstrates removeUnreferenced. When a page, an image or a whole section is replaced in an editor, the objects it used often stay in the file with nothing pointing at them any more. They are not old revisions -- they are in the current revision, simply unreachable -- so only a reachability walk from the document catalog finds them. In a publication assembled over several editing passes this is frequently the largest single saving. PureBasic

IncludeFile "CkPdf.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  This example requires the Chilkat API to have been previously unlocked.
    ;  See Global Unlock Sample for sample code.

    ;  The PDF used in this example is available at watersense_accomplishments.pdf

    pdf.i = CkPdf::ckCreate()
    If pdf.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkPdf::ckLoadFile(pdf,"qa_data/pdf/watersense_accomplishments.pdf")
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        ProcedureReturn
    EndIf

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    jsonOut.i = CkJsonObject::ckCreate()
    If jsonOut.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkPdf::ckOptimize(pdf,"audit",json,jsonOut)
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkJsonObject::ckDispose(jsonOut)
        ProcedureReturn
    EndIf

    Debug "fileSize: " + Str(CkJsonObject::ckIntOf(jsonOut,"fileSize"))
    Debug "removeUnreferenced would save: " + Str(CkJsonObject::ckIntOf(jsonOut,"estimatedSavings.removeUnreferenced"))

    ;  Optimize with the defaults and see how many objects were actually dropped.
    success = CkPdf::ckOptimize(pdf,"optimize",json,jsonOut)
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkJsonObject::ckDispose(jsonOut)
        ProcedureReturn
    EndIf

    success = CkPdf::ckWriteFile(pdf,"qa_output/watersense_optimized.pdf")
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkJsonObject::ckDispose(jsonOut)
        ProcedureReturn
    EndIf

    Debug "objects removed: " + Str(CkJsonObject::ckIntOf(jsonOut,"actions.removeUnreferenced.count"))
    Debug "bytes saved:     " + Str(CkJsonObject::ckIntOf(jsonOut,"actions.removeUnreferenced.bytesSaved"))

    ;  Nothing a page needs is ever removed: the walk starts at the document catalog and follows every
    ;  reference, including the ones in annotations, the structure tree, named destinations and the
    ;  optional-content configuration.
    Debug "pages after: " + Str(CkPdf::ckNumPages(pdf))


    CkPdf::ckDispose(pdf)
    CkJsonObject::ckDispose(json)
    CkJsonObject::ckDispose(jsonOut)


    ProcedureReturn
EndProcedure