xlsxwriter 0.2.1.pre → 0.2.2

data/ext/xlsxwriter/libxlsxwriter/src/format.c

@@ -3,7 +3,7 @@
  *
  * Used in conjunction with the libxlsxwriter library.
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  */
 
@@ -27,9 +27,11 @@ lxw_format_new(void)
     GOTO_LABEL_ON_MEM_ERROR(format, mem_error);
 
     format->xf_format_indices = NULL;
+    format->dxf_format_indices = NULL;
 
     format->xf_index = LXW_PROPERTY_UNSET;
     format->dxf_index = LXW_PROPERTY_UNSET;
+    format->xf_id = 0;
 
     format->font_name[0] = '\0';
     format->font_scheme[0] = '\0';
@@ -42,7 +44,7 @@ lxw_format_new(void)
     format->bold = LXW_FALSE;
     format->italic = LXW_FALSE;
     format->font_color = LXW_COLOR_UNSET;
-    format->underline = LXW_FALSE;
+    format->underline = LXW_UNDERLINE_NONE;
     format->font_strikeout = LXW_FALSE;
     format->font_outline = LXW_FALSE;
     format->font_shadow = LXW_FALSE;
@@ -51,7 +53,7 @@ lxw_format_new(void)
     format->font_charset = LXW_FALSE;
     format->font_condense = LXW_FALSE;
     format->font_extend = LXW_FALSE;
-    format->theme = LXW_FALSE;
+    format->theme = 0;
     format->hyperlink = LXW_FALSE;
 
     format->hidden = LXW_FALSE;
@@ -116,18 +118,6 @@ lxw_format_free(lxw_format *format)
     format = NULL;
 }
 
-/*
- * Check a user input color.
- */
-lxw_color_t
-lxw_format_check_color(lxw_color_t color)
-{
-    if (color == LXW_COLOR_UNSET)
-        return color;
-    else
-        return color & LXW_COLOR_MASK;
-}
-
 /*
  * Check a user input border.
  */
@@ -160,7 +150,9 @@ _get_format_key(lxw_format *self)
 
     /* Set pointer members to NULL since they aren't part of the comparison. */
     key->xf_format_indices = NULL;
+    key->dxf_format_indices = NULL;
     key->num_xf_formats = NULL;
+    key->num_dxf_formats = NULL;
     key->list_pointers.stqe_next = NULL;
 
     return key;
@@ -182,8 +174,9 @@ lxw_format_get_font_key(lxw_format *self)
     key->font_size = self->font_size;
     key->bold = self->bold;
     key->italic = self->italic;
-    key->font_color = self->font_color;
     key->underline = self->underline;
+    key->theme = self->theme;
+    key->font_color = self->font_color;
     key->font_strikeout = self->font_strikeout;
     key->font_outline = self->font_outline;
     key->font_shadow = self->font_shadow;
@@ -296,6 +289,57 @@ lxw_format_get_xf_index(lxw_format *self)
     }
 }
 
+/*
+ * Returns the DXF index number used by Excel to identify a format.
+ */
+int32_t
+lxw_format_get_dxf_index(lxw_format *self)
+{
+    lxw_format *format_key;
+    lxw_format *existing_format;
+    lxw_hash_element *hash_element;
+    lxw_hash_table *formats_hash_table = self->dxf_format_indices;
+    int32_t index;
+
+    /* Note: The formats_hash_table/dxf_format_indices contains the unique and
+     * more importantly the *used* formats in the workbook.
+     */
+
+    /* Format already has an index number so return it. */
+    if (self->dxf_index != LXW_PROPERTY_UNSET) {
+        return self->dxf_index;
+    }
+
+    /* Otherwise, the format doesn't have an index number so we assign one.
+     * First generate a unique key to identify the format in the hash table.
+     */
+    format_key = _get_format_key(self);
+
+    /* Return the default format index if the key generation failed. */
+    if (!format_key)
+        return 0;
+
+    /* Look up the format in the hash table. */
+    hash_element =
+        lxw_hash_key_exists(formats_hash_table, format_key,
+                            sizeof(lxw_format));
+
+    if (hash_element) {
+        /* Format matches existing format with an index. */
+        free(format_key);
+        existing_format = hash_element->value;
+        return existing_format->dxf_index;
+    }
+    else {
+        /* New format requiring an index. */
+        index = formats_hash_table->unique_count;
+        self->dxf_index = index;
+        lxw_insert_hash_element(formats_hash_table, format_key, self,
+                                sizeof(lxw_format));
+        return index;
+    }
+}
+
 /*
  * Set the font_name property.
  */
