Header include/spec.h deleted and its content moved to

the specification compiler template file.

Author: maxim2266

Makefile

@@ -26,13 +26,13 @@ release32 : CFLAGS += -mx32
 SRC = src/parser.c src/scanner.c src/utils.c src/converters.c \
 test/main.c test/scanner_test.c test/parser_test.c test/test_utils.c test/utils_test.c test/$(SPEC).c
 
-HEADERS = include/fix.h include/spec.h include/$(SPEC).h src/fix_impl.h test/test_utils.h
+HEADERS = include/fix.h include/$(SPEC).h src/fix_impl.h test/test_utils.h
 
 $(BIN) : $(SRC) $(HEADERS)
 	$(CC) -o $@ $(CFLAGS) $(SRC)
 
 # clean-up
 .PHONY : clean
 clean :
-	rm -f include/$(SPEC).h src/$(SPEC).c $(BIN)
+	rm -f include/$(SPEC).h test/$(SPEC).c $(BIN)
 

doc/doc.md

@@ -6,7 +6,6 @@ FullFIX is a library for parsing Financial Information eXchange (FIX) messages.
 
 * `include/`
   * `fix.h` - main header file, contains all the data definitions and function declarations;
-  * `spec.h` - some macro definitions to support the compiled specification, should not be used anywhere else.
 * `src/`
   * `scanner.c` - parser, first pass;
   * `parser.c` - parser, second pass;
@@ -16,6 +15,7 @@ FullFIX is a library for parsing Financial Information eXchange (FIX) messages.
 * `test/`: unit tests
 * `tools/`
   * `compile-spec` - FIX specification compiler;
+  * `spec.c.template` - template for specification compiler.
   * `perf-stat` - performance statistics collector.
 * `doc/`
   * `doc.md` - main documentation (this file);
@@ -50,7 +50,7 @@ The same functions can also act as format validators.
 The parser takes raw bytes as input and provides an API for extracting messages one-by-one.
 Each message gets extracted and parsed (steps 1 and 2 above) and returned to the user
 as an efficient `tag->value` mapping. All processing happens in the same thread of execution
-to avoid any synchronisation overhead, especially  when integrating the library into 
+to avoid any synchronisation overhead, especially  when integrating the library into
 an existing software.
 
 ### Data representation

tools/compile-spec

@@ -30,7 +30,7 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 from sys import exit, argv
 import xml.etree.ElementTree as ET
-from os.path import basename, splitext, exists, isdir, join as path_join
+from os.path import basename, splitext, exists, isdir, dirname, join as path_join
 from collections import namedtuple, OrderedDict, deque
 from functools import singledispatch
 from itertools import chain
@@ -64,6 +64,14 @@ def write_file(file_name, fmt, data):
 	except IOError as e:
 		die('Cannot write "{}": {}'.format(file_name, e))
 
+# spec template
+def read_spec_template():
+	try:
+		with open(path_join(dirname(argv[0]), 'spec.c.template')) as f:
+			return f.read()
+	except IOError as e:
+		die('Cannot read template file: ' + str(e))
+
 # data extractors -------------------------------------------------------------------------------------
 # tag types
 RegularTag = namedtuple('RegularTag', ('value', 'data_type'))
@@ -474,45 +482,9 @@ def make_parser_table_body(messages):
 
 	return '\n'.join(s for s in iter_body())
 
-# .c file format
-__c_fmt = \
-'''// AUTOMATICALLY GENERATED FILE - DO NOT EDIT!
-#include <{base_name}.h>
-#include <spec.h>
-
-// empty group info function
-static
-const fix_group_info* empty_group_info_func(const unsigned tag __attribute__((__unused__)))
-{{
-	return NULL;
-}}
-
-// groups ----------------------------------------------------------------------------------------
-{groups}
-
-{common}
-
-// messages --------------------------------------------------------------------------------------
-{messages}
-
-// parser table ----------------------------------------------------------------------------------
-static
-const fix_message_info* {prefix}_parser_table(const fix_string msg_type)
-{{
-	const char* s = msg_type.begin;
-
-	{parser_table}
-}}
-
-// parser constructor ----------------------------------------------------------------------------
-fix_parser* create_{prefix}_parser()
-{{
-	return create_fix_parser({prefix}_parser_table, CONST_LIT("{fix_version}"));
-}}'''
-
 # code generator
 def write_code(name, file_name_base, prefix, fix_version, groups, messages, common):
