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 | 599 +++++++++++++++++++++++++++++++++++++++++++---------------- 1 files changed, 437 insertions(+), 162 deletions(-) diff --git a/libscpi/src/parser.c b/libscpi/src/parser.c index 2f95fe7..d7f5eee 100644 --- a/libscpi/src/parser.c +++ b/libscpi/src/parser.c @@ -168,7 +168,7 @@ 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)) { @@ -258,12 +258,12 @@ while (1) { 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,8 +365,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] = '#'; + 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; } @@ -369,21 +406,35 @@ return SCPI_ResultIntBase(context, val ? 1 : 0, 10); } - /* 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, const 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 +442,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) { - scpiLex_Comma(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 +457,126 @@ context->input_count++; - scpiParser_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 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); + 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 + */ +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)) { - *value = param.number.value; + SCPI_ParamToDouble(context, ¶m, value); } else if (SCPI_ParamIsNumber(¶m, TRUE)) { SCPI_ErrorPush(context, SCPI_ERROR_SUFFIX_NOT_ALLOWED); result = FALSE; @@ -491,110 +585,90 @@ 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 integer parameter + * @param context + * @param value + * @param mandatory + * @return + */ +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; } - - result = SCPI_ParamDouble(context, &tmpVal, mandatory); + + result = SCPI_Parameter(context, ¶m, mandatory); if (result) { - *value = tmpVal; + 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; + } } - return result; } -scpi_bool_t SCPI_ParamCharacters(scpi_t * context, const char ** value, size_t * len, scpi_bool_t mandatory) -{ +/** + * 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) { + *value = param.ptr; + *len = param.len; // 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,6 +678,172 @@ 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; +} + +/** + * 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; @@ -621,7 +861,7 @@ 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; } } @@ -636,6 +876,13 @@ return result + realLen; } +/** + * 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; @@ -643,7 +890,7 @@ int paramCount = 0; token->len = -1; - token->type = TokAllProgramData; + token->type = SCPI_TOKEN_ALL_PROGRAM_DATA; token->ptr = state->pos; @@ -651,17 +898,17 @@ token->len += result; if (result == 0) { - token->type = TokUnknown; + token->type = SCPI_TOKEN_UNKNOWN; token->len = 0; paramCount = -1; break; } result = scpiParser_parseProgramData(state, &tmp); - if (tmp.type != TokUnknown) { + 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,12 +926,13 @@ return token->len; } -static void invalidateToken(scpi_token_t * token, const char * ptr) { - token->len = 0; - token->ptr = ptr; - token->type = TokUnknown; -} - +/** + * 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; scpi_token_t tmp; @@ -715,23 +963,50 @@ 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) { + 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