From d44ab5893845801ec95e058b9b56a3a75b9720f7 Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: 周日, 04 10月 2015 19:35:26 +0800
Subject: [PATCH] Fix access outside buffer
---
libscpi/src/parser.c | 827 ++++++++++++++++++++++++++++++++++++++++++++++++----------
1 files changed, 680 insertions(+), 147 deletions(-)
diff --git a/libscpi/src/parser.c b/libscpi/src/parser.c
index 99de301..9032c9c 100644
--- a/libscpi/src/parser.c
+++ b/libscpi/src/parser.c
@@ -39,9 +39,11 @@
#include "scpi/config.h"
#include "scpi/parser.h"
-#include "scpi/lexer.h"
-#include "utils.h"
+#include "parser_private.h"
+#include "lexer_private.h"
#include "scpi/error.h"
+#include "scpi/constants.h"
+#include "scpi/utils.h"
/**
* Write data to SCPI output
@@ -74,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;
}
@@ -88,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;
}
@@ -104,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) {
@@ -130,13 +147,13 @@
* @param context
* @result TRUE if context->paramlist is filled with correct values
*/
-static bool_t findCommandHeader(scpi_t * context, const char * header, int len) {
+static scpi_bool_t findCommandHeader(scpi_t * context, const char * header, int len) {
int32_t i;
const scpi_command_t * cmd;
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)) {
context->param_list.cmd = cmd;
return TRUE;
}
@@ -151,32 +168,43 @@
* @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 = SCPI_DetectProgramMessageUnit(state, data, len);
+ r = scpiParser_detectProgramMessageUnit(state, data, len);
- if (state->programHeader.len > 0) {
+ 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;
context->param_list.lex_state.pos = context->param_list.lex_state.buffer;
context->param_list.lex_state.len = state->programData.len;
+ context->param_list.cmd_raw.data = state->programHeader.ptr;
+ context->param_list.cmd_raw.position = 0;
+ context->param_list.cmd_raw.length = state->programHeader.len;
processCommand(context);
result = 1;
+ cmd_prev = state->programHeader;
} else {
SCPI_ErrorPush(context, SCPI_ERROR_UNDEFINED_HEADER);
}
@@ -190,6 +218,10 @@
}
}
+
+ /* conditionaly write new line */
+ writeNewLine(context);
+
return result;
}
@@ -201,6 +233,19 @@
* @param interface
*/
void SCPI_Init(scpi_t * context) {
+ if (context->idn[0] == NULL) {
+ context->idn[0] = SCPI_DEFAULT_1_MANUFACTURE;
+ }
+ if (context->idn[1] == NULL) {
+ context->idn[1] = SCPI_DEFAULT_2_MODEL;
+ }
+ if (context->idn[2] == NULL) {
+ context->idn[2] = SCPI_DEFAULT_3;
+ }
+ if (context->idn[3] == NULL) {
+ context->idn[3] = SCPI_DEFAULT_4_REVISION;
+ }
+
context->buffer.position = 0;
SCPI_ErrorInit(context);
}
@@ -237,17 +282,18 @@
while (1) {
- cmdlen = SCPI_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;
+ }
}
}
@@ -280,6 +326,11 @@
return SCPI_ResultIntBase(context, val, 10);
}
+/**
+ * Return prefix of nondecimal base
+ * @param base
+ * @return
+ */
static const char * getBasePrefix(int8_t base) {
switch (base) {
case 2: return "#B";
@@ -289,13 +340,20 @@
}
}
+/**
+ * Write integer value in specific base to the result
+ * @param context
+ * @param val
+ * @param base
+ * @return
+ */
size_t SCPI_ResultIntBase(scpi_t * context, int32_t val, int8_t base) {
char buffer[33];
const char * basePrefix;
size_t result = 0;
size_t len;
- len = longToStr(val, buffer, sizeof (buffer), base);
+ len = SCPI_LongToStr(val, buffer, sizeof (buffer), base);
basePrefix = getBasePrefix(base);
result += writeDelimiter(context);
@@ -316,7 +374,7 @@
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++;
@@ -334,26 +392,76 @@
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_LongToStr(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;
+}
+
+/**
+ * Write boolean value to the result
+ * @param context
+ * @param val
+ * @return
+ */
+size_t SCPI_ResultBool(scpi_t * context, scpi_bool_t val) {
+ return SCPI_ResultIntBase(context, val ? 1 : 0, 10);
+}
+
/* parsing parameters */
-bool_t SCPI_Parameter(scpi_t * context, scpi_parameter_t * parameter, bool_t mandatory) {
- 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;
@@ -361,14 +469,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) {
- SCPI_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;
}
@@ -376,136 +484,507 @@
context->input_count++;
- SCPI_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;
- SCPI_ErrorPush(context, SCPI_ERROR_UNKNOWN_PARAMETER);
+ invalidateToken(parameter, NULL);
+ SCPI_ErrorPush(context, SCPI_ERROR_INVALID_STRING_DATA);
return FALSE;
}
}
-int32_t SCPI_ParamGetIntVal(scpi_t * context, scpi_parameter_t * parameter) {
+/**
+ * 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 TokDecimalNumericProgramDataWithSuffix:
- return parameter->number.value;
+ case SCPI_TOKEN_HEXNUM:
+ case SCPI_TOKEN_OCTNUM:
+ case SCPI_TOKEN_BINNUM:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ return TRUE;
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ return suffixAllowed;
default:
- SCPI_ErrorPush(context, SCPI_ERROR_INVALID_PARAMETER);
- return 0;
+ return FALSE;
}
}
-double SCPI_ParamGetDoubleVal(scpi_t * context, scpi_parameter_t * parameter) {
- return parameter->number.value;
+/**
+ * Convert parameter to integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+static scpi_bool_t ParamToInt(scpi_t * context, scpi_parameter_t * parameter, int32_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 strToULong(parameter->ptr, (uint32_t *)value, 16) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_OCTNUM:
+ return strToULong(parameter->ptr, (uint32_t *)value, 8) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_BINNUM:
+ return strToULong(parameter->ptr, (uint32_t *)value, 2) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ if (sign) {
+ return strToLong(parameter->ptr, value, 10) > 0 ? TRUE : FALSE;
+ } else {
+ return strToULong(parameter->ptr, (uint32_t *)value, 10) > 0 ? TRUE : FALSE;
+ }
+ }
+ return FALSE;
}
-void SCPI_ParamGetTextVal(scpi_t * context, scpi_parameter_t * parameter, const char ** data, int32_t * len) {
- *data = parameter->data.ptr;
- *len = parameter->data.len;
+
+/**
+ * Convert parameter to integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToInt(scpi_t * context, scpi_parameter_t * parameter, int32_t * value) {
+ return ParamToInt(context, parameter, value, TRUE);
}
-int SCPI_ParseProgramData(lex_state_t * state, token_t * token) {
- token_t tmp;
+/**
+ * Convert parameter to unsigned integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToUnsignedInt(scpi_t * context, scpi_parameter_t * parameter, uint32_t * value) {
+ return ParamToInt(context, parameter, (int32_t *)value, FALSE);
+}
+
+/**
+ * Convert parameter to double
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+#include "stdio.h"
+scpi_bool_t SCPI_ParamToDouble(scpi_t * context, scpi_parameter_t * parameter, double * value) {
+ scpi_bool_t result = FALSE;
+ 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_ParamToUnsignedInt(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;
+ }
+ return result;
+}
+
+/**
+ * Read floating point 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_Parameter(context, ¶m, mandatory);
+ if (result) {
+ 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;
+}
+
+/**
+ * Read integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+static scpi_bool_t ParamInt(scpi_t * context, int32_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 = ParamToInt(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;
+}
+
+scpi_bool_t SCPI_ParamInt(scpi_t * context, int32_t * value, scpi_bool_t mandatory) {
+ return ParamInt(context, value, mandatory, TRUE);
+}
+
+scpi_bool_t SCPI_ParamUnsignedInt(scpi_t * context, uint32_t * value, scpi_bool_t mandatory) {
+ return ParamInt(context, (int32_t *)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) {
+ 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;
+}
+
+/**
+ * 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 || !len) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
+ if (result) {
+ 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;
+ }
+ }
+
+ return result;
+}
+
+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_ParamToInt(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 += SCPI_LexWhiteSpace(state, &tmp);
+ realLen += scpiLex_WhiteSpace(state, &tmp);
- if (result == 0) result = SCPI_LexNondecimalNumericData(state, token);
- if (result == 0) result = SCPI_LexCharacterProgramData(state, token);
+ if (result == 0) result = scpiLex_NondecimalNumericData(state, token);
+ if (result == 0) result = scpiLex_CharacterProgramData(state, token);
if (result == 0) {
- result = SCPI_LexDecimalNumericProgramData(state, token);
+ result = scpiLex_DecimalNumericProgramData(state, token);
if (result != 0) {
- wsLen = SCPI_LexWhiteSpace(state, &tmp);
- suffixLen = SCPI_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 = SCPI_LexStringProgramData(state, token);
- if (result == 0) result = SCPI_LexArbitraryBlockProgramData(state, token);
- if (result == 0) result = SCPI_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 += SCPI_LexWhiteSpace(state, &tmp);
+ realLen += scpiLex_WhiteSpace(state, &tmp);
return result + realLen;
}
-int SCPI_ParseAllProgramData(lex_state_t * state, 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;
- token_t tmp;
+ 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 = SCPI_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 = SCPI_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;
@@ -523,61 +1002,115 @@
return token->len;
}
-int SCPI_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;
- token_t tmp;
+ scpi_token_t tmp;
int result = 0;
lex_state.buffer = lex_state.pos = buffer;
lex_state.len = len;
+ state->numberOfParameters = 0;
/* ignore whitespace at the begginig */
- SCPI_LexWhiteSpace(&lex_state, &tmp);
+ scpiLex_WhiteSpace(&lex_state, &tmp);
- if (SCPI_LexProgramHeader(&lex_state, &state->programHeader) >= 0) {
- if (SCPI_LexWhiteSpace(&lex_state, &tmp) > 0) {
- SCPI_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 {
- state->programData.len = 0;
- state->programData.ptr = lex_state.pos;
- state->programData.type = TokUnknown;
- state->numberOfParameters = 0;
+ invalidateToken(&state->programData, lex_state.pos);
}
} else {
- state->programHeader.len = 0;
- state->programData.ptr = lex_state.buffer;
- state->programHeader.type = TokUnknown;
-
- state->programData.len = 0;
- state->programData.ptr = lex_state.buffer;
- state->programData.type = TokUnknown;
- state->numberOfParameters = 0;
+ invalidateToken(&state->programHeader, lex_state.buffer);
+ invalidateToken(&state->programData, lex_state.buffer);
}
- if (result == 0) result = SCPI_LexNewLine(&lex_state, &tmp);
- if (result == 0) result = SCPI_LexSemicolon(&lex_state, &tmp);
+ if (result == 0) result = scpiLex_NewLine(&lex_state, &tmp);
+ if (result == 0) result = scpiLex_Semicolon(&lex_state, &tmp);
- if (TokSemicolon == tmp.type) {
- state->termination = PmutSemicolon;
- } else if (TokNewLine == tmp.type) {
- state->termination = PmutNewLine;
+ if (!scpiLex_IsEos(&lex_state) && (result == 0)) {
+ lex_state.pos++;
+
+ state->programHeader.len = 1;
+ state->programHeader.type = SCPI_TOKEN_INVALID;
+
+ invalidateToken(&state->programData, lex_state.buffer);
+ }
+
+ 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);
+}
+/**
+ * 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);
+}
+scpi_bool_t SCPI_CommandNumbers(scpi_t * context, int32_t * numbers, size_t len) {
+ return matchCommand (context->param_list.cmd->pattern, context->param_list.cmd_raw.data, context->param_list.cmd_raw.length, numbers, len);
+}
+/**
+ * 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