PipeWire  0.3.66
Utilities

Various utility functions. More...

Macros

#define strndupa(s, n)
 
#define strdupa(s)
 
#define pw_rand32()   ({ uint32_t val; pw_random(&val, sizeof(val)); val; })
 
#define PW_DEPRECATED(v)   ({ __typeof__(v) _v SPA_DEPRECATED = (v); (void)_v; (v); })
 

Typedefs

typedef void(* pw_destroy_t) (void *object)
 a function to destroy an item More...
 

Functions

const char * pw_split_walk (const char *str, const char *delimiter, size_t *len, const char **state)
 Split a string based on delimiters. More...
 
char ** pw_split_strv (const char *str, const char *delimiter, int max_tokens, int *n_tokens)
 Split a string based on delimiters. More...
 
int pw_split_ip (char *str, const char *delimiter, int max_tokens, char *tokens[])
 Split a string in-place based on delimiters. More...
 
void pw_free_strv (char **str)
 Free a NULL terminated array of strings. More...
 
char * pw_strip (char *str, const char *whitespace)
 Strip all whitespace before and after a string. More...
 
SPA_WARN_UNUSED_RESULT ssize_t pw_getrandom (void *buf, size_t buflen, unsigned int flags)
 Fill a buffer with random data. More...
 
void pw_random (void *buf, size_t buflen)
 Fill a buffer with random data. More...
 
void * pw_reallocarray (void *ptr, size_t nmemb, size_t size)
 

Detailed Description

Various utility functions.

Macro Definition Documentation

◆ strndupa

#define strndupa (   s,
 
)

◆ strdupa

#define strdupa (   s)

◆ pw_rand32

#define pw_rand32 ( )    ({ uint32_t val; pw_random(&val, sizeof(val)); val; })

◆ PW_DEPRECATED

#define PW_DEPRECATED (   v)    ({ __typeof__(v) _v SPA_DEPRECATED = (v); (void)_v; (v); })

Typedef Documentation

◆ pw_destroy_t

typedef void(* pw_destroy_t) (void *object)

a function to destroy an item

Function Documentation

◆ pw_split_walk()

const char* pw_split_walk ( const char *  str,
const char *  delimiter,
size_t *  len,
const char **  state 
)

Split a string based on delimiters.

Parameters
stra string to split
delimiterdelimiter characters to split on
[out]lenthe length of the current string
[in,out]statea state variable
Returns
a string or NULL when the end is reached

Repeatedly call this function to split str into all substrings delimited by delimiter. state should be set to NULL on the first invocation and passed to the function until NULL is returned.

◆ pw_split_strv()

char** pw_split_strv ( const char *  str,
const char *  delimiter,
int  max_tokens,
int *  n_tokens 
)

Split a string based on delimiters.

Parameters
stra string to split
delimiterdelimiter characters to split on
max_tokensthe max number of tokens to split
[out]n_tokensthe number of tokens
Returns
a NULL terminated array of strings that should be freed with pw_free_strv.

◆ pw_split_ip()

int pw_split_ip ( char *  str,
const char *  delimiter,
int  max_tokens,
char *  tokens[] 
)

Split a string in-place based on delimiters.

Parameters
stra string to split
delimiterdelimiter characters to split on
max_tokensthe max number of tokens to split
[out]tokensan array to hold up to max_tokens of strings
Returns
the number of tokens in tokens

str will be modified in-place so that tokens will contain zero terminated strings split at delimiter characters.

◆ pw_free_strv()

void pw_free_strv ( char **  str)

Free a NULL terminated array of strings.

Parameters
stra NULL terminated array of string

Free all the strings in the array and the array

◆ pw_strip()

char* pw_strip ( char *  str,
const char *  whitespace 
)

Strip all whitespace before and after a string.

Parameters
stra string to strip
whitespacecharacters to strip
Returns
the stripped part of str

Strip whitespace before and after str. str will be modified.

◆ pw_getrandom()

SPA_WARN_UNUSED_RESULT ssize_t pw_getrandom ( void *  buf,
size_t  buflen,
unsigned int  flags 
)

Fill a buffer with random data.

Parameters
bufa buffer to fill
buflenthe number of bytes to fill
flagsoptional flags
Returns
the number of bytes filled

Fill buf with buflen random bytes.

◆ pw_random()

void pw_random ( void *  buf,
size_t  buflen 
)

Fill a buffer with random data.

Parameters
bufa buffer to fill
buflenthe number of bytes to fill

Fill buf with buflen random bytes. This functions uses pw_getrandom() but falls back to a pseudo random number generator in case of failure.

◆ pw_reallocarray()

void* pw_reallocarray ( void *  ptr,
size_t  nmemb,
size_t  size 
)