[libsigrok.git] / strutil.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include "sigrok.h"
#include "sigrok-internal.h"

/**
 * 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".
 *
 * @param samplerate The samplerate in Hz.
 *
 * @return A g_try_malloc()ed string representation of the samplerate value,
 *         or NULL upon errors. The caller is responsible to g_free() the
 *         memory.
 */
SR_API char *sr_samplerate_string(uint64_t samplerate)
{
	char *o;
	int r;

	/* Allocate enough for a uint64_t as string + " GHz". */
	if (!(o = g_try_malloc0(30 + 1))) {
		sr_err("strutil: %s: o malloc failed", __func__);
		return NULL;
	}

	if (samplerate >= SR_GHZ(1))
		r = snprintf(o, 30, "%" PRIu64 " GHz", samplerate / 1000000000);
	else if (samplerate >= SR_MHZ(1))
		r = snprintf(o, 30, "%" PRIu64 " MHz", samplerate / 1000000);
	else if (samplerate >= SR_KHZ(1))
		r = snprintf(o, 30, "%" PRIu64 " kHz", samplerate / 1000);
	else
		r = snprintf(o, 30, "%" PRIu64 " Hz", samplerate);

	if (r < 0) {
		/* Something went wrong... */
		g_free(o);
		return NULL;
	}

	return o;
}

/**
 * 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".
 *
 * @param frequency The frequency in Hz.
 *
 * @return A g_try_malloc()ed string representation of the frequency value,
 *         or NULL upon errors. The caller is responsible to g_free() the
 *         memory.
 */
SR_API char *sr_period_string(uint64_t frequency)
{
	char *o;
	int r;

	/* Allocate enough for a uint64_t as string + " ms". */
	if (!(o = g_try_malloc0(30 + 1))) {
		sr_err("strutil: %s: o malloc failed", __func__);
		return NULL;
	}

	if (frequency >= SR_GHZ(1))
		r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
	else if (frequency >= SR_MHZ(1))
		r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
	else if (frequency >= SR_KHZ(1))
		r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
	else
		r = snprintf(o, 30, "%" PRIu64 " s", frequency);

	if (r < 0) {
		/* Something went wrong... */
		g_free(o);
		return NULL;
	}

	return o;
}

/**
 * TODO
 *
 * @param dev TODO
 * @param triggerstring TODO
 *
 * @return TODO
 */
SR_API char **sr_parse_triggerstring(struct sr_dev *dev,
				     const char *triggerstring)
{
	GSList *l;
	struct sr_probe *probe;
	int max_probes, probenum, i;
	char **tokens, **triggerlist, *trigger, *tc, *trigger_types;
	gboolean error;

	max_probes = g_slist_length(dev->probes);
	error = FALSE;

	if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
		sr_err("session file: %s: metafile malloc failed", __func__);
		return NULL;
	}

	tokens = g_strsplit(triggerstring, ",", max_probes);
	trigger_types = dev->plugin->get_dev_info(0, SR_DI_TRIGGER_TYPES);
	if (trigger_types == NULL)
		return NULL;

	for (i = 0; tokens[i]; i++) {
		if (tokens[i][0] < '0' || tokens[i][0] > '9') {
			/* Named probe */
			probenum = 0;
			for (l = dev->probes; l; l = l->next) {
				probe = (struct sr_probe *)l->data;
				if (probe->enabled
				    && !strncmp(probe->name, tokens[i],
						strlen(probe->name))) {
					probenum = probe->index;
					break;
				}
			}
		} else {
			probenum = strtol(tokens[i], NULL, 10);
		}

		if (probenum < 1 || probenum > max_probes) {
			sr_err("Invalid probe.\n");
			error = TRUE;
			break;
		}

		if ((trigger = strchr(tokens[i], '='))) {
			for (tc = ++trigger; *tc; tc++) {
				if (strchr(trigger_types, *tc) == NULL) {
					sr_err("Unsupported trigger type "
					       "'%c'\n", *tc);
					error = TRUE;
					break;
				}
			}
			if (!error)
				triggerlist[probenum - 1] = g_strdup(trigger);
		}
	}
	g_strfreev(tokens);

	if (error) {
		for (i = 0; i < max_probes; i++)
			g_free(triggerlist[i]);
		g_free(triggerlist);
		triggerlist = NULL;
	}

	return triggerlist;
}

