1010 Commits

This Branch

This Branch

All Branches

Author	SHA1	Message	Date
Carson Radtke	7fabaa499d	deprecate features adopted into C++ (#1198) ... * deprecated features adopted into C++ 1) Mark the following GSL features as deprecated: - gsl::unique_ptr (always) - gsl::shared_ptr (always) - gsl::byte (since c++17) - gsl::joining_thread (never implemented) 2) Refactor existing deprecations to use the new GSL_DEPRECATED(msg) macro. 3) Create a section in the README for deprecated features in the standard. * do not deprecate gsl::to_integer because we never claim to implement it. * do not use gsl::byte if it is deprecated	2025-02-14 11:24:51 -06:00
Carson Radtke	4742bc192a	use relative path in # include (#1194) ... Reverts commit that changes #include "assert" -> #include "gsl/assert". This change is necessary in order to comply with CppCoreGuideline's SF.12. Now we do #include "./assert".	2025-02-12 09:16:45 -06:00
Carson Radtke	ec729d63a7	introduce gsl::not_null<T>::element_type (#1196) ... * introduce gsl::not_null<T>::element_type * use std::is_same instead of is_same_v * fix: cannot put a non-pointer in a gsl::not_null	2025-02-12 09:16:05 -06:00
Carson Radtke	7f4fc9388b	Add more gsl::span tests [copilot] (#1189) ... * Add more gsl::span tests [copilot] This PR adds comprehensive unit tests for `gsl::span` to ensure its correctness and consistency. The following tests have been added: 1. **Empty Span Tests**: - Tests to verify the behavior of an empty `gsl::span` and `gsl::span<const int>`. 2. **Conversion Tests**: - Tests to check the conversion between different types of `gsl::span`. 3. **Comparison Operator Tests**: - Tests to verify the comparison operators for `gsl::span`. 4. **Deduction Guide Tests**: - Tests to compare the behavior of `gsl::span` and `std::span` deduction guides for various types of arrays and containers. These tests help ensure that `gsl::span` behaves correctly in various scenarios and is consistent with `std::span`. This PR was created with the help of GitHub Copilot. **Changes**: - Added tests for empty span. - Added tests for conversions. - Added tests for comparison operators. - Added tests for deduction guides. **Testing**: - All new tests have been added to the existing test suite. - Run the test suite using `ctest` to ensure all tests pass.This PR adds comprehensive unit tests for `gsl::span` to ensure its correctness and consistency. The following tests have been added: 1. **Empty Span Tests**: - Tests to verify the behavior of an empty `gsl::span` and `gsl::span<const int>`. 2. **Conversion Tests**: - Tests to check the conversion between different types of `gsl::span`. 3. **Comparison Operator Tests**: - Tests to verify the comparison operators for `gsl::span`. 4. **Deduction Guide Tests**: - Tests to compare the behavior of `gsl::span` and `std::span` deduction guides for various types of arrays and containers. These tests help ensure that `gsl::span` behaves correctly in various scenarios and is consistent with `std::span`. This PR was created with the help of GitHub Copilot. **Changes**: - Added tests for empty span. - Added tests for conversions. - Added tests for comparison operators. - Added tests for deduction guides. **Testing**: - All new tests have been added to the existing test suite. - Run the test suite using `ctest` to ensure all tests pass. * fix tests for pre-C++17	2025-02-12 09:15:43 -06:00
Tiago	355982daf6	Delete gsl/string_span (#1185) ... This has been deprecated for 2+ years.	2025-01-07 08:58:59 -06:00
Werner Henze	50aaf2efbb	remove documentation for deprecated make_span overloads (#1183) ... Co-authored-by: Werner Henze <werner.henze+gitcommits@posteo.de>	2025-01-07 08:50:49 -06:00
Tiago	7b6b8013b1	Add "gsl" to #includes (#1184) ... Office is seeing build breaks due to `#include "span"` including C++20 span instead of gsl/span. Most likely we want all headers includes qualified with "gsl/" to avoid similar issues.	2025-01-07 08:42:38 -06:00
Werner Henze	1cdb8d295e	More checks for non-compilable code, plus fix for span (#1180)	2025-01-04 11:50:31 -06:00
Carson Radtke	c832885f15	React to ubuntu-latest changing to 24.04 (#1181) ... * React to ubuntu-latest changing to 24.04 Reacting to https://github.com/actions/runner-images/issues/10636 * update clang to 16,17,18 * update gcc to 12,13,14	2025-01-03 10:23:50 -06:00
Werner Henze	16a60199df	strict_not_null for unique_ptr (#1179) ... - `strict_not_null<std::unique_ptr<int>>{ std::make_unique<int>()}` failed to compile - `strict_not_null` ctor needs to move the passed `unique_ptr`, not copy - Copied `not_null` `TestNotNullConstructors` for `strict_not_null` - The `noexcept` specifiers on the `strict_not_null` and `not_null` constructors were out of sync. - Added unit test for `not_null<unique_ptr<T>>` and for `strict_not_null<unique_ptr<T>>` - Added unit test for `gsl::swap` for two `strict_not_null` - Added unit test for `gsl::swap` for `not_null` and `strict_not_null` Co-authored-by: Werner Henze <w.henze@avm.de>	2024-12-26 11:00:36 -06:00
Werner Henze	fcd55ee924	Better use of std::enable_if (#1177) ... * this commits adds tests that should fail, but don't * Better use of std::enable_if Replace the occurances of `class = std::enable_if_t<Cond>` and `typename = std::enable_if_t<Cond>` that have been identified in the previous commit with `std::enable_if_t<Cond, bool> = true`. This commit is inspired by #1174, which changed one occurance in the owner header. This commit is aimed to fix all remaining occurances. * fix failing checks - core.cxx_gsl aktualisiert auf [](https://gitlab.avm.de/fos/repos/core.cxx_gsl/-/commit/) - plc.access_lib aktualisiert auf [](https://gitlab.avm.de/fos/repos/plc.access_lib/-/commit/) - plc.common aktualisiert auf [](https://gitlab.avm.de/fos/repos/plc.common/-/commit/) - plc.daemon aktualisiert auf [](https://gitlab.avm.de/fos/repos/plc.daemon/-/commit/) - Test Plan: - --------- Co-authored-by: Werner Henze <werner.henze+gitcommits@posteo.de> Co-authored-by: Werner Henze <w.henze@avm.de>	2024-12-23 10:40:22 -06:00
Werner Henze	b8ac820fe1	Force unit tests for byte to use GSL implementation (#1176) ... When setting `GSL_USE_STD_BYTE` to zero, then the unit test does not compile because `byte` is ambiguous (could be `std::byte` or `gsl::byte`). So `gsl::` prefix is needed for `byte`. It looks like the unit tests never ran on a platform where `gsl::byte` is not based on `std::byte`. It does not make much sense to test `std::byte` for compliance, so make the unit tests based on the GSL implementation of `gsl::byte` (`#define GSL_USE_STD_BYTE 0`). Co-authored-by: Werner Henze <werner.henze+gitcommits@posteo.de>	2024-12-18 10:16:36 -06:00
Carson Radtke	272463043e	introduce gsl::swap for swapping gsl::not_null (#1160) ... fixes: https://github.com/microsoft/GSL/issues/1129 * create gsl::swap<T>(T&, T&) which wraps std::swap * specialize gsl::swap<T>(gsl::not_null<T>&, gsl::not_null<T>&) * add tests	2024-12-13 15:16:53 -06:00
Carson Radtke	8a0e3d8a9b	fix: direct-init const ref instead of list-init (#1175) ... fixes: https://github.com/microsoft/GSL/issues/1162 gcc has a bug that generates a call to the copy constructor when list initializing a const reference. This PR offers a workaround which is to direct initialize the value. see: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=117900	2024-12-13 10:22:16 -06:00
Alberto La Rocca	aed09c41b6	Fix SFINAE on gsl::owner. (#1174) ... `std::enable_if_t` must not be used as a default template argument, otherwise the instantiator will be able to override it freely with something that doesn't fail substitution. Instead, `std::enable_if_t` itself must be the type of the template argument. More information in the examples here: https://en.cppreference.com/w/cpp/types/enable_if	2024-12-13 09:56:28 -06:00
Carson Radtke	4b190d2e2a	Create issue templates (#1173)	2024-12-02 14:34:38 -06:00
Carson Radtke	ddae9d72b6	fix stale badge links in README (#1170) ... * update pipeline badge links * add link to compilers pipeline * add badge to vcpkg version	2024-11-25 13:06:02 -06:00
Carson Radtke	74d2bb79d4	fix various pipeline failures (#1172) ... * fix failing pipeline tests * upgrade to googletest v1.14.0 so it works with newer cmake versions * fix android pipeline to permit new cmake versions (short-term fix)	2024-11-25 12:58:45 -06:00
Carson Radtke	f8ec309118	improve performance of span_iterator w/ clang (#1166) ... * improve performance of span_iterator w/ clang Issue: #1165 Before this PR, the range-for loop was ~3300x slower. After this PR, it is ~1.005x slower The clang optimizer is very good at optimizing `current != end`, so we changed to this idiom. This moves the Expects assertion into the constructor instead of on the hot-path which is called whenever either operator++ or operator* is called. Note: The codegen for the assertion is still a missed optimization, but less worrisome as it only happens once per iterator. Note: benchmarks on M1 Macbook Pro w/ Apple Clang 16.0.0	2024-11-12 15:41:21 -06:00
Carson Radtke	87f9d76886	GSL v4.1.0 (#1163) ... Fixes: #1161 Update version strings in README and CMakeLists.txt. v4.1.0	2024-10-21 10:19:37 -05:00
Heiko Kröger	82ba6c77ce	Added the IWYU pragma export (#1154) ... * Added the IWYU pragma export clang-tidy has added the check misc-include-cleaner with version 17. This check respects the IWYU pragmas.	2024-10-15 17:26:45 -05:00
mq白	32511b8de4	Delete the useless 'noexcept(false)' (#1152)	2024-10-14 15:30:40 -05:00
Konstantin Akimov	84b2ca1352	Remove unused headers from gsl/pointers (#1153) ... * Remove unused headers from gsl/pointers forward is already declared in utility, no need to include algorithm which is relativaly heavy hash is already declared in memory, no need to bring brand-new header system_error for hash only * Fix: add missing header <functional> to gsl/pointers due to using less/greater	2024-10-14 15:15:46 -05:00
Carson Radtke	ce2a959e02	[ci]: add testing pipelines to github actions (#1159) ... move pipeline testing from AzDO to GitHub Actions. * update clang versions to 13-15 * update gcc versions to 10-12 * update xcode versions to 14.3.1 and 15.4 * test against C++23 (where supported)	2024-10-14 15:05:13 -05:00
Brian Kroth	11fe02d1ac	Add a MS GSL disambiguation note (#1156)	2024-10-14 09:43:43 -05:00
Werner Henze	3275f9ccb9	Fix gcc build problem (#1149) ... Closes issue #1148 by fixing problems introduced in PR #1140. Co-authored-by: Werner Henze <w.henze@avm.de>	2024-10-11 19:46:21 -05:00
Carson Radtke	b206bd163b	[ci]: fix android job (#1158) ... Job has been failing for months and is preventing other PRs from getting merged. This PR fixes the pipeline - it changed the following: - runs on macos-latest-large (which is a non-arm image) - starts the emulator under java8 (see https://learn.microsoft.com/en-us/java/openjdk/transition-from-java-8-to-java-11) - runs emulator with -no-audio The above were requirements to get the pipeline running. Other changes include the following: - The job will auto-cancel when a newer commit is pushed to the PR. - The 'Wait for emulator ready' step now has a 2 minute timeout. This is necessary because we get no indication on whether or not the command that started the emulator suceeded. I believe there is room for improvement here, but it is outside the scope of the PR.	2024-10-11 16:05:20 -07:00
Werner Henze	b39e7e4b09	Add documentation for to_integer(byte) (#1144) ... Co-authored-by: Werner Henze <w.henze@avm.de>	2024-02-26 13:23:45 -08:00
Stephan T. Lavavej	2e0d1ba48c	Test only __cpp_lib_byte, drop _HAS_STD_BYTE. (#1145)	2024-02-26 13:22:20 -08:00
d-winsor	1b4d42ca2e	Fix initialization in test (#1140) ... * Suppress unsafe-buffer-usage	2024-02-26 13:17:12 -08:00
Bruce Mitchener	caae4dd0f8	Fix some typos. (#1146)	2024-02-21 15:06:29 -08:00
Bruce Mitchener	f1a494cfd2	ci: Update to actions/checkout@v4. (#1142) ... This fixes annotations on task runs like the following: The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/	2024-01-17 15:25:32 -08:00
Bruce Mitchener	77b2f4f3b8	Fix some typos. (#1143)	2024-01-17 15:25:07 -08:00
Nicholas Guriev	e64c97fc2c	Mark not_null constructors as noexcept when underlying type can be moved with no exception (#1135) ... This enables possible optimisations for trivial types. This also avoids a bug in std::variant::emplace from GNU's libstdc++. https://gcc.gnu.org/bugzilla/show_bug.cgi?id=106547	2023-10-18 15:15:26 -07:00
Edward Chen	52212c2d76	Update Clang GSL_SUPPRESS to stringize parameter instead of using fixed string literal. (#1133) ... Fix #1130.	2023-09-11 10:52:30 -07:00
Dmitry Kobets	2940006b5c	Suppress some noisy / buggy warnings (#1136) ... Two warnings were being emitted in the MSVC+LLVM tests. The warning `-Wunsafe-buffer-usage` is initially introduced in some capacity here https://reviews.llvm.org/D137346 pointing to documentation at https://discourse.llvm.org/t/rfc-c-buffer-hardening/65734. The warning is a stylistic checker whose goal is to "emit a warning every time an unsafe operation is performed on a raw pointer". This type of programming model is not useful for library implementations of types such as `span`, where direct manipulation of raw pointers is inevitable, so disable the warning altogether. There is also a false-positive warning https://github.com/llvm/llvm-project/issues/65689 that I've disabled inline.	2023-09-11 10:06:40 -07:00
Werner Henze	9695da9b38	fix and optimize documentation (#1131) ... - Add anchor for `finally` in `headers.md` so that the link in `README.md` can work - In `README.md` add code formatting for the character types of the `zstring` and `string_span` types - In `README.md` change code formatting to links for GSL types - Vertical alignment	2023-09-05 16:08:36 -07:00
Dmitry Kobets	4300304ef2	Remove unused macros (#1128) ... This macro is a relic of the old implementation of GSL's header. It is unused and can be removed.	2023-07-26 15:07:28 -07:00
Werner Henze	b34f7350fe	get back gcc 8.4 compatibility (#1127) ... Before my PR #1122 `gsl/pointers` was gcc 8.4 compatible. Now it is not. This commit makes it compatible with gcc 8.4 again.	2023-07-06 12:51:48 -07:00
Werner Henze	167c77d28e	add missing include (#1126) ... The header file uses `std::declval`, so it needs to `#include <utility>`.	2023-07-03 17:20:50 -07:00
Werner Henze	87e21400dc	remove gcc noexcept warning (#1122) ... Without this change a `gsl::not_null<class_type>` triggers these `noexcept` warnings: ``` .../gsl/include/gsl/pointers:162:50: warning: noexcept-expression evaluates to ‘false’ because of a call to ‘constexpr gsl::details::value_or_reference_return_t<T> gsl::not_null<T>::get() const [with T = class_type*; gsl::details::value_or_reference_return_t<T> = class_type* const]’ [-Wnoexcept] 162 | const not_null<U>& rhs) noexcept(noexcept(lhs.get() == rhs.get())) | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .../gsl/include/gsl/pointers:119:55: note: but ‘constexpr gsl::details::value_or_reference_return_t<T> gsl::not_null<T>::get() const [with T = class_type*; gsl::details::value_or_reference_return_t<T> = class_type* const]’ does not throw; perhaps it should be declared ‘noexcept’ 119 | constexpr details::value_or_reference_return_t<T> get() const | ^~~ ``` Co-authored-by: Werner Henze <w.henze@avm.de>	2023-06-28 15:17:12 -07:00
Dmitry Kobets	3549e31ba4	Deprecate <gsl/string_span> and replace with <gsl/zstring> (#1125) ... With `string_span` having been deprecated (https://github.com/microsoft/GSL/pull/931, https://github.com/microsoft/GSL/pull/945) and removed (https://github.com/microsoft/GSL/pull/1074), the header `<gsl/string_span>` now only contains the definitions for the `zstring` family. Update the name accordingly from `<gsl/string_span>` to `<gsl/zstring>`. The old header is now deprecated and should no longer be used and will be removed in some future release.	2023-06-28 10:48:23 -07:00
Dmitry Kobets	65a5995035	Remove deprecated headers (#1124) ... Headers that were previously prefixed with `gsl_` were renamed to drop the `gsl_` prefix in https://github.com/microsoft/GSL/pull/946, and the original version deprecated. The deprecation happened a long time ago, so it is now time to remove these headers entirely.	2023-06-28 10:48:04 -07:00
Dmitry Kobets	303d964a24	Deprecate the Ptr make_span overloads (#1113) ... These overloads don't seem to be in a usable state, and their original purpose is no longer clear. Deprecate them. Resolves #1092	2023-05-22 10:48:41 -07:00
jpr42	afaaa71bce	Install GSL.natvis (#1112) ... Turns out supporting GSL.natvis perfectly is quite difficult. There is no universal way to consume .natvis files that would satisfy everyone. I thought the solution was to use the /NATVIS linker option. But it turns out that actually embeds information into the PDB. So I'm not sure how to properly support the Ninja generator... That's not even accounting for the fact target_link_options doesn't play nicely with /NATVIS When you just add the file via target_sources the visual studio solution will just pick it up and recognize it without adding it to the PDB file. Which won't affect the binary and is what most devs want. This all comes down to the fact that /NATVIS files have native integration with visual studio that makes it difficult to use with non-visual studio solutions. /NATVIS almost works but embeds itself into the PDB which not everyone wants, and not everyone generates PDBs either. Docs for natvis files and /NATVIS - https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2022 - https://learn.microsoft.com/en-us/cpp/build/reference/natvis-add-natvis-to-pdb?view=msvc-170 So my current solution is to just simplify the existing CMake code, and install the natvis so the user can decide. closes #1084	2023-05-10 17:02:44 -07:00
Dmitry Kobets	4b5b5a1ed5	Disable std::hash<gsl::not_null<T>> if std::hash<T> is not enabled. (#1109) ... Resolves #914	2023-05-10 11:25:04 -07:00
Dmitry Kobets	5dc7fae119	Use the implementation-defined strict total order for pointer comparisons with not_null (#1106) ... Using `<`,`<=`,`>`,`>=` to compare unrelated pointers gives an unspecified result according to the standard. This PR replaces the usage of these operators in `gsl::not_null` with the STL counterparts, which would leverage any implementation-defined strict total ordering for pointers. Resolves #880	2023-05-09 09:06:53 -07:00
Dmitry Kobets	9face82309	Remove unnecessary check from size_bytes() (#1105) ... `size_bytes()` returns the span's size in bytes. Assuming the span was constructed with an accurate size parameter, the check `size() < dynamic_extent / sizeof(element_type)` isn't required, since `size_t(-1)` (which is `dynamic_extent`) represents the size of the address space, so the number of bytes will never exceed it and in practice won't even come close. Otherwise, it is not actually feasible to detect cases when the size parameter does not correspond to the dimensions of the underlying data pointer. In these cases, the relationship `size() < dynamic_extent / sizeof(element_type)` is simply one of many ways in which the `size()` could be incorrect, and serves no necessary purpose. Resolves #1012	2023-05-09 09:05:26 -07:00
Dmitry Kobets	1d036585cc	Add testcase for #1100 (#1101)	2023-03-30 11:10:15 -07:00
Werner Henze	43d60c5e38	Suppress warning C26481 (#1099) ... Suppress "warning C26481: Don't use pointer arithmetic. Use span instead (bounds.1)." in the code that impements `span`.	2023-03-14 16:57:46 -07:00