Add getter for help text

Author: juzzlin

CHANGELOG

@@ -4,6 +4,7 @@ x.y.z
 New features:
 
 * Fix GitHub Issue #2: Configurable value names for help
+* Add getter for help text
 
 Bug fixes:
 

src/argengine.cpp

@@ -79,6 +79,11 @@ class Argengine::Impl
         m_helpText = helpText;
     }
 
+    std::string helpText() const
+    {
+        return m_helpText;
+    }
+
     void setHelpSorting(HelpSorting helpSorting)
     {
         m_helpSorting = helpSorting;
@@ -458,6 +463,11 @@ void Argengine::setHelpText(std::string helpText)
     m_impl->setHelpText(helpText);
 }
 
+std::string Argengine::helpText() const
+{
+    return m_impl->helpText();
+}
+
 void Argengine::setHelpSorting(HelpSorting helpSorting)
 {
     m_impl->setHelpSorting(helpSorting);

src/argengine.hpp

@@ -81,6 +81,9 @@ class Argengine
     //! \param helpText Text shown in help. E.g. "MyApplication v1.0.0, Copyright (c) 2020 Foo Bar".
     void setHelpText(std::string helpText);
 
+    //! \return The current help text.
+    std::string helpText() const;
+
     //! Sorting order of arguments in help.
     enum class HelpSorting
     {

src/tests/help_test/help_test.cpp

@@ -102,6 +102,14 @@ void testDefaultHelp_SingleValueOptionAdded_ShouldSucceed()
     assert(ss.str() == answer);
 }
 
+void testSetGetHelpText_ShouldSucceed()
+{
+    Argengine ae({ "test" });
+    assert(ae.helpText() == "Usage: test [OPTIONS]");
+    ae.setHelpText("Foo");
+    assert(ae.helpText() == "Foo");
+}
+
 int main(int, char **)
 {
     testDefaultHelpOverride_HelpActive_ShouldFail();
@@ -114,5 +122,7 @@ int main(int, char **)
 
     testDefaultHelp_SingleValueOptionAdded_ShouldSucceed();
 
+    testSetGetHelpText_ShouldSucceed();
+
     return EXIT_SUCCESS;
 }