para/GSL
1
0
Fork 0
mirror of https://github.com/microsoft/GSL.git synced 2024-11-03 17:56:43 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
Guidelines Support Library
500 Commits 15 Branches 9 Tags 18 MiB
C++ 94.6%
CMake 5.4%
51ae678d08
Go to file
Anna Gringauze 51ae678d08
Add usage for check-and-unwrap of MS STL iterators (#687) 
* Add usage for check-and-unwrap of MS STL iterators

This is Billy ONeal's PR #682 with a typo fixed.

See corresponding change here:
ca77129308
That change officially exposes the STL's range checking machinery,
available in MSVC++ "15.8"+
This change augments GSL span::iterator to call into that newly exposed
machinery.

_Verify_range(cit, cit)
Requests that the iterator type check that the parameters form a valid
[First, Last) range iterator pair. This replaces _DEBUG_RANGE and
supporting machinery. The standard library provides a version for
pointers under _IDL != 0; otherwise they are normally provided via
hidden friend functions. Note that declaring some of these hidden
friends for "wrapper" iterators like move_iterator and reverse_iterator
triggers VSO#610735.

cit._Verify_offset(difference_type _Off)
For random-access iterators, performs any asserts that would be
performed by i += _Off; except with possibly a better error message and
without moving the iterator.

cit._Unwrapped()
Returns an "unchecked" or "unwrapped" iterator which has previously been
validated. The iterator may have been validated by a call to
_Verify_range or _Verify_offset (above), or by seeking a checked
iterator to a "high water mark" point.

it._Seek_to(cit) / it._Seek_to(return value from _Unwrapped())
Moves the position of the checked iterator it to the position of the
unchecked iterator supplied. Generally not intended to perform range
checks.

* Fixed build break in VS2015

* fixed constexpr build break when using VS2015
2018-05-22 18:07:49 -07:00
include/gsl Add usage for check-and-unwrap of MS STL iterators (#687) 2018-05-22 18:07:49 -07:00
tests not_null constructor is now explicit (#659) 2018-04-24 19:11:43 -07:00
.clang-format Applied clang-format to the source. 2016-07-20 13:17:47 -07:00
.gitignore Fix catch installation issue (#540) 2017-08-16 18:38:47 -07:00
.travis.yml Update .travis.yml 2018-05-07 01:18:08 +03:00
appveyor.yml Move from unittest-cpp to catch for unit testing. (#533) 2017-07-13 13:53:56 -07:00
CMakeLists.txt v2.0 Patch (#641) 2018-04-27 12:56:25 -07:00
CONTRIBUTING.md Fix inconsistent naming 2016-08-14 13:20:32 +08:00
GSL.natvis Rename final_act in GSL.natvis (#593) 2018-02-11 12:18:00 -08:00
LICENSE Adding CONTRIBUTING.md and fixing up README.md, LICENSE 2015-08-23 08:34:32 -07:00
README.md Cmake version updated in README (#669) 2018-05-01 12:00:37 -07:00
ThirdPartyNotices.txt Move from unittest-cpp to catch for unit testing. (#533) 2017-07-13 13:53:56 -07:00

README.md

GSL: Guideline Support Library Build Status Build status

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

Usage of Third Party Libraries

This project makes use of the Catch testing library. Please see the ThirdPartyNotices.txt file for details regarding the licensing of Catch.

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
  • Windows using Intel C++ Compiler 18.0
  • GNU/Linux using Clang/LLVM 3.6
  • GNU/Linux using GCC 5.1
  • OS X Yosemite using Xcode with Apple Clang 7.0.0.7000072
  • OS X Yosemite using GCC-5.2.0
  • OS X Sierra 10.12.4 using Apple LLVM version 8.1.0 (Clang-802.0.42)
  • OS X El Capitan (10.11) using Xcode with AppleClang 8.0.0.8000042
  • OS X High Sierra 10.13.2 (17C88) using Apple LLVM version 9.0.0 (clang-900.0.39.2)
  • 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 3.1.3 or later to be installed and in your PATH.

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

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.