Skip to content

Commit

Permalink
buffer: add documentation for string_mod and extend related UT
Browse files Browse the repository at this point in the history 
Since I was confused what exactly string_mod does, I
added documentation and additional UTs to make it
clearer.

Change-Id: I911fb5c5fa4b41f1fc1a30c6bf8b314245f64a6e
Signed-off-by: Frank Lichtenheld <[email protected]>
Acked-by: Arne Schwabe <[email protected]>
Message-Id: <[email protected]>
URL: https://www.mail-archive.com/[email protected]/msg27761.html
Signed-off-by: Gert Doering <[email protected]>
  • Loading branch information
@flichtenheld @cron2
flichtenheld authored and cron2 committed Dec 12, 2023
1 parent 3094d8f commit 975ef50
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 41 deletions.
99 changes: 63 additions & 36 deletions src/openvpn/buffer.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -898,51 +898,78 @@ const char *np(const char *str);

/* character classes */

#define CC_ANY (1<<0)
#define CC_NULL (1<<1)

#define CC_ALNUM (1<<2)
#define CC_ALPHA (1<<3)
#define CC_ASCII (1<<4)
#define CC_CNTRL (1<<5)
#define CC_DIGIT (1<<6)
#define CC_PRINT (1<<7)
#define CC_PUNCT (1<<8)
#define CC_SPACE (1<<9)
#define CC_XDIGIT (1<<10)

#define CC_BLANK (1<<11)
#define CC_NEWLINE (1<<12)
#define CC_CR (1<<13)

#define CC_BACKSLASH (1<<14)
#define CC_UNDERBAR (1<<15)
#define CC_DASH (1<<16)
#define CC_DOT (1<<17)
#define CC_COMMA (1<<18)
#define CC_COLON (1<<19)
#define CC_SLASH (1<<20)
#define CC_SINGLE_QUOTE (1<<21)
#define CC_DOUBLE_QUOTE (1<<22)
#define CC_REVERSE_QUOTE (1<<23)
#define CC_AT (1<<24)
#define CC_EQUAL (1<<25)
#define CC_LESS_THAN (1<<26)
#define CC_GREATER_THAN (1<<27)
#define CC_PIPE (1<<28)
#define CC_QUESTION_MARK (1<<29)
#define CC_ASTERISK (1<<30)
#define CC_ANY (1<<0) /**< any character */
#define CC_NULL (1<<1) /**< null character \0 */

#define CC_ALNUM (1<<2) /**< alphanumeric isalnum() */
#define CC_ALPHA (1<<3) /**< alphabetic isalpha() */
#define CC_ASCII (1<<4) /**< ASCII character */
#define CC_CNTRL (1<<5) /**< control character iscntrl() */
#define CC_DIGIT (1<<6) /**< digit isdigit() */
#define CC_PRINT (1<<7) /**< printable (>= 32, != 127) */
#define CC_PUNCT (1<<8) /**< punctuation ispunct() */
#define CC_SPACE (1<<9) /**< whitespace isspace() */
#define CC_XDIGIT (1<<10) /**< hex digit isxdigit() */

#define CC_BLANK (1<<11) /**< space or tab */
#define CC_NEWLINE (1<<12) /**< newline */
#define CC_CR (1<<13) /**< carriage return */

#define CC_BACKSLASH (1<<14) /**< backslash */
#define CC_UNDERBAR (1<<15) /**< underscore */
#define CC_DASH (1<<16) /**< dash */
#define CC_DOT (1<<17) /**< dot */
#define CC_COMMA (1<<18) /**< comma */
#define CC_COLON (1<<19) /**< colon */
#define CC_SLASH (1<<20) /**< slash */
#define CC_SINGLE_QUOTE (1<<21) /**< single quote */
#define CC_DOUBLE_QUOTE (1<<22) /**< double quote */
#define CC_REVERSE_QUOTE (1<<23) /**< reverse quote */
#define CC_AT (1<<24) /**< at sign */
#define CC_EQUAL (1<<25) /**< equal sign */
#define CC_LESS_THAN (1<<26) /**< less than sign */
#define CC_GREATER_THAN (1<<27) /**< greater than sign */
#define CC_PIPE (1<<28) /**< pipe */
#define CC_QUESTION_MARK (1<<29) /**< question mark */
#define CC_ASTERISK (1<<30) /**< asterisk */

