xlsxwriter 0.2.1.pre.2 → 0.2.2

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

@@ -0,0 +1,443 @@
+/*****************************************************************************
+ * comment - A library for creating Excel XLSX comment files.
+ *
+ * Used in conjunction with the libxlsxwriter library.
+ *
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ *
+ */
+
+#include "xlsxwriter/xmlwriter.h"
+#include "xlsxwriter/comment.h"
+#include "xlsxwriter/utility.h"
+
+/*
+ * Forward declarations.
+ */
+
+STATIC int _author_id_cmp(lxw_author_id *tuple1, lxw_author_id *tuple2);
+
+#ifndef __clang_analyzer__
+LXW_RB_GENERATE_AUTHOR_IDS(lxw_author_ids, lxw_author_id,
+                           tree_pointers, _author_id_cmp);
+#endif
+
+/*****************************************************************************
+ *
+ * Private functions.
+ *
+ ****************************************************************************/
+
+/*
+ * Comparator for the author ids.
+ */
+STATIC int
+_author_id_cmp(lxw_author_id *author_id1, lxw_author_id *author_id2)
+{
+    return strcmp(author_id1->author, author_id2->author);
+}
+
+/*
+ * Check if an author already existing in the author/id table.
+ */
+STATIC uint8_t
+_check_author(lxw_comment *self, char *author)
+{
+    lxw_author_id tmp_author_id;
+    lxw_author_id *existing_author = NULL;
+
+    if (!author)
+        return LXW_TRUE;
+
+    tmp_author_id.author = author;
+    existing_author = RB_FIND(lxw_author_ids,
+                              self->author_ids, &tmp_author_id);
+
+    if (existing_author)
+        return LXW_TRUE;
+    else
+        return LXW_FALSE;
+}
+
+/*
+ * Get the index used for an author name.
+ */
+STATIC uint32_t
+_get_author_index(lxw_comment *self, char *author)
+{
+    lxw_author_id tmp_author_id;
+    lxw_author_id *existing_author = NULL;
+    lxw_author_id *new_author_id = NULL;
+
+    if (!author)
+        return 0;
+
+    tmp_author_id.author = author;
+    existing_author = RB_FIND(lxw_author_ids,
+                              self->author_ids, &tmp_author_id);
+
+    if (existing_author) {
+        return existing_author->id;
+    }
+    else {
+        new_author_id = calloc(1, sizeof(lxw_author_id));
+
+        if (new_author_id) {
+            new_author_id->id = self->author_id;
+            new_author_id->author = lxw_strdup(author);
+            self->author_id++;
+
+            RB_INSERT(lxw_author_ids, self->author_ids, new_author_id);
+
+            return new_author_id->id;
+        }
+        else {
+            return 0;
+        }
+    }
+}
+
+/*
+ * Create a new comment object.
+ */
+lxw_comment *
+lxw_comment_new(void)
+{
+    lxw_comment *comment = calloc(1, sizeof(lxw_comment));
+    GOTO_LABEL_ON_MEM_ERROR(comment, mem_error);
+
+    comment->author_ids = calloc(1, sizeof(struct lxw_author_ids));
+    GOTO_LABEL_ON_MEM_ERROR(comment->author_ids, mem_error);
+    RB_INIT(comment->author_ids);
+
+    return comment;
+
+mem_error:
+    lxw_comment_free(comment);
+    return NULL;
+}
+
+/*
+ * Free a comment object.
+ */
+void
+lxw_comment_free(lxw_comment *comment)
+{
+    struct lxw_author_id *author_id;
+    struct lxw_author_id *next_author_id;
+
+    if (!comment)
+        return;
+
+    if (comment->author_ids) {
+        for (author_id =
+             RB_MIN(lxw_author_ids, comment->author_ids);
+             author_id; author_id = next_author_id) {
+
+            next_author_id =
+                RB_NEXT(lxw_author_ids, worksheet->author_id, author_id);
+            RB_REMOVE(lxw_author_ids, comment->author_ids, author_id);
+            free(author_id->author);
+            free(author_id);
+        }
+
+        free(comment->author_ids);
+    }
+
+    free(comment);
+}
+
+/*****************************************************************************
+ *
+ * XML functions.
+ *
+ ****************************************************************************/
+
+/*
+ * Write the XML declaration.
+ */
+STATIC void
+_comment_xml_declaration(lxw_comment *self)
+{
+    lxw_xml_declaration(self->file);
+}
+
+/*****************************************************************************
+ *
+ * XML file assembly functions.
+ *
+ ****************************************************************************/
+
+/*
+ * Write the <t> element.
+ */
+STATIC void
+_comment_write_text_t(lxw_comment *self, lxw_vml_obj *comment_obj)
+{
+    lxw_xml_data_element(self->file, "t", comment_obj->text, NULL);
+}
+
+/*
+ * Write the <family> element.
+ */
+STATIC void
+_comment_write_family(lxw_comment *self, lxw_vml_obj *comment_obj)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_INT("val", comment_obj->font_family);
+
+    lxw_xml_empty_tag(self->file, "family", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
+/*
+ * Write the <rFont> element.
+ */
+STATIC void
+_comment_write_r_font(lxw_comment *self, lxw_vml_obj *comment_obj)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+    char font_name[LXW_ATTR_32];
+
+    if (comment_obj->font_name)
+        lxw_snprintf(font_name, LXW_ATTR_32, "%s", comment_obj->font_name);
+    else
+        lxw_snprintf(font_name, LXW_ATTR_32, "Tahoma");
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_STR("val", font_name);
+
+    lxw_xml_empty_tag(self->file, "rFont", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
+/*
+ * Write the <color> element.
+ */
+STATIC void
+_comment_write_color(lxw_comment *self)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+    char indexed[] = "81";
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_STR("indexed", indexed);
+
+    lxw_xml_empty_tag(self->file, "color", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
+/*
+ * Write the <sz> element.
+ */
+STATIC void
+_comment_write_sz(lxw_comment *self, lxw_vml_obj *comment_obj)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_DBL("val", comment_obj->font_size);
+
+    lxw_xml_empty_tag(self->file, "sz", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
+/*
+ * Write the <rPr> element.
+ */
+STATIC void
+_comment_write_r_pr(lxw_comment *self, lxw_vml_obj *comment_obj)
+{
+    lxw_xml_start_tag(self->file, "rPr", NULL);
+
+    /* Write the sz element. */
+    _comment_write_sz(self, comment_obj);
+
+    /* Write the color element. */
+    _comment_write_color(self);
+
+    /* Write the rFont element. */
+    _comment_write_r_font(self, comment_obj);
+
+    /* Write the family element. */
+    _comment_write_family(self, comment_obj);
+
+    lxw_xml_end_tag(self->file, "rPr");
+}
+
+/*
+ * Write the <r> element.
+ */
+STATIC void
+_comment_write_r(lxw_comment *self, lxw_vml_obj *comment_obj)
+{
+    lxw_xml_start_tag(self->file, "r", NULL);
+
+    /* Write the rPr element. */
+    _comment_write_r_pr(self, comment_obj);
+
+    /* Write the t element. */
+    _comment_write_text_t(self, comment_obj);
+
+    lxw_xml_end_tag(self->file, "r");
+}
+
+/*
+ * Write the <text> element.
+ */
+STATIC void
+_comment_write_text(lxw_comment *self, lxw_vml_obj *comment_obj)
+{
+    lxw_xml_start_tag(self->file, "text", NULL);
+
+    /* Write the r element. */
+    _comment_write_r(self, comment_obj);
+
+    lxw_xml_end_tag(self->file, "text");
+}
+
+/*
+ * Write the <comment> element.
+ */
+STATIC void
+_comment_write_comment(lxw_comment *self, lxw_vml_obj *comment_obj)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+    char ref[LXW_MAX_CELL_NAME_LENGTH];
+
+    lxw_rowcol_to_cell(ref, comment_obj->row, comment_obj->col);
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_STR("ref", ref);
+    LXW_PUSH_ATTRIBUTES_INT("authorId", comment_obj->author_id);
+
+    lxw_xml_start_tag(self->file, "comment", &attributes);
+
+    /* Write the text element. */
+    _comment_write_text(self, comment_obj);
+
+    lxw_xml_end_tag(self->file, "comment");
+
+    LXW_FREE_ATTRIBUTES();
+}
+
+/*
+ * Write the <commentList> element.
+ */
+STATIC void
+_comment_write_comment_list(lxw_comment *self)
+{
+    lxw_vml_obj *comment_obj;
+
+    lxw_xml_start_tag(self->file, "commentList", NULL);
+
+    STAILQ_FOREACH(comment_obj, self->comment_objs, list_pointers) {
+        /* Write the comment element. */
+        _comment_write_comment(self, comment_obj);
+    }
+
+    lxw_xml_end_tag(self->file, "commentList");
+
+}
+
+/*
+ * Write the <author> element.
+ */
+STATIC void
+_comment_write_author(lxw_comment *self, char *author)
+{
+    lxw_xml_data_element(self->file, "author", author, NULL);
+}
+
+/*
+ * Write the <authors> element.
+ */
+STATIC void
+_comment_write_authors(lxw_comment *self)
+{
+    lxw_vml_obj *comment_obj;
+    char *author;
+
+    lxw_xml_start_tag(self->file, "authors", NULL);
+
+    /* Set the default author (from worksheet_set_comments_author()). */
+    if (self->comment_author) {
+        _get_author_index(self, self->comment_author);
+        _comment_write_author(self, self->comment_author);
+    }
+    else {
+        _get_author_index(self, "");
+        _comment_write_author(self, "");
+    }
+
+    STAILQ_FOREACH(comment_obj, self->comment_objs, list_pointers) {
+        author = comment_obj->author;
+
+        if (author) {
+
+            if (!_check_author(self, author))
+                _comment_write_author(self, author);
+
+            comment_obj->author_id = _get_author_index(self, author);
+        }
+    }
+
+    lxw_xml_end_tag(self->file, "authors");
+}
+
+/*
+ * Write the <comments> element.
+ */
+STATIC void
+_comment_write_comments(lxw_comment *self)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+    char xmlns[] =
+        "http://schemas.openxmlformats.org/spreadsheetml/2006/main";
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_STR("xmlns", xmlns);
+
+    lxw_xml_start_tag(self->file, "comments", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
+/*
+ * Assemble and write the XML file.
+ */
+void
+lxw_comment_assemble_xml_file(lxw_comment *self)
+{
+    /* Write the XML declaration. */
+    _comment_xml_declaration(self);
+
+    /* Write the comments element. */
+    _comment_write_comments(self);
+
+    /* Write the authors element. */
+    _comment_write_authors(self);
+
+    /* Write the commentList element. */
+    _comment_write_comment_list(self);
+
+    lxw_xml_end_tag(self->file, "comments");
+}
+
+/*****************************************************************************
+ *
+ * Public functions.
+ *
+ ****************************************************************************/

data/ext/xlsxwriter/libxlsxwriter/src/content_types.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.
  *
  */
 
@@ -322,6 +322,25 @@ lxw_ct_add_drawing_name(lxw_content_types *self, const char *name)
     lxw_ct_add_override(self, name, LXW_APP_DOCUMENT "drawing+xml");
 }
 
+/*
+ * Add the name of a VML drawing to the ContentTypes overrides.
+ */
+void
+lxw_ct_add_vml_name(lxw_content_types *self)
+{
+    lxw_ct_add_default(self, "vml", LXW_APP_DOCUMENT "vmlDrawing");
+}
+
+/*
+ * Add the name of a comment to the ContentTypes overrides.
+ */
+void
+lxw_ct_add_comment_name(lxw_content_types *self, const char *name)
+{
+    lxw_ct_add_override(self, name,
+                        LXW_APP_DOCUMENT "spreadsheetml.comments+xml");
+}
+
 /*
  * Add the sharedStrings link to the ContentTypes overrides.
  */

data/ext/xlsxwriter/libxlsxwriter/src/core.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.
  *
  */
 
@@ -50,7 +50,7 @@ lxw_core_free(lxw_core *core)
 }
 
 /*
- * Convert a time_t struct to a ISO 8601 style "2010-01-01T00:00:00Z" date.
+ * Convert a time_t to a ISO 8601 style "2010-01-01T00:00:00Z" date.
  */
 static void
 _datetime_to_iso8601_date(time_t *timer, char *str, size_t size)

data/ext/xlsxwriter/libxlsxwriter/src/custom.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/drawing.c

@@ -3,13 +3,14 @@
  *
  * 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.
  *
  */
 
 #include "xlsxwriter/xmlwriter.h"
 #include "xlsxwriter/common.h"
 #include "xlsxwriter/drawing.h"
+#include "xlsxwriter/worksheet.h"
 #include "xlsxwriter/utility.h"
 
 #define LXW_OBJ_NAME_LENGTH 14  /* "Picture 65536", or "Chart 65536" */
@@ -54,7 +55,6 @@ lxw_free_drawing_object(lxw_drawing_object *drawing_object)
         return;
 
     free(drawing_object->description);
-    free(drawing_object->url);
     free(drawing_object->tip);
 
     free(drawing_object);
@@ -221,6 +221,32 @@ _drawing_write_to(lxw_drawing *self, lxw_drawing_coords *coords)
     lxw_xml_end_tag(self->file, "xdr:to");
 }
 
+/*
+ * Write the <a:hlinkClick> element.
+ */
+STATIC void
+_drawing_write_a_hlink_click(lxw_drawing *self, uint32_t rel_index, char *tip)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+    char xmlns_r[] = "http://schemas.openxmlformats.org/"
+        "officeDocument/2006/relationships";
+    char r_id[LXW_MAX_ATTRIBUTE_LENGTH];
+
+    lxw_snprintf(r_id, LXW_ATTR_32, "rId%d", rel_index);
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_STR("xmlns:r", xmlns_r);
+    LXW_PUSH_ATTRIBUTES_STR("r:id", r_id);
+
+    if (tip)
+        LXW_PUSH_ATTRIBUTES_STR("tooltip", tip);
+
+    lxw_xml_empty_tag(self->file, "a:hlinkClick", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
 /*
  * Write the <xdr:cNvPr> element.
  */
@@ -239,10 +265,24 @@ _drawing_write_c_nv_pr(lxw_drawing *self, char *object_name, uint32_t index,
     LXW_PUSH_ATTRIBUTES_INT("id", index + 1);
     LXW_PUSH_ATTRIBUTES_STR("name", name);
 
-    if (drawing_object && drawing_object->description)
+    if (drawing_object && drawing_object->description
+        && strlen(drawing_object->description)) {
         LXW_PUSH_ATTRIBUTES_STR("descr", drawing_object->description);
+    }
+
+    if (drawing_object && drawing_object->url_rel_index) {
+        lxw_xml_start_tag(self->file, "xdr:cNvPr", &attributes);
 
-    lxw_xml_empty_tag(self->file, "xdr:cNvPr", &attributes);
+        /* Write the a:hlinkClick element. */
+        _drawing_write_a_hlink_click(self,
+                                     drawing_object->url_rel_index,
+                                     drawing_object->tip);
+
+        lxw_xml_end_tag(self->file, "xdr:cNvPr");
+    }
+    else {
+        lxw_xml_empty_tag(self->file, "xdr:cNvPr", &attributes);
+    }
 
     LXW_FREE_ATTRIBUTES();
 }
@@ -472,7 +512,7 @@ _drawing_write_pic(lxw_drawing *self, uint32_t index,
     _drawing_write_nv_pic_pr(self, index, drawing_object);
 
     /* Write the xdr:blipFill element. */
-    _drawing_write_blip_fill(self, index);
+    _drawing_write_blip_fill(self, drawing_object->rel_index);
 
     /* Write the xdr:spPr element. */
     _drawing_write_sp_pr(self, drawing_object);
@@ -661,7 +701,8 @@ _drawing_write_a_graphic(lxw_drawing *self, uint32_t index)
  * Write the <xdr:graphicFrame> element.
  */
 STATIC void
-_drawing_write_graphic_frame(lxw_drawing *self, uint32_t index)
+_drawing_write_graphic_frame(lxw_drawing *self, uint32_t index,
+                             uint32_t rel_index)
 {
     struct xml_attribute_list attributes;
     struct xml_attribute *attribute;
@@ -678,7 +719,7 @@ _drawing_write_graphic_frame(lxw_drawing *self, uint32_t index)
     _drawing_write_xfrm(self);
 
     /* Write the a:graphic element. */
-    _drawing_write_a_graphic(self, index);
+    _drawing_write_a_graphic(self, rel_index);
 
     lxw_xml_end_tag(self->file, "xdr:graphicFrame");
 
@@ -697,24 +738,21 @@ _drawing_write_two_cell_anchor(lxw_drawing *self, uint32_t index,
 
     LXW_INIT_ATTRIBUTES();
 
-    if (drawing_object->anchor_type == LXW_ANCHOR_TYPE_IMAGE) {
-
-        if (drawing_object->edit_as == LXW_ANCHOR_EDIT_AS_ABSOLUTE)
-            LXW_PUSH_ATTRIBUTES_STR("editAs", "absolute");
-        else if (drawing_object->edit_as != LXW_ANCHOR_EDIT_AS_RELATIVE)
-            LXW_PUSH_ATTRIBUTES_STR("editAs", "oneCell");
-    }
+    if (drawing_object->anchor == LXW_OBJECT_MOVE_DONT_SIZE)
+        LXW_PUSH_ATTRIBUTES_STR("editAs", "oneCell");
+    else if (drawing_object->anchor == LXW_OBJECT_DONT_MOVE_DONT_SIZE)
+        LXW_PUSH_ATTRIBUTES_STR("editAs", "absolute");
 
     lxw_xml_start_tag(self->file, "xdr:twoCellAnchor", &attributes);
 
     _drawing_write_from(self, &drawing_object->from);
     _drawing_write_to(self, &drawing_object->to);
 
-    if (drawing_object->anchor_type == LXW_ANCHOR_TYPE_CHART) {
+    if (drawing_object->type == LXW_DRAWING_CHART) {
         /* Write the xdr:graphicFrame element for charts. */
-        _drawing_write_graphic_frame(self, index);
+        _drawing_write_graphic_frame(self, index, drawing_object->rel_index);
     }
-    else if (drawing_object->anchor_type == LXW_ANCHOR_TYPE_IMAGE) {
+    else if (drawing_object->type == LXW_DRAWING_IMAGE) {
         /* Write the xdr:pic element. */
         _drawing_write_pic(self, index, drawing_object);
     }
@@ -772,7 +810,7 @@ _drawing_write_pos(lxw_drawing *self, int32_t x, int32_t y)
  * Write the <xdr:absoluteAnchor> element.
  */
 STATIC void
-_drawing_write_absolute_anchor(lxw_drawing *self)
+_drawing_write_absolute_anchor(lxw_drawing *self, uint32_t frame_index)
 {
     lxw_xml_start_tag(self->file, "xdr:absoluteAnchor", NULL);
 
@@ -791,7 +829,7 @@ _drawing_write_absolute_anchor(lxw_drawing *self)
         _drawing_write_ext(self, 6162675, 6124575);
     }
 
-    _drawing_write_graphic_frame(self, 1);
+    _drawing_write_graphic_frame(self, frame_index, frame_index);
 
     /* Write the xdr:clientData element. */
     _drawing_write_client_data(self);
@@ -830,7 +868,7 @@ lxw_drawing_assemble_xml_file(lxw_drawing *self)
     }
     else {
         /* Write the xdr:absoluteAnchor element. Mainly for chartsheets. */
-        _drawing_write_absolute_anchor(self);
+        _drawing_write_absolute_anchor(self, 1);
     }
 
     lxw_xml_end_tag(self->file, "xdr:wsDr");