/**
 * 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.
 *
 * @param sizestring A string containing a (decimal) size value.
 * @param size Pointer to uint64_t which will contain the string's size value.
 *
 * @return SR_OK upon success, SR_ERR upon errors.
 */
SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
{
	int multiplier, done;
	char *s;

	*size = strtoull(sizestring, &s, 10);
	multiplier = 0;
	done = FALSE;
	while (s && *s && multiplier == 0 && !done) {
		switch (*s) {
		case ' ':
			break;
		case 'k':
		case 'K':
			multiplier = SR_KHZ(1);
			break;
		case 'm':
		case 'M':
			multiplier = SR_MHZ(1);
			break;
		case 'g':
		case 'G':
			multiplier = SR_GHZ(1);
			break;
		default:
			done = TRUE;
			s--;
		}
		s++;
	}
	if (multiplier > 0)
		*size *= multiplier;

	if (*s && strcasecmp(s, "Hz"))
		return SR_ERR;

	return SR_OK;
}

/**
 * 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.
 *
 * @param timestring A string containing a (decimal) time value.
 * @return The string's time value as uint64_t, in milliseconds.
 *
 * TODO: Error handling.
 * TODO: Add support for "m" (minutes) and others.
 * TODO: picoseconds?
 * TODO: Allow both lower-case and upper-case.
 */
SR_API uint64_t sr_parse_timestring(const char *timestring)
{
	uint64_t time_msec;
	char *s;

	time_msec = strtoull(timestring, &s, 10);
	if (time_msec == 0 && s == timestring)
		return 0;

	if (s && *s) {
		while (*s == ' ')
			s++;
		if (!strcmp(s, "s"))
			time_msec *= 1000;
		else if (!strcmp(s, "ms"))
			; /* redundant */
		else
			return 0;
	}

	return time_msec;
}

