xlsxwriter 0.2.0 → 0.2.1.pre

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

@@ -40,13 +40,13 @@ LXW_RB_GENERATE_CHARTSHEET_NAMES(lxw_chartsheet_names, lxw_chartsheet_name,
 STATIC int
 _worksheet_name_cmp(lxw_worksheet_name *name1, lxw_worksheet_name *name2)
 {
-    return strcmp(name1->name, name2->name);
+    return lxw_strcasecmp(name1->name, name2->name);
 }
 
 STATIC int
 _chartsheet_name_cmp(lxw_chartsheet_name *name1, lxw_chartsheet_name *name2)
 {
-    return strcmp(name1->name, name2->name);
+    return lxw_strcasecmp(name1->name, name2->name);
 }
 
 /*
@@ -208,6 +208,8 @@ lxw_workbook_free(lxw_workbook *workbook)
     lxw_sst_free(workbook->sst);
     free(workbook->options.tmpdir);
     free(workbook->ordered_charts);
+    free(workbook->vba_project);
+    free(workbook->vba_codename);
     free(workbook);
 }
 
@@ -885,9 +887,9 @@ _prepare_drawings(lxw_workbook *self)
     lxw_sheet *sheet;
     lxw_worksheet *worksheet;
     lxw_image_options *image_options;
-    uint16_t chart_ref_id = 0;
-    uint16_t image_ref_id = 0;
-    uint16_t drawing_id = 0;
+    uint32_t chart_ref_id = 0;
+    uint32_t image_ref_id = 0;
+    uint32_t drawing_id = 0;
     uint8_t is_chartsheet;
 
     STAILQ_FOREACH(sheet, self->sheets, list_pointers) {
@@ -1135,6 +1137,10 @@ _write_file_version(lxw_workbook *self)
     LXW_PUSH_ATTRIBUTES_STR("lowestEdited", "4");
     LXW_PUSH_ATTRIBUTES_STR("rupBuild", "4505");
 
+    if (self->vba_project)
+        LXW_PUSH_ATTRIBUTES_STR("codeName",
+                                "{37E998C4-C9E5-D4B9-71C8-EB1FF731991C}");
+
     lxw_xml_empty_tag(self->file, "fileVersion", &attributes);
 
     LXW_FREE_ATTRIBUTES();
@@ -1150,6 +1156,10 @@ _write_workbook_pr(lxw_workbook *self)
     struct xml_attribute *attribute;
 
     LXW_INIT_ATTRIBUTES();
+
+    if (self->vba_codename)
+        LXW_PUSH_ATTRIBUTES_STR("codeName", self->vba_codename);
+
     LXW_PUSH_ATTRIBUTES_STR("defaultThemeVersion", "124226");
 
     lxw_xml_empty_tag(self->file, "workbookPr", &attributes);
@@ -1470,6 +1480,7 @@ workbook_new_opt(const char *filename, lxw_workbook_options *options)
     if (options) {
         workbook->options.constant_memory = options->constant_memory;
         workbook->options.tmpdir = lxw_strdup(options->tmpdir);
+        workbook->options.use_zip64 = options->use_zip64;
     }
 
     return workbook;
@@ -1717,6 +1728,22 @@ workbook_close(lxw_workbook *self)
             worksheet->active = 1;
     }
 
+    /* Set workbook and worksheet VBA codenames if a macro has been added. */
+    if (self->vba_project) {
+        if (!self->vba_codename)
+            workbook_set_vba_name(self, "ThisWorkbook");
+
+        STAILQ_FOREACH(sheet, self->sheets, list_pointers) {
+            if (sheet->is_chartsheet)
+                continue;
+            else
+                worksheet = sheet->u.worksheet;
+
+            if (!worksheet->vba_codename)
+                worksheet_set_vba_name(worksheet, worksheet->name);
+        }
+    }
+
     /* Set the defined names for the worksheets such as Print Titles. */
     _prepare_defined_names(self);
 
@@ -1727,13 +1754,15 @@ workbook_close(lxw_workbook *self)
     _add_chart_cache_data(self);
 
     /* Create a packager object to assemble sub-elements into a zip file. */
-    packager = lxw_packager_new(self->filename, self->options.tmpdir);
+    packager = lxw_packager_new(self->filename,
+                                self->options.tmpdir,
+                                self->options.use_zip64);
 
     /* If the packager fails it is generally due to a zip permission error. */
     if (packager == NULL) {
         fprintf(stderr, "[ERROR] workbook_close(): "
                 "Error creating '%s'. "
-                "Error = %s\n", self->filename, strerror(errno));
+                "System error = %s\n", self->filename, strerror(errno));
 
         error = LXW_ERROR_CREATING_XLSX_FILE;
         goto mem_error;
@@ -1749,26 +1778,47 @@ workbook_close(lxw_workbook *self)
     if (error == LXW_ERROR_CREATING_TMPFILE) {
         fprintf(stderr, "[ERROR] workbook_close(): "
                 "Error creating tmpfile(s) to assemble '%s'. "
-                "Error = %s\n", self->filename, strerror(errno));
+                "System error = %s\n", self->filename, strerror(errno));
     }
 
