Moving text_reader/text_writer into its own file in support

Author: djowel

lib/CMakeLists.txt

@@ -122,6 +122,7 @@ set(ELEMENTS_HEADERS
    include/elements/support/draw_utils.hpp
    include/elements/support/icon_ids.hpp
    include/elements/support/receiver.hpp
+   include/elements/support/text_reader_writer.hpp
    include/elements/support/text_utils.hpp
    include/elements/support/theme.hpp
    include/elements/view.hpp

lib/include/elements/element/label.hpp

@@ -7,11 +7,11 @@
 #define ELEMENTS_LABELS_APRIL_11_2016
 
 #include <elements/element/element.hpp>
-#include <elements/element/text.hpp>
 #include <elements/element/proxy.hpp>
 #include <elements/element/traversal.hpp>
 #include <elements/support/theme.hpp>
 #include <elements/support/receiver.hpp>
+#include <elements/support/text_reader_writer.hpp>
 #include <artist/font.hpp>
 #include <infra/string_view.hpp>
 #include <string>

lib/include/elements/element/text.hpp

@@ -9,9 +9,9 @@
 #include <elements/element/element.hpp>
 #include <elements/support/theme.hpp>
 #include <elements/support/receiver.hpp>
+#include <elements/support/text_reader_writer.hpp>
 #include <artist/text_layout.hpp>
 
-#include <infra/string_view.hpp>
 #include <string>
 #include <vector>
 #include <set>
@@ -21,41 +21,6 @@ namespace cycfi::elements
    using artist::font_descr;
    using artist::font;
 
-   ////////////////////////////////////////////////////////////////////////////
-   // text_reader and text_writer mixins
-   ////////////////////////////////////////////////////////////////////////////
-   class text_reader_u8
-   {
-   public:
-
-      virtual                       ~text_reader_u8() = default;
-      virtual std::string_view      get_text() const = 0;
-   };
-
-   class text_writer
-   {
-   public:
-
-      virtual                       ~text_writer() = default;
-      virtual void                  set_text(string_view text) = 0;
-   };
-
-   class text_reader_u32
-   {
-   public:
-
-      virtual                       ~text_reader_u32() = default;
-      virtual std::u32string_view   get_text() const = 0;
-   };
-
-   class text_writer_u32
-   {
-   public:
-
-      virtual                       ~text_writer_u32() = default;
-      virtual void                  set_text(std::u32string_view text) = 0;
-   };
-
    ////////////////////////////////////////////////////////////////////////////
    // Static Text Box
    ////////////////////////////////////////////////////////////////////////////

lib/include/elements/support/text_reader_writer.hpp

@@ -0,0 +1,76 @@
+/*=============================================================================
+   Copyright (c) 2016-2023 Joel de Guzman
+
+   Distributed under the MIT License [ https://opensource.org/licenses/MIT ]
+=============================================================================*/
+#if !defined(ELEMENTS_TEXT_READER_WRITER_APRIL_17_2016)
+#define ELEMENTS_TEXT_READER_WRITER_APRIL_17_2016
+
+#include <infra/string_view.hpp>
+
+namespace cycfi::elements
+{
+   /**
+    * @brief
+    *    This class represents a text reader for UTF-8 encoded text.
+    *
+    *    It defines the interface for classes that are capable of reading
+    *    UTF-8 text. Derived classes must implement the `get_text()` function.
+    */
+   class text_reader_u8
+   {
+   public:
+
+      virtual                       ~text_reader_u8() = default;
+      virtual std::string_view      get_text() const = 0;
+   };
+
+   /**
+    * @brief
+    *    This class defines an interface for writing text.
+    *
+    *    It serves as a base class for writing or updating text. Derived
+    *    classes must implement the `set_text(string_view text)` function.
+    */
+   class text_writer
+   {
+   public:
+
+      virtual                       ~text_writer() = default;
+      virtual void                  set_text(string_view text) = 0;
+   };
+
+   /**
+    * @brief
+    *    This class provides an interface for reading UTF-32 encoded text.
+    *
+    *    It serves as a base class for classes that are capable of reading
+    *    text encoded in UTF-32. Derived classes must implement the
+    *    `get_text()` function.
+    */
+   class text_reader_u32
+   {
+   public:
+
+      virtual                       ~text_reader_u32() = default;
+      virtual std::u32string_view   get_text() const = 0;
+   };
+
+   /**
+    * @brief
+    *    This class serves as a base class for writing UTF-32 encoded text.
+    *
+    *    Designed to be used as an interface for classes that need to write
+    *    UTF-32 encoded text. Derived classes must implement the
+    *    `set_text(std::u32string_view text)` function.
+    */
+   class text_writer_u32
+   {
+   public:
+
+      virtual                       ~text_writer_u32() = default;
+      virtual void                  set_text(std::u32string_view text) = 0;
+   };
+}
+
+#endif