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/parser.c | 727 ++++++++++++++++++++++++++++++++++++++++++-------------
1 files changed, 549 insertions(+), 178 deletions(-)
diff --git a/libscpi/src/parser.c b/libscpi/src/parser.c
index aa3806a..d7f5eee 100644
--- a/libscpi/src/parser.c
+++ b/libscpi/src/parser.c
@@ -39,31 +39,10 @@
#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"
-
-static void paramSkipBytes(scpi_t * context, size_t num);
-static void paramSkipWhitespace(scpi_t * context);
-static bool_t paramNext(scpi_t * context, bool_t mandatory);
-
-/*
-int _strnicmp(const char* s1, const char* s2, int len) {
- int result = 0;
- int i;
-
- for (i = 0; i < len && s1[i] && s2[i]; i++) {
- char c1 = tolower(s1[i]);
- char c2 = tolower(s2[i]);
- if (c1 != c2) {
- result = (int) c1 - (int) c2;
- break;
- }
- }
-
- return result;
-}
- */
+#include "scpi/constants.h"
/**
* Write data to SCPI output
@@ -96,7 +75,7 @@
*/
static size_t writeDelimiter(scpi_t * context) {
if (context->output_count > 0) {
- return writeData(context, ", ", 2);
+ return writeData(context, ",", 2);
} else {
return 0;
}
@@ -123,7 +102,8 @@
* @param context
*/
static void processCommand(scpi_t * context) {
- const scpi_command_t * cmd = context->paramlist.cmd;
+ const scpi_command_t * cmd = context->param_list.cmd;
+ lex_state_t * state = &context->param_list.lex_state;
context->cmd_error = FALSE;
context->output_count = 0;
@@ -140,11 +120,8 @@
/* conditionaly write new line */
writeNewLine(context);
- /* skip all whitespaces */
- paramSkipWhitespace(context);
-
/* set error if command callback did not read all parameters */
- if (context->paramlist.length != 0 && !context->cmd_error) {
+ if (state->pos < (state->buffer + state->len) && !context->cmd_error) {
SCPI_ErrorPush(context, SCPI_ERROR_PARAMETER_NOT_ALLOWED);
}
}
@@ -154,14 +131,14 @@
* @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)) {
- context->paramlist.cmd = cmd;
+ context->param_list.cmd = cmd;
return TRUE;
}
}
@@ -189,13 +166,19 @@
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) {
if (findCommandHeader(context, state->programHeader.ptr, state->programHeader.len)) {
- context->paramlist.parameters = state->programData.ptr;
- context->paramlist.length = state->programData.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);
@@ -224,6 +207,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);
}
@@ -260,14 +256,14 @@
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 (context->parser_state.termination == SCPI_MESSAGE_TERMINATION_NL) break;
+ if (context->parser_state.programHeader.type == SCPI_TOKEN_UNKNOWN) break;
if (totcmdlen >= context->buffer.position) break;
}
- if (context->parser_state.termination == PmutNewLine) {
+ 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;
@@ -285,8 +281,7 @@
* @param data
* @return
*/
-size_t SCPI_ResultString(scpi_t * context, const char * data) {
- size_t len = strlen(data);
+size_t SCPI_ResultCharacters(scpi_t * context, const char * data, size_t len) {
size_t result = 0;
result += writeDelimiter(context);
result += writeData(context, data, len);
@@ -301,10 +296,43 @@
* @return
*/
size_t SCPI_ResultInt(scpi_t * context, int32_t val) {
- char buffer[12];
+ 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";
+ case 8: return "#Q";
+ case 16: return "#H";
+ default: return NULL;
+ }
+}
+
+/**
+ * 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 = longToStr(val, buffer, sizeof (buffer));
+ size_t len;
+
+ len = longToStr(val, buffer, sizeof (buffer), base);
+ basePrefix = getBasePrefix(base);
+
result += writeDelimiter(context);
+ if (basePrefix != NULL) {
+ result += writeData(context, basePrefix, 2);
+ }
result += writeData(context, buffer, len);
context->output_count++;
return result;
@@ -337,242 +365,550 @@
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] = '#';
+ longToStr(len, block_header + 2, 10, 10);
+
+ header_len = strlen(block_header + 2);
+ block_header[1] = 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 */
/**
- * Skip num bytes from the begginig of parameters
- * @param context
- * @param num
+ * Invalidate token
+ * @param token
+ * @param ptr
*/
-void paramSkipBytes(scpi_t * context, size_t num) {
- if (context->paramlist.length < num) {
- num = context->paramlist.length;
- }
- context->paramlist.parameters += num;
- context->paramlist.length -= num;
+static void invalidateToken(scpi_token_t * token, const char * ptr) {
+ token->len = 0;
+ token->ptr = ptr;
+ token->type = SCPI_TOKEN_UNKNOWN;
}
/**
- * Skip white spaces from the beggining of parameters
+ * Get one parameter from command line
* @param context
- */
-void paramSkipWhitespace(scpi_t * context) {
- size_t ws = skipWhitespace(context->paramlist.parameters, context->paramlist.length);
- paramSkipBytes(context, ws);
-}
-
-/**
- * Find next parameter
- * @param context
+ * @param parameter
* @param mandatory
- * @return
+ * @return
*/
-bool_t paramNext(scpi_t * context, bool_t mandatory) {
- paramSkipWhitespace(context);
- if (context->paramlist.length == 0) {
+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;
+
+ if (state->pos >= (state->buffer + state->len)) {
if (mandatory) {
SCPI_ErrorPush(context, SCPI_ERROR_MISSING_PARAMETER);
+ } else {
+ parameter->type = SCPI_TOKEN_PROGRAM_MNEMONIC; // TODO: select something different
}
return FALSE;
}
if (context->input_count != 0) {
- if (context->paramlist.parameters[0] == ',') {
- paramSkipBytes(context, 1);
- paramSkipWhitespace(context);
- } else {
+ scpiLex_Comma(state, parameter);
+ if (parameter->type != SCPI_TOKEN_COMMA) {
+ invalidateToken(parameter, NULL);
SCPI_ErrorPush(context, SCPI_ERROR_INVALID_SEPARATOR);
return FALSE;
}
}
+
context->input_count++;
- return TRUE;
+
+ scpiParser_parseProgramData(&context->param_list.lex_state, parameter);
+
+ 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:
+ invalidateToken(parameter, NULL);
+ SCPI_ErrorPush(context, SCPI_ERROR_INVALID_STRING_DATA);
+ return FALSE;
+ }
}
/**
- * Parse integer 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 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:
+ return FALSE;
+ }
+}
+
+/**
+ * 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) {
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ switch (parameter->type) {
+ case SCPI_TOKEN_HEXNUM:
+ return strToLong(parameter->ptr, value, 16) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_OCTNUM:
+ return strToLong(parameter->ptr, value, 8) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_BINNUM:
+ return strToLong(parameter->ptr, value, 2) > 0 ? TRUE : FALSE;
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
+ return strToLong(parameter->ptr, value, 10) > 0 ? TRUE : FALSE;
+ }
+ return FALSE;
+}
+
+/**
+ * Convert parameter to double
+ * @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 = FALSE;
+ int32_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_ParamToInt(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
+ * @return
*/
-bool_t SCPI_ParamInt(scpi_t * context, int32_t * value, bool_t mandatory) {
- const char * param;
- size_t param_len;
- size_t num_len;
+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;
}
- if (!SCPI_ParamString(context, ¶m, ¶m_len, mandatory)) {
- 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;
+ }
}
-
- num_len = strToLong(param, value);
-
- if (num_len != param_len) {
- SCPI_ErrorPush(context, SCPI_ERROR_SUFFIX_NOT_ALLOWED);
- return FALSE;
- }
-
- return TRUE;
+ return result;
}
/**
- * Parse double parameter
+ * Read integer parameter
* @param context
* @param value
* @param mandatory
- * @return
+ * @return
*/
-bool_t SCPI_ParamDouble(scpi_t * context, double * value, bool_t mandatory) {
- const char * param;
- size_t param_len;
- size_t num_len;
+scpi_bool_t SCPI_ParamInt(scpi_t * context, int32_t * value, scpi_bool_t mandatory) {
+ scpi_bool_t result;
+ scpi_parameter_t param;
if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
return FALSE;
}
- if (!SCPI_ParamString(context, ¶m, ¶m_len, mandatory)) {
- return FALSE;
+ result = SCPI_Parameter(context, ¶m, mandatory);
+ if (result) {
+ if (SCPI_ParamIsNumber(¶m, FALSE)) {
+ SCPI_ParamToInt(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;
+ }
}
-
- num_len = strToDouble(param, value);
-
- if (num_len != param_len) {
- SCPI_ErrorPush(context, SCPI_ERROR_SUFFIX_NOT_ALLOWED);
- return FALSE;
- }
-
- return TRUE;
+ return result;
}
/**
- * Parse string parameter
+ * Read character parameter
* @param context
* @param value
* @param len
* @param mandatory
- * @return
+ * @return
*/
-bool_t SCPI_ParamString(scpi_t * context, const char ** value, size_t * len, bool_t mandatory) {
- size_t length;
+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;
}
- if (!paramNext(context, mandatory)) {
+ result = SCPI_Parameter(context, ¶m, mandatory);
+ if (result) {
+ *value = param.ptr;
+ *len = param.len;
+
+ // 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;
}
- if (locateStr(context->paramlist.parameters, context->paramlist.length, value, &length)) {
- paramSkipBytes(context, length);
- paramSkipWhitespace(context);
- if (len) {
- *len = length;
+ 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 TRUE;
+ }
+
+ 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 = 0, i_to = 0; i_from < (size_t) param.len; 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++;
+ }
+ }
+ 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)) {
+ *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;
}
/**
- * Parse text parameter (can be inside "")
+ * Read BOOL parameter (0,1,ON,OFF)
* @param context
* @param value
- * @param len
* @param mandatory
- * @return
+ * @return
*/
-bool_t SCPI_ParamText(scpi_t * context, const char ** value, size_t * len, bool_t mandatory) {
- size_t length;
+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;
- if (!value || !len) {
+ 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;
}
- if (!paramNext(context, mandatory)) {
- return FALSE;
- }
+ result = SCPI_Parameter(context, ¶m, mandatory);
- if (locateText(context->paramlist.parameters, context->paramlist.length, value, &length)) {
- paramSkipBytes(context, length);
- if (len) {
- *len = length;
+ 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 TRUE;
}
- return FALSE;
+ return result;
}
-int SCPI_ParseProgramData(lex_state_t * state, token_t * token) {
- token_t tmp;
+/**
+ * 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;
@@ -590,52 +926,87 @@
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, const 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) {
+ if (!context->param_list.cmd) {
+ return FALSE;
+ }
+ const char * pattern = context->param_list.cmd->pattern;
+ return matchCommand(pattern, cmd, strlen(cmd));
+}
+
+/**
+ * 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;
+ }
+}
--
Gitblit v1.9.1