-    /* If LXW_ERROR_ZIP_FILE_OPERATION then errno is set by zlib. */
+    /* If LXW_ERROR_ZIP_FILE_OPERATION then errno is set by zip. */
     if (error == LXW_ERROR_ZIP_FILE_OPERATION) {
         fprintf(stderr, "[ERROR] workbook_close(): "
-                "Zlib error while creating xlsx file '%s'. "
-                "Error = %s\n", self->filename, strerror(errno));
+                "Zip ZIP_ERRNO error while creating xlsx file '%s'. "
+                "System error = %s\n", self->filename, strerror(errno));
+    }
+
+    /* If LXW_ERROR_ZIP_PARAMETER_ERROR then errno is set by zip. */
+    if (error == LXW_ERROR_ZIP_PARAMETER_ERROR) {
+        fprintf(stderr, "[ERROR] workbook_close(): "
+                "Zip ZIP_PARAMERROR error while creating xlsx file '%s'. "
+                "System error = %s\n", self->filename, strerror(errno));
+    }
+
+    /* If LXW_ERROR_ZIP_BAD_ZIP_FILE then errno is set by zip. */
+    if (error == LXW_ERROR_ZIP_BAD_ZIP_FILE) {
+        fprintf(stderr, "[ERROR] workbook_close(): "
+                "Zip ZIP_BADZIPFILE error while creating xlsx file '%s'. "
+                "This may require the use_zip64 option for large files. "
+                "System error = %s\n", self->filename, strerror(errno));
+    }
+
+    /* If LXW_ERROR_ZIP_INTERNAL_ERROR then errno is set by zip. */
+    if (error == LXW_ERROR_ZIP_INTERNAL_ERROR) {
+        fprintf(stderr, "[ERROR] workbook_close(): "
+                "Zip ZIP_INTERNALERROR error while creating xlsx file '%s'. "
+                "System error = %s\n", self->filename, strerror(errno));
     }
 
     /* The next 2 error conditions don't set errno. */
     if (error == LXW_ERROR_ZIP_FILE_ADD) {
         fprintf(stderr, "[ERROR] workbook_close(): "
-                "Zlib error adding file to xlsx file '%s'.\n",
-                self->filename);
+                "Zip error adding file to xlsx file '%s'.\n", self->filename);
     }
 
     if (error == LXW_ERROR_ZIP_CLOSE) {
         fprintf(stderr, "[ERROR] workbook_close(): "
-                "Zlib error closing xlsx file '%s'.\n", self->filename);
+                "Zip error closing xlsx file '%s'.\n", self->filename);
     }
 
 mem_error:
@@ -2114,6 +2164,14 @@ workbook_validate_sheet_name(lxw_workbook *self, const char *sheetname)
     if (strpbrk(sheetname, "[]:*?/\\"))
         return LXW_ERROR_INVALID_SHEETNAME_CHARACTER;
 
