Merge pull request #14 from dermojo/extend-ci

Extend ci

Author: dermojo

.clang-tidy

@@ -0,0 +1,24 @@
+---
+# enable useful checks and disable a bunch of false positives :-(
+# TODO: splitting into multiple lines doesn't seem to work...
+Checks: 'clan*,cert*,misc*,perf*,cppc*,mode*,-*pointer-arithmetic,-*vararg,-*reinterpret-cast,-*array-to-pointer-decay,-*union-access,-cppcoreguidelines-pro-type-member-init,-cert-dcl50-cpp,-cppcoreguidelines-c-copy-assignment-signature,-misc-unconventional-assign-operator,-cppcoreguidelines-no-malloc,-cppcoreguidelines-pro-bounds-constant-array-index,-cert-err60-cpp'
+
+WarningsAsErrors: ''
+HeaderFilterRegex: '.*'
+AnalyzeTemporaryDtors: false
+User:            daniel
+CheckOptions:
+  - key:             modernize-loop-convert.MaxCopySize
+    value:           '16'
+  - key:             modernize-loop-convert.MinConfidence
+    value:           reasonable
+  - key:             modernize-loop-convert.NamingStyle
+    value:           CamelCase
+  - key:             modernize-pass-by-value.IncludeStyle
+    value:           llvm
+  - key:             modernize-replace-auto-ptr.IncludeStyle
+    value:           llvm
+  - key:             modernize-use-nullptr.NullMacros
+    value:           'NULL'
+...
+

.travis.yml

@@ -46,16 +46,74 @@ matrix:
           packages:
             - clang-3.9
       env: MYCC=clang-3.9 MYCXX=clang++-3.9
+    - compiler: clang
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+            - llvm-toolchain-trusty-4.0
+          packages:
+            - clang-4.0
+      env: MYCC=clang-4.0 MYCXX=clang++-4.0
+    - os: linux
+      env:
+        - TEST="Clang Format"
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+            - llvm-toolchain-trusty
+          packages:
+            - clang-format
+      script:
+        - mkdir build
+        - cd build
+        - cmake ..
+        - make format
+        - |
+          if [[ -n $(git diff) ]]; then
+            echo "You must run make format before submitting a pull request"
+            echo ""
+            git diff
+            exit -1
+          fi
+    - os: linux
+      env:
+        - TEST="Clang Tidy"
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+            - llvm-toolchain-trusty-4.0
+          packages:
+            - clang-tidy-4.0
+            - clang-4.0
+      script:
+        - mkdir build
+        - cd build
+        - cmake .. -DCMAKE_C_COMPILER=clang-4.0 -DCMAKE_CXX_COMPILER=clang++-4.0
+        - make tidy >output.txt
+        - |
+          if [[ -n $(grep "warning: " output.txt) ]] || [[ -n $(grep "error: " output.txt) ]]; then
+              echo "You must pass the clang tidy checks before submitting a pull request"
+              echo ""
+              grep --color -E '^|warning: |error: ' output.txt
+              exit -1;
+          else
+              echo -e "\033[1;32m\xE2\x9C\x93 passed:\033[0m $1";
+          fi
 
 before_install:
   - sudo apt-get install -y libgtest-dev
 
-script:
+before_script:
   - cd /usr/src/gtest
   - sudo cmake -DCMAKE_C_COMPILER=$MYCC -DCMAKE_CXX_COMPILER=$MYCXX .
   - sudo cmake --build .
   - sudo mv libg* /usr/local/lib/
   - cd $TRAVIS_BUILD_DIR
+
+script:
   - mkdir build
   - cd build
   - cmake -DCMAKE_C_COMPILER=$MYCC -DCMAKE_CXX_COMPILER=$MYCXX ..

CMakeLists.txt

@@ -76,3 +76,43 @@ endif()
 # use this to enable C++17 tests (esp. string_view) with GCC/Clang
 # (but comment the CXX_STANDARD* settings above)
 #target_compile_options(testlib PUBLIC -std=c++1z)
