Use ConvertFlag to open convertion descriptor.

Author: ChenPi11

.markdownlint.json

@@ -0,0 +1,8 @@
+{
+  "MD024": {
+    "siblings_only": true
+  },
+  "MD033": {
+    "allowed_elements": ["img"]
+  }
+}

CMakeLists.txt

@@ -33,7 +33,7 @@ if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/build-aux")
 elseif(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/../build-aux")
     set(BUILD_AUX "${CMAKE_CURRENT_SOURCE_DIR}/../build-aux")
 else()
-    message(FATAL_ERROR "CMake build-aux directory is not exists, try to execute 'setup.cmd' or './setup.sh' to get it.")
+    message(FATAL_ERROR "C+++ build-aux directory is not exists.")
 endif()
 get_filename_component(BUILD_AUX "${BUILD_AUX}" ABSOLUTE)
 include("${BUILD_AUX}/cmake/cppp.cmake")
@@ -71,7 +71,6 @@ configure_file("${CMAKE_CURRENT_SOURCE_DIR}/include/cppp/reiconv.hpp.in" "${outp
 set(CPPP_API "${CPPP_IMPORT_API}")
 configure_file("${CMAKE_CURRENT_SOURCE_DIR}/include/cppp/reiconv.h.in" "${output_includedir}/cppp/reiconv.h.inst")
 
-
 # Header for build.
 # cppp/reiconv.hpp
 set(CPPP_API "${CPPP_EXPORT_API}")

include/cppp/encodings/reiconv.h.in

@@ -23,15 +23,13 @@
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
-/* When installed, this file is called "cppp/reiconv.h". */
-
+#pragma once
 #ifndef _CPPP_ENCODINGS_REICONV_H_
 #define _CPPP_ENCODINGS_REICONV_H_
-#pragma once
 
 #if _MSC_VER >= 1600
 #pragma execution_character_set("utf-8")
-#endif
+#endif /* _MSC_VER >= 1600 */
 
 @INDEXES_CODE@
-#endif // _CPPP_ENCODINGS_REICONV_H_
+#endif /* _CPPP_ENCODINGS_REICONV_H_ */

include/cppp/encodings/reiconv.hpp.in

@@ -23,15 +23,13 @@
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
-/* When installed, this file is called "cppp/reiconv.hpp". */
-
+#pragma once
 #ifndef _CPPP_ENCODINGS_REICONV_HPP_
 #define _CPPP_ENCODINGS_REICONV_HPP_
-#pragma once
 
 #if _MSC_VER >= 1600
 #pragma execution_character_set("utf-8")
-#endif
+#endif // _MSC_VER >= 1600
 
 @INDEXES_CODE@
 #endif // _CPPP_ENCODINGS_REICONV_HPP_

include/cppp/reiconv.h.in

@@ -23,31 +23,26 @@
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
-/* When installed, this file is called "cppp/reiconv.h". */
-
 #pragma once
-
 #ifndef _CPPP_REICONV_H_
 #define _CPPP_REICONV_H_
 
-#include <cppp/encodings/reiconv.h>
+#include "encodings/reiconv.h"
 
-#include <stdbool.h>
 #include <stddef.h>
 
-#define _CPPP_API
-
 #ifndef _CPPP_API
 #define _CPPP_API @CPPP_API@
-#endif
+#endif /* _CPPP_API */
 
 #if _MSC_VER >= 1600
 #pragma execution_character_set("utf-8")
-#endif
+#endif /* _MSC_VER >= 1600 */
 
 #ifdef __cplusplus
-extern "C" {
-#endif
+extern "C"
+{
+#endif /* __cplusplus */
 
 /**
  * @brief Version information.
@@ -86,7 +81,7 @@ extern _CPPP_API size_t reiconv_name_canonicalize(const char *name, char *outbuf
 
 /**
  * @brief Lookup an encoding by it's name.
- * @note The return value is an encoding index that can be used with `reiconv_open_from_codepage`.
+ * @note The return value is an encoding index that can be used with `reiconv_open_from_index`.
  * @note We will ignore '-' and '_', and uppercase all characters.
  * @param encoding The encoding name.
  * @return The encoding index. If the it is not found, -1 is returned.
@@ -95,7 +90,7 @@ extern _CPPP_API int reiconv_lookup_from_name(const char *encoding);
 
 /**
  * @brief Lookup an encoding by it's codepage.
- * @note The return value is an encoding index that can be used with `reiconv_open_from_codepage`.
+ * @note The return value is an encoding index that can be used with `reiconv_open_from_index`.
  * @param codepage The codepage.
  * @return The encoding index. If the it is not found, -1 is returned.
  */
@@ -106,36 +101,52 @@ extern _CPPP_API int reiconv_lookup_from_codepage(int codepage);
  */
 typedef void *reiconv_t;
 
+/**
+ * @brief Convert flags. Used for open conversion descriptor.
+ */
+enum ConvertFlag
+{
+    /**
+     * @brief No flags.
+     */
+    REICONV_NO_FLAGS = 0,
+
+    /**
+     * @brief Discard illegal sequences. Same as iconv(3) '//IGNORE'.
+     */
+    REICONV_DISCARD_ILSEQ = 1,
+};
+
 /**
  * @brief Open a conversion descriptor from encoding index.
  * @note The return value is a conversion descriptor.
  * @param fromcode The input buffer encoding's index.
  * @param tocode The output buffer encoding's index.
- * @param discard_ilseq If true, we will ignore conversion errors. Same as iconv(3) '//IGNORE'.
+ * @param flags The convert flags.
  * @return The conversion descriptor. Indexes MUST BE VALID or the behavior is undefined.
  * @note If the conversion descriptor cannot be created, returns (reiconv_t)(-1) and errno is set to ENOMEM.
  */
-extern _CPPP_API reiconv_t reiconv_open_from_index(int fromcode, int tocode, bool discard_ilseq);
+extern _CPPP_API reiconv_t reiconv_open_from_index(int fromcode, int tocode, enum ConvertFlag flags);
 
 /**
  * @brief Open a conversion descriptor from codepage.
  * @note The return value is a conversion descriptor.
  * @param fromcode The input buffer encoding's codepage.
  * @param tocode The output buffer encoding's codepage.
- * @param discard_ilseq If true, we will ignore conversion errors. Same as iconv(3) '//IGNORE'.
+ * @param flags The convert flags.
  * @return The conversion descriptor. (reiconv_t)(-1) is returned if error occured with errno set.
  */
-extern _CPPP_API reiconv_t reiconv_open_from_codepage(int fromcode, int tocode, bool discard_ilseq);
+extern _CPPP_API reiconv_t reiconv_open_from_codepage(int fromcode, int tocode, enum ConvertFlag flags);
 
 /**
  * @brief Open a conversion descriptor from encoding name.
  * @note The return value is a conversion descriptor.
  * @param fromcode The input buffer encoding's name.
  * @param tocode The output buffer encoding's name.
- * @param discard_ilseq If true, we will ignore conversion errors. Same as iconv(3) '//IGNORE'.
+ * @param flags The convert flags.
  * @return The conversion descriptor. (reiconv_t)(-1) is returned if error occured with errno set.
  */
-extern _CPPP_API reiconv_t reiconv_open_from_name(const char* fromcode, const char* tocode, bool discard_ilseq);
+extern _CPPP_API reiconv_t reiconv_open_from_name(const char *fromcode, const char *tocode, enum ConvertFlag flags);
 
 /**
  * @brief Get the size of the result. -1 on error with errno set.
@@ -159,7 +170,8 @@ extern _CPPP_API size_t reiconv_result_size(reiconv_t cd, const char *start, siz
  * @note If the output buffer is too big, the rest of the buffer is filled with zero.
  * @return 0 on success, -1 on error with errno set.
  */
-extern _CPPP_API int reiconv_convert_static_size(reiconv_t cd, const char* input_data, size_t input_length, char* output_data, size_t output_length);
+extern _CPPP_API int reiconv_convert_static_size(reiconv_t cd, const char *input_data, size_t input_length,
+                                                 char *output_data, size_t output_length);
 
 /**
  * @brief Converts an string from one encoding to another.
@@ -175,7 +187,8 @@ extern _CPPP_API int reiconv_convert_static_size(reiconv_t cd, const char* input
  * @note The length of the result is stored in `*output_length_ptr`.
  * @return 0 on success, -1 on error with errno set.
  */
-extern _CPPP_API int reiconv_convert(reiconv_t cd, const char *input_data, size_t input_length, char **output_data_ptr, size_t *output_length_ptr);
+extern _CPPP_API int reiconv_convert(reiconv_t cd, const char *input_data, size_t input_length, char **output_data_ptr,
+                                     size_t *output_length_ptr);
 
 /**
  * @brief Open a conversion descriptor. For iconv compatibility.
@@ -192,7 +205,8 @@ extern _CPPP_API reiconv_t reiconv_open(const char *tocode, const char *fromcode
  * @note Decrements `*inbytesleft` and increments `*inbuf` by the same amount.
  * @note Decrements `*outbytesleft` and increments `*outbuf` by the same amount.
  */
-extern _CPPP_API size_t reiconv_iconv(reiconv_t cd, char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft);
+extern _CPPP_API size_t reiconv_iconv(reiconv_t cd, char **inbuf, size_t *inbytesleft, char **outbuf,
+                                      size_t *outbytesleft);
 
 /**
  * @brief Close a conversion descriptor. For iconv compatibility.
@@ -210,6 +224,6 @@ extern _CPPP_API const char *locale_charset();
 
 #ifdef __cplusplus
 }
-#endif
+#endif /* __cplusplus */
 
 #endif /* _CPPP_REICONV_H_ */

include/cppp/reiconv.hpp.in

@@ -23,21 +23,16 @@
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
-/* When installed, this file is called "cppp/reiconv.hpp". */
-
 #pragma once
 #ifndef _CPPP_REICONV_HPP_
 #define _CPPP_REICONV_HPP_
 
-#include <cppp/encodings/reiconv.hpp>
+#include "encodings/reiconv.hpp"
 
-#include <cstddef>
 #include <cstring>
 #include <string>
 #include <string_view>
 
-#define _CPPP_API // TODO: Remove this.
-
 #ifndef _CPPP_API
 #define _CPPP_API @CPPP_API@
 #endif
@@ -123,6 +118,22 @@ namespace reiconv
      */
     extern _CPPP_API VersionInfo version;
 
+    /**
+     * @brief Convert flags. Used for open conversion descriptor.
+     */
+    enum class ConvertFlag
+    {
+        /**
+         * @brief No flags.
+         */
+        NO_FLAGS = 0,
+
+        /**
+         * @brief Discard illegal sequences. Same as iconv(3) '//IGNORE'.
+         */
+        DISCARD_ILSEQ = 1,
+    };
+
     /**
      * @brief Converts an string from one encoding to another, supports encodings autodetecting.
      *
@@ -139,7 +150,7 @@ namespace reiconv
      * @return Return the output buffer.
      * @throw std::system_error if an error occurs.
      */
-    extern _CPPP_API std::string convert(Encoding from, Encoding to, const std::string_view input, bool strict = true);
+    extern _CPPP_API std::string convert(Encoding from, Encoding to, const std::string_view input, enum ConvertFlag flag = ConvertFlag::NO_FLAGS);
 
     /**
      * @brief Determine the current locale's character encoding.

include/iconv.h.in

@@ -23,8 +23,6 @@
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
-/* When installed, this file is called "iconv.h". */
-
 #ifndef _ICONV_H_
 #define _ICONV_H_
 

lib/iconv.c

@@ -86,7 +86,7 @@ _CPPP_API int reiconv_lookup_from_codepage(int codepage)
     return codepage_to_eindex[codepage] - 1;
 }
 
-_CPPP_API reiconv_t reiconv_open_from_index(int fromcode, int tocode, bool discard_ilseq)
+_CPPP_API reiconv_t reiconv_open_from_index(int fromcode, int tocode, enum ConvertFlag flags)
 {
     struct conv_struct *cd = (struct conv_struct *)malloc(sizeof(struct conv_struct));
     if (cd == NULL)
@@ -111,12 +111,12 @@ _CPPP_API reiconv_t reiconv_open_from_index(int fromcode, int tocode, bool disca
     cd->ibyteorder = 0;
 
     // Initialize the operation flags.
-    cd->discard_ilseq = discard_ilseq;
+    cd->discard_ilseq = flags & REICONV_DISCARD_ILSEQ;
 
     return cd;
 }
 
-_CPPP_API reiconv_t reiconv_open_from_codepage(int fromcode, int tocode, bool discard_ilseq)
+_CPPP_API reiconv_t reiconv_open_from_codepage(int fromcode, int tocode, enum ConvertFlag flags)
 {
     int from_index = reiconv_lookup_from_codepage(fromcode);
     int to_index = reiconv_lookup_from_codepage(tocode);
@@ -126,10 +126,10 @@ _CPPP_API reiconv_t reiconv_open_from_codepage(int fromcode, int tocode, bool di
         errno = EINVAL;
         return (reiconv_t)(-1);
     }
-    return reiconv_open_from_index(from_index, to_index, discard_ilseq);
+    return reiconv_open_from_index(from_index, to_index, flags);
 }
 
-_CPPP_API reiconv_t reiconv_open_from_name(const char *fromcode, const char *tocode, bool discard_ilseq)
+_CPPP_API reiconv_t reiconv_open_from_name(const char *fromcode, const char *tocode, enum ConvertFlag flags)
 {
     int from_index = reiconv_lookup_from_name(fromcode);
     int to_index = reiconv_lookup_from_name(tocode);
@@ -139,7 +139,7 @@ _CPPP_API reiconv_t reiconv_open_from_name(const char *fromcode, const char *toc
         errno = EINVAL;
         return (reiconv_t)(-1);
     }
-    return reiconv_open_from_index(from_index, to_index, discard_ilseq);
+    return reiconv_open_from_index(from_index, to_index, flags);
 }
 
 _CPPP_API reiconv_t reiconv_open(const char *tocode, const char *fromcode)
@@ -150,7 +150,7 @@ _CPPP_API reiconv_t reiconv_open(const char *tocode, const char *fromcode)
     size_t fromcode_len = reiconv_name_canonicalize(fromcode, fromcode_buf);
     size_t tocode_len = reiconv_name_canonicalize(tocode, tocode_buf);
 
-    bool discard_ilseq = false;
+    enum ConvertFlag flag = REICONV_NO_FLAGS;
 
     for (size_t i = 0; i < fromcode_len; i++)
     {
@@ -159,7 +159,7 @@ _CPPP_API reiconv_t reiconv_open(const char *tocode, const char *fromcode)
             fromcode_buf[i] = '\0';
             if (i + 7 < fromcode_len && memcmp(fromcode_buf + i + 1, "/IGNORE", 8) == 0)
             {
-                discard_ilseq = true;
+                flag |= REICONV_DISCARD_ILSEQ;
             }
         }
     }
@@ -171,7 +171,7 @@ _CPPP_API reiconv_t reiconv_open(const char *tocode, const char *fromcode)
             tocode_buf[i] = '\0';
             if (i + 7 < tocode_len && memcmp(tocode_buf + i + 1, "/IGNORE", 7) == 0)
             {
-                discard_ilseq = true;
+                flag |= REICONV_DISCARD_ILSEQ;
             }
         }
     }
@@ -184,7 +184,7 @@ _CPPP_API reiconv_t reiconv_open(const char *tocode, const char *fromcode)
         return (reiconv_t)(-1);
     }
 
