javadoc mapping traits

#feat

Author: alandefreitas

include/mrdocs/Metadata/Javadoc.hpp

@@ -32,8 +32,6 @@ contains(Range const& range, El const& el)
         std::ranges::end(range), el) != std::ranges::end(range);
 }
 
-// A second overload where the range is an initializer list
-
 /** Determine if a range contains a specific element.
     @param range The range to search.
     @param el The element to search for.
@@ -49,6 +47,29 @@ contains(std::initializer_list<T> const& range, U const& el)
         std::ranges::end(range), el) != std::ranges::end(range);
 }
 
+/** Determine if an element is equal to any of the elements in the specified range.
+
+    @param el The element to search for.
+    @param range The range to search.
+    @return True if the element is found, false otherwise.
+ */
+template <class El, std::ranges::range Range>
+requires std::equality_comparable_with<std::ranges::range_value_t<Range>, El>
+bool
+is_one_of(El const& el, Range const& range)
+{
+    return contains(range, el);
+}
+
+/// @copydoc is_one_of(El const&, Range const&)
+template <class U, class T>
+requires std::equality_comparable_with<U, T>
+bool
+is_one_of(U const& el, std::initializer_list<T> const& range)
+{
+    return contains(range, el);
+}
+
 /** Determine if a range contains any of the specified elements.
     @param range The range to search.
     @param els The elements to search for.

include/mrdocs/Support/Algorithm.hpp

@@ -38,6 +38,15 @@ concept polymorphic_storage_for = requires(T const& t)
     { t.operator->() } -> std::convertible_to<Base const*>;
 };
 
+/** Determine if a type is dereferenceable
+
+    This concept checks if a type can be dereferenced
+    to a value it represents and converted to a boolean
+    value that represents if the object is in a valid state.
+
+    Examples of such types are std::optional, std::unique_ptr,
+    std::shared_ptr, Polymorphic, pointers, etc.
+ */
 template <class T>
 concept dereferenceable = requires(T const& t)
 {

include/mrdocs/Support/Concepts.hpp

@@ -17,58 +17,72 @@
 #include <string>
 #include <string_view>
 
-namespace clang {
-namespace mrdocs {
+namespace clang::mrdocs {
+
+/** Return the substring without leading specified characters.
+ */
+constexpr
+std::string_view
+ltrim(
+    std::string_view const s,
+    std::string_view const chars) noexcept
+{
+    return s.substr(std::min(s.find_first_not_of(chars), s.size()));
+}
 
 /** Return the substring without leading horizontal whitespace.
  */
 constexpr
 std::string_view
-ltrim(std::string_view s) noexcept
+ltrim(
+    std::string_view const s) noexcept
 {
-    auto it = s.begin();
-    for (;; ++it)
+    return ltrim(s, " \t\n\v\f\r");
+}
+
+/** Return the substring without trailing specified characters.
+ */
+constexpr
+std::string_view
+rtrim(
+    std::string_view const s,
+    std::string_view const chars) noexcept
+{
+    auto const pos = s.find_last_not_of(chars);
+    if (pos == std::string_view::npos)
     {
-        if (it == s.end())
-            return {};
-        if (! std::isspace(*it))
-            break;
+        return s.substr(0, 0);
     }
-    return s.substr(it - s.begin());
+    return s.substr(0, pos + 1);
 }
 
 /** Return the substring without trailing horizontal whitespace.
  */
 constexpr
 std::string_view
-rtrim(std::string_view s) noexcept
+rtrim(std::string_view const s) noexcept
 {
-    auto it = s.end() - 1;
-    while(it > s.begin() && std::isspace(*it))
-    {
-        --it;
-    }
-    return s.substr(0, it - s.begin() + 1);
+    return rtrim(s, " \t\n\v\f\r");
 }
 
 /** Return the substring without leading and trailing horizontal whitespace.
  */
 constexpr
 std::string_view
-trim(std::string_view s) noexcept
+trim(std::string_view const s) noexcept
 {
-    auto left = s.begin();
-    for (;; ++left)
-    {
-        if (left == s.end())
-            return {};
-        if (!isspace(*left))
-            break;
-    }
-    auto right = s.end() - 1;
-    while(right > left && std::isspace(*right))
-        --right;
-    return std::string_view(&*left, right - left + 1);
+    return rtrim(ltrim(s));
+}
+
+/** Return the substring without leading and trailing specified characters.
+ */
+constexpr
+std::string_view
+trim(
+    std::string_view const s,
+    std::string_view const chars) noexcept
+{
+    return rtrim(ltrim(s, chars), chars);
 }
 
 /** Return the substring without leading and trailing horizontal whitespace.
@@ -86,8 +100,24 @@ isWhitespace(std::string_view s) noexcept
     return s.find_first_not_of(" \t\n\v\f\r") == std::string::npos;
 }
 
+/** Determine if a string starts with one of the specified characters
+ */
+constexpr
+bool
+startsWithOneOf(std::string_view s, std::string_view chars) noexcept
+{
+    return !s.empty() && chars.find(s.front()) != std::string_view::npos;
+}
+
+/** Determine if a string ends with one of the specified characters
+ */
+constexpr
+bool
+endsWithOneOf(std::string_view s, std::string_view chars) noexcept
+{
+    return !s.empty() && chars.find(s.back()) != std::string_view::npos;
+}
 
-} // mrdocs
-} // clang
+} // clang::mrdocs
 
 #endif

include/mrdocs/Support/String.hpp

@@ -0,0 +1,3 @@
+[{{upper admonish}}]
+{{#each children}}{{> javadoc/any-text }}{{/each}}
+

share/mrdocs/addons/generator/adoc/partials/javadoc/admonition.adoc.hbs

@@ -0,0 +1,5 @@
+[,cpp]
+----
+{{#each children}}{{> javadoc/any-text verbatim=true }}
+{{/each}}
+----

share/mrdocs/addons/generator/adoc/partials/javadoc/code.adoc.hbs

@@ -0,0 +1,2 @@
+{{#each .}}{{>javadoc/any-block .}}{{/each}}
+

share/mrdocs/addons/generator/adoc/partials/javadoc/detail-blocks.adoc.hbs

@@ -0,0 +1,3 @@
+
+=== {{string}}
+

share/mrdocs/addons/generator/adoc/partials/javadoc/heading.adoc.hbs

@@ -0,0 +1,2 @@
+{{#each children}}{{> javadoc/any-text }}{{/each}}
+

share/mrdocs/addons/generator/adoc/partials/javadoc/paragraph.adoc.hbs

@@ -0,0 +1,3 @@
+{{#each items}}* {{> javadoc/block }}
+{{/each}}
+