@@ -322,7 +366,7 @@ format_set_font_size(lxw_format *self, double size)
 void
 format_set_font_color(lxw_format *self, lxw_color_t color)
 {
-    self->font_color = lxw_format_check_color(color);
+    self->font_color = color;
 }
 
 /*
@@ -508,7 +552,7 @@ format_set_pattern(lxw_format *self, uint8_t value)
 void
 format_set_bg_color(lxw_format *self, lxw_color_t color)
 {
-    self->bg_color = lxw_format_check_color(color);
+    self->bg_color = color;
 }
 
 /*
@@ -517,7 +561,7 @@ format_set_bg_color(lxw_format *self, lxw_color_t color)
 void
 format_set_fg_color(lxw_format *self, lxw_color_t color)
 {
-    self->fg_color = lxw_format_check_color(color);
+    self->fg_color = color;
 }
 
 /*
@@ -539,7 +583,6 @@ format_set_border(lxw_format *self, uint8_t style)
 void
 format_set_border_color(lxw_format *self, lxw_color_t color)
 {
-    color = lxw_format_check_color(color);
     self->bottom_color = color;
     self->top_color = color;
     self->left_color = color;
@@ -561,7 +604,7 @@ format_set_bottom(lxw_format *self, uint8_t style)
 void
 format_set_bottom_color(lxw_format *self, lxw_color_t color)
 {
-    self->bottom_color = lxw_format_check_color(color);
+    self->bottom_color = color;
 }
 
 /*
@@ -579,7 +622,7 @@ format_set_left(lxw_format *self, uint8_t style)
 void
 format_set_left_color(lxw_format *self, lxw_color_t color)
 {
-    self->left_color = lxw_format_check_color(color);
+    self->left_color = color;
 }
 
 /*
@@ -597,7 +640,7 @@ format_set_right(lxw_format *self, uint8_t style)
 void
 format_set_right_color(lxw_format *self, lxw_color_t color)
 {
-    self->right_color = lxw_format_check_color(color);
+    self->right_color = color;
 }
 
 /*
@@ -615,7 +658,7 @@ format_set_top(lxw_format *self, uint8_t style)
 void
 format_set_top_color(lxw_format *self, lxw_color_t color)
 {
-    self->top_color = lxw_format_check_color(color);
+    self->top_color = color;
 }
 
 /*
@@ -634,7 +677,7 @@ format_set_diag_type(lxw_format *self, uint8_t type)
 void
 format_set_diag_color(lxw_format *self, lxw_color_t color)
 {
-    self->diag_color = lxw_format_check_color(color);
+    self->diag_color = color;
 }
 
 /*
@@ -726,3 +769,33 @@ format_set_theme(lxw_format *self, uint8_t value)
 {
     self->theme = value;
 }
+
+/*
+ * Set the color_indexed property.
+ */
+void
+format_set_color_indexed(lxw_format *self, uint8_t value)
+{
+    self->color_indexed = value;
+}
+
+/*
+ * Set the font_only property.
+ */
+void
+format_set_font_only(lxw_format *self)
+{
+    self->font_only = LXW_TRUE;
+}
+
+/*
+ * Set the theme property.
+ */
+void
+format_set_hyperlink(lxw_format *self)
+{
+    self->hyperlink = LXW_TRUE;
+    self->xf_id = 1;
+    self->underline = LXW_UNDERLINE_SINGLE;
+    self->theme = 10;
+}

data/ext/xlsxwriter/libxlsxwriter/src/hash_table.c

@@ -3,7 +3,7 @@
  *
  * Used in conjunction with the libxlsxwriter library.
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  */
 

data/ext/xlsxwriter/libxlsxwriter/src/packager.c

@@ -3,7 +3,7 @@
  *
  * Used in conjunction with the libxlsxwriter library.
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  */
 