-    return reiconv_open_from_index(from_index, to_index, discard_ilseq);
+    return reiconv_open_from_index(from_index, to_index, flag);
 }
 
 _CPPP_API size_t reiconv_iconv(reiconv_t cd, char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft)

lib/reiconv.cpp

@@ -52,9 +52,9 @@ _CPPP_API reiconv::Encoding::Encoding(const int codepage)
 _CPPP_API reiconv::VersionInfo reiconv::version{VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH};
 
 _CPPP_API std::string reiconv::convert(reiconv::Encoding from, reiconv::Encoding to, const std::string_view input,
-                                       bool strict)
+                                       enum ConvertFlag flag)
 {
-    ::reiconv_t cd = ::reiconv_open_from_index(from, to, !strict);
+    ::reiconv_t cd = ::reiconv_open_from_index(from, to, (enum ::ConvertFlag)flag);
     if (cd == (::reiconv_t)(-1))
     {
         throw std::system_error(errno, std::system_category(), "reiconv_open_from_index");

tests/reiconv-test.hpp

@@ -34,6 +34,6 @@ inline Buffer reiconv_test(reiconv::Encoding from, reiconv::Encoding to, const s
 {
     using namespace reiconv;
     Buffer input = Buffer::read_from_file(input_file_path);
-    std::string res = convert(from, to, {input.data(), input.size}, true);
+    std::string res = convert(from, to, {input.data(), input.size}, ConvertFlag::DISCARD_ILSEQ);
     return Buffer(res, "converted");
 }