Skip to content

Commit 1839e43

Browse files
majenkotechmajenkotech
committed
Initial Import
1 parent a127a6b commit 1839e43

File tree

3 files changed

+267
-2
lines changed

3 files changed

+267
-2
lines changed

‎CLI.cpp

+186
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
Copyright (c) 2013, Majenko Technologies
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without modification,
5+
are permitted provided that the following conditions are met:
6+
7+
* Redistributions of source code must retain the above copyright notice, this
8+
list of conditions and the following disclaimer.
9+
10+
* Redistributions in binary form must reproduce the above copyright notice, this
11+
list of conditions and the following disclaimer in the documentation and/or
12+
other materials provided with the distribution.
13+
14+
* Neither the name of Majenko Technologies nor the names of its
15+
contributors may be used to endorse or promote products derived from
16+
this software without specific prior written permission.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
22+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28+
29+
#include <CLI.h>
30+
31+
CLIServer CLI;
32+
33+
CLIServer::CLIServer() {
34+
clients = NULL;
35+
commands = NULL;
36+
}
37+
38+
void CLIServer::addClient(Stream *dev) {
39+
CLIClient *scan;
40+
CLIClient *newClient;
41+
42+
newClient = (CLIClient *)malloc(sizeof(CLIClient));
43+
newClient->dev = dev;
44+
newClient->pos = 0;
45+
bzero(newClient->input, CLI_BUFFER);
46+
newClient->next = NULL;
47+
if (clients == NULL) {
48+
clients = newClient;
49+
return;
50+
}
51+
for (scan = clients; scan->next; scan = scan->next);
52+
scan->next = newClient;
53+
}
54+
55+
void CLIServer::addCommand(const char *command, int (*function)(Stream *, int, char **)) {
56+
CLICommand *scan;
57+
CLICommand *newCommand;
58+
59+
newCommand = (CLICommand *)malloc(sizeof(CLICommand));
60+
newCommand->command = strdup(command);
61+
newCommand->function = function;
62+
newCommand->next = NULL;
63+
64+
if (commands == NULL) {
65+
commands = newCommand;
66+
return;
67+
}
68+
for (scan = commands; scan->next; scan = scan->next);
69+
scan->next = newCommand;
70+
}
71+
72+
char *CLIServer::getWord(char *buf) {
73+
static char *ptr = NULL;
74+
char *start, *scan;
75+
char term = ' ';
76+
77+
if (buf != NULL) {
78+
ptr = buf;
79+
}
80+
81+
while (*ptr == ' ' || *ptr == '\t' && *ptr != '\0') {
82+
ptr++;
83+
}
84+
if (*ptr == '\0') {
85+
return NULL;
86+
}
87+
88+
if (*ptr == '"' || *ptr == '\'') {
89+
term = *ptr;
90+
ptr++;
91+
}
92+
start = ptr;
93+
94+
while (*ptr != '\0') {
95+
if (*ptr == '\\') {
96+
for (scan = ptr; *scan != '\0'; scan++) {
97+
*scan = *(scan+1);
98+
}
99+
ptr++;
100+
continue;
101+
}
102+
if (*ptr == term || (term == ' ' && *ptr == '\t')) {
103+
*ptr = '\0';
104+
ptr++;
105+
return start;
106+
}
107+
ptr++;
108+
}
109+
if (ptr == start) {
110+
return NULL;
111+
}
112+
return start;
113+
}
114+
115+
int CLIServer::readline(CLIClient *client) {
116+
int rpos;
117+
118+
char readch = client->dev->read();
119+
120+
if (readch > 0) {
121+
switch (readch) {
122+
case '\n': // Ignore new-lines
123+
break;
124+
case '\r': // Return on CR
125+
rpos = client->pos;
126+
client->pos = 0; // Reset position index ready for next time
127+
client->dev->println();
128+
return rpos;
129+
case 8:
130+
case 127:
131+
if (client->pos > 0) {
132+
client->pos--;
133+
client->input[client->pos] = 0;
134+
client->dev->print("\b \b");
135+
}
136+
break;
137+
default:
138+
if (client->pos < CLI_BUFFER-1) {
139+
client->dev->print(readch);
140+
client->input[client->pos++] = readch;
141+
client->input[client->pos] = 0;
142+
}
143+
}
144+
}
145+
// No end of line has been found, so return -1.
146+
return -1;
147+
}
148+
149+
int CLIServer::parseCommand(CLIClient *client) {
150+
CLICommand *scan;
151+
char *argv[20];
152+
int argc;
153+
char *w;
154+
155+
argc = 0;
156+
w = getWord(client->input);
157+
while ((argc < 20) && (w != NULL)) {
158+
argv[argc++] = w;
159+
w = getWord(NULL);
160+
}
161+
for (scan = commands; scan; scan = scan->next) {
162+
if (strcmp(scan->command, argv[0]) == 0) {
163+
return scan->function(client->dev, argc, argv);
164+
}
165+
}
166+
return -1;
167+
}
168+
169+
void CLIServer::process() {
170+
CLIClient *scan;
171+
for (scan = clients; scan; scan = scan->next) {
172+
if (readline(scan) > 0) {
173+
int rv = parseCommand(scan);
174+
if (rv == -1) {
175+
scan->dev->println("Unknown command");
176+
}
177+
}
178+
}
179+
}
180+
181+
void CLIServer::write(uint8_t c) {
182+
CLIClient *scan;
183+
for (scan = clients; scan; scan = scan->next) {
184+
scan->dev->write(c);
185+
}
186+
}

