Many changes and fixes in here, still TODO comments

I think it is time for a little reorganization, but on top of that this
branch and commit aims to:

* Fix enumeration generation
* Add in a better framework for handling options and different version
which need generating.
* Add new utility functions

There will be a few other tasks such as:

* Bring up code to coding standards
* Add in more comments to the generated code (asking for donations,
pointing to product website, etc.)
* Updated MPC library
* Implement/Fix TODOs

Author: howerj

2c.c

@@ -862,21 +862,65 @@ static int switch_function_print(FILE *c, dbc_t *dbc, bool prototype, const char
 	return fprintf(c, "\treturn -1; \n}\n\n");
 }
 
-static void msg2h_define_can_ids(dbc_t *dbc, FILE *h) {
+// TODO: Define enums as well/instead of.
+/* NB. We should really use these enum names instead of the msg->id */
+static void msg2h_define_can_ids(dbc_t *dbc, FILE *h, dbc2c_options_t *copts) {
+	assert(dbc);
+	assert(h);
+	assert(copts);
+
+	if (dbc->message_count == 0)
+		return;
+
+	const int ens = copts->generate_enum_can_ids;
+
+	if (ens) {
+		fprintf(h, "enum {\n"); // TODO: Typedef
+	}
 	for (size_t i = 0; i < dbc->message_count; i++) {
-		char* name = duplicate(dbc->messages[i]->name);
+		can_msg_t *msg = dbc->messages[i];
+		char *name = duplicate(msg->name);
 
 		for (size_t i = 0; name[i] != 0; i++)
 			name[i] = toupper(name[i]);
-
-		fprintf(h, "#define CAN_ID_%s %lu\n", name, dbc->messages[i]->id);
+		if (ens) {
+			fprintf(h, "\tCAN_ID_%s = %lu, /* 0x%lx */\n", name, msg->id, msg->id);
+		} else {
+			fprintf(h, "#define CAN_ID_%s (%lu) /* 0x%lx */\n", name, msg->id, msg->id);
+		}
 
 		free(name);
 	}
+	if (ens) {
+		fprintf(h, "};\n");
+	}
 
 	fprintf(h, "\n");
 }
 
+static char *escape_string(const char *s, int upper) {
+	const size_t max_char_len = 4;
+	const size_t l = strlen(s) * max_char_len + 1;
+	char *n = allocate(l);
+	int ch = 0;
+	for (size_t i = 0, j = 0; (ch = s[i]); i++) {
+		assert(j < l);
+		ch = ch == ' ' ? '_' : ch;
+		if (!isalnum(ch) && ch != '_') {
+
+			sprintf(&n[j], "_%02x_", ch);
+			j += max_char_len;
+		} else {
+			if (upper > 0)
+				ch = toupper(ch);
+			if (upper < 0)
+				ch = tolower(ch);
+			n[j++] = ch;
+		}
+	}
+	return n;
+}
+
 static int msg2h_types(dbc_t *dbc, FILE *h, dbc2c_options_t *copts)
 {
 	assert(h);
@@ -901,24 +945,32 @@ static int msg2h_types(dbc_t *dbc, FILE *h, dbc2c_options_t *copts)
 			signal_t* signal = msg->sigs[i];
 			val_list_t *list = signal->val_list;
 
-			if (list == NULL)
+			if (!list)
 				continue;
 
+			/* We really should use enum values in generated C codes/as types */
 			fprintf(h, "typedef enum {\n");
 			for (size_t j = 0; j < list->val_list_item_count; j++) {
 				val_list_item_t *item = list->val_list_items[j];
 
-				char enum_value_name[MAX_NAME_LENGTH] = {0};
-
-				if (copts->version >= 2)
-					snprintf(enum_value_name, MAX_NAME_LENGTH-1, "%s_%s_%s", name, list->name, item->name);
-				else
-					fprintf(h, "\t%s_%s_e = %d,\n", list->name, item->name, item->value);
-
-				for (int i = 0;enum_value_name[i] != 0;i++) 
-					enum_value_name[i] = toupper(enum_value_name[i]);
+				int r = 0;
+
+				if (copts->version >= 2) {
+					char *ename = escape_string(item->name, 0);
+					if (strlen(ename) != strlen(item->name))
+						warning("Non C-Ident characters in enumeration generation: '%s' -> '%s'", item->name, ename);
+					char enum_value_name[MAX_NAME_LENGTH] = { 0, };
+					r = snprintf(enum_value_name, MAX_NAME_LENGTH-1, "%s_%s_%s", name, list->name, ename);
+					for (int i = 0; enum_value_name[i]; i++) 
+						enum_value_name[i] = toupper(enum_value_name[i]);
+					fprintf(h, "\t%s = %d,\n", enum_value_name, item->value);
+					free(ename);
+				} else {
+					r = fprintf(h, "\t%s_%s_e = %d,\n", list->name, item->name, item->value);
+				}
+				if (r < 0)
+					error("output failed");
 
-				fprintf(h, "\t%s = %d,\n", enum_value_name, item->value);
 			}
 
 			if (copts->version >= 2)
@@ -999,7 +1051,7 @@ int dbc2c(dbc_t *dbc, FILE *c, FILE *h, const char *name, dbc2c_options_t *copts
 		"/* If the contents of this file have caused breaking changes for you, you could try using\n"
 		"   an older version of the generator. You can specify this on the command line with\n"
 		"   the -n option. */\n"
-		"#define DBCC_GENERATOR_VERSION %i\n\n"
+		"#define DBCC_GENERATOR_VERSION (%d)\n\n"
 		"#include <stdint.h>\n"
 		"%s\n\n"
 		"#ifdef __cplusplus\n"
@@ -1032,7 +1084,7 @@ int dbc2c(dbc_t *dbc, FILE *c, FILE *h, const char *name, dbc2c_options_t *copts
 	fprintf(h, "} dbcc_signal_status_e;\n");
 	fprintf(h, "#endif\n\n");
 
-	msg2h_define_can_ids(dbc, h);
+	msg2h_define_can_ids(dbc, h, copts);
 
 	if (msg2h_types(dbc, h, copts) < 0) {
 		rv = -1;

2c.h

@@ -14,6 +14,7 @@ typedef struct {
 	bool use_doubles_for_encoding;
 	bool generate_print, generate_pack, generate_unpack;
 	bool generate_asserts;
+	bool generate_enum_can_ids;
 	int version;
 } dbc2c_options_t;
 

2csv.c

@@ -32,7 +32,7 @@ static int msg2csv(can_msg_t *msg, FILE *o)
 		}
 
 		/* "MSG, ID, DLC, Signal, Start, Length, Endianess, Scaling, Offset, Minimum, Maximum, Signed, Units, Multiplexed */
-		fprintf(o, "%s, %lu, %u, ", msg->name, msg->id, msg->dlc);
+		fprintf(o, "%s, %lu, %u, ", msg->name, msg->id | ((unsigned long)msg->is_extended << 31) , msg->dlc);
 		fprintf(o, "%s, ", sig->name);
 		fprintf(o, "%u, ", sig->start_bit);
 		fprintf(o, "%u, ", sig->bit_length);

2json.c

@@ -104,9 +104,10 @@ static int msg2json(can_msg_t *msg, FILE *o, unsigned depth)
 	assert(o);
 	indent(o, depth);
 	fprintf(o, "{\n");
-	pfield(o, depth+1, false, STRING, "name", "%s", msg->name);
-	pfield(o, depth+1, false, INT,    "id",   "%u", msg->id);
-	pfield(o, depth+1, false, INT,    "dlc",  "%u", msg->dlc);
+	pfield(o, depth+1, false, STRING, "name",      "%s", msg->name);
+	pfield(o, depth+1, false, INT,    "id",        "%u", msg->id);
+	pfield(o, depth+1, false, BOOL,   "extended",  "%s", msg->is_extended ? "true" : "false");
+	pfield(o, depth+1, false, INT,    "dlc",       "%u", msg->dlc);
 
 	signal_t *multiplexor = NULL;
 	indent(o, depth+1);

2xml.c

@@ -136,6 +136,7 @@ static int msg2xml(can_msg_t *msg, FILE *o, unsigned depth)
 	pnode(o, depth+1, "name", "%s", msg->name);
 	pnode(o, depth+1, "id",   "%u", msg->id);
 	pnode(o, depth+1, "dlc",  "%u", msg->dlc);
+	pnode(o, depth+1, "extended",  "%d", (int)msg->is_extended);
 
 	signal_t *multiplexor = NULL;
 	for (size_t i = 0; i < msg->signal_count; i++) {

can.c

@@ -239,6 +239,19 @@ static can_msg_t *ast2msg(mpc_ast_t *top, mpc_ast_t *ast, dbc_t *dbc)
 	r = sscanf(id->contents,  "%lu", &c->id);
 	assert(r == 1);
 
+	/* Extended CAN messages use the top most bit (which should
+	 * not normally be set) to indicate that they are extended
+	 * and not normal messages. */
+
+	// TODO: Handle version generation
+	//if (copt->version >= 3 || copt->feature_mask_ids) {
+		const uint32_t msk = 0x80000000u;
+		if (c->id & 0x80000000u) {
+			c->is_extended = true;
+			c->id &= ~msk;
+		}
+	//}
+
 	signal_t **signal_s = allocate(sizeof(*signal_s));
 	size_t len = 1, j = 0;
 	for (int i = 0; i >= 0;) {

can.h

@@ -64,6 +64,7 @@ typedef struct {
 	size_t signal_count; /**< number of signals */
 	unsigned dlc;        /**< length of CAN message 0-8 bytes */
 	unsigned long id;    /**< identifier, 11 or 29 bit */
+	bool is_extended;    /**< is extended mode message (29bit) */
 	char *comment;
 } can_msg_t;
 
@@ -73,6 +74,7 @@ typedef struct {
 	can_msg_t **messages; /**< list of messages */
 	size_t val_count;     /**< count of vals */
 	val_list_t **vals;    /**< value list; used for enumerations in DBC file */
+	int version;          /**< version information used for generating files (not just C) */
 } dbc_t;
 
 dbc_t *ast2dbc(mpc_ast_t *ast);

dbcc.xsd

@@ -30,6 +30,7 @@
         <xs:element name="id" type="can-id"/>
         <!-- 11 or 29 bit CAN ID -->
         <xs:element name="dlc" type="dlc"/>
+        <xs:element maxOccurs="1" minOccurs="0" name="extended" type="intBool"/>
         <xs:element minOccurs="0" maxOccurs="unbounded" ref="signal"/>
         <xs:element maxOccurs="1" minOccurs="0" ref="multiplexor-group"/>
       </xs:sequence>
@@ -131,4 +132,10 @@
       <xs:maxInclusive value="64"/>
     </xs:restriction>
   </xs:simpleType>
+  <xs:simpleType name="intBool">
+    <xs:restriction base="xs:integer">
+      <xs:minInclusive value="0"/>
+      <xs:maxInclusive value="1"/>
+    </xs:restriction>
+  </xs:simpleType>
 </xs:schema>

dbcc.xslt

@@ -16,6 +16,7 @@
             <th>Message</th>
             <th>Id. (decimal)</th>
             <th>DLC</th>
+            <th>Extended</th>
             <th>Signals</th>
           </tr>
           <xsl:apply-templates select="message">
@@ -48,6 +49,7 @@
       <td> <xsl:value-of select="name"/> </td>
       <td> <xsl:value-of select="id"/> </td>
       <td> <xsl:value-of select="dlc"/> </td>
+      <td> <xsl:value-of select="extended"/> </td>
       <td>
         <xsl:apply-templates select="signal" mode="signal-name">
           <xsl:sort select="name"/>

double_signal.dbc

@@ -1,35 +1,35 @@
-VERSION "HIPBNYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY/4/%%%/4/'%**4YYY///"
-
-
-NS_ : 
-	NS_DESC_
-	CM_
-	BA_DEF_
-	BA_
-	VAL_
-	CAT_DEF_
-	CAT_
-	FILTER
-	BA_DEF_DEF_
-	EV_DATA_
-	ENVVAR_DATA_
-	SGTYPE_
-	SGTYPE_VAL_
-	BA_DEF_SGTYPE_
-	BA_SGTYPE_
-	SIG_TYPE_REF_
-	VAL_TABLE_
-	SIG_GROUP_
-	SIG_VALTYPE_
-	SIGTYPE_VALTYPE_
-
-BS_:
-
-BU_: NewNode0
-
-
-BO_ 1024 NewMessage0: 8 NewNode0
- SG_ DoubleSignal0 : 0|64@1- (1,0) [0|0] "" Vector__XXX
-
-
-SIG_VALTYPE_ 1024 DoubleSignal0 : 2;
+VERSION "HIPBNYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY/4/%%%/4/'%**4YYY///"
+
+
+NS_ : 
+	NS_DESC_
+	CM_
+	BA_DEF_
+	BA_
+	VAL_
+	CAT_DEF_
+	CAT_
+	FILTER
+	BA_DEF_DEF_
+	EV_DATA_
+	ENVVAR_DATA_
+	SGTYPE_
+	SGTYPE_VAL_
+	BA_DEF_SGTYPE_
+	BA_SGTYPE_
+	SIG_TYPE_REF_
+	VAL_TABLE_
+	SIG_GROUP_
+	SIG_VALTYPE_
+	SIGTYPE_VALTYPE_
+
+BS_:
+
+BU_: NewNode0
+
+
+BO_ 1024 NewMessage0: 8 NewNode0
+ SG_ DoubleSignal0 : 0|64@1- (1,0) [0|0] "" Vector__XXX
+
+
+SIG_VALTYPE_ 1024 DoubleSignal0 : 2;

enum.dbc

@@ -0,0 +1,84 @@
+VERSION ""
+
+
+NS_ : 
+	NS_DESC_
+	CM_
+	BA_DEF_
+	BA_
+	VAL_
+	CAT_DEF_
+	CAT_
+	FILTER
+	BA_DEF_DEF_
+	EV_DATA_
+	ENVVAR_DATA_
+	SGTYPE_
+	SGTYPE_VAL_
+	BA_DEF_SGTYPE_
+	BA_SGTYPE_
+	SIG_TYPE_REF_
+	VAL_TABLE_
+	SIG_GROUP_
+	SIG_VALTYPE_
+	SIGTYPE_VALTYPE_
+	BO_TX_BU_
+	BA_DEF_REL_
+	BA_REL_
+	BA_DEF_DEF_REL_
+	BU_SG_REL_
+	BU_EV_REL_
+	BU_BO_REL_
+	SG_MUL_VAL_
+
+BS_:
+
+BU_: Destination IVT_30_Node
+
+
+BO_ 2147483938 IVT_SleepAck: 1 IVT_30_Node
+ SG_ IVT_SleepAck : 0|4@1- (1,0) [0|0] ""  Destination
+
+BO_ 3 IVT_Ctrl: 8 Destination
+ SG_ IVT_Ctrl_Fuse_State : 13|1@1+ (1,0) [0|0] ""  IVT_30_Node
+
+BO_ 1 enum1: 8 Destination
+ SG_ state : 0|4@1+ (1,0) [0|0] ""  A_node
+
+BO_ 4 enum2: 8 Destination
+ SG_ state : 0|4@1+ (1,0) [0|0] ""  A_node
+
+
+CM_ BO_ 2147483938 "Control message 1.";
+CM_ SG_ 2147483938 IVT_SleepAck "cm 1";
+CM_ BO_ 3 "Control message 2.";
+CM_ SG_ 3 IVT_Ctrl_Fuse_State "cm 1";
+BA_DEF_  "Version" STRING ;
+BA_DEF_  "SyncJumpWidthMin" INT 1 4;
+BA_DEF_  "SyncJumpWidthMax" INT 1 4;
+BA_DEF_  "SamplePointMin" INT 1 100;
+BA_DEF_  "SamplePointMax" INT 1 100;
+BA_DEF_ SG_  "GenSigStartValue" INT -2147483648 2147483647;
+BA_DEF_  "Baudrate" INT 250000 1000000;
+BA_DEF_  "BusType" STRING ;
+BA_DEF_ BO_  "GenMsgCycleTime" INT 0 65535;
+BA_DEF_DEF_  "Version" "1_1_0_Released";
+BA_DEF_DEF_  "SyncJumpWidthMin" 1;
+BA_DEF_DEF_  "SyncJumpWidthMax" 1;
+BA_DEF_DEF_  "SamplePointMin" 1;
+BA_DEF_DEF_  "SamplePointMax" 1;
+BA_DEF_DEF_  "GenSigStartValue" 0;
+BA_DEF_DEF_  "Baudrate" 500000;
+BA_DEF_DEF_  "BusType" "CAN";
+BA_DEF_DEF_  "GenMsgCycleTime" 0;
+BA_ "SyncJumpWidthMin" 2;
+BA_ "SyncJumpWidthMax" 4;
+BA_ "SamplePointMin" 80;
+BA_ "SamplePointMax" 84;
+BA_ "Baudrate" 500000;
+BA_ "BusType" "CAN";
+BA_ "GenMsgCycleTime" BO_ 3 100;
+VAL_ 1 state 0 "Inactive" 1 "Active";
+VAL_ 2 state 3 "OFF" 4 "ON";
+VAL_ 3 IVT_Ctrl_Fuse_State 1 "Fuse+ AND Fuse- closed" 0 "Fuse+ OR Fuse- open";
+VAL_ 2147483938 IVT_SleepAck 15 "reserved 15" 14 "reserved 14" 13 "reserved 13" 12 "reserved 12" 11 "reserved 11" 10 "reserved 10" 9 "reserved 9" 8 "reserved 8" 7 "reserved 7" 6 "reserved 6" 5 "reserved 5" 4 "reserved 4" 3 "reserved 3" 2 "reserved 2" 1 "Sleep request acknowledged" 0 "Sleep request not acknowledged";