API contract: qpdf_get_qpdf_version() returns a static

Jay Berkenbilt
1 parent 5f3f7882
Showing 5 changed files with 12 additions and 3 deletions
ChangeLog
include/qpdf/QPDF.hh
include/qpdf/qpdf-c.h
libqpdf/QPDF.cc
libqpdf/qpdf-c.cc
 2022-02-05  Jay Berkenbilt  <ejb@ql.org>
+	* Add comments letting people know that the version string
+	returned by QPDF::QPDFVersion and qpdf_get_qpdf_version is static.
+
 	* Add QUtil::make_unique_cstr to return a std::unique_ptr<char[]>
 	as an alternative to QUtil::copy_string and
 	QUtil::make_shared_cstr.
@@ -773,7 +773,7 @@ class QPDF
     friend class Pipe;
   private:
-    static std::string qpdf_version;
+    static std::string const qpdf_version;
     class ObjCache
     {
@@ -171,7 +171,9 @@ extern &quot;C&quot; {
     QPDF_DLL
     void qpdf_silence_errors(qpdf_data qpdf);
-    /* Returns the version of the qpdf software */
+    /* Returns the version of the qpdf software. This is guaranteed to
+     * be a static value.
+     */
     QPDF_DLL
     char const* qpdf_get_qpdf_version();
@@ -26,7 +26,9 @@
 #include <qpdf/QPDF_Stream.hh>
 #include <qpdf/QPDF_Array.hh>
-std::string QPDF::qpdf_version(QPDF_VERSION);
+// This must be a fixed value. This API returns a const reference to
+// it, and the C API relies on its being static as well.
+std::string const QPDF::qpdf_version(QPDF_VERSION);
 static char const* EMPTY_PDF =
     "%PDF-1.3\n"
@@ -178,6 +180,7 @@ QPDF::StringDecrypter::decryptString(std::string&amp; val)
 std::string const&
 QPDF::QPDFVersion()
 {
+    // The C API relies on this being a static value.
     return QPDF::qpdf_version;
 }
@@ -161,6 +161,7 @@ static QPDF_ERROR_CODE trap_errors(
 char const* qpdf_get_qpdf_version()
 {
     QTC::TC("qpdf", "qpdf-c called qpdf_get_qpdf_version");
+    // The API guarantees that this is a static value.
     return QPDF::QPDFVersion().c_str();
 }