xlsxwriter 0.2.1.pre.2 → 0.2.3.pre.1

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

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -72,14 +72,14 @@
  * The type for RGB colors in libxlsxwriter. The valid range is `0x000000`
  * (black) to `0xFFFFFF` (white). See @ref working_with_colors.
  */
-typedef int32_t lxw_color_t;
+typedef uint32_t lxw_color_t;
 
 #define LXW_FORMAT_FIELD_LEN            128
 #define LXW_DEFAULT_FONT_NAME           "Calibri"
 #define LXW_DEFAULT_FONT_FAMILY         2
 #define LXW_DEFAULT_FONT_THEME          1
 #define LXW_PROPERTY_UNSET              -1
-#define LXW_COLOR_UNSET                 -1
+#define LXW_COLOR_UNSET                 0x000000
 #define LXW_COLOR_MASK                  0xFFFFFF
 #define LXW_MIN_FONT_SIZE               1.0
 #define LXW_MAX_FONT_SIZE               409.0
@@ -92,8 +92,10 @@ typedef int32_t lxw_color_t;
 
 /** Format underline values for format_set_underline(). */
 enum lxw_format_underlines {
+    LXW_UNDERLINE_NONE = 0,
+
     /** Single underline */
-    LXW_UNDERLINE_SINGLE = 1,
+    LXW_UNDERLINE_SINGLE,
 
     /** Double underline */
     LXW_UNDERLINE_DOUBLE,
@@ -348,10 +350,13 @@ typedef struct lxw_format {
     FILE *file;
 
     lxw_hash_table *xf_format_indices;
+    lxw_hash_table *dxf_format_indices;
     uint16_t *num_xf_formats;
+    uint16_t *num_dxf_formats;
 
     int32_t xf_index;
     int32_t dxf_index;
+    int32_t xf_id;
 
     char num_format[LXW_FORMAT_FIELD_LEN];
     char font_name[LXW_FORMAT_FIELD_LEN];
@@ -387,6 +392,8 @@ typedef struct lxw_format {
 
     lxw_color_t fg_color;
     lxw_color_t bg_color;
+    lxw_color_t dxf_fg_color;
+    lxw_color_t dxf_bg_color;
     uint8_t pattern;
     uint8_t has_fill;
     uint8_t has_dxf_fill;
@@ -431,6 +438,7 @@ typedef struct lxw_font {
     uint8_t bold;
     uint8_t italic;
     uint8_t underline;
+    uint8_t theme;
     uint8_t font_strikeout;
     uint8_t font_outline;
     uint8_t font_shadow;
@@ -483,12 +491,11 @@ extern "C" {
 lxw_format *lxw_format_new(void);
 void lxw_format_free(lxw_format *format);
 int32_t lxw_format_get_xf_index(lxw_format *format);
+int32_t lxw_format_get_dxf_index(lxw_format *format);
 lxw_font *lxw_format_get_font_key(lxw_format *format);
 lxw_border *lxw_format_get_border_key(lxw_format *format);
 lxw_fill *lxw_format_get_fill_key(lxw_format *format);
 
-lxw_color_t lxw_format_check_color(lxw_color_t color);
-
 /**
  * @brief Set the font used in the cell.
  *
@@ -672,6 +679,9 @@ void format_set_font_script(lxw_format *format, uint8_t style);
  *
  * @image html format_set_num_format.png
  *
+ * To set a number format that matches an Excel format category such as "Date"
+ * or "Currency" see @ref ww_formats_categories.
+ *
  * The number system used for dates is described in @ref working_with_dates.
  *
  * For more information on number formats in Excel refer to the
@@ -749,6 +759,7 @@ void format_set_num_format(lxw_format *format, const char *num_format);
  *  - The dollar sign in the above format appears as the defined local currency
  *    symbol.
  *  - These formats can also be set via format_set_num_format().
+ *  - See also @ref ww_formats_categories.
  */
 void format_set_num_format_index(lxw_format *format, uint8_t index);
 
@@ -1199,6 +1210,9 @@ void format_set_font_condense(lxw_format *format);
 void format_set_font_extend(lxw_format *format);
 void format_set_reading_order(lxw_format *format, uint8_t value);
 void format_set_theme(lxw_format *format, uint8_t value);
+void format_set_hyperlink(lxw_format *format);
+void format_set_color_indexed(lxw_format *format, uint8_t value);
+void format_set_font_only(lxw_format *format);
 
 /* Declarations required for unit testing. */
 #ifdef TESTING

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

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * hash_table - Hash table functions for libxlsxwriter.
  *

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

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * packager - A libxlsxwriter library for creating Excel XLSX packager files.
  *
@@ -29,6 +29,8 @@
 #include "format.h"
 #include "content_types.h"
 #include "relationships.h"
+#include "vml.h"
+#include "comment.h"
 
 #define LXW_ZIP_BUFFER_SIZE (16384)
 

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

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * relationships - A libxlsxwriter library for creating Excel XLSX
  *                 relationships files.

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

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * shared_strings - A libxlsxwriter library for creating Excel XLSX
  *                  sst files.

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

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * styles - A libxlsxwriter library for creating Excel XLSX styles files.
  *
@@ -28,6 +28,9 @@ typedef struct lxw_styles {
     uint32_t fill_count;
     struct lxw_formats *xf_formats;
     struct lxw_formats *dxf_formats;
+    uint8_t has_hyperlink;
+    uint16_t hyperlink_font_id;
+    uint8_t has_comments;
 
 } lxw_styles;
 
@@ -55,18 +58,21 @@ STATIC void _write_font_name(lxw_styles *self, const char *font_name,
                              uint8_t is_rich_string);
 STATIC void _write_font_family(lxw_styles *self, uint8_t font_family);
 STATIC void _write_font_scheme(lxw_styles *self, const char *font_scheme);
-STATIC void _write_font(lxw_styles *self, lxw_format *format,
+STATIC void _write_font(lxw_styles *self, lxw_format *format, uint8_t is_dxf,
                         uint8_t is_rich_string);
 STATIC void _write_fonts(lxw_styles *self);
 STATIC void _write_default_fill(lxw_styles *self, const char *pattern);
 STATIC void _write_fills(lxw_styles *self);
-STATIC void _write_border(lxw_styles *self, lxw_format *format);
+STATIC void _write_border(lxw_styles *self, lxw_format *format,
+                          uint8_t is_dxf);
 STATIC void _write_borders(lxw_styles *self);
-STATIC void _write_style_xf(lxw_styles *self);
+STATIC void _write_style_xf(lxw_styles *self, uint8_t has_hyperlink,
+                            uint16_t font_id);
 STATIC void _write_cell_style_xfs(lxw_styles *self);
 STATIC void _write_xf(lxw_styles *self, lxw_format *format);
 STATIC void _write_cell_xfs(lxw_styles *self);
-STATIC void _write_cell_style(lxw_styles *self);
+STATIC void _write_cell_style(lxw_styles *self, char *name, uint8_t xf_id,
+                              uint8_t builtin_id);
 STATIC void _write_cell_styles(lxw_styles *self);
 STATIC void _write_dxfs(lxw_styles *self);
 STATIC void _write_table_styles(lxw_styles *self);

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

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * theme - A libxlsxwriter library for creating Excel XLSX theme files.
  *

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

@@ -0,0 +1,43 @@
+/*
+ * This is an OpenSSL-compatible implementation of the RSA Data Security, Inc.
+ * MD5 Message-Digest Algorithm (RFC 1321).
+ *
+ * Homepage:
+ * http://openwall.info/wiki/people/solar/software/public-domain-source-code/md5
+ *
+ * Author:
+ * Alexander Peslyak, better known as Solar Designer <solar at openwall.com>
+ *
+ * This software was written by Alexander Peslyak in 2001.  No copyright is
+ * claimed, and the software is hereby placed in the public domain.
+ * In case this attempt to disclaim copyright and place the software in the
+ * public domain is deemed null and void, then the software is
+ * Copyright (c) 2001 Alexander Peslyak and it is hereby released to the
+ * general public under the following terms:
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted.
+ *
+ * There's ABSOLUTELY NO WARRANTY, express or implied.
+ *
+ * See md5.c for more information.
+ */
+
+#ifndef __LXW_MD5_H__
+#define __LXW_MD5_H__
+
+/* Any 32-bit or wider unsigned integer data type will do */
+typedef unsigned int uint32_t;
+
+typedef struct {
+	uint32_t lo, hi;
+	uint32_t a, b, c, d;
+	unsigned char buffer[64];
+	uint32_t block[16];
+} lxw_md5_ctx;
+
+extern void lxw_md5_init(lxw_md5_ctx *ctx);
+extern void lxw_md5_update(lxw_md5_ctx *ctx, const void *data, unsigned long size);
+extern void lxw_md5_final(unsigned char *result, lxw_md5_ctx *ctx);
+
+#endif

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

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -9,7 +9,7 @@
  *
  * @brief Utility functions for libxlsxwriter.
  *
- * <!-- Copyright 2014-2019, John McNamara, jmcnamara@cpan.org -->
+ * <!-- Copyright 2014-2020, John McNamara, jmcnamara@cpan.org -->
  *
  */
 
@@ -17,7 +17,9 @@
 #define __LXW_UTILITY_H__
 
 #include <stdint.h>
+#ifndef _MSC_VER
 #include <strings.h>
+#endif
 #include "common.h"
 #include "xmlwriter.h"
 
@@ -101,6 +103,20 @@ extern "C" {
  */
 const char *lxw_version(void);
 
+/**
+ * @brief Retrieve the library version ID.
+ *
+ * @return The version ID.
+ *
+ * Get the library version such as "X.Y.Z" as a XYZ integer.
+ *
+ *  @code
+ *      printf("Libxlsxwriter version id = %d\n", lxw_version_id());
+ *  @endcode
+ *
+ */
+uint16_t lxw_version_id(void);
+
 /**
  * @brief Converts a libxlsxwriter error number to a string.
  *
@@ -155,10 +171,32 @@ void lxw_rowcol_to_formula_abs(char *formula, const char *sheetname,
 
 uint32_t lxw_name_to_row(const char *row_str);
 uint16_t lxw_name_to_col(const char *col_str);
+
 uint32_t lxw_name_to_row_2(const char *row_str);
 uint16_t lxw_name_to_col_2(const char *col_str);
 
-double lxw_datetime_to_excel_date(lxw_datetime *datetime, uint8_t date_1904);
+/**
+ * @brief Converts a #lxw_datetime to an Excel datetime number.
+ *
+ * @param datetime A pointer to a #lxw_datetime struct.
+ *
+ * @return A double representing an Excel datetime.
+ *
+ * The `%lxw_datetime_to_excel_datetime()` function converts a datetime in
+ * #lxw_datetime to and Excel datetime number:
+ *
+ * @code
+ *     lxw_datetime datetime = {2013, 2, 28, 12, 0, 0.0};
+ *
+ *     double excel_datetime = lxw_datetime_to_excel_date(&datetime);
+ * @endcode
+ *
+ * See @ref working_with_dates for more details on the Excel datetime format.
+ */
+double lxw_datetime_to_excel_datetime(lxw_datetime *datetime);
+
+double lxw_datetime_to_excel_date_epoch(lxw_datetime *datetime,
+                                        uint8_t date_1904);
 
 char *lxw_strdup(const char *str);
 char *lxw_strdup_formula(const char *formula);
@@ -175,6 +213,7 @@ void lxw_str_tolower(char *str);
 #endif
 
 FILE *lxw_tmpfile(char *tmpdir);
+FILE *lxw_fopen(const char *filename, const char *mode);
 
 /* Use a user defined function to format doubles in sprintf or else a simple
  * macro (the default). */

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

@@ -0,0 +1,55 @@
+/*
+ * libxlsxwriter
+ *
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ *
+ * vml - A libxlsxwriter library for creating Excel XLSX vml files.
+ *
+ */
+#ifndef __LXW_VML_H__
+#define __LXW_VML_H__
+
+#include <stdint.h>
+
+#include "common.h"
+#include "worksheet.h"
+
+/*
+ * Struct to represent a vml object.
+ */
+typedef struct lxw_vml {
+
+    FILE *file;
+    uint8_t type;
+    struct lxw_comment_objs *button_objs;
+    struct lxw_comment_objs *comment_objs;
+    struct lxw_comment_objs *image_objs;
+    char *vml_data_id_str;
+    uint32_t vml_shape_id;
+    uint8_t comment_display_default;
+
+} lxw_vml;
+
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+extern "C" {
+#endif
+/* *INDENT-ON* */
+
+lxw_vml *lxw_vml_new(void);
+void lxw_vml_free(lxw_vml *vml);
+void lxw_vml_assemble_xml_file(lxw_vml *self);
+
+/* Declarations required for unit testing. */
+#ifdef TESTING
+
+#endif /* TESTING */
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+}
+#endif
+/* *INDENT-ON* */
+
+#endif /* __LXW_VML_H__ */

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

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -57,6 +57,7 @@
 /* Define the tree.h RB structs for the red-black head types. */
 RB_HEAD(lxw_worksheet_names, lxw_worksheet_name);
 RB_HEAD(lxw_chartsheet_names, lxw_chartsheet_name);
+RB_HEAD(lxw_image_md5s, lxw_image_md5);
 
 /* Define the queue.h structs for the workbook lists. */
 STAILQ_HEAD(lxw_sheets, lxw_sheet);
@@ -65,7 +66,7 @@ STAILQ_HEAD(lxw_chartsheets, lxw_chartsheet);
 STAILQ_HEAD(lxw_charts, lxw_chart);
 TAILQ_HEAD(lxw_defined_names, lxw_defined_name);
 
-/* TODO */
+/* Struct to hold the 2 sheet types. */
 typedef struct lxw_sheet {
     uint8_t is_chartsheet;
 
@@ -93,6 +94,14 @@ typedef struct lxw_chartsheet_name {
     RB_ENTRY (lxw_chartsheet_name) tree_pointers;
 } lxw_chartsheet_name;
 
+/* Struct to represent an image MD5/ID pair. */
+typedef struct lxw_image_md5 {
+    uint32_t id;
+    char *md5;
+
+    RB_ENTRY (lxw_image_md5) tree_pointers;
+} lxw_image_md5;
+
 /* Wrapper around RB_GENERATE_STATIC from tree.h to avoid unused function
  * warnings and to avoid portability issues with the _unused attribute. */
 #define LXW_RB_GENERATE_WORKSHEET_NAMES(name, type, field, cmp)  \
@@ -117,6 +126,17 @@ typedef struct lxw_chartsheet_name {
     /* Add unused struct to allow adding a semicolon */          \
     struct lxw_rb_generate_charsheet_names{int unused;}
 
+#define LXW_RB_GENERATE_IMAGE_MD5S(name, type, field, cmp) \
+    RB_GENERATE_INSERT_COLOR(name, type, field, static)          \
+    RB_GENERATE_REMOVE_COLOR(name, type, field, static)          \
+    RB_GENERATE_INSERT(name, type, field, cmp, static)           \
+    RB_GENERATE_REMOVE(name, type, field, static)                \
+    RB_GENERATE_FIND(name, type, field, cmp, static)             \
+    RB_GENERATE_NEXT(name, type, field, static)                  \
+    RB_GENERATE_MINMAX(name, type, field, static)                \
+    /* Add unused struct to allow adding a semicolon */          \
+    struct lxw_rb_generate_image_md5s{int unused;}
+
 /**
  * @brief Macro to loop over all the worksheets in a workbook.
  *
@@ -158,7 +178,7 @@ typedef struct lxw_defined_name {
 } lxw_defined_name;
 
 /**
- * Workbook document properties.
+ * Workbook document properties. Set any unused fields to NULL or 0.
  */
 typedef struct lxw_doc_properties {
     /** The title of the Excel Document. */
@@ -188,9 +208,13 @@ typedef struct lxw_doc_properties {
     /** The status of the Excel Document. */
     char *status;
 
-    /** The hyperlink base url of the Excel Document. */
+    /** The hyperlink base URL of the Excel Document. */
     char *hyperlink_base;
 
+    /** The file creation date/time shown in Excel. This defaults to the
+     * current time and date if set to 0. If you wish to create files that are
+     * binary equivalent (for the same input data) then you should set this
+     * creation date/time to a known value. */
     time_t created;
 
 } lxw_doc_properties;
@@ -254,6 +278,8 @@ typedef struct lxw_workbook {
     struct lxw_chartsheets *chartsheets;
     struct lxw_worksheet_names *worksheet_names;
     struct lxw_chartsheet_names *chartsheet_names;
+    struct lxw_image_md5s *image_md5s;
+    struct lxw_image_md5s *header_image_md5s;
     struct lxw_charts *charts;
     struct lxw_charts *ordered_charts;
     struct lxw_formats *formats;
@@ -271,23 +297,31 @@ typedef struct lxw_workbook {
     uint16_t first_sheet;
     uint16_t active_sheet;
     uint16_t num_xf_formats;
+    uint16_t num_dxf_formats;
     uint16_t num_format_count;
     uint16_t drawing_count;
+    uint16_t comment_count;
 
     uint16_t font_count;
     uint16_t border_count;
     uint16_t fill_count;
     uint8_t optimize;
+    uint16_t max_url_length;
 
     uint8_t has_png;
     uint8_t has_jpeg;
     uint8_t has_bmp;
+    uint8_t has_vml;
+    uint8_t has_comments;
 
     lxw_hash_table *used_xf_formats;
+    lxw_hash_table *used_dxf_formats;
 
     char *vba_project;
     char *vba_codename;
 
+    lxw_format *default_url_format;
+
 } lxw_workbook;
 
 
@@ -365,13 +399,6 @@ lxw_workbook *workbook_new(const char *filename);
 lxw_workbook *workbook_new_opt(const char *filename,
                                lxw_workbook_options *options);
 
-/* Deprecated function name for backwards compatibility. */
-lxw_workbook *new_workbook(const char *filename);
-
-/* Deprecated function name for backwards compatibility. */
-lxw_workbook *new_workbook_opt(const char *filename,
-                               lxw_workbook_options *options);
-
 /**
  * @brief Add a new worksheet to a workbook.
  *
@@ -404,12 +431,15 @@ lxw_workbook *new_workbook_opt(const char *filename,
  * - 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.
+ *
+ * @note You should also avoid using the worksheet name "History" (case
+ * insensitive) which is reserved in English language versions of
+ * Excel. Non-English versions may have restrictions on the equivalent word.
  */
 lxw_worksheet *workbook_add_worksheet(lxw_workbook *workbook,
                                       const char *sheetname);
@@ -443,13 +473,16 @@ lxw_worksheet *workbook_add_worksheet(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 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.
  *
+ * @note You should also avoid using the worksheet name "History" (case
+ * insensitive) which is reserved in English language versions of
+ * Excel. Non-English versions may have restrictions on the equivalent word.
+ *
  * 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
  * "Worksheet" object is used to write data and configure a worksheet in the
@@ -527,6 +560,8 @@ lxw_format *workbook_add_format(lxw_workbook *workbook);
  * | #LXW_CHART_COLUMN_STACKED_PERCENT        | Column chart - percentage stacked.     |
  * | #LXW_CHART_DOUGHNUT                      | Doughnut chart.                        |
  * | #LXW_CHART_LINE                          | Line chart.                            |
+ * | #LXW_CHART_LINE_STACKED                  | Line chart - stacked.                  |
+ * | #LXW_CHART_LINE_STACKED_PERCENT          | Line chart - percentage stacked.       |
  * | #LXW_CHART_PIE                           | Pie chart.                             |
  * | #LXW_CHART_SCATTER                       | Scatter chart.                         |
  * | #LXW_CHART_SCATTER_STRAIGHT              | Scatter chart - straight.              |
@@ -594,10 +629,11 @@ lxw_error workbook_close(lxw_workbook *workbook);
  * - `keywords`
  * - `comments`
  * - `hyperlink_base`
+ * - `created`
  *
  * The properties are specified via a `lxw_doc_properties` struct. All the
- * members are `char *` and they are all optional. An example of how to create
- * and pass the properties is:
+ * fields are all optional. An example of how to create and pass the
+ * properties is:
  *
  * @code
  *     // Create a properties structure and set some of the fields.
@@ -619,6 +655,12 @@ lxw_error workbook_close(lxw_workbook *workbook);
  *
  * @image html doc_properties.png
  *
+ * The `created` parameter sets the file creation date/time shown in
+ * Excel. This defaults to the current time and date if set to 0. If you wish
+ * to create files that are binary equivalent (for the same input data) then
+ * you should set this creation date/time to a known value using a `time_t`
+ * value.
+ *
  */
 lxw_error workbook_set_properties(lxw_workbook *workbook,
                                   lxw_doc_properties *properties);
@@ -771,13 +813,32 @@ lxw_error workbook_set_custom_property_datetime(lxw_workbook *workbook,
  * @endcode
  *
  * The rules for names in Excel are explained in the
- * [Microsoft Office
-documentation](http://office.microsoft.com/en-001/excel-help/define-and-use-names-in-formulas-HA010147120.aspx).
+ * [Microsoft Office documentation](http://office.microsoft.com/en-001/excel-help/define-and-use-names-in-formulas-HA010147120.aspx).
  *
  */
 lxw_error workbook_define_name(lxw_workbook *workbook, const char *name,
                                const char *formula);
 
+/**
+ * @brief Get the default URL format used with `worksheet_write_url()`.
+ *
+ * @param  workbook Pointer to a lxw_workbook instance.
+ * @return A lxw_format instance that has hyperlink properties set.
+ *
+ * This function returns a lxw_format instance that is used for the default
+ * blue underline hyperlink in the `worksheet_write_url()` function when a
+ * format isn't specified:
+ *
+ * @code
+ *     lxw_format *url_format = workbook_get_default_url_format(workbook);
+ * @endcode
+ *
+ * The format is the hyperlink style defined by Excel for the default theme.
+ * This format is only ever required when overwriting a string URL with
+ * data of a different type. See the example below.
+ */
+lxw_format *workbook_get_default_url_format(lxw_workbook *workbook);
+
 /**
  * @brief Get a worksheet object from its name.
  *
@@ -828,7 +889,6 @@ 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 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
@@ -839,6 +899,10 @@ 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 You should also avoid using the worksheet name "History" (case
+ * insensitive) which is reserved in English language versions of
+ * Excel. Non-English versions may have restrictions on the equivalent word.
+ *
  * @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
@@ -909,6 +973,7 @@ 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);
+void workbook_unset_default_url_format(lxw_workbook *workbook);
 
 /* Declarations required for unit testing. */
 #ifdef TESTING