use boost::describe for reflection as well

CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ### Added
 
+- added boost::describe for reflection as well
 - added showing git diff as indicators in stc component
 - added robotidy beautifier, and added config page
 - added LISTBOX item that uses a wxListBox

doc/README.md

@@ -481,6 +481,7 @@ It benefits from the following boost libraries:
 lib  | info
 -----|------
 boost::algorithm | uses find_tail, icontains, iequals, replace_all, to_upper, trim
+boost::describe | to add reflection
 boost::json | to implement wex::config
 boost::log | to implement wex::log
 boost::process | to implement wex::process

include/wex/core/file-status.h

@@ -2,7 +2,7 @@
 // Name:      file-status.h
 // Purpose:   Declaration of wex::file_status class
 // Author:    Anton van Wezenbeek
-// Copyright: (c) 2010-2022 Anton van Wezenbeek
+// Copyright: (c) 2010-2024 Anton van Wezenbeek
 ////////////////////////////////////////////////////////////////////////////////
 
 #pragma once
@@ -23,6 +23,9 @@ class file_status
   /// Default constructor. Calls sync.
   explicit file_status(const std::string& path = std::string()) { sync(path); }
 
+  /// << Operator.
+  friend std::ostream& operator<<(std::ostream& os, const file_status& rhs);
+
   /// Returns access time.
   time_t get_access_time() const;
 

include/wex/core/path.h

@@ -7,14 +7,15 @@
 
 #pragma once
 
-#include <wex/core/file-status.h>
-
 #include <bitset>
 #include <filesystem>
+#include <ostream>
 #include <sstream>
 #include <string>
 #include <vector>
 
+#include <wex/core/file-status.h>
+
 namespace wex
 {
 class file;
@@ -79,6 +80,9 @@ class path
   /// == Operator.
   bool operator==(const path& r) const { return data() == r.data(); }
 
+  /// << Operator.
+  friend std::ostream& operator<<(std::ostream& os, const path& rhs);
+
   /// Appends path.
   path& append(const path& path);
 

include/wex/core/reflection.h

@@ -2,7 +2,7 @@
 // Name:      reflection.h
 // Purpose:   Declaration of wex::reflection class
 // Author:    Anton van Wezenbeek
-// Copyright: (c) 2023 Anton van Wezenbeek
+// Copyright: (c) 2023-2024 Anton van Wezenbeek
 ////////////////////////////////////////////////////////////////////////////////
 
 #pragma once
@@ -12,15 +12,14 @@
 #include <sstream>
 #include <vector>
 
-/// YOu can use this macro to add reflection to your class members,
+/// You can use this macro to add reflection to your class members,
 /// or functions.
-#define REFLECT_ADD(NAME, ITEM) \
-  {                             \
-    NAME, [&]()                 \
-    {                           \
-      return ITEM;              \
-    }                           \
-  }
+#define REFLECT_ADD(NAME, ITEM)                                                \
+  {NAME,                                                                       \
+   [&]()                                                                       \
+   {                                                                           \
+     return ITEM;                                                              \
+   }}
 
 namespace wex
 {

include/wex/ctags/ctags-entry.h

@@ -7,10 +7,9 @@
 
 #pragma once
 
-#include <string>
-
+#include <boost/describe.hpp>
 #include <readtags.h>
-#include <wex/core/reflection.h>
+#include <string>
 
 class wxStyledTextCtrl;
 
@@ -132,7 +131,7 @@ class ctags_entry
   ctags_entry& kind(const std::string& v);
 
   /// Logs info about this entry.
-  const std::stringstream log() const { return m_reflect.log(); }
+  const std::stringstream log() const;
 
   /// Returns signature member.
   const auto& signature() const { return m_signature; }
@@ -149,6 +148,11 @@ class ctags_entry
 
   std::string m_access, m_class, m_kind, m_signature;
 
-  reflection m_reflect;
+  BOOST_DESCRIBE_CLASS(
+    ctags_entry,
+    (),
+    (),
+    (),
+    (m_access, m_class, m_kind, m_signature))
 };
 }; // namespace wex

include/wex/data/substitute.h

@@ -7,6 +7,7 @@
 
 #pragma once
 
