AceUtils  0.5.0
Useful Arduino utilties which are too small as separate libraries, but complex enough to be shared among multiple projects, and often have external dependencies to other libraries.
CommandManager.h
1 /*
2 MIT License
3 
4 Copyright (c) 2018 Brian T. Park
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 
25 #ifndef ACE_UTILS_CLI_COMMAND_MANAGER_H
26 #define ACE_UTILS_CLI_COMMAND_MANAGER_H
27 
28 #include <AceRoutine.h> // Coroutine, Channel
29 #include "CommandDispatcher.h"
30 #include "StreamLineReader.h"
31 
32 namespace ace_utils {
33 namespace cli {
34 
81 template<uint8_t BUF_SIZE, uint8_t ARGV_SIZE>
82 class CommandManager: public ace_routine::Coroutine {
83  public:
84 
96  CommandManager(const CommandHandler* const* commands, uint8_t numCommands,
97  Stream& serial, const char* prompt = nullptr):
98  mCommands(commands),
99  mNumCommands(numCommands),
100  mSerial(serial),
101  mPrompt(prompt),
102  mStreamLineReader(mChannel, mSerial, mLineBuffer, BUF_SIZE),
103  mDispatcher(mChannel, mSerial, mCommands, mNumCommands,
104  mArgv, ARGV_SIZE, mPrompt) {}
105 
110  int runCoroutine() override {
111  mStreamLineReader.runCoroutine();
112  mDispatcher.runCoroutine();
113  return 0;
114  }
115 
117  const CommandDispatcher* getDispatcher() const { return &mDispatcher; }
118 
119  private:
120  const CommandHandler* const* const mCommands;
121  uint8_t const mNumCommands;
122  Stream& mSerial;
123  const char* const mPrompt;
124  ace_routine::Channel<InputLine> mChannel;
125  StreamLineReader mStreamLineReader;
126  CommandDispatcher mDispatcher;
127  char mLineBuffer[BUF_SIZE];
128  const char* mArgv[ARGV_SIZE];
129 };
130 
131 } // cli
132 } // ace_utils
133 
134 #endif
ace_utils::cli::CommandHandler
Signature for a command handler.
Definition: CommandHandler.h:38
ace_utils::cli::CommandManager::runCoroutine
int runCoroutine() override
Main body of coroutine, dispatches to the underlying mStreamLineReader and mDispatcher.
Definition: CommandManager.h:110
ace_utils::cli::CommandManager
A convenience wrapper around a CommandDispatcher that hides complexity of creating,...
Definition: CommandManager.h:82
ace_utils::cli::StreamLineReader
An AceRoutine coroutine that reads lines (terminated by '\n' or '\r' from the Stream device,...
Definition: StreamLineReader.h:40
ace_utils::cli::StreamLineReader::runCoroutine
int runCoroutine() override
Main body of the coroutine that reads a character from the input stream and writes it into the output...
Definition: StreamLineReader.h:64
ace_utils::cli::CommandDispatcher
A coroutine that reads lines from the Serial port, tokenizes the line on whitespace boundaries,...
Definition: CommandDispatcher.h:52
ace_utils::cli::CommandManager::CommandManager
CommandManager(const CommandHandler *const *commands, uint8_t numCommands, Stream &serial, const char *prompt=nullptr)
Constructor.
Definition: CommandManager.h:96
ace_utils::cli::CommandManager::getDispatcher
const CommandDispatcher * getDispatcher() const
Return the CommandDispatcher.
Definition: CommandManager.h:117