Add a blank line after the first header included in each source

Jay Berkenbilt
1 parent 2abb3055
Showing 63 changed files with 73 additions and 0 deletions
README-maintainer
libqpdf/AES_PDF_native.cc
libqpdf/BitStream.cc
libqpdf/BufferInputSource.cc
libqpdf/ClosedFileInputSource.cc
libqpdf/ContentNormalizer.cc
libqpdf/CryptoRandomDataProvider.cc
libqpdf/FileInputSource.cc
libqpdf/InputSource.cc
libqpdf/JSON.cc
libqpdf/JSONHandler.cc
libqpdf/MD5.cc
libqpdf/MD5_native.cc
libqpdf/NNTree.cc
libqpdf/OffsetInputSource.cc
libqpdf/Pipeline.cc
libqpdf/Pl_AES_PDF.cc
libqpdf/Pl_ASCII85Decoder.cc
libqpdf/Pl_ASCIIHexDecoder.cc
libqpdf/Pl_Buffer.cc
@@ -86,6 +86,15 @@ GOOGLE OSS-FUZZ
  
 CODING RULES
  
+* In a source file, include the header file that declares the source
+  class first followed by a blank line. If a config file is needed
+  first, put a blank line between that and the header followed by
+  another blank line. This assures that each header file is included
+  first at least once, thereby ensuring that it explicitly includes
+  all the headers it needs, which in turn alleviates lots of header
+  ordering problems. The blank line ensures that formatters don't
+  messt his up by resorting the headers.
+
 * Avoid atoi. Use QUtil::string_to_int instead. It does
   overflow/underflow checking.
  
 #include <qpdf/AES_PDF_native.hh>
+
 #include <qpdf/QUtil.hh>
 #include <cstring>
 #include <assert.h>
 #include <qpdf/BitStream.hh>
+
 #include <qpdf/QIntC.hh>
  
 // See comments in bits.cc
 #include <qpdf/BufferInputSource.hh>
+
 #include <qpdf/QIntC.hh>
 #include <string.h>
 #include <stdexcept>
 #include <qpdf/ClosedFileInputSource.hh>
+
 #include <qpdf/FileInputSource.hh>
  
 ClosedFileInputSource::Members::Members(char const* filename) :
 #include <qpdf/ContentNormalizer.hh>
+
 #include <qpdf/QUtil.hh>
  
 ContentNormalizer::ContentNormalizer() :
 #include <qpdf/CryptoRandomDataProvider.hh>
+
 #include <qpdf/QPDFCryptoProvider.hh>
  
 CryptoRandomDataProvider::CryptoRandomDataProvider()
 #include <qpdf/FileInputSource.hh>
+
 #include <string.h>
 #include <qpdf/QUtil.hh>
 #include <qpdf/QPDFExc.hh>
 #include <qpdf/InputSource.hh>
+
 #include <string.h>
 #include <stdexcept>
 #include <qpdf/QTC.hh>
 #include <qpdf/JSON.hh>
+
 #include <qpdf/QUtil.hh>
 #include <qpdf/QTC.hh>
 #include <stdexcept>
 #include <qpdf/JSONHandler.hh>
+
 #include <qpdf/QUtil.hh>
 #include <qpdf/QTC.hh>
 #include <qpdf/QPDFUsage.hh>
 #include <qpdf/MD5.hh>
+
 #include <qpdf/QUtil.hh>
 #include <qpdf/QIntC.hh>
 #include <qpdf/QPDFCryptoProvider.hh>
@@ -28,6 +28,7 @@
 /////////////////////////////////////////////////////////////////////////
  
 #include <qpdf/MD5_native.hh>
+
 #include <qpdf/QUtil.hh>
 #include <qpdf/QIntC.hh>
  
 #include <qpdf/NNTree.hh>
+
 #include <qpdf/QTC.hh>
 #include <qpdf/QUtil.hh>
  
 #include <qpdf/OffsetInputSource.hh>
+
 #include <limits>
 #include <sstream>
 #include <stdexcept>
 #include <qpdf/Pipeline.hh>
+
 #include <stdexcept>
  
 Pipeline::Pipeline(char const* identifier, Pipeline* next) :
 #include <qpdf/Pl_AES_PDF.hh>
+
 #include <qpdf/QUtil.hh>
 #include <cstring>
 #include <assert.h>
 #include <qpdf/Pl_ASCII85Decoder.hh>
