Add support to charls.ixx for import std; (#339)

Use the macro __cpp_lib_modules to detect if usage of import std; is possible.

Author: vbaderks

cpp.hint

@@ -1,4 +1,4 @@
-// Copyright (c) Team CharLS.
+// SPDX-FileCopyrightText: © 2018 Team CharLS
 // SPDX-License-Identifier: BSD-3-Clause
 
 //
@@ -29,6 +29,7 @@
 #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

include/charls/api_abi.h

@@ -49,6 +49,7 @@
 #define CHARLS_FINAL final
 #define CHARLS_NOEXCEPT noexcept
 #define CHARLS_C_VOID
+#define CHARLS_STD ::std::
 
 #ifdef CHARLS_BUILD_AS_CPP_MODULE
 #define CHARLS_EXPORT export
@@ -61,5 +62,6 @@
 #define CHARLS_FINAL
 #define CHARLS_NOEXCEPT
 #define CHARLS_C_VOID void
+#define CHARLS_STD
 
 #endif

include/charls/charls.h

@@ -1,10 +1,11 @@
-// Copyright (c) Team CharLS.
+// SPDX-FileCopyrightText: © 2009 Team CharLS
 // SPDX-License-Identifier: BSD-3-Clause
 
 #pragma once
 
 #include "charls_jpegls_decoder.h"
 #include "charls_jpegls_encoder.h"
+#include "validate_spiff_header.h"
 #include "version.h"
 
 #include "undef_macros.h"

include/charls/charls.ixx

@@ -1,20 +1,32 @@
-// Copyright (c) Team CharLS.
+// SPDX-FileCopyrightText: © 2023 Team CharLS
 // SPDX-License-Identifier: BSD-3-Clause
 
 module;
 
 #define CHARLS_BUILD_AS_CPP_MODULE
 
+#include <version>
 #include <sal.h>
+
+#ifndef __cpp_lib_modules
+
 #include <cstddef>
 #include <cstdint>
 #include <system_error>
 #include <functional>
 #include <memory>
 #include <utility>
 
+#endif
+
 export module charls;
 
+#ifdef __cpp_lib_modules
+
+import std;
+
+#endif
+
 #include "jpegls_decoder.hpp"
 #include "jpegls_encoder.hpp"
 #include "version.h"

include/charls/charls_jpegls_decoder.h

@@ -1,19 +1,15 @@
-// Copyright (c) Team CharLS.
+// SPDX-FileCopyrightText: © 2020 Team CharLS
 // SPDX-License-Identifier: BSD-3-Clause
 
 #pragma once
 
 #include "jpegls_error.h"
-#include "validate_spiff_header.h"
-
-#ifndef __cplusplus
-#include <stddef.h>
-#endif
 
 #ifdef __cplusplus
 struct charls_jpegls_decoder;
 extern "C" {
 #else
+#include <stddef.h>
 typedef struct charls_jpegls_decoder charls_jpegls_decoder;
 #endif
 
@@ -110,7 +106,7 @@ charls_jpegls_decoder_get_near_lossless(CHARLS_IN const charls_jpegls_decoder* d
 /// <param name="interleave_mode">Reference that will hold the value of the interleave mode.</param>
 /// <returns>The result of the operation: success or a failure code.</returns>
 CHARLS_CHECK_RETURN CHARLS_API_IMPORT_EXPORT charls_jpegls_errc CHARLS_API_CALLING_CONVENTION
-charls_jpegls_decoder_get_interleave_mode(CHARLS_IN const charls_jpegls_decoder* decoder, int32_t component_index, 
+charls_jpegls_decoder_get_interleave_mode(CHARLS_IN const charls_jpegls_decoder* decoder, int32_t component_index,
                                           CHARLS_OUT charls_interleave_mode* interleave_mode) CHARLS_NOEXCEPT
     CHARLS_ATTRIBUTE((nonnull));
 

include/charls/charls_jpegls_encoder.h

@@ -1,21 +1,15 @@
-// Copyright (c) Team CharLS.
+// SPDX-FileCopyrightText: © 2020 Team CharLS
 // SPDX-License-Identifier: BSD-3-Clause
 
 #pragma once
 
 #include "jpegls_error.h"
 
-#ifdef __cplusplus
-#include <cstring>
-#include <memory>
-#else
-#include <stddef.h>
-#endif
-
 #ifdef __cplusplus
 struct charls_jpegls_encoder;
 extern "C" {
 #else
+#include <stddef.h>
 typedef struct charls_jpegls_encoder charls_jpegls_encoder;
 #endif
 

include/charls/jpegls_decoder.hpp

@@ -1,9 +1,10 @@
-// Copyright (c) Team CharLS.
+// SPDX-FileCopyrightText: © 2020 Team CharLS
 // SPDX-License-Identifier: BSD-3-Clause
 
 #pragma once
 
 #include "charls_jpegls_decoder.h"
+#include "validate_spiff_header.h"
 #include "jpegls_error.hpp"
 
 #ifndef CHARLS_BUILD_AS_CPP_MODULE

include/charls/jpegls_encoder.hpp

@@ -1,12 +1,14 @@
-// Copyright (c) Team CharLS.
+// SPDX-FileCopyrightText: © 2020 Team CharLS
 // SPDX-License-Identifier: BSD-3-Clause
 
 #pragma once
 
 #include "charls_jpegls_encoder.h"
 
+#ifndef CHARLS_BUILD_AS_CPP_MODULE
 #include <cstring>
 #include <memory>
+#endif
 
 CHARLS_EXPORT
 namespace charls {

include/charls/public_types.h

@@ -386,7 +386,8 @@ enum class [[nodiscard]] jpegls_errc
     invalid_parameter_jpegls_preset_parameters = impl::CHARLS_JPEGLS_ERRC_INVALID_PARAMETER_JPEGLS_PRESET_PARAMETERS,
 
     /// <summary>
-    /// This error is returned when the stream contains an invalid color transformation segment or one that doesn't match with frame info.
+    /// This error is returned when the stream contains an invalid color transformation segment or one that doesn't match
+    /// with frame info.
     /// </summary>
     invalid_parameter_color_transformation = impl::CHARLS_JPEGLS_ERRC_INVALID_PARAMETER_COLOR_TRANSFORMATION,
 
@@ -622,7 +623,7 @@ enum class color_transformation
 /// Defines the Application profile identifier options that can be used in a SPIFF header v2, as defined in ISO/IEC 10918-3,
 /// F.1.2
 /// </summary>
-enum class spiff_profile_id : int32_t
+enum class spiff_profile_id : std::int32_t
 {
     /// <summary>
     /// No profile identified.
@@ -655,7 +656,7 @@ enum class spiff_profile_id : int32_t
 /// <summary>
 /// Defines the color space options that can be used in a SPIFF header v2, as defined in ISO/IEC 10918-3, F.2.1.1
 /// </summary>
-enum class spiff_color_space : int32_t
+enum class spiff_color_space : std::int32_t
 {
     /// <summary>
     /// Bi-level image. Each image sample is one bit: 0 = white and 1 = black.
@@ -730,7 +731,7 @@ enum class spiff_color_space : int32_t
 /// <summary>
 /// Defines the compression options that can be used in a SPIFF header v2, as defined in ISO/IEC 10918-3, F.2.1
 /// </summary>
-enum class spiff_compression_type : int32_t
+enum class spiff_compression_type : std::int32_t
 {
     /// <summary>
     /// Picture data is stored in component interleaved format, encoded at BPS per sample.
@@ -773,7 +774,7 @@ enum class spiff_compression_type : int32_t
 /// <summary>
 /// Defines the resolution units for the VRES and HRES parameters, as defined in ISO/IEC 10918-3, F.2.1
 /// </summary>
-enum class spiff_resolution_units : int32_t
+enum class spiff_resolution_units : std::int32_t
 {
     /// <summary>
     /// VRES and HRES are to be interpreted as aspect ratio.
@@ -799,7 +800,7 @@ enum class spiff_resolution_units : int32_t
 /// <summary>
 /// Official defined SPIFF tags defined in Table F.5 (ISO/IEC 10918-3)
 /// </summary>
-enum class spiff_entry_tag : uint32_t
+enum class spiff_entry_tag : std::uint32_t
 {
     /// <summary>
     /// This entry describes the opto-electronic transfer characteristics of the source image.
@@ -931,15 +932,15 @@ typedef int32_t charls_spiff_resolution_units;
 struct charls_spiff_header CHARLS_FINAL
 {
     charls_spiff_profile_id profile_id;   // P: Application profile, type I.8
-    int32_t component_count;              // NC: Number of color components, range [1, 255], type I.8
-    uint32_t height;                      // HEIGHT: Number of lines in image, range [1, 4294967295], type I.32
-    uint32_t width;                       // WIDTH: Number of samples per line, range [1, 4294967295], type I.32
+    CHARLS_STD int32_t component_count;   // NC: Number of color components, range [1, 255], type I.8
+    CHARLS_STD uint32_t height;           // HEIGHT: Number of lines in image, range [1, 4294967295], type I.32
+    CHARLS_STD uint32_t width;            // WIDTH: Number of samples per line, range [1, 4294967295], type I.32
     charls_spiff_color_space color_space; // S: Color space used by image data, type is I.8
-    int32_t bits_per_sample;              // BPS: Number of bits per sample, range (1, 2, 4, 8, 12, 16), type is I.8
+    CHARLS_STD int32_t bits_per_sample;   // BPS: Number of bits per sample, range (1, 2, 4, 8, 12, 16), type is I.8
     charls_spiff_compression_type compression_type; // C: Type of data compression used, type is I.8
     charls_spiff_resolution_units resolution_units; // R: Type of resolution units, type is I.8
-    uint32_t vertical_resolution;   // VRES: Vertical resolution, range [1, 4294967295], type can be F or I.32
-    uint32_t horizontal_resolution; // HRES: Horizontal resolution, range [1, 4294967295], type can be F or I.32
+    CHARLS_STD uint32_t vertical_resolution;   // VRES: Vertical resolution, range [1, 4294967295], type can be F or I.32
+    CHARLS_STD uint32_t horizontal_resolution; // HRES: Horizontal resolution, range [1, 4294967295], type can be F or I.32
 };
 
 
@@ -955,22 +956,22 @@ struct charls_frame_info CHARLS_FINAL
     /// <summary>
     /// Width of the image, range [1, 4294967295].
     /// </summary>
-    uint32_t width;
+    CHARLS_STD uint32_t width;
 
     /// <summary>
     /// Height of the image, range [1, 4294967295].
     /// </summary>
-    uint32_t height;
+    CHARLS_STD uint32_t height;
 
     /// <summary>
     /// Number of bits per sample, range [2, 16]
     /// </summary>
-    int32_t bits_per_sample;
+    CHARLS_STD int32_t bits_per_sample;
 
     /// <summary>
     /// Number of components contained in the frame, range [1, 255]
     /// </summary>
-    int32_t component_count;
+    CHARLS_STD int32_t component_count;
 };
 
 
@@ -985,27 +986,27 @@ struct charls_jpegls_pc_parameters CHARLS_FINAL
     /// Maximum possible value for any image sample in a scan.
     /// This must be greater than or equal to the actual maximum value for the components in a scan.
     /// </summary>
-    int32_t maximum_sample_value;
+    CHARLS_STD int32_t maximum_sample_value;
 
     /// <summary>
     /// First quantization threshold value for the local gradients.
     /// </summary>
-    int32_t threshold1;
+    CHARLS_STD int32_t threshold1;
 
     /// <summary>
     /// Second quantization threshold value for the local gradients.
     /// </summary>
-    int32_t threshold2;
+    CHARLS_STD int32_t threshold2;
 
     /// <summary>
     /// Third quantization threshold value for the local gradients.
     /// </summary>
-    int32_t threshold3;
+    CHARLS_STD int32_t threshold3;
 
     /// <summary>
     /// Value at which the counters A, B, and N are halved.
     /// </summary>
-    int32_t reset_value;
+    CHARLS_STD int32_t reset_value;
 };
 
 
@@ -1017,17 +1018,17 @@ struct charls_mapping_table_info CHARLS_FINAL
     /// <summary>
     /// Identifier of the mapping table, range [1, 255].
     /// </summary>
-    int32_t table_id;
+    CHARLS_STD int32_t table_id;
 
     /// <summary>
     /// Width of a table entry in bytes, range [1, 255].
     /// </summary>
-    int32_t entry_size;
+    CHARLS_STD int32_t entry_size;
 
     /// <summary>
     /// Size of the table in bytes, range [1, 16711680]
     /// </summary>
-    uint32_t data_size;
+    CHARLS_STD uint32_t data_size;
 };
 
 
@@ -1042,7 +1043,8 @@ struct charls_mapping_table_info CHARLS_FINAL
 /// <param name="size">Size in bytes of the data of the COM segment.</param>
 /// <param name="user_context">Free to use context information that can be set during the installation of the
 /// handler.</param>
-using charls_at_comment_handler = int32_t(CHARLS_API_CALLING_CONVENTION*)(const void* data, size_t size, void* user_context);
+using charls_at_comment_handler = std::int32_t(CHARLS_API_CALLING_CONVENTION*)(const void* data, std::size_t size,
+                                                                               void* user_context);
 
 /// <summary>
 /// Function definition for a callback handler that will be called when an application data (APPn) segment is found.
@@ -1054,9 +1056,9 @@ using charls_at_comment_handler = int32_t(CHARLS_API_CALLING_CONVENTION*)(const
 /// <param name="size">Size in bytes of the data of the APPn segment.</param>
 /// <param name="user_context">Free to use context information that can be set during the installation of the
 /// handler.</param>
-using charls_at_application_data_handler = int32_t(CHARLS_API_CALLING_CONVENTION*)(int32_t application_data_id,
-                                                                                   const void* data, size_t size,
-                                                                                   void* user_context);
+using charls_at_application_data_handler = std::int32_t(CHARLS_API_CALLING_CONVENTION*)(std::int32_t application_data_id,
+                                                                                        const void* data, std::size_t size,
+                                                                                        void* user_context);
 
 CHARLS_EXPORT
 namespace charls {

include/charls/undef_macros.h

@@ -10,6 +10,7 @@
 #undef CHARLS_NOEXCEPT
 #undef CHARLS_ATTRIBUTE
 #undef CHARLS_C_VOID
+#undef CHARLS_STD
 #undef CHARLS_NO_INLINE
 #undef CHARLS_IN
 #undef CHARLS_IN_OPT

include/charls/version.h

@@ -7,7 +7,11 @@
 #include "api_abi.h"
 
 #ifdef __cplusplus
+
+#ifndef CHARLS_BUILD_AS_CPP_MODULE
 #include <cstdint>
+#endif
+
 extern "C" {
 #else
 #include <stdint.h>

src/CharLS.vcxproj

@@ -209,6 +209,7 @@
     <None Include="design\JpegStream.cd" />
     <None Include="design\Strategy.cd" />
     <None Include="packages.config" />
+    <None Include="..\include\charls\charls.ixx" />
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="golomb_lut.cpp" />

src/CharLS.vcxproj.filters

@@ -31,6 +31,9 @@
     <ClCompile Include="quantization_lut.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="..\include\charls\charls.ixx">
+      <Filter>Header Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\include\charls\charls.h">