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>
59 lines
1.9 KiB
C++
59 lines
1.9 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_ZSTRING_H
|
|
#define GSL_ZSTRING_H
|
|
|
|
#include "./span_ext" // for dynamic_extent
|
|
|
|
#include <cstddef> // for size_t, nullptr_t
|
|
|
|
namespace gsl
|
|
{
|
|
//
|
|
// czstring and wzstring
|
|
//
|
|
// These are "tag" typedefs for C-style strings (i.e. null-terminated character arrays)
|
|
// that allow static analysis to help find bugs.
|
|
//
|
|
// There are no additional features/semantics that we can find a way to add inside the
|
|
// type system for these types that will not either incur significant runtime costs or
|
|
// (sometimes needlessly) break existing programs when introduced.
|
|
//
|
|
|
|
template <typename CharT, std::size_t Extent = dynamic_extent>
|
|
using basic_zstring = CharT*;
|
|
|
|
using czstring = basic_zstring<const char, dynamic_extent>;
|
|
|
|
using cwzstring = basic_zstring<const wchar_t, dynamic_extent>;
|
|
|
|
using cu16zstring = basic_zstring<const char16_t, dynamic_extent>;
|
|
|
|
using cu32zstring = basic_zstring<const char32_t, dynamic_extent>;
|
|
|
|
using zstring = basic_zstring<char, dynamic_extent>;
|
|
|
|
using wzstring = basic_zstring<wchar_t, dynamic_extent>;
|
|
|
|
using u16zstring = basic_zstring<char16_t, dynamic_extent>;
|
|
|
|
using u32zstring = basic_zstring<char32_t, dynamic_extent>;
|
|
|
|
} // namespace gsl
|
|
|
|
#endif // GSL_ZSTRING_H
|