+
 #include <qpdf/QTC.hh>
 #include <stdexcept>
 #include <string.h>
 #include <qpdf/Pl_ASCIIHexDecoder.hh>
+
 #include <qpdf/QTC.hh>
 #include <stdexcept>
 #include <string.h>
 #include <qpdf/Pl_Buffer.hh>
+
 #include <stdexcept>
 #include <algorithm>
 #include <assert.h>
 #include <qpdf/Pl_Count.hh>
+
 #include <qpdf/QIntC.hh>
  
 Pl_Count::Members::Members() :
 #include <qpdf/Pl_Flate.hh>
+
 #include <zlib.h>
 #include <string.h>
 #include <limits.h>
 #include <qpdf/Pl_MD5.hh>
+
 #include <stdexcept>
  
 Pl_MD5::Pl_MD5(char const* identifier, Pipeline* next) :
 #include <qpdf/Pl_PNGFilter.hh>
+
 #include <qpdf/QTC.hh>
 #include <stdexcept>
 #include <string.h>
 #include <qpdf/Pl_QPDFTokenizer.hh>
+
 #include <qpdf/QTC.hh>
 #include <qpdf/QUtil.hh>
 #include <qpdf/BufferInputSource.hh>
 #include <qpdf/Pl_RC4.hh>
