scope-guard/README.md

Scope Guard

Implementation of Scope Guards (scope_exit, scope_success, scope_fail) and unique_resource as proposed in P0052R5 (former N3949).

There’s a C++14 implementation on the cpp14 Branch.

Compatibility

This implementation conforms to P0052, except:

Namespace

The namespace sr is used instead of std.

Filenames

The filenames contain a .h extension. To enable the compatible header as specified in the document the CMake option ENABLE_COMPAT_HEADER can be used. This will generate and install an additional header named scope (without file extension).

Implementation decisions

Factory functions

The Factory functions for both types are kept for the C++14 implementations as deduction guides aren’t available.

Documentation

• P0052R5 - Generic Scope Guard and RAII Wrapper for the Standard Library (P. Sommerlad, A. L. Sandoval, E. Niebler, D. Krügler)
• N3949 - Scoped Resource - Generic RAII Wrapper for the Standard Library (P. Sommerlad, A. L. Sandoval)

License

GNU General Public License (GPL)

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.