fnhelper.c File Reference

Helper functions for MUSH functions. More...

#include "config.h"
#include "constants.h"
#include "typedefs.h"
#include "macros.h"
#include "externs.h"
#include "prototypes.h"
#include <stdbool.h>
#include <string.h>

Include dependency graph for fnhelper.c:

Functions
char *	trim_space_sep (char *str, const Delim *sep)
	Trim off leading and trailing spaces if the separator char is a space. More...
char *	next_token (char *str, const Delim *sep)
	Point at start of next token in string. More...
char *	split_token (char **sp, const Delim *sep)
	Get next token from string as null-term string. String is destructively modified. More...
char *	next_token_ansi (char *str, const Delim *sep, int *ansi_state_ptr)
	Point at start of next token, and tell what color it is. More...
int	countwords (char *str, const Delim *sep)
	Count the words in a delimiter-separated list. More...
int	list2arr (char ***arr, int maxtok, char *list, const Delim *sep)
	Convert lists to arrays. More...
void	print_separator (const Delim *sep, char *list, char **bufc)
	Print separator for arr2list. More...
void	arr2list (char **arr, int alen, char *list, char **bufc, const Delim *sep)
	Convert arrays to lists. More...
int	list2ansi (int *arr, int *prior_state, int maxlen, char *list, const Delim *sep)
	Find the ANSI states at the beginning and end of each word of a list. More...
dbref	match_thing (dbref player, char *name)
	Quick-matching for function purposes. More...
bool	fn_range_check (const char *fname, int nfargs, int minargs, int maxargs, char *result, char **bufc)
	Check # of args to a function with an optional argument for validity. More...
int	delim_check (char *buff, char **bufc, dbref player, dbref caller, dbref cause, char *fargs[], int nfargs, char *cargs[], int ncargs, int sep_arg, Delim *sep, int dflags)
	Obtain delimiter. More...
bool	xlate (char *arg)
void	do_reverse (char *from, char *to)
	Used by fun_reverse and fun_revwords to reverse things. More...
uint32_t	random_range (uint32_t low, uint32_t high)
	Generate random number between low and high. More...
void	pcg32_srandom_r (pcg32_random_t *rng, uint64_t initstate, uint64_t initseq)
	Seed the rng. Specified in two parts, state initializer and a sequence selection constant (a.k.a. stream id) More...
uint32_t	pcg32_random_r (pcg32_random_t *rng)
	Generate a uniformly distributed 32-bit random number. More...
uint32_t	pcg32_boundedrand_r (pcg32_random_t *rng, uint32_t bound)
	Generate a uniformly distributed number, r, where 0 <= r < bound. More...

Detailed Description

Helper functions for MUSH functions.

Author

