xlsxwriter 0.2.0 → 0.2.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5952e238ec4dc55988d50bacd80e39132daca19f62ad8c6191705b240ad40cf1
-  data.tar.gz: '05824be3c90e0ebbf3a44df01034b3d300191ea8712cb7e4d24643aa68b0beef'
+  metadata.gz: 258446b7479b3f3677923a46fe56f3206d313a81776e797bf4232e08bbaa1926
+  data.tar.gz: '029fd9139e2047cbbd7e248f324c517c09383fa332f02edd83dabaf75c328886'
 SHA512:
-  metadata.gz: b3733fc664a8e74657d194268b3b653a28bb886078fe92a35cdbcfefc1665d47add6117b35598726db1159caca7b983db0358f6e0c28be27a2a6d503b06fea81
-  data.tar.gz: 630f607d92e91c348b0a126f121242fcafd81bece774f642363b272c721c5d10d4a12ac8213290c7fbef1b8b4519f745c7ee6b5c364cc19a84fe26af256f8411
+  metadata.gz: 356595ae4d443af888c87a9402727dae8438db5ee666fe75887762a3140d905e9473d7e9c63967c6cd94c92c7cc643696d9a044658691d8164c0464ed9b50a32
+  data.tar.gz: 96d899fd65b2b01a7ffb64f38749b71baa849786fc7a5cd61fecbafbae245aa2b7aff3d5e9b852694ad70a1bb399517a1ba8611b12ab52b8f5c8a33998f850f1

data/ext/xlsxwriter/chart.c

@@ -7,6 +7,13 @@ VALUE cChart;
 VALUE cChartSeries;
 VALUE cChartAxis;
 