/* macro classes */
#define CC_NAME (CC_ALNUM|CC_UNDERBAR)
#define CC_CRLF (CC_CR|CC_NEWLINE)
#define CC_NAME (CC_ALNUM|CC_UNDERBAR) /**< alphanumeric plus underscore */
#define CC_CRLF (CC_CR|CC_NEWLINE) /**< carriage return or newline */

bool char_class(const unsigned char c, const unsigned int flags);

bool string_class(const char *str, const unsigned int inclusive, const unsigned int exclusive);

/**
* Modifies a string in place by replacing certain classes of characters of it with a specified
* character.
*
* Guaranteed to not increase the length of the string.
* If replace is 0, characters are skipped instead of replaced.
*
* @param str The string to be modified.
* @param inclusive The character classes not to be replaced.
* @param exclusive Character classes to be replaced even if they are also in inclusive.
* @param replace The character to replace the specified character classes with.
* @return True if the string was not modified, false otherwise.
*/
bool string_mod(char *str, const unsigned int inclusive, const unsigned int exclusive, const char replace);

/**
* Returns a copy of a string with certain classes of characters of it replaced with a specified
* character.
*
* If replace is 0, characters are skipped instead of replaced.
*
* @param str The input string to be modified.
* @param inclusive Character classes not to be replaced.
* @param exclusive Character classes to be replaced even if they are also in inclusive.
* @param replace The character to replace the specified character classes with.
* @param gc The garbage collector arena to allocate memory from.
*
* @return The modified string with characters replaced within the specified range.
*/
const char *string_mod_const(const char *str,
const unsigned int inclusive,
const unsigned int exclusive,
Expand Down
19 changes: 14 additions & 5 deletions tests/unit_tests/openvpn/test_buffer.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -324,23 +324,32 @@ test_character_class(void **state)
{
char buf[256];
strcpy(buf, "There is \x01 a nice 1234 year old tr\x7f ee!");
string_mod(buf, CC_PRINT, 0, '@');
assert_false(string_mod(buf, CC_PRINT, 0, '@'));
assert_string_equal(buf, "There is @ a nice 1234 year old tr@ ee!");

strcpy(buf, "There is \x01 a nice 1234 year old tr\x7f ee!");
string_mod(buf, CC_PRINT, CC_DIGIT, '@');
assert_true(string_mod(buf, CC_ANY, 0, '@'));
assert_string_equal(buf, "There is \x01 a nice 1234 year old tr\x7f ee!");

/* 0 as replace removes characters */
strcpy(buf, "There is \x01 a nice 1234 year old tr\x7f ee!");
assert_false(string_mod(buf, CC_PRINT, 0, '\0'));
assert_string_equal(buf, "There is a nice 1234 year old tr ee!");

strcpy(buf, "There is \x01 a nice 1234 year old tr\x7f ee!");
assert_false(string_mod(buf, CC_PRINT, CC_DIGIT, '@'));
assert_string_equal(buf, "There is @ a nice @@@@ year old tr@ ee!");

strcpy(buf, "There is \x01 a nice 1234 year old tr\x7f ee!");
string_mod(buf, CC_ALPHA, CC_DIGIT, '.');
assert_false(string_mod(buf, CC_ALPHA, CC_DIGIT, '.'));
assert_string_equal(buf, "There.is...a.nice......year.old.tr..ee.");

strcpy(buf, "There is \x01 a 'nice' \"1234\"\n year old \ntr\x7f ee!");
string_mod(buf, CC_ALPHA|CC_DIGIT|CC_NEWLINE|CC_SINGLE_QUOTE, CC_DOUBLE_QUOTE|CC_BLANK, '.');
assert_false(string_mod(buf, CC_ALPHA|CC_DIGIT|CC_NEWLINE|CC_SINGLE_QUOTE, CC_DOUBLE_QUOTE|CC_BLANK, '.'));
assert_string_equal(buf, "There.is...a.'nice'..1234.\n.year.old.\ntr..ee.");

strcpy(buf, "There is a \\'nice\\' \"1234\" [*] year old \ntree!");
string_mod(buf, CC_PRINT, CC_BACKSLASH|CC_ASTERISK, '.');
assert_false(string_mod(buf, CC_PRINT, CC_BACKSLASH|CC_ASTERISK, '.'));
assert_string_equal(buf, "There is a .'nice.' \"1234\" [.] year old .tree!");
}

Expand Down

0 comments on commit 975ef50

Please sign in to comment.