xlsxwriter 0.0.3 → 0.0.4.pre.2

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

@@ -16,8 +16,8 @@
 #define __LXW_COMMON_H__
 
 #include <time.h>
-#include "xlsxwriter/third_party/queue.h"
-#include "xlsxwriter/third_party/tree.h"
+#include "third_party/queue.h"
+#include "third_party/tree.h"
 
 #ifndef TESTING
 #define STATIC static
@@ -89,6 +89,9 @@ typedef enum lxw_error {
     /** Worksheet name is already in use. */
     LXW_ERROR_SHEETNAME_ALREADY_USED,
 
+    /** Parameter exceeds Excel's limit of 32 characters. */
+    LXW_ERROR_32_STRING_LENGTH_EXCEEDED,
+
     /** Parameter exceeds Excel's limit of 128 characters. */
     LXW_ERROR_128_STRING_LENGTH_EXCEEDED,
 
@@ -223,6 +226,42 @@ enum lxw_custom_property_types {
 #define LXW_WARN_FORMAT2(message, var1, var2)    \
     fprintf(stderr, "[WARNING]: " message "\n", var1, var2)
 
+/* Chart axis type checks. */
+#define LXW_WARN_CAT_AXIS_ONLY(function)                                   \
+    if (!axis->is_category) {                                              \
+        fprintf(stderr, "[WARNING]: "                                      \
+                function "() is only valid for category axes\n");          \
+       return;                                                             \
+    }
+
+#define LXW_WARN_VALUE_AXIS_ONLY(function)                                 \
+    if (!axis->is_value) {                                                 \
+        fprintf(stderr, "[WARNING]: "                                      \
+                function "() is only valid for value axes\n");             \
+       return;                                                             \
+    }
+
+#define LXW_WARN_DATE_AXIS_ONLY(function)                                  \
+    if (!axis->is_date) {                                                  \
+        fprintf(stderr, "[WARNING]: "                                      \
+                function "() is only valid for date axes\n");              \
+       return;                                                             \
+    }
+
+#define LXW_WARN_CAT_AND_DATE_AXIS_ONLY(function)                          \
+    if (!axis->is_category && !axis->is_date) {                            \
+        fprintf(stderr, "[WARNING]: "                                      \
+                function "() is only valid for category and date axes\n"); \
+       return;                                                             \
+    }
+
+#define LXW_WARN_VALUE_AND_DATE_AXIS_ONLY(function)                        \
+    if (!axis->is_value && !axis->is_date) {                               \
+        fprintf(stderr, "[WARNING]: "                                      \
+                function "() is only valid for value and date axes\n");    \
+       return;                                                             \
+    }
+
 #ifndef LXW_BIG_ENDIAN
 #define LXW_UINT32_NETWORK(n) ((((n) & 0xFF)       << 24) | \
                                (((n) & 0xFF00)     <<  8) | \

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

@@ -11,7 +11,7 @@
 
 #include <stdint.h>
 
-#include "xlsxwriter/workbook.h"
+#include "workbook.h"
 #include "common.h"
 
 /*

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

@@ -81,8 +81,8 @@ typedef int32_t lxw_color_t;
 #define LXW_PROPERTY_UNSET              -1
 #define LXW_COLOR_UNSET                 -1
 #define LXW_COLOR_MASK                  0xFFFFFF
-#define LXW_MIN_FONT_SIZE               1
-#define LXW_MAX_FONT_SIZE               409
+#define LXW_MIN_FONT_SIZE               1.0
+#define LXW_MAX_FONT_SIZE               409.0
 
 #define LXW_FORMAT_FIELD_COPY(dst, src)             \
     do{                                             \
@@ -360,7 +360,7 @@ typedef struct lxw_format {
     uint16_t font_index;
     uint8_t has_font;
     uint8_t has_dxf_font;
-    uint16_t font_size;
+    double font_size;
     uint8_t bold;
     uint8_t italic;
     lxw_color_t font_color;
@@ -427,7 +427,7 @@ typedef struct lxw_format {
 typedef struct lxw_font {
 
     char font_name[LXW_FORMAT_FIELD_LEN];
-    uint16_t font_size;
+    double font_size;
     uint8_t bold;
     uint8_t italic;
     uint8_t underline;
@@ -529,7 +529,7 @@ void format_set_font_name(lxw_format *format, const char *font_name);
  * size in the row. You can also explicitly specify the height of a
  * row using the worksheet_set_row() function.
  */
-void format_set_font_size(lxw_format *format, uint16_t size);
+void format_set_font_size(lxw_format *format, double size);
 
 /**
  * @brief Set the color of the font used in the cell.

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

@@ -10,7 +10,12 @@
 #define __LXW_PACKAGER_H__
 
 #include <stdint.h>
-#include "xlsxwriter/third_party/zip.h"
+
+#ifdef USE_SYSTEM_MINIZIP
+#include "minizip/zip.h"
+#else
+#include "third_party/zip.h"
+#endif
 
 #include "common.h"
 #include "workbook.h"
@@ -27,7 +32,7 @@
 
 #define LXW_ZIP_BUFFER_SIZE (16384)
 
-/*  * If zlib returns Z_ERRNO then errno is set and we can trap that. Otherwise
+/* If zlib returns Z_ERRNO then errno is set and we can trap that. Otherwise
  * return a default libxlsxwriter error. */
 #define RETURN_ON_ZIP_ERROR(err, default_err)   \
     if (err == Z_ERRNO)                         \
@@ -64,7 +69,7 @@ extern "C" {
 
 lxw_packager *lxw_packager_new(const char *filename, char *tmpdir);
 void lxw_packager_free(lxw_packager *packager);
-uint8_t lxw_create_package(lxw_packager *self);
+lxw_error lxw_create_package(lxw_packager *self);
 
 /* Declarations required for unit testing. */
 #ifdef TESTING

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

@@ -46,7 +46,7 @@ void lxw_styles_assemble_xml_file(lxw_styles *self);
 
 STATIC void _styles_xml_declaration(lxw_styles *self);
 STATIC void _write_style_sheet(lxw_styles *self);
-STATIC void _write_font_size(lxw_styles *self, uint16_t font_size);
+STATIC void _write_font_size(lxw_styles *self, double font_size);
 STATIC void _write_font_color_theme(lxw_styles *self, uint8_t theme);
 STATIC void _write_font_name(lxw_styles *self, const char *font_name);
 STATIC void _write_font_family(lxw_styles *self, uint8_t font_family);

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

@@ -145,6 +145,7 @@ uint16_t lxw_name_to_col_2(const char *col_str);
 double lxw_datetime_to_excel_date(lxw_datetime *datetime, uint8_t date_1904);
 
 char *lxw_strdup(const char *str);
+char *lxw_strdup_formula(const char *formula);
 
 size_t lxw_utf8_strlen(const char *str);
 

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

@@ -671,8 +671,8 @@ lxw_error workbook_define_name(lxw_workbook *workbook, const char *name,
 /**
  * @brief Get a worksheet object from its name.
  *
- * @param workbook
- * @param name
+ * @param workbook Pointer to a lxw_workbook instance.
+ * @param name     Worksheet name.
  *
  * @return A lxw_worksheet object.
  *

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

@@ -76,14 +76,131 @@
 enum lxw_gridlines {
     /** Hide screen and print gridlines. */
     LXW_HIDE_ALL_GRIDLINES = 0,
+
     /** Show screen gridlines. */
     LXW_SHOW_SCREEN_GRIDLINES,
+
     /** Show print gridlines. */
     LXW_SHOW_PRINT_GRIDLINES,
+
     /** Show screen and print gridlines. */
     LXW_SHOW_ALL_GRIDLINES
 };
 
+/** Data validation property values. */
+enum lxw_validation_boolean {
+    LXW_VALIDATION_DEFAULT,
+
+    /** Turn a data validation property off. */
+    LXW_VALIDATION_OFF,
+
+    /** Turn a data validation property on. Data validation properties are
+     * generally on by default. */
+    LXW_VALIDATION_ON
+};
+
+/** Data validation types. */
+enum lxw_validation_types {
+    LXW_VALIDATION_TYPE_NONE,
+
+    /** Restrict cell input to whole/integer numbers only. */
+    LXW_VALIDATION_TYPE_INTEGER,
+
+    /** Restrict cell input to whole/integer numbers only, using a cell
+     *  reference. */
+    LXW_VALIDATION_TYPE_INTEGER_FORMULA,
+
+    /** Restrict cell input to decimal numbers only. */
+    LXW_VALIDATION_TYPE_DECIMAL,
+
+    /** Restrict cell input to decimal numbers only, using a cell
+     * reference. */
+    LXW_VALIDATION_TYPE_DECIMAL_FORMULA,
+
+    /** Restrict cell input to a list of strings in a dropdown. */
+    LXW_VALIDATION_TYPE_LIST,
+
+    /** Restrict cell input to a list of strings in a dropdown, using a
+     * cell range. */
+    LXW_VALIDATION_TYPE_LIST_FORMULA,
+
+    /** Restrict cell input to date values only, using a lxw_datetime type. */
+    LXW_VALIDATION_TYPE_DATE,
+
+    /** Restrict cell input to date values only, using a cell reference. */
+    LXW_VALIDATION_TYPE_DATE_FORMULA,
+
+    /* Restrict cell input to date values only, as a serial number.
+     * Undocumented. */
+    LXW_VALIDATION_TYPE_DATE_NUMBER,
+
+    /** Restrict cell input to time values only, using a lxw_datetime type. */
+    LXW_VALIDATION_TYPE_TIME,
+
+    /** Restrict cell input to time values only, using a cell reference. */
+    LXW_VALIDATION_TYPE_TIME_FORMULA,
+
+    /* Restrict cell input to time values only, as a serial number.
+     * Undocumented. */
+    LXW_VALIDATION_TYPE_TIME_NUMBER,
+
+    /** Restrict cell input to strings of defined length, using a cell
+     * reference. */
+    LXW_VALIDATION_TYPE_LENGTH,
+
+    /** Restrict cell input to strings of defined length, using a cell
+     * reference. */
+    LXW_VALIDATION_TYPE_LENGTH_FORMULA,
+
+    /** Restrict cell to input controlled by a custom formula that returns
+     * `TRUE/FALSE`. */
+    LXW_VALIDATION_TYPE_CUSTOM_FORMULA,
+
+    /** Allow any type of input. Mainly only useful for pop-up messages. */
+    LXW_VALIDATION_TYPE_ANY
+};
+
+/** Data validation criteria uses to control the selection of data. */
+enum lxw_validation_criteria {
+    LXW_VALIDATION_CRITERIA_NONE,
+
+    /** Select data between two values. */
+    LXW_VALIDATION_CRITERIA_BETWEEN,
+
+    /** Select data that is not between two values. */
+    LXW_VALIDATION_CRITERIA_NOT_BETWEEN,
+
+    /** Select data equal to a value. */
+    LXW_VALIDATION_CRITERIA_EQUAL_TO,
+
+    /** Select data not equal to a value. */
+    LXW_VALIDATION_CRITERIA_NOT_EQUAL_TO,
+
+    /** Select data greater than a value. */
+    LXW_VALIDATION_CRITERIA_GREATER_THAN,
+
+    /** Select data less than a value. */
+    LXW_VALIDATION_CRITERIA_LESS_THAN,
+
+    /** Select data greater than or equal to a value. */
+    LXW_VALIDATION_CRITERIA_GREATER_THAN_OR_EQUAL_TO,
+
+    /** Select data less than or equal to a value. */
+    LXW_VALIDATION_CRITERIA_LESS_THAN_OR_EQUAL_TO
+};
+
+/** Data validation error types for pop-up messages. */
+enum lxw_validation_error_types {
+    /** Show a "Stop" data validation pop-up message. This is the default. */
+    LXW_VALIDATION_ERROR_TYPE_STOP,
+
+    /** Show an "Error" data validation pop-up message. */
+    LXW_VALIDATION_ERROR_TYPE_WARNING,
+
+    /** Show an "Information" data validation pop-up message. */
+    LXW_VALIDATION_ERROR_TYPE_INFORMATION
+};
+
 enum cell_types {
     NUMBER_CELL = 1,
     STRING_CELL,
@@ -140,6 +257,7 @@ struct lxw_table_rows {
 
 STAILQ_HEAD(lxw_merged_ranges, lxw_merged_range);
 STAILQ_HEAD(lxw_selections, lxw_selection);
+STAILQ_HEAD(lxw_data_validations, lxw_data_validation);
 STAILQ_HEAD(lxw_image_data, lxw_image_options);
 STAILQ_HEAD(lxw_chart_data, lxw_image_options);
 
@@ -229,6 +347,180 @@ typedef struct lxw_selection {
 
 } lxw_selection;
 
+/**
+ * @brief Worksheet data validation options.
+ */
+typedef struct lxw_data_validation {
+
+    /**
+     * Set the validation type. Should be a #lxw_validation_types value.
+     */
+    uint8_t validate;
+
+    /**
+     * Set the validation criteria type to select the data. Should be a
+     * #lxw_validation_criteria value.
+     */
+    uint8_t criteria;
+
+    /** Controls whether a data validation is not applied to blank data in the
+     * cell. Should be a #lxw_validation_boolean value. It is on by
+     * default.
+     */
+    uint8_t ignore_blank;
+
+    /**
+     * This parameter is used to toggle on and off the 'Show input message
+     * when cell is selected' option in the Excel data validation dialog. When
+     * the option is off an input message is not displayed even if it has been
+     * set using input_message. Should be a #lxw_validation_boolean value. It
+     * is on by default.
+     */
+    uint8_t show_input;
+
+    /**
+     * This parameter is used to toggle on and off the 'Show error alert
+     * after invalid data is entered' option in the Excel data validation
+     * dialog. When the option is off an error message is not displayed even
+     * if it has been set using error_message. Should be a
+     * #lxw_validation_boolean value. It is on by default.
+     */
+    uint8_t show_error;
+
+    /**
+     * This parameter is used to specify the type of error dialog that is
+     * displayed. Should be a #lxw_validation_error_types value.
+     */
+    uint8_t error_type;
+
+    /**
+     * This parameter is used to toggle on and off the 'In-cell dropdown'
+     * option in the Excel data validation dialog. When the option is on a
+     * dropdown list will be shown for list validations. Should be a
+     * #lxw_validation_boolean value. It is on by default.
+     */
+    uint8_t dropdown;
+
+    uint8_t is_between;
+
+    /**
+     * This parameter is used to set the limiting value to which the criteria
+     * is applied using a whole or decimal number.
+     */
+    double value_number;
+
+    /**
+     * This parameter is used to set the limiting value to which the criteria
+     * is applied using a cell reference. It is valid for any of the
+     * `_FORMULA` validation types.
+     */
+    char *value_formula;
+
+    /**
+     * This parameter is used to set a list of strings for a drop down list.
+     * The list should be a `NULL` terminated array of char* strings:
+     *
+     * @code
+     *    char *list[] = {"open", "high", "close", NULL};
+     *
+     *    data_validation->validate   = LXW_VALIDATION_TYPE_LIST;
+     *    data_validation->value_list = list;
+     * @endcode
+     *
+     * The `value_formula` parameter can also be used to specify a list from
+     * an Excel cell range.
+     *
+     * Note, the string list is restricted by Excel to 255 characters,
+     * including comma separators.
+     */
+    char **value_list;
+
+    /**
+     * This parameter is used to set the limiting value to which the date or
+     * time criteria is applied using a #lxw_datetime struct.
+     */
+    lxw_datetime value_datetime;
+
+    /**
+     * This parameter is the same as `value_number` but for the minimum value
+     * when a `BETWEEN` criteria is used.
+     */
+    double minimum_number;
+
+    /**
+     * This parameter is the same as `value_formula` but for the minimum value
+     * when a `BETWEEN` criteria is used.
+     */
+    char *minimum_formula;
+
+    /**
+     * This parameter is the same as `value_datetime` but for the minimum value
+     * when a `BETWEEN` criteria is used.
+     */
+    lxw_datetime minimum_datetime;
+
+    /**
+     * This parameter is the same as `value_number` but for the maximum value
+     * when a `BETWEEN` criteria is used.
+     */
+    double maximum_number;
+
+    /**
+     * This parameter is the same as `value_formula` but for the maximum value
+     * when a `BETWEEN` criteria is used.
+     */
+    char *maximum_formula;
+
+    /**
+     * This parameter is the same as `value_datetime` but for the maximum value
+     * when a `BETWEEN` criteria is used.
+     */
+    lxw_datetime maximum_datetime;
+
+    /**
+     * The input_title parameter is used to set the title of the input message
+     * that is displayed when a cell is entered. It has no default value and
+     * is only displayed if the input message is displayed. See the
+     * `input_message` parameter below.
+     *
+     * The maximum title length is 32 characters.
+     */
+    char *input_title;
+
+    /**
+     * The input_message parameter is used to set the input message that is
+     * displayed when a cell is entered. It has no default value.
+     *
+     * The message can be split over several lines using newlines. The maximum
+     * message length is 255 characters.
+     */
+    char *input_message;
+
+    /**
+     * The error_title parameter is used to set the title of the error message
+     * that is displayed when the data validation criteria is not met. The
+     * default error title is 'Microsoft Excel'. The maximum title length is
+     * 32 characters.
+     */
+    char *error_title;
+
+    /**
+     * The error_message parameter is used to set the error message that is
+     * displayed when a cell is entered. The default error message is "The
+     * value you entered is not valid. A user has restricted values that can
+     * be entered into the cell".
+     *
+     * The message can be split over several lines using newlines. The maximum
+     * message length is 255 characters.
+     */
+    char *error_message;
+
+    char sqref[LXW_MAX_CELL_RANGE_LENGTH];
+
+    STAILQ_ENTRY (lxw_data_validation) list_pointers;
+
+} lxw_data_validation;
+
 /**
  * @brief Options for inserted images
  *
@@ -354,6 +646,7 @@ typedef struct lxw_worksheet {
     struct lxw_cell **array;
     struct lxw_merged_ranges *merged_ranges;
     struct lxw_selections *selections;
+    struct lxw_data_validations *data_validations;
     struct lxw_image_data *image_data;
     struct lxw_chart_data *chart_data;
 
@@ -416,6 +709,7 @@ typedef struct lxw_worksheet {
     uint8_t vba_codename;
     uint8_t vcenter;
     uint8_t zoom_scale_normal;
+    uint8_t num_validations;
 
     lxw_color_t tab_color;
 
@@ -561,6 +855,10 @@ extern "C" {
  *
  * @image html write_number02.png
  *
+ * @note Excel doesn't support `NaN`, `Inf` or `-Inf` as a number value. If
+ * you are writing data that contains these values then your application
+ * should convert them to a string or handle them in some other way.
+ *
  */
 lxw_error worksheet_write_number(lxw_worksheet *worksheet,
                                  lxw_row_t row,
@@ -669,7 +967,7 @@ lxw_error worksheet_write_formula(lxw_worksheet *worksheet,
 /**
  * @brief Write an array formula to a worksheet cell.
  *
- * @param worksheet
+ * @param worksheet pointer to a lxw_worksheet instance to be updated.
  * @param first_row   The first row of the range. (All zero indexed.)
  * @param first_col   The first column of the range.
  * @param last_row    The last row of the range.
@@ -1470,6 +1768,87 @@ lxw_error worksheet_autofilter(lxw_worksheet *worksheet, lxw_row_t first_row,
                                lxw_col_t first_col, lxw_row_t last_row,
                                lxw_col_t last_col);
 
+/**
+ * @brief Add a data validation to a cell.
+ *
+ * @param worksheet  Pointer to a lxw_worksheet instance to be updated.
+ * @param row        The zero indexed row number.
+ * @param col        The zero indexed column number.
+ * @param validation A #lxw_data_validation object to control the validation.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_data_validation_cell()` function is used to construct an
+ * Excel data validation or to limit the user input to a dropdown list of
+ * values:
+ *
+ * @code
+ *
+ *    lxw_data_validation *data_validation = calloc(1, sizeof(lxw_data_validation));
+ *
+ *    data_validation->validate       = LXW_VALIDATION_TYPE_INTEGER;
+ *    data_validation->criteria       = LXW_VALIDATION_CRITERIA_BETWEEN;
+ *    data_validation->minimum_number = 1;
+ *    data_validation->maximum_number = 10;
+ *
+ *    worksheet_data_validation_cell(worksheet, 2, 1, data_validation);
+ *
+ *    // Same as above with the CELL() macro.
+ *    worksheet_data_validation_cell(worksheet, CELL("B3"), data_validation);
+ *
+ * @endcode
+ *
+ * @image html data_validate4.png
+ *
+ * Data validation and the various options of #lxw_data_validation are
+ * described in more detail in @ref working_with_data_validation.
+ */
+lxw_error worksheet_data_validation_cell(lxw_worksheet *worksheet,
+                                         lxw_row_t row, lxw_col_t col,
+                                         lxw_data_validation *validation);
+
+/**
+ * @brief Add a data validation to a range cell.
+ *
+ * @param worksheet  Pointer to a lxw_worksheet instance to be updated.
+ * @param first_row  The first row of the range. (All zero indexed.)
+ * @param first_col  The first column of the range.
+ * @param last_row   The last row of the range.
+ * @param last_col   The last col of the range.
+ * @param validation A #lxw_data_validation object to control the validation.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_data_validation_range()` function is the same as the
+ * `%worksheet_data_validation_cell()`, see above,  except the data validation
+ * is applied to a range of cells:
+ *
+ * @code
+ *
+ *    lxw_data_validation *data_validation = calloc(1, sizeof(lxw_data_validation));
+ *
+ *    data_validation->validate       = LXW_VALIDATION_TYPE_INTEGER;
+ *    data_validation->criteria       = LXW_VALIDATION_CRITERIA_BETWEEN;
+ *    data_validation->minimum_number = 1;
+ *    data_validation->maximum_number = 10;
+ *
+ *    worksheet_data_validation_range(worksheet, 2, 1, 4, 1, data_validation);
+ *
+ *    // Same as above with the RANGE() macro.
+ *    worksheet_data_validation_range(worksheet, RANGE("B3:B5"), data_validation);
+ *
+ * @endcode
+ *
+ * Data validation and the various options of #lxw_data_validation are
+ * described in more detail in @ref working_with_data_validation.
+ */
+lxw_error worksheet_data_validation_range(lxw_worksheet *worksheet,
+                                          lxw_row_t first_row,
+                                          lxw_col_t first_col,
+                                          lxw_row_t last_row,
+                                          lxw_col_t last_col,
+                                          lxw_data_validation *validation);
+
  /**
   * @brief Make a worksheet the active, i.e., visible worksheet.
   *
@@ -2630,6 +3009,7 @@ STATIC void _worksheet_write_print_options(lxw_worksheet *worksheet);
 STATIC void _worksheet_write_sheet_pr(lxw_worksheet *worksheet);
 STATIC void _worksheet_write_tab_color(lxw_worksheet *worksheet);
 STATIC void _worksheet_write_sheet_protection(lxw_worksheet *worksheet);
+STATIC void _worksheet_write_data_validations(lxw_worksheet *self);
 #endif /* TESTING */
 
 /* *INDENT-OFF* */