From d98558302ebe1bd0483e83d1602ad32a62320188 Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: 周三, 23 10月 2013 22:42:55 +0800
Subject: [PATCH] Add optional keywords to pattern match
---
libscpi/test/test_scpi_utils.c | 113 ++++++++++++++++++++++
libscpi/src/utils.c | 114 +++++++++++++++++-----
examples/common/scpi-def.c | 20 +++
README.md | 11 +-
4 files changed, 219 insertions(+), 39 deletions(-)
diff --git a/README.md b/README.md
index 0c3b6dc..b71e665 100644
--- a/README.md
+++ b/README.md
@@ -15,13 +15,9 @@
Pattern "SYSTem:VERsion?" mathes strings "SYST:version?", "system:ver?", "SYST:VER?", ...
-SCPI standard also uses brackets "[]" to define unnecesery parts of command. This behaviour is not implemented yet.
+SCPI standard also uses brackets "[]" to define unnecesery parts of command.
- Pattern "SYSTem:ERRor[:NEXT]?" should match "SYST:ERR?", "system:err?" and also "system:error:next?", ...
-
-In current implementation, you should write two patterns to implement this behaviour
-
- Pattern "SYSTem:ERRor?" and "SYSTem:ERRor:NEXT?"
+ Pattern "SYSTem:ERRor[:NEXT]?" mathes "SYST:ERR?", "system:err?" and also "system:error:next?", ...
Command callback
@@ -170,11 +166,14 @@
- `SCPI_ParamNumber` - read double value with or without units or represented by special number (DEF, MIN, MAX, ...). This function is more universal then SCPI_ParamDouble.
- `SCPI_ParamText` - read text value - may be encapsuled in ""
- `SCPI_ParamString` - read unspecified parameter not encapsulated in ""
+ - `SCPI_ParamBool` - read boolean value (ON, OFF, 0, 1)
+ - `SCPI_ParamChoice` - read enumeration value eg. (BUS, IMMediate, EXTernal) defined by parameter
These are the functions, you can use to write results
- `SCPI_ResultInt` - write integer value
- `SCPI_ResultDouble` - write double value
- `SCPI_ResultText` - write text value encapsulated in ""
- `SCPI_ResultString` - directly write string value
+ - `SCPI_ResultBool` - write boolean value
You can use function `SCPI_NumberToStr` to convert number with units to textual representation and then use `SCPI_ResultString` to write this to the user.
\ No newline at end of file
diff --git a/examples/common/scpi-def.c b/examples/common/scpi-def.c
index ea8be8a..6a53644 100644
--- a/examples/common/scpi-def.c
+++ b/examples/common/scpi-def.c
@@ -89,6 +89,19 @@
return SCPI_RES_OK;
}
+scpi_result_t TEST_Bool(scpi_t * context) {
+ bool_t param1;
+ fprintf(stderr, "TEST:BOOL\r\n"); // debug command name
+
+ // read first parameter if present
+ if (!SCPI_ParamBool(context, ¶m1, true)) {
+ return SCPI_RES_ERR;
+ }
+
+ fprintf(stderr, "\tP1=%d\r\n", param1);
+
+ return SCPI_RES_OK;
+}
const char * trigger_source[] = {
"BUS",
@@ -130,8 +143,7 @@
{ .pattern = "*WAI", .callback = SCPI_CoreWai,},
/* Required SCPI commands (SCPI std V1999.0 4.2.1) */
- {.pattern = "SYSTem:ERRor?", .callback = SCPI_SystemErrorNextQ,},
- {.pattern = "SYSTem:ERRor:NEXT?", .callback = SCPI_SystemErrorNextQ,},
+ {.pattern = "SYSTem:ERRor[:NEXT]?", .callback = SCPI_SystemErrorNextQ,},
{.pattern = "SYSTem:ERRor:COUNt?", .callback = SCPI_SystemErrorCountQ,},
{.pattern = "SYSTem:VERSion?", .callback = SCPI_SystemVersionQ,},
@@ -141,8 +153,7 @@
//{.pattern = "STATus:OPERation:ENABle", .callback = scpi_stub_callback,},
//{.pattern = "STATus:OPERation:ENABle?", .callback = scpi_stub_callback,},
- {.pattern = "STATus:QUEStionable?", .callback = SCPI_StatusQuestionableEventQ,},
- {.pattern = "STATus:QUEStionable:EVENt?", .callback = SCPI_StatusQuestionableEventQ,},
+ {.pattern = "STATus:QUEStionable[:EVENt]?", .callback = SCPI_StatusQuestionableEventQ,},
//{.pattern = "STATus:QUEStionable:CONDition?", .callback = scpi_stub_callback,},
{.pattern = "STATus:QUEStionable:ENABle", .callback = SCPI_StatusQuestionableEnable,},
{.pattern = "STATus:QUEStionable:ENABle?", .callback = SCPI_StatusQuestionableEnableQ,},
@@ -163,6 +174,7 @@
{.pattern = "SYSTem:COMMunication:TCPIP:CONTROL?", .callback = SCPI_SystemCommTcpipControlQ,},
+ {.pattern = "TEST:BOOL", .callback = TEST_Bool,},
{.pattern = "TEST:CHOice?", .callback = TEST_ChoiceQ,},
SCPI_CMD_LIST_END
diff --git a/libscpi/src/utils.c b/libscpi/src/utils.c
index 355f9ea..ec3ae7a 100644
--- a/libscpi/src/utils.c
+++ b/libscpi/src/utils.c
@@ -376,15 +376,6 @@
return len;
}
-/**
- * is colon or not
- * @param cmd - command
- * @return
- */
-static bool_t iscolon(char ch) {
- return (':' == ch) ? TRUE : FALSE;
-}
-
/**
* Pattern is composed from upper case an lower case letters. This function
* search the first lowercase letter
@@ -436,7 +427,6 @@
return result;
}
-
/**
* Match pattern and str. Pattern is in format UPPERCASElowercase
* @param pattern
@@ -453,68 +443,134 @@
/**
* Compare pattern and command
- * @param pattern
+ * @param pattern eg. [:MEASure]:VOLTage:DC?
* @param cmd - command
* @param len - max search length
* @return TRUE if pattern matches, FALSE otherwise
*/
bool_t matchCommand(const char * pattern, const char * cmd, size_t len) {
- int result = FALSE;
-
+ bool_t result = FALSE;
+ int leftFlag = 0; // flag for '[' on left
+ int rightFlag = 0; // flag for ']' on right
+ int cmd_sep_pos = 0;
+
const char * pattern_ptr = pattern;
int pattern_len = strlen(pattern);
const char * pattern_end = pattern + pattern_len;
-
+
const char * cmd_ptr = cmd;
size_t cmd_len = SCPI_strnlen(cmd, len);
const char * cmd_end = cmd + cmd_len;
-
- /* TODO: now it is possible to send command ":*IDN?" which is incorrect */
- if (iscolon(cmd_ptr[0])) {
- cmd_len --;
- cmd_ptr ++;
+
+ /* now support optional keywords in pattern style, e.g. [:MEASure]:VOLTage:DC? */
+ if (pattern_ptr[0] == '[') { // skip first '['
+ pattern_len--;
+ pattern_ptr++;
+ leftFlag++;
}
-
+ if (pattern_ptr[0] == ':') { // skip first ':'
+ pattern_len--;
+ pattern_ptr++;
+ }
+
+ if (cmd_ptr[0] == ':') {
+ /* handle errornouse ":*IDN?" */
+ if((cmd_len >= 2) && (cmd_ptr[1] != '*')) {
+ cmd_len--;
+ cmd_ptr++;
+ } else {
+ }
+ }
+
while (1) {
int pattern_sep_pos = patternSeparatorPos(pattern_ptr, pattern_end - pattern_ptr);
- int cmd_sep_pos = cmdSeparatorPos(cmd_ptr, cmd_end - cmd_ptr);
-
+
+ if ((leftFlag > 0) && (rightFlag > 0)) {
+ leftFlag--;
+ rightFlag--;
+ } else {
+ cmd_sep_pos = cmdSeparatorPos(cmd_ptr, cmd_end - cmd_ptr);
+ }
+
if (matchPattern(pattern_ptr, pattern_sep_pos, cmd_ptr, cmd_sep_pos)) {
pattern_ptr = pattern_ptr + pattern_sep_pos;
cmd_ptr = cmd_ptr + cmd_sep_pos;
result = TRUE;
-
+
/* command is complete */
if ((pattern_ptr == pattern_end) && (cmd_ptr >= cmd_end)) {
break;
}
-
+
/* pattern complete, but command not */
if ((pattern_ptr == pattern_end) && (cmd_ptr < cmd_end)) {
result = FALSE;
break;
}
-
+
/* command complete, but pattern not */
if (cmd_ptr >= cmd_end) {
+ if (cmd_end == cmd_ptr) {
+ if (cmd_ptr[0] == pattern_ptr[pattern_end - pattern_ptr - 1]) {
+ break; /* exist optional keyword, command is complete */
+ }
+ if (']' == pattern_ptr[pattern_end - pattern_ptr - 1]) {
+ break; /* exist optional keyword, command is complete */
+ }
+ }
result = FALSE;
break;
}
-
+
/* both command and patter contains command separator at this position */
if ((pattern_ptr[0] == cmd_ptr[0]) && ((pattern_ptr[0] == ':') || (pattern_ptr[0] == '?'))) {
pattern_ptr = pattern_ptr + 1;
cmd_ptr = cmd_ptr + 1;
+ } else if ((pattern_ptr[1] == cmd_ptr[0])
+ && (pattern_ptr[0] == '[')
+ && (pattern_ptr[1] == ':')) {
+ pattern_ptr = pattern_ptr + 2; // for skip '[' in "[:"
+ cmd_ptr = cmd_ptr + 1;
+ leftFlag++;
+ } else if ((pattern_ptr[1] == cmd_ptr[0])
+ && (pattern_ptr[0] == ']')
+ && (pattern_ptr[1] == ':')) {
+ pattern_ptr = pattern_ptr + 2; // for skip ']' in "]:"
+ cmd_ptr = cmd_ptr + 1;
+ } else if ((pattern_ptr[2] == cmd_ptr[0])
+ && (pattern_ptr[0] == ']')
+ && (pattern_ptr[1] == '[')
+ && (pattern_ptr[2] == ':')) {
+ pattern_ptr = pattern_ptr + 3; // for skip '][' in "][:"
+ cmd_ptr = cmd_ptr + 1;
+ leftFlag++;
+ } else if (((pattern_ptr[0] == ']')
+ || (pattern_ptr[0] == '['))
+ && (*(pattern_end - 1) == '?') // last is '?'
+ && (cmd_ptr[0] == '?')) {
+ result = TRUE; // exist optional keyword, and they are end with '?'
+ break; // command is complete OK
} else {
result = FALSE;
break;
}
} else {
- result = FALSE;
- break;
+ pattern_ptr = pattern_ptr + pattern_sep_pos;
+ if ((pattern_ptr[0] == ']') && (pattern_ptr[1] == ':')) {
+ pattern_ptr = pattern_ptr + 2; // for skip ']' in "]:" , pattern_ptr continue, while cmd_ptr remain unchanged
+ rightFlag++;
+ } else if ((pattern_ptr[0] == ']')
+ && (pattern_ptr[1] == '[')
+ && (pattern_ptr[2] == ':')) {
+ pattern_ptr = pattern_ptr + 3; // for skip ']' in "][:" , pattern_ptr continue, while cmd_ptr remain unchanged
+ rightFlag++;
+ } else {
+ result = FALSE;
+ break;
+ }
}
}
-
+
return result;
}
diff --git a/libscpi/test/test_scpi_utils.c b/libscpi/test/test_scpi_utils.c
index 4cfd5a0..f6fd46f 100644
--- a/libscpi/test/test_scpi_utils.c
+++ b/libscpi/test/test_scpi_utils.c
@@ -1,3 +1,32 @@
+/*-
+ * Copyright (c) 2013 Jan Breuer
+ * Richard.hmm
+ * Copyright (c) 2012 Jan Breuer
+ *
+ * All Rights Reserved
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+ * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+ * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
/*
* File: test_scpi_utils.c
* Author: Jan Breuer
@@ -274,6 +303,90 @@
TEST_MATCH_COMMAND("ABc:AACddd", ":abc:aacddd", TRUE);
TEST_MATCH_COMMAND("ABc:AACddd", ":abc:aacdd", FALSE);
TEST_MATCH_COMMAND("ABc:AACddd", ":a:aac", FALSE);
+ TEST_MATCH_COMMAND("?", "?", TRUE);
+ TEST_MATCH_COMMAND("A?", "A?", TRUE);
+ TEST_MATCH_COMMAND("A", "A?", FALSE);
+ TEST_MATCH_COMMAND("A?", "A", FALSE);
+ TEST_MATCH_COMMAND("[:ABc]:AACddd", ":ab:aac", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:AACddd", "aac", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:AACddd", "aac?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:AACddd?", ":ab:aac?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:AACddd?", "aac?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:AACddd?", "aac", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd]:CDe", "ab:bc:cd", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd]:CDe", "ab:cd", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd]:CDe", "ab:cd?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd]:CDe?", "ab:bc:cd?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd]:CDe?", "ab:cd?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd]:CDe?", "ab:cd", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc:BCd[:CDe]", "ab:bc:cd", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc:BCd[:CDe]", "ab:bc", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc:BCd[:CDe]", "ab:bc?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc:BCd[:CDe]?", "ab:bc:cd?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc:BCd[:CDe]?", "ab:bc?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc:BCd[:CDe]?", "ab:bc", FALSE); // test optional keyword
+
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]", "ab:bc:cd", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]", "ab:bc", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]", "bc:cd", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]", "ab:bc?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]", "bc:cd?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]?", "ab:bc:cd?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]?", "ab:bc?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]?", "bc:cd?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]?", "ab:bc", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("[:ABc]:BCd[:CDe]?", "bc:cd", FALSE); // test optional keyword
+
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]", "ab:bc:cd", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]", "ab:bc", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]", "ab:cd", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]", "ab:bc?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]", "ab:cd?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]?", "ab:bc:cd?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]?", "ab:bc?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]?", "ab:cd?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]?", "ab:bc", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe]?", "ab:cd", FALSE); // test optional keyword
+
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:bc:cd:de", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:bc:cd", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:bc:de", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:cd:de", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:bc", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:cd", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:de", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:bc:cd?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:bc:de?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:cd:de?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:bc?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:cd?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab:de?", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]", "ab?", FALSE); // test optional keyword
+
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:bc:cd:de?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:bc:cd?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:bc:de?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:cd:de?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:bc?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:cd?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:de?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab?", TRUE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:bc:cd", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:bc:de", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:cd:de", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:bc", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:cd", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab:de", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("ABc[:BCd][:CDe][:DEf]?", "ab", FALSE); // test optional keyword
+ TEST_MATCH_COMMAND("*IDN?", "idn", FALSE); // common command
+ TEST_MATCH_COMMAND("*IDN?", "idn?", FALSE); // common command
+ TEST_MATCH_COMMAND("*IDN?", "*idn", FALSE); // common command
+ TEST_MATCH_COMMAND("*IDN?", "*idn?", TRUE); // common command
+ TEST_MATCH_COMMAND("*IDN?", ":idn", FALSE); // common command
+ TEST_MATCH_COMMAND("*IDN?", ":idn?", FALSE); // common command
+ TEST_MATCH_COMMAND("*IDN?", ":*idn", FALSE); // common command
+ TEST_MATCH_COMMAND("*IDN?", ":*idn?", FALSE); // common command
}
int main() {
--
Gitblit v1.9.1