forked from microsoft/GSL
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Neil MacIntosh
committed
Aug 21, 2015
1 parent
8368329
commit a9dcbe0
Showing
17 changed files
with
4,177 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
tests/unittest-cpp |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
cmake_minimum_required(VERSION 3.2.2) | ||
|
||
project(GSL) | ||
|
||
include_directories( | ||
${CMAKE_CURRENT_BINARY_DIR} | ||
) | ||
|
||
enable_testing() | ||
|
||
add_subdirectory(tests) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Copyright (c) 2015 Microsoft Corporation. All rights reserved. | ||
|
||
This code is licensed under the MIT License (MIT). | ||
|
||
THE SOFTWARE IS 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 SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,62 @@ | ||
# GSL | ||
Guidelines Support Library | ||
# GSL: Guidelines Support Library | ||
|
||
This library contains functions and types that are suggested for use by the | ||
[C++ Coding Guidelines](https://github.com/Microsoft/CppCodingStandards/). | ||
|
||
These include types like `array_view<>`, `string_view<>`, `owner<>` and others. | ||
|
||
The entire implementation is provided inline in the headers under the [include](./include) directory. | ||
|
||
While some types have been broken out into their own headers (e.g. [include/array_view.h](./include/array_view.h)), | ||
it is simplest to just include [gsl.h](./include/gsl.h) and gain access to the entire library. | ||
|
||
> NOTE: We encourage contributions that improve or refine any of the types in this library. | ||
# Quick Start | ||
## Supported Platforms | ||
The test suite that exercises GSL has been built and passes successfully on the following platforms: | ||
|
||
* Windows using Visual Studio 2013 | ||
* Windows using Visual Studio 2015 | ||
* Windows using Clang\LLVM 3.6 | ||
* Windows using GCC 5.1 | ||
* Linux using Clang\LLVM 3.6 | ||
* Linux using GCC 5.1 | ||
|
||
> If you successfully port GSL to another platform, we would love to hear from you. Please consider contributing | ||
any changes that were necessary back to this project to benefit the wider community. | ||
|
||
## Building the tests | ||
To build the tests, you will require the following: | ||
|
||
* [CMake](http://cmake.org), version 3.3 or later to be installed and in your PATH. | ||
* [UnitTest-cpp](https://github.com/Microsoft/unittest-cpp), to be cloned under the [tests/unittest-cpp](./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`. | ||
|
||
1. Create a directory to contain the build outputs for a particular architecture (we name it c:\GSL\vs14-x86 in this example). | ||
|
||
cd GSL | ||
md build-x86 | ||
cd build-x86 | ||
|
||
2. 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 | ||
|
||
3. Build the test suite (in this case, in the Debug configuration, Release is another good choice). | ||
|
||
cmake --build . --config Debug | ||
|
||
4. 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. | ||
|
||
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! |
Oops, something went wrong.