mirror of
https://github.com/microsoft/GSL.git
synced 2026-07-04 23:50:54 +02:00
Werner Henze
b2f6bec48e
* clang-format improvements - Add a clang-format linter check to the PR pipeline - Apply clang-format to files where the linter initially failed - Remove `CommentPragmas` from `.clang-format` - Remove all `// clang-format off` and `// NO-FORMAT` as they are not needed - Remove a commented out `GSL_SUPPRESS` * clang-format 20 * pipeline fail * Update .github/workflows/clang-format.yml Co-authored-by: Carson Radtke <nosrac925@gmail.com> * output used clang-format version * installed version is 18 which replaces "GSL_SUPPRESS(bounds.1)" with "GSL_SUPPRESS(bounds .1)" * only include/gsl, not include to prevent formatting of include/CMakeLists.txt * apply clang-format[-20] In a VS2026 developer command prompt I ran `clang-format -i include\gsl\* --assume-filename x.cpp`. This was necessary because VS GUI does not format files without an extension :(. Please note that `--assume-filename` is necessary here, otherwise the files will not be formatted. Surprisingly the behaviour for the formatter differs from the behaviour of `lang-format(-20) --dry-run --Werror include/gsl/*` where clang-format recognizes that the files is C++. * change "#if 0" back to original version with comments only * formatting scripts for windows and linux for linux with linter (shfmt and shellcheck) * add WhitespaceSensitiveMacros: [GSL_SUPPRESS] * provide path for clang-format (Windows) Currently not clear to me: On my personal computer at home, when I start "Developer Command Prompt for VS18", I can run `clang-format` without providing the path. On my managed (domain) company computer, when I start "Developer Command Prompt for VS18", I can NOT run `clang-format` without providing the path. I need to call `"%VCINSTALLDIR%Tools\Llvm\bin\clang-format"`. I have no idea what the difference is. At least the version `"%VCINSTALLDIR%Tools\Llvm\bin\clang-format"` works on both computers, so I add the path. --------- Co-authored-by: Werner Henze <w.henze@avm.de> Co-authored-by: Carson Radtke <nosrac925@gmail.com> Co-authored-by: Werner Henze <werner.henze+gitcommits@posteo.de>
77 lines
3.0 KiB
C++
77 lines
3.0 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// 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.
|
|
//
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef GSL_NARROW_H
|
|
#define GSL_NARROW_H
|
|
#include "./assert" // for GSL_SUPPRESS
|
|
#include "./util" // for narrow_cast
|
|
#include <exception> // for std::exception
|
|
namespace gsl
|
|
{
|
|
struct narrowing_error : public std::exception
|
|
{
|
|
const char* what() const noexcept override { return "narrowing_error"; }
|
|
};
|
|
|
|
// narrow() : a checked version of narrow_cast() that throws if the cast changed the value
|
|
template <class T, class U, typename std::enable_if<std::is_arithmetic<T>::value>::type* = nullptr>
|
|
GSL_SUPPRESS(type.1)
|
|
GSL_SUPPRESS(es.46) // The warning suggests that a floating->unsigned conversion can occur
|
|
// in the static_cast below, and that gsl::narrow should be used instead.
|
|
// Suppress this warning, since gsl::narrow is defined in terms of
|
|
// static_cast
|
|
constexpr T narrow(U u)
|
|
{
|
|
constexpr const bool is_different_signedness =
|
|
(std::is_signed<T>::value != std::is_signed<U>::value);
|
|
|
|
GSL_SUPPRESS(es.103) // don't overflow
|
|
GSL_SUPPRESS(es.104) // don't underflow
|
|
GSL_SUPPRESS(p.2) // don't rely on undefined behavior
|
|
const T t = narrow_cast<T>(
|
|
u); // While this is technically undefined behavior in some cases (i.e., if the source value
|
|
// is of floating-point type and cannot fit into the destination integral type), the
|
|
// resultant behavior is benign on the platforms that we target (i.e., no hardware trap
|
|
// representations are hit).
|
|
|
|
#if defined(__clang__) || defined(__GNUC__)
|
|
#pragma GCC diagnostic push
|
|
#pragma GCC diagnostic ignored "-Wfloat-equal"
|
|
#endif
|
|
// Note: NaN will always throw, since NaN != NaN
|
|
if (static_cast<U>(t) != u || (is_different_signedness && ((t < T{}) != (u < U{}))))
|
|
{
|
|
throw narrowing_error{};
|
|
}
|
|
#if defined(__clang__) || defined(__GNUC__)
|
|
#pragma GCC diagnostic pop
|
|
#endif
|
|
|
|
return t;
|
|
}
|
|
|
|
template <class T, class U, typename std::enable_if<!std::is_arithmetic<T>::value>::type* = nullptr>
|
|
GSL_SUPPRESS(type.1) constexpr T narrow(U u)
|
|
{
|
|
const T t = narrow_cast<T>(u);
|
|
|
|
if (static_cast<U>(t) != u) { throw narrowing_error{}; }
|
|
|
|
return t;
|
|
}
|
|
} // namespace gsl
|
|
#endif // GSL_NARROW_H
|