sola/scpi-parser.git

			@@ -1,28 +1,29 @@
			/*-
			* Copyright (c) 2012-2013 Jan Breuer,
			* BSD 2-Clause License
			*
			* All Rights Reserved
			* Copyright (c) 2012-2018, 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.
			* modification, are permitted provided that the following conditions are met:
			*
			* 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.
			* * Redistributions of source code must retain the above copyright notice, this
			* list of conditions and the following disclaimer.
			*
			* * 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER 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.
			*/

			/**
			@@ -222,7 +223,7 @@
			/* place undefined header with error */
			/* calculate length of errornouse header and trim \r\n */
			size_t r2 = r;
			while(r2 > 0 && (data[r2 - 1] == '\r' \|\| data[r2 - 1] == '\n')) r2--;
			while (r2 > 0 && (data[r2 - 1] == '\r' \|\| data[r2 - 1] == '\n')) r2--;
			SCPI_ErrorPushEx(context, SCPI_ERROR_UNDEFINED_HEADER, data, r2);
			result = FALSE;
			}
			@@ -246,9 +247,17 @@
			/**
			* Initialize SCPI context structure
			* @param context
			* @param command_list
			* @param buffer
			* @param commands
			* @param interface
			* @param units
			* @param idn1
			* @param idn2
			* @param idn3
			* @param idn4
			* @param input_buffer
			* @param input_buffer_length
			* @param error_queue_data
			* @param error_queue_size
			*/
			void SCPI_Init(scpi_t * context,
			const scpi_command_t * commands,
			@@ -256,8 +265,7 @@
			const scpi_unit_def_t * units,
			const char * idn1, const char * idn2, const char * idn3, const char * idn4,
			char * input_buffer, size_t input_buffer_length,
			scpi_error_t * error_queue_data, int16_t error_queue_size,
			char * error_info_heap, size_t error_info_heap_length) {
			scpi_error_t * error_queue_data, int16_t error_queue_size) {
			memset(context, 0, sizeof (*context));
			context->cmdlist = commands;
			context->interface = interface;
			@@ -269,13 +277,23 @@
			context->buffer.data = input_buffer;
			context->buffer.length = input_buffer_length;
			context->buffer.position = 0;
			context->error_info_heap.data = error_info_heap;
			context->error_info_heap.wr = 0;
			context->error_info_heap.size = error_info_heap_length;
			context->error_info_heap.count = context->error_info_heap.size;
			memset(context->error_info_heap.data, 0, context->error_info_heap.size);
			SCPI_ErrorInit(context, error_queue_data, error_queue_size);
			}

			#if USE_DEVICE_DEPENDENT_ERROR_INFORMATION && !USE_MEMORY_ALLOCATION_FREE

			/**
			* Initialize context's
			* @param context
			* @param data
			* @param len
			* @return
			*/
			void SCPI_InitHeap(scpi_t * context,
			char * error_info_heap, size_t error_info_heap_length) {
			scpiheap_init(&context->error_info_heap, error_info_heap, error_info_heap_length);
			}
			#endif

			/**
			* Interface to the application. Adds data to system buffer and try to search
			@@ -577,10 +595,6 @@
			}
			result += writeData(context, "\"", 1);

			#if USE_DEVICE_DEPENDENT_ERROR_INFORMATION
			SCPIDEFINE_free(&context->error_info_heap, error->device_dependent_info, false);
			#endif

			return result;
			}

			@@ -686,7 +700,7 @@
			if (mandatory) {
			SCPI_ErrorPush(context, SCPI_ERROR_MISSING_PARAMETER);
			} else {
			parameter->type = SCPI_TOKEN_PROGRAM_MNEMONIC; // TODO: select something different
			parameter->type = SCPI_TOKEN_PROGRAM_MNEMONIC; /* TODO: select something different */
			}
			return FALSE;
			}
			@@ -1121,7 +1135,7 @@
			break;
			}

			// TODO: return also parameter type (ProgramMnemonic, ArbitraryBlockProgramData, SingleQuoteProgramData, DoubleQuoteProgramData
			/* TODO: return also parameter type (ProgramMnemonic, ArbitraryBlockProgramData, SingleQuoteProgramData, DoubleQuoteProgramData */
			}

			return result;
			@@ -1257,6 +1271,15 @@
			return FALSE;
			}

			/*
			* Definition of BOOL choice list
			*/
			const scpi_choice_def_t scpi_bool_def[] = {
			{"OFF", 0},
			{"ON", 1},
			SCPI_CHOICE_LIST_END /* termination of option list */
			};

			/**
			* Read BOOL parameter (0,1,ON,OFF)
			* @param context
			@@ -1268,12 +1291,6 @@
			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);
			@@ -1287,7 +1304,7 @@
			SCPI_ParamToInt32(context, &param, &intval);
			*value = intval ? TRUE : FALSE;
			} else {
			result = SCPI_ParamToChoice(context, &param, bool_options, &intval);
			result = SCPI_ParamToChoice(context, &param, scpi_bool_def, &intval);
			if (result) {
			*value = intval ? TRUE : FALSE;
			}
			@@ -1533,7 +1550,7 @@
			* @param format
			* @return
			*/
			static size_t parserResultArrayBinary(scpi_t * context, const void * array, size_t count, size_t item_size, scpi_array_format_t format) {
			static size_t produceResultArrayBinary(scpi_t * context, const void * array, size_t count, size_t item_size, scpi_array_format_t format) {

			if (SCPI_GetNativeFormat() == format) {
			switch (item_size) {
			@@ -1598,7 +1615,7 @@
			result += func(context, array[i]);\
			}\
			} else {\
			result = parserResultArrayBinary(context, array, count, sizeof(*array), format);\
			result = produceResultArrayBinary(context, array, count, sizeof(*array), format);\
			}\
			return result;\
			} while(0)
			@@ -1722,3 +1739,95 @@
			size_t SCPI_ResultArrayDouble(scpi_t * context, const double * array, size_t count, scpi_array_format_t format) {
			RESULT_ARRAY(SCPI_ResultDouble);
			}

			/*
			* Template macro to generate all SCPI_ParamArrayXYZ function
			*/
			#define PARAM_ARRAY_TEMPLATE(func) do{\
			if (format != SCPI_FORMAT_ASCII) return FALSE;\
			for (o_count = 0; o_count < i_count; (*o_count)++) {\
			if (!func(context, &data[*o_count], mandatory)) {\
			break;\
			}\
			mandatory = FALSE;\
			}\
			return mandatory ? FALSE : TRUE;\
			}while(0)

			/**
			* Read list of values up to i_count
			* @param context
			* @param data - array to fill
			* @param i_count - number of elements of data
			* @param o_count - real number of filled elements
			* @param mandatory
			* @return TRUE on success
			*/
			scpi_bool_t SCPI_ParamArrayInt32(scpi_t * context, int32_t data, size_t i_count, size_t o_count, scpi_array_format_t format, scpi_bool_t mandatory) {
			PARAM_ARRAY_TEMPLATE(SCPI_ParamInt32);
			}

			/**
			* Read list of values up to i_count
			* @param context
			* @param data - array to fill
			* @param i_count - number of elements of data
			* @param o_count - real number of filled elements
			* @param mandatory
			* @return TRUE on success
			*/
			scpi_bool_t SCPI_ParamArrayUInt32(scpi_t * context, uint32_t data, size_t i_count, size_t o_count, scpi_array_format_t format, scpi_bool_t mandatory) {
			PARAM_ARRAY_TEMPLATE(SCPI_ParamUInt32);
			}

			/**
			* Read list of values up to i_count
			* @param context
			* @param data - array to fill
			* @param i_count - number of elements of data
			* @param o_count - real number of filled elements
			* @param mandatory
			* @return TRUE on success
			*/
			scpi_bool_t SCPI_ParamArrayInt64(scpi_t * context, int64_t data, size_t i_count, size_t o_count, scpi_array_format_t format, scpi_bool_t mandatory) {
			PARAM_ARRAY_TEMPLATE(SCPI_ParamInt64);
			}

			/**
			* Read list of values up to i_count
			* @param context
			* @param data - array to fill
			* @param i_count - number of elements of data
			* @param o_count - real number of filled elements
			* @param mandatory
			* @return TRUE on success
			*/
			scpi_bool_t SCPI_ParamArrayUInt64(scpi_t * context, uint64_t data, size_t i_count, size_t o_count, scpi_array_format_t format, scpi_bool_t mandatory) {
			PARAM_ARRAY_TEMPLATE(SCPI_ParamUInt64);
			}

			/**
			* Read list of values up to i_count
			* @param context
			* @param data - array to fill
			* @param i_count - number of elements of data
			* @param o_count - real number of filled elements
			* @param mandatory
			* @return TRUE on success
			*/
			scpi_bool_t SCPI_ParamArrayFloat(scpi_t * context, float data, size_t i_count, size_t o_count, scpi_array_format_t format, scpi_bool_t mandatory) {
			PARAM_ARRAY_TEMPLATE(SCPI_ParamFloat);
			}

			/**
			* Read list of values up to i_count
			* @param context
			* @param data - array to fill
			* @param i_count - number of elements of data
			* @param o_count - real number of filled elements
			* @param mandatory
			* @return TRUE on success
			*/
			scpi_bool_t SCPI_ParamArrayDouble(scpi_t * context, double data, size_t i_count, size_t o_count, scpi_array_format_t format, scpi_bool_t mandatory) {
			PARAM_ARRAY_TEMPLATE(SCPI_ParamDouble);
			}