Completly remodel implementation of TextStream class

Author: nexos-dev

.clang-format

@@ -66,7 +66,7 @@ BreakConstructorInitializersBeforeComma: false
 BreakConstructorInitializers: BeforeColon
 BreakAfterJavaFieldAnnotations: false
 BreakStringLiterals: true
-ColumnLimit:     120
+ColumnLimit:     115
 CommentPragmas:  '^ IWYU pragma:'
 CompactNamespaces: false
 ConstructorInitializerAllOnOneLineOrOnePerLine: false

.gitignore

@@ -1,3 +1,4 @@
 *.testout
 *.code-workspace
 *.mo
+*.po~

CMakeLists.txt

@@ -76,7 +76,7 @@ if(LIBNEX_ENABLE_NLS)
     # Validate locales
     foreach(locale ${LIBNEX_ENABLED_LOCALES})
         # Strip en from list. en_US is the locale that the message IDs are in, meaning that we
-        # don't need a l12n for that
+        # don't need a l10n for that
         if("${locale}" STREQUAL "en")
             list(REMOVE_ITEM LIBNEX_ENABLED_LOCALES "en")
         endif()
@@ -169,7 +169,8 @@ list(APPEND LIBNEX_HEADERS_ALWAYS
      ${CMAKE_SOURCE_DIR}/include/libnex/bits.h
      ${CMAKE_SOURCE_DIR}/include/libnex/object.h
      ${CMAKE_SOURCE_DIR}/include/libnex/lock.h
-     ${CMAKE_SOURCE_DIR}/include/libnex/unicode.h)
+     ${CMAKE_SOURCE_DIR}/include/libnex/unicode.h
+     ${CMAKE_SOURCE_DIR}/include/libnex/char32.h)
 
 # Figure out which libnex.h to use
 if(LIBNEX_BAREMETAL)
@@ -203,6 +204,9 @@ list(APPEND LIBNEX_INCLUDE_DIRS ${CMAKE_SOURCE_DIR}/include ${CMAKE_BINARY_DIR}
                             ${CMAKE_SOURCE_DIR}/src ${Intl_INCLUDE_DIRS}
                             ${NEXNIXSDK_INCLUDE_DIRS})
 
+# Public include directories
+list(APPEND LIBNEX_PUBLIC_INCLUDE_DIRS ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR})
+
 # Setup libraries to link with
 if(Intl_LIB)
     list(APPEND LIBNEX_LIBRARIES ${Intl_LIB})
@@ -225,7 +229,7 @@ add_library(nex ${LIBNEX_SOURCES})
 target_link_libraries(nex PUBLIC ${LIBNEX_LIBRARIES})
 
 # Set SOName
-set_target_properties(nex PROPERTIES VERSION ${PROJECT_VERSION} SOVERSION ${PROJECT_VERSION})
+set_target_properties(nex PROPERTIES VERSION ${PROJECT_VERSION} SOVERSION ${PROJECT_VERSION_MAJOR})
 # Include the directories
 target_include_directories(nex PRIVATE ${LIBNEX_INCLUDE_DIRS})
 
@@ -252,11 +256,14 @@ install(TARGETS nex)
 if(BUILD_SHARED_LIBS)
     set(LIBNEX_LIBTYPE "SHARED")
     set(LIBNEX_LIBRARY_FILE 
-        "${CMAKE_INSTALL_FULL_LIBDIR}/${CMAKE_SHARED_LIBRARY_PREFIX}nex.${CMAKE_SHARED_LIBRARY_SUFFIX}")
+        "${CMAKE_INSTALL_FULL_LIBDIR}/${CMAKE_SHARED_LIBRARY_PREFIX}nex${CMAKE_SHARED_LIBRARY_SUFFIX}")
+    set(LIBNEX_HAVE_SONAME TRUE)
+    set(LIBNEX_SONAME "${CMAKE_SHARED_LIBRARY_PREFIX}nex${CMAKE_SHARED_LIBRARY_SUFFIX}.${PROJECT_VERSION_MAJOR}")
 else()
     set(LIBNEX_LIBTYPE "STATIC")
+    set(LIBNEX_HAVE_SONAME FALSE)
     set(LIBNEX_LIBRARY_FILE 
-        "${CMAKE_INSTALL_FULL_LIBDIR}/${CMAKE_STATIC_LIBRARY_PREFIX}nex.${CMAKE_STATIC_LIBRARY_SUFFIX}")
+        "${CMAKE_INSTALL_FULL_LIBDIR}/${CMAKE_STATIC_LIBRARY_PREFIX}nex${CMAKE_STATIC_LIBRARY_SUFFIX}")
 endif()
 
 # Install header files

data/LibNexConfig.cmake.in

@@ -29,9 +29,15 @@ set(LIBNEX_LIBRARY "@LIBNEX_LIBRARY_FILE@")
 
 # Create the imported target
 add_library(LibNex::nex @LIBNEX_LIBTYPE@ IMPORTED)
