From 6acc53b725ddd75772ea5f0777b2dcabf1583b50 Mon Sep 17 00:00:00 2001
From: Iztok Jeras <iztok.jeras@redpitaya.com>
Date: ćšć, 08 10æ 2015 03:00:34 +0800
Subject: [PATCH] integer parser: make buffer sizes more explicit, as sum of bitlength and NULL termination
---
libscpi/src/parser.c | 257 ++++++++++++++++++++++++++++++++++++++++++++------
1 files changed, 224 insertions(+), 33 deletions(-)
diff --git a/libscpi/src/parser.c b/libscpi/src/parser.c
index ef779bc..494ff70 100644
--- a/libscpi/src/parser.c
+++ b/libscpi/src/parser.c
@@ -153,7 +153,7 @@
for (i = 0; context->cmdlist[i].pattern != NULL; i++) {
cmd = &context->cmdlist[i];
- if (matchCommand(cmd->pattern, header, len, NULL, 0)) {
+ if (matchCommand(cmd->pattern, header, len, NULL, 0, 0)) {
context->param_list.cmd = cmd;
return TRUE;
}
@@ -317,13 +317,43 @@
}
/**
- * Write integer value to the result
+ * Write signed 32 bit integer value to the result
* @param context
* @param val
* @return
*/
-size_t SCPI_ResultInt(scpi_t * context, int32_t val) {
- return SCPI_ResultIntBase(context, val, 10);
+size_t SCPI_ResultInt32(scpi_t * context, int32_t val) {
+ return SCPI_ResultInt32Base(context, val, 10);
+}
+
+/**
+ * Write unsigned 32 bit integer value to the result
+ * @param context
+ * @param val
+ * @return
+ */
+size_t SCPI_ResultUInt32(scpi_t * context, uint32_t val) {
+ return SCPI_ResultUInt32Base(context, val, 10);
+}
+
+/**
+ * Write signed 64 bit integer value to the result
+ * @param context
+ * @param val
+ * @return
+ */
+size_t SCPI_ResultInt64(scpi_t * context, int64_t val) {
+ return SCPI_ResultInt64Base(context, val, 10);
+}
+
+/**
+ * Write unsigned 64 bit integer value to the result
+ * @param context
+ * @param val
+ * @return
+ */
+size_t SCPI_ResultUInt64(scpi_t * context, uint64_t val) {
+ return SCPI_ResultUInt64Base(context, val, 10);
}
/**
@@ -341,19 +371,19 @@
}
/**
- * Write integer value in specific base to the result
+ * Write signed 32 bit 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];
+size_t SCPI_ResultInt32Base(scpi_t * context, int32_t val, int8_t base) {
+ char buffer[32+1];
const char * basePrefix;
size_t result = 0;
size_t len;
- len = SCPI_LongToStr(val, buffer, sizeof (buffer), base);
+ len = SCPI_Int32ToStr(val, buffer, sizeof (buffer), base);
basePrefix = getBasePrefix(base);
result += writeDelimiter(context);
@@ -366,7 +396,82 @@
}
/**
- * Write double walue to the result
+ * Write unsigned 32 bit integer value in specific base to the result
+ * @param context
+ * @param val
+ * @param base
+ * @return
+ */
+size_t SCPI_ResultUInt32Base(scpi_t * context, uint32_t val, int8_t base) {
+ char buffer[32+1];
+ const char * basePrefix;
+ size_t result = 0;
+ size_t len;
+
+ len = SCPI_UInt32ToStr(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;
+}
+
+/**
+ * Write signed 64 bit integer value in specific base to the result
+ * @param context
+ * @param val
+ * @param base
+ * @return
+ */
+size_t SCPI_ResultInt64Base(scpi_t * context, int64_t val, int8_t base) {
+ char buffer[64+1];
+ const char * basePrefix;
+ size_t result = 0;
+ size_t len;
+
+ len = SCPI_Int64ToStr(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;
+}
+
+/**
+ * Write unsigned 64 bit integer value in specific base to the result
+ * @param context
+ * @param val
+ * @param base
+ * @return
+ */
+size_t SCPI_ResultUInt64Base(scpi_t * context, uint64_t val, int8_t base) {
+ char buffer[64+1];
+ const char * basePrefix;
+ size_t result = 0;
+ size_t len;
+
+ len = SCPI_UInt64ToStr(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;
+}
+
+/**
+ * Write double value to the result
* @param context
* @param val
* @return
@@ -411,10 +516,10 @@
char block_header[12];
size_t header_len;
block_header[0] = '#';
- SCPI_LongToStr(len, block_header + 2, 10, 10);
+ SCPI_Int32ToStr(len, block_header + 2, 10, 10);
header_len = strlen(block_header + 2);
- block_header[1] = header_len + '0';
+ block_header[1] = (char)(header_len + '0');
result += writeData(context, block_header, header_len + 2);
result += writeData(context, data, len);
@@ -430,7 +535,7 @@
* @return
*/
size_t SCPI_ResultBool(scpi_t * context, scpi_bool_t val) {
- return SCPI_ResultIntBase(context, val ? 1 : 0, 10);
+ return SCPI_ResultInt32Base(context, val ? 1 : 0, 10);
}
/* parsing parameters */
@@ -526,13 +631,13 @@
}
/**
- * Convert parameter to integer
+ * Convert parameter to signed/unsigned 32 bit 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) {
+static scpi_bool_t ParamToInt32(scpi_t * context, scpi_parameter_t * parameter, int32_t * value, scpi_bool_t sign) {
if (!value) {
SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
@@ -541,16 +646,43 @@
switch (parameter->type) {
case SCPI_TOKEN_HEXNUM:
- return strToLong(parameter->ptr, value, 16) > 0 ? TRUE : FALSE;
+ return strToUInt32(parameter->ptr, (uint32_t *)value, 16) > 0 ? TRUE : FALSE;
case SCPI_TOKEN_OCTNUM:
- return strToLong(parameter->ptr, value, 8) > 0 ? TRUE : FALSE;
+ return strToUInt32(parameter->ptr, (uint32_t *)value, 8) > 0 ? TRUE : FALSE;
case SCPI_TOKEN_BINNUM:
- return strToLong(parameter->ptr, value, 2) > 0 ? TRUE : FALSE;
+ return strToUInt32(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:
- return strToLong(parameter->ptr, value, 10) > 0 ? TRUE : FALSE;
+ if (sign) {
+ return strToInt32(parameter->ptr, value, 10) > 0 ? TRUE : FALSE;
+ } else {
+ return strToUInt32(parameter->ptr, (uint32_t *)value, 10) > 0 ? TRUE : FALSE;
+ }
+ default:
+ return FALSE;
}
- return FALSE;
+}
+
+/**
+ * Convert parameter to signed 32 bit integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToInt32(scpi_t * context, scpi_parameter_t * parameter, int32_t * value) {
+ return ParamToInt32(context, parameter, value, TRUE);
+}
+
+/**
+ * Convert parameter to unsigned 32 bit integer
+ * @param context
+ * @param parameter
+ * @param value result
+ * @return TRUE if succesful
+ */
+scpi_bool_t SCPI_ParamToUInt32(scpi_t * context, scpi_parameter_t * parameter, uint32_t * value) {
+ return ParamToInt32(context, parameter, (int32_t *)value, FALSE);
}
/**
@@ -560,9 +692,10 @@
* @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;
- int32_t valint;
+ scpi_bool_t result;
+ uint32_t valint;
if (!value) {
SCPI_ErrorPush(context, SCPI_ERROR_SYSTEM_ERROR);
@@ -573,13 +706,15 @@
case SCPI_TOKEN_HEXNUM:
case SCPI_TOKEN_OCTNUM:
case SCPI_TOKEN_BINNUM:
- result = SCPI_ParamToInt(context, parameter, &valint);
+ result = SCPI_ParamToUInt32(context, parameter, &valint);
*value = valint;
break;
case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA:
case SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX:
result = strToDouble(parameter->ptr, value) > 0 ? TRUE : FALSE;
break;
+ default:
+ result = FALSE;
}
return result;
}
@@ -616,13 +751,13 @@
}
/**
- * Read integer parameter
+ * Read signed/unsigned 32 bit integer parameter
* @param context
* @param value
* @param mandatory
* @return
*/
-scpi_bool_t SCPI_ParamInt(scpi_t * context, int32_t * value, scpi_bool_t mandatory) {
+static scpi_bool_t ParamInt32(scpi_t * context, int32_t * value, scpi_bool_t mandatory, scpi_bool_t sign) {
scpi_bool_t result;
scpi_parameter_t param;
@@ -634,7 +769,7 @@
result = SCPI_Parameter(context, ¶m, mandatory);
if (result) {
if (SCPI_ParamIsNumber(¶m, FALSE)) {
- SCPI_ParamToInt(context, ¶m, value);
+ result = ParamToInt32(context, ¶m, value, sign);
} else if (SCPI_ParamIsNumber(¶m, TRUE)) {
SCPI_ErrorPush(context, SCPI_ERROR_SUFFIX_NOT_ALLOWED);
result = FALSE;
@@ -644,6 +779,28 @@
}
}
return result;
+}
+
+/**
+ * Read signed 32 bit integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamInt32(scpi_t * context, int32_t * value, scpi_bool_t mandatory) {
+ return ParamInt32(context, value, mandatory, TRUE);
+}
+
+/**
+ * Read unsigned 32 bit integer parameter
+ * @param context
+ * @param value
+ * @param mandatory
+ * @return
+ */
+scpi_bool_t SCPI_ParamUInt32(scpi_t * context, uint32_t * value, scpi_bool_t mandatory) {
+ return ParamInt32(context, (int32_t *)value, mandatory, FALSE);
}
/**
@@ -665,8 +822,17 @@
result = SCPI_Parameter(context, ¶m, mandatory);
if (result) {
- *value = param.ptr;
- *len = param.len;
+ 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
}
@@ -724,7 +890,7 @@
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++) {
+ for (i_from = 1, i_to = 0; i_from < (size_t) (param.len - 1); i_from++) {
if (i_from >= buffer_len) {
break;
}
@@ -733,6 +899,10 @@
if (param.ptr[i_from] == quote) {
i_from++;
}
+ }
+ *copy_len = i_to;
+ if (i_to < buffer_len) {
+ buffer[i_to] = 0;
}
break;
default:
@@ -827,7 +997,7 @@
if (result) {
if (param.type == SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA) {
- SCPI_ParamToInt(context, ¶m, &intval);
+ SCPI_ParamToInt32(context, ¶m, &intval);
*value = intval ? TRUE : FALSE;
} else {
result = SCPI_ParamToChoice(context, ¶m, bool_options, &intval);
@@ -1021,7 +1191,7 @@
}
pattern = context->param_list.cmd->pattern;
- return matchCommand (pattern, cmd, strlen (cmd), NULL, 0);
+ return matchCommand (pattern, cmd, strlen (cmd), NULL, 0, 0);
}
/**
@@ -1038,9 +1208,30 @@
}
scpi_bool_t SCPI_Match(const char * pattern, const char * value, size_t len) {
- return matchCommand (pattern, value, len, NULL, 0);
+ return matchCommand (pattern, value, len, NULL, 0, 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);
+scpi_bool_t SCPI_CommandNumbers(scpi_t * context, int32_t * numbers, size_t len, int32_t default_value) {
+ return matchCommand (context->param_list.cmd->pattern, context->param_list.cmd_raw.data, context->param_list.cmd_raw.length, numbers, len, default_value);
+}
+
+/**
+ * If SCPI_Parameter() returns FALSE, this function can detect, if the parameter
+ * is just missing (TRUE) or if there was an error during processing of the command (FALSE)
+ * @param parameter
+ * @return
+ */
+scpi_bool_t SCPI_ParamIsValid(scpi_parameter_t * parameter)
+{
+ return parameter->type == SCPI_TOKEN_UNKNOWN ? FALSE : TRUE;
+}
+
+/**
+ * Returns TRUE if there was an error during parameter handling
+ * @param context
+ * @return
+ */
+scpi_bool_t SCPI_ParamErrorOccurred(scpi_t * context)
+{
+ return context->cmd_error;
}
--
Gitblit v1.9.1