Initial work on defined names.

.indent.pro

@@ -51,6 +51,7 @@
 -T lxw_content_types
 -T lxw_core
 -T lxw_datetime
+-T lxw_defined_name
 -T lxw_doc_properties
 -T lxw_fill
 -T lxw_font

include/xlsxwriter/workbook.h

@@ -49,8 +49,22 @@
 #include "hash_table.h"
 #include "common.h"
 
-/* Define the queue.h TAILQ structs for the workbook list. */
+/* Define the queue.h structs for the workbook lists. */
 STAILQ_HEAD(lxw_worksheets, lxw_worksheet);
+LIST_HEAD(lxw_defined_names, lxw_defined_name);
+
+#define LXW_DEFINED_NAME_LENGTH 128
+
+/* Struct to represent a defined name. */
+typedef struct lxw_defined_name {
+    int16_t index;
+    uint8_t hidden;
+    char name[LXW_DEFINED_NAME_LENGTH];
+    char range[LXW_DEFINED_NAME_LENGTH];
+
+    /* List pointers for queue.h. */
+    LIST_ENTRY (lxw_defined_name) list_pointers;
+} lxw_defined_name;
 
 /**
  * @brief Errors conditions encountered when closing the Workbook and writing
@@ -91,6 +105,7 @@ typedef struct lxw_workbook {
     FILE *file;
     struct lxw_worksheets *worksheets;
     struct lxw_formats *formats;
+    struct lxw_defined_names *defined_names;
     lxw_sst *sst;
     lxw_doc_properties *properties;
     const char *filename;
@@ -279,6 +294,10 @@ STATIC void _write_sheet(lxw_workbook *self,
 STATIC void _write_sheets(lxw_workbook *self);
 STATIC void _write_calc_pr(lxw_workbook *self);
 
+STATIC void _write_defined_name(lxw_workbook *self,
+                                lxw_defined_name *define_name);
+STATIC void _write_defined_names(lxw_workbook *self);
+
 #endif /* TESTING */
 
 /* *INDENT-OFF* */

src/workbook.c

@@ -31,6 +31,7 @@ _free_workbook(lxw_workbook *workbook)
 {
     lxw_worksheet *worksheet;
     lxw_format *format;
+    lxw_defined_name *defined_name;
 
     if (!workbook)
         return;
@@ -63,10 +64,18 @@ _free_workbook(lxw_workbook *workbook)
         _free_format(format);
     }
 
+    /* Free the defined_names in the workbook. */
+    while (!LIST_EMPTY(workbook->defined_names)) {
+        defined_name = LIST_FIRST(workbook->defined_names);
+        LIST_REMOVE(defined_name, list_pointers);
+        free(defined_name);
+    }
+
     _free_lxw_hash(workbook->used_xf_formats);
     _free_sst(workbook->sst);
     free(workbook->worksheets);
     free(workbook->formats);
+    free(workbook->defined_names);
     free(workbook);
 }
 
@@ -537,6 +546,50 @@ _write_calc_pr(lxw_workbook *self)
     _FREE_ATTRIBUTES();
 }
 
+/*
+ * Write the <definedName> element.
+ */
+STATIC void
+_write_defined_name(lxw_workbook *self, lxw_defined_name *defined_name)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+
+    _INIT_ATTRIBUTES();
+    _PUSH_ATTRIBUTES_STR("name", defined_name->name);
+
+    if (defined_name->index != -1)
+        _PUSH_ATTRIBUTES_INT("localSheetId", defined_name->index);
+
+    if (defined_name->hidden)
+        _PUSH_ATTRIBUTES_INT("hidden", 1);
+
+    _xml_data_element(self->file, "definedName", defined_name->range,
+                      &attributes);
+
+    _FREE_ATTRIBUTES();
+}
+
+/*
+ * Write the <definedNames> element.
+ */
+STATIC void
+_write_defined_names(lxw_workbook *self)
+{
+    lxw_defined_name *defined_name;
+
+    if (LIST_EMPTY(self->defined_names))
+        return;
+
+    _xml_start_tag(self->file, "definedNames", NULL);
+
+    LIST_FOREACH(defined_name, self->defined_names, list_pointers) {
+        _write_defined_name(self, defined_name);
+    }
+
+    _xml_end_tag(self->file, "definedNames");
+}
+
 /*****************************************************************************
  *
  * XML file assembly functions.
@@ -570,6 +623,9 @@ _workbook_assemble_xml_file(lxw_workbook *self)
     /* Write the worksheet names and ids. */
     _write_sheets(self);
 
+    /* Write the workbook defined names. */
+    _write_defined_names(self);
+
     /* Write the workbook calculation properties. */
     _write_calc_pr(self);
 
@@ -616,6 +672,11 @@ new_workbook_opt(const char *filename, lxw_workbook_options *options)
     GOTO_LABEL_ON_MEM_ERROR(workbook->formats, mem_error);
     STAILQ_INIT(workbook->formats);
 
