Release v0.10.3

WanzenBug · WanzenBug · commit 2637a4e9e1a5 · 2019-05-06T13:15:02.000+02:00
* Add clang-tidy to CI pipeline
* Fix minor linting issue
* Fix example build
diff --git a/.clang-tidy b/.clang-tidy
@@ -0,0 +1,40 @@
+# https://clang.llvm.org/extra/clang-tidy/checks/list.html
+
+# gtest's TEST & TEST_F trigger
+# - cppcoreguidelines-owning-memory (TEST_F only)
+# - cppcoreguidelines-special-member-functions
+# - modernize-use-equals-delete
+
+# gtest's ASSERT_THROW & ASSERT_NO_THROW trigger
+# cppcoreguidelines-avoid-goto
+
+# gtest's ASSERT_EQ triggers
+# cppcoreguidelines-pro-type-vararg
+
+# cppcoreguidelines-pro-bounds-array-to-pointer-decay reports:
+#   lib/HdfFile.cpp:118:33: warning: do not implicitly decay an array into a pointer;
+#   consider using gsl::array_view or an explicit cast instead
+#        char nameGroup[MAX_NAME_LENGTH];
+#        ...
+#        if (name == std::string(nameGroup)) {
+#                                ^
+
+Checks: >-
+  bugprone-*,
+  cppcoreguidelines-*,
+  -cppcoreguidelines-avoid-goto,
+  -cppcoreguidelines-owning-memory,
+  -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
+  -cppcoreguidelines-pro-type-vararg,
+  -cppcoreguidelines-special-member-functions,
+  misc-*,
+  modernize-*,
+  -modernize-use-equals-delete,
+  performance-*,
+  readability-*,
+
+# TODO fix remaining warnings in this list
+WarningsAsErrors: >-
+  *,
+  -clang-diagnostic-return-type,
+  -cppcoreguidelines-pro-bounds-pointer-arithmetic,
diff --git a/.travis.yml b/.travis.yml
@@ -21,6 +21,10 @@ install:
 
 script:
 # https://cmake.org/cmake/help/v3.12/module/FindGTest.html
-- GTEST_ROOT="$PWD/gtest" cmake .
+- GTEST_ROOT="$PWD/gtest"
+  cmake
+  -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
+  -DCMAKE_CXX_CLANG_TIDY='clang-tidy;-p=compile_commands.json'
+  .
 - make --jobs=$(nproc)
 - tests/hdf4cpp-tests
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -67,6 +67,11 @@ endif ()
 option(HDF4CPP_BUILD_TESTS "Enable building tests" ON)
 option(HDF4CPP_BUILD_EXAMPLES "Enable building examples" ON)
 
+if (NOT DEFINED TEST_DATA_PATH)
+    set(TEST_DATA_PATH "${PROJECT_SOURCE_DIR}/tests/test_data/")
+    message(STATUS "No path to test data defined, using ${TEST_DATA_PATH} as default")
+endif ()
+
 if (HDF4CPP_BUILD_TESTS)
     add_subdirectory(tests)
 endif()
diff --git a/examples/ReadingSData.cpp b/examples/ReadingSData.cpp
@@ -6,6 +6,7 @@
 
 using namespace hdf4cpp;
 
