spvBinaryDestroy(nullptr) is a no-op.

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 0dcdce3..b35e04a 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -161,6 +161,7 @@ if (NOT ${SPIRV_SKIP_EXECUTABLES})
       ${CMAKE_CURRENT_SOURCE_DIR}/test/TestFixture.h
       ${CMAKE_CURRENT_SOURCE_DIR}/test/UnitSPIRV.h
 
+      ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryDestroy.cpp
       ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryEndianness.cpp
       ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryHeaderGet.cpp
       ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryToText.cpp

diff --git a/include/libspirv/libspirv.h b/include/libspirv/libspirv.h
index 863bd88..292cd6a 100644 (file)
--- a/include/libspirv/libspirv.h
+++ b/include/libspirv/libspirv.h
@@ -441,7 +441,9 @@ spv_result_t spvBinaryToText(const spv_binary binary, const uint32_t options,
                              const spv_ext_inst_table extInstTable,
                              spv_text *pText, spv_diagnostic *pDiagnostic);
 
-/// @brief Free a binary stream from memory
+/// @brief Free a binary stream from memory.
+///
+/// This is a no-op if binary is a null pointer.
 ///
 /// @param binary stream to destroy
 void spvBinaryDestroy(spv_binary binary);

diff --git a/test/BinaryDestroy.cpp b/test/BinaryDestroy.cpp
new file mode 100644 (file)
index 0000000..03ebb2b
--- /dev/null
+++ b/test/BinaryDestroy.cpp
@@ -0,0 +1,46 @@
+// Copyright (c) 2015 The Khronos Group Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and/or associated documentation files (the
+// "Materials"), to deal in the Materials without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Materials, and to
+// permit persons to whom the Materials are furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Materials.
+//
+// MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS
+// KHRONOS STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS
+// SPECIFICATIONS AND HEADER INFORMATION ARE LOCATED AT
+//    https://www.khronos.org/registry/
+//
+// THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
+
+#include "UnitSPIRV.h"
+
+namespace {
+
+TEST(BinaryDestroy, Null) {
+  // There is no state or return value to check. Just check
+  // for the ability to call the API without abnormal termination.
+  spvBinaryDestroy(nullptr);
+}
+
+// Check safety of destroying a validly constructed binary.
+TEST(BinaryDestroy, Something) {
+  spv_binary binary = new spv_binary_t;
+  const int fewest_words_possible = 5;  // The SPIR-V preamble is 5 words long.
+  binary->code = new uint32_t[fewest_words_possible];
+  binary->wordCount = fewest_words_possible;
+  spvBinaryDestroy(binary);
+}
+
+}  // anonymous namespace