+#define DEF_PROP_SETTER(type, field, value, ptr_field) VALUE type ## _set_ ## field ## _ (VALUE self, VALUE val) { \
+    struct type *ptr;                                                   \
+    Data_Get_Struct(self, struct type, ptr);                            \
+    type ## _set_ ## field (ptr->ptr_field, value);                     \
+    return val;                                                         \
+}
+
 
 VALUE
 chart_alloc(VALUE klass) {
@@ -233,38 +240,24 @@ chart_legend_delete_series_(VALUE self, VALUE series) {
   return self;
 }
 
-/*  call-seq: chart.style=(style) -> style
+/*  Document-method: XlsxWriter::Workbook::Chart#style=
+ *
+ *  call-seq: chart.style=(style) -> style
  *
  *  Sets the chart +style+ (integer from 1 to 48, default is 2).
  */
-VALUE
-chart_set_style_(VALUE self, VALUE style) {
-  struct chart *ptr;
-  Data_Get_Struct(self, struct chart, ptr);
-
-  chart_set_style(ptr->chart, NUM2INT(rb_check_to_int(style)));
-  return style;
-}
-
-/* :nodoc: */
-VALUE
-chart_set_rotation_(VALUE self, VALUE rotation) {
-  struct chart *ptr;
-  Data_Get_Struct(self, struct chart, ptr);
+DEF_PROP_SETTER(chart, style, NUM2INT(rb_check_to_int(val)), chart)
 
-  chart_set_rotation(ptr->chart, NUM2UINT(rb_check_to_int(rotation)));
-  return rotation;
-}
 
-/* :nodoc: */
-VALUE
-chart_set_hole_size_(VALUE self, VALUE size) {
-  struct chart *ptr;
-  Data_Get_Struct(self, struct chart, ptr);
+/*  Document-method: XlsxWriter::Workbook::Chart#rotation=
+ *
+ */
+DEF_PROP_SETTER(chart, rotation, NUM2UINT(rb_check_to_int(val)), chart)
 
-  chart_set_hole_size(ptr->chart, NUM2UINT(rb_check_to_int(size)));
-  return size;
-}
+/*  Document-method: XlsxWriter::Workbook::Chart#hole_size=
+ *
+ */
+DEF_PROP_SETTER(chart, hole_size, NUM2UINT(rb_check_to_int(val)), chart)
 
 
 /* :nodoc: */
@@ -302,18 +295,79 @@ chart_set_axis_id_2_(VALUE self, VALUE val) {
 }
 
 
-/*  call-seq: axis.name=(name) -> name
+/* Document-method: XlsxWriter::Workbook::Chart::Axis#name=
+ *
+ *  call-seq: axis.name=(name) -> name
  *
  *  Sets the chart axis +name+.
  */
-VALUE
-chart_axis_set_name_(VALUE self, VALUE val) {
-  struct chart_axis *ptr;
-  Data_Get_Struct(self, struct chart_axis, ptr);
+DEF_PROP_SETTER(chart_axis, name, StringValueCStr(val), axis)
 
-  chart_axis_set_name(ptr->axis, StringValueCStr(val));
-  return val;
-}
+/*  Document-method XlsxWriter::Workbook::Chart::Axis#interval_unit=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, interval_unit, NUM2UINT(rb_check_to_int(val)), axis)
+
+/*  Document-method XlsxWriter::Workbook::Chart::Axis#interval_tick=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, interval_tick, NUM2UINT(rb_check_to_int(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#max=
+ *
+ *  call-seq: axis.max=(value) -> value
+ *
+ *  Sets the chart axis +max+ value.
+ */
+DEF_PROP_SETTER(chart_axis, max, NUM2DBL(rb_check_to_float(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#min=
+ *
+ *  call-seq: axis.min=(value) -> value
+ *
+ *  Sets the chart axis +min+ value.
+ */
+DEF_PROP_SETTER(chart_axis, min, NUM2DBL(rb_check_to_float(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#major_tick_mark=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, major_tick_mark, NUM2UINT(rb_check_to_int(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#minor_tick_mark=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, minor_tick_mark, NUM2UINT(rb_check_to_int(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#major_unit=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, major_unit, NUM2DBL(rb_check_to_float(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#minor_unit=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, minor_unit, NUM2DBL(rb_check_to_float(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#label_align=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, label_align, NUM2UINT(rb_check_to_int(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#label_position=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, label_position, NUM2DBL(rb_check_to_float(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#log_base=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, log_base, NUM2DBL(rb_check_to_float(val)), axis)
+
+/*  Document-method: XlsxWriter::Workbook::Chart::Axis#num_format=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, num_format, StringValueCStr(val), axis)
 
 /*  call-seq:
  *     axis.set_name_range(name, cell) -> self
@@ -392,6 +446,38 @@ chart_axis_set_fill_(VALUE self, VALUE opts) {
   return self;
 }
 
+/*  Document-method XlsxWriter::Workbook::Chart::Axis#position=
+ *
+ */
+DEF_PROP_SETTER(chart_axis, position, NUM2UINT(rb_check_to_int(val)), axis)
+
+/*  call-seq: axis.reverse = true
+ *
+ *  Interpret axis values/categories in reverse order.
+ */
+VALUE
+chart_axis_set_reverse_(VALUE self, VALUE p) {
+  struct chart_axis *ptr;
+  if (RTEST(p)) {
+    Data_Get_Struct(self, struct chart_axis, ptr);
+
+    chart_axis_set_reverse(ptr->axis);
+  }
+  return p;
+}
+
+VALUE
+chart_axis_set_source_linked_(VALUE self, VALUE val) {
+  struct chart_axis *ptr;
+
+  Data_Get_Struct(self, struct chart_axis, ptr);
+
+  ptr->axis->source_linked = NUM2UINT(rb_check_to_int(val));
+
+  return val;
+}
+
+
 /*  call-seq:
  *     series.set_categories(sheetname, range)
  *     series.set_categories(sheetname, cell_from, cell_to)
@@ -433,18 +519,13 @@ chart_series_set_values_(int argc, VALUE *argv, VALUE self) {
   return self;
 }
 
-/*  call-seq: series.name=(name) -> name
+/*  Document-method: XlsxWriter::Workbook::Chart::Series#name=
+ *
+ *  call-seq: series.name=(name) -> name
  *
  *  Set chart series name.
  */
-VALUE
-chart_series_set_name_(VALUE self, VALUE name) {
-  struct chart_series *ptr;
-  Data_Get_Struct(self, struct chart_series, ptr);
-
-  chart_series_set_name(ptr->series, StringValueCStr(name));
-  return name;
-}
+DEF_PROP_SETTER(chart_series, name, StringValueCStr(val), series)
 
 /*  call-seq:
  *     series.set_name_range(name, cell) -> self
@@ -465,6 +546,17 @@ chart_series_set_name_range_(int argc, VALUE *argv, VALUE self) {
   return self;
 }
 
+VALUE
+chart_series_set_invert_if_negative_(VALUE self, VALUE p) {
+  struct chart_series *ptr;
+  if (RTEST(p)) {
+    Data_Get_Struct(self, struct chart_series, ptr);
+
+    chart_series_set_invert_if_negative(ptr->series);
+  }
+  return p;
+}
+
 
 #define SET_PROP(prop, vres) {                          \
     val = rb_hash_aref(opts, ID2SYM(rb_intern(#prop))); \
@@ -552,11 +644,26 @@ void init_xlsxwriter_chart() {
   rb_define_method(cChartAxis, "initialize", chart_axis_init, 2);
 
   rb_define_method(cChartAxis, "name=", chart_axis_set_name_, 1);
+  rb_define_method(cChartAxis, "interval_unit=", chart_axis_set_interval_unit_, 1);
+  rb_define_method(cChartAxis, "interval_tick=", chart_axis_set_interval_tick_, 1);
+  rb_define_method(cChartAxis, "max=", chart_axis_set_max_, 1);
+  rb_define_method(cChartAxis, "min=", chart_axis_set_min_, 1);
+  rb_define_method(cChartAxis, "major_tick_mark=", chart_axis_set_major_tick_mark_, 1);
+  rb_define_method(cChartAxis, "minor_tick_mark=", chart_axis_set_minor_tick_mark_, 1);
+  rb_define_method(cChartAxis, "major_unit=", chart_axis_set_major_unit_, 1);
+  rb_define_method(cChartAxis, "minor_unit=", chart_axis_set_minor_unit_, 1);
+  rb_define_method(cChartAxis, "label_align=", chart_axis_set_label_align_, 1);
+  rb_define_method(cChartAxis, "label_position=", chart_axis_set_label_position_, 1);
+  rb_define_method(cChartAxis, "log_base=", chart_axis_set_log_base_, 1);
+  rb_define_method(cChartAxis, "num_format=", chart_axis_set_num_format_, 1);
   rb_define_method(cChartAxis, "set_name_range", chart_axis_set_name_range_, -1);
   rb_define_method(cChartAxis, "set_name_font", chart_axis_set_name_font_, 1);
   rb_define_method(cChartAxis, "set_num_font", chart_axis_set_num_font_, 1);
   rb_define_method(cChartAxis, "set_line", chart_axis_set_line_, 1);
   rb_define_method(cChartAxis, "set_fill", chart_axis_set_fill_, 1);
+  rb_define_method(cChartAxis, "position=", chart_axis_set_position_, 1);
+  rb_define_method(cChartAxis, "reverse=", chart_axis_set_reverse_, 1);
+  rb_define_method(cChartAxis, "source_linked=", chart_axis_set_source_linked_, 1);
 
   rb_define_alloc_func(cChartSeries, chart_series_alloc);
   rb_define_method(cChartSeries, "initialize", chart_series_init, -1);
@@ -565,6 +672,7 @@ void init_xlsxwriter_chart() {
   rb_define_method(cChartSeries, "set_values", chart_series_set_values_, -1);
   rb_define_method(cChartSeries, "name=", chart_series_set_name_, 1);
   rb_define_method(cChartSeries, "set_name_range", chart_series_set_name_range_, -1);
+  rb_define_method(cChartSeries, "invert_if_negative=", chart_series_set_invert_if_negative_, 1);
 
 #define MAP_CHART_CONST(name) rb_define_const(cChart, #name, INT2NUM(LXW_CHART_##name))
   MAP_CHART_CONST(NONE);
@@ -602,7 +710,25 @@ void init_xlsxwriter_chart() {
   MAP_CHART_CONST(AXIS_LABEL_ALIGN_CENTER);
   MAP_CHART_CONST(AXIS_LABEL_ALIGN_LEFT);
   MAP_CHART_CONST(AXIS_LABEL_ALIGN_RIGHT);
-
-
 #undef MAP_CHART_CONST
+
+#define MAP_CHART_AXIS_CONST(name) rb_define_const(cChartAxis, #name, INT2NUM(LXW_CHART_AXIS_##name))
+  MAP_CHART_AXIS_CONST(LABEL_ALIGN_CENTER);
+  MAP_CHART_AXIS_CONST(LABEL_ALIGN_LEFT);
+  MAP_CHART_AXIS_CONST(LABEL_ALIGN_RIGHT);
+
+  MAP_CHART_AXIS_CONST(LABEL_POSITION_NEXT_TO);
+  MAP_CHART_AXIS_CONST(LABEL_POSITION_HIGH);
+  MAP_CHART_AXIS_CONST(LABEL_POSITION_LOW);
+  MAP_CHART_AXIS_CONST(LABEL_POSITION_NONE);
+
+  MAP_CHART_AXIS_CONST(POSITION_BETWEEN);
+  MAP_CHART_AXIS_CONST(POSITION_ON_TICK);
+
+  MAP_CHART_AXIS_CONST(TICK_MARK_DEFAULT);
+  MAP_CHART_AXIS_CONST(TICK_MARK_NONE);
+  MAP_CHART_AXIS_CONST(TICK_MARK_INSIDE);
+  MAP_CHART_AXIS_CONST(TICK_MARK_OUTSIDE);
+  MAP_CHART_AXIS_CONST(TICK_MARK_CROSSING);
+#undef MAP_CHART_AXIS_CONST
 }

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter.h

@@ -18,6 +18,6 @@
 #include "xlsxwriter/format.h"
 #include "xlsxwriter/utility.h"
 
-#define LXW_VERSION "0.8.6"
+#define LXW_VERSION "0.8.7"
 
 #endif /* __LXW_XLSXWRITER_H__ */

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/common.h

@@ -68,13 +68,22 @@ typedef enum lxw_error {
     /** Error reading a tmpfile. */
     LXW_ERROR_READING_TMPFILE,
 
-    /** Zlib error with a file operation while creating xlsx file. */
+    /** Zip generic error ZIP_ERRNO while creating the xlsx file. */
     LXW_ERROR_ZIP_FILE_OPERATION,
 
-    /** Zlib error when adding sub file to xlsx file. */
+    /** Zip error ZIP_PARAMERROR while creating the xlsx file. */
+    LXW_ERROR_ZIP_PARAMETER_ERROR,
+
+    /** Zip error ZIP_BADZIPFILE (use_zip64 option may be required). */
+    LXW_ERROR_ZIP_BAD_ZIP_FILE,
+
+    /** Zip error ZIP_INTERNALERROR while creating the xlsx file. */
+    LXW_ERROR_ZIP_INTERNAL_ERROR,
+
+    /** File error or unknown zip error when adding sub file to xlsx file. */
     LXW_ERROR_ZIP_FILE_ADD,
 
-    /** Zlib error when closing xlsx file. */
+    /** Unknown zip error when closing xlsx file. */
     LXW_ERROR_ZIP_CLOSE,
 
     /** NULL function parameter ignored. */
@@ -86,12 +95,18 @@ typedef enum lxw_error {
     /** Worksheet name exceeds Excel's limit of 31 characters. */
     LXW_ERROR_SHEETNAME_LENGTH_EXCEEDED,
 
-    /** Worksheet name contains invalid Excel character: '[]:*?/\\' */
+    /** Worksheet name cannot contain invalid characters: '[ ] : * ? / \\' */
     LXW_ERROR_INVALID_SHEETNAME_CHARACTER,
 
+    /** Worksheet name cannot start or end with an apostrophe. */
+    LXW_ERROR_SHEETNAME_START_END_APOSTROPHE,
+
     /** Worksheet name is already in use. */
     LXW_ERROR_SHEETNAME_ALREADY_USED,
 
+    /** Worksheet name 'History' is reserved by Excel. */
+    LXW_ERROR_SHEETNAME_RESERVED,
+
     /** Parameter exceeds Excel's limit of 32 characters. */
     LXW_ERROR_32_STRING_LENGTH_EXCEEDED,
 

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/content_types.h

@@ -17,6 +17,7 @@
 
 #define LXW_APP_PACKAGE  "application/vnd.openxmlformats-package."
 #define LXW_APP_DOCUMENT "application/vnd.openxmlformats-officedocument."
+#define LXW_APP_MSEXCEL  "application/vnd.ms-excel."
 
 /*
  * Struct to represent a content_types.

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/packager.h

@@ -32,11 +32,17 @@
 
 #define LXW_ZIP_BUFFER_SIZE (16384)
 
-/* If zlib returns Z_ERRNO then errno is set and we can trap that. Otherwise
- * return a default libxlsxwriter error. */
+/* If zip returns a ZIP_XXX error then errno is set and we can trap that in
+ * workbook.c. Otherwise return a default libxlsxwriter error. */
 #define RETURN_ON_ZIP_ERROR(err, default_err)   \
-    if (err == Z_ERRNO)                         \
+    if (err == ZIP_ERRNO)                       \
         return LXW_ERROR_ZIP_FILE_OPERATION;    \
+    else if (err == ZIP_PARAMERROR)             \
+        return LXW_ERROR_ZIP_PARAMETER_ERROR;   \
+    else if (err == ZIP_BADZIPFILE)             \
+        return LXW_ERROR_ZIP_BAD_ZIP_FILE;      \
+    else if (err == ZIP_INTERNALERROR)          \
+        return LXW_ERROR_ZIP_INTERNAL_ERROR;    \
     else                                        \
         return default_err;
 
@@ -54,6 +60,7 @@ typedef struct lxw_packager {
     char *filename;
     char *buffer;
     char *tmpdir;
+    uint8_t use_zip64;
 
 } lxw_packager;
 
@@ -64,7 +71,8 @@ extern "C" {
 #endif
 /* *INDENT-ON* */
 
-lxw_packager *lxw_packager_new(const char *filename, char *tmpdir);
+lxw_packager *lxw_packager_new(const char *filename, char *tmpdir,
+                               uint8_t use_zip64);
 void lxw_packager_free(lxw_packager *packager);
 lxw_error lxw_create_package(lxw_packager *self);
 

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/utility.h

@@ -17,6 +17,7 @@
 #define __LXW_UTILITY_H__
 
 #include <stdint.h>
+#include <strings.h>
 #include "common.h"
 #include "xmlwriter.h"
 
@@ -166,6 +167,13 @@ size_t lxw_utf8_strlen(const char *str);
 
 void lxw_str_tolower(char *str);
 
+/* Define a portable version of strcasecmp(). */
+#ifdef _MSC_VER
+#define lxw_strcasecmp _stricmp
+#else
+#define lxw_strcasecmp strcasecmp
+#endif
+
 FILE *lxw_tmpfile(char *tmpdir);
 
 /* Use a user defined function to format doubles in sprintf or else a simple

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/workbook.h

@@ -203,27 +203,40 @@ typedef struct lxw_doc_properties {
  *
  * The following properties are supported:
  *
- * - `constant_memory`: Reduces the amount of data stored in memory so that
- *   large files can be written efficiently.
+ * - `constant_memory`: This option reduces the amount of data stored in
+ *   memory so that large files can be written efficiently. This option is off
+ *   by default. See the note below for limitations when this mode is on.
  *
- *   @note In this mode a row of data is written and then discarded when a
- *   cell in a new row is added via one of the `worksheet_write_*()`
- *   functions. Therefore, once this option is active, data should be written in
- *   sequential row order. For this reason the `worksheet_merge_range()`
- *   doesn't work in this mode. See also @ref ww_mem_constant.
- *
- * - `tmpdir`: libxlsxwriter stores workbook data in temporary files prior
- *   to assembling the final XLSX file. The temporary files are created in the
+ * - `tmpdir`: libxlsxwriter stores workbook data in temporary files prior to
+ *   assembling the final XLSX file. The temporary files are created in the
  *   system's temp directory. If the default temporary directory isn't
  *   accessible to your application, or doesn't contain enough space, you can
  *   specify an alternative location using the `tmpdir` option.
+ *
+ * - `use_zip64`: Make the zip library use ZIP64 extensions when writing very
+ *   large xlsx files to allow the zip container, or individual XML files
+ *   within it, to be greater than 4 GB. See [ZIP64 on Wikipedia][zip64_wiki]
+ *   for more information. This option is off by default.
+ *
+ *   [zip64_wiki]: https://en.wikipedia.org/wiki/Zip_(file_format)#ZIP64
+ *
+ * @note In `constant_memory` mode a row of data is written and then discarded
+ * when a cell in a new row is added via one of the `worksheet_write_*()`
+ * functions. Therefore, once this option is active, data should be written in
+ * sequential row order. For this reason the `worksheet_merge_range()` doesn't
+ * work in this mode. See also @ref ww_mem_constant.
+ *
  */
 typedef struct lxw_workbook_options {
-    /** Optimize the workbook to use constant memory for worksheets */
+    /** Optimize the workbook to use constant memory for worksheets. */
     uint8_t constant_memory;
 
     /** Directory to use for the temporary files created by libxlsxwriter. */
     char *tmpdir;
+
+    /** Allow ZIP64 extensions when creating the xlsx file zip container. */
+    uint8_t use_zip64;
+
 } lxw_workbook_options;
 
 /**
@@ -272,6 +285,9 @@ typedef struct lxw_workbook {
 
     lxw_hash_table *used_xf_formats;
 
+    char *vba_project;
+    char *vba_codename;
+
 } lxw_workbook;
 
 
@@ -313,30 +329,37 @@ lxw_workbook *workbook_new(const char *filename);
  * additional options to be set.
  *
  * @code
- *    lxw_workbook_options options = {.constant_memory = 1,
- *                                    .tmpdir = "C:\\Temp"};
+ *    lxw_workbook_options options = {.constant_memory = LXW_TRUE,
+ *                                    .tmpdir = "C:\\Temp",
+ *                                    .use_zip64 = LXW_FALSE};
  *
  *    lxw_workbook  *workbook  = workbook_new_opt("filename.xlsx", &options);
  * @endcode
  *
  * The options that can be set via #lxw_workbook_options are:
  *
- * - `constant_memory`: Reduces the amount of data stored in memory so that
- *   large files can be written efficiently.
- *
- *   @note In this mode a row of data is written and then discarded when a
- *   cell in a new row is added via one of the `worksheet_write_*()`
- *   functions. Therefore, once this option is active, data should be written in
- *   sequential row order. For this reason the `worksheet_merge_range()`
- *   doesn't work in this mode. See also @ref ww_mem_constant.
+ * - `constant_memory`: This option reduces the amount of data stored in
+ *   memory so that large files can be written efficiently. This option is off
+ *   by default. See the note below for limitations when this mode is on.
  *
- * - `tmpdir`: libxlsxwriter stores workbook data in temporary files prior
- *   to assembling the final XLSX file. The temporary files are created in the
+ * - `tmpdir`: libxlsxwriter stores workbook data in temporary files prior to
+ *   assembling the final XLSX file. The temporary files are created in the
  *   system's temp directory. If the default temporary directory isn't
  *   accessible to your application, or doesn't contain enough space, you can
- *   specify an alternative location using the `tmpdir` option.*
+ *   specify an alternative location using the `tmpdir` option.
+ *
+ * - `use_zip64`: Make the zip library use ZIP64 extensions when writing very
+ *   large xlsx files to allow the zip container, or individual XML files
+ *   within it, to be greater than 4 GB. See [ZIP64 on Wikipedia][zip64_wiki]
+ *   for more information. This option is off by default.
+ *
+ *   [zip64_wiki]: https://en.wikipedia.org/wiki/Zip_(file_format)#ZIP64
  *
- * See @ref working_with_memory for more details.
+ * @note In `constant_memory` mode a row of data is written and then discarded
+ * when a cell in a new row is added via one of the `worksheet_write_*()`
+ * functions. Therefore, once this option is active, data should be written in
+ * sequential row order. For this reason the `worksheet_merge_range()` doesn't
+ * work in this mode. See also @ref ww_mem_constant.
  *
  */
 lxw_workbook *workbook_new_opt(const char *filename,
@@ -376,14 +399,17 @@ lxw_workbook *new_workbook_opt(const char *filename,
  *
  * @image html workbook02.png
  *
- * The worksheet name must be a valid Excel worksheet name, i.e. it must be
- * less than 32 character and it cannot contain any of the characters:
+ * The worksheet name must be a valid Excel worksheet name, i.e:
  *
- *     / \ [ ] : * ?
- *
- * In addition, you cannot use the same, case insensitive, `sheetname` for more
- * than one worksheet, or chartsheet.
+ * - The name is less than or equal to 31 UTF-8 characters.
+ * - The name doesn't contain any of the characters: ` [ ] : * ? / \ `
+ * - The name doesn't start or end with an apostrophe.
+ * - The name isn't "History", which is reserved by Excel. (Case insensitive).
+ * - The name isn't already in use. (Case insensitive).
  *
+ * If any of these errors are encountered the function will return NULL.
+ * You can check for valid name using the `workbook_validate_sheet_name()`
+ * function.
  */
 lxw_worksheet *workbook_add_worksheet(lxw_workbook *workbook,
                                       const char *sheetname);
@@ -412,13 +438,17 @@ lxw_worksheet *workbook_add_worksheet(lxw_workbook *workbook,
  *
  * @endcode
  *
- * The chartsheet name must be a valid Excel worksheet name, i.e. it must be
- * less than 32 character and it cannot contain any of the characters:
+ * The chartsheet name must be a valid Excel worksheet name, i.e.:
  *
- *     / \ [ ] : * ?
+ * - The name is less than or equal to 31 UTF-8 characters.
+ * - The name doesn't contain any of the characters: ` [ ] : * ? / \ `
+ * - The name doesn't start or end with an apostrophe.
+ * - The name isn't "History", which is reserved by Excel. (Case insensitive).
+ * - The name isn't already in use. (Case insensitive).
  *
- * In addition, you cannot use the same, case insensitive, `sheetname` for more
- * than one chartsheet, or worksheet.
+ * If any of these errors are encountered the function will return NULL.
+ * You can check for valid name using the `workbook_validate_sheet_name()`
+ * function.
  *
  * At least one worksheet should be added to a new workbook when creating a
  * chartsheet in order to provide data for the chart. The @ref worksheet.h
@@ -797,7 +827,9 @@ lxw_chartsheet *workbook_get_chartsheet_by_name(lxw_workbook *workbook,
  *
  * - The name is less than or equal to 31 UTF-8 characters.
  * - The name doesn't contain any of the characters: ` [ ] : * ? / \ `
- * - The name isn't already in use.
+ * - The name doesn't start or end with an apostrophe.
+ * - The name isn't "History", which is reserved by Excel. (Case insensitive).
+ * - The name isn't already in use. (Case insensitive, see the note below).
  *
  * @code
  *     lxw_error err = workbook_validate_sheet_name(workbook, "Foglio");
@@ -807,10 +839,73 @@ lxw_chartsheet *workbook_get_chartsheet_by_name(lxw_workbook *workbook,
  * `workbook_add_chartsheet()` but it can be explicitly called by the user
  * beforehand to ensure that the sheet name is valid.
  *
+ * @note This function does an ASCII lowercase string comparison to determine
+ * if the sheet name is already in use. It doesn't take UTF-8 characters into
+ * account. Thus it would flag "Café" and "café" as a duplicate (just like
+ * Excel) but it wouldn't catch "CAFÉ". If you need a full UTF-8 case
+ * insensitive check you should use a third party library to implement it.
+ *
  */
 lxw_error workbook_validate_sheet_name(lxw_workbook *workbook,
                                        const char *sheetname);
 
+/**
+ * @brief Add a vbaProject binary to the Excel workbook.
+ *
+ * @param workbook Pointer to a lxw_workbook instance.
+ * @param filename The path/filename of the vbaProject.bin file.
+ *
+ * The `%workbook_add_vba_project()` function can be used to add macros or
+ * functions to a workbook using a binary VBA project file that has been
+ * extracted from an existing Excel xlsm file:
+ *
+ * @code
+ *     workbook_add_vba_project(workbook, "vbaProject.bin");
+ * @endcode
+ *
+ * Only one `vbaProject.bin file` can be added per workbook. The name doesn't
+ * have to be `vbaProject.bin`. Any suitable path/name for an existing VBA bin
+ * file will do.
+ *
+ * Once you add a VBA project had been add to an libxlsxwriter workbook you
+ * should ensure that the file extension is `.xlsm` to prevent Excel from
+ * giving a warning when it opens the file:
+ *
+ * @code
+ *     lxw_workbook *workbook = new_workbook("macro.xlsm");
+ * @endcode
+ *
+ * See also @ref working_with_macros
+ *
+ * @return A #lxw_error.
+ */
+lxw_error workbook_add_vba_project(lxw_workbook *workbook,
+                                   const char *filename);
+
+/**
+ * @brief Set the VBA name for the workbook.
+ *
+ * @param workbook Pointer to a lxw_workbook instance.
+ * @param name     Name of the workbook used by VBA.
+ *
+ * The `workbook_set_vba_name()` function can be used to set the VBA name for
+ * the workbook. This is sometimes required when a vbaProject macro included
+ * via `workbook_add_vba_project()` refers to the workbook by a name other
+ * than `ThisWorkbook`.
+ *
+ * @code
+ *     workbook_set_vba_name(workbook, "MyWorkbook");
+ * @endcode
+ *
+ * If an Excel VBA name for the workbook isn't specified then libxlsxwriter
+ * will use `ThisWorkbook`.
+ *
+ * See also @ref working_with_macros
+ *
+ * @return A #lxw_error.
+ */
+lxw_error workbook_set_vba_name(lxw_workbook *workbook, const char *name);
+
 void lxw_workbook_free(lxw_workbook *workbook);
 void lxw_workbook_assemble_xml_file(lxw_workbook *workbook);
 void lxw_workbook_set_default_xf_indices(lxw_workbook *workbook);