From 794a6e9f2e3e2ebefd9269772d35f7f3e9e21166 Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: 周日, 18 1月 2015 20:07:26 +0800
Subject: [PATCH] Refactoring token constants
---
libscpi/src/parser.c | 400 ++++++++++++++++++++++++++++++++++++++++-----------------
1 files changed, 281 insertions(+), 119 deletions(-)
diff --git a/libscpi/src/parser.c b/libscpi/src/parser.c
index ba06728..43f5b98 100644
--- a/libscpi/src/parser.c
+++ b/libscpi/src/parser.c
@@ -166,9 +166,9 @@
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) {
if (findCommandHeader(context, state->programHeader.ptr, state->programHeader.len)) {
@@ -256,14 +256,14 @@
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 (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;
@@ -299,6 +299,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";
@@ -308,6 +313,13 @@
}
}
+/**
+ * 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;
@@ -353,6 +365,7 @@
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++;
@@ -371,9 +384,15 @@
/* parsing parameters */
-
+/**
+ * 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) {
- token_t token;
+ scpi_token_t token;
lex_state_t * state;
int32_t value;
@@ -383,7 +402,7 @@
parameter->number.base = 10;
parameter->number.unit = SCPI_UNIT_NONE;
parameter->number.type = SCPI_NUM_NUMBER;
- parameter->type = TokUnknown;
+ parameter->type = SCPI_TOKEN_UNKNOWN;
state = &context->param_list.lex_state;
@@ -392,13 +411,13 @@
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, &token);
+ if (token.type != SCPI_TOKEN_COMMA) {
SCPI_ErrorPush(context, SCPI_ERROR_INVALID_SEPARATOR);
return FALSE;
}
@@ -406,48 +425,48 @@
context->input_count++;
- parseProgramData(&context->param_list.lex_state, &token);
+ scpiParser_parseProgramData(&context->param_list.lex_state, &token);
parameter->type = token.type;
parameter->data.ptr = token.ptr;
parameter->data.len = token.len;
switch (token.type) {
- case TokHexnum:
+ case SCPI_TOKEN_HEXNUM:
parameter->number.base = 16;
strToLong(token.ptr, &value, 16);
parameter->number.value = value;
return TRUE;
- case TokOctnum:
+ case SCPI_TOKEN_OCTNUM:
parameter->number.base = 8;
strToLong(token.ptr, &value, 8);
parameter->number.value = value;
return TRUE;
- case TokBinnum:
+ case SCPI_TOKEN_BINNUM:
parameter->number.base = 2;
strToLong(token.ptr, &value, 2);
parameter->number.value = value;
return TRUE;
- case TokProgramMnemonic:
+ case SCPI_TOKEN_PROGRAM_MNEMONIC:
return TRUE;
- case TokDecimalNumericProgramData:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
strToDouble(token.ptr, ¶meter->number.value);
return TRUE;
- case TokDecimalNumericProgramDataWithSuffix:
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
strToDouble(token.ptr, ¶meter->number.value);
return TRUE;
- case TokArbitraryBlockProgramData:
+ case SCPI_TOKEN_ARBITRARY_BLOCK_PROGRAM_DATA:
return TRUE;
- case TokSingleQuoteProgramData:
+ case SCPI_TOKEN_SINGLE_QUOTE_PROGRAM_DATA:
// TODO: replace double "single qoute"
return TRUE;
- case TokDoubleQuoteProgramData:
+ case SCPI_TOKEN_DOUBLE_QUOTE_PROGRAM_DATA:
// TODO: replace double "double qoute"
return TRUE;
- case TokProgramExpression:
+ case SCPI_TOKEN_PROGRAM_EXPRESSION:
return TRUE;
default:
- parameter->type = TokUnknown;
+ parameter->type = SCPI_TOKEN_UNKNOWN;
parameter->data.ptr = NULL;
parameter->data.len = 0;
SCPI_ErrorPush(context, SCPI_ERROR_INVALID_STRING_DATA);
@@ -455,133 +474,269 @@
}
}
-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_DATA_TYPE_ERROR);
- return 0;
- }
-}
-
-double SCPI_ParamGetDoubleVal(scpi_t * context, scpi_parameter_t * parameter) {
- return parameter->number.value;
-}
-
-void SCPI_ParamGetTextVal(scpi_t * context, scpi_parameter_t * parameter, const char ** data, int32_t * len) {
- *data = parameter->data.ptr;
- *len = parameter->data.len;
-}
-
-/* SCPI-99 7.3 Boolean Program Data */
-scpi_bool_t SCPI_ParamGetBoolVal(scpi_t * context, scpi_parameter_t * parameter) {
- switch (parameter->type) {
- case TokDecimalNumericProgramData:
- return parameter->number.value ? 1 : 0;
- case TokProgramMnemonic:
- if (compareStr("ON", 2, parameter->data.ptr, parameter->data.len)) {
- return TRUE;
- } else if (compareStr("OFF", 3, parameter->data.ptr, parameter->data.len)) {
- return FALSE;
- } else {
- SCPI_ErrorPush(context, SCPI_ERROR_ILLEGAL_PARAMETER_VALUE);
- return FALSE;
- }
- default:
- SCPI_ErrorPush(context, SCPI_ERROR_DATA_TYPE_ERROR);
return FALSE;
- }
+ }
}
/**
- * Get choice parameter
+ * Read floating point parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
*/
-int32_t SCPI_ParamGetChoiceVal(scpi_t * context, scpi_parameter_t * parameter, const char * options[]) {
- size_t res;
-
- if (!options) {
- SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
- return -1;
+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;
}
-
- switch(parameter->type) {
- case TokProgramMnemonic:
- for (res = 0; options[res]; ++res) {
- if (matchPattern(options[res], strlen(options[res]), parameter->data.ptr, parameter->data.len)) {
- return res;
- }
- }
- SCPI_ErrorPush(context, SCPI_ERROR_ILLEGAL_PARAMETER_VALUE);
- return -1;
- default:
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
+ if (result) {
+ if (SCPI_ParamIsNumber(¶m, FALSE)) {
+ *value = param.number.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);
- return -1;
+ result = FALSE;
+ }
}
+ return result;
}
-int parseProgramData(lex_state_t * state, token_t * token) {
- token_t tmp;
+/**
+ * Read integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamInt(scpi_t * context, int32_t * value, scpi_bool_t mandatory)
+{
+ // TODO: remove dependency on double
+ double tmpVal;
+ scpi_bool_t result;
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ result = SCPI_ParamDouble(context, &tmpVal, mandatory);
+ if (result) {
+ *value = tmpVal;
+ }
+
+ return result;
+}
+
+/**
+ * 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;
+
+ // TODO: return also parameter type (ProgramMnemonic, ArbitraryBlockProgramData, SingleQuoteProgramData, DoubleQuoteProgramData
+ }
+
+ return result;
+}
+
+/**
+ * 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;
+
+ if (!value) {
+ SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
+ return FALSE;
+ }
+
+ result = SCPI_Parameter(context, ¶m, mandatory);
+
+ if (result) {
+ switch (param.type) {
+ case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
+ *value = param.number.value ? 1 : 0;
+ break;
+ case SCPI_TOKEN_PROGRAM_MNEMONIC:
+ 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;
+}
+
+/**
+ * Read value from list of options
+ * @param context
+ * @param options
+ * @param value
+ * @param mandatory
+ * @return
+ */
+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 == SCPI_TOKEN_PROGRAM_MNEMONIC) {
+ 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;
+ }
+ } else {
+ SCPI_ErrorPush(context, SCPI_ERROR_DATA_TYPE_ERROR);
+ result = FALSE;
+ }
+ }
+
+ 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, 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 = 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;
@@ -599,15 +754,22 @@
return token->len;
}
-static void invalidateToken(token_t * token, const char * ptr) {
+static void invalidateToken(scpi_token_t * token, const char * ptr) {
token->len = 0;
token->ptr = ptr;
- token->type = TokUnknown;
+ token->type = SCPI_TOKEN_UNKNOWN;
}
-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, 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;
@@ -615,11 +777,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);
}
@@ -628,24 +790,24 @@
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);
}
- 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;
--
Gitblit v1.9.1