SR_API gboolean sr_parse_boolstring(const char *boolstr)
{
	if (!boolstr)
		return FALSE;

	if (!g_strcasecmp(boolstr, "true") ||
	    !g_strcasecmp(boolstr, "yes") ||
	    !g_strcasecmp(boolstr, "on") ||
	    !g_strcasecmp(boolstr, "1"))
		return TRUE;

	return FALSE;
}
Commit	Line	Data
	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#include <stdint.h>
	22	#include <stdlib.h>
	23	#include <string.h>
	24	#include "sigrok.h"
	25	#include "sigrok-internal.h"
	26
	27	/**
	28	* Convert a numeric samplerate value to its "natural" string representation.
	29	*
	30	* E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz".
	31	*
	32	* @param samplerate The samplerate in Hz.
	33	*
	34	* @return A g_try_malloc()ed string representation of the samplerate value,
	35	* or NULL upon errors. The caller is responsible to g_free() the
	36	* memory.
	37	*/
	38	SR_API char *sr_samplerate_string(uint64_t samplerate)
	39	{
	40	char *o;
	41	int r;
	42
	43	/* Allocate enough for a uint64_t as string + " GHz". */
	44	if (!(o = g_try_malloc0(30 + 1))) {
	45	sr_err("strutil: %s: o malloc failed", __func__);
	46	return NULL;
	47	}
	48
	49	if (samplerate >= SR_GHZ(1))
	50	r = snprintf(o, 30, "%" PRIu64 " GHz", samplerate / 1000000000);
	51	else if (samplerate >= SR_MHZ(1))
	52	r = snprintf(o, 30, "%" PRIu64 " MHz", samplerate / 1000000);
	53	else if (samplerate >= SR_KHZ(1))
	54	r = snprintf(o, 30, "%" PRIu64 " kHz", samplerate / 1000);
	55	else
	56	r = snprintf(o, 30, "%" PRIu64 " Hz", samplerate);
	57
	58	if (r < 0) {
	59	/* Something went wrong... */
	60	g_free(o);
	61	return NULL;
	62	}
	63
	64	return o;
	65	}
	66
	67	/**
	68	* Convert a numeric frequency value to the "natural" string representation
	69	* of its period.
	70	*
	71	* E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
	72	*
	73	* @param frequency The frequency in Hz.
	74	*
	75	* @return A g_try_malloc()ed string representation of the frequency value,
	76	* or NULL upon errors. The caller is responsible to g_free() the
	77	* memory.
	78	*/
	79	SR_API char *sr_period_string(uint64_t frequency)
	80	{
	81	char *o;
	82	int r;
	83
	84	/* Allocate enough for a uint64_t as string + " ms". */
	85	if (!(o = g_try_malloc0(30 + 1))) {
	86	sr_err("strutil: %s: o malloc failed", __func__);
	87	return NULL;
	88	}
	89
	90	if (frequency >= SR_GHZ(1))
	91	r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
	92	else if (frequency >= SR_MHZ(1))
	93	r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
	94	else if (frequency >= SR_KHZ(1))
	95	r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
	96	else
	97	r = snprintf(o, 30, "%" PRIu64 " s", frequency);
	98
	99	if (r < 0) {
	100	/* Something went wrong... */
	101	g_free(o);
	102	return NULL;
	103	}
	104
	105	return o;
	106	}
	107
	108	/**
	109	* TODO
	110	*
	111	* @param dev TODO
	112	* @param triggerstring TODO
	113	*
	114	* @return TODO
	115	*/
	116	SR_API char *sr_parse_triggerstring(struct sr_dev dev,
	117	const char *triggerstring)
	118	{
	119	GSList *l;
	120	struct sr_probe *probe;
	121	int max_probes, probenum, i;
	122	char tokens, triggerlist, trigger, tc, *trigger_types;
	123	gboolean error;
	124
	125	max_probes = g_slist_length(dev->probes);
	126	error = FALSE;
	127
	128	if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
	129	sr_err("session file: %s: metafile malloc failed", __func__);
	130	return NULL;
	131	}
	132
	133	tokens = g_strsplit(triggerstring, ",", max_probes);
	134	trigger_types = dev->plugin->get_dev_info(0, SR_DI_TRIGGER_TYPES);
	135	if (trigger_types == NULL)
	136	return NULL;
	137
	138	for (i = 0; tokens[i]; i++) {
	139	if (tokens[i][0] < '0' \|\| tokens[i][0] > '9') {
	140	/* Named probe */
	141	probenum = 0;
	142	for (l = dev->probes; l; l = l->next) {
	143	probe = (struct sr_probe *)l->data;
	144	if (probe->enabled
	145	&& !strncmp(probe->name, tokens[i],
	146	strlen(probe->name))) {
	147	probenum = probe->index;
	148	break;
	149	}
	150	}
	151	} else {
	152	probenum = strtol(tokens[i], NULL, 10);
	153	}
	154
	155	if (probenum < 1 \|\| probenum > max_probes) {
	156	sr_err("Invalid probe.\n");
	157	error = TRUE;
	158	break;
	159	}
	160
	161	if ((trigger = strchr(tokens[i], '='))) {
	162	for (tc = ++trigger; *tc; tc++) {
	163	if (strchr(trigger_types, *tc) == NULL) {
	164	sr_err("Unsupported trigger type "
	165	"'%c'\n", *tc);
	166	error = TRUE;
	167	break;
	168	}
	169	}
	170	if (!error)
	171	triggerlist[probenum - 1] = g_strdup(trigger);
	172	}
	173	}
	174	g_strfreev(tokens);
	175
	176	if (error) {
	177	for (i = 0; i < max_probes; i++)
	178	g_free(triggerlist[i]);
	179	g_free(triggerlist);
	180	triggerlist = NULL;
	181	}
	182
	183	return triggerlist;
	184	}
	185
	186	/**
	187	* Convert a "natural" string representation of a size value to uint64_t.
	188	*
	189	* E.g. a value of "3k" or "3 K" would be converted to 3000, a value
	190	* of "15M" would be converted to 15000000.
	191	*
	192	* Value representations other than decimal (such as hex or octal) are not
	193	* supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
	194	* Spaces (but not other whitespace) between value and suffix are allowed.
	195	*
	196	* @param sizestring A string containing a (decimal) size value.
	197	* @param size Pointer to uint64_t which will contain the string's size value.
	198	*
	199	* @return SR_OK upon success, SR_ERR upon errors.
	200	*/
	201	SR_API int sr_parse_sizestring(const char sizestring, uint64_t size)
	202	{
	203	int multiplier, done;
	204	char *s;
	205
	206	*size = strtoull(sizestring, &s, 10);
	207	multiplier = 0;
	208	done = FALSE;
	209	while (s && *s && multiplier == 0 && !done) {
	210	switch (*s) {
	211	case ' ':
	212	break;
	213	case 'k':
	214	case 'K':
	215	multiplier = SR_KHZ(1);
	216	break;
	217	case 'm':
	218	case 'M':
	219	multiplier = SR_MHZ(1);
	220	break;
	221	case 'g':
	222	case 'G':
	223	multiplier = SR_GHZ(1);
	224	break;
	225	default:
	226	done = TRUE;
	227	s--;
	228	}
	229	s++;
	230	}
	231	if (multiplier > 0)
	232	size = multiplier;
	233
	234	if (*s && strcasecmp(s, "Hz"))
	235	return SR_ERR;
	236
	237	return SR_OK;
	238	}
	239
	240	/**
	241	* Convert a "natural" string representation of a time value to an
	242	* uint64_t value in milliseconds.
	243	*
	244	* E.g. a value of "3s" or "3 s" would be converted to 3000, a value
	245	* of "15ms" would be converted to 15.
	246	*
	247	* Value representations other than decimal (such as hex or octal) are not
	248	* supported. Only lower-case "s" and "ms" time suffixes are supported.
	249	* Spaces (but not other whitespace) between value and suffix are allowed.
	250	*
	251	* @param timestring A string containing a (decimal) time value.
	252	* @return The string's time value as uint64_t, in milliseconds.
	253	*
	254	* TODO: Error handling.
	255	* TODO: Add support for "m" (minutes) and others.
	256	* TODO: picoseconds?
	257	* TODO: Allow both lower-case and upper-case.
	258	*/
	259	SR_API uint64_t sr_parse_timestring(const char *timestring)
	260	{
	261	uint64_t time_msec;
	262	char *s;
	263
	264	time_msec = strtoull(timestring, &s, 10);
	265	if (time_msec == 0 && s == timestring)
	266	return 0;
	267
	268	if (s && *s) {
	269	while (*s == ' ')
	270	s++;
	271	if (!strcmp(s, "s"))
	272	time_msec *= 1000;
	273	else if (!strcmp(s, "ms"))
	274	; /* redundant */
	275	else
	276	return 0;
	277	}
	278
	279	return time_msec;
	280	}
	281
	282	SR_API gboolean sr_parse_boolstring(const char *boolstr)
	283	{
	284	if (!boolstr)
	285	return FALSE;
	286
	287	if (!g_strcasecmp(boolstr, "true") \|\|
	288	!g_strcasecmp(boolstr, "yes") \|\|
	289	!g_strcasecmp(boolstr, "on") \|\|
	290	!g_strcasecmp(boolstr, "1"))
	291	return TRUE;
	292
	293	return FALSE;
	294	}