AceRoutine  1.0
A low-memory, fast-switching, cooperative multitasking library using stackless coroutines on Arduino platforms.
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_ROUTINE_COMMAND_MANAGER_H
26 #define ACE_ROUTINE_COMMAND_MANAGER_H
27 
28 #include <AceRoutine.h>
29 #include "CommandDispatcher.h"
30 #include "StreamLineReader.h"
31 
32 namespace ace_routine {
33 namespace cli {
34 
81 template<uint8_t BUF_SIZE, uint8_t ARGV_SIZE>
82 class CommandManager: public 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 
106  int runCoroutine() override {
107  mStreamLineReader.runCoroutine();
108  mDispatcher.runCoroutine();
109  return 0;
110  }
111 
113  const CommandDispatcher* getDispatcher() const { return &mDispatcher; }
114 
115  private:
116  const CommandHandler* const* const mCommands;
117  uint8_t const mNumCommands;
118  Stream& mSerial;
119  const char* const mPrompt;
120  Channel<InputLine> mChannel;
121  StreamLineReader mStreamLineReader;
122  CommandDispatcher mDispatcher;
123  char mLineBuffer[BUF_SIZE];
124  const char* mArgv[ARGV_SIZE];
125 };
126 
127 }
128 }
129 
130 #endif
Signature for a command handler.
int runCoroutine() override
The body of the coroutine.
A convenience wrapper around a CommandDispatcher that hides complexity of creating, initializing and injecting the resources needed by the CommandDispatcher.
int runCoroutine() override
The body of the coroutine.
const CommandDispatcher * getDispatcher() const
Return the CommandDispatcher.
CommandManager(const CommandHandler *const *commands, uint8_t numCommands, Stream &serial, const char *prompt=nullptr)
Constructor.
An AceRoutine coroutine that reads lines (terminated by &#39;\n&#39; or &#39;\r&#39; from the Stream device...
An unbuffered synchronized channel.
Definition: Channel.h:43
int runCoroutine() override
The body of the coroutine.
A coroutine that reads lines from the Serial port, tokenizes the line on whitespace boundaries...
Base class of all coroutines.
Definition: Coroutine.h:255