@@ -18,6 +18,10 @@ STATIC lxw_error _add_file_to_zip(lxw_packager *self, FILE * file,
 STATIC lxw_error _add_buffer_to_zip(lxw_packager *self, unsigned char *buffer,
                                     size_t buffer_size, const char *filename);
 
+STATIC lxw_error _write_vml_drawing_rels_file(lxw_packager *self,
+                                              lxw_worksheet *worksheet,
+                                              uint32_t index);
+
 /*
  * Forward declarations.
  */
@@ -247,7 +251,7 @@ _write_image_files(lxw_packager *self)
     lxw_workbook *workbook = self->workbook;
     lxw_sheet *sheet;
     lxw_worksheet *worksheet;
-    lxw_image_options *image;
+    lxw_object_properties *object_props;
     lxw_error err;
     FILE *image_stream;
 
@@ -260,21 +264,25 @@ _write_image_files(lxw_packager *self)
         else
             worksheet = sheet->u.worksheet;
 
-        if (STAILQ_EMPTY(worksheet->image_data))
+        if (STAILQ_EMPTY(worksheet->image_props))
             continue;
 
-        STAILQ_FOREACH(image, worksheet->image_data, list_pointers) {
+        STAILQ_FOREACH(object_props, worksheet->image_props, list_pointers) {
+
+            if (object_props->is_duplicate)
+                continue;
 
             lxw_snprintf(filename, LXW_FILENAME_LENGTH,
-                         "xl/media/image%d.%s", index++, image->extension);
+                         "xl/media/image%d.%s", index++,
+                         object_props->extension);
 
-            if (!image->is_image_buffer) {
+            if (!object_props->is_image_buffer) {
                 /* Check that the image file exists and can be opened. */
-                image_stream = fopen(image->filename, "rb");
+                image_stream = lxw_fopen(object_props->filename, "rb");
                 if (!image_stream) {
                     LXW_WARN_FORMAT1("Error adding image to xlsx file: file "
                                      "doesn't exist or can't be opened: %s.",
-                                     image->filename);
+                                     object_props->filename);
                     return LXW_ERROR_CREATING_TMPFILE;
                 }
 
@@ -283,8 +291,9 @@ _write_image_files(lxw_packager *self)
             }
             else {
                 err = _add_buffer_to_zip(self,
-                                         image->image_buffer,
-                                         image->image_buffer_size, filename);
+                                         object_props->image_buffer,
+                                         object_props->image_buffer_size,
+                                         filename);
             }
 
             RETURN_ON_ERROR(err);
@@ -308,7 +317,7 @@ _add_vba_project(lxw_packager *self)
         return LXW_NO_ERROR;
 
     /* Check that the image file exists and can be opened. */
-    image_stream = fopen(workbook->vba_project, "rb");
+    image_stream = lxw_fopen(workbook->vba_project, "rb");
     if (!image_stream) {
         LXW_WARN_FORMAT1("Error adding vbaProject.bin to xlsx file: "
                          "file doesn't exist or can't be opened: %s.",
@@ -440,6 +449,164 @@ _get_drawing_count(lxw_packager *self)
     return drawing_count;
 }
 
+/*
+ * Write the comment/header VML files.
+ */
+STATIC lxw_error
+_write_vml_files(lxw_packager *self)
+{
+    lxw_workbook *workbook = self->workbook;
+    lxw_sheet *sheet;
+    lxw_worksheet *worksheet;
+    lxw_vml *vml;
+    char filename[LXW_FILENAME_LENGTH] = { 0 };
+    uint32_t index = 1;
+    lxw_error err;
+
+    STAILQ_FOREACH(sheet, workbook->sheets, list_pointers) {
+        if (sheet->is_chartsheet)
+            continue;
+        else
+            worksheet = sheet->u.worksheet;
+
+        if (!worksheet->has_vml && !worksheet->has_header_vml)
+            continue;
+
+        if (worksheet->has_vml) {
+
+            vml = lxw_vml_new();
+            if (!vml)
+                return LXW_ERROR_MEMORY_MALLOC_FAILED;
+
+            lxw_snprintf(filename, LXW_FILENAME_LENGTH,
+                         "xl/drawings/vmlDrawing%d.vml", index++);
+
+            vml->file = lxw_tmpfile(self->tmpdir);
+            if (!vml->file) {
+                lxw_vml_free(vml);
+                return LXW_ERROR_CREATING_TMPFILE;
+            }
+
+            vml->comment_objs = worksheet->comment_objs;
+            vml->vml_shape_id = worksheet->vml_shape_id;
+            vml->comment_display_default = worksheet->comment_display_default;
+
+            if (worksheet->vml_data_id_str) {
+                vml->vml_data_id_str = worksheet->vml_data_id_str;
+            }
+            else {
+                fclose(vml->file);
+                lxw_vml_free(vml);
+                return LXW_ERROR_MEMORY_MALLOC_FAILED;
+            }
+
+            lxw_vml_assemble_xml_file(vml);
+
+            err = _add_file_to_zip(self, vml->file, filename);
+
+            fclose(vml->file);
+            lxw_vml_free(vml);
+
+            RETURN_ON_ERROR(err);
+        }
+
+        if (worksheet->has_header_vml) {
+
+            err = _write_vml_drawing_rels_file(self, worksheet, index);
+            RETURN_ON_ERROR(err);
+
+            vml = lxw_vml_new();
+            if (!vml)
+                return LXW_ERROR_MEMORY_MALLOC_FAILED;
+
+            lxw_snprintf(filename, LXW_FILENAME_LENGTH,
+                         "xl/drawings/vmlDrawing%d.vml", index++);
+
+            vml->file = lxw_tmpfile(self->tmpdir);
+            if (!vml->file) {
+                lxw_vml_free(vml);
+                return LXW_ERROR_CREATING_TMPFILE;
+            }
+
+            vml->image_objs = worksheet->header_image_objs;
+            vml->vml_shape_id = worksheet->vml_header_id * 1024;
+
+            if (worksheet->vml_header_id_str) {
+                vml->vml_data_id_str = worksheet->vml_header_id_str;
+            }
+            else {
+                fclose(vml->file);
+                lxw_vml_free(vml);
+                return LXW_ERROR_MEMORY_MALLOC_FAILED;
+            }
+
+            lxw_vml_assemble_xml_file(vml);
+
+            err = _add_file_to_zip(self, vml->file, filename);
+
+            fclose(vml->file);
+            lxw_vml_free(vml);
+
+            RETURN_ON_ERROR(err);
+        }
+
+    }
+
+    return LXW_NO_ERROR;
+}
+
+/*
+ * Write the comment files.
+ */
+STATIC lxw_error
+_write_comment_files(lxw_packager *self)
+{
+    lxw_workbook *workbook = self->workbook;
+    lxw_sheet *sheet;
+    lxw_worksheet *worksheet;
+    lxw_comment *comment;
+    char filename[LXW_FILENAME_LENGTH] = { 0 };
+    uint32_t index = 1;
+    lxw_error err;
+
+    STAILQ_FOREACH(sheet, workbook->sheets, list_pointers) {
+        if (sheet->is_chartsheet)
+            continue;
+        else
+            worksheet = sheet->u.worksheet;
+
+        if (!worksheet->has_comments)
+            continue;
+
+        comment = lxw_comment_new();
+        if (!comment)
+            return LXW_ERROR_MEMORY_MALLOC_FAILED;
+
+        lxw_snprintf(filename, LXW_FILENAME_LENGTH,
+                     "xl/comments%d.xml", index++);
+
+        comment->file = lxw_tmpfile(self->tmpdir);
+        if (!comment->file) {
+            lxw_comment_free(comment);
+            return LXW_ERROR_CREATING_TMPFILE;
+        }
+
+        comment->comment_objs = worksheet->comment_objs;
+        comment->comment_author = worksheet->comment_author;
+
+        lxw_comment_assemble_xml_file(comment);
+
+        err = _add_file_to_zip(self, comment->file, filename);
+
+        fclose(comment->file);
+        lxw_comment_free(comment);
+
+        RETURN_ON_ERROR(err);
+    }
+
+    return LXW_NO_ERROR;
+}
+
 /*
  * Write the sharedStrings.xml file.
  */
@@ -690,11 +857,28 @@ _write_styles_file(lxw_packager *self)
         STAILQ_INSERT_TAIL(styles->xf_formats, style_format, list_pointers);
     }
 
+    /* Copy the unique and in-use dxf formats from the workbook to the styles
+     * dxf_format list. */
+    LXW_FOREACH_ORDERED(hash_element, self->workbook->used_dxf_formats) {
+        lxw_format *workbook_format = (lxw_format *) hash_element->value;
+        lxw_format *style_format = lxw_format_new();
+
+        if (!style_format) {
+            err = LXW_ERROR_MEMORY_MALLOC_FAILED;
+            goto mem_error;
+        }
+
+        memcpy(style_format, workbook_format, sizeof(lxw_format));
+        STAILQ_INSERT_TAIL(styles->dxf_formats, style_format, list_pointers);
+    }
+
     styles->font_count = self->workbook->font_count;
     styles->border_count = self->workbook->border_count;
     styles->fill_count = self->workbook->fill_count;
     styles->num_format_count = self->workbook->num_format_count;
     styles->xf_count = self->workbook->used_xf_formats->unique_count;
+    styles->dxf_count = self->workbook->used_dxf_formats->unique_count;
+    styles->has_comments = self->workbook->has_comments;
 
     styles->file = lxw_tmpfile(self->tmpdir);
     if (!styles->file) {
@@ -787,6 +971,15 @@ _write_content_types_file(lxw_packager *self)
         lxw_ct_add_drawing_name(content_types, filename);
     }
 
+    if (workbook->has_vml)
+        lxw_ct_add_vml_name(content_types);
+
+    for (index = 1; index <= workbook->comment_count; index++) {
+        lxw_snprintf(filename, LXW_FILENAME_LENGTH,
+                     "/xl/comments%d.xml", index);
+        lxw_ct_add_comment_name(content_types, filename);
+    }
+
     if (workbook->sst->string_count)
         lxw_ct_add_shared_strings(content_types);
 
@@ -893,7 +1086,10 @@ _write_worksheet_rels_file(lxw_packager *self)
         index++;
 
         if (STAILQ_EMPTY(worksheet->external_hyperlinks) &&
-            STAILQ_EMPTY(worksheet->external_drawing_links))
+            STAILQ_EMPTY(worksheet->external_drawing_links) &&
+            !worksheet->external_vml_header_link &&
+            !worksheet->external_vml_comment_link &&
+            !worksheet->external_comment_link)
             continue;
 
         rels = lxw_relationships_new();