-	write_file(name, __c_fmt, { \
+	write_file(name, read_spec_template(), { \
 		'base_name'		: file_name_base, \
 		'prefix'		: prefix, \
 		'fix_version'	: fix_version, \

include/spec.h tools/spec.c.templateinclude/spec.h renamed to tools/spec.c.template

@@ -26,7 +26,9 @@ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
-#pragma once
+// AUTOMATICALLY GENERATED FILE - DO NOT EDIT!
+
+#include <{base_name}.h>
 
 // macro to support compiled specification
 #define NONE ((unsigned)-1)
@@ -47,63 +49,93 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 // group --------------------------------------------------------------------------------------
 #define TAG_INFO_FUNC(name)	\
 static unsigned name ## _tag_info_func(const unsigned tag)	\
-{	\
+{{	\
 	switch(tag)	\
-	{
+	{{
 
 #define END_TAG_INFO	\
 		default: return NONE;	\
-	}	\
-}
+	}}	\
+}}
 
 #define GROUP_INFO_FUNC(name)	\
 static const fix_group_info* name ## _group_info_func(const unsigned tag)	\
-{	\
+{{	\
 	switch(tag)	\
-	{
+	{{
 
 #define GROUP_INFO(len_tag_name, group_name)	\
 	case len_tag_name: return &group_name ## _group_info;
 
 #define END_GROUP_INFO	\
 		default: return NULL;	\
-	}	\
-}
+	}}	\
+}}
 
 #define GROUP_INFO_STRUCT(name, node_size, first_tag)	\
 static const fix_group_info	\
-name ## _group_info = { (node_size), (first_tag), name ## _tag_info_func, name ## _group_info_func };
+name ## _group_info = {{ (node_size), (first_tag), name ## _tag_info_func, name ## _group_info_func }};
 
 #define EMPTY_GROUP_INFO(name, node_size, first_tag)	\
 static const fix_group_info	\
-name ## _group_info = { (node_size), (first_tag), name ## _tag_info_func, empty_group_info_func };
+name ## _group_info = {{ (node_size), (first_tag), name ## _tag_info_func, empty_group_info_func }};
 
 // message ---------------------------------------------------------------------------------------
 #define MESSAGE_TAG_INFO_FUNC		TAG_INFO_FUNC
 
 #define END_MESSAGE_TAG_INFO	\
 		default: return common_tag_info_func(tag);	\
-	}	\
-}
+	}}	\
+}}
 
 #define MESSAGE_GROUP_INFO_FUNC	GROUP_INFO_FUNC
 
 #define END_MESSAGE_GROUP_INFO	\
 		default: return common_group_info_func(tag);	\
-	}	\
-}
+	}}	\
+}}
 
 #define MESSAGE_GROUP_INFO_STRUCT(name, node_size)	\
 static const fix_message_info	\
-name ## _message_info = { { (node_size), 0, name ## _tag_info_func, name ## _group_info_func }, name };
+name ## _message_info = {{ {{ (node_size), 0, name ## _tag_info_func, name ## _group_info_func }}, name }};
 
 #define EMPTY_MESSAGE_GROUP_INFO(name, node_size)	\
 static const fix_message_info	\
-name ## _message_info = { { (node_size), 0, name ## _tag_info_func, common_group_info_func }, name };
+name ## _message_info = {{ {{ (node_size), 0, name ## _tag_info_func, common_group_info_func }}, name }};
 
 // parser table ----------------------------------------------------------------------------------
 #define RETURN_MESSAGE(name)	\
 	return &name ## _message_info
 
 #define RETURN_MESSAGE_OR_NULL(name)	\
 	return *s == SOH ? &name ## _message_info : NULL
+
+// empty group info function --------------------------------------------------------------------
+static
+const fix_group_info* empty_group_info_func(const unsigned tag __attribute__((__unused__)))
+{{
+	return NULL;
+}}
+
+// groups ----------------------------------------------------------------------------------------
+{groups}
+
+{common}
+
+// messages --------------------------------------------------------------------------------------
+{messages}
+
+// parser table ----------------------------------------------------------------------------------
+static
+const fix_message_info* {prefix}_parser_table(const fix_string msg_type)
+{{
+	const char* s = msg_type.begin;
+
+	{parser_table}
+}}
+
+// parser constructor ----------------------------------------------------------------------------
+fix_parser* create_{prefix}_parser()
+{{
+	return create_fix_parser({prefix}_parser_table, CONST_LIT("{fix_version}"));
+}}