Skip to content

output_xml: add SAMPLE_EVENT_STRING to events table and guard array access #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikeller merged 2 commits into from
Sep 12, 2026
Merged

output_xml: add SAMPLE_EVENT_STRING to events table and guard array access #135

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2aea4df
output_xml: add SAMPLE_EVENT_STRING to events table and guard array a…
mikeller Sep 10, 2026
37e69fa
xml: cast char to unsigned char before fputc to avoid UB
mikeller Sep 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions examples/output_xml.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,21 @@
#include "output-private.h"
#include "utils.h"

// AI-generated (Claude)
// Write a string to a FILE, replacing XML special characters with entities.
static void
xml_escape_text (FILE *ostream, const char *s)
{
for (; *s; s++) {
switch (*s) {
case '&': fputs ("&", ostream); break;
case '<': fputs ("&lt;", ostream); break;
case '>': fputs ("&gt;", ostream); break;
default: fputc ((unsigned char)*s, ostream); break;
}
}
}

static dc_status_t dctool_xml_output_write (dctool_output_t *output, dc_parser_t *parser, const unsigned char data[], unsigned int size, const unsigned char fingerprint[], unsigned int fsize);
static dc_status_t dctool_xml_output_free (dctool_output_t *output);

Expand Down Expand Up @@ -98,7 +113,7 @@ sample_cb (dc_sample_type_t type, const dc_sample_value_t *value, void *userdata
"safety stop (voluntary)", "safety stop (mandatory)", "deepstop",
"ceiling (safety stop)", "floor", "divetime", "maxdepth",
"OLF", "PO2", "airtime", "rgbm", "heading", "tissue level warning",
"gaschange2"};
"gaschange2", "string"};
static const char *decostop[] = {
"ndl", "safety", "deco", "deep"};

Expand Down Expand Up @@ -134,8 +149,17 @@ sample_cb (dc_sample_type_t type, const dc_sample_value_t *value, void *userdata
break;
case DC_SAMPLE_EVENT:
if (value->event.type != SAMPLE_EVENT_GASCHANGE && value->event.type != SAMPLE_EVENT_GASCHANGE2) {
fprintf (sampledata->ostream, " <event type=\"%u\" time=\"%u\" flags=\"%u\" value=\"%u\">%s</event>\n",
value->event.type, value->event.time, value->event.flags, value->event.value, events[value->event.type]);
fprintf (sampledata->ostream, " <event type=\"%u\" time=\"%u\" flags=\"%u\" value=\"%u\">",
value->event.type, value->event.time, value->event.flags, value->event.value);
if (value->event.type == SAMPLE_EVENT_STRING && value->event.name != NULL) {
// event.name is device-supplied text; XML-escape it before emitting.
xml_escape_text (sampledata->ostream, value->event.name);
} else if (value->event.type < sizeof (events) / sizeof (events[0])) {
fputs (events[value->event.type], sampledata->ostream);
} else {
fputs ("unknown", sampledata->ostream);
}
fputs ("</event>\n", sampledata->ostream);
}
break;
case DC_SAMPLE_RBT:
Expand Down