diff options
author | Jay Berkenbilt <ejb@ql.org> | 2022-07-24 22:54:48 +0200 |
---|---|---|
committer | Jay Berkenbilt <ejb@ql.org> | 2022-07-31 16:32:55 +0200 |
commit | bb96499b613265b3d9cf2146af09283a4b99ef13 (patch) | |
tree | ecf2ae2ac567a9df00729886bb8e3777348e8d5a /include | |
parent | 0e3d4cdc9753ae59d42ff8478b0769196899032b (diff) | |
download | qpdf-bb96499b613265b3d9cf2146af09283a4b99ef13.tar.zst |
Update docs and prepare QPDF::writeJSON for changes
Add additional parameters that will be needed to call QPDF::writeJSON
in partial mode.
Diffstat (limited to 'include')
-rw-r--r-- | include/qpdf/QPDF.hh | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/include/qpdf/QPDF.hh b/include/qpdf/QPDF.hh index a80ddcd5..639e16c4 100644 --- a/include/qpdf/QPDF.hh +++ b/include/qpdf/QPDF.hh @@ -134,8 +134,17 @@ class QPDF void updateFromJSON(std::shared_ptr<InputSource>); // Write qpdf json format to the pipeline "p". The only supported - // version is 2. The finish() method is called on the pipeline at - // the end. The decode_level parameter controls which streams are + // version is 2. + // + // If the value of "complete" is true, a complete JSON object + // containing only the "qpdf" key is written to the pipeline, and + // finish() is called on the pipeline at the end. If the value of + // "complete" is false, the "qpdf" key and its value are written + // to the pipeline assuming that a dictionary is already open, and + // finish() is not called. The parameter first_key indicates + // whether this is the first key if in-progress dictionary. + // + // The decode_level parameter controls which streams are // uncompressed in the JSON. Use qpdf_dl_none to preserve all // stream data exactly as it appears in the input. The possible // values for json_stream_data can be found in qpdf/Constants.h @@ -158,6 +167,8 @@ class QPDF void writeJSON( int version, Pipeline* p, + bool complete, + bool first_key, qpdf_stream_decode_level_e decode_level, qpdf_json_stream_data_e json_stream_data, std::string const& file_prefix, |