+    /* Add the defined_names list. */
+    workbook->defined_names = calloc(1, sizeof(struct lxw_defined_names));
+    GOTO_LABEL_ON_MEM_ERROR(workbook->defined_names, mem_error);
+    LIST_INIT(workbook->defined_names);
+
     /* Add the shared strings table. */
     workbook->sst = _new_sst();
     GOTO_LABEL_ON_MEM_ERROR(workbook->sst, mem_error);

test/unit/ctest.h

@@ -235,7 +235,7 @@ void assert_str(const char* exp, const char*  real, const char* caller, int line
     if ((exp == NULL && real != NULL) ||
         (exp != NULL && real == NULL) ||
         (exp && real && strcmp(exp, real) != 0)) {
-        CTEST_ERR("%s:%d  expected '%s', got '%s'", caller, line, exp, real);
+        CTEST_ERR("%s:%d\n\texpected '%s',\n\tgot      '%s'", caller, line, exp, real);
     }
 }
 
@@ -244,11 +244,11 @@ void assert_data(const unsigned char* exp, int expsize,
                  const char* caller, int line) {
     int i;
     if (expsize != realsize) {
-        CTEST_ERR("%s:%d  expected %d bytes, got %d", caller, line, expsize, realsize);
+        CTEST_ERR("%s:%d\n\texpected %d bytes,\n\tgot      %d", caller, line, expsize, realsize);
     }
     for (i=0; i<expsize; i++) {
         if (exp[i] != real[i]) {
-            CTEST_ERR("%s:%d expected 0x%02x at offset %d got 0x%02x",
+            CTEST_ERR("%s:%d expected 0x%02x at offset %d\n\tgot      0x%02x",
                 caller, line, exp[i], i, real[i]);
         }
     }
@@ -256,7 +256,7 @@ void assert_data(const unsigned char* exp, int expsize,
 
 void assert_equal(long exp, long real, const char* caller, int line) {
     if (exp != real) {
-        CTEST_ERR("%s:%d  expected %ld, got %ld", caller, line, exp, real);
+        CTEST_ERR("%s:%d\n\texpected %ld,\n\tgot      %ld", caller, line, exp, real);
     }
 }
 
@@ -273,7 +273,7 @@ void assert_double(double exp, double real, const char* caller, int line) {
     double largest = (real > exp) ? real : exp;
 
     if (diff > largest * FLT_EPSILON) {
-        CTEST_ERR("%s:%d  DEXPECTED %g, got %g", caller, line, exp, real);
+        CTEST_ERR("%s:%d  DEXPECTED %g,\n\tgot      %g", caller, line, exp, real);
     }
 }
 

test/unit/workbook/test_workbook_write_defined_name.c

@@ -0,0 +1,32 @@
+/*
+ * Tests for the libxlsxwriter library.
+ *
+ * Copyright 2014, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "../ctest.h"
+#include "../helper.h"
+
+#include "xlsxwriter/workbook.h"
+
+/* Test the _write_defined_name() method. */
+CTEST(workbook, write_defined_name) {
+
+
+    char* got;
+    char exp[] = "<definedName name=\"_xlnm.Print_Titles\" localSheetId=\"0\">Sheet1!$1:$1</definedName>";
+    FILE* testfile = tmpfile();
+    lxw_defined_name defined_name = {0, 0, "_xlnm.Print_Titles", "Sheet1!$1:$1", {NULL, NULL}};
+
+
+    lxw_workbook *workbook = new_workbook(NULL);
+    workbook->file = testfile;
+
+    _write_defined_name(workbook, &defined_name);
+
+    RUN_XLSX_STREQ(exp, got);
+
+    _free_workbook(workbook);
+}
+

test/unit/workbook/test_workbook_write_defined_names.c

@@ -0,0 +1,36 @@
+/*
+ * Tests for the libxlsxwriter library.
+ *
+ * Copyright 2014, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "../ctest.h"
+#include "../helper.h"
+
+#include "xlsxwriter/workbook.h"
+
+/* Test the _write_defined_names() method. */
+CTEST(workbook, write_defined_names) {
+
+
+    char* got;
+    char exp[] = "<definedNames><definedName name=\"_xlnm.Print_Titles\" localSheetId=\"0\">Sheet1!$1:$1</definedName></definedNames>";
+    FILE* testfile = tmpfile();
+    lxw_defined_name *defined_name = calloc(1, sizeof(struct lxw_defined_name));
+
+    strcpy(defined_name->name, "_xlnm.Print_Titles");
+    strcpy(defined_name->range, "Sheet1!$1:$1");
+
+    lxw_workbook *workbook = new_workbook(NULL);
+    workbook->file = testfile;
+
+    LIST_INSERT_HEAD(workbook->defined_names, defined_name, list_pointers);
+
+    _write_defined_names(workbook);
+
+    RUN_XLSX_STREQ(exp, got);
+
+    _free_workbook(workbook);
+}
+