+    /* Check that the worksheet doesn't start or end with an apostrophe. */
+    if (sheetname[0] == '\'' || sheetname[strlen(sheetname) - 1] == '\'')
+        return LXW_ERROR_SHEETNAME_START_END_APOSTROPHE;
+
+    /* Check that the worksheet name isn't the reserved work "History". */
+    if (lxw_strcasecmp(sheetname, "history") == 0)
+        return LXW_ERROR_SHEETNAME_RESERVED;
+
     /* Check if the worksheet name is already in use. */
     if (workbook_get_worksheet_by_name(self, sheetname))
         return LXW_ERROR_SHEETNAME_ALREADY_USED;
@@ -2124,3 +2182,48 @@ workbook_validate_sheet_name(lxw_workbook *self, const char *sheetname)
 
     return LXW_NO_ERROR;
 }
+
+/*
+ * Add a vbaProject binary to the Excel workbook.
+ */
+lxw_error
+workbook_add_vba_project(lxw_workbook *self, const char *filename)
+{
+    FILE *filehandle;
+
+    if (!filename) {
+        LXW_WARN("workbook_add_vba_project(): "
+                 "filename must be specified.");
+        return LXW_ERROR_NULL_PARAMETER_IGNORED;
+    }
+
+    /* Check that the vbaProject file exists and can be opened. */
+    filehandle = fopen(filename, "rb");
+    if (!filehandle) {
+        LXW_WARN_FORMAT1("workbook_add_vba_project(): "
+                         "file doesn't exist or can't be opened: %s.",
+                         filename);
+        return LXW_ERROR_PARAMETER_VALIDATION;
+    }
+    fclose(filehandle);
+
+    self->vba_project = lxw_strdup(filename);
+
+    return LXW_NO_ERROR;
+}
+
+/*
+ * Set the VBA name for the workbook.
+ */
+lxw_error
+workbook_set_vba_name(lxw_workbook *self, const char *name)
+{
+    if (!name) {
+        LXW_WARN("workbook_set_vba_name(): " "name must be specified.");
+        return LXW_ERROR_NULL_PARAMETER_IGNORED;
+    }
+
+    self->vba_codename = lxw_strdup(name);
+
+    return LXW_NO_ERROR;
+}

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

@@ -448,6 +448,7 @@ lxw_worksheet_free(lxw_worksheet *worksheet)
     free(worksheet->vbreaks);
     free(worksheet->name);
     free(worksheet->quoted_name);
+    free(worksheet->vba_codename);
 
     free(worksheet);
     worksheet = NULL;
@@ -1507,7 +1508,8 @@ _worksheet_write_optimized_sheet_data(lxw_worksheet *self)
         while (read_size) {
             read_size =
                 fread(buffer, 1, LXW_BUFFER_SIZE, self->optimize_tmpfile);
-            fwrite(buffer, 1, read_size, self->file);
+            /* Ignore return value. There is no easy way to raise error. */
+            (void) fwrite(buffer, 1, read_size, self->file);
         }
 
         fclose(self->optimize_tmpfile);
