String utilities

Helper functions for handling or converting libsigrok-related strings. More...

Functions
char *	sr_si_string_u64 (uint64_t x, const char *unit)
	Convert a numeric value value to its "natural" string representation in SI units. More...
char *	sr_samplerate_string (uint64_t samplerate)
	Convert a numeric samplerate value to its "natural" string representation. More...
char *	sr_period_string (uint64_t frequency)
	Convert a numeric frequency value to the "natural" string representation of its period. More...
char *	sr_voltage_string (uint64_t v_p, uint64_t v_q)
	Convert a numeric voltage value to the "natural" string representation of its voltage value. More...
int	sr_parse_sizestring (const char *sizestring, uint64_t *size)
	Convert a "natural" string representation of a size value to uint64_t. More...
uint64_t	sr_parse_timestring (const char *timestring)
	Convert a "natural" string representation of a time value to an uint64_t value in milliseconds. More...
gboolean	sr_parse_boolstring (const char *boolstr)
int	sr_parse_period (const char *periodstr, uint64_t *p, uint64_t *q)
int	sr_parse_voltage (const char *voltstr, uint64_t *p, uint64_t *q)

Detailed Description

Helper functions for handling or converting libsigrok-related strings.

Function Documentation

gboolean sr_parse_boolstring

(

const char *

boolstr

)

Since

0.1.0

Definition at line 467 of file strutil.c.

int sr_parse_period	(	const char *	periodstr,
		uint64_t *	p,
		uint64_t *	q
	)

Since

0.2.0

Definition at line 482 of file strutil.c.

References SR_ERR_ARG, and SR_OK.

int sr_parse_sizestring	(	const char *	sizestring,
		uint64_t *	size
	)

Convert a "natural" string representation of a size value to uint64_t.

E.g. a value of "3k" or "3 K" would be converted to 3000, a value of "15M" would be converted to 15000000.

Value representations other than decimal (such as hex or octal) are not supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported. Spaces (but not other whitespace) between value and suffix are allowed.

Parameters

sizestring	A string containing a (decimal) size value.
size	Pointer to uint64_t which will contain the string's size value.

Returns

SR_OK upon success, SR_ERR upon errors.

Since

0.1.0

Definition at line 374 of file strutil.c.

References SR_ERR, SR_GHZ, SR_KHZ, SR_MHZ, and SR_OK.

Referenced by sr_session_load().

Here is the caller graph for this function:

uint64_t sr_parse_timestring

(

const char *

timestring

)

Convert a "natural" string representation of a time value to an uint64_t value in milliseconds.

E.g. a value of "3s" or "3 s" would be converted to 3000, a value of "15ms" would be converted to 15.

Value representations other than decimal (such as hex or octal) are not supported. Only lower-case "s" and "ms" time suffixes are supported. Spaces (but not other whitespace) between value and suffix are allowed.

Parameters

timestring

A string containing a (decimal) time value.

Returns

The string's time value as uint64_t, in milliseconds.

Todo:

Add support for "m" (minutes) and others.

Add support for picoseconds?

Allow both lower-case and upper-case? If no, document it.

Since

0.1.0

Definition at line 441 of file strutil.c.

int sr_parse_voltage	(	const char *	voltstr,
		uint64_t *	p,
		uint64_t *	q
	)

Since

0.2.0

Definition at line 515 of file strutil.c.

References SR_ERR_ARG, and SR_OK.

char* sr_period_string

(

uint64_t

frequency

)

Convert a numeric frequency value to the "natural" string representation of its period.

E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".

Parameters

frequency

The frequency in Hz.

Returns

A newly allocated string representation of the frequency value, or NULL upon errors. The caller is responsible to g_free() the memory.

Since

0.1.0

Definition at line 292 of file strutil.c.

References SR_GHZ, SR_KHZ, and SR_MHZ.

char* sr_samplerate_string

(

uint64_t

samplerate

)

Convert a numeric samplerate value to its "natural" string representation.

E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz", 31500 would become "31.5 kHz".

Parameters

samplerate

The samplerate in Hz.

Returns

A newly allocated string representation of the samplerate value, or NULL upon errors. The caller is responsible to g_free() the memory.

Since

0.1.0

Definition at line 273 of file strutil.c.

References sr_si_string_u64().

Here is the call graph for this function:

char* sr_si_string_u64	(	uint64_t	x,
		const char *	unit
	)

Convert a numeric value value to its "natural" string representation in SI units.

E.g. a value of 3000000, with units set to "W", would be converted to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".

Parameters

x	The value to convert.
unit	The unit to append to the string, or NULL if the string has no units.

Returns

A newly allocated string representation of the samplerate value, or NULL upon errors. The caller is responsible to g_free() the memory.

Since

0.2.0

Definition at line 231 of file strutil.c.

References SR_GHZ, SR_HZ, SR_KHZ, and SR_MHZ.

Referenced by sr_samplerate_string().

Here is the caller graph for this function:

char* sr_voltage_string	(	uint64_t	v_p,
		uint64_t	v_q
	)

Convert a numeric voltage value to the "natural" string representation of its voltage value.

The voltage is specified as a rational number's numerator and denominator.

E.g. a value of 300000 would be converted to "300mV", 2 to "2V".

Parameters

v_p	The voltage numerator.
v_q	The voltage denominator.

Returns

A newly allocated string representation of the voltage value, or NULL upon errors. The caller is responsible to g_free() the memory.

Since

0.2.0

Definition at line 334 of file strutil.c.