From b7e9d6858699f5ea9a23ecf6587e98e7b0e1bc28 Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: 周三, 14 10月 2015 16:49:41 +0800
Subject: [PATCH] Resolve #58: Illegal parameter value and unit test
---
libscpi/src/parser.c | 1070 +++++++++++++++++++++++++++++++++++++++++++++++------------
1 files changed, 851 insertions(+), 219 deletions(-)
diff --git a/libscpi/src/parser.c b/libscpi/src/parser.c
index f2211c6..acb53a8 100644
--- a/libscpi/src/parser.c
+++ b/libscpi/src/parser.c
@@ -43,6 +43,7 @@
#include "lexer_private.h"
#include "scpi/error.h"
#include "scpi/constants.h"
+#include "scpi/utils.h"
/**
* Write data to SCPI output
@@ -75,7 +76,7 @@
*/
static size_t writeDelimiter(scpi_t * context) {
if (context->output_count > 0) {
- return writeData(context, ",", 2);
+ return writeData(context, ",", 1);
} else {
return 0;
}
@@ -89,9 +90,25 @@
static size_t writeNewLine(scpi_t * context) {
if (context->output_count > 0) {
size_t len;
- len = writeData(context, "\r\n", 2);
+#ifndef SCPI_LINE_ENDING
+#error no termination character defined
+#endif
+ len = writeData(context, SCPI_LINE_ENDING, strlen(SCPI_LINE_ENDING));
flushData(context);
return len;
+ } else {
+ return 0;
+ }
+}
+
+/**
+ * Conditionaly write ";"
+ * @param context
+ * @return number of characters written
+ */
+static size_t writeSemicolon(scpi_t * context) {
+ if (context->output_count > 0) {
+ return writeData(context, ";", 1);
} else {
return 0;
}
@@ -105,20 +122,19 @@
const scpi_command_t * cmd = context->param_list.cmd;
lex_state_t * state = &context->param_list.lex_state;
+ /* conditionaly write ; */
+ writeSemicolon(context);
+
context->cmd_error = FALSE;
context->output_count = 0;
context->input_count = 0;
- SCPI_DEBUG_COMMAND(context);
/* if callback exists - call command callback */
if (cmd->callback != NULL) {
if ((cmd->callback(context) != SCPI_RES_OK) && !context->cmd_error) {
SCPI_ErrorPush(context, SCPI_ERROR_EXECUTION_ERROR);
}
}
-
- /* conditionaly write new line */
- writeNewLine(context);
/* set error if command callback did not read all parameters */
if (state->pos < (state->buffer + state->len) && !context->cmd_error) {
@@ -137,7 +153,7 @@
for (i = 0; context->cmdlist[i].pattern != NULL; i++) {
cmd = &context->cmdlist[i];
- if (matchCommand(cmd->pattern, header, len)) {
+ if (matchCommand(cmd->pattern, header, len, NULL, 0, 0)) {
context->param_list.cmd = cmd;
return TRUE;
}
@@ -152,25 +168,30 @@
* @param len - command line length
* @return 1 if the last evaluated command was found
*/
-int SCPI_Parse(scpi_t * context, const char * data, int len) {
+int SCPI_Parse(scpi_t * context, char * data, int len) {
int result = 0;
scpi_parser_state_t * state;
int r;
+ scpi_token_t cmd_prev = {SCPI_TOKEN_UNKNOWN, NULL, 0};
if (context == NULL) {
return -1;
}
state = &context->parser_state;
+ context->output_count = 0;
while (1) {
result = 0;
- r = detectProgramMessageUnit(state, data, len);
+ r = scpiParser_detectProgramMessageUnit(state, data, len);
- if (state->programHeader.type == TokInvalid) {
+ if (state->programHeader.type == SCPI_TOKEN_INVALID) {
SCPI_ErrorPush(context, SCPI_ERROR_INVALID_CHARACTER);
} else if (state->programHeader.len > 0) {
+
+ composeCompoundCommand(&cmd_prev, &state->programHeader);
+
if (findCommandHeader(context, state->programHeader.ptr, state->programHeader.len)) {
context->param_list.lex_state.buffer = state->programData.ptr;
@@ -183,6 +204,7 @@
processCommand(context);
result = 1;
+ cmd_prev = state->programHeader;
} else {
SCPI_ErrorPush(context, SCPI_ERROR_UNDEFINED_HEADER);
}
@@ -196,6 +218,10 @@
}
}
+
+ /* conditionaly write new line */
+ writeNewLine(context);
+
return result;
}
@@ -256,17 +282,18 @@
while (1) {
- cmdlen = detectProgramMessageUnit(&context->parser_state, context->buffer.data + totcmdlen, context->buffer.position - totcmdlen);
+ cmdlen = scpiParser_detectProgramMessageUnit(&context->parser_state, context->buffer.data + totcmdlen, context->buffer.position - totcmdlen);
totcmdlen += cmdlen;
- if (context->parser_state.termination == PmutNewLine) break;
- if (context->parser_state.programHeader.type == TokUnknown) break;
- if (totcmdlen >= context->buffer.position) break;
- }
- if (context->parser_state.termination == PmutNewLine) {
- result = SCPI_Parse(context, context->buffer.data, totcmdlen);
- memmove(context->buffer.data, context->buffer.data + totcmdlen, context->buffer.position - totcmdlen);
- context->buffer.position -= totcmdlen;
+ if (context->parser_state.termination == SCPI_MESSAGE_TERMINATION_NL) {
+ result = SCPI_Parse(context, context->buffer.data, totcmdlen);
+ memmove(context->buffer.data, context->buffer.data + totcmdlen, context->buffer.position - totcmdlen);
+ context->buffer.position -= totcmdlen;
+ totcmdlen = 0;
+ } else {
+ if (context->parser_state.programHeader.type == SCPI_TOKEN_UNKNOWN) break;
+ if (totcmdlen >= context->buffer.position) break;
+ }
}
}
@@ -290,15 +317,10 @@
}
/**
- * Write integer value to the result
- * @param context
- * @param val
+ * Return prefix of nondecimal base
+ * @param base
* @return
*/
-size_t SCPI_ResultInt(scpi_t * context, int32_t val) {
- return SCPI_ResultIntBase(context, val, 10);
-}
-
static const char * getBasePrefix(int8_t base) {
switch (base) {
case 2: return "#B";
@@ -308,13 +330,21 @@
}
}
-size_t SCPI_ResultIntBase(scpi_t * context, int32_t val, int8_t base) {
- char buffer[33];
+/**
+ * Write signed/unsigned 32 bit integer value in specific base to the result
+ * @param context
+ * @param val
+ * @param base
+ * @param sign
+ * @return
+ */
+static size_t resultUInt32BaseSign(scpi_t * context, uint32_t val, int8_t base, scpi_bool_t sign) {
+ char buffer[32 + 1];
const char * basePrefix;
size_t result = 0;
size_t len;
- len = longToStr(val, buffer, sizeof (buffer), base);
+ len = UInt32ToStrBaseSign(val, buffer, sizeof (buffer), base, sign);
basePrefix = getBasePrefix(base);
result += writeDelimiter(context);
@@ -327,7 +357,90 @@
}
/**
- * Write double walue to the result
+ * Write signed/unsigned 64 bit integer value in specific base to the result
+ * @param context
+ * @param val
+ * @param base
+ * @param sign
+ * @return
+ */
+static size_t resultUInt64BaseSign(scpi_t * context, uint64_t val, int8_t base, scpi_bool_t sign) {
+ char buffer[64 + 1];
+ const char * basePrefix;
+ size_t result = 0;
+ size_t len;
+
+ len = UInt64ToStrBaseSign(val, buffer, sizeof (buffer), base, sign);
+ basePrefix = getBasePrefix(base);
+
+ result += writeDelimiter(context);
+ if (basePrefix != NULL) {
+ result += writeData(context, basePrefix, 2);
+ }
+ result += writeData(context, buffer, len);
+ context->output_count++;
+ return result;
+}
+
+/**
+ * Write signed 32 bit integer value to the result
+ * @param context
+ * @param val
+ * @return
+ */
+size_t SCPI_ResultInt32(scpi_t * context, int32_t val) {
+ return resultUInt32BaseSign(context, val, 10, TRUE);
+}
+
+/**
+ * Write unsigned 32 bit integer value in specific base to the result
+ * Write signed/unsigned 32 bit integer value in specific base to the result
+ * @param context
+ * @param val
+ * @return
+ */
+size_t SCPI_ResultUInt32Base(scpi_t * context, uint32_t val, int8_t base) {
+ return resultUInt32BaseSign(context, val, base, FALSE);
+}
+
+/**
+ * Write signed 64 bit integer value to the result
+ * @param context
+ * @param val
+ * @return
+ */
+size_t SCPI_ResultInt64(scpi_t * context, int64_t val) {
+ return resultUInt64BaseSign(context, val, 10, TRUE);
+}
+
+/**
+ * Write unsigned 64 bit integer value in specific base to the result
+ * @param context
+ * @param val
+ * @return
+ */
+size_t SCPI_ResultUInt64Base(scpi_t * context, uint64_t val, int8_t base) {
+ return resultUInt64BaseSign(context, val, base, FALSE);
+}
+
+/**
+ * Write float (32 bit) value to the result
+ * @param context
+ * @param val
+ * @return
+ */
+size_t SCPI_ResultFloat(scpi_t * context, float val) {
+ char buffer[32];
+ size_t result = 0;
+ size_t len = SCPI_FloatToStr(val, buffer, sizeof (buffer));
+ result += writeDelimiter(context);
+ result += writeData(context, buffer, len);
+ context->output_count++;
+ return result;
+}
+
+/**
+ * Write double (64bit) value to the result
* @param context
* @param val
* @return
@@ -335,12 +448,11 @@
size_t SCPI_ResultDouble(scpi_t * context, double val) {
char buffer[32];
size_t result = 0;
- size_t len = doubleToStr(val, buffer, sizeof (buffer));
+ size_t len = SCPI_DoubleToStr(val, buffer, sizeof (buffer));
result += writeDelimiter(context);
result += writeData(context, buffer, len);
context->output_count++;
return result;
-
}
/**
@@ -353,8 +465,33 @@
size_t result = 0;
result += writeDelimiter(context);
result += writeData(context, "\"", 1);
+ // TODO: convert " to ""
result += writeData(context, data, strlen(data));
result += writeData(context, "\"", 1);
+ context->output_count++;
+ return result;
+}
+
+/**
+ * Write arbitrary block program data to the result
+ * @param context
+ * @param data
+ * @param len
+ * @return
+ */
+size_t SCPI_ResultArbitraryBlock(scpi_t * context, const char * data, size_t len) {
+ size_t result = 0;
+ char block_header[12];
+ size_t header_len;
+ block_header[0] = '#';
+ SCPI_UInt32ToStrBase((uint32_t) len, block_header + 2, 10, 10);
+
+ header_len = strlen(block_header + 2);
+ block_header[1] = (char) (header_len + '0');
+
+ result += writeData(context, block_header, header_len + 2);
+ result += writeData(context, data, len);
+
context->output_count++;
return result;
}
@@ -366,24 +503,38 @@
* @return
*/
size_t SCPI_ResultBool(scpi_t * context, scpi_bool_t val) {
- return SCPI_ResultIntBase(context, val ? 1 : 0, 10);
+ return resultUInt32BaseSign(context, val ? 1 : 0, 10, FALSE);
}
-
/* parsing parameters */
-scpi_bool_t SCPI_Parameter(scpi_t * context, scpi_parameter_t * parameter, scpi_bool_t mandatory) {
- scpi_token_t token;
- lex_state_t * state;
- int32_t value;
+/**
+ * Invalidate token
+ * @param token
+ * @param ptr
+ */
+static void invalidateToken(scpi_token_t * token, char * ptr) {
+ token->len = 0;
+ token->ptr = ptr;
+ token->type = SCPI_TOKEN_UNKNOWN;
+}
- parameter->data.ptr = NULL;
- parameter->data.len = 0;
- parameter->number.value = 0;
- parameter->number.base = 10;
- parameter->number.unit = SCPI_UNIT_NONE;
- parameter->number.type = SCPI_NUM_NUMBER;
- parameter->type = TokUnknown;
+/**
+ * Get one parameter from command line
+ * @param context
+ * @param parameter
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_Parameter(scpi_t * context, scpi_parameter_t * parameter, scpi_bool_t mandatory) {
+ lex_state_t * state;
+
+ if (!parameter) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ invalidateToken(parameter, NULL);
state = &context->param_list.lex_state;
@@ -391,14 +542,14 @@
if (mandatory) {
SCPI_ErrorPush(context, SCPI_ERROR_MISSING_PARAMETER);
} else {
- parameter->number.type = SCPI_NUM_DEF;
- parameter->type = TokProgramMnemonic; // TODO: select something different
+ parameter->type = SCPI_TOKEN_PROGRAM_MNEMONIC; // TODO: select something different
}
return FALSE;
}
if (context->input_count != 0) {
- lexComma(state, &token);
- if (token.type != TokComma) {
+ scpiLex_Comma(state, parameter);
+ if (parameter->type != SCPI_TOKEN_COMMA) {
+ invalidateToken(parameter, NULL);
SCPI_ErrorPush(context, SCPI_ERROR_INVALID_SEPARATOR);
return FALSE;
}
@@ -406,83 +557,245 @@
context->input_count++;
- parseProgramData(&context->param_list.lex_state, &token);
+ scpiParser_parseProgramData(&context->param_list.lex_state, parameter);
- parameter->type = token.type;
- parameter->data.ptr = token.ptr;
- parameter->data.len = token.len;
-
- switch (token.type) {
- case TokHexnum:
- parameter->number.base = 16;
- strToLong(token.ptr, &value, 16);
- parameter->number.value = value;
- return TRUE;
- case TokOctnum:
- parameter->number.base = 8;
- strToLong(token.ptr, &value, 8);
- parameter->number.value = value;
- return TRUE;
- case TokBinnum:
- parameter->number.base = 2;
- strToLong(token.ptr, &value, 2);
- parameter->number.value = value;
- return TRUE;
- case TokProgramMnemonic:
- return TRUE;
- case TokDecimalNumericProgramData:
- strToDouble(token.ptr, ¶meter->number.value);
- return TRUE;
- case TokDecimalNumericProgramDataWithSuffix:
- strToDouble(token.ptr, ¶meter->number.value);
- return TRUE;
- case TokArbitraryBlockProgramData:
- return TRUE;
- case TokSingleQuoteProgramData:
- // TODO: replace double "single qoute"
- return TRUE;
- case TokDoubleQuoteProgramData:
- // TODO: replace double "double qoute"
- return TRUE;
- case TokProgramExpression:
+ switch (parameter->type) {
+ case SCPI_TOKEN_HEXNUM:
+ case SCPI_TOKEN_OCTNUM:
+ case SCPI_TOKEN_BINNUM:
+ case SCPI_TOKEN_PROGRAM_MNEMONIC:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ case SCPI_TOKEN_ARBITRARY_BLOCK_PROGRAM_DATA:
+ case SCPI_TOKEN_SINGLE_QUOTE_PROGRAM_DATA:
+ case SCPI_TOKEN_DOUBLE_QUOTE_PROGRAM_DATA:
+ case SCPI_TOKEN_PROGRAM_EXPRESSION:
return TRUE;
default:
- parameter->type = TokUnknown;
- parameter->data.ptr = NULL;
- parameter->data.len = 0;
+ invalidateToken(parameter, NULL);
SCPI_ErrorPush(context, SCPI_ERROR_INVALID_STRING_DATA);
return FALSE;
}
}
+/**
+ * Detect if parameter is number
+ * @param parameter
+ * @param suffixAllowed
+ * @return
+ */
scpi_bool_t SCPI_ParamIsNumber(scpi_parameter_t * parameter, scpi_bool_t suffixAllowed) {
switch (parameter->type) {
- case TokHexnum:
- case TokOctnum:
- case TokBinnum:
- case TokDecimalNumericProgramData:
+ case SCPI_TOKEN_HEXNUM:
+ case SCPI_TOKEN_OCTNUM:
+ case SCPI_TOKEN_BINNUM:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
return TRUE;
- case TokDecimalNumericProgramDataWithSuffix:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
return suffixAllowed;
default:
return FALSE;
- }
+ }
}
-scpi_bool_t SCPI_ParamDouble(scpi_t * context, double * value, scpi_bool_t mandatory)
-{
- scpi_bool_t result;
- scpi_parameter_t param;
-
+/**
+ * Convert parameter to signed/unsigned 32 bit integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @param sign
+ * @return TRUE if succesful
+ */
+static scpi_bool_t ParamSignToUInt32(scpi_t * context, scpi_parameter_t * parameter, uint32_t * value, scpi_bool_t sign) {
+
if (!value) {
- SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
return FALSE;
}
-
+
+ switch (parameter->type) {
+ case SCPI_TOKEN_HEXNUM:
+ return strBaseToUInt32(parameter->ptr, value, 16) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_OCTNUM:
+ return strBaseToUInt32(parameter->ptr, value, 8) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_BINNUM:
+ return strBaseToUInt32(parameter->ptr, value, 2) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ if (sign) {
+ return strBaseToInt32(parameter->ptr, (int32_t *) value, 10) > 0 ? TRUE : FALSE;
+ } else {
+ return strBaseToUInt32(parameter->ptr, value, 10) > 0 ? TRUE : FALSE;
+ }
+ default:
+ return FALSE;
+ }
+}
+
+/**
+ * Convert parameter to signed/unsigned 64 bit integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @param sign
+ * @return TRUE if succesful
+ */
+static scpi_bool_t ParamSignToUInt64(scpi_t * context, scpi_parameter_t * parameter, uint64_t * value, scpi_bool_t sign) {
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ switch (parameter->type) {
+ case SCPI_TOKEN_HEXNUM:
+ return strBaseToUInt64(parameter->ptr, value, 16) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_OCTNUM:
+ return strBaseToUInt64(parameter->ptr, value, 8) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_BINNUM:
+ return strBaseToUInt64(parameter->ptr, value, 2) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ if (sign) {
+ return strBaseToInt64(parameter->ptr, (int64_t *) value, 10) > 0 ? TRUE : FALSE;
+ } else {
+ return strBaseToUInt64(parameter->ptr, value, 10) > 0 ? TRUE : FALSE;
+ }
+ default:
+ return FALSE;
+ }
+}
+
+/**
+ * Convert parameter to signed 32 bit integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToInt32(scpi_t * context, scpi_parameter_t * parameter, int32_t * value) {
+ return ParamSignToUInt32(context, parameter, (uint32_t *) value, TRUE);
+}
+
+/**
+ * Convert parameter to unsigned 32 bit integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToUInt32(scpi_t * context, scpi_parameter_t * parameter, uint32_t * value) {
+ return ParamSignToUInt32(context, parameter, value, FALSE);
+}
+
+/**
+ * Convert parameter to signed 64 bit integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToInt64(scpi_t * context, scpi_parameter_t * parameter, int64_t * value) {
+ return ParamSignToUInt64(context, parameter, (uint64_t *) value, TRUE);
+}
+
+/**
+ * Convert parameter to unsigned 32 bit integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToUInt64(scpi_t * context, scpi_parameter_t * parameter, uint64_t * value) {
+ return ParamSignToUInt64(context, parameter, value, FALSE);
+}
+
+/**
+ * Convert parameter to float (32 bit)
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToFloat(scpi_t * context, scpi_parameter_t * parameter, float * value) {
+ scpi_bool_t result;
+ uint32_t valint;
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ switch (parameter->type) {
+ case SCPI_TOKEN_HEXNUM:
+ case SCPI_TOKEN_OCTNUM:
+ case SCPI_TOKEN_BINNUM:
+ result = SCPI_ParamToUInt32(context, parameter, &valint);
+ *value = valint;
+ break;
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ result = strToFloat(parameter->ptr, value) > 0 ? TRUE : FALSE;
+ break;
+ default:
+ result = FALSE;
+ }
+ return result;
+}
+
+/**
+ * Convert parameter to double (64 bit)
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToDouble(scpi_t * context, scpi_parameter_t * parameter, double * value) {
+ scpi_bool_t result;
+ uint64_t valint;
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ switch (parameter->type) {
+ case SCPI_TOKEN_HEXNUM:
+ case SCPI_TOKEN_OCTNUM:
+ case SCPI_TOKEN_BINNUM:
+ result = SCPI_ParamToUInt64(context, parameter, &valint);
+ *value = valint;
+ break;
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ result = strToDouble(parameter->ptr, value) > 0 ? TRUE : FALSE;
+ break;
+ default:
+ result = FALSE;
+ }
+ return result;
+}
+
+/**
+ * Read floating point float (32 bit) parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamFloat(scpi_t * context, float * value, scpi_bool_t mandatory) {
+ scpi_bool_t result;
+ scpi_parameter_t param;
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
result = SCPI_Parameter(context, ¶m, mandatory);
if (result) {
if (SCPI_ParamIsNumber(¶m, FALSE)) {
- *value = param.number.value;
+ SCPI_ParamToFloat(context, ¶m, value);
} else if (SCPI_ParamIsNumber(¶m, TRUE)) {
SCPI_ErrorPush(context, SCPI_ERROR_SUFFIX_NOT_ALLOWED);
result = FALSE;
@@ -491,110 +804,207 @@
result = FALSE;
}
}
- return result;
+ return result;
}
-scpi_bool_t SCPI_ParamInt(scpi_t * context, int32_t * value, scpi_bool_t mandatory)
-{
- // TODO: remove dependency on double
- double tmpVal;
+/**
+ * Read floating point double (64 bit) parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamDouble(scpi_t * context, double * value, scpi_bool_t mandatory) {
scpi_bool_t result;
+ scpi_parameter_t param;
if (!value) {
SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
return FALSE;
}
-
- result = SCPI_ParamDouble(context, &tmpVal, mandatory);
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
if (result) {
- *value = tmpVal;
+ if (SCPI_ParamIsNumber(¶m, FALSE)) {
+ SCPI_ParamToDouble(context, ¶m, value);
+ } else if (SCPI_ParamIsNumber(¶m, TRUE)) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SUFFIX_NOT_ALLOWED);
+ result = FALSE;
+ } else {
+ SCPI_ErrorPush(context, SCPI_ERROR_DATA_TYPE_ERROR);
+ result = FALSE;
+ }
}
-
return result;
}
-scpi_bool_t SCPI_ParamCharacters(scpi_t * context, const char ** value, size_t * len, scpi_bool_t mandatory)
-{
+/**
+ * Read signed/unsigned 32 bit integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @param sign
+ * @return
+ */
+static scpi_bool_t ParamSignUInt32(scpi_t * context, uint32_t * value, scpi_bool_t mandatory, scpi_bool_t sign) {
scpi_bool_t result;
scpi_parameter_t param;
-
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
+ if (result) {
+ if (SCPI_ParamIsNumber(¶m, FALSE)) {
+ result = ParamSignToUInt32(context, ¶m, value, sign);
+ } else if (SCPI_ParamIsNumber(¶m, TRUE)) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SUFFIX_NOT_ALLOWED);
+ result = FALSE;
+ } else {
+ SCPI_ErrorPush(context, SCPI_ERROR_DATA_TYPE_ERROR);
+ result = FALSE;
+ }
+ }
+ return result;
+}
+
+/**
+ * Read signed/unsigned 64 bit integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @param sign
+ * @return
+ */
+static scpi_bool_t ParamSignUInt64(scpi_t * context, uint64_t * value, scpi_bool_t mandatory, scpi_bool_t sign) {
+ scpi_bool_t result;
+ scpi_parameter_t param;
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
+ if (result) {
+ if (SCPI_ParamIsNumber(¶m, FALSE)) {
+ result = ParamSignToUInt64(context, ¶m, value, sign);
+ } else if (SCPI_ParamIsNumber(¶m, TRUE)) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SUFFIX_NOT_ALLOWED);
+ result = FALSE;
+ } else {
+ SCPI_ErrorPush(context, SCPI_ERROR_DATA_TYPE_ERROR);
+ result = FALSE;
+ }
+ }
+ return result;
+}
+
+/**
+ * Read signed 32 bit integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamInt32(scpi_t * context, int32_t * value, scpi_bool_t mandatory) {
+ return ParamSignUInt32(context, (uint32_t *) value, mandatory, TRUE);
+}
+
+/**
+ * Read unsigned 32 bit integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamUInt32(scpi_t * context, uint32_t * value, scpi_bool_t mandatory) {
+ return ParamSignUInt32(context, value, mandatory, FALSE);
+}
+
+/**
+ * Read signed 64 bit integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamInt64(scpi_t * context, int64_t * value, scpi_bool_t mandatory) {
+ return ParamSignUInt64(context, (uint64_t *) value, mandatory, TRUE);
+}
+
+/**
+ * Read unsigned 64 bit integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamUInt64(scpi_t * context, uint64_t * value, scpi_bool_t mandatory) {
+ return ParamSignUInt64(context, value, mandatory, FALSE);
+}
+
+/**
+ * Read character parameter
+ * @param context
+ * @param value
+ * @param len
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamCharacters(scpi_t * context, const char ** value, size_t * len, scpi_bool_t mandatory) {
+ scpi_bool_t result;
+ scpi_parameter_t param;
+
if (!value || !len) {
SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
return FALSE;
}
-
+
result = SCPI_Parameter(context, ¶m, mandatory);
- if (result) {
- *value = param.data.ptr;
- *len = param.data.len;
+ if (result) {
+ switch (param.type) {
+ case SCPI_TOKEN_SINGLE_QUOTE_PROGRAM_DATA:
+ case SCPI_TOKEN_DOUBLE_QUOTE_PROGRAM_DATA:
+ *value = param.ptr + 1;
+ *len = param.len - 2;
+ break;
+ default:
+ *value = param.ptr;
+ *len = param.len;
+ break;
+ }
// TODO: return also parameter type (ProgramMnemonic, ArbitraryBlockProgramData, SingleQuoteProgramData, DoubleQuoteProgramData
}
-
+
return result;
}
-scpi_bool_t SCPI_ParamBool(scpi_t * context, scpi_bool_t * value, scpi_bool_t mandatory)
-{
+/**
+ * Get arbitrary block program data and returns pointer to data
+ * @param context
+ * @param value result pointer to data
+ * @param len result length of data
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamArbitraryBlock(scpi_t * context, const char ** value, size_t * len, scpi_bool_t mandatory) {
scpi_bool_t result;
scpi_parameter_t param;
- if (!value) {
+ if (!value || !len) {
SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
return FALSE;
}
-
- result = SCPI_Parameter(context, ¶m, mandatory);
-
- if (result) {
- switch (param.type) {
- case TokDecimalNumericProgramData:
- *value = param.number.value ? 1 : 0;
- break;
- case TokProgramMnemonic:
- if (compareStr("ON", 2, param.data.ptr, param.data.len)) {
- *value = TRUE;
- } else if (compareStr("OFF", 3, param.data.ptr, param.data.len)) {
- *value = FALSE;
- } else {
- SCPI_ErrorPush(context, SCPI_ERROR_ILLEGAL_PARAMETER_VALUE);
- result = FALSE;
- }
- break;
- default:
- SCPI_ErrorPush(context, SCPI_ERROR_DATA_TYPE_ERROR);
- result = FALSE;
- }
- }
-
- return result;
-}
-scpi_bool_t SCPI_ParamChoice(scpi_t * context, const char * options[], int32_t * value, scpi_bool_t mandatory)
-{
- size_t res;
- scpi_bool_t result;
- scpi_parameter_t param;
-
- if (!options || !value) {
- SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
- return FALSE;
- }
-
result = SCPI_Parameter(context, ¶m, mandatory);
if (result) {
- if (param.type == TokProgramMnemonic) {
- for (res = 0; options[res]; ++res) {
- if (matchPattern(options[res], strlen(options[res]), param.data.ptr, param.data.len)) {
- *value = res;
- break;
- }
- }
-
- if (!options[res]) {
- SCPI_ErrorPush(context, SCPI_ERROR_ILLEGAL_PARAMETER_VALUE);
- result = FALSE;
- }
+ if (param.type == SCPI_TOKEN_ARBITRARY_BLOCK_PROGRAM_DATA) {
+ *value = param.ptr;
+ *len = param.len;
} else {
SCPI_ErrorPush(context, SCPI_ERROR_DATA_TYPE_ERROR);
result = FALSE;
@@ -604,64 +1014,241 @@
return result;
}
-int parseProgramData(lex_state_t * state, scpi_token_t * token) {
+scpi_bool_t SCPI_ParamCopyText(scpi_t * context, char * buffer, size_t buffer_len, size_t * copy_len, scpi_bool_t mandatory) {
+ scpi_bool_t result;
+ scpi_parameter_t param;
+ size_t i_from;
+ size_t i_to;
+ char quote;
+
+ if (!buffer || !copy_len) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
+ if (result) {
+
+ switch (param.type) {
+ case SCPI_TOKEN_SINGLE_QUOTE_PROGRAM_DATA:
+ case SCPI_TOKEN_DOUBLE_QUOTE_PROGRAM_DATA:
+ quote = param.type == SCPI_TOKEN_SINGLE_QUOTE_PROGRAM_DATA ? '\'' : '"';
+ for (i_from = 1, i_to = 0; i_from < (size_t) (param.len - 1); i_from++) {
+ if (i_from >= buffer_len) {
+ break;
+ }
+ buffer[i_to] = param.ptr[i_from];
+ i_to++;
+ if (param.ptr[i_from] == quote) {
+ i_from++;
+ }
+ }
+ *copy_len = i_to;
+ if (i_to < buffer_len) {
+ buffer[i_to] = 0;
+ }
+ break;
+ default:
+ SCPI_ErrorPush(context, SCPI_ERROR_DATA_TYPE_ERROR);
+ result = FALSE;
+ }
+ }
+
+ return result;
+}
+
+/**
+ * Convert parameter to choice
+ * @param context
+ * @param parameter - should be PROGRAM_MNEMONIC
+ * @param options - NULL terminated list of choices
+ * @param value - index to options
+ * @return
+ */
+scpi_bool_t SCPI_ParamToChoice(scpi_t * context, scpi_parameter_t * parameter, const scpi_choice_def_t * options, int32_t * value) {
+ size_t res;
+ scpi_bool_t result = FALSE;
+
+ if (!options || !value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ if (parameter->type == SCPI_TOKEN_PROGRAM_MNEMONIC) {
+ for (res = 0; options[res].name; ++res) {
+ if (matchPattern(options[res].name, strlen(options[res].name), parameter->ptr, parameter->len, NULL)) {
+ *value = options[res].tag;
+ result = TRUE;
+ break;
+ }
+ }
+
+ if (!result) {
+ SCPI_ErrorPush(context, SCPI_ERROR_ILLEGAL_PARAMETER_VALUE);
+ }
+ } else {
+ SCPI_ErrorPush(context, SCPI_ERROR_DATA_TYPE_ERROR);
+ }
+
+ return result;
+}
+
+/**
+ * Find tag in choices and returns its first textual representation
+ * @param options specifications of choices numbers (patterns)
+ * @param tag numerical representatio of choice
+ * @param text result text
+ * @return TRUE if succesfule, else FALSE
+ */
+scpi_bool_t SCPI_ChoiceToName(const scpi_choice_def_t * options, int32_t tag, const char ** text) {
+ int i;
+
+ for (i = 0; options[i].name != NULL; i++) {
+ if (options[i].tag == tag) {
+ *text = options[i].name;
+ return TRUE;
+ }
+ }
+
+ return FALSE;
+}
+
+/**
+ * Read BOOL parameter (0,1,ON,OFF)
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamBool(scpi_t * context, scpi_bool_t * value, scpi_bool_t mandatory) {
+ scpi_bool_t result;
+ scpi_parameter_t param;
+ int32_t intval;
+
+ scpi_choice_def_t bool_options[] = {
+ {"OFF", 0},
+ {"ON", 1},
+ SCPI_CHOICE_LIST_END /* termination of option list */
+ };
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
+
+ if (result) {
+ if (param.type == SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA) {
+ SCPI_ParamToInt32(context, ¶m, &intval);
+ *value = intval ? TRUE : FALSE;
+ } else {
+ result = SCPI_ParamToChoice(context, ¶m, bool_options, &intval);
+ if (result) {
+ *value = intval ? TRUE : FALSE;
+ }
+ }
+ }
+
+ return result;
+}
+
+/**
+ * Read value from list of options
+ * @param context
+ * @param options
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamChoice(scpi_t * context, const scpi_choice_def_t * options, int32_t * value, scpi_bool_t mandatory) {
+ scpi_bool_t result;
+ scpi_parameter_t param;
+
+ if (!options || !value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
+ if (result) {
+ result = SCPI_ParamToChoice(context, ¶m, options, value);
+ }
+
+ return result;
+}
+
+/**
+ * Parse one parameter and detect type
+ * @param state
+ * @param token
+ * @return
+ */
+int scpiParser_parseProgramData(lex_state_t * state, scpi_token_t * token) {
scpi_token_t tmp;
int result = 0;
int wsLen;
int suffixLen;
int realLen = 0;
- realLen += lexWhiteSpace(state, &tmp);
+ realLen += scpiLex_WhiteSpace(state, &tmp);
- if (result == 0) result = lexNondecimalNumericData(state, token);
- if (result == 0) result = lexCharacterProgramData(state, token);
+ if (result == 0) result = scpiLex_NondecimalNumericData(state, token);
+ if (result == 0) result = scpiLex_CharacterProgramData(state, token);
if (result == 0) {
- result = lexDecimalNumericProgramData(state, token);
+ result = scpiLex_DecimalNumericProgramData(state, token);
if (result != 0) {
- wsLen = lexWhiteSpace(state, &tmp);
- suffixLen = lexSuffixProgramData(state, &tmp);
+ wsLen = scpiLex_WhiteSpace(state, &tmp);
+ suffixLen = scpiLex_SuffixProgramData(state, &tmp);
if (suffixLen > 0) {
token->len += wsLen + suffixLen;
- token->type = TokDecimalNumericProgramDataWithSuffix;
+ token->type = SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX;
result = token->len;
}
}
}
- if (result == 0) result = lexStringProgramData(state, token);
- if (result == 0) result = lexArbitraryBlockProgramData(state, token);
- if (result == 0) result = lexProgramExpression(state, token);
+ if (result == 0) result = scpiLex_StringProgramData(state, token);
+ if (result == 0) result = scpiLex_ArbitraryBlockProgramData(state, token);
+ if (result == 0) result = scpiLex_ProgramExpression(state, token);
- realLen += lexWhiteSpace(state, &tmp);
+ realLen += scpiLex_WhiteSpace(state, &tmp);
return result + realLen;
}
-int parseAllProgramData(lex_state_t * state, scpi_token_t * token, int * numberOfParameters) {
+/**
+ * Skip all parameters to correctly detect end of command line.
+ * @param state
+ * @param token
+ * @param numberOfParameters
+ * @return
+ */
+int scpiParser_parseAllProgramData(lex_state_t * state, scpi_token_t * token, int * numberOfParameters) {
int result;
scpi_token_t tmp;
int paramCount = 0;
token->len = -1;
- token->type = TokAllProgramData;
+ token->type = SCPI_TOKEN_ALL_PROGRAM_DATA;
token->ptr = state->pos;
- for (result = 1; result != 0; result = lexComma(state, &tmp)) {
+ for (result = 1; result != 0; result = scpiLex_Comma(state, &tmp)) {
token->len += result;
if (result == 0) {
- token->type = TokUnknown;
+ token->type = SCPI_TOKEN_UNKNOWN;
token->len = 0;
paramCount = -1;
break;
}
- result = parseProgramData(state, &tmp);
- if (tmp.type != TokUnknown) {
+ result = scpiParser_parseProgramData(state, &tmp);
+ if (tmp.type != SCPI_TOKEN_UNKNOWN) {
token->len += result;
} else {
- token->type = TokUnknown;
+ token->type = SCPI_TOKEN_UNKNOWN;
token->len = 0;
paramCount = -1;
break;
@@ -679,13 +1266,14 @@
return token->len;
}
-static void invalidateToken(scpi_token_t * token, const char * ptr) {
- token->len = 0;
- token->ptr = ptr;
- token->type = TokUnknown;
-}
-
-int detectProgramMessageUnit(scpi_parser_state_t * state, const char * buffer, int len) {
+/**
+ * Skip complete command line - program header and parameters
+ * @param state
+ * @param buffer
+ * @param len
+ * @return
+ */
+int scpiParser_detectProgramMessageUnit(scpi_parser_state_t * state, char * buffer, int len) {
lex_state_t lex_state;
scpi_token_t tmp;
int result = 0;
@@ -695,11 +1283,11 @@
state->numberOfParameters = 0;
/* ignore whitespace at the begginig */
- lexWhiteSpace(&lex_state, &tmp);
+ scpiLex_WhiteSpace(&lex_state, &tmp);
- if (lexProgramHeader(&lex_state, &state->programHeader) >= 0) {
- if (lexWhiteSpace(&lex_state, &tmp) > 0) {
- parseAllProgramData(&lex_state, &state->programData, &state->numberOfParameters);
+ if (scpiLex_ProgramHeader(&lex_state, &state->programHeader) >= 0) {
+ if (scpiLex_WhiteSpace(&lex_state, &tmp) > 0) {
+ scpiParser_parseAllProgramData(&lex_state, &state->programData, &state->numberOfParameters);
} else {
invalidateToken(&state->programData, lex_state.pos);
}
@@ -708,39 +1296,83 @@
invalidateToken(&state->programData, lex_state.buffer);
}
- if (result == 0) result = lexNewLine(&lex_state, &tmp);
- if (result == 0) result = lexSemicolon(&lex_state, &tmp);
+ if (result == 0) result = scpiLex_NewLine(&lex_state, &tmp);
+ if (result == 0) result = scpiLex_Semicolon(&lex_state, &tmp);
- if (!lexIsEos(&lex_state) && (result == 0)) {
+ if (!scpiLex_IsEos(&lex_state) && (result == 0)) {
lex_state.pos++;
state->programHeader.len = 1;
- state->programHeader.type = TokInvalid;
+ state->programHeader.type = SCPI_TOKEN_INVALID;
- invalidateToken(&state->programData, lex_state.buffer);
+ invalidateToken(&state->programData, lex_state.buffer);
}
- if (TokSemicolon == tmp.type) {
- state->termination = PmutSemicolon;
- } else if (TokNewLine == tmp.type) {
- state->termination = PmutNewLine;
+ if (SCPI_TOKEN_SEMICOLON == tmp.type) {
+ state->termination = SCPI_MESSAGE_TERMINATION_SEMICOLON;
+ } else if (SCPI_TOKEN_NL == tmp.type) {
+ state->termination = SCPI_MESSAGE_TERMINATION_NL;
} else {
- state->termination = PmutNone;
+ state->termination = SCPI_MESSAGE_TERMINATION_NONE;
}
return lex_state.pos - lex_state.buffer;
}
+/**
+ * Check current command
+ * - suitable for one handle to multiple commands
+ * @param context
+ * @param cmd
+ * @return
+ */
+scpi_bool_t SCPI_IsCmd(scpi_t * context, const char * cmd) {
+ const char * pattern;
+ if (!context->param_list.cmd) {
+ return FALSE;
+ }
+ pattern = context->param_list.cmd->pattern;
+ return matchCommand(pattern, cmd, strlen(cmd), NULL, 0, 0);
+}
+/**
+ * Return the .tag field of the matching scpi_command_t
+ * @param context
+ * @return
+ */
+int32_t SCPI_CmdTag(scpi_t * context) {
+ if (context->param_list.cmd) {
+ return context->param_list.cmd->tag;
+ } else {
+ return 0;
+ }
+}
+scpi_bool_t SCPI_Match(const char * pattern, const char * value, size_t len) {
+ return matchCommand(pattern, value, len, NULL, 0, 0);
+}
+scpi_bool_t SCPI_CommandNumbers(scpi_t * context, int32_t * numbers, size_t len, int32_t default_value) {
+ return matchCommand(context->param_list.cmd->pattern, context->param_list.cmd_raw.data, context->param_list.cmd_raw.length, numbers, len, default_value);
+}
+/**
+ * If SCPI_Parameter() returns FALSE, this function can detect, if the parameter
+ * is just missing (TRUE) or if there was an error during processing of the command (FALSE)
+ * @param parameter
+ * @return
+ */
+scpi_bool_t SCPI_ParamIsValid(scpi_parameter_t * parameter) {
+ return parameter->type == SCPI_TOKEN_UNKNOWN ? FALSE : TRUE;
+}
-
-
-
-
-
-
+/**
+ * Returns TRUE if there was an error during parameter handling
+ * @param context
+ * @return
+ */
+scpi_bool_t SCPI_ParamErrorOccurred(scpi_t * context) {
+ return context->cmd_error;
+}
--
Gitblit v1.9.1