TinyMUSH development team (https://github.com/TinyMUSH)

Version

3.3

Date

2021-01-04

Copyright

Copyright (C) 1989-2021 TinyMUSH development team. You may distribute under the terms the Artistic License, as specified in the COPYING file.

PCG Random Number Generation for C, Copyright 2014 Melissa O'Neill oneil.nosp@m.l@pc.nosp@m.g-ran.nosp@m.dom..nosp@m.org. You may distribute under the terms of the Apache License, Version 2.0 as specified in the COPYING file.

Function Documentation

arr2list()

void arr2list	(	char **	arr,
		int	alen,
		char *	list,
		char **	bufc,
		const Delim *	sep
	)

Convert arrays to lists.

Parameters

arr	Array to convert
alen	Array length
list	List buffer
bufc	Buffer
sep	Separatpr

countwords()

int countwords	(	char *	str,
		const Delim *	sep
	)

Count the words in a delimiter-separated list.

Parameters

str	String to count words
sep	Word separators

Returns

int Number of words

delim_check()

int delim_check	(	char *	buff,
		char **	bufc,
		dbref	player,
		dbref	caller,
		dbref	cause,
		char *	fargs[],
		int	nfargs,
		char *	cargs[],
		int	ncargs,
		int	sep_arg,
		Delim *	sep,
		int	dflags
	)

Obtain delimiter.

Parameters

buff	Buffer
bufc	Buffer tracher
player	DBref of player
caller	DBref of caller
cause	DBref oc cause
fargs	Arguments for functions
nfargs	Number of arguments for functions
cargs	Arguments for commands
ncargs	Number of arguments for commands
sep_arg	Argument Separator
sep	Separator
dflags	Delimiter flags

Returns

int

do_reverse()

void do_reverse	(	char *	from,
		char *	to
	)

Used by fun_reverse and fun_revwords to reverse things.

Parameters

from	Input
to	Output

fn_range_check()

bool fn_range_check	(	const char *	fname,
		int	nfargs,
		int	minargs,
		int	maxargs,
		char *	result,
		char **	bufc
	)

Check # of args to a function with an optional argument for validity.

Parameters

fname	Function name
nfargs	Number of arguments
minargs	Minimum number of arguments
maxargs	Maximum number of arguments
result	Result message if error
bufc	Buffer

Returns

bool

list2ansi()

int list2ansi	(	int *	arr,
		int *	prior_state,
		int	maxlen,
		char *	list,
		const Delim *	sep
	)

Find the ANSI states at the beginning and end of each word of a list.

Note

Needs one more array slot than list2arr (think fenceposts) but still takes the same maxlen and returns the same number of words.

Parameters

arr	Array
prior_state	Ansi State
maxlen	Maximum length of array
list	List to parse
sep	Separator

Returns

int Ansi state

list2arr()

int list2arr	(	char ***	arr,
		int	maxtok,
		char *	list,
		const Delim *	sep
	)

Convert lists to arrays.

Parameters

arr	Pointer to Array
maxtok	Maximum number of token
list	List to convert
sep	List separator

Returns

int Number of token in array.

Mark token starting points in a 1k bitstring, then go back and collect them into an array of just the right number of pointers.

< So we don't try to XMALLOC(0).

Caller must free this array of pointers later. Validity of the pointers is dependent upon the original list string having not been freed yet.

There's at least one token starting in this byte of the bitstring, so we scan the bits.

match_thing()

dbref match_thing	(	dbref	player,
		char *	name
	)

Quick-matching for function purposes.

Parameters

player	DBref of player
name	Name for match

Returns

dbref Match

next_token()

char * next_token	(	char *	str,
		const Delim *	sep
	)

Point at start of next token in string.

Parameters

str	String with tokens
sep	Token separators

Returns

char* Pointer to next token

next_token_ansi()

char * next_token_ansi	(	char *	str,
		const Delim *	sep,
		int *	ansi_state_ptr
	)

Point at start of next token, and tell what color it is.

Parameters

str	String with token
sep	Token separator
ansi_state_ptr	Current ansi state

Returns

char* Token

ansi tracking not supported yet in multichar delims

pcg32_boundedrand_r()

uint32_t pcg32_boundedrand_r	(	pcg32_random_t *	rng,
		uint32_t	bound
	)

Generate a uniformly distributed number, r, where 0 <= r < bound.

Parameters

rng	Address of a pcg32_random_t value previously declared
bound	Upper limit for the generated number

Returns

uint32_t Uniformly distributed 32-bit random number

pcg32_random_r()

uint32_t pcg32_random_r

(

pcg32_random_t *

rng

)

Generate a uniformly distributed 32-bit random number.

Parameters

rng	Address of a pcg32_random_t value previously declared

Returns

uint32_t Uniformly distributed 32-bit random number

pcg32_srandom_r()

void pcg32_srandom_r	(	pcg32_random_t *	rng,
		uint64_t	initstate,
		uint64_t	initseq
	)

Seed the rng. Specified in two parts, state initializer and a sequence selection constant (a.k.a. stream id)

Parameters

rng	Address of a pcg32_random_t value previously declared
initstate	Starting state for the RNG, you can pass any 64-bit value
initseq	Selects the output sequence for the RNG, you can pass any 64-bit value, although only the low 63 bits are significant

print_separator()

void print_separator	(	const Delim *	sep,
		char *	list,
		char **	bufc
	)

Print separator for arr2list.

Parameters

sep	Separator
list	List
bufc	Buffer where to write

random_range()

uint32_t random_range	(	uint32_t	low,
		uint32_t	high
	)

Generate random number between low and high.

Parameters

low	Lowest value of random number
high	Highest value of random number

Returns

uint32_t Random number

split_token()

char * split_token	(	char **	sp,
		const Delim *	sep
	)

Get next token from string as null-term string. String is destructively modified.

Parameters

sp	String with tokens
sep	Token separators

Returns

char* Token

trim_space_sep()

char * trim_space_sep	(	char *	str,
		const Delim *	sep
	)

Trim off leading and trailing spaces if the separator char is a space.

Parameters

str	String to trim
sep	Separator char

Returns

char* Trimmed string

xlate()

bool xlate

(

char *

arg

)

Parameters

arg	Boolean true/false check.

Returns

true

false

Case of '#-1 <string>'