para/GSL

mirror of https://github.com/microsoft/GSL.git synced 2024-11-03 17:56:43 -05:00

Guidelines Support Library

Go to file

Neil MacIntosh 398abc8fa6 Merge pull request #111 from neilmacintosh/master Adding noexcept to finally, final_act, narrow_cast. Fixes #92.		2015-09-30 15:15:01 -07:00
include	Adding noexcept to finally, final_act, narrow_cast. Fixes #92 .	2015-09-30 15:10:24 -07:00
tests	Renamed namespace to 'gsl'. Renamed macro to configure testing.	2015-09-29 16:41:37 -07:00
.gitignore	Initial commit of library files.	2015-08-20 18:09:14 -07:00
.travis.yml	add travis testing (gcc5, clang36)	2015-09-23 17:43:36 +02:00
CMakeLists.txt	add travis testing (gcc5, clang36)	2015-09-23 17:43:36 +02:00
CONTRIBUTING.md	Corrected grammatical error...	2015-09-22 13:38:47 -04:00
LICENSE	Adding CONTRIBUTING.md and fixing up README.md, LICENSE	2015-08-23 08:34:32 -07:00
README.md	Update list of known platforms where GSL was successfully tested	2015-09-28 04:43:59 -07:00

README.md

GSL: Guidelines Support Library

The Guidelines 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 array_view<>, string_view<>, owner<> and others.

The entire implementation is provided inline in the headers under the include directory.

While some types have been broken out into their own headers (e.g. include/array_view.h), it is simplest to just 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 as well as ports to other platforms. Please see CONTRIBUTING.md for more information about contributing.

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
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.

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\vs14-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.

Just place the contents of the 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!