Add QUtil::FileCloser to the public API

Jay Berkenbilt
1 parent 0fe8d447
Showing 3 changed files with 32 additions and 20 deletions
ChangeLog
include/qpdf/QUtil.hh
libqpdf/QUtil.cc
+2022-05-18  Jay Berkenbilt  <ejb@ql.org>
+
+        * Add QUtil::FileCloser to the public API. This is a simple inline
+        class to help with automatic file closing.
+
 2022-05-17  Jay Berkenbilt  <ejb@ql.org>
  
         * Allow passing *uninitialized* (not null) objects to
@@ -114,6 +114,33 @@ namespace QUtil
     QPDF_DLL
     FILE* fopen_wrapper(std::string const&, FILE*);
  
+    // This is a little class to help with automatic closing files.
+    // You can do something like
+    //
+    // QUtil::FileCloser fc(QUtil::safe_fopen(filename, "rb"));
+    //
+    // and then use fc.f to the file. Be sure to actually declare a
+    // variable of type FileCloser. Using it as a temporary won't work
+    // because it will close the file as soon as it goes out of scope.
+    class FileCloser
+    {
+      public:
+        FileCloser(FILE* f) :
+            f(f)
+        {
+        }
+
+        ~FileCloser()
+        {
+            if (f) {
+                fclose(f);
+                f = nullptr;
+            }
+        }
+
+        FILE* f;
+    };
+
     // Attempt to open the file read only and then close again
     QPDF_DLL
     bool file_can_be_opened(char const* filename);
@@ -305,26 +305,6 @@ static std::map&lt;unsigned long, unsigned char&gt; unicode_to_pdf_doc = {
     {0x20ac, 0xa0},
 };
  
-namespace
-{
-    class FileCloser
-    {
-      public:
-        FileCloser(FILE* f) :
-            f(f)
-        {
-        }
-
-        ~FileCloser()
-        {
-            fclose(f);
-        }
-
-      private:
-        FILE* f;
-    };
-} // namespace
-
 template <typename T>
 static std::string
 int_to_string_base_internal(T num, int base, int length)