Changelog

Dependency changes

• Minimal supported CMake version is now 3.5, changed from 3.4, since CMake 3.27+ warns if a compatibility with CMake below 3.5 is requested. Older versions are not supported anymore and all workarounds for them were removed. This is a conservative change, as there are no known supported distributions which would have anything older than 3.5.

New features

• MSVC 2022 support. For that there's a new CORRADE_MSVC_COMPATIBILITY flag that controls workarounds for MSVC 2019+ with the /permissive- flag not enabled. This supersedes the CORRADE_MSVC2019_COMPATIBILITY flag and can be turned off if /permissive- is set for all files that use Corrade. See also mosra/corrade#124.
• New CORRADE_TARGET_WASM preprocessor variable for any (even non-Emscripten) WebAssembly target, as a complement to CORRADE_TARGET_X86, CORRADE_TARGET_ARM and CORRADE_TARGET_POWERPC
• New CORRADE_TARGET_SSE3, CORRADE_TARGET_SSSE3, CORRADE_TARGET_SSE41, CORRADE_TARGET_SSE42, CORRADE_TARGET_POPCNT, CORRADE_TARGET_LZCNT, CORRADE_TARGET_BMI1, CORRADE_TARGET_BMI2, CORRADE_TARGET_AVX, CORRADE_TARGET_AVX_F16C, CORRADE_TARGET_AVX_FMA, CORRADE_TARGET_AVX2, CORRADE_TARGET_AVX512F, CORRADE_TARGET_NEON, CORRADE_TARGET_NEON_FMA, CORRADE_TARGET_NEON_FP16 and CORRADE_TARGET_SIMD128 preprocessor variables added to the already existing CORRADE_TARGET_SSE2 for detecting enabled instruction sets on x86, ARM and WebAssembly
• New CORRADE_TARGET_32BIT preprocessor variable for cross-platform detection of 32-bit builds
• New CORRADE_TARGET_CXX14, CORRADE_TARGET_CXX17 and CORRADE_TARGET_CXX20 convenience macros that provide an easier way to detect used C++ standard than comparing CORRADE_CXX_STANDARD to some arbitrary value
• New Cpu namespace that provides building blocks for compile-time and runtime CPU feature detection and dispatch on x86, ARM and WebAssembly. See mosra/corrade#115, mosra/corrade#154 and mosra/corrade#171.
• Added MSVC Natvis files and pretty-printers for GDB. See Debugger support, mosra/corrade#111, mosra/corrade#147, mosra/corrade#160, mosra/corrade#165, mosra/corrade#172 and mosra/corrade#179 for more information.
• For console applications, the Corrade::Main library now disables showing an assertion dialog on Windows, making them either jump to the debugger or exit directly. This fixes a problem in non-interactive scenarios where assertions caused the apps to get stuck forever waiting for someone to close the dialog.

Changes and improvements

Build system

