From edf4f2883a71e71b5dd27243d1128647e00f40ee Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: ćšć, 19 3æ 2015 03:33:52 +0800
Subject: [PATCH] Update documentation
---
libscpi/src/units.c | 163 +++++++++++++++++++++++++++++------------------------
1 files changed, 89 insertions(+), 74 deletions(-)
diff --git a/libscpi/src/units.c b/libscpi/src/units.c
index e54c46d..d4f3784 100644
--- a/libscpi/src/units.c
+++ b/libscpi/src/units.c
@@ -103,68 +103,18 @@
/*
* Special number values definition
*/
-const scpi_special_number_def_t scpi_special_numbers_def[] = {
+const scpi_choice_def_t scpi_special_numbers_def[] = {
{/* name */ "MINimum", /* type */ SCPI_NUM_MIN},
{/* name */ "MAXimum", /* type */ SCPI_NUM_MAX},
{/* name */ "DEFault", /* type */ SCPI_NUM_DEF},
{/* name */ "UP", /* type */ SCPI_NUM_UP},
{/* name */ "DOWN", /* type */ SCPI_NUM_DOWN},
{/* name */ "NAN", /* type */ SCPI_NUM_NAN},
- {/* name */ "INF", /* type */ SCPI_NUM_INF},
+ {/* name */ "INFinity", /* type */ SCPI_NUM_INF},
{/* name */ "NINF", /* type */ SCPI_NUM_NINF},
- SCPI_SPECIAL_NUMBERS_LIST_END,
+ {/* name */ "AUTO", /* type */ SCPI_NUM_AUTO},
+ SCPI_CHOICE_LIST_END,
};
-
-/**
- * Match string constant to one of special number values
- * @param specs specifications of special numbers (patterns)
- * @param str string to be recognised
- * @param len length of string
- * @param value resultin value
- * @return TRUE if str matches one of specs patterns
- */
-static bool_t translateSpecialNumber(const scpi_special_number_def_t * specs, const char * str, size_t len, scpi_number_parameter_t * value) {
- int i;
-
- value->value = 0.0;
- value->unit = SCPI_UNIT_NONE;
- value->type = SCPI_NUM_NUMBER;
-
- if (specs == NULL) {
- return FALSE;
- }
-
- for (i = 0; specs[i].name != NULL; i++) {
- if (matchPattern(specs[i].name, strlen(specs[i].name), str, len)) {
- value->type = specs[i].type;
- return TRUE;
- }
- }
-
- return FALSE;
-}
-
-/**
- * Convert special number type to its string representation
- * @param specs specifications of special numbers (patterns)
- * @param type type of special number
- * @return String representing special number or NULL
- */
-static const char * translateSpecialNumberInverse(const scpi_special_number_def_t * specs, scpi_special_number_t type) {
- int i;
-
- if (specs == NULL) {
- return NULL;
- }
-
- for (i = 0; specs[i].name != NULL; i++) {
- if (specs[i].type == type) {
- return specs[i].name;
- }
- }
-
- return NULL;
-}
/**
* Convert string describing unit to its representation
@@ -219,7 +169,7 @@
* @param value preparsed numeric value
* @return TRUE if value parameter was converted to base units
*/
-static bool_t transformNumber(scpi_t * context, const char * unit, size_t len, scpi_number_parameter_t * value) {
+static scpi_bool_t transformNumber(scpi_t * context, const char * unit, size_t len, scpi_number_t * value) {
size_t s;
const scpi_unit_def_t * unitDef;
s = skipWhitespace(unit, len);
@@ -249,30 +199,97 @@
* @param mandatory if the parameter is mandatory
* @return
*/
-bool_t SCPI_ParamTranslateNumberVal(scpi_t * context, scpi_parameter_t * parameter) {
- token_t token;
+scpi_bool_t SCPI_ParamNumber(scpi_t * context, const scpi_choice_def_t * special, scpi_number_t * value, scpi_bool_t mandatory)
+{
+ scpi_token_t token;
lex_state_t state;
+ scpi_parameter_t param;
+ scpi_bool_t result;
+ int32_t intval;
- state.buffer = parameter->data.ptr;
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
+
+ if (!result) {
+ return result;
+ }
+
+ state.buffer = param.ptr;
state.pos = state.buffer;
- state.len = parameter->data.len;
+ state.len = param.len;
- switch(parameter->type) {
- case TokDecimalNumericProgramDataWithSuffix:
- lexDecimalNumericProgramData(&state, &token);
- lexWhiteSpace(&state, &token);
- lexSuffixProgramData(&state, &token);
+ switch(param.type) {
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ case SCPI_TOKEN_HEXNUM:
+ case SCPI_TOKEN_OCTNUM:
+ case SCPI_TOKEN_BINNUM:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ case SCPI_TOKEN_PROGRAM_MNEMONIC:
+ value->unit = SCPI_UNIT_NONE;
+ value->type = SCPI_NUM_NUMBER;
+ result = TRUE;
+ break;
+ }
- return transformNumber(context, token.ptr, token.len, ¶meter->number);
- case TokProgramMnemonic:
- lexWhiteSpace(&state, &token);
- lexCharacterProgramData(&state, &token);
+ switch(param.type) {
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ case SCPI_TOKEN_PROGRAM_MNEMONIC:
+ value->base = 10;
+ break;
+ case SCPI_TOKEN_BINNUM:
+ value->base = 2;
+ break;
+ case SCPI_TOKEN_HEXNUM:
+ value->base = 16;
+ break;
+ case SCPI_TOKEN_OCTNUM:
+ value->base = 8;
+ break;
+ }
+
+ switch(param.type) {
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ SCPI_ParamToDouble(context, ¶m, &(value->value));
+ break;
+ case SCPI_TOKEN_HEXNUM:
+ SCPI_ParamToDouble(context, ¶m, &(value->value));
+ break;
+ case SCPI_TOKEN_OCTNUM:
+ SCPI_ParamToDouble(context, ¶m, &(value->value));
+ break;
+ case SCPI_TOKEN_BINNUM:
+ SCPI_ParamToDouble(context, ¶m, &(value->value));
+ break;
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ scpiLex_DecimalNumericProgramData(&state, &token);
+ scpiLex_WhiteSpace(&state, &token);
+ scpiLex_SuffixProgramData(&state, &token);
+
+ SCPI_ParamToDouble(context, ¶m, &(value->value));
+
+ result = transformNumber(context, token.ptr, token.len, value);
+ break;
+ case SCPI_TOKEN_PROGRAM_MNEMONIC:
+ scpiLex_WhiteSpace(&state, &token);
+ scpiLex_CharacterProgramData(&state, &token);
/* convert string to special number type */
- return translateSpecialNumber(context->special_numbers, token.ptr, token.len, ¶meter->number);
+ SCPI_ParamToChoice(context, &token, special, &intval);
+
+ value->type = intval;
+ value->value = 0;
+
+ break;
default:
- return FALSE;
+ result = FALSE;
}
+
+ return result;
}
/**
@@ -283,7 +300,7 @@
* @param len max length of string
* @return number of chars written to string
*/
-size_t SCPI_NumberToStr(scpi_t * context, scpi_number_parameter_t * value, char * str, size_t len) {
+size_t SCPI_NumberToStr(scpi_t * context, const scpi_choice_def_t * special, scpi_number_t * value, char * str, size_t len) {
const char * type;
const char * unit;
size_t result;
@@ -292,9 +309,7 @@
return 0;
}
- type = translateSpecialNumberInverse(context->special_numbers, value->type);
-
- if (type) {
+ if (SCPI_ChoiceToName(special, value->type, &type)) {
strncpy(str, type, len);
return min(strlen(type), len);
}
--
Gitblit v1.9.1