Commit 2fd5a43f6756584958b369553906ca74e7085436
1 parent
42bff9f4
Add ChangeLog entries for refactoring work
Showing
2 changed files
with
32 additions
and
9 deletions
ChangeLog
| 1 | +2022-02-01 Jay Berkenbilt <ejb@ql.org> | ||
| 2 | + | ||
| 3 | + * The --json flag now takes a version number as an optional | ||
| 4 | + parameter. The default will remain version 1 for compatibility. | ||
| 5 | + This enables future code to use --json=latest to always get the | ||
| 6 | + latest version or to use a specific version. At this time, there's | ||
| 7 | + only version 1, but a version 2 may appear in a future qpdf. | ||
| 8 | + | ||
| 9 | + * Major refactor: all functionality from the qpdf CLI is now | ||
| 10 | + available for library users using the QPDFJob class. See comments | ||
| 11 | + in include/qpdf/QPDFJob.hh and a new chapter about QPDFJob in the | ||
| 12 | + manual. QPDFJob provides fluent interfaces for setting options | ||
| 13 | + that exactly map to command-line arguments. There are also methods | ||
| 14 | + for initializing QPDFJob from an argv array and from a JSON | ||
| 15 | + object. | ||
| 16 | + | ||
| 17 | + * A light C API around basic QPDFJob functionality is in | ||
| 18 | + include/qpdf/qpdf-job-c.h.p | ||
| 19 | + | ||
| 20 | + * Add new functions version of QUtil::call_main_from_wmain that | ||
| 21 | + takes a constant argv array. | ||
| 22 | + | ||
| 1 | 2022-01-31 Jay Berkenbilt <ejb@ql.org> | 23 | 2022-01-31 Jay Berkenbilt <ejb@ql.org> |
| 2 | 24 | ||
| 3 | * Have --json-help just output the JSON object, leaving a | 25 | * Have --json-help just output the JSON object, leaving a |
| @@ -8,9 +30,8 @@ | @@ -8,9 +30,8 @@ | ||
| 8 | 30 | ||
| 9 | 2022-01-28 Jay Berkenbilt <ejb@ql.org> | 31 | 2022-01-28 Jay Berkenbilt <ejb@ql.org> |
| 10 | 32 | ||
| 11 | - * Add QPDFUsage exception, which is thrown by JSONHandler, | ||
| 12 | - QPDFArgParser, and QPDFJob to indicate command-line usage or job | ||
| 13 | - configuration errors. | 33 | + * Add QPDFUsage exception, which is thrown by QPDFJob to indicate |
| 34 | + command-line usage or job configuration errors. | ||
| 14 | 35 | ||
| 15 | 2022-01-22 Jay Berkenbilt <ejb@ql.org> | 36 | 2022-01-22 Jay Berkenbilt <ejb@ql.org> |
| 16 | 37 | ||
| @@ -25,11 +46,6 @@ | @@ -25,11 +46,6 @@ | ||
| 25 | to QPDFObjectHandle with corresponding functions added to the C | 46 | to QPDFObjectHandle with corresponding functions added to the C |
| 26 | API. Thanks to m-holger for the contribution. | 47 | API. Thanks to m-holger for the contribution. |
| 27 | 48 | ||
| 28 | -2022-01-19 Jay Berkenbilt <ejb@ql.org> | ||
| 29 | - | ||
| 30 | - * Add a JSONHandler class that allows sax-like, recursive handling | ||
| 31 | - of JSON objects. | ||
| 32 | - | ||
| 33 | 2022-01-17 Jay Berkenbilt <ejb@ql.org> | 49 | 2022-01-17 Jay Berkenbilt <ejb@ql.org> |
| 34 | 50 | ||
| 35 | * Add JSON::parse. Now qpdf's JSON class implements a | 51 | * Add JSON::parse. Now qpdf's JSON class implements a |
| @@ -43,6 +59,14 @@ | @@ -43,6 +59,14 @@ | ||
| 43 | 59 | ||
| 44 | 2022-01-11 Jay Berkenbilt <ejb@ql.org> | 60 | 2022-01-11 Jay Berkenbilt <ejb@ql.org> |
| 45 | 61 | ||
| 62 | + * Major overhaul of documentation and help for the qpdf | ||
| 63 | + command-line tool. qpdf --help is now broken into topics rather | ||
| 64 | + than being one great wall of text, and the command-line arguments | ||
| 65 | + are indexed in the manual. The entire text of the "Running qpdf" | ||
| 66 | + chapter has been reviewed thoroughly. Many thanks once again to | ||
| 67 | + M. Holger for a detailed review and editorial assistance with the | ||
| 68 | + manual. | ||
| 69 | + | ||
| 46 | * Bug fix: add missing characters from PDF doc encoding. | 70 | * Bug fix: add missing characters from PDF doc encoding. |
| 47 | Fixes #606. | 71 | Fixes #606. |
| 48 | 72 |
TODO
| 1 | Next | 1 | Next |
| 2 | ==== | 2 | ==== |
| 3 | 3 | ||
| 4 | -* High-level API/doc overhaul: #593 | ||
| 5 | * Add user-defined initializer `QPDFObjectHandle operator ""_qpdf` to | 4 | * Add user-defined initializer `QPDFObjectHandle operator ""_qpdf` to |
| 6 | be like QPDFObjectHandle::parse: `auto oh = "<< /a (b) >>"_qpdf;` | 5 | be like QPDFObjectHandle::parse: `auto oh = "<< /a (b) >>"_qpdf;` |
| 7 | * Add QPDF_MAJOR_VERSION, QPDF_MINOR_VERSION to some header, possibly | 6 | * Add QPDF_MAJOR_VERSION, QPDF_MINOR_VERSION to some header, possibly |