Merge branch 'master' into dev/neilmac/iterators

CMakeLists.txt

@@ -3,10 +3,10 @@ cmake_minimum_required(VERSION 2.8.7)
 project(GSL CXX)
 
 set(GSL_HEADERS
-    "include/gsl.h"
-    "include/gsl_assert.h"
-    "include/span.h"
-    "include/string_span.h"
+    "gsl/gsl"
+    "gsl/gsl_assert"
+    "gsl/span"
+    "gsl/string_span"
 )
 
 include_directories(

README.md

@@ -6,10 +6,10 @@ This repo contains Microsoft's implementation of GSL.
 
 The library includes types like `span<T>`, `string_span`, `owner<>` and others.
 
-The entire implementation is provided inline in the headers under the [include](./include) directory. The implementation generally assumes a platform that implements C++14 support. There are specific workarounds to support MSVC 2013 and 2015.
+The entire implementation is provided inline in the headers under the [gsl](./gsl) directory. The implementation generally assumes a platform that implements C++14 support. There are specific workarounds to support MSVC 2013 and 2015.
 
-While some types have been broken out into their own headers (e.g. [include/span.h](./include/span.h)),
-it is simplest to just include [gsl.h](./include/gsl.h) and gain access to the entire library.
+While some types have been broken out into their own headers (e.g. [gsl/span](./gsl/span)),
+it is simplest to just include [gsl/gsl](./gsl/gsl) and gain access to the entire library.
 
 > NOTE: We encourage contributions that improve or refine any of the types in this library as well as ports to
 other platforms. Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about contributing.
@@ -66,5 +66,19 @@ All tests should pass - indicating your platform is fully supported and you are
 ## Using the libraries
 As the types are entirely implemented inline in headers, there are no linking requirements.
 
-Just place the contents of the [include](./include) directory within your source tree so it is available
-to your compiler, then include the appropriate headers in your program, and away you go!
+You can copy the [gsl](./gsl) directory into your source tree so it is available
+to your compiler, then include the appropriate headers in your program.
+
+Alternatively set your compiler's *include path* flag to point to the GSL development folder (`c:\GSL` in the example above) or installation folder (after running the install). Eg.
+
+MSVC++
+
+    /I c:\GSL
+
+GCC/clang
+
+    -I$HOME/dev/GSL
+
+Include the library using:
+
+    #include <gsl/gsl>

gsl/gsl

@@ -19,11 +19,11 @@
 #ifndef GSL_GSL_H
 #define GSL_GSL_H
 
-#include "gsl_assert.h"  // Ensures/Expects
-#include "gsl_util.h"    // finally()/narrow()/narrow_cast()...
-#include "multi_span.h"  // multi_span, strided_span...
-#include "span.h"        // span
-#include "string_span.h" // zstring, string_span, zstring_builder...
+#include "gsl_assert"  // Ensures/Expects
+#include "gsl_util"    // finally()/narrow()/narrow_cast()...
+#include "multi_span"  // multi_span, strided_span...
+#include "span"        // span
+#include "string_span" // zstring, string_span, zstring_builder...
 #include <memory>
 
 #ifdef _MSC_VER

gsl/gsl_util

@@ -19,7 +19,7 @@
 #ifndef GSL_UTIL_H
 #define GSL_UTIL_H
 
-#include "gsl_assert.h" // Ensures/Expects
+#include "gsl_assert" // Ensures/Expects
 #include <array>
 #include <exception>
 #include <type_traits>

gsl/multi_span

@@ -19,9 +19,9 @@
 #ifndef GSL_MULTI_SPAN_H
 #define GSL_MULTI_SPAN_H
 
-#include "gsl_assert.h"
-#include "gsl_byte.h"
-#include "gsl_util.h"
+#include "gsl_assert"
+#include "gsl_byte"
+#include "gsl_util"
 #include <algorithm>
 #include <array>
 #include <cassert>

gsl/span

@@ -20,9 +20,9 @@
 #ifndef GSL_SPAN_H
 #define GSL_SPAN_H
 
-#include "gsl_assert.h"
-#include "gsl_byte.h"
-#include "gsl_util.h"
+#include "gsl_assert"
+#include "gsl_byte"
+#include "gsl_util"
 #include <array>
 #include <iterator>
 #include <limits>
@@ -681,10 +681,13 @@ as_writeable_bytes(span<ElementType, Extent> s) noexcept
 #undef noexcept
 
 #ifdef _MSC_VER
-#pragma warning(pop)
 #pragma pop_macro("noexcept")
 #endif
 
 #endif // GSL_THROW_ON_CONTRACT_VIOLATION
 
+#ifdef _MSC_VER
+#pragma warning(pop)
+#endif
+
 #endif // GSL_SPAN_H

gsl/string_span

@@ -19,9 +19,9 @@
 #ifndef GSL_STRING_SPAN_H
 #define GSL_STRING_SPAN_H
 
-#include "gsl_assert.h"
-#include "gsl_util.h"
-#include "span.h"
+#include "gsl_assert"
+#include "gsl_util"
+#include "span"
 #include <cstdint>
 #include <cstring>
 #include <string>

tests/CMakeLists.txt

@@ -9,7 +9,7 @@ endif()
 add_subdirectory(unittest-cpp)
 
 include_directories(
-    ../include
+    ..
     ./unittest-cpp
 )
 
@@ -33,7 +33,7 @@ else()
 endif()
 
 function(add_gsl_test name)
-    add_executable(${name} ${name}.cpp ../include/gsl.h ../include/gsl_assert.h ../include/gsl_util.h ../include/multi_span.h ../include/span.h ../include/string_span.h)
+    add_executable(${name} ${name}.cpp ../gsl/gsl ../gsl/gsl_assert ../gsl/gsl_util ../gsl/multi_span ../gsl/span ../gsl/string_span)
     target_link_libraries(${name} UnitTest++)
     install(TARGETS ${name}
         RUNTIME DESTINATION bin

tests/assertion_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h> 
-#include <gsl.h>
+#include <gsl/gsl>
 
 using namespace gsl;
 

tests/at_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h> 
-#include <gsl.h>
+#include <gsl/gsl>
 #include <vector>
 #include <initializer_list>
 

tests/bounds_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h> 
-#include <multi_span.h>
+#include <gsl/multi_span>
 #include <vector>
 
 using namespace std;

tests/byte_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h>
-#include <gsl_byte.h>
+#include <gsl/gsl_byte>
 
 #include <iostream>
 #include <list>

tests/multi_span_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h>
-#include <multi_span.h>
+#include <gsl/multi_span>
 
 #include <iostream>
 #include <list>

tests/notnull_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h> 
-#include <gsl.h>
+#include <gsl/gsl>
 #include <vector>
 
 using namespace gsl;

tests/owner_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h> 
-#include <gsl.h>
+#include <gsl/gsl>
 #include <functional>
 
 using namespace gsl;

tests/span_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h>
-#include <span.h>
+#include <gsl/span>
 
 #include <iostream>
 #include <list>

tests/strided_span_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h> 
-#include <multi_span.h>
+#include <gsl/multi_span>
 
 #include <string>
 #include <vector>

tests/string_span_tests.cpp

@@ -16,8 +16,9 @@
 
 #include <UnitTest++/UnitTest++.h>
 #include <cstdlib>
-#include <string_span.h>
+#include <gsl/string_span>
 #include <vector>
+#include <map>
 
 using namespace std;
 using namespace gsl;
@@ -942,7 +943,13 @@ SUITE(string_span_tests)
                 CHECK(*(str + 3) == L'\0');
             }
         }
+    }
 
+    TEST(Issue305)
+    {
+        std::map<gsl::cstring_span<>, int> foo = { { "foo", 0 },{ "bar", 1 } };
+        CHECK(foo["foo"] == 0);
+        CHECK(foo["bar"] == 1);
     }
 }
 

tests/utils_tests.cpp

@@ -15,7 +15,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <UnitTest++/UnitTest++.h>
-#include <gsl.h>
+#include <gsl/gsl>
 #include <functional>
 
 using namespace gsl;