+
+# run clang-format on all files
+list(APPEND CLANG_FORMAT_ARGS
+    -style=file
+    -i
+    ${CMAKE_SOURCE_DIR}/include/*.hpp
+    ${CMAKE_SOURCE_DIR}/include/spsl/*.hpp
+    ${CMAKE_SOURCE_DIR}/test/*.hpp
+    ${CMAKE_SOURCE_DIR}/test/*.cpp
+)
+
+if(NOT WIN32 STREQUAL "1")
+    add_custom_target(
+        format
+        COMMAND clang-format ${CLANG_FORMAT_ARGS}
+        COMMENT "running clang-format"
+    )
+else()
+    add_custom_target(
+        format
+        COMMAND clang-format.exe ${CLANG_FORMAT_ARGS}
+        COMMENT "running clang-format"
+    )
+endif()
+
+# clang tidy support (using version 4.0 atm)
+# (since this is a header-only library, it's sufficient to check a single source that includes
+#  everything)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(CLANG_TIDY /usr/bin/clang-tidy-4.0)
+list(APPEND CLANG_TIDY_ARGS
+    -p .
+    ${CMAKE_SOURCE_DIR}/test/example.cpp
+)
+
+add_custom_target(
+    tidy
+    COMMAND ${CLANG_TIDY} ${CLANG_TIDY_ARGS}
+    COMMENT "running clang tidy"
+)

README.md

@@ -38,14 +38,14 @@ The SPSL itself only relies on the STL and has no dependencies. To compile the t
 * [CMake](https://cmake.org/) 3.2 or higher
 * [GoogleTest](https://github.com/google/googletest) 1.8
 
-Supported compilers (we'll, the ones I've tested) include GCC 4.9/5/6 and clang 3.8/3.9 on Linux, 
-Microsoft Visual Studio 2013 (Update 5) and Microsoft Visual Studio 2015.
+Supported compilers (we'll, the ones I've tested) include GCC 4.9/5/6 and clang 3.8/3.9/4.0
+on Linux, Microsoft Visual Studio 2013 (Update 5) and Microsoft Visual Studio 2015.
 
 
 ## Running the tests
 
 SPSL comes with a lot of unit tests. They are compiled into the `testlib` executable, which can
-be run standalone or from cmake/ctest. 
+be run standalone or from cmake/ctest.
 
 To build on Linux, simply run CMake and execute the tests:
     mkdir build
@@ -75,4 +75,4 @@ tl;dr: Feel free to use and modify the code or to include it in your commercial
 ## Acknowledgements
 
 This library uses the MurmurHash3 hash functions, copied thankfully from
-[https://github.com/aappleby/smhasher](https://github.com/aappleby/smhasher). Thanks a lot! 
+[https://github.com/aappleby/smhasher](https://github.com/aappleby/smhasher). Thanks a lot!

include/spsl/compat.hpp

@@ -11,7 +11,6 @@
 #include <system_error>
 
 #define SPSL_HAS_NOEXCEPT
-#define SPSL_HAS_DEFAULT_MOVE
 #define SPSL_HAS_CONSTEXPR_ARRAY
 
 #ifdef _WIN32   // Windows
@@ -26,7 +25,6 @@ typedef intptr_t ssize_t;
 #define noexcept
 #define constexpr const
 #undef SPSL_HAS_NOEXCEPT
-#undef SPSL_HAS_DEFAULT_MOVE
 #endif
 
 // can't use constexpr values in array definitions...

include/spsl/hash.hpp

@@ -117,7 +117,7 @@ FORCE_INLINE uint64_t fmix64(uint64_t k)
 
 inline void MurmurHash3_x86_32(const void* key, const uint32_t len, uint32_t seed, void* out)
 {
-    const uint8_t* data = reinterpret_cast<const uint8_t*>(key);
+    auto data = reinterpret_cast<const uint8_t*>(key);
     const uint32_t nblocks = len / 4;
 
     uint32_t h1 = seed;
@@ -128,7 +128,7 @@ inline void MurmurHash3_x86_32(const void* key, const uint32_t len, uint32_t see
     //----------
     // body
 
-    const uint32_t* blocks = reinterpret_cast<const uint32_t*>(data);
+    auto blocks = reinterpret_cast<const uint32_t*>(data);
 
     for (uint32_t i = 0; i < nblocks; ++i)
     {
@@ -181,7 +181,7 @@ inline void MurmurHash3_x86_32(const void* key, const uint32_t len, uint32_t see
 inline void MurmurHash3_x64_128(const void* key, const std::size_t len, const uint32_t seed,
                                 void* out)
 {
-    const uint8_t* data = reinterpret_cast<const uint8_t*>(key);
+    auto data = reinterpret_cast<const uint8_t*>(key);
     const std::size_t nblocks = len / 16;
 
     uint64_t h1 = seed;
@@ -193,7 +193,7 @@ inline void MurmurHash3_x64_128(const void* key, const std::size_t len, const ui
     //----------
     // body
 
-    const uint64_t* blocks = reinterpret_cast<const uint64_t*>(data);
+    auto blocks = reinterpret_cast<const uint64_t*>(data);
 
     for (std::size_t i = 0; i < nblocks; i++)
     {

include/spsl/pagealloc.hpp

@@ -57,22 +57,14 @@ class SensitivePageAllocator
     {
         AllocationInfo(pointer a, std::size_t s) : addr(a), size(s) {}
         AllocationInfo(const AllocationInfo&) noexcept = default;
-#ifdef SPSL_HAS_DEFAULT_MOVE
-        AllocationInfo(AllocationInfo&&) noexcept = default;
-#else
         AllocationInfo(AllocationInfo&& other) noexcept : addr(other.addr), size(other.size) {}
-#endif
         AllocationInfo& operator=(const AllocationInfo&) noexcept = default;
-#ifdef SPSL_HAS_DEFAULT_MOVE
-        AllocationInfo& operator=(AllocationInfo&&) noexcept = default;
-#else
         AllocationInfo& operator=(AllocationInfo&& other) noexcept
         {
             addr = other.addr;
             size = other.size;
             return *this;
         }
-#endif
         ~AllocationInfo() = default;
 
         /// the allocated address
@@ -195,6 +187,11 @@ class SensitivePageAllocator
         }
     }
 
+    // disable copy & move
+    SensitivePageAllocator(const SensitivePageAllocator&) = delete;
+    SensitivePageAllocator(SensitivePageAllocator&&) = delete;
+    SensitivePageAllocator& operator=(const SensitivePageAllocator&) = delete;
+    SensitivePageAllocator& operator=(SensitivePageAllocator&&) = delete;
 
     /**
      * Returns the "default instance", a.k.a. a static instance of the allocator. The instance is

include/spsl/storage_array.hpp

@@ -307,7 +307,11 @@ class StorageArray
         *this = std::move(tmp);
     }
 
-    void swap(this_type& other) { std::swap(*this, other); }
+    void swap(this_type& other) noexcept
+    {
+        std::swap(m_length, other.m_length);
+        std::swap(m_buffer, other.m_buffer);
+    }
 
 protected:
     void assign_nothrow(const char_type* s, size_type len) noexcept
@@ -319,7 +323,7 @@ class StorageArray
 
 protected:
     /// number of bytes (*not* characters) in the buffer, not including the terminating NUL
-    size_type m_length;
+    size_type m_length; // NOLINT: disable modernize-use-default-member-init
     /// the underlying buffer: an array that can hold MaxSize characters (+ terminating NUL)
     std::array<char_type, MaxSize + 1> m_buffer;
 };

include/spsl/stringbase.hpp

@@ -101,11 +101,7 @@ class StringBase : public StringCore<StorageType>
     // default destructor, move and copy
     ~StringBase() = default;
     StringBase(const this_type&) = default;
-#ifdef SPSL_HAS_DEFAULT_MOVE
-    StringBase(this_type&&) = default;
-#else
-    StringBase(this_type&& rhs) { this->swap(rhs); }
-#endif
+    StringBase(this_type&& rhs) noexcept : StringBase() { this->swap(rhs); }
 
     /// construct from another storage instance
     explicit StringBase(const storage_type& storage) : base_type(storage) {}
@@ -138,15 +134,11 @@ class StringBase : public StringCore<StorageType>
 
     // default copy & move
     this_type& operator=(const this_type&) = default;
-#ifdef SPSL_HAS_DEFAULT_MOVE
-    this_type& operator=(this_type&&) = default;
-#else
-    this_type& operator=(this_type&& rhs)
+    this_type& operator=(this_type&& rhs) noexcept
     {
         this->swap(rhs);
         return *this;
     }
-#endif
 
     /// allow assignment from another string-like container (may even be a vector...)
     template <typename StringClass, typename std::enable_if<is_compatible_string<
@@ -295,8 +287,8 @@ class StringBase : public StringCore<StorageType>
     template <class InputIt, typename = checkInputIter<InputIt>>
     this_type& replace(const_iterator first, const_iterator last, InputIt first2, InputIt last2)
     {
-        size_type pos = static_cast<size_type>(first - data());
-        size_type count = static_cast<size_type>(last - first);
+        auto pos = static_cast<size_type>(first - data());
+        auto count = static_cast<size_type>(last - first);
         if (pos > size())
             throw std::out_of_range("replace: pos > size()");
         if (pos + count > size())
@@ -556,17 +548,9 @@ struct hash<spsl::StringBase<StorageType>>
 
     hash() = default;
     hash(const hash&) = default;
-#ifdef SPSL_HAS_DEFAULT_MOVE
-    hash(hash&&) = default;
-#else
-    hash(hash&&) {}
-#endif
+    hash(hash&&) noexcept {}
     hash& operator=(const hash&) = default;
-#ifdef SPSL_HAS_DEFAULT_MOVE
-    hash& operator=(hash&&) = default;
-#else
-    hash& operator=(hash&&) { return *this; }
-#endif
+    hash& operator=(hash&&) noexcept { return *this; }
     ~hash() = default;
 
     size_t operator()(const argument_type& s) const