-set_target_properties(LibNex::nex PROPERTIES IMPORTED_SONAME "@LIBNEX_LIBRARY@")
+set_target_properties(LibNex::nex PROPERTIES IMPORTED_LOCATION "@LIBNEX_LIBRARY_FILE@")
 if(NOT "@LIBNEX_LIBRARIES@" STREQUAL "")
     target_link_libraries(LibNex::nex INTERFACE "@LIBNEX_LIBRARIES@")
 endif()
+target_include_directories(LibNex::nex INTERFACE "@LIBNEX_PUBLIC_INCLUDE_DIRS@")
+
+# Set SOName
+if(@LIBNEX_HAVE_SONAME@)
+    set_target_properties(LibNex::nex PROPERTIES IMPORTED_SONAME "@LIBNEX_SONAME@")
+endif()
 
 check_required_components(LibNex)

include/libnex/textstream.h

@@ -24,6 +24,7 @@
 #include <libnex/char32.h>
 #include <libnex/decls.h>
 #include <libnex/object.h>
+#include <libnex/unicode.h>
 #include <stdbool.h>
 #include <stddef.h>
 #include <stdint.h>
@@ -66,15 +67,15 @@ __DECL_START
  */
 typedef struct _TextStream
 {
-    Object_t obj;       ///< The object for this stream
-    FILE* file;         ///< Pointer to underlying file object
-    char* fileName;     ///< The original file name
-    uint8_t* buf;       ///< Buffer to use for staging
-    size_t bufSize;     ///< Size of above buffer (defaults to 512 bytes)
-    char encoding;      ///< Underlying encoding of the stream
-    char order;         ///< Order of bytes for multi byte character sets
-    char maxEncSize;    ///< Max size of one char in the encoding
-    char minEncSize;    ///< Minimum size of one char in the encoding
+    Object_t obj;            // The object for this stream
+    FILE* file;              // Pointer to underlying file object
+    const char* fileName;    // The original file name
+    uint8_t* buf;            // Buffer to use for staging
+    size_t bufSize;          // Size of above buffer
+    size_t bufPos;           // Read position within buffer. Used only for reading
+    char encoding;           // Underlying encoding of the stream
+    char order;              // Order of bytes for multi byte character sets
+    char mode;               // Mode used to open text stream
 } TextStream_t;
 
 /**
@@ -91,7 +92,7 @@ typedef struct _TextStream
  * @param[out] stream result variable to put the stream in
  * @return TEXT_SUCCESS, otherwise, an error code
  */
-PUBLIC short TextOpen (char* file, TextStream_t** stream, char mode, char encoding, bool hasBom, char order);
+PUBLIC short TextOpen (const char* file, TextStream_t** stream, char mode, char encoding, bool hasBom, char order);
 
 /**
  * @brief Closes a text stream
@@ -101,7 +102,7 @@ PUBLIC short TextOpen (char* file, TextStream_t** stream, char mode, char encodi
  *
  * @param[in] stream the stream to close
  */
-PUBLIC void TextClose (TextStream_t* stream);
+PUBLIC short TextClose (TextStream_t* stream);
 
 /**
  * @brief Reads data from a text stream
@@ -160,20 +161,6 @@ PUBLIC short TextWrite (TextStream_t* stream, const char32_t* buf, const size_t
  */
 PUBLIC long TextSize (TextStream_t* stream);
 
-/**
- * @brief Sets the size of the staging buffer
- *
- * TextSetBufSz resizes the staging buffer to the size specified by sz
- * This could used to help optimize performance by selecting a large buffer
- * size, or optimizing memory usage by selecting a small buffer size This
- * function has a potential exit point. It may call exit(3) in an error
- * condition
- *
- * @param[in] stream the stream to operate on
- * @param[in] sz the new buffer size
- */
-PUBLIC void TextSetBufSz (TextStream_t* stream, size_t sz);
-
 /**
  * @brief Returns a textual representation of a textstream error code
  * @param code the error code turn into a string
@@ -184,21 +171,26 @@ PUBLIC const char* TextError (int code);
 /**
  * @brief Takes a libchardet charset name, and returns a textsream encoding and byte order
  * @param encName the name of the encoding
- * @param enc the numeric encoding ID to write to
- * @param order the byte order to write to
+ * @param enc the numeric encoding ID pointer to write to
+ * @param order the byte order pointer to write to
  */
 PUBLIC void TextGetEncId (const char* encName, char* enc, char* order);
 
+/**
+ * @brief Flushes the contents of a text stream when the stream in a writing mode
+ * @param stream the stream to flush
+ * @return an error code, or TEXT_SUCCESS
+ */
+PUBLIC short TextFlush (TextStream_t* stream);
+
 __DECL_END
 
 // Helper macros
 #define TextGetEncoding(stream) ((stream)->encoding)    ///< Grabs the character encoding of stream
 #define TextGetOrder(stream)    ((stream)->order)       ///< Grabs the byte order of stream
-#define TextGetBufSz(stream)    ((stream)->bufSize)     ///< Grabs the size of the staging buffer in stream
 #define TextRef(item)           ((TextStream_t*) ObjRef (&(item)->obj))    ///< References the underlying the object
 #define TextLock(item)          (ObjLock (&(item)->obj))                   ///< Locks this stream
 #define TextUnlock(item)        (ObjUnlock (&(item)->obj))                 ///< Unlocks the stream
 #define TextDeRef(item)         (ObjDestroy (&(item)->obj))                ///< Dereferences this stream
