str.h File Reference

String manipulation helper functions. More...

#include "os_port.h"
#include "error.h"

Go to the source code of this file.

Functions
char_t *	strDuplicate (const char_t *s)
	Duplicate a string. More...
char_t *	strTrimWhitespace (char_t *s)
	Removes all leading and trailing whitespace from a string. More...
void	strRemoveTrailingSpace (char_t *s)
	Removes all trailing whitespace from a string. More...
void	strReplaceChar (char_t *s, char_t oldChar, char_t newChar)
	Replace all occurrences of the specified character. More...
error_t	strSafeCopy (char_t *dest, const char_t *src, size_t destSize)
	Copy string. More...

Detailed Description

String manipulation helper functions.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.0

Definition in file str.h.

Function Documentation

strDuplicate()

char_t* strDuplicate

(

const char_t *

s

)

Duplicate a string.

Parameters

[in]

s

Pointer to a constant NULL-terminated character string

Returns

Address of the string that was copied, or NULL if the string cannot be copied

Definition at line 42 of file str.c.

strRemoveTrailingSpace()

void strRemoveTrailingSpace

(

char_t *

s

)

Removes all trailing whitespace from a string.

Parameters

[in,out]

s

Pointer to a NULL-terminated character string

Definition at line 115 of file str.c.

strReplaceChar()

void strReplaceChar	(	char_t *	s,
		char_t	oldChar,
		char_t	newChar
	)

Replace all occurrences of the specified character.

Parameters

[in,out]	s	Pointer to a NULL-terminated character string
[in]	oldChar	The character to be replaced
[in]	newChar	The character that will replace all occurrences of oldChar

Definition at line 141 of file str.c.

strSafeCopy()

error_t strSafeCopy	(	char_t *	dest,
		const char_t *	src,
		size_t	destSize
	)

Copy string.

Parameters

[out]	dest	Pointer to the destination string
[in]	src	Pointer to the source string
[in]	destSize	Size of the buffer allocated for the destination string

Returns

Error code

Definition at line 164 of file str.c.

strTrimWhitespace()

char_t* strTrimWhitespace

(

char_t *

s

)

Removes all leading and trailing whitespace from a string.

Parameters

[in]

s

The string that will be trimmed

Returns

String with whitespace stripped from the beginning and end

Definition at line 78 of file str.c.