+// NOLINTNEXTLINE(bugprone-exception-escape)
 int main() {
     // Open the file
     HdfFile file(TEST_DATA_PATH "small_test.hdf");
@@ -33,9 +34,9 @@ int main() {
     std::vector<int32> dims = item.getDims();
     for (const auto &dim : dims) {
         if (dim >= 1) {
-            ranges.push_back(Range(0, dim - 1));
+            ranges.emplace_back(0, dim - 1);
         } else {
-            ranges.push_back(Range(0, dim));
+            ranges.emplace_back(0, dim);
         }
     }
     item.read(vec, ranges);
diff --git a/examples/ReadingVData.cpp b/examples/ReadingVData.cpp
@@ -6,6 +6,7 @@
 
 using namespace hdf4cpp;
 
+// NOLINTNEXTLINE(bugprone-exception-escape)
 int main() {
     // Open the file
     HdfFile file(TEST_DATA_PATH "small_test.hdf");
@@ -43,4 +44,4 @@ int main() {
         }
         std::cout << std::endl;
     }
-}
+}
diff --git a/include/hdf4cpp/HdfAttribute.h b/include/hdf4cpp/HdfAttribute.h
@@ -51,8 +51,8 @@ class HdfAttribute : public HdfObject {
         int32 size() const;
 
       private:
-        int32 _size;
-        int32 dataType;
+        int32 _size{};
+        int32 dataType{};
 
         void get(void *dest);
         int32 getDataType() const;
@@ -81,17 +81,17 @@ class HdfAttribute : public HdfObject {
         int32 size() const;
 
       private:
-        int32 _size;
-        int32 dataType;
+        int32 _size{};
+        int32 dataType{};
         void get(void *dest);
         int32 getDataType() const;
     };
 
   public:
     HdfAttribute(const HdfAttribute &) = delete;
-    HdfAttribute(HdfAttribute &&other);
+    HdfAttribute(HdfAttribute &&other) noexcept;
     HdfAttribute &operator=(const HdfAttribute &attribute) = delete;
-    HdfAttribute &operator=(HdfAttribute &&other);
+    HdfAttribute &operator=(HdfAttribute &&other) noexcept;
     /// \returns the number of elements of the attribute data
     int32 size() const;
 
diff --git a/include/hdf4cpp/HdfFile.h b/include/hdf4cpp/HdfFile.h
@@ -20,9 +20,9 @@ class HdfFile : public HdfObject {
   public:
     HdfFile(const std::string &path);
     HdfFile(const HdfFile &file) = delete;
-    HdfFile(HdfFile &&file);
+    HdfFile(HdfFile &&file) noexcept;
     HdfFile &operator=(const HdfFile &file) = delete;
-    HdfFile &operator=(HdfFile &&file);
+    HdfFile &operator=(HdfFile &&file) noexcept;
     ~HdfFile();
 
     int32 getSId() const;
diff --git a/include/hdf4cpp/HdfItem.h b/include/hdf4cpp/HdfItem.h
@@ -61,9 +61,9 @@ class HdfAttribute;
 class HdfItem : public HdfObject {
   public:
     HdfItem(const HdfItem &item) = delete;
-    HdfItem(HdfItem &&item);
+    HdfItem(HdfItem &&other) noexcept;
     HdfItem &operator=(const HdfItem &item) = delete;
-    HdfItem &operator=(HdfItem &&it);
+    HdfItem &operator=(HdfItem &&it) noexcept;
 
     /// \returns The name of the item
     std::string getName() const;
@@ -216,7 +216,7 @@ class HdfItem : public HdfObject {
 
       private:
         int32 _size;
-        int32 dataType;
+        int32 dataType{};
         std::string name;
         std::vector<int32> dims;
     };
@@ -332,12 +332,11 @@ class HdfItem : public HdfObject {
         }
 
       private:
-        int32 _size;
         std::string name;
 
-        int32 nrRecords;
-        int32 interlace;
-        int32 recordSize;
+        int32 nrRecords{};
+        int32 interlace{};
+        int32 recordSize{};
     };
 
     HdfItem(HdfItemBase *item, int32 sId, int32 vId);
diff --git a/include/hdf4cpp/HdfObject.h b/include/hdf4cpp/HdfObject.h
@@ -24,6 +24,10 @@ class HdfObject {
             : endFunction(endFunction)
             , id(id) {
         }
+        HdfDestroyer(const HdfDestroyer& other)
+            : endFunction(other.endFunction)
+            , id(other.id) {
+        }
         ~HdfDestroyer() {
             endFunction(id);
         }
@@ -38,14 +42,24 @@ class HdfObject {
     /// then the destructor of the destroyer will call the end access function.
     class HdfDestroyerChain {
       public:
-        HdfDestroyerChain() {
-        }
-        HdfDestroyerChain(const HdfDestroyerChain &other)
+        HdfDestroyerChain() = default;
+        HdfDestroyerChain(const HdfDestroyerChain &other) noexcept
             : chain(other.chain) {
         }
+        HdfDestroyerChain(HdfDestroyerChain &&other) noexcept
+            : chain(std::move(other.chain)) {
+        }
+        HdfDestroyerChain &operator=(const HdfDestroyerChain &other) noexcept {
+            chain = other.chain; // copy
+            return *this;
+        }
+        HdfDestroyerChain &operator=(HdfDestroyerChain &&other) noexcept {
+            chain = std::move(other.chain);
+            return *this;
+        }
 
-        void pushBack(HdfDestroyer *destroyer) {
-            chain.push_back(std::shared_ptr<HdfDestroyer>(destroyer));
+        void emplaceBack(const std::function<int32(int32)> &endFunction, int32 id) {
+            chain.emplace_back(new HdfDestroyer(endFunction, id));
         }
 
       private:
@@ -54,12 +68,12 @@ class HdfObject {
 
   public:
     /// \returns the type of the object
-    virtual Type getType() const {
+    virtual Type getType() const noexcept {
         return type;
     }
 
     /// \returns the class type of the object
-    virtual ClassType getClassType() const {
+    virtual ClassType getClassType() const noexcept {
         return classType;
     }
 
@@ -69,16 +83,21 @@ class HdfObject {
         , classType(classType)
         , chain(chain) {
     }
+    HdfObject(const Type &type, const ClassType &classType, HdfDestroyerChain &&chain)
+        : type(type)
+        , classType(classType)
+        , chain(std::move(chain)) {
+    }
     HdfObject(const HdfObject *object)
         : type(object->getType())
         , classType(object->getClassType())
         , chain(object->chain) {
     }
 
-    virtual void setType(const Type &type) {
+    virtual void setType(const Type &type) noexcept {
         this->type = type;
     }
-    virtual void setClassType(const ClassType &classType) {
+    virtual void setClassType(const ClassType &classType) noexcept {
         this->classType = classType;
     }
 
diff --git a/lib/HdfAttribute.cpp b/lib/HdfAttribute.cpp
@@ -84,11 +84,11 @@ void hdf4cpp::HdfAttribute::HdfDataAttribute::get(void *dest) {
 int32 hdf4cpp::HdfAttribute::HdfDataAttribute::getDataType() const {
     return dataType;
 }
-hdf4cpp::HdfAttribute::HdfAttribute(HdfAttribute &&other)
+hdf4cpp::HdfAttribute::HdfAttribute(HdfAttribute &&other) noexcept
     : HdfObject(other.getType(), other.getClassType(), std::move(other.chain))
     , attribute(std::move(other.attribute)) {
 }
-hdf4cpp::HdfAttribute &hdf4cpp::HdfAttribute::operator=(HdfAttribute &&other) {
+hdf4cpp::HdfAttribute &hdf4cpp::HdfAttribute::operator=(HdfAttribute &&other) noexcept {
     attribute = std::move(other.attribute);
     setType(attribute->getType());
     setClassType(attribute->getClassType());
diff --git a/lib/HdfFile.cpp b/lib/HdfFile.cpp
@@ -23,32 +23,32 @@ hdf4cpp::HdfFile::HdfFile(const std::string &path)
 
     Vinitialize(vId);
 
-    chain.pushBack(new HdfDestroyer(&SDend, sId));
-    chain.pushBack(new HdfDestroyer(&Vfinish, vId));
-    chain.pushBack(new HdfDestroyer(&Hclose, vId));
+    chain.emplaceBack(&SDend, sId);
+    chain.emplaceBack(&Vfinish, vId);
+    chain.emplaceBack(&Hclose, vId);
 
     int32 loneSize = Vlone(vId, nullptr, 0);
     std::vector<int32> refs((size_t)loneSize);
     Vlone(vId, refs.data(), loneSize);
     for (const auto &ref : refs) {
-        loneRefs.push_back(std::pair<int32, Type>(ref, VGROUP));
+        loneRefs.emplace_back(ref, VGROUP);
     }
 
     int32 loneVdata = VSlone(vId, nullptr, 0);
     refs.resize((size_t)loneVdata);
     VSlone(vId, refs.data(), loneVdata);
     for (const auto &ref : refs) {
-        loneRefs.push_back(std::pair<int32, Type>(ref, VDATA));
+        loneRefs.emplace_back(ref, VDATA);
     }
 }
-hdf4cpp::HdfFile::HdfFile(HdfFile &&file)
+hdf4cpp::HdfFile::HdfFile(HdfFile &&file) noexcept
     : HdfObject(file.getType(), file.getClassType(), std::move(file.chain)) {
     sId = file.sId;
     vId = file.vId;
     loneRefs = std::move(file.loneRefs);
     file.sId = file.vId = FAIL;
 }
-hdf4cpp::HdfFile &hdf4cpp::HdfFile::operator=(HdfFile &&file) {
+hdf4cpp::HdfFile &hdf4cpp::HdfFile::operator=(HdfFile &&file) noexcept {
     setType(file.getType());
     setClassType(file.getClassType());
     chain = std::move(file.chain);
@@ -125,14 +125,14 @@ std::vector<int32> hdf4cpp::HdfFile::getGroupDataIds(const std::string &name) co
     return ids;
 }
 std::vector<hdf4cpp::HdfItem> hdf4cpp::HdfFile::getAll(const std::string &name) const {
+    const std::vector<int32> &dataset_ids = getDatasetIds(name);
+    const std::vector<int32> &group_ids = getGroupDataIds(name);
     std::vector<HdfItem> items;
-    std::vector<int32> ids;
-    ids = getDatasetIds(name);
-    for (const auto &id : ids) {
+    items.reserve(dataset_ids.size() + group_ids.size());
+    for (auto &id : dataset_ids) {
         items.push_back(HdfItem(new HdfItem::HdfDatasetItem(id, chain), sId, vId));
     }
-    ids = getGroupDataIds(name);
-    for (const auto &id : ids) {
+    for (auto &id : group_ids) {
         items.push_back(HdfItem(new HdfItem::HdfGroupItem(id, chain), sId, vId));
     }
     return items;
diff --git a/lib/HdfItem.cpp b/lib/HdfItem.cpp
@@ -18,7 +18,7 @@ hdf4cpp::HdfItem::HdfDatasetItem::HdfDatasetItem(int32 id, const HdfDestroyerCha
     dims = std::vector<int32>(dim, dim + size);
     _size = std::accumulate(dims.begin(), dims.end(), 1, std::multiplies<int32>());
     name = std::string(_name);
-    this->chain.pushBack(new HdfDestroyer(&SDendaccess, id));
+    this->chain.emplaceBack(&SDendaccess, id);
 }
 std::vector<int32> hdf4cpp::HdfItem::HdfDatasetItem::getDims() {
     return dims;
@@ -32,14 +32,13 @@ std::string hdf4cpp::HdfItem::HdfDatasetItem::getName() const {
 int32 hdf4cpp::HdfItem::HdfDatasetItem::getId() const {
     return id;
 }
-hdf4cpp::HdfItem::HdfDatasetItem::~HdfDatasetItem() {
-}
+hdf4cpp::HdfItem::HdfDatasetItem::~HdfDatasetItem() = default;
 hdf4cpp::HdfItem::HdfGroupItem::HdfGroupItem(int32 id, const HdfDestroyerChain &chain)
     : HdfItemBase(id, VGROUP, chain) {
     char _name[MAX_NAME_LENGTH];
     Vgetname(id, _name);
     name = std::string(_name);
-    this->chain.pushBack(new HdfDestroyer(&Vdetach, id));
+    this->chain.emplaceBack(&Vdetach, id);
 }
 std::vector<int32> hdf4cpp::HdfItem::HdfGroupItem::getDims() {
     raiseException(INVALID_OPERATION);
@@ -53,17 +52,15 @@ std::string hdf4cpp::HdfItem::HdfGroupItem::getName() const {
 int32 hdf4cpp::HdfItem::HdfGroupItem::getId() const {
     return id;
 }
-hdf4cpp::HdfItem::HdfGroupItem::~HdfGroupItem() {
-}
+hdf4cpp::HdfItem::HdfGroupItem::~HdfGroupItem() = default;
 hdf4cpp::HdfItem::HdfDataItem::HdfDataItem(int32 id, const HdfDestroyerChain &chain)
     : HdfItemBase(id, VDATA, chain) {
-    this->chain.pushBack(new HdfDestroyer(&VSdetach, id));
+    this->chain.emplaceBack(&VSdetach, id);
     char _name[MAX_NAME_LENGTH];
     VSinquire(id, &nrRecords, &interlace, nullptr, &recordSize, _name);
     name = std::string(_name);
 }
-hdf4cpp::HdfItem::HdfDataItem::~HdfDataItem() {
-}
+hdf4cpp::HdfItem::HdfDataItem::~HdfDataItem() = default;
 hdf4cpp::HdfAttribute hdf4cpp::HdfItem::HdfDataItem::getAttribute(const std::string &name) const {
     return HdfAttribute(new HdfAttribute::HdfDataAttribute(id, name, chain));
 }
@@ -82,13 +79,13 @@ hdf4cpp::HdfItem::HdfItem(HdfItemBase *item, int32 sId, int32 vId)
     , sId(sId)
     , vId(vId) {
 }
-hdf4cpp::HdfItem::HdfItem(HdfItem &&other)
+hdf4cpp::HdfItem::HdfItem(HdfItem &&other) noexcept
     : HdfObject(other.getType(), other.getClassType(), std::move(other.chain))
     , item(std::move(other.item))
     , sId(other.sId)
     , vId(other.vId) {
 }
-hdf4cpp::HdfItem &hdf4cpp::HdfItem::operator=(HdfItem &&it) {
+hdf4cpp::HdfItem &hdf4cpp::HdfItem::operator=(HdfItem &&it) noexcept {
     setType(it.getType());
     setClassType(it.getClassType());
     chain = std::move(it.chain);
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
diff --git a/tests/HdfFileTest.cpp b/tests/HdfFileTest.cpp

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`using namespace hdf4cpp;`
`8`	`8`
	`9`	`+// NOLINTNEXTLINE(bugprone-exception-escape)`
`9`	`10`	`int main() {`
`10`	`11`	`// Open the file`
`11`	`12`	`HdfFile file(TEST_DATA_PATH "small_test.hdf");`
`@@ -43,4 +44,4 @@ int main() {`
`43`	`44`	`}`
`44`	`45`	`std::cout << std::endl;`
`45`	`46`	`}`
`46`		`-}`
	`47`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -84,11 +84,11 @@ void hdf4cpp::HdfAttribute::HdfDataAttribute::get(void *dest) {`
`84`	`84`	`int32 hdf4cpp::HdfAttribute::HdfDataAttribute::getDataType() const {`
`85`	`85`	`return dataType;`
`86`	`86`	`}`
`87`		`-hdf4cpp::HdfAttribute::HdfAttribute(HdfAttribute &&other)`
	`87`	`+hdf4cpp::HdfAttribute::HdfAttribute(HdfAttribute &&other) noexcept`
`88`	`88`	`: HdfObject(other.getType(), other.getClassType(), std::move(other.chain))`
`89`	`89`	`, attribute(std::move(other.attribute)) {`
`90`	`90`	`}`
`91`		`-hdf4cpp::HdfAttribute &hdf4cpp::HdfAttribute::operator=(HdfAttribute &&other) {`
	`91`	`+hdf4cpp::HdfAttribute &hdf4cpp::HdfAttribute::operator=(HdfAttribute &&other) noexcept {`
`92`	`92`	`attribute = std::move(other.attribute);`
`93`	`93`	`setType(attribute->getType());`
`94`	`94`	`setClassType(attribute->getClassType());`