• The library now uses -fno-strict-aliasing on GCC and enables this flag for all CMake users as well, independently of whether the CORRADE_USE_PEDANTIC_FLAGS CMake option is enabled. Strict aliasing was disabled for the Magnum library since 2013 already, this change just enables it for all Magnum-related projects because essential functionality like Containers::StridedArrayView is impossible to implement without breaking strict aliasing rules.
• The oldest supported Clang version is now 6.0 (available on Ubuntu 18.04), or equivalently Apple Clang 10.0 (Xcode 10). Oldest supported GCC version is still 4.8.
• The -o option in the Single-header generator tool utility now treats the argument as a file if it doesn't exist and a directory only if it exists and is a directory (see mosra/corrade#90)
• Fixed a potential error in UseCorrade.cmake that would happen when compiling with an unrecognized compiler (see mosra/magnum#457)
• The version.h header now gets populated from Git correctly also when inside a CMake subproject
• The corrade_add_test(), corrade_add_plugin(), corrade_add_static_plugin() and corrade_add_resource() CMake functions now check for presence of the targets they depend on, giving the user a clear message in case something is missing (see mosra/corrade#101)
• Attempted a switch of Emscripten build on Travis CI from macOS to Ubuntu + Docker for 2x faster build times in a futile attempt to not use the extremely expensive features of a no-longer-free service. Ultimately, Travis banned everyone from using their CI and so all Linux, macOS, Emscripten, Android and iOS builds were migrated from Travis to Circle CI, together with adding also an explicit ARM64 build. See mosra/corrade#105, mosra/magnum#350 and mosra/magnum#523.
• On CMake 3.16 and newer, FindCorrade.cmake can provide additional details if some component is not found
• The Homebrew package now uses std_cmake_args instead of hardcoded build type and install prefix, which resolves certain build issues (see mosra/homebrew-magnum#6)
• CORRADE_DEPRECATED_ENUM() is now a no-op for Qt's Meta Object Compiler as it caused parse errors on older Qt versions
• With CMake 3.20 and newer it's possible to compile for Android NDK r19+ without explicitly supplying various system paths. Additionally, when CMAKE_INSTALL_PREFIX points to Android NDK sysroot, the LIB_SUFFIX gets autodetected to a correct triplet + API level version subdirectory, making the installed project discoverable by both vanilla CMake and Gradle. On CMake 3.16 to 3.19 it's required to set two extra variables for the same effect. See Cross-compiling for Android and mosra/magnum#310 for more information.
• Updated Debian build instructions to pass --no-sign to dpkg-buildpackage, avoiding a confusing error message that might lead people to think the packaging failed (see mosra/magnum-plugins#105)
• Updated Emscripten toolchains to not pass -s WASM to the compiler, as only the linker needs it and recent versions complain loudly (see mosra/toolchains#16)
• Updated Emscripten toolchains to set CMAKE_<LANG>_COMPILER to the cache so MSVC IntelliSense can work with it (see mosra/toolchains#17)
• Corrade/Utility/Memory.h now has #include <malloc.h> on Windows as well instead of declaring aligned memory allocation functions on its own, as it's not worth the seriously-looking compiler warnings (see mosra/corrade#145)
• Platforms that support CORRADE_CPU_USE_IFUNC will now build certain code paths optimized for multiple architectures, with the best variant selected at runtime using the Cpu library based on available CPU features. This behavior can be disabled with the CORRADE_BUILD_CPU_RUNTIME_DISPATCH CMake option. Platforms without IFUNC support implement runtime dispatch using function pointers instead of indirect functions and have this currently disabled by default.
• Various warning fixes (see mosra/corrade#151)
• Preventing a build error on Emscripten if CORRADE_UTILITY_USE_ANSI_COLORS is passed to CMake (see mosra/corrade#153)
• The corrade_add_test() CMake macro now recognizes a new CORRADE_TESTSUITE_TEST_TARGET CMake variable to put tests into a dedicated target instead of building them as part of the implicit ALL target.
• Updated Corrade/Utility/StlForwardArray.h and Corrade/Utility/StlForwardTuple.h to work on libc++ 16
• On Windows there's a new CORRADE_BUILD_STATIC_UNIQUE_GLOBALS_DLL_NAME CMake option to aid CORRADE_BUILD_STATIC_UNIQUE_GLOBALS in cases where Corrade is only linked to a DLL but not the main executable.
• Worked around a compilation failure on MSVC 2022 with /fsanitize=address /std:c++17 /permissive-, where a definition of __sanitizer_annotate_contiguous_container() in Corrade/Containers/GrowableArray.h would conflict with MSVC's own in <vector> that additionally has a noexcept specifier
• Made it possible to optionally find TestSuite via find_package() without causing a fatal error if not found on platforms that need additional runner files like XCTest, Android and Emscripten. See also mosra/corrade#170.
• It's now possible to build dynamic libraries on Android and Emscripten with the usual options. Static libraries are still a default but it isn't enforced anymore. See mosra/corrade#170.
• Fixed a build error related to the environ variable on macOS versions before 10.8. See mosra/corrade#175.
• The Emscripten toolchain now prefers include directory located in the Emscripten cache, which as of Emscripten 3.0.4 contains the version.h header. See mosra/corrade#133.
• The Emscripten toolchain now uses the -flto flag instead of --llvm-lto, which was specific to the fastcomp backend that's removed as of Emscripten 2.0, and sets up correct emar to be used for LTO. See mosra/toolchains#13, mosra/toolchains#14 and mosra/magnum#490.
• The Emscripten build now uses --js-library instead of inline EM_ASM() for calling into JavaScript. This allows it to properly specify its runtime dependencies without risking breakages when new Emscripten versions make more JS API functions optional, and circumvents the need for users to specify -s EXPORTED_FUNCTIONS on their side.
• Utility::Path::copy() now uses an 8 kB buffer instead of 128 kB to not crash on Emscripten 3.1.27+, which reduced the default stack size from 5 MB to 64 kB.
• New #pragma ACME forget option in the Single-header generator tool utility
• /OPT:NOICF is now added for the Interconnect library for clang-cl as well (see mosra/corrade#178)
• The Emscripten toolchain no longer uses a *.bc extension for static libraries, as that breaks builds with version 3.1.52+. See mosra/magnum#633 for more information.
• Fixed most remaining warnings on MSVC, in particular those related to "conversion from T to void * of greater size". See also mosra/magnum#544.
• Fixed ambiguity with std::format() when compiling Corrade as C++20 on certain STL implementations (see mosra/corrade#184)
• The corrade_add_test() CMake command is fixed to not call Node.js with itself when CMAKE_CROSSCOMPILING_EMULATOR is set (see mosra/corrade#185)
• Corrade can now cross-compile and use its own corrade-rc executable through an emulator if CMAKE_CROSSCOMPILING_EMULATOR is set, instead of requiring a native version of it to be compiled first. See also mosra/corrade#81 and mosra/corrade#185.
• Corrade now automatically installs and uses Find modules for its dependencies in a way that doesn't clash with modules of the same name potentially installed by other software, meaning the user doesn't need to copy and carry them along anymore (see mosra/magnum#436)

Bug fixes

• Containers::arrayReserve() was not correctly propagating an explicit allocator argument when checking for capacity, using always the implicit one, and thus resulting in unnecessary reallocation in some cases Containers::arrayAppend(Array<T>&, std::initializer_list<typename std::common_type<T>::type>) was not correctly propagating an explicit allocator argument, causing the array to be always reallocated using the implicit one
• Utility::Path::libraryLocation() documentation now mentions caveats related to position-independent code on Unix platforms and the corresponding test was fixed to ensure the preconditions are met. See also mosra/corrade#135.
• Utility::Path::list() was leaking the file handle on Windows (see mosra/corrade#99)
• Fixed Utility::Path::move() to overwrite the destination if it exists also on Windows, consistently with other platforms (see mosra/corrade#143)
• Fixed Utility::Path::homeDirectory() and configurationDirectory() to not use an old Windows API that tends to prefer OneDrive over local user directories (see mosra/corrade#144)
• Added GCC 4.8-specific workarounds to Containers::Array, growable array utils, Containers::Optional, Containers::Pointer and Containers::StaticArray where using T{b} or T{std::move(b)} to perform copy/move-construction on a plain struct would cause GCC 4.8 to attempt to construct the members directly instead of invoking a copy/move-constructor, using () instead works.
• When crosscompiling with Corrade as a CMake subproject and not using find_package(), corrade_add_resource() failed late during build on the Corrade::rc target not being defined (see mosra/corrade#101)
• On Emscripten, Utility::Arguments used an internal allocation function, which changed signature in 2.0.5 and caused runtime failures when -s ASSERTIONS was enabled. A public stable API is now used instead, see mosra/corrade#106.
• Containers::Array growable utilities, Containers::String, Utility::copy(), Utility::format() and Utility::Sha1 was fixed to not call std::memcpy() with nullptr when size is zero (see mosra/corrade#102)
• Fixed Utility::Arguments to produce an error instead of asserting in case a positional argument is specified as named
• Deep Utility::ConfigurationGroup assignments didn't properly reassign the configuration() pointer, leading to an assertion on save
• Corrade/Utility/StlForwardTuple.h was fixed to do a full #include <tuple> on libstdc++ before version 7 as there a forward declaration is not available
• Utility::Tweakable was not correctly parsing unsigned long long literals, truncating them to 32 bits
• Tests ran using CTest under Emscripten used to have --stack-trace-limit=0 set, preventing Node.js from printing a backtrace on exception. This was originally needed because historically Emscripten applications didn't correctly propagate main() return codes, which had to be worked around by throwing an exception instead. This workaround became obsolete and got removed in 2017, but this option was left there by accident. Now it's removed as well.
• PluginManager::Manager no longer dies on startup on an internal assertion if duplicate static plugins are encountered. This can happen when a static plugin is linked to multiple dynamic libraries or modules which then get used in a single executable.
• Calling PluginManager::AbstractManager::setPreferredPlugins() with a plugin of given alias being instantiated led to an internal assertion when the plugin got later unloaded.
• Fixed PluginManager::AbstractManager::load() and loadAndInstantiate() to properly interpret non-absolute plugin filenames as relative to current working directory instead of passing them directly to OS APIs, which then attempt to load them from OS-specific locations and fail
• TestSuite::Compare::SortedContainer no longer modifies order of referenced elements when non-owning views are passed to it
• Fixed the CORRADE_CONSTEXPR14 macro be empty on MSVC 2015, which doesn't support C++14 relaxed constexpr rules yet. See also mosra/corrade#152.
• Fixed the corrade_add_resource() CMake macro to properly trim trailing whitespace before looking for files for dependency tracking.
• Adapted a Containers::ArrayView and Containers::StaticArrayView test related to constexpr usage to expect a strange failure on Clang 14 with AddressSanitizer enabled. Fixed again in Clang 15, although no related bug report or commit was found. See also mosra/corrade#135.
• Fixed the library to build and pass tests when CORRADE_NO_ASSERT or CORRADE_STANDARD_ASSERT is defined.
• Fixed three more cases of a "chosen constructor is explicit in copy-initialization" C++ featurebug when using growable Containers::Array APIs and Containers::StaticArray with a struct that has a member with an explicit default constructor.

Deprecated APIs

• All CMake build options are now prefixed with CORRADE_. For backwards compatibility, unless CORRADE_BUILD_DEPRECATED is disabled and unless a prefixed option is already set during the initial run, the unprefixed options are still recognized with a warning. In particular, if BUILD_DEPRECATED is set but CORRADE_BUILD_DEPRECATED not, the unprefixed options are also recognized. See also mosra/corrade#139.
• Containers::Array::empty(), ArrayView::empty(), StaticArray::empty(), StaticArrayView::empty() and StridedArrayView::empty() is deprecated in favor of Containers::Array::isEmpty, ArrayView::isEmpty(), StaticArray::isEmpty(), StaticArrayView::isEmpty() and StridedArrayView::isEmpty(). The original name was chosen only to match what STL did, but it could be confused with "make the array empty" (i.e., what clear() does) and it was inconsistent with all other APIs returning a bool as well as the new Containers::String and StringView APIs, which all use isSomething() instead.
• Containers::Array, ArrayView, StaticArray, StaticArrayView and StridedArrayView slicing APIs were reworked for more consistency. In particular:
  • except() is deprecated in favor of exceptSuffix(), being consistent with the new Containers::StringView::exceptSuffix(StringView) const API
  • suffix() is deprecated in favor of exceptPrefix(), being consistent with the new Containers::StringView::exceptPrefix(StringView) const API, as both take a prefix length, and not suffix length. The suffix() API, taking a suffix length instead of an offset, is scheduled to be reintroduced once enough time passes after the deprecated API gets removed to avoid silent breakages in existing code.
• Size and Stride typedefs in Containers::StridedArrayView are deprecated in favor of Size, Size1D, Size2D, Size3D, Size4D, Stride, Stride1D, Stride2D, Stride3D and Stride4D aliases living directly in the Containers namespace, as those are significantly shorter to type
• Utility::Directory::isSandboxed() is deprecated in favor of Utility::System::isSandboxed(), as that's the better place for this API to live in
• All other Utility::Directory APIs are deprecated in favor of a new Utility::Path namespace. It uses the more efficient Containers::StringView instead of std::string for function arguments and non-owned return values, Containers::String instead of std::string for owned return values, wraps return values for all failable APIs in a Containers::Optional and makes various API naming cleanups and clarifications. Because of the sweeping nature of the changes, it was not possible to make these updates in Utility::Directory directly, as it would cause basically all existing code to break. Thus the new APIs are in a completely new namespace:
  • Utility::Directory::fromNativeSeparators() and toNativeSeparators() is deprecated in favor of Utility::Path::fromNativeSeparators() and toNativeSeparators()
  • Utility::Directory::path() and filename() is deprecated in favor of Utility::Path::split() that returns both parts together
  • Utility::Directory::splitExtension() is deprecated in favor of Utility::Path::splitExtension()
  • Utility::Directory::join() is deprecated in favor of Utility::Path::join()
  • Utility::Directory::list(), Flag and Flags are deprecated in favor of Utility::Path::list(), ListFlag and ListFlags, returning the list wrapped in a Containers::Optional
  • Utility::Directory::mkpath(), rm() and move() are deprecated in favor of Utility::Path::make(), remove() and move()
  • Utility::Directory::current(), libraryLocation(), executableLocation(), home(), configurationDir() and tmp() are deprecated in favor of Utility::Path::currentDirectory(), libraryLocation(), executableLocation(), homeDirectory(), configurationDirectory() and temporaryDirectory(), all returning the path wrapped in a Containers::Optional
  • Utility::Directory::exists() and isDirectory() is deprecated in favor of Utility::Path::exists() and isDirectory()
  • Utility::Directory::fileSize() is deprecated in favor of Utility::Path::size()
  • Utility::Directory::read() is deprecated in favor of Utility::Path::read(), returning a Containers::Optional
  • Utility::Directory::readString() is deprecated in favor of Utility::Path::readString(), returning a Containers::String in a Containers::Optional, transferring the memory ownership from a Containers::Array instead of making a copy
  • Utility::Directory::write(), writeString(), append() and appendString() are deprecated in favor of Utility::Path::write() and append(). Because a Containers::StringView is implicitly convertible to a Containers::ArrayView<const void>, there's no need for a dedicated string overload anymore.
  • Utility::Directory::copy() is deprecated in favor of Utility::Path::copy(),
  • Utility::Directory::map(), mapRead(), mapWrite() and MapDeleter are deprecated in favor of Utility::Path::map(), mapRead(), mapWrite() and MapDeleter, returning the mapped array wrapped in an Containers::Optional
• The Utility::Resource class was ported to use Containers::StringView instead of std::string, Utility::Resource::get() is deprecated in favor of Utility::Resource::getString(). The get() API is scheduled to be reintroduced — with a Containers::ArrayView return type consistent with Utility::Path::read() and Utility::Path::readString() — once enough time passes after the deprecated API gets removed to avoid silent breakages in existing code.
• Utility::String::split() and Utility::String::splitWithoutEmptyParts() overloads taking Containers::BasicStringView are deprecated in favor of Containers::BasicStringView::split() and Containers::BasicStringView::splitWithoutEmptyParts(); the overloads taking std::string are still kept
• Utility::String::viewBeginsWith() and Utility::String::viewEndsWith() variants of Utility::String::beginsWith() / Utility::String::endsWith() are deprecated in favor of Containers::BasicStringView::hasPrefix() and Containers::BasicStringView::hasSuffix(); the overloads taking std::string are still kept
• CORRADE_ALIGNAS() and CORRADE_NORETURN macros are deprecated as they were originally introduced for compatibility with GCC 4.7 and older and aren't needed anymore. Use the standard C++11 alignas() and [[noreturn]] attributes instead.
• The CORRADE_ASSUME() macro is moved from Corrade/Utility/Assert.h to Corrade/Utility/Macros.h, as it's a lightweight annotation that doesn't depend on any debug output. If CORRADE_BUILD_DEPRECATED is enabled, the Corrade/Utility/Assert.h pulls it in for backwards compatibility.
• The CORRADE_UTILITY_DEBUG_HAS_SOURCE_LOCATION macro, which was closely tied to Utility::Debug, is deprecated in favor of a more general CORRADE_SOURCE_LOCATION_BUILTINS_SUPPORTED that's defined inside Corrade/Utility/TypeTraits.h instead.
• The CORRADE_STD_IS_TRIVIALLY_TRAITS_SUPPORTED macro is deprecated in favor of CORRADE_NO_STD_IS_TRIVIALLY_TRAITS, which is defined only if the traits aren't supported, and is moved to Corrade/Corrade.h. This solves a recurring problem where forgetting to include Corrade/Utility/TypeTraits.h led to the traits checks being silently skipped, while forgetting to include with the inverse macro would lead to a non-silent compiler error on GCC 4. Additionally it prepares better for future removal of GCC < 5 support.
• The CORRADE_INCLUDE_INSTALL_PREFIX CMake variable, needed for installations into older Android NDKs, is obsolete and no longer needed for NDK r19+. It still does what's expected on builds with CORRADE_BUILD_DEPRECATED enabled, however you'll get a deprecation notice. Since the variable got saved to CMake cache, to get rid of the message, you may need to either recreate your build directory or explicitly delete it from the cache.
• The Corrade/Containers/Tags.h header, Containers::DefaultInit, Containers::ValueInit, Containers::NoInit, Containers::NoCreate, Containers::DirectInit, Containers::InPlaceInit and related tag types were moved to Corrade/Tags.h and the root Corrade namespace, available as DefaultInit, ValueInit, NoInit, NoCreate, DirectInit, InPlaceInit and related tag types
• PluginManager and TestSuite APIs that switched from std::string to Containers::StringView or Containers::String now include Corrade/Containers/StringStl.h for compatibility when building with CORRADE_BUILD_DEPRECATED enabled. Include this header explicitly in your code if you wish to continue to rely on implicit conversion from a std::string.
• To avoid unconditionally including relatively heavy headers, PluginManager::Manager now has the template definitions moved into Corrade/PluginManager/Manager.hpp. This header is implicitly included from the *.h for backwards compatibility if CORRADE_BUILD_DEPRECATED is defined. While nothing changes when using builtin Corrade and Magnum plugin interfaces, for custom interfaces you need to either include this header explicitly or perform an explicit template instantiation as described in Custom plugin interfaces and template definitions.

Potential compatibility breakages, removed APIs

• All includes of Corrade/Containers/PointerStl.h that were added in 2019.01 for preserving backwards compatibility after the move from std::unique_ptr to Containers::Pointer are now removed. This should have a significant positive effect on compile times of code using especially the PluginManager library.
• Containers::ScopedExit, deprecated in 2019.01, is removed, use Containers::ScopeGuard instead
• Removed the CORRADE_CXX_FLAGS CMake variable, which was deprecated in favor of the CORRADE_USE_PEDANTIC_FLAGS target property in 2016.
• Removed a dependency of UseCorrade on UseEmscripten to allow 3rd party Emscripten toolchains to be used. This may break code that uses the emscripten_embed_file() CMake function, to fix that either explicitly include(UseEmscripten) or update the toolchains submodule, which now includes the file implicitly. See mosra/corrade#104.
• Containers::Array, StaticArray, ArrayView, StaticArrayView, String and StringView now contain debug assertions for OOB element access, if necessary implementing an operator[]() instead of relying on implicit pointer conversions. Code that previously inadvertently made out-of-bound access will now assert in debug builds.
• Containers::arrayAllocatorCast() used to be allowed on nullptr Containers::Array instances regardless of their allocator but attempting to query capacity of such array or do any growable operation on it then resulted in a crash. It's now checked by an assert, which may cause breakages in existing code that attempted to call this API on default-constructed or empty arrays.
• Containers::LinkedList destruction was changed in a way that makes Containers::LinkedListItem::list() still accessible in a destructor of Containers::LinkedListItem subclasses. This behavior didn't make sense and so it's not assumed any existing code relied on it, nevertheless it's a subtle change in behavior that is worth mentioning.
• Containers::Pointer destructor and reset() now contain a static_assert() that checks for the type being complete. This avoids accidentally calling delete on a pointer to an incomplete type, which doesn't call the type destructors properly and can lead to resource leaks. Existing code where this silently happened will now fail to compile and has to be updated as documented in Usage with incomplete types.
• Containers::Pointer conversion from a derived type and emplace() with a derived type now contain a static_assert() that checks for either the base type having a virtual destructor or the derived type being trivially destructible. If neither of these is true, attempting to delete through the base pointer would lead to resource leaks as the derived type destructor would never get called. Existing code where this silently happened will now fail to compile and has to be updated.
• PluginManager::AbstractManager::pluginList(), aliasList() and PluginManager::PluginMetadata APIs now return Containers::String, Containers::StringIterable or Containers::Array of Containers::StringView instead of std::string and std::vector instances. As the change was done to avoid including a heavy std::vector, no backwards compatibility is done.
• Overrides of PluginManager::AbstractPlugin::pluginInterface(), pluginSuffix() and pluginMetadataSuffix() are now expected to return a global Containers::StringView, i.e. a string view literal, instead of a std::string. Since a global view has to be explicitly made, no backwards compatibility can be provides
• Override of PluginManager::AbstractPlugin::pluginSearchPaths() is now expected to return a Containers::Array of Containers::String instead of a std::vector of std::string, similarly PluginManager::implicitPluginSearchPaths() is changed to match that. As the change was done to avoid including a heavy std::vector, no backwards compatibility is done.
• Due to changes to CORRADE_SKIP() internals, passing a std::string to it now requires an explicit #include <Corrade/Utility/DebugStl.h>. Alternatively, if string concatenation was used, you can compose the message by chaining Utility::Debug output operators instead.
• Utility::String::replaceFirst() and Utility::String::replaceAll() is now operating on a Containers::StringView and returns a Containers::String. The original std::string overloads had to be removed as they caused various ambiguities, so using these functions with std::string may now need extra casts.
• Utility::String::lowercase() and Utility::String::uppercase() now has overloads for both Containers::StringView and std::string, which may cause ambiguous overload errors for existing code that passes const char* to it. Given that either type is valid now, the code has to be updated to explicitly pass that type to the function.
• Utility::format() now returns a Containers::String instead of Containers::Array and Utility::formatInto() now takes a Containers::MutableStringView instead of Containers::ArrayView. The types are however implicitly convertible and thus breakages are not expected in majority of existing code.
• Printing a C++17 std::string_view with Utility::Debug now requires the Corrade/Utility/DebugStlStringView.h include. Before it was printed as a numeric container due to Utility::IsStringLike not recognizing it.
• Utility::Resource::compile() and Utility::Resource::compileFrom() APIs are no longer public, but rather a private detail of the corrade-rc utility.
• Utility::Resource::list() now returns a Containers::StringIterable instead of a std::vector of std::string. Because the reason for this change was to get rid of #include <vector>, no backwards compatibility is provided.
• As part of the ongoing STL usage cleanup, Utility::TweakableParser is now expected to return a Containers::Pair instead of std::pair
• As part of the ongoing STL usage cleanup, the Utility::Unicode namespace now uses Containers::Pair and Containers::StringView, all uses of std::pair and std::string were removed. The Utility::Unicode::utf32() API now returns a Containers::Array<char32_t> wrapped in a Containers::Optional. Utility::Unicode::narrow() and widen() variants taking a view or a char pointer now return either a Containers::String or a Containers::Array<wchar_t> instead of std::string or std::wstring. Corrade/Containers/PairStl.h is included for implicit conversions to a std::pair and Corrade/Containers/StringStl.h is included for implicit conversions from/to a std::string, but there's no implicit conversion for std::wstring or std::u32string.

Documentation

• Added a table mapping between STL and Corrade containers
• New and thorough documentation for the Utility::Resource class
• Various fixes (see mosra/corrade#108, mosra/corrade#119, mosra/corrade#120, mosra/magnum#600, mosra/corrade#161)

New features

• Clang-CL is now a supported compiler on Windows. See also mosra/corrade#40.
• New CORRADE_TARGET_GCC, CORRADE_TARGET_CLANG, CORRADE_TARGET_APPLE_CLANG, CORRADE_TARGET_CLANG_CL, CORRADE_TARGET_MSVC and CORRADE_TARGET_MINGW variables for easier compiler identification
• New CORRADE_TARGET_SSE2 providing an extremely minimal SIMD feature detection. More extensions to come later.
• New CORRADE_TARGET_BIG_ENDIAN macro. A variant of this macro called just CORRADE_BIG_ENDIAN was used internally for a long time, now it's been exposed publicly.
• New CORRADE_CONSTEXPR14 macro for marking constexpr functions that make use of C++14 relaxed constexpr rules but still need to work under C++11 as well.

Changes and improvements

• TestSuite::Tester and the CORRADE_INTERNAL_ASSERT() family of macros now prints file/line info in test failures as a more compact <file>:<line>, which is consistent with Utility::Debug source location and how GCC or GDB print those
• Added an ability to disable unique globals across shared libraries using CORRADE_BUILD_STATIC_UNIQUE_GLOBALS on static builds that don't need it
• Library version is now exposed through CORRADE_VERSION_YEAR, CORRADE_VERSION_MONTH, CORRADE_VERSION_COMMIT, CORRADE_VERSION_HASH and CORRADE_VERSION_STRING preprocessor defines in a new Corrade/version.h header. This header is not included by any other header to avoid trigerring a full rebuild when Git commit changes. If Git is not found, only the first two defines are present.

Build system

• Fixed compilation of the Corrade::Main library on i686 MinGW
• UseCorrade.cmake defined NOMINMAX and WIN32_LEAN_AND_MEAN by mistake only on MSVC, causing windows.h to leak unforgivable crimes when compiling under MinGW (see mosra/magnum-plugins#74)
• Fixed MSVC detection in conanfile.py, made it aware of the MSVC2019_COMPATIBILITY option as well (see mosra/corrade#93)
• The library again compiles and tests cleanly with CORRADE_NO_ASSERT enabled, and this setup is verified on the CI to avoid further regressions
• Fixes to make the library work under MinGW Clang (see mosra/corrade#95)
• Fixed compilation on GCC 10 (see mosra/corrade#97)
• UseAndroid.cmake no longer expects adb to be in $PATH, but it locates it relatively to Android SDK (see mosra/toolchains#10)
• Various warning fixes (see mosra/corrade#96)

Bug fixes

• The CORRADE_TARGET_LIBSTDCXX macro was defined on GCC < 5 only when certain headers were included before. That caused problems especially with the new CORRADE_STD_IS_TRIVIALLY_TRAITS_SUPPORTED macro and is now fixed to assume old GCC versions always use libstdc++.
• Fixed an assertion in Utility::Arguments when a single - was passed on the command-line
• Utility::Endianness::swapInPlace() and other in-place APIs were fixed to work correctly on platforms that don't allow unaligned reads and writes
• Utility::ConfigurationValue was saving double and long double with only 6 precision digits due to silly std::ostream defaults. Now it prints those with 15 and 18 digits respectively, consistent with Utility::Debug and Utility::format() output
• As internals of PluginManager::Manager were rewritten to not need any shared global state anymore, various corner cases and crashes on destruction are not happening anymore. In particular, it's now also possible to have two instances of the same manager type without the two interfering with each other in any way.

Documentation

• Various fixes and clarifications (see mosra/corrade#80, mosra/magnum#418)

Deprecated APIs

• Utility::Directory::map(const std::string&, std::size_t) is deprecated and renamed to Utility::Directory::mapWrite() as it doesn't preserve original file contents and thus can't be used for read-write access
• The internal CORRADE_BIG_ENDIAN macro got renamed to CORRADE_TARGET_BIG_ENDIAN and made public. The old variant is still present for backwards compatibility, but will be removed in the future.

Potential compatibility breakages, removed APIs

• CORRADE_ASSERT_UNREACHABLE() now accepts a message and will fail to compile when used with an empty argument list. The original functionality is provided by CORRADE_INTERNAL_ASSERT_UNREACHABLE() instead.
• Containers::Array and Containers::StaticArray was switched to do the Containers::ValueInit construction by default instead of Containers::DefaultInit, i.e. zero-initializing trivial types instead of keeping them uninitialized. Apart from introducing potential slowdowns due to the additional zero-ininitialization this isn't really breaking, just makes the default safer; and you still have the option to choose a different initialization.
• Utility::Debug and Utility::format() now prints long double with 15 significant digits instead of 18 on platforms where it is 64-bit instead of 80-bit
• Utility::Endianness is now a namespace, similarly to the change done to Utility::Directory or Utility::String in 2018.02. The API doesn't change apart from that, but code previously doing using Utility::Endianness needs to be changed to using namespace Utility::Endianness to compile again.
• Removed Corrade/Utility/AndroidStreamBuffer.h that was deprecated in 2018.04, use Corrade/Utility/AndroidLogStreamBuffer.h instead
• Removed PluginManager::Manager::instance() that was deprecated in 2018.04, use PluginManager::Manager::instantiate() instead

Dependency changes

• Minimal supported CMake version is now 3.4. Older versions are not supported anymore and all workarounds for them were removed. Download a prebuilt release of a newer version if you need to use Corrade on older systems (such as Ubuntu 14.04 or Debian 8). This is a conservative change that shouldn't affect any additional distribution compared to the CMake 3.1 requirement in 2019.01.

New features

• MSVC 2019 support. It needs about the same set of workarounds as MSVC 2017, which means there's a new (automatically enabled) MSVC2019_COMPATIBILITY CMake option, exposed further as CORRADE_MSVC2019_COMPATIBILITY CMake variable and preprocessor macro. See also mosra/magnum-bootstrap#18 and mosra/magnum#343.
• New Corrade::Main library for improved user experience and consistent behavior on Windows platforms (see mosra/corrade#37 and mosra/magnum#98)
• When using Corrade as a CMake subproject, it now puts all binaries into a common directory to simplify PATH handling and dynamic plugin loading. For more information see Using Corrade as a CMake subproject, mosra/magnum#357 and mosra/magnum-plugins#63.
• Added CORRADE_TARGET_POWERPC for detecting PowerPC architectures (see mosra/corrade#60)
• New set of CORRADE_TARGET_LIBCXX, CORRADE_TARGET_LIBSTDCXX and CORRADE_TARGET_DINKUMWARE macros to detect the common STL implementations
• New CORRADE_BUILD_MULTITHREADED build-time option, moved from Magnum

Changes and improvements

• Global state used by PluginManager::Manager, Utility::Debug and Utility::Resource internals is no longer duplicated when Corrade is built statically and linked to more than one dynamic library or executable. This works on all platforms except for Python bindings on Windows at the moment, where the workaround is to build Corrade dynamically.
• PluginManager::Manager and Utility::Debug now have the global state thread-local when the CORRADE_BUILD_MULTITHREADED option is enabled (see also mosra/corrade#65)

Build system

• MSYS2 packages are now in official repositories, installable directly via pacman
• The CORRADE_CXX_STANDARD preprocessor macro learned support for the upcoming C++2a standard. The equivalent CMake property can now be set to 20 to pass the -std=c++2a flag to GCC and Clang and /std:c++latest to MSVC.
• It's now possible to use the TestSuite library via CMake subprojects also on Android, iOS and Emscripten
• Explicitly disabling a MSVC linker optimization that causes seemingly similar signals to be conflated together, causing erratic behavior. This is done automatically for CMake-based projects, see the Interconnect::Emitter documentation for more information when using custom buildsystems, see also mosra/corrade#51.
• Fixed compilation with Clang and -std=gnu++14 (see mosra/corrade#62)
• CORRADE_VISIBILITY_STATIC no longer exports symbols in static libraries to be consistent with hidden visibility by default, additionally -fvisibility-inlines-hidden is passed along with -fvisibility=hidden when CORRADE_USE_PEDANTIC_FLAGS property is enabled in CMake on GCC and Clang to avoid linker warnings on macOS (see mosra/corrade#53)
• The Emscripten CMake toolchain now sets the EMSCRIPTEN variable to help 3rd party projects (see mosra/toolchains#7)
• The Emscripten CMake toolchain now looks for emcc on $PATH as a last resort and then uses the parent directory as EMSCRIPTEN_PREFIX (see mosra/toolchains#8)
• On Windows, if the Emscripten toolchain detects Visual Studio being used as a generator, it'll fail with an error suggesting to use a different generator instead. Previously, CMake silently fell back to using Visual Studio as a C++ compiler, resulting in seemingly impossible errors. See mosra/corrade#78.
• Clarified interaction of -fvisibility-inlines-hidden and/or -Wl,-Bsymbolic-functions GCC/Clang flags and Interconnect::Emitter
• The TestSuite library and all tests created with corrade_add_test() are now built with -s DISABLE_EXCEPTION_CATCHING=0 being explicitly specified both for the compiler and linker to work correctly on Emscripten 1.38.36 and newer
• Emscripten builds now have the -fPIC option disabled by default as it causes linker errors related to __memory_base on 1.38.36 (see also emscripten-core/emscripten#8761)
• Fixed dynamic plugin metadata location when CMAKE_LIBRARY_OUTPUT_DIRECTORY is set (see mosra/corrade#74)
• With CMake 3.15 there's an unfortunate collision between CORRADE_CXX_STANDARD and CMake's own COMPILE_FEATURES target property, where a request to use C++14 from a 3rd party library would get ignored with C++11 being used instead. To fix that, the CORRADE_CXX_STANDARD property does nothing if the COMPILE_FEATURES property is set on the target as well. See Using Corrade with CMake for more information.
• Fixed corrade_add_test() when library output path is set in CMake (see mosra/corrade#77)
• Plugin metadata are now copied next to the binary as a post-build command instead of only during a full build
• Updated the iOS toolchain to make find_package(Threads) work correctly

Bug fixes

• The TestSuite::Comparator class by mistake did not have fuzzy comparison for long double
• Fixed TestSuite::Compare::around() for types that don't have a total ordering (for example, for Magnum matrix and vector types, !(a < b) might not necessarily imply that a >= b).
• Fixed build on big-endian platforms (see mosra/corrade#58)
• Fixed Utility::Sha1 calculation on big-endian platforms (see mosra/corrade#60)
• Fixed Utility::Directory::read() to not use ftello() on 32-bit Android and API levels below 24
• Fixed Utility::Directory::read() to work with files that report an early EOF (such as stuff from /sys on Linux)
• Fixed Interconnect::Emitter::emit() for signals from multiply-inherited base classes on MSVC — it was due to an insufficiently tested workaround for a template deduction limitation in the compiler (see mosra/corrade#51)
• Interconnect::Emitter::emit() now works correctly on MSVC for signals from classes where multiple and/or virtual inheritance is involved (see mosra/corrade#51)
• Fixed CORRADE_COMPARE_WITH() to be callable with expressions such as *comparator
• Fixed Utility::Tweakable to work correctly with buildsystems using absolute paths for __FILE__ macros (such as Makefiles, Ninja is using relative paths). See mosra/corrade#61.
• In some corner cases, automatic registering / unregistering of Utility::Resource data happens more than once. While this was allowed for registration, the unregistration caused an assert to be fired. Fixed this to be allowed on both.
• Utility::Directory::copy() wasn't properly freeing both opened files if one of them failed to open (see mosra/corrade#70)
• Interconnect::Emitter::emit() (and signal/slot connections in general) now work correctly with non-copyable arguments
• Fixed Utility::Debug::isTty() (and thus also TestSuite colored output) to reliably work on macOS. Because Xcode output window doesn't support ANSI color escape codes, tt was relying on an undocumented $XPC_SERVICE_NAME variable that was always defined inside Xcode to disable colored output. Nowadays this variable is sometimes defined outside as well, making the check unreliable. Fixed by testing for $TERM instead, see mosra/corrade#73 for more information.

Deprecated APIs

• Single-argument Utility::Arguments::setHelp() is now deprecated in favor of Utility::Arguments::setGlobalHelp() to avoid it being used for documenting named arguments by accident.
• Utility::Directory::fileExists() is now deprecated in favor of Utility::Directory::exists(). It was named like this to prevent it from looking like it works on directories only, but such name then caused people to ask if it works on directories as well, not helping anything.
• Interconnect::Connection::isConnected() and Interconnect::Connection::disconnect() are deprecated and print a warning at runtime as the redesigned internals of the Interconnect library now make it impossible to check that the original Interconnect::Emitter object still exists. Use Interconnect::Emitter::isConnected() and Interconnect::disconnect() instead.
• Re-connecting a disconnected signal using Interconnect::Connection::isConnectionPossible() and Interconnect::Connection::connect() is not possible anymore in order to make the Interconnect library more efficient. These two functions are now deprecated and just returningthe value of (also deprecated) isConnected().
• Signatures of TestSuite::Comparator methods were changed in order to support new features. The old variant with operator()() returning a bool and printErrorMessage() instead of printMessage() is still supported for backwards compatibility but custom comparators are strongly advised to upgrade

Potential compatibility breakages, removed APIs

• Containers::StridedArrayView<T> is now Containers::StridedArrayView<dimensions, T> and all code that was using it directly before needs to be changed to use Containers::StridedArrayView1D<T> instead; the constructor is also changed to take a linear array view in addition for better bounds checking
• Support for std::tuple and std::string in Utility::Debug is now provided through a separate header, Corrade/Utility/DebugStl.h, to speed up compile times. Since including it for backwards compatibility would practically revert the optimization, you have to #include it explicitly where needed.
• Utility::formatString(), Utility::formatInto() taking a std::string and support for formatting std::string through the Utility::format() family of APIs is now provided through a separate header, Corrade/Utility/FormatStl.h, to speed up compile times. Since including it for backwards compatibility would practically revert the optimization, you have to #include it explicitly where needed.
• TestSuite::Compare::SortedContainer was split from the Corrade/TestSuite/Compare/Container.h header into Corrade/TestSuite/Compare/SortedContainer.h to isolate the heavy <algorithm> include. Backwards compatibility is not provided in order to reduce compile times, please include the new header now.
• The CORRADE_ENUMSET_FRIEND_OPERATORS() macro now provides both declarations and definitions of enum set operators. This means it has to be used alone, without CORRADE_ENUMSET_OPERATORS(), as that would lead to duplicate definitions.
• The CORRADE_BENCHMARK, CORRADE_BENCHMARK_DISCARD, CORRADE_BENCHMARK_YELLOW and CORRADE_BENCHMARK_RED environment variables used by TestSuite::Tester were renamed to CORRADE_TEST_BENCHMARK, CORRADE_TEST_BENCHMARK_DISCARD, CORRADE_TEST_BENCHMARK_YELLOW and CORRADE_TEST_BENCHMARK_RED to be consistent with remaining variables understood by test suite executables.

Documentation

• Updated docs of the Corrade/Utility/Macros.h header mentioning what CORRADE_DEPRECATED() macros work on what compiler (see mosra/corrade#46)
• Fixed Gentoo build instructions (see mosra/corrade#64)
• Various other doc updates (see mosra/corrade#69, mosra/corrade#71 and mosra/corrade#76)

Dependency changes

• Minimal supported GCC version is now 4.8.1, GCC 4.7 is not supported anymore. Minimal Clang version is now 3.3, since that's the first version with a complete C++11 support. See also mosra/magnum#274.
• Minimal supported CMake version is now 3.1. Older versions are not supported anymore and all workarounds for them were removed. Download a prebuilt release of a newer version if you need to use Corrade on older systems (such as Ubuntu 14.04 or Debian 8). See also mosra/magnum#274.

New features

• Various Corrade features are now being available also as single-header libraries for easier integration into your projects. See Single-header libraries for more information.

Changes and improvements

• The CORRADE_CXX_STANDARD macro has been moved to the top-level Corrade/Corrade.h from Corrade/Utility/Macros.h so it's available everywhere unconditionally

Build system

• Corrade now has a Conan package. See Conan package for more information. See also mosra/corrade#57.
• Corrade is now available through Hunter CMake-driven package manager. See Hunter package for more information. See also mosra/magnum#298.
• The package/msys directory now contains PKGBUILDs for MSYS2. See MSYS2 packages for more information. See also mosra/corrade#56.

Bug fixes

• It was not possible to use TestSuite::Compare::File with CORRADE_COMPARE_WITH() because its symbols were not exported by mistake
• The FILES section in corrade_add_test() was mistakenly ignored everywhere except Android and Emscripten, making cross-platform testing more prone to errors. Now ctest properly fails when the FILES section contains a file that doesn't exist.
• The Containers::ArrayView::operator bool() and Containers::StaticArrayView::operator bool() operators were not constexpr by accident

Deprecated APIs

• Containers::ScopedExit is deprecated, use Containers::ScopeGuard instead
• All uses of std::unique_ptr are replaced with Containers::Pointer (affecting mainly the PluginManager::Manager class). The types are implicitly move-convertible to each other if the Corrade/Containers/PointerStl.h header is included. The header is included where needed if CORRADE_BUILD_DEPRECATED is enabled. To ensure your code keeps with future versions of Magnum, either switch your code to use Containers::Pointer as well or include the Corrade/Containers/PointerStl.h header explicitly.

Potential compatibility breakages, removed APIs

• Removed Containers::ArrayReference, which was deprecated since 2015. Use Containers::ArrayView instead.
• Removed Containers::Array::zeroInitialized() and Containers::Array::from(), which were deprecated since 2015. Use Containers::Array::Array(ValueInitT, std::size_t) and Containers::Array::Array(InPlaceInitT, std::initializer_list<T>) instead.
• Removed Utility::Arguments::setHelpKey(), which was deprecated since 2016. Its functionality was merged into Utility::Arguments::setHelp().
• Removed Utility::Debug::setOutput(), which was deprecated since 2016 and superseded by Utility::Debug scoped output
• Removed Utility::Debug::noNewlineAtTheEnd(), which was deprecated since 2016 and superseded by Utility::Debug::Flag::NoNewlineAtTheEnd
• Removed Utility::sleep() which was deprecated since 2016. Use Utility::System::sleep() instead.
• Removed TestSuite::Tester::BenchmarkType::WallClock, TestSuite::Tester::BenchmarkUnits::Time and TestSuite::Tester::BenchmarkUnits::Memory which were deprecated since January 2017, not long after introducing the benchmark functionality itself. Use TestSuite::Tester::BenchmarkType::WallTime, TestSuite::Tester::BenchmarkUnits::Nanoseconds and TestSuite::Tester::BenchmarkUnits::Bytes instead.
• Removed CORRADE_*_LIBRARIES and CORRADE_*_INCLUDE_DIRS CMake variables, which were deprecated in favor of Corrade::* imported targets in 2016. The deprecated CORRADE_CXX_FLAGS variable is still present, however.

Documentation

• The user-definable macros CORRADE_NO_ASSERT and CORRADE_GRACEFUL_ASSERT now have dedicated documentation, instead of being casually mentioned on various places and impossible to search for.

New features

Changes and improvements

Build system

• There's now a PPA for Ubuntu packages. See Packages for Debian, Ubuntu and derivatives for more information.
• The Resource compiler utility is now fully standalone even with shared builds to minimize annoying first-time-use issues. It's also possible to build just this utility without anything else for example for crosscompiling, by enabling only WITH_RC and disabling all other CMake options.
• Due to changes in Xcode 10, CMake before 3.12 would fail during the build of Corrade. To prevent that, when Xcode 10 is detected, the build aborts with a clear message upfront, telling the user to upgrade to CMake 3.12. See mosra/corrade#52 and cmake/cmake#18099.

Bug fixes

• Calling PluginManager::Manager::setPluginDirectory() could lead to plugin aliases being forgotten in some cases
• Worked around a misoptimization of Utility::Sha1 when using GCC 6 with -O3 on Raspberry Pi Model 3 B+ (AArch64) (GCC 8 works properly again). See mosra/corrade#45.
• It was not possible to use the Interconnect::Emitter class with virtual base classes on 32-bit Windows due to an incorrect assumption about member function pointer sizes (see mosra/magnum-extras#7)
• Assertions were not removed if both CORRADE_NO_ASSERT and CORRADE_GRACEFUL_ASSERT was defined

Documentation

• All code snippets are now compiled, ensuring no deprecated APIs are used and no accidental compile errors are present
• TestSuite::Comparator documentation mistakenly stated that it's possible to have multiple operator()() overloads for a single pseudo-type. Due to implementation limitations it's not.

Changelogs for previous versions are available in Archived changelogs.