+
 #include <qpdf/QUtil.hh>
  
 Pl_RC4::Pl_RC4(char const* identifier, Pipeline* next,
 #include <qpdf/Pl_SHA2.hh>
+
 #include <stdexcept>
 #include <cstdio>
 #include <qpdf/PointerHolder.hh>
 #include <qpdf/qpdf-config.h>  // include first for large file support
+
 #include <qpdf/Pl_StdioFile.hh>
+
 #include <qpdf/QUtil.hh>
 #include <stdexcept>
 #include <errno.h>
 #include <qpdf/Pl_TIFFPredictor.hh>
+
 #include <qpdf/QTC.hh>
 #include <qpdf/BitStream.hh>
 #include <qpdf/BitWriter.hh>
 #include <qpdf/qpdf-config.h>  // include first for large file support
+
 #include <qpdf/QPDF.hh>
  
 #include <atomic>
 #include <qpdf/QPDFAnnotationObjectHelper.hh>
+
 #include <qpdf/QTC.hh>
 #include <qpdf/QPDFMatrix.hh>
 #include <qpdf/QUtil.hh>
 #include <qpdf/QPDFArgParser.hh>
+
 #include <qpdf/QUtil.hh>
 #include <qpdf/QIntC.hh>
 #include <qpdf/QTC.hh>
 #include <qpdf/QPDFCryptoProvider.hh>
+
 #include <qpdf/qpdf-config.h>
 #include <qpdf/QUtil.hh>
 #include <stdexcept>
 #include <qpdf/QPDFCrypto_gnutls.hh>
+
 #include <qpdf/QIntC.hh>
 #include <qpdf/QUtil.hh>
 #include <cstring>
 #include <qpdf/QPDFCrypto_native.hh>
+
 #include <qpdf/QUtil.hh>
  
 #ifdef USE_INSECURE_RANDOM
 #include <qpdf/QPDFEFStreamObjectHelper.hh>
+
 #include <qpdf/QIntC.hh>
 #include <qpdf/QUtil.hh>
 #include <qpdf/Pl_Count.hh>
 #include <qpdf/QPDFExc.hh>
+
 #include <qpdf/QUtil.hh>
  
 QPDFExc::QPDFExc(qpdf_error_code_e error_code,
 #include <qpdf/QPDFFileSpecObjectHelper.hh>
+
 #include <qpdf/QTC.hh>
 #include <qpdf/QPDF.hh>
 #include <qpdf/QUtil.hh>
 #include <qpdf/QPDFFormFieldObjectHelper.hh>
+
 #include <qpdf/QTC.hh>
 #include <qpdf/QPDFAcroFormDocumentHelper.hh>
 #include <qpdf/QPDFAnnotationObjectHelper.hh>
@@ -115,6 +115,7 @@ ArgParser::argVersion()
 void
 ArgParser::argCopyright()
 {
+    // clang-format off
     // Make sure the output looks right on an 80-column display.
     //               1         2         3         4         5         6         7         8
     //      12345678901234567890123456789012345678901234567890123456789012345678901234567890
@@ -153,6 +154,7 @@ ArgParser::argCopyright()
         << std::endl
         << "see the manual for additional information."
         << std::endl;
+    // clang-format on
 }
  
 void
 #include <qpdf/QPDFJob.hh>
+
 #include <qpdf/QUtil.hh>
 #include <qpdf/QTC.hh>
  
 #include <qpdf/QPDFJob.hh>
+
 #include <qpdf/JSONHandler.hh>
 #include <qpdf/QPDFUsage.hh>
 #include <qpdf/QUtil.hh>
 #include <qpdf/QPDFMatrix.hh>
+
 #include <qpdf/QUtil.hh>
 #include <algorithm>
  
 #include <qpdf/QPDFNameTreeObjectHelper.hh>
+
 #include <qpdf/NNTree.hh>
  
 class NameTreeDetails: public NNTreeDetails
 #include <qpdf/QPDFNumberTreeObjectHelper.hh>
+
 #include <qpdf/NNTree.hh>
 #include <qpdf/QIntC.hh>
  
 #include <qpdf/QPDFObjGen.hh>
+
 #include <qpdf/QUtil.hh>
  
 QPDFObjGen::QPDFObjGen() :
 #include <qpdf/QPDFOutlineDocumentHelper.hh>
+
 #include <qpdf/QTC.hh>
  
 QPDFOutlineDocumentHelper::Members::~Members()
 #include <qpdf/QPDFOutlineObjectHelper.hh>
+
 #include <qpdf/QPDFOutlineDocumentHelper.hh>
 #include <qpdf/QTC.hh>
  
 #include <qpdf/QPDFPageDocumentHelper.hh>
+
 #include <qpdf/QPDFAcroFormDocumentHelper.hh>
 #include <qpdf/QUtil.hh>
 #include <qpdf/QTC.hh>
 #include <qpdf/QPDFPageLabelDocumentHelper.hh>
+
 #include <qpdf/QTC.hh>
  
 QPDFPageLabelDocumentHelper::Members::~Members()
 #include <qpdf/QPDFPageObjectHelper.hh>
+
 #include <qpdf/QTC.hh>
 #include <qpdf/QPDF.hh>
 #include <qpdf/Pl_Concatenate.hh>
 #include <qpdf/QPDFSystemError.hh>
+
 #include <qpdf/QUtil.hh>
 #include <string.h>
  
 #include <qpdf/qpdf-config.h>  // include first for large file support
+
 #include <qpdf/QPDFWriter.hh>
  
 #include <assert.h>
 #include <qpdf/QPDFXRefEntry.hh>
+
 #include <qpdf/QPDFExc.hh>
 #include <qpdf/QUtil.hh>
 #include <qpdf/QIntC.hh>
 #include <qpdf/QPDF_Array.hh>
+
 #include <qpdf/QUtil.hh>
 #include <qpdf/QIntC.hh>
 #include <stdexcept>
 #include <qpdf/QPDF_Reserved.hh>
+
 #include <stdexcept>
  
 QPDF_Reserved::~QPDF_Reserved()
@@ -2,6 +2,7 @@
 #include <qpdf/qpdf-config.h>
  
 #include <qpdf/QUtil.hh>
+
 #include <qpdf/PointerHolder.hh>
 #include <qpdf/CryptoRandomDataProvider.hh>
 #include <qpdf/QPDFSystemError.hh>
 #include <qpdf/RC4.hh>
+
 #include <qpdf/QPDFCryptoProvider.hh>
  
 #include <string.h>
 #include <qpdf/RC4_native.hh>
+
 #include <qpdf/QIntC.hh>
  
 #include <string.h>
 #include <qpdf/SF_FlateLzwDecode.hh>
+
 #include <qpdf/Pl_PNGFilter.hh>
 #include <qpdf/Pl_TIFFPredictor.hh>
 #include <qpdf/Pl_Flate.hh>
 #include <qpdf/SHA2_native.hh>
+
 #include <stdexcept>
 #include <cstdio>
 #include <qpdf/PointerHolder.hh>
 #include <qpdf/SparseOHArray.hh>
+
 #include <stdexcept>
  
 SparseOHArray::SparseOHArray() :
 #include <qpdf/qpdf-c.h>
  
 #include <qpdf/QPDF.hh>
+
 #include <qpdf/QPDFWriter.hh>
 #include <qpdf/QTC.hh>
 #include <qpdf/QPDFExc.hh>