File StardewString.h

FileList > engine > include > StardewString.h

#include "DynArray.h"

Public Functions

Type	Name
void	Str_AdvanceToNextToken (char ** pNextToken) advance a char pointer to the null terminator and then past its
int	Str_Tokenize (char * string, char sep) replaces occurences of the char "sep" in the string with null characters and returns the resulting number of strings.

Macros

Type	Name
define	DECLARE_STATIC_STRING_COPY (copyName, copySrc) `/* multi line expression */` Declares and lazily intializes a buffer and copies src string into it, call at start of function passing in an arg so that you can tokenize the string with minimal dynamic memory allocation. uses a vector, but doesn't set the vectors size property, just uses it as a string buffer.

Public Functions Documentation

function Str_AdvanceToNextToken

advance a char pointer to the null terminator and then past its

void Str_AdvanceToNextToken (
    char ** pNextToken
)

Parameters:

pNextToken

function Str_Tokenize

replaces occurences of the char "sep" in the string with null characters and returns the resulting number of strings.

int Str_Tokenize (
    char * string,
    char sep
)

Parameters:

string
sep separator

Returns:

number of tokens

Macro Definition Documentation

define DECLARE_STATIC_STRING_COPY

Declares and lazily intializes a buffer and copies src string into it, call at start of function passing in an arg so that you can tokenize the string with minimal dynamic memory allocation. uses a vector, but doesn't set the vectors size property, just uses it as a string buffer.

#define DECLARE_STATIC_STRING_COPY (
    copyName,
    copySrc
) `/* multi line expression */`

Parameters:

copyName name of string copy variable
copySrc source string

The documentation for this class was generated from the following file /home/runner/work/2DFarmingRPG/2DFarmingRPG/Stardew/engine/include/StardewString.h