‎CLI.h

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
Copyright (c) 2013, Majenko Technologies
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without modification,
5+
are permitted provided that the following conditions are met:
6+
7+
* Redistributions of source code must retain the above copyright notice, this
8+
list of conditions and the following disclaimer.
9+
10+
* Redistributions in binary form must reproduce the above copyright notice, this
11+
list of conditions and the following disclaimer in the documentation and/or
12+
other materials provided with the distribution.
13+
14+
* Neither the name of Majenko Technologies nor the names of its
15+
contributors may be used to endorse or promote products derived from
16+
this software without specific prior written permission.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
22+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28+
29+
#ifndef _CLI_H
30+
#define _CLI_H
31+
32+
#if ARDUINO >= 100
33+
# include <Arduino.h>
34+
#else
35+
# include <WProgram.h>
36+
#endif
37+
38+
#include <stdlib.h>
39+
40+
#define CLI_BUFFER 1024
41+
42+
#define CLI_COMMAND(X) int X(Stream *dev, int argc, char **argv)
43+
44+
typedef struct _CLIClient{
45+
Stream *dev;
46+
char input[CLI_BUFFER];
47+
int pos;
48+
struct _CLIClient *next;
49+
} CLIClient;
50+
51+
typedef struct _CLICommand {
52+
char *command;
53+
int (*function)(Stream *, int, char **);
54+
struct _CLICommand *next;
55+
} CLICommand;
56+
57+
class CLIServer : public Print {
58+
private:
59+
CLIClient *clients;
60+
CLICommand *commands;
61+
62+
int readline(CLIClient *);
63+
int parseCommand(CLIClient *client);
64+
char *getWord(char *buf);
65+
66+
public:
67+
CLIServer();
68+
void addCommand(const char *command, int (*function)(Stream *, int, char **));
69+
void addClient(Stream *dev);
70+
void process();
71+
void broadcast(char *);
72+
void write(uint8_t);
73+
};
74+
75+
extern CLIServer CLI;
76+
77+
#endif

‎LICENSE

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2013, Matt Jenkins
1+
Copyright (c) 2013, Majenko Technologies
22
All rights reserved.
33

44
Redistribution and use in source and binary forms, with or without modification,
@@ -11,7 +11,7 @@ are permitted provided that the following conditions are met:
1111
list of conditions and the following disclaimer in the documentation and/or
1212
other materials provided with the distribution.
1313

14-
* Neither the name of the {organization} nor the names of its
14+
* Neither the name of Majenko Technologies nor the names of its
1515
contributors may be used to endorse or promote products derived from
1616
this software without specific prior written permission.
1717

@@ -25,3 +25,5 @@ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
2525
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2626
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
2727
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28+
29+

0 commit comments

Comments
 (0)