+#include <boost/describe.hpp>
 #include <string>
 
 namespace wex::data
@@ -60,5 +61,12 @@ class substitute
   std::string m_commands, m_options, m_pattern, m_replacement;
 
   bool m_clear{false}, m_global_command{false}, m_inverse{false};
+
+  BOOST_DESCRIBE_CLASS(
+    substitute,
+    (),
+    (),
+    (),
+    (m_commands, m_options, m_pattern, m_replacement))
 };
 } // namespace wex::data

include/wex/syntax/lexer.h

@@ -2,12 +2,11 @@
 // Name:      lexer.h
 // Purpose:   Declaration of wex::lexer class
 // Author:    Anton van Wezenbeek
-// Copyright: (c) 2008-2023 Anton van Wezenbeek
+// Copyright: (c) 2008-2024 Anton van Wezenbeek
 ////////////////////////////////////////////////////////////////////////////////
 
 #pragma once
 
-#include <wex/core/reflection.h>
 #include <wex/syntax/property.h>
 #include <wex/syntax/style.h>
 
@@ -133,9 +132,6 @@ class lexer
   /// Returns the line size.
   size_t line_size() const;
 
-  /// Logs info about this class.
-  std::stringstream log() const { return m_reflect.log(); }
-
   /// Returns a lexer comment string with text formatted.
   const std::string make_comment(
     const std::string& text,
@@ -216,7 +212,5 @@ class lexer
   bool m_is_ok{false}, m_previewable{false};
 
   syntax::stc* m_stc{nullptr};
-
-  reflection m_reflect;
 };
 }; // namespace wex

include/wex/ui/listitem.h

@@ -2,13 +2,14 @@
 // Name:      listitem.h
 // Purpose:   Declaration of class wex::listitem
 // Author:    Anton van Wezenbeek
-// Copyright: (c) 2009-2023 Anton van Wezenbeek
+// Copyright: (c) 2009-2024 Anton van Wezenbeek
 ////////////////////////////////////////////////////////////////////////////////
 
 #pragma once
 
+#include <boost/describe.hpp>
+
 #include <wex/core/path.h>
-#include <wex/core/reflection.h>
 #include <wex/ui/listview.h>
 
 namespace wex
@@ -43,7 +44,7 @@ class listitem : public wxListItem
   bool is_readonly() const { return m_is_readonly; }
 
   /// Logs info about this item.
-  std::stringstream log() const { return m_reflect.log(); }
+  std::stringstream log() const;
 
   /// Returns the path.
   const auto& path() const { return m_path; }
@@ -66,6 +67,11 @@ class listitem : public wxListItem
   const std::string m_file_spec;
   bool              m_is_readonly{false};
 
-  reflection m_reflect;
+  BOOST_DESCRIBE_CLASS(
+    listitem,
+    (),
+    (),
+    (),
+    (m_path, m_file_spec, m_is_readonly))
 };
 }; // namespace wex

src/core/file-status.cpp

@@ -16,6 +16,13 @@
 #include <unistd.h>
 #endif
 
+std::ostream& wex::operator<<(std::ostream& os, const wex::file_status& rhs)
+{
+  os << rhs.m_fullpath;
+
+  return os;
+}
+
 const std::string
 wex::file_status::get_creation_time_str(const std::string& format) const
 {

src/core/path.cpp

@@ -57,6 +57,12 @@ wex::path::path(const std::vector<std::string>& v, log_t t)
   }
 }
 
