Helper functions to decorate strings with nice-looking quote characters.
More...
#include <csutil/stringquote.h>
List of all members.
Static Public Member Functions |
static void | Double (csStringBase &out, const char *str) |
| Put double quotes (“ , ” ) around a string.
|
static const char * | Double (const char *str) |
| Put double quotes (“ , ” ) around a string.
|
static void | DoubleLeft (csStringBase &out, const char *str="") |
| Put a double left quote (” ) before a string.
|
static const char * | DoubleLeft (const char *str="") |
| Put a double left quote (” ) before a string.
|
static void | DoubleRight (csStringBase &out, const char *str="") |
| Put a double right quote (” ) after a string.
|
static const char * | DoubleRight (const char *str="") |
| Put a double right quote (” ) after a string.
|
static void | Single (csStringBase &out, const char *str) |
| Put single quotes (‘ , ’ ) around a string.
|
static const char * | Single (const char *str) |
| Put single quotes (‘ , ’ ) around a string.
|
static void | SingleLeft (csStringBase &out, const char *str="") |
| Put a single left quote (‘ ) before a string.
|
static const char * | SingleLeft (const char *str="") |
| Put a single left quote (‘ ) before a string.
|
static void | SingleRight (csStringBase &out, const char *str="") |
| Put a single right quote (‘ ) after a string.
|
static const char * | SingleRight (const char *str="") |
| Put a single right quote (‘ ) after a string.
|
Detailed Description
Helper functions to decorate strings with nice-looking quote characters.
Definition at line 36 of file stringquote.h.
Member Function Documentation
Put double quotes (“
, ”
) around a string.
- Parameters:
-
out | String to receive quoted input. |
str | String to quote. |
Put double quotes (“
, ”
) around a string.
- Parameters:
-
- Returns:
- Pointer to quoted input. The returned string will be discarded overwritten after a small, but indeterminate time. It is safe to assume it survives to be used as an argument to a function call, but for anything longer than that the string should be stowed away manually somewhere.
Put a double left quote (”
) before a string.
- Parameters:
-
out | String to receive quoted input. |
str | String to quote. |
Put a double left quote (”
) before a string.
- Parameters:
-
- Returns:
- Pointer to quoted input. The returned string will be discarded overwritten after a small, but indeterminate time. It is safe to assume it survives to be used as an argument to a function call, but for anything longer than that the string should be stowed away manually somewhere.
Put a double right quote (”
) after a string.
- Parameters:
-
out | String to receive quoted input. |
str | String to quote. |
Put a double right quote (”
) after a string.
- Parameters:
-
- Returns:
- Pointer to quoted input. The returned string will be discarded overwritten after a small, but indeterminate time. It is safe to assume it survives to be used as an argument to a function call, but for anything longer than that the string should be stowed away manually somewhere.
Put single quotes (‘
, ’
) around a string.
- Parameters:
-
out | String to receive quoted input. |
str | String to quote. |
Put single quotes (‘
, ’
) around a string.
- Parameters:
-
- Returns:
- Pointer to quoted input. The returned string will be discarded overwritten after a small, but indeterminate time. It is safe to assume it survives to be used as an argument to a function call, but for anything longer than that the string should be stowed away manually somewhere.
Put a single left quote (‘
) before a string.
- Parameters:
-
out | String to receive quoted input. |
str | String to quote. |
Put a single left quote (‘
) before a string.
- Parameters:
-
- Returns:
- Pointer to quoted input. The returned string will be discarded overwritten after a small, but indeterminate time. It is safe to assume it survives to be used as an argument to a function call, but for anything longer than that the string should be stowed away manually somewhere.
Put a single right quote (‘
) after a string.
- Parameters:
-
out | String to receive quoted input. |
str | String to quote. |
Put a single right quote (‘
) after a string.
- Parameters:
-
- Returns:
- Pointer to quoted input. The returned string will be discarded overwritten after a small, but indeterminate time. It is safe to assume it survives to be used as an argument to a function call, but for anything longer than that the string should be stowed away manually somewhere.
The documentation for this struct was generated from the following file: