Document that parseStream accepts stream that end with double null character

Author: SatyaRanjanDas-tomtom

cppparser/include/cppparser/cppparser.h

@@ -45,6 +45,13 @@ class CppParser
 
 public:
   std::unique_ptr<cppast::CppCompound> parseFile(const std::string& filename);
+  /**
+   * @brief Parses the given stream and returns the AST.
+   * @param stm The stream to parse.
+   * @param stmSize The size of the stream.
+   * @return The AST.
+   * @warning The stream \a stm must terminate with double null characters, i.e. the last 2 bytes must be '\0'.
+   */
   std::unique_ptr<cppast::CppCompound> parseStream(char* stm, size_t stmSize);
 
   void setErrorHandler(ErrorHandler errorHandler);

cppparser/src/cppparser.cpp

@@ -111,8 +111,8 @@ std::unique_ptr<cppast::CppCompound> CppParser::parseFile(const std::string& fil
 
 std::unique_ptr<cppast::CppCompound> CppParser::parseStream(char* stm, size_t stmSize)
 {
-  if (stm == nullptr || stmSize == 0)
-    return nullptr;
+  if ((stm == nullptr) || (stmSize < 2) || (stm[stmSize - 1] != '\0') || (stm[stmSize - 2] != '\0'))
+    throw std::invalid_argument("Stream must be valid and it must terminate with double null characters");
   return ::parseStream(stm, stmSize);
 }
 

cppparser/test/unit/embedded-snippet-test-base.h

@@ -59,7 +59,7 @@ class EmbeddedSnippetTestBase
    */
   std::string getTestSnippetParseStream(int lastSnippetBeforeLineNum) const
   {
-    return getTestSnippet(lastSnippetBeforeLineNum).append(3, '\0');
+    return getTestSnippet(lastSnippetBeforeLineNum).append(2, '\0');
   }
 };