wayne roberts / libscpi

https://github.com/j123b567/scpi-parser

Dependents:   scpi_sx127x scpi_sx127x_firstTest MLX90418_I2C_master

inc/scpi/parser.h@1:b497f235115a, 2015-08-07 (annotated)

Committer:
dudmuck
Date:
Fri Aug 07 21:54:11 2015 +0000
Revision:
1:b497f235115a
Parent:
0:aad43948c45c 
update from github commit 6e5e3e0e3fc450eaf53feee059824ad85c4f270d

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dudmuck 0:aad43948c45c 1 /*-
dudmuck 0:aad43948c45c 2 * Copyright (c) 2012-2013 Jan Breuer,
dudmuck 0:aad43948c45c 3 *
dudmuck 0:aad43948c45c 4 * All Rights Reserved
dudmuck 0:aad43948c45c 5 *
dudmuck 0:aad43948c45c 6 * Redistribution and use in source and binary forms, with or without
dudmuck 0:aad43948c45c 7 * modification, are permitted provided that the following conditions are
dudmuck 0:aad43948c45c 8 * met:
dudmuck 0:aad43948c45c 9 * 1. Redistributions of source code must retain the above copyright notice,
dudmuck 0:aad43948c45c 10 * this list of conditions and the following disclaimer.
dudmuck 0:aad43948c45c 11 * 2. Redistributions in binary form must reproduce the above copyright
dudmuck 0:aad43948c45c 12 * notice, this list of conditions and the following disclaimer in the
dudmuck 0:aad43948c45c 13 * documentation and/or other materials provided with the distribution.
dudmuck 0:aad43948c45c 14 *
dudmuck 0:aad43948c45c 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
dudmuck 0:aad43948c45c 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
dudmuck 0:aad43948c45c 17 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
dudmuck 0:aad43948c45c 18 * DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
dudmuck 0:aad43948c45c 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
dudmuck 0:aad43948c45c 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
dudmuck 0:aad43948c45c 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
dudmuck 0:aad43948c45c 22 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
dudmuck 0:aad43948c45c 23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
dudmuck 0:aad43948c45c 24 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
dudmuck 0:aad43948c45c 25 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
dudmuck 0:aad43948c45c 26 */
dudmuck 0:aad43948c45c 27
dudmuck 0:aad43948c45c 28 /**
dudmuck 0:aad43948c45c 29 * @file scpi_parser.h
dudmuck 0:aad43948c45c 30 * @date Thu Nov 15 10:58:45 UTC 2012
dudmuck 0:aad43948c45c 31 *
dudmuck 0:aad43948c45c 32 * @brief SCPI parser implementation
dudmuck 0:aad43948c45c 33 *
dudmuck 0:aad43948c45c 34 *
dudmuck 0:aad43948c45c 35 */
dudmuck 0:aad43948c45c 36
dudmuck 0:aad43948c45c 37 #ifndef SCPI_PARSER_H
dudmuck 0:aad43948c45c 38 #define SCPI_PARSER_H
dudmuck 0:aad43948c45c 39
dudmuck 1:b497f235115a 40 #include <string.h>
dudmuck 0:aad43948c45c 41 #include "scpi/types.h"
dudmuck 0:aad43948c45c 42
dudmuck 0:aad43948c45c 43 #ifdef __cplusplus
dudmuck 0:aad43948c45c 44 extern "C" {
dudmuck 0:aad43948c45c 45 #endif
dudmuck 0:aad43948c45c 46 void SCPI_Init(scpi_t * context);
dudmuck 0:aad43948c45c 47
dudmuck 1:b497f235115a 48 int SCPI_Input(scpi_t * context, const char * data, int len);
dudmuck 1:b497f235115a 49 int SCPI_Parse(scpi_t * context, char * data, int len);
dudmuck 1:b497f235115a 50
dudmuck 0:aad43948c45c 51
dudmuck 1:b497f235115a 52 size_t SCPI_ResultCharacters(scpi_t * context, const char * data, size_t len);
dudmuck 1:b497f235115a 53 #define SCPI_ResultMnemonic(context, data) SCPI_ResultCharacters((context), (data), strlen(data))
dudmuck 0:aad43948c45c 54 size_t SCPI_ResultInt(scpi_t * context, int32_t val);
dudmuck 1:b497f235115a 55 size_t SCPI_ResultIntBase(scpi_t * context, int32_t val, int8_t base);
dudmuck 0:aad43948c45c 56 size_t SCPI_ResultDouble(scpi_t * context, double val);
dudmuck 0:aad43948c45c 57 size_t SCPI_ResultText(scpi_t * context, const char * data);
dudmuck 1:b497f235115a 58 size_t SCPI_ResultArbitraryBlock(scpi_t * context, const char * data, size_t len);
dudmuck 0:aad43948c45c 59 size_t SCPI_ResultBool(scpi_t * context, scpi_bool_t val);
dudmuck 1:b497f235115a 60
dudmuck 1:b497f235115a 61 scpi_bool_t SCPI_Parameter(scpi_t * context, scpi_parameter_t * parameter, scpi_bool_t mandatory);
dudmuck 1:b497f235115a 62 scpi_bool_t SCPI_ParamIsNumber(scpi_parameter_t * parameter, scpi_bool_t suffixAllowed);
dudmuck 1:b497f235115a 63 scpi_bool_t SCPI_ParamToInt(scpi_t * context, scpi_parameter_t * parameter, int32_t * value);
dudmuck 1:b497f235115a 64 scpi_bool_t SCPI_ParamToDouble(scpi_t * context, scpi_parameter_t * parameter, double * value);
dudmuck 1:b497f235115a 65 scpi_bool_t SCPI_ParamToChoice(scpi_t * context, scpi_parameter_t * parameter, const scpi_choice_def_t * options, int32_t * value);
dudmuck 1:b497f235115a 66 scpi_bool_t SCPI_ChoiceToName(const scpi_choice_def_t * options, int32_t tag, const char ** text);
dudmuck 1:b497f235115a 67
dudmuck 0:aad43948c45c 68
dudmuck 0:aad43948c45c 69 scpi_bool_t SCPI_ParamInt(scpi_t * context, int32_t * value, scpi_bool_t mandatory);
dudmuck 0:aad43948c45c 70 scpi_bool_t SCPI_ParamDouble(scpi_t * context, double * value, scpi_bool_t mandatory);
dudmuck 1:b497f235115a 71 scpi_bool_t SCPI_ParamCharacters(scpi_t * context, const char ** value, size_t * len, scpi_bool_t mandatory);
dudmuck 1:b497f235115a 72 scpi_bool_t SCPI_ParamArbitraryBlock(scpi_t * context, const char ** value, size_t * len, scpi_bool_t mandatory);
dudmuck 1:b497f235115a 73 scpi_bool_t SCPI_ParamCopyText(scpi_t * context, char * buffer, size_t buffer_len, size_t * copy_len, scpi_bool_t mandatory);
dudmuck 1:b497f235115a 74
dudmuck 0:aad43948c45c 75 scpi_bool_t SCPI_ParamBool(scpi_t * context, scpi_bool_t * value, scpi_bool_t mandatory);
dudmuck 1:b497f235115a 76 scpi_bool_t SCPI_ParamChoice(scpi_t * context, const scpi_choice_def_t * options, int32_t * value, scpi_bool_t mandatory);
dudmuck 0:aad43948c45c 77
dudmuck 1:b497f235115a 78 scpi_bool_t SCPI_IsCmd(scpi_t * context, const char * cmd);
dudmuck 1:b497f235115a 79 int32_t SCPI_CmdTag(scpi_t * context);
dudmuck 1:b497f235115a 80 scpi_bool_t SCPI_Match(const char * pattern, const char * value, size_t len);
dudmuck 1:b497f235115a 81 scpi_bool_t SCPI_CommandNumbers(scpi_t * context, int32_t * numbers, size_t len);
dudmuck 0:aad43948c45c 82
dudmuck 0:aad43948c45c 83 #ifdef __cplusplus
dudmuck 0:aad43948c45c 84 }
dudmuck 0:aad43948c45c 85 #endif
dudmuck 0:aad43948c45c 86
dudmuck 0:aad43948c45c 87 #endif /* SCPI_PARSER_H */