Add invitation char to config (closes #28)

Author: ldmi3i

lib/CMakeLists.txt

@@ -41,6 +41,7 @@ else ()
             -Wlogical-op
             -Wredundant-decls
             -Wsign-conversion
+            -Wwrite-strings
             -pedantic-errors)
 endif ()
 

lib/include/embedded_cli.h

@@ -121,6 +121,12 @@ struct EmbeddedCli {
  * Configuration to create CLI
  */
 struct EmbeddedCliConfig {
+    /**
+     * Invitation string. Is printed at the beginning of each line with user
+     * input
+     */
+    const char *invitation;
+    
     /**
      * Size of buffer that is used to store characters until they're processed
      */

lib/src/embedded_cli.c

@@ -379,6 +379,7 @@ EmbeddedCliConfig *embeddedCliDefaultConfig(void) {
     defaultConfig.cliBufferSize = 0;
     defaultConfig.maxBindingCount = 8;
     defaultConfig.enableAutoComplete = true;
+    defaultConfig.invitation = "> ";
     return &defaultConfig;
 }
 
@@ -450,7 +451,7 @@ EmbeddedCli *embeddedCliNew(EmbeddedCliConfig *config) {
     impl->bindingsCount = 0;
     impl->maxBindingsCount = (uint16_t) (config->maxBindingCount + cliInternalBindingCount);
     impl->lastChar = '\0';
-    impl->invitation = "> ";
+    impl->invitation = config->invitation;
 
     initInternalBindings(cli);
 

tests/CliTestRunner.cpp

@@ -650,3 +650,28 @@ void CliTestRunner::testHelp() {
         REQUIRE(lines[2] == "> ");
     }
 }
+
+void CliTestRunner::testInvitationChanged(const std::string &invitation) {
+    embeddedCliProcess(cli);
+
+    SECTION("Invitation is applied to cli") {
+        size_t cursor = 0;
+        auto lines = mock.getLines(false, &cursor);
+
+        REQUIRE(lines.size() == 1);
+        REQUIRE(lines[0] == invitation);
+        REQUIRE(cursor == 4);
+
+        std::string input = "str";
+
+        mock.sendStr(input);
+
+        embeddedCliProcess(cli);
+
+        lines = mock.getLines(true, &cursor);
+
+        REQUIRE(lines.size() == 1);
+        REQUIRE(lines[0] == invitation + input);
+        REQUIRE(cursor == 7);
+    }
+}

tests/CliTestRunner.h

@@ -13,6 +13,8 @@ class CliTestRunner {
 
     void testAutocompleteDisabled();
 
+    void testInvitationChanged(const std::string &invitation);
+
 private:
     EmbeddedCli *cli;
     CliMock mock;

tests/EmbeddedCliTest.cpp

@@ -64,5 +64,20 @@ TEST_CASE("EmbeddedCli. Disabled autocomplete", "[cli]") {
 
     runner.testAutocompleteDisabled();
 
+    embeddedCliFree(cli);
+}
+
+TEST_CASE("EmbeddedCli. Invitation is changed", "[cli]") {
+    EmbeddedCliConfig *config = embeddedCliDefaultConfig();
+    const std::string invitation = "test";
+    config->invitation = invitation.c_str();
+    EmbeddedCli *cli = embeddedCliNew(config);
+
+    REQUIRE(cli != nullptr);
+
+    CliTestRunner runner(cli);
+
+    runner.testInvitationChanged(invitation);
+
     embeddedCliFree(cli);
 }