charls/cpp.hint

// SPDX-FileCopyrightText: © 2018 Team CharLS
// SPDX-License-Identifier: BSD-3-Clause

//
// cpp.hint: What is this thing?
//
// This file is used solely to aid Visual Studio Intellisense while editing.
// It is not used as part of any build. See Microsoft docs for more info about this file.
//

#define CHARLS_API_IMPORT_EXPORT
#define CHARLS_API_CALLING_CONVENTION
#define CHARLS_FINAL final
#define CHARLS_NOEXCEPT
#define CHARLS_NO_INLINE
#define FORCE_INLINE
#define MSVC_WARNING_SUPPRESS_NEXT_LINE(x)
#define MSVC_WARNING_SUPPRESS(x)
#define MSVC_WARNING_UNSUPPRESS
#define CHARLS_IN
#define CHARLS_IN_OPT
#define CHARLS_IN_Z
#define CHARLS_IN_READS_BYTES(size)
#define CHARLS_OUT
#define CHARLS_OUT_OPT
#define CHARLS_OUT_WRITES_BYTES(size)
#define CHARLS_OUT_WRITES_Z(size_in_bytes)
#define CHARLS_RETURN_TYPE_SUCCESS(expr)
#define CHARLS_ATTRIBUTE(a)
#define CHARLS_ATTRIBUTE_ACCESS(a)
#define CHARLS_C_VOID
#define CHARLS_STD ::std::
#define CHARLS_EXPORT
#define CHARLS_CHECK_RETURN
#define CHARLS_RET_MAY_BE_NULL
#define USE_DECL_ANNOTATIONS
#define ASSERT(x)
#define UNLIKELY(x)
#define BENCHMARK_MAIN()
Add support to charls.ixx for import std; (#339) Use the macro __cpp_lib_modules to detect if usage of import std; is possible. 2024-12-06 11:44:25 +01:00			`// SPDX-FileCopyrightText: © 2018 Team CharLS`
Introduce SPDX Unique License Identifiers (BSD-3-Clause) Apply the modern way of documenting the used license, by referencing a SPDX Unique License Identifier in the source code files. Note: From the legal point of view, this commit is only a change to the textual representation of the license information, but in no way any change to the actual license terms. With this commit applied, all files will still be licensed under the same terms they were before. 2019-11-08 23:17:16 +01:00			`// SPDX-License-Identifier: BSD-3-Clause`

Add cpp.hint files to assist intellisense 2018-05-31 14:12:52 +02:00			`//`
			`// cpp.hint: What is this thing?`
			`//`
			`// This file is used solely to aid Visual Studio Intellisense while editing.`
			`// It is not used as part of any build. See Microsoft docs for more info about this file.`
Introduce an object-oriented C++ API based on a new C ABI The current C API prevents adding new features and the introduction of an object oriented C++ interface. Every change results directly in a ABI break. To prevent this a new C API is introduced that is easier to extend and to maintain. On top of this API are 2 C++ classes: jpeg_encoder and jpeg_decoder to encode and decode JPEG-LS files. This commit comes also with the following changes: - Updated .clang-format - Switch to Visual Studio 2019 for the CI build pipeline - Support for reading and writing SPIFF header - Incomplete support for JFIF header has been removed - Extended unit test coverage 2019-11-08 21:56:38 +01:00			`//`
Add cpp.hint files to assist intellisense 2018-05-31 14:12:52 +02:00
Replace charls_error with charls::jpegls_error Export the class jpegls_error to make it possible to re-use it. 2018-11-06 22:43:54 +01:00			`#define CHARLS_API_IMPORT_EXPORT`
			`#define CHARLS_API_CALLING_CONVENTION`
Introduce an object-oriented C++ API based on a new C ABI The current C API prevents adding new features and the introduction of an object oriented C++ interface. Every change results directly in a ABI break. To prevent this a new C API is introduced that is easier to extend and to maintain. On top of this API are 2 C++ classes: jpeg_encoder and jpeg_decoder to encode and decode JPEG-LS files. This commit comes also with the following changes: - Updated .clang-format - Switch to Visual Studio 2019 for the CI build pipeline - Support for reading and writing SPIFF header - Incomplete support for JFIF header has been removed - Extended unit test coverage 2019-11-08 21:56:38 +01:00			`#define CHARLS_FINAL final`
Add overflow detection for estimated_destination_size in x86 build (#150) As CharLS now supports oversized image dimensions, the x86 build should check that the calculated estimated destination buffer size doesn't overflow. 2022-01-23 16:26:40 +01:00			`#define CHARLS_NOEXCEPT`
Add a noinline helper method to throw jpegls_error objects The normal code path of the check_jpegls_errc is to not throw. Use a helper function to move the exceptional path out of this function. 2019-11-28 23:35:39 +01:00			`#define CHARLS_NO_INLINE`
Add cpp.hint files to assist intellisense 2018-05-31 14:12:52 +02:00			`#define FORCE_INLINE`
Use MSVC_WARNING_SUPPRESS_NEXT_LINE to reduce noise By using the "suppress" method of MSVC #pragma warning, the additional lines needed to suppress false warnings can be reduced. 2020-04-04 14:21:21 +02:00			`#define MSVC_WARNING_SUPPRESS_NEXT_LINE(x)`
Add support to encode and decode mapping tables (#302) * Add support to write mapping tables to the JPEG byte stream. * Add API method to set the table ID for a component * Add method to create JPEG-LS file with mapping tables only. * Add support to read mapping tables * Parse table-ids from the scan segment * Extend API of charls_decoder_get_mapping_table_index to return -1 if index is not found * Add support to read mapping table continuation segments * Document new API methods * Add sample image from appendix H.4.5 "Example of a palletised image" / Figure H.10 to unit test * Update the get_mapping_table API to include size of the buffer 2024-07-23 13:17:12 +02:00			`#define MSVC_WARNING_SUPPRESS(x)`
			`#define MSVC_WARNING_UNSUPPRESS`
Add the prefix CHARLS for the SAL annotation macros (#115) Using the prefix CHARLS is a more clear identification that the macros belongs to the CharLS library. It also reduces the risk with conflicts of other 3rd party headers. 2021-12-19 14:32:26 +01:00			`#define CHARLS_IN`
			`#define CHARLS_IN_OPT`
			`#define CHARLS_IN_Z`
			`#define CHARLS_IN_READS_BYTES(size)`
			`#define CHARLS_OUT`
			`#define CHARLS_OUT_OPT`
			`#define CHARLS_OUT_WRITES_BYTES(size)`
			`#define CHARLS_OUT_WRITES_Z(size_in_bytes)`
			`#define CHARLS_RETURN_TYPE_SUCCESS(expr)`
Add C++ static analyzer annotations to the API Both the MSVC and the gcc\clang C++ compiler provide additional attributes that can be used to assist the static analyzer build into these compilers to detect problems at compile time. The problem is that these extension attributes are not cross compiler compatible, which requires additional macros to ensure that all supported compiler can compile the code. The main focus of adding these attributes is on the external C API as in that area the most errors can be made. 2020-02-02 14:22:50 +01:00			`#define CHARLS_ATTRIBUTE(a)`
Use CHARLS_CHECK_RETURN instead of CHARLS_NO_DISCARD (#117) The C++ attribute [[nodiscard]] requires C++17. Using _Check_return_ or __attribute__((warn_unused_result)) ensures C++14 and C apps are covered. __attribute__((warn_unused_result)) cannot be used in front of an enum. Using CHARLS_CHECK_RETURN directly in front of the API functions ensure the best coverage. Add also CHARLS_ATTRIBUTE_ACCESS((access()) annotations. Note that only GCC 10 or newer is required for this annotation attribute. 2021-12-19 22:37:40 +01:00			`#define CHARLS_ATTRIBUTE_ACCESS(a)`
Introduce CHARLS_C_VOID to handle difference of void in API C requires void when no parameters are used in a method. Modern C++ doesn't use it. Use a macro to support both languages. 2020-10-03 12:10:51 +02:00			`#define CHARLS_C_VOID`
Add support to charls.ixx for import std; (#339) Use the macro __cpp_lib_modules to detect if usage of import std; is possible. 2024-12-06 11:44:25 +01:00			`#define CHARLS_STD ::std::`
Add support to encode and decode mapping tables (#302) * Add support to write mapping tables to the JPEG byte stream. * Add API method to set the table ID for a component * Add method to create JPEG-LS file with mapping tables only. * Add support to read mapping tables * Parse table-ids from the scan segment * Extend API of charls_decoder_get_mapping_table_index to return -1 if index is not found * Add support to read mapping table continuation segments * Document new API methods * Add sample image from appendix H.4.5 "Example of a palletised image" / Figure H.10 to unit test * Update the get_mapping_table API to include size of the buffer 2024-07-23 13:17:12 +02:00			`#define CHARLS_EXPORT`
Add SAL annotations on "create" functions charls_jpegls_decoder_create and charls_jpegls_encoder_create may return null pointers. Add SAL annotations on those functions. note: remove API docs for removed parameters 2020-11-16 22:57:23 +01:00			`#define CHARLS_CHECK_RETURN`
			`#define CHARLS_RET_MAY_BE_NULL`
Add the prefix CHARLS for the SAL annotation macros (#115) Using the prefix CHARLS is a more clear identification that the macros belongs to the CharLS library. It also reduces the risk with conflicts of other 3rd party headers. 2021-12-19 14:32:26 +01:00			`#define USE_DECL_ANNOTATIONS`
Backport C++20 countl_zero (#128) Backport C++20 countl_zero 1) countl_zero can be used in peek_0_bits and is 2X faster. Note: peek_0_bits is not on a hot path, overall gain is limited. 2) Apply updates for clang-tidy v13 (ships with VS 2022 17.1 Preview 2) 3) Increase upper range of supported CMake to 3.22 2022-01-06 16:06:23 +01:00			`#define ASSERT(x)`
Mark branches that will throw an error exception with "unlikely" (#132) 2022-01-08 01:36:14 +01:00			`#define UNLIKELY(x)`
Fix triplet problem with vcpkg and ARM64 platform (#337) vcpkg requires lowercase triplet names. Using ARM64 will trigger a failure. Add an explicit override to resolve this. 2024-11-21 23:43:12 +01:00			`#define BENCHMARK_MAIN()`