+std::ostream& wex::operator<<(std::ostream& os, const wex::path& p)
+{
+  os << p.m_path;
+  return os;
+}
+
 wex::path::~path()
 {
   if (!m_path_original.empty() && m_path_original != current().data())

src/ex/ex-stream-line.cpp

@@ -48,13 +48,6 @@ wex::ex_stream_line::ex_stream_line(
   , m_end(
       type != ACTION_JOIN ? range.end().get_line() - 1 :
                             range.end().get_line() - 2)
-  , m_reflect(
-      {REFLECT_ADD("actions", m_actions),
-       REFLECT_ADD("from", m_begin),
-       REFLECT_ADD("to", m_end),
-       REFLECT_ADD("pattern", m_data.pattern()),
-       REFLECT_ADD("replacement", m_data.replacement())},
-      reflection::log_t::SKIP_EMPTY)
 {
 }
 
@@ -107,7 +100,10 @@ wex::ex_stream_line::ex_stream_line(
 
 wex::ex_stream_line::~ex_stream_line()
 {
-  log::trace("ex stream " + m_action_names.at(m_action)) << m_reflect.log();
+  std::stringstream ss;
+  using boost::describe::operators::operator<<;
+  ss << *this << m_data;
+  log::trace("ex stream " + m_action_names.at(m_action)) << ss;
 }
 
 wex::ex_stream_line::handle_t

src/ex/ex-stream-line.h

@@ -2,14 +2,13 @@
 // Name:      ex-stream-line.h
 // Purpose:   Declaration of class wex::ex_stream_line
 // Author:    Anton van Wezenbeek
-// Copyright: (c) 2020-2023 Anton van Wezenbeek
+// Copyright: (c) 2020-2024 Anton van Wezenbeek
 ////////////////////////////////////////////////////////////////////////////////
 
 #pragma once
 
 #include <unordered_map>
 #include <wex/core/file.h>
-#include <wex/core/reflection.h>
 #include <wex/data/substitute.h>
 #include <wex/ex/addressrange.h>
 
@@ -109,8 +108,13 @@ class ex_stream_line
 
   std::string m_copy;
 
-  reflection m_reflect;
-
   static const std::unordered_map<action_t, std::string> m_action_names;
+
+  BOOST_DESCRIBE_CLASS(
+    ex_stream_line,
+    (),
+    (),
+    (),
+    (m_action, m_text, m_register, m_begin, m_end, m_dest))
 };
 }; // namespace wex

src/syntax/lexer.cpp

@@ -113,11 +113,6 @@ wex::lexer::lexer(const pugi::xml_node* node)
 wex::lexer::lexer(const pugi::xml_node* node, syntax::stc* s)
   : m_scintilla_lexer(node != nullptr ? node->attribute("name").value() : "")
   , m_stc(s)
-  , m_reflect(
-      {REFLECT_ADD("display", m_display_lexer),
-       REFLECT_ADD("extensions", m_extensions),
-       REFLECT_ADD("language", m_language),
-       REFLECT_ADD("lexer", m_scintilla_lexer)})
 {
 }
 

src/ui/ctags/ctags-entry.cpp

@@ -23,15 +23,7 @@ enum class image_access_t
 };
 }
 
-wex::ctags_entry::ctags_entry()
-  : m_reflect(
-      {REFLECT_ADD("access", m_access),
-       REFLECT_ADD("class", m_class),
-       REFLECT_ADD("kind", m_kind),
-       REFLECT_ADD("signature", m_signature)},
-      reflection::log_t::SKIP_EMPTY)
-{
-}
+wex::ctags_entry::ctags_entry() {}
 
 wex::ctags_entry& wex::ctags_entry::access(const std::string& v)
 {
@@ -187,6 +179,14 @@ wex::ctags_entry& wex::ctags_entry::kind(const std::string& v)
   return *this;
 }
 
+const std::stringstream wex::ctags_entry::log() const
+{
+  std::stringstream ss;
+  using boost::describe::operators::operator<<;
+  ss << *this;
+  return ss;
+}
+
 void wex::ctags_entry::register_image(wxStyledTextCtrl* stc)
 {
   stc->RegisterImage(

src/ui/listitem.cpp

@@ -43,8 +43,6 @@ wex::listitem::listitem(
   : m_listview(listview)
   , m_path(filename)
   , m_file_spec(filespec)
-  , m_reflect(
-      {REFLECT_ADD("path", m_path.string()), REFLECT_ADD("id", GetId())})
 {
   SetId(-1);
 }
@@ -83,6 +81,14 @@ void wex::listitem::insert(long index)
   }
 }
 
+std::stringstream wex::listitem::log() const
+{
+  std::stringstream ss;
+  using boost::describe::operators::operator<<;
+  ss << "listitem: " << *this << GetId();
+  return ss;
+}
+
 bool wex::listitem::set_item(
   const std::string& col_name,
   const std::string& text)