@@ -914,6 +1110,21 @@ _write_worksheet_rels_file(lxw_packager *self)
                                            rel->target_mode);
         }
 
+        rel = worksheet->external_vml_comment_link;
+        if (rel)
+            lxw_add_worksheet_relationship(rels, rel->type, rel->target,
+                                           rel->target_mode);
+
+        rel = worksheet->external_vml_header_link;
+        if (rel)
+            lxw_add_worksheet_relationship(rels, rel->type, rel->target,
+                                           rel->target_mode);
+
+        rel = worksheet->external_comment_link;
+        if (rel)
+            lxw_add_worksheet_relationship(rels, rel->type, rel->target,
+                                           rel->target_mode);
+
         lxw_snprintf(sheetname, LXW_FILENAME_LENGTH,
                      "xl/worksheets/_rels/sheet%d.xml.rels", index);
 
@@ -1047,6 +1258,46 @@ _write_drawing_rels_file(lxw_packager *self)
     return LXW_NO_ERROR;
 }
 
+/*
+ * Write the vmlDrawing .rels files for worksheets that contain images in
+ * headers or footers.
+ */
+STATIC lxw_error
+_write_vml_drawing_rels_file(lxw_packager *self, lxw_worksheet *worksheet,
+                             uint32_t index)
+{
+    lxw_relationships *rels;
+    lxw_rel_tuple *rel;
+    char sheetname[LXW_FILENAME_LENGTH] = { 0 };
+    lxw_error err = LXW_NO_ERROR;
+
+    rels = lxw_relationships_new();
+
+    rels->file = lxw_tmpfile(self->tmpdir);
+    if (!rels->file) {
+        lxw_free_relationships(rels);
+        return LXW_ERROR_CREATING_TMPFILE;
+    }
+
+    STAILQ_FOREACH(rel, worksheet->vml_drawing_links, list_pointers) {
+        lxw_add_worksheet_relationship(rels, rel->type, rel->target,
+                                       rel->target_mode);
+
+    }
+
+    lxw_snprintf(sheetname, LXW_FILENAME_LENGTH,
+                 "xl/drawings/_rels/vmlDrawing%d.vml.rels", index);
+
+    lxw_relationships_assemble_xml_file(rels);
+
+    err = _add_file_to_zip(self, rels->file, sheetname);
+
+    fclose(rels->file);
+    lxw_free_relationships(rels);
+
+    return err;
+}
+
 /*
  * Write the _rels/.rels xml file.
  */
