8b320e3f5d
* Refactor cmake file to have GSL as an interface CMake supports header only libraries as INTERFACE libraries. Using interfaces libraries make is easier for users to use the library because one just need to "link" agaisnt the library and necessary include paths, definitions, flags... will be taken care of. This commit creates a new interface library called GSL. It then add the following things to the GSL library: - compiler flags ex: (-std=c++14) - definitions ex: _SCL_SECURE_NO_WARNINGS - include paths ex: include/gsl - natvis file Another project can now have the GSL project as a git submodule and one only need to add the two following lines to their project to use the GSL. add_subdirectory(GSL) target_link_libraries(<some target> GSL) After cmake 3.8.0 a lot of the logic can be simplified. Right now the cmake file has an if for version checking, but when the minimun required version is 3.8.0 one can just delete the branching and keep the simpler version. * Cut support for c++11 Compiling on GCC6.2 with only the c++11 flag will generate compilation errors. For example some of the errors are related to the use of enable_if_t which is a c++14 feature. To avoid compilation errors this comiit removes c++11 support on linux. * Refactor code that pulls unittest-cpp Two minor changes: - uses cmake to find a proper installation of git (in case user does not have it on the path) - checks for the CMakeLists file instead. This is needed for the build itself and seems like a better way to do the checking * Refactor tests so they show together on VS This commit will make a VS geenrated project to group all tests under GSL_tests * Refactor tests configuration This creates a test configuration interface and add all the previous compiler options to that interface. compiler options are now sorted so it is easier to find them, and also one per line, so that modifications are easier to track from git. |
||
|---|---|---|
| include/gsl | ||
| tests | ||
| .clang-format | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| appveyor.yml | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| GSL.natvis | ||
| LICENSE | ||
| README.md | ||
GSL: Guideline Support Library 
The Guideline Support Library (GSL) contains functions and types that are suggested for use by the C++ Core Guidelines maintained by the Standard C++ Foundation. 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 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. gsl/span), it is simplest to just include 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 for more information about contributing.
Project Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Quick Start
Supported Platforms
The test suite that exercises GSL has been built and passes successfully on the following platforms:1)
- Windows using Visual Studio 2015
- Windows using Visual Studio 2017
- Windows using Clang/LLVM 3.6
- Windows using GCC 5.1
- GNU/Linux using Clang/LLVM 3.6
- GNU/Linux using GCC 5.1
- OS X Yosemite using Xcode with AppleClang 7.0.0.7000072
- OS X Yosemite using GCC-5.2.0
- FreeBSD 10.x with Clang/LLVM 3.6
If you successfully port GSL to another platform, we would love to hear from you. Please submit an issue to let us know. Also please consider contributing any changes that were necessary back to this project to benefit the wider community.
1) For gsl::byte to work correctly with Clang and GCC you might have to use the -fno-strict-aliasing compiler option.
Building the tests
To build the tests, you will require the following:
- CMake, version 2.8.7 or later to be installed and in your PATH.
- UnitTest-cpp, to be cloned under the tests/unittest-cpp directory of your GSL source.
These steps assume the source code of this repository has been cloned into a directory named c:\GSL.
-
Create a directory to contain the build outputs for a particular architecture (we name it c:\GSL\build-x86 in this example).
cd GSL md build-x86 cd build-x86 -
Configure CMake to use the compiler of your choice (you can see a list by running
cmake --help).cmake -G "Visual Studio 14 2015" c:\GSL -
Build the test suite (in this case, in the Debug configuration, Release is another good choice).
cmake --build . --config Debug -
Run the test suite.
ctest -C Debug
All tests should pass - indicating your platform is fully supported and you are ready to use the GSL types!
Using the libraries
As the types are entirely implemented inline in headers, there are no linking requirements.
You can copy the 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\include in the example above) or installation folder (after running the install). Eg.
MSVC++
/I c:\GSL\include
GCC/clang
-I$HOME/dev/GSL/include
Include the library using:
#include <gsl/gsl>
Debugging visualization support
For Visual Studio users, the file GSL.natvis in the root directory of the repository can be added to your project if you would like more helpful visualization of GSL types in the Visual Studio debugger than would be offered by default.