forked from RoboCore/String_Functions
-
Notifications
You must be signed in to change notification settings - Fork 0
/
String_Functions.h
171 lines (122 loc) · 6.85 KB
/
String_Functions.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
#ifndef RC_STRING_FUNCTIONS
#define RC_STRING_FUNCTIONS
/*
RoboCore String Functions Library
(v1.5 - 18/09/2014)
Library to manipulate strings
(tested with Arduino 0022 and 1.0.1)
Copyright 2013 RoboCore (François) ( http://www.RoboCore.net )
------------------------------------------------------------------------------
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------------
NOTE: the library uses malloc() to create the strings and
the Pointer List in <Memory.h> is usedby default .
To use regular malloc(), undefine USE_POINTER_LIST
in <Memory.h>
NOTE: more functions (and alternative ones) can be found
in the <string.h> library
NOTE: SoftwareSerial is only available for Arduino 1.0.1+
OBS: char* str1 = "test";
//in .DATA section, DO NOT free (because will
add this address to the free_list)
char* str2 = (char*)malloc(10);
//in the HEAP, so CAN be freed
*/
//#define STRING_FUNCTIONS_SOFTWARE_SERIAL
#if defined(ARDUINO) && (ARDUINO >= 100)
#include <Arduino.h> // for Arduino 1.0 or later
#else
#include <WProgram.h> // for Arduino 0022 and 0023
#undef STRING_FUNCTIONS_SOFTWARE_SERIAL // the SoftwareSerial library is not recommended for versions before 1.0
#endif
#include <Memory.h>
#ifdef STRING_FUNCTIONS_SOFTWARE_SERIAL
#include <SoftwareSerial.h>
#endif
//#define RC_STRING_DEBUG
// bitwise values for StrCompare() and StrFind()
#define CASE_SENSITIVE 0
#define CASE_INSENSITIVE (1 << 0)
//-------------------------------------------------------------------------------------------------
// Convert an integer (long) to a string
// NOTE: it is recommended to create the buffer of at least 6 characters because
// the code adds the NULL termination
// NOTE: the buffer must be at least 2 characters long
void IntToStr(long value, char *buffer, int buffer_size);
//-------------------------------------------------------------------------------------------------
// Read a string from serial until buffer is full, eol is reached (if eol not NULL) or
// no more characters in the serial buffer (if eol is NULL)
// (returns the string length)
// NOTE: it is recommended to create the buffer with 1 additional char because
// the code adds the NULL termination
// (ex: desired size = 30 >> create with 31 and pass this value as parameter)
int ReadFromSerial(HardwareSerial *serial, char *buffer, int buffer_length, char eol = NULL, unsigned long timeout = 0);
#ifdef STRING_FUNCTIONS_SOFTWARE_SERIAL
int ReadFromSerial(SoftwareSerial *serial, char *buffer, int buffer_length, char eol = NULL, unsigned long timeout = 0);
#endif
//-------------------------------------------------------------------------------------------------
//IMPORTANT: DO NOT forget to cast to (byte) when calling overloads with 'option'
// Compares str2 with str1 and with given options, starting from start in str1
// and until length or end of str2 is reached
// NOTE: by default start = 0, length = StrLength(str2) and is CASE_SENSITIVE
// (returns the number of matched characters (0 if none matched) or
// -1 on errror)
// NOTE: if(return == StrLength(str2)), str2 was found in str1. Otherwise
// only part (or nothing) of str2 was found
int StrCompare(char* str1, char* str2);
int StrCompare(char* str1, char* str2, byte options);
int StrCompare(char* str1, char* str2, int start);
int StrCompare(char* str1, char* str2, int start, byte options);
int StrCompare(char* str1, char* str2, int start, int length);
int StrCompare(char* str1, char* str2, int start, int length, byte options);
//-------------------------------------------------------------------------------------------------
// Concatenate two strings
// NOTE: it doesn't change any of the given strings
// (returns NULL on error or if given strings are empty, pointer to one of the strings
// if the other is empty, or the concatenated string)
char* StrConcat(char* str1, char* str2);
//-------------------------------------------------------------------------------------------------
// Finds the position of a character in a string
// NOTE: by default uses CASE_SENSITIVE comparison
// (returns -1 if 'string' is empty, 'c' wasn't found or 'c' is NULL)
int StrFind(char* string, char c);
int StrFind(char* string, char c, byte options);
// Finds the position of str2 in str1
// NOTE: by default uses CASE_SENSITIVE comparison
// (returns -1 if str2 > str1, str2 is empty or coudn't find)
int StrFind(char* str1, char* str2);
int StrFind(char* str1, char* str2, byte options);
//-------------------------------------------------------------------------------------------------
// Get the length of a string
int StrLength(char* string);
//-------------------------------------------------------------------------------------------------
// Parses the string to get the string at the desired index (1 based)
// (returns NULL if the string is empty (length of 0), if NULL delimiter or
// if the index is not valid, or the desired string)
char* StrParser(char* string, char delimiter, int index);
//-------------------------------------------------------------------------------------------------
// Get the length of the string (of given index >> 1 based) in the string to parse
// (returns 0 if empty string, NULL delimiter or invalid index, or the string length)
int StrParserLength(char* string, char delimiter, int index);
//-------------------------------------------------------------------------------------------------
// Return the number of valid strings to parse
// (returns 0 if empty string or NULL delimiter, or the number of strings)
int StrParserQty(char* string, char delimiter);
//-------------------------------------------------------------------------------------------------
// Removes a character from a string
// (returns NULL on error or if 'string' is empty, pointer to 'string' if 'c' is NULL)
char* StrRemove(char* string, char c);
// Removes a series of characters from a string
// (returns NULL on error or if given string is empty, pointer to 'string' if 'characters' is empty)
char* StrRemove(char* string, char* characters);
//-------------------------------------------------------------------------------------------------
#endif