@@ -1223,6 +1474,12 @@ lxw_create_package(lxw_packager *self)
     error = _write_drawing_files(self);
     RETURN_ON_ERROR(error);
 
+    error = _write_vml_files(self);
+    RETURN_ON_ERROR(error);
+
+    error = _write_comment_files(self);
+    RETURN_ON_ERROR(error);
+
     error = _write_shared_strings_file(self);
     RETURN_ON_ERROR(error);
 

data/ext/xlsxwriter/libxlsxwriter/src/relationships.c

@@ -3,7 +3,7 @@
  *
  * Used in conjunction with the libxlsxwriter library.
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  */
 

data/ext/xlsxwriter/libxlsxwriter/src/shared_strings.c

@@ -3,7 +3,7 @@
  *
  * Used in conjunction with the libxlsxwriter library.
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  */
 
@@ -145,9 +145,7 @@ _write_si(lxw_sst *self, char *string)
     lxw_xml_start_tag(self->file, "si", NULL);
 
     /* Look for and escape control chars in the string. */
-    if (strpbrk(string, "\x01\x02\x03\x04\x05\x06\x07\x08\x0B\x0C"
-                "\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16"
-                "\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F")) {
+    if (lxw_has_control_characters(string)) {
         string = lxw_escape_control_characters(string);
         escaped_string = LXW_TRUE;
     }