-#define TextGetFile(stream)     ((stream)->file)                           ///< Obtains the file handle of this stream
 
 #endif

include/libnex/unicode.h

@@ -48,6 +48,8 @@ typedef struct _utf8state
 
 #define UnicodeIsAccepted(state)  ((state).state == 6)     ///< Checks if state has been accepted
 #define UnicodeIsAcceptedP(state) ((state)->state == 6)    ///< Checks if state has been accepted
+#define UnicodeStateInit(state)   ((state).state = 0)      ///< Initializes state structure
+#define UnicodeStateInitP(state)  ((state)->state = 0)     ///< Initializes state structure
 
 /**
  * @brief Decodes a UTF-16 character to UTF-32
@@ -77,6 +79,7 @@ PUBLIC size_t UnicodeEncode16 (uint16_t* out, char32_t in, char endian);
  * @param out pointer to the resulting codepoint
  * @param in the current byte in the sequence
  * @param state pointer to structure maintaining the parser's state
+ * @return The number of byte decoded from in. 0 on error
  */
 PUBLIC size_t UnicodeDecodePart8 (char32_t* out, uint8_t in, Utf8State_t* state);
 
@@ -85,6 +88,7 @@ PUBLIC size_t UnicodeDecodePart8 (char32_t* out, uint8_t in, Utf8State_t* state)
  * @param out the buffer to write the character out to
  * @param in pointer to buffer containing sequence to convert
  * @param sz size of in
+ * @return the number of bytes decoded from in. 0 on error
  */
 PUBLIC size_t UnicodeDecode8 (char32_t* out, const uint8_t* in, size_t sz);
 
@@ -93,6 +97,7 @@ PUBLIC size_t UnicodeDecode8 (char32_t* out, const uint8_t* in, size_t sz);
  * @param out the buffer to write the encoded UTF-8 out to
  * @param in character to encode
  * @param sz size of out
+ * @return the number of bytes encoded. 0 on error
  */
 PUBLIC size_t UnicodeEncode8 (uint8_t* out, char32_t in, size_t sz);
 

src/error.c

@@ -39,9 +39,9 @@ void error (char* msg, ...)
     va_start (ap, msg);
 
     // Print it out
-    printf ("%s: ", getprogname());
+    fprintf (stderr, "%s: ", getprogname());
     vfprintf (stderr, msg, ap);
-    printf ("\n");
+    fprintf (stderr, "\n");
 
     // Exit
     va_end (ap);

src/po/es/libnex.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-03-08 12:39-0500\n"
+"POT-Creation-Date: 2022-03-12 16:32-0500\n"
 "PO-Revision-Date: 2022-03-07 22:29-0500\n"
 "Last-Translator: nexos <[email protected]>\n"
 "Language-Team: Language  es\n"
@@ -16,26 +16,26 @@ msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: src/textstream.c:677
+#: src/textstream.c:643
 msgid "No error"
-msgstr "No error"
+msgstr "No hay error"
 
-#: src/textstream.c:679
+#: src/textstream.c:645
 msgid "Invalid parameter"
-msgstr "Parametro invalido"
+msgstr "Un parametro es invalido"
 
-#: src/textstream.c:680
+#: src/textstream.c:646
 msgid "Invalid byte order mark"
-msgstr "Marca de orden de bytes no válida"
+msgstr "La marca de orden de bytes no válida"
 
-#: src/textstream.c:681
+#: src/textstream.c:647
 msgid "Character can't be encoded by character set"
 msgstr "El carácter no se puede codificar por el conjunto de caracteres"
 
-#: src/textstream.c:682
+#: src/textstream.c:648
 msgid "Result buffer too small"
 msgstr "El búfer de resultados es demasiado pequeño"
 
-#: src/textstream.c:683
+#: src/textstream.c:649
 msgid "Unsupported character encoding"
-msgstr "Conjunto de caracteres no soportado"
+msgstr "El conjunto de caracteres es no soportado"

src/po/libnex.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-03-08 12:39-0500\n"
+"POT-Creation-Date: 2022-03-12 16:32-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -17,26 +17,26 @@ msgstr ""
 "Content-Type: text/plain; charset=CHARSET\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: src/textstream.c:677
+#: src/textstream.c:643
 msgid "No error"
 msgstr ""
 
-#: src/textstream.c:679
+#: src/textstream.c:645
 msgid "Invalid parameter"
 msgstr ""
 
-#: src/textstream.c:680
+#: src/textstream.c:646
 msgid "Invalid byte order mark"
 msgstr ""
 
-#: src/textstream.c:681
+#: src/textstream.c:647
 msgid "Character can't be encoded by character set"
 msgstr ""
 
-#: src/textstream.c:682
+#: src/textstream.c:648
 msgid "Result buffer too small"
 msgstr ""
 
-#: src/textstream.c:683
+#: src/textstream.c:649
 msgid "Unsupported character encoding"
 msgstr ""