Rename QPDFValueProxy.hh and QPDFValueProxy.cc

Preparing to change the class name back to QPDFObject

Rename QPDFValueProxy.hh and QPDFValueProxy.cc
Preparing to change the class name back to QPDFObject
Jay Berkenbilt
1 parent c7a4967d
Showing 8 changed files with 26 additions and 13 deletions
cSpell.json
include/qpdf/QPDFObject.hh
libqpdf/CMakeLists.txt
libqpdf/QPDF.cc
libqpdf/QPDFValueProxy.cc → libqpdf/QPDFObject.cc
libqpdf/QPDFObjectHandle.cc
libqpdf/QPDFValue.cc
libqpdf/qpdf/QPDFValueProxy.hh → libqpdf/qpdf/QPDFObject_private.hh
@@ -425,7 +425,6 @@
     "qpdftypes",
     "qpdfusage",
     "qpdfvalue",
-    "qpdfvalueproxy",
     "qpdfwriter",
     "qpdfx",
     "qpdfxrefentry",
@@ -19,14 +19,24 @@
 // continue to consider qpdf to be licensed under those terms. Please
 // see the manual for additional information.
-#ifndef QPDFOBJECT_HH
-#define QPDFOBJECT_HH
+#ifndef QPDFOBJECT_OLD_HH
+#define QPDFOBJECT_OLD_HH
+
+// **********************************************************************
+//
+//   This file is for backward compatibility. The header file for the
+//   internal QPDFObject class (not part of the public API) is in
+//   QPDFObject_private.hh (not installed).
+//
+// **********************************************************************
 // ABI: in qpdf 12, leave this file in place and have it generate an
 // error. This is to prevent someone from being able to successfully
 // include this file and get a copy from a previous installation
 // thereby accidentally creating sources depend on having an older
-// version installed.
+// version installed. When enough time has passed, this file can be
+// removed, and libqpdf/qpdf/QPDFObject_private.hh can be renamed to
+// libqpdf/qpdf/QPDFObject.hh.
 #ifndef QPDF_OBJECT_NOWARN
 // ABI: remove this file in qpdf 12
@@ -66,4 +76,4 @@ class QPDFObject
     QPDFObject& operator=(QPDFObject const&) = delete;
 };
-#endif // QPDFOBJECT_HH
+#endif // QPDFOBJECT_OLD_HH
@@ -72,6 +72,7 @@ set(libqpdf_SOURCES
   QPDFMatrix.cc
   QPDFNameTreeObjectHelper.cc
   QPDFNumberTreeObjectHelper.cc
+  QPDFObject.cc
   QPDFObjectHandle.cc
   QPDFObjGen.cc
   QPDFOutlineDocumentHelper.cc
@@ -85,7 +86,6 @@ set(libqpdf_SOURCES
   QPDFTokenizer.cc
   QPDFUsage.cc
   QPDFValue.cc
-  QPDFValueProxy.cc
   QPDFWriter.cc
   QPDFXRefEntry.cc
   QPDF_Array.cc
@@ -21,7 +21,7 @@
 #include <qpdf/Pl_OStream.hh>
 #include <qpdf/QPDFExc.hh>
 #include <qpdf/QPDFLogger.hh>
-#include <qpdf/QPDFValueProxy.hh>
+#include <qpdf/QPDFObject_private.hh>
 #include <qpdf/QPDF_Array.hh>
 #include <qpdf/QPDF_Dictionary.hh>
 #include <qpdf/QPDF_Null.hh>
-#include <qpdf/QPDFValueProxy.hh>
+#include <qpdf/QPDFObject_private.hh>
 #include <qpdf/QPDF.hh>
 #include <qpdf/QPDF_Destroyed.hh>
@@ -7,9 +7,9 @@
 #include <qpdf/QPDFExc.hh>
 #include <qpdf/QPDFLogger.hh>
 #include <qpdf/QPDFMatrix.hh>
+#include <qpdf/QPDFObject_private.hh>
 #include <qpdf/QPDFPageObjectHelper.hh>
 #include <qpdf/QPDFParser.hh>
-#include <qpdf/QPDFValueProxy.hh>
 #include <qpdf/QPDF_Array.hh>
 #include <qpdf/QPDF_Bool.hh>
 #include <qpdf/QPDF_Dictionary.hh>
 #include <qpdf/QPDFValue.hh>
-#include <qpdf/QPDFValueProxy.hh>
+#include <qpdf/QPDFObject_private.hh>
 std::shared_ptr<QPDFValueProxy>
 QPDFValue::do_create(QPDFValue* object)
-#ifndef QPDFVALUEPROXY_HH
-#define QPDFVALUEPROXY_HH
+#ifndef QPDFOBJECT_HH
+#define QPDFOBJECT_HH
+
+// NOTE: This file is called QPDFObject_private.hh instead of
+// QPDFObject.hh because of include/qpdf/QPDFObject.hh. See comments
+// there for an explanation.
 #include <qpdf/Constants.h>
 #include <qpdf/DLL.h>
@@ -149,4 +153,4 @@ class QPDFValueProxy
     std::shared_ptr<QPDFValue> value;
 };
-#endif // QPDFVALUEPROXY_HH
+#endif // QPDFOBJECT_HH