@@ -1992,7 +1994,7 @@ _worksheet_position_object_emus(lxw_worksheet *self,
  */
 void
 lxw_worksheet_prepare_image(lxw_worksheet *self,
-                            uint16_t image_ref_id, uint16_t drawing_id,
+                            uint32_t image_ref_id, uint32_t drawing_id,
                             lxw_image_options *image_data)
 {
     lxw_drawing_object *drawing_object;
@@ -2079,8 +2081,8 @@ mem_error:
  */
 void
 lxw_worksheet_prepare_chart(lxw_worksheet *self,
-                            uint16_t chart_ref_id,
-                            uint16_t drawing_id,
+                            uint32_t chart_ref_id,
+                            uint32_t drawing_id,
                             lxw_image_options *image_data,
                             uint8_t is_chartsheet)
 {
@@ -3147,7 +3149,7 @@ _worksheet_write_sheet_pr(lxw_worksheet *self)
     LXW_INIT_ATTRIBUTES();
 
     if (self->vba_codename)
-        LXW_PUSH_ATTRIBUTES_INT("codeName", self->vba_codename);
+        LXW_PUSH_ATTRIBUTES_STR("codeName", self->vba_codename);
 
     if (self->filter_on)
         LXW_PUSH_ATTRIBUTES_STR("filterMode", "1");
@@ -5629,7 +5631,14 @@ worksheet_insert_image_buffer_opt(lxw_worksheet *self,
     /* Write the image buffer to a temporary file so we can read the
      * dimensions like an ordinary file. */
     image_stream = lxw_tmpfile(self->tmpdir);
-    fwrite(image_buffer, 1, image_size, image_stream);
+    if (!image_stream)
+        return LXW_ERROR_CREATING_TMPFILE;
+
+    if (fwrite(image_buffer, 1, image_size, image_stream) != image_size) {
+        fclose(image_stream);
+        return LXW_ERROR_CREATING_TMPFILE;
+    }
+
     rewind(image_stream);
 
     /* Create a new object to hold the image options. */
@@ -6066,3 +6075,19 @@ worksheet_data_validation_cell(lxw_worksheet *self, lxw_row_t row,
     return worksheet_data_validation_range(self, row, col,
                                            row, col, validation);
 }
+
+/*
+ * Set the VBA name for the worksheet.
+ */
+lxw_error
+worksheet_set_vba_name(lxw_worksheet *self, const char *name)
+{
+    if (!name) {
+        LXW_WARN("worksheet_set_vba_name(): " "name must be specified.");
+        return LXW_ERROR_NULL_PARAMETER_IGNORED;
+    }
+
+    self->vba_codename = lxw_strdup(name);
+
+    return LXW_NO_ERROR;
+}

data/ext/xlsxwriter/workbook.c

@@ -31,15 +31,18 @@ workbook_alloc(VALUE klass) {
 }
 
 /*  call-seq:
- *     XlsxWriter::Workbook.new(path, constant_memory: false, tmpdir: nil) -> workbook
- *     XlsxWriter::Workbook.new(path, constant_memory: false, tmpdir: nil) { |wb| block } -> nil
- *     XlsxWriter::Workbook.open(path, constant_memory: false, tmpdir: nil) { |wb| block } -> nil
+ *     XlsxWriter::Workbook.new(path, constant_memory: false, tmpdir: nil, use_zip64: false) -> workbook
+ *     XlsxWriter::Workbook.new(path, constant_memory: false, tmpdir: nil, use_zip64: false) { |wb| block } -> nil
+ *     XlsxWriter::Workbook.open(path, constant_memory: false, tmpdir: nil, use_zip64: false) { |wb| block } -> nil
  *
  *  Creates a new Xlsx workbook in file +path+ and returns a new Workbook object.
  *
  *  If +constant_memory+ is set to true workbook data is stored in temporary files
  *  in +tmpdir+, considerably reducing memory consumption for large documents.
  *
+ *  If +use_zip64+ is set to truthy value zip64 extensions are enabled for the resulting xlsx file. It allows
+ *  for files in the archive to have size >4GB.
+ *
  *    XlsxWriter::Workbook.open('/tmp/test.xlsx', constant_memory: true) do |wb|
  *      # ... populate the workbook with data ...
  *    end
@@ -61,7 +64,8 @@ workbook_init(int argc, VALUE *argv, VALUE self) {
   struct workbook *ptr;
   lxw_workbook_options options = {
     .constant_memory = 0,
-    .tmpdir = NULL
+    .tmpdir = NULL,
+    .use_zip64 = 0
   };
 
   if (argc < 1 || argc > 2) {
@@ -75,6 +79,10 @@ workbook_init(int argc, VALUE *argv, VALUE self) {
       if (!NIL_P(tmpdir))
         options.tmpdir = RSTRING_PTR(tmpdir);
     }
+    VALUE use_zip64_ = rb_hash_aref(argv[1], ID2SYM(rb_intern("use_zip64")));
+    if (!NIL_P(use_zip64_) && use_zip64_) {
+      options.use_zip64 = 1;
+    }
   }
 
   Data_Get_Struct(self, struct workbook, ptr);
@@ -274,6 +282,24 @@ workbook_add_chart_(VALUE self, VALUE type) {
   return chart;
 }
 
+/*  call-seq:
+ *     wb.add_vba_project(filename)
+ *
+ *  Adds a vba project to the workbook (has to be extracted from a xlsm file).
+ *  Only one file per workbook is allowed. Documents with vba projects should have
+ *  extension "xlsm" rather than "xlsx" to avoid reader/editor software warnings.
+ */
+VALUE
+workbook_add_vba_project_(VALUE self, VALUE filename) {
+  struct workbook *ptr;
+  Data_Get_Struct(self, struct workbook, ptr);
+
+  lxw_error err = workbook_add_vba_project(ptr->workbook, StringValueCStr(filename));
+  handle_lxw_error(err);
+
+  return self;
+}
+
 /* :nodoc: */
 VALUE
 workbook_set_default_xf_indices_(VALUE self) {
@@ -283,6 +309,22 @@ workbook_set_default_xf_indices_(VALUE self) {
   return self;
 }
 
+/*  call-seq:
+ *     wb.vba_name = name
+ *
+ *  Set the VBA name for the workbook.
+ */
+VALUE
+workbook_set_vba_name_(VALUE self, VALUE name) {
+  struct workbook *ptr;
+  Data_Get_Struct(self, struct workbook, ptr);
+
+  lxw_error err = workbook_set_vba_name(ptr->workbook, StringValueCStr(name));
+  handle_lxw_error(err);
+
+  return name;
+}
+
 /*  call-seq: wb.properties -> wb_properties
  *
  *  Returns worbook properties accessor object.
@@ -382,14 +424,16 @@ init_xlsxwriter_workbook() {
   rb_define_alias(rb_singleton_class(cWorkbook), "open", "new");
   rb_define_method(cWorkbook, "initialize", workbook_init, -1);
   rb_define_method(cWorkbook, "close", workbook_release, 0);
-  rb_define_method(cWorkbook, "add_worksheet", workbook_add_worksheet_, -1);
-  rb_define_method(cWorkbook, "add_format", workbook_add_format_, 2);
   rb_define_method(cWorkbook, "add_chart", workbook_add_chart_, 1);
-  rb_define_method(cWorkbook, "set_default_xf_indices", workbook_set_default_xf_indices_, 0);
-  rb_define_method(cWorkbook, "properties", workbook_properties_, 0);
+  rb_define_method(cWorkbook, "add_format", workbook_add_format_, 2);
+  rb_define_method(cWorkbook, "add_vba_project", workbook_add_vba_project_, 1);
+  rb_define_method(cWorkbook, "add_worksheet", workbook_add_worksheet_, -1);
   rb_define_method(cWorkbook, "define_name", workbook_define_name_, 2);
+  rb_define_method(cWorkbook, "properties", workbook_properties_, 0);
+  rb_define_method(cWorkbook, "set_default_xf_indices", workbook_set_default_xf_indices_, 0);
   rb_define_method(cWorkbook, "validate_sheet_name", workbook_validate_sheet_name_, 1);
   rb_define_method(cWorkbook, "validate_worksheet_name", workbook_validate_sheet_name_, 1);
+  rb_define_method(cWorkbook, "vba_name=", workbook_set_vba_name_, 1);
 
   /*
    * This attribute contains effective font widths used for automatic column

data/ext/xlsxwriter/worksheet.c

@@ -624,6 +624,53 @@ worksheet_insert_image_(int argc, VALUE *argv, VALUE self) {
   return self;
 }
 
+/*  call-seq:
+ *     ws.insert_image_buffer(cell, data, options) -> self
+ *     ws.insert_image_buffer(row, col, data, options) -> self
+ *
+ *  Adds data validation or limits user input to a list of values.
+ */
+VALUE
+worksheet_insert_image_buffer_(int argc, VALUE *argv, VALUE self) {
+  lxw_row_t row;
+  lxw_col_t col;
+  VALUE data = Qnil;
+  VALUE opts = Qnil;
+  lxw_image_options options;
+  char with_options = '\0';
+
+  rb_check_arity(argc, 2, 4);
+  int larg = extract_cell(argc, argv, &row, &col);
+
+  if (larg < argc) {
+    data = argv[larg];
+    ++larg;
+  } else {
+    rb_raise(rb_eArgError, "Cannot embed image without data");
+  }
+
+  if (larg < argc) {
+    opts = argv[larg];
+    ++larg;
+  }
+  struct worksheet *ptr;
+  Data_Get_Struct(self, struct worksheet, ptr);
+
+  if (!NIL_P(opts)) {
+    options = val_to_lxw_image_options(opts, &with_options);
+  }
+
+  lxw_error error;
+  if (with_options) {
+    error = worksheet_insert_image_buffer_opt(ptr->worksheet, row, col, (const unsigned char *) RSTRING_PTR(data), RSTRING_LEN(data), &options);
+  } else {
+    error = worksheet_insert_image_buffer(ptr->worksheet, row, col, (const unsigned char *) RSTRING_PTR(data), RSTRING_LEN(data));
+  }
+  handle_lxw_error(error);
+
+  return self;
+}
+
 /*  call-seq:
  *     ws.insert_chart(cell, chart, opts = {}) -> self
  *     ws.insert_chart(row, col, chart, opts = {}) -> self
@@ -1485,6 +1532,23 @@ worksheet_data_validation_(int argc, VALUE *argv, VALUE self) {
   return self;
 }
 
+/*  call-seq: wb.vba_name = name
+ *
+ *  Set the VBA name for the worksheet.
+ */
+VALUE
+worksheet_set_vba_name_(VALUE self, VALUE name) {
+  struct worksheet *ptr;
+  Data_Get_Struct(self, struct worksheet, ptr);
+
+  lxw_error err = worksheet_set_vba_name(ptr->worksheet, StringValueCStr(name));
+  handle_lxw_error(err);
+
+  return name;
+}
+
+// Helpers
+
 lxw_col_t
 value_to_col(VALUE value) {
   switch (TYPE(value)) {
@@ -1600,6 +1664,7 @@ val_to_lxw_image_options(VALUE opts, char *with_options) {
   SET_IMG_OPT("scale",    options.x_scale  = options.y_scale  = NUM2DBL(val));
   SET_IMG_OPT("x_scale",  options.x_scale  =                    NUM2DBL(val));
   SET_IMG_OPT("y_scale",                     options.y_scale  = NUM2DBL(val));
+  SET_IMG_OPT("description", options.description = StringValueCStr(val));
   return options;
 }
 #undef SET_IMG_OPT
@@ -1626,6 +1691,7 @@ init_xlsxwriter_worksheet() {
   rb_define_method(cWorksheet, "set_row", worksheet_set_row_, 2);
   rb_define_method(cWorksheet, "set_column", worksheet_set_column_, 3);
   rb_define_method(cWorksheet, "insert_image", worksheet_insert_image_, -1);
+  rb_define_method(cWorksheet, "insert_image_buffer", worksheet_insert_image_buffer_, -1);
   rb_define_method(cWorksheet, "insert_chart", worksheet_insert_chart_, -1);
   rb_define_method(cWorksheet, "merge_range", worksheet_merge_range_, -1);
   rb_define_method(cWorksheet, "autofilter", worksheet_autofilter_, -1);
@@ -1668,6 +1734,8 @@ init_xlsxwriter_worksheet() {
   rb_define_method(cWorksheet, "vertical_dpi=", worksheet_set_vertical_dpi_, 1);
 
   rb_define_method(cWorksheet, "add_data_validation", worksheet_data_validation_, -1);
+  rb_define_method(cWorksheet, "vba_name=", worksheet_set_vba_name_, 1);
+
   rb_define_private_method(cWorksheet, "extract_column", rb_extract_col, 1);
 
 #define MAP_LXW_WH_CONST(name, val_name) rb_define_const(cWorksheet, #name, INT2NUM(LXW_##val_name))