fast_excel 0.1.4 → 0.1.5

data/libxlsxwriter/include/xlsxwriter/common.h

@@ -0,0 +1,372 @@
+/*
+ * libxlsxwriter
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ */
+
+/**
+ * @file common.h
+ *
+ * @brief Common functions and defines for the libxlsxwriter library.
+ *
+ * <!-- Copyright 2014-2017, John McNamara, jmcnamara@cpan.org -->
+ *
+ */
+#ifndef __LXW_COMMON_H__
+#define __LXW_COMMON_H__
+
+#include <time.h>
+#include "third_party/queue.h"
+#include "third_party/tree.h"
+
+#ifndef TESTING
+#define STATIC static
+#else
+#define STATIC
+#endif
+
+/** Integer data type to represent a row value. Equivalent to `uint32_t`.
+ *
+ * The maximum row in Excel is 1,048,576.
+ */
+typedef uint32_t lxw_row_t;
+
+/** Integer data type to represent a column value. Equivalent to `uint16_t`.
+ *
+ * The maximum column in Excel is 16,384.
+ */
+typedef uint16_t lxw_col_t;
+
+/** Boolean values used in libxlsxwriter. */
+enum lxw_boolean {
+    /** False value. */
+    LXW_FALSE,
+    /** True value. */
+    LXW_TRUE
+};
+
+/**
+ * @brief Error codes from libxlsxwriter functions.
+ *
+ * See the `lxw_strerror()` function for an example of how to convert the
+ * enum number to a descriptive error message string.
+ */
+typedef enum lxw_error {
+
+    /** No error. */
+    LXW_NO_ERROR = 0,
+
+    /** Memory error, failed to malloc() required memory. */
+    LXW_ERROR_MEMORY_MALLOC_FAILED,
+
+    /** Error creating output xlsx file. Usually a permissions error. */
+    LXW_ERROR_CREATING_XLSX_FILE,
+
+    /** Error encountered when creating a tmpfile during file assembly. */
+    LXW_ERROR_CREATING_TMPFILE,
+
+    /** Zlib error with a file operation while creating xlsx file. */
+    LXW_ERROR_ZIP_FILE_OPERATION,
+
+    /** Zlib error when adding sub file to xlsx file. */
+    LXW_ERROR_ZIP_FILE_ADD,
+
+    /** Zlib error when closing xlsx file. */
+    LXW_ERROR_ZIP_CLOSE,
+
+    /** NULL function parameter ignored. */
+    LXW_ERROR_NULL_PARAMETER_IGNORED,
+
+    /** Function parameter validation error. */
+    LXW_ERROR_PARAMETER_VALIDATION,
+
+    /** Worksheet name exceeds Excel's limit of 31 characters. */
+    LXW_ERROR_SHEETNAME_LENGTH_EXCEEDED,
+
+    /** Worksheet name contains invalid Excel character: '[]:*?/\\' */
+    LXW_ERROR_INVALID_SHEETNAME_CHARACTER,
+
+    /** Worksheet name is already in use. */
+    LXW_ERROR_SHEETNAME_ALREADY_USED,
+
+    /** Parameter exceeds Excel's limit of 128 characters. */
+    LXW_ERROR_128_STRING_LENGTH_EXCEEDED,
+
+    /** Parameter exceeds Excel's limit of 255 characters. */
+    LXW_ERROR_255_STRING_LENGTH_EXCEEDED,
+
+    /** String exceeds Excel's limit of 32,767 characters. */
+    LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED,
+
+    /** Error finding internal string index. */
+    LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND,
+
+    /** Worksheet row or column index out of range. */
+    LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE,
+
+    /** Maximum number of worksheet URLs (65530) exceeded. */
+    LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED,
+
+    /** Couldn't read image dimensions or DPI. */
+    LXW_ERROR_IMAGE_DIMENSIONS,
+
+    LXW_MAX_ERRNO
+} lxw_error;
+
+/** @brief Struct to represent a date and time in Excel.
+ *
+ * Struct to represent a date and time in Excel. See @ref working_with_dates.
+ */
+typedef struct lxw_datetime {
+
+    /** Year     : 1900 - 9999 */
+    int year;
+    /** Month    : 1 - 12 */
+    int month;
+    /** Day      : 1 - 31 */
+    int day;
+    /** Hour     : 0 - 23 */
+    int hour;
+    /** Minute   : 0 - 59 */
+    int min;
+    /** Seconds  : 0 - 59.999 */
+    double sec;
+
+} lxw_datetime;
+
+enum lxw_custom_property_types {
+    LXW_CUSTOM_NONE,
+    LXW_CUSTOM_STRING,
+    LXW_CUSTOM_DOUBLE,
+    LXW_CUSTOM_INTEGER,
+    LXW_CUSTOM_BOOLEAN,
+    LXW_CUSTOM_DATETIME
+};
+
+/* Excel sheetname max of 31 chars. */
+#define LXW_SHEETNAME_MAX         31
+
+/* Max with all worksheet chars 4xUTF-8 bytes + start and end quotes + \0. */
+#define LXW_MAX_SHEETNAME_LENGTH  ((LXW_SHEETNAME_MAX * 4) + 2 + 1)
+
+/* Max col string length. */
+#define LXW_MAX_COL_NAME_LENGTH   sizeof("$XFD")
+
+/* Max row string length. */
+#define LXW_MAX_ROW_NAME_LENGTH   sizeof("$1048576")
+
+/* Max cell string length. */
+#define LXW_MAX_CELL_NAME_LENGTH  sizeof("$XFWD$1048576")
+
+/* Max range: $XFWD$1048576:$XFWD$1048576\0 */
+#define LXW_MAX_CELL_RANGE_LENGTH (LXW_MAX_CELL_NAME_LENGTH * 2)
+
+/* Max range formula Sheet1!$A$1:$C$5$ style. */
+#define LXW_MAX_FORMULA_RANGE_LENGTH (LXW_MAX_SHEETNAME_LENGTH + LXW_MAX_CELL_RANGE_LENGTH)
+
+/* Datetime string length. */
+#define LXW_DATETIME_LENGTH       sizeof("2016-12-12T23:00:00Z")
+
+#define LXW_EPOCH_1900            0
+#define LXW_EPOCH_1904            1
+
+#define LXW_UINT32_T_LENGTH       sizeof("4294967296")
+#define LXW_FILENAME_LENGTH       128
+#define LXW_IGNORE                1
+
+#define LXW_SCHEMA_MS        "http://schemas.microsoft.com/office/2006/relationships"
+#define LXW_SCHEMA_ROOT      "http://schemas.openxmlformats.org"
+#define LXW_SCHEMA_DRAWING   LXW_SCHEMA_ROOT "/drawingml/2006"
+#define LXW_SCHEMA_OFFICEDOC LXW_SCHEMA_ROOT "/officeDocument/2006"
+#define LXW_SCHEMA_PACKAGE   LXW_SCHEMA_ROOT "/package/2006/relationships"
+#define LXW_SCHEMA_DOCUMENT  LXW_SCHEMA_ROOT "/officeDocument/2006/relationships"
+#define LXW_SCHEMA_CONTENT   LXW_SCHEMA_ROOT "/package/2006/content-types"
+
+#define LXW_ERROR(message)                      \
+    fprintf(stderr, "[ERROR][%s:%d]: " message "\n", __FILE__, __LINE__)
+
+#define LXW_MEM_ERROR()                         \
+    LXW_ERROR("Memory allocation failed.")
+
+#define GOTO_LABEL_ON_MEM_ERROR(pointer, label) \
+    if (!pointer) {                             \
+        LXW_MEM_ERROR();                        \
+        goto label;                             \
+    }
+
+#define RETURN_ON_MEM_ERROR(pointer, error)     \
+    if (!pointer) {                             \
+        LXW_MEM_ERROR();                        \
+        return error;                           \
+    }
+
+#define RETURN_VOID_ON_MEM_ERROR(pointer)       \
+    if (!pointer) {                             \
+        LXW_MEM_ERROR();                        \
+        return;                                 \
+    }
+
+#define RETURN_ON_ERROR(error)                  \
+    if (error)                                  \
+        return error;
+
+#define LXW_WARN(message)                       \
+    fprintf(stderr, "[WARNING]: " message "\n")
+
+/* We can't use variadic macros here since we support ANSI C. */
+#define LXW_WARN_FORMAT(message)                \
+    fprintf(stderr, "[WARNING]: " message "\n")
+
+#define LXW_WARN_FORMAT1(message, var)          \
+    fprintf(stderr, "[WARNING]: " message "\n", var)
+
+#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) | \
+                               (((n) & 0xFF0000)   >>  8) | \
+                               (((n) & 0xFF000000) >> 24))
+#define LXW_UINT16_NETWORK(n) ((((n) & 0x00FF) << 8) | (((n) & 0xFF00) >> 8))
+#else
+#define LXW_UINT32_NETWORK(n) (n)
+#define LXW_UINT16_NETWORK(n) (n)
+#endif
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+extern "C" {
+#endif
+/* *INDENT-ON* */
+
+/* Compilers that have a native snprintf() can use it directly. */
+#ifdef _MSC_VER
+#define LXW_HAS_SNPRINTF
+#endif
+
+#ifdef LXW_HAS_SNPRINTF
+#define lxw_snprintf snprintf
+#else
+#define lxw_snprintf __builtin_snprintf
+#endif
+
+/* Define a snprintf for MSVC 2010. */
+#if defined(_MSC_VER) && _MSC_VER < 1900
+
+#include <stdarg.h>
+#define snprintf msvc2010_snprintf
+#define vsnprintf msvc2010_vsnprintf
+
+__inline int
+msvc2010_vsnprintf(char *str, size_t size, const char *format, va_list ap)
+{
+    int count = -1;
+
+    if (size != 0)
+        count = _vsnprintf_s(str, size, _TRUNCATE, format, ap);
+    if (count == -1)
+        count = _vscprintf(format, ap);
+
+    return count;
+}
+
+__inline int
+msvc2010_snprintf(char *str, size_t size, const char *format, ...)
+{
+    int count;
+    va_list ap;
+
+    va_start(ap, format);
+    count = msvc2010_vsnprintf(str, size, format, ap);
+    va_end(ap);
+
+    return count;
+}
+
+#endif
+
+/* Safer strcpy for fixed width char arrays. */
+#define lxw_strcpy(dest, src) \
+    lxw_snprintf(dest, sizeof(dest), "%s", src)
+
+/* Define the queue.h structs for the formats list. */
+STAILQ_HEAD(lxw_formats, lxw_format);
+
+/* Define the queue.h structs for the generic data structs. */
+STAILQ_HEAD(lxw_tuples, lxw_tuple);
+STAILQ_HEAD(lxw_custom_properties, lxw_custom_property);
+
+typedef struct lxw_tuple {
+    char *key;
+    char *value;
+
+    STAILQ_ENTRY (lxw_tuple) list_pointers;
+} lxw_tuple;
+
+/* Define custom property used in workbook.c and custom.c. */
+typedef struct lxw_custom_property {
+
+    enum lxw_custom_property_types type;
+    char *name;
+
+    union {
+        char *string;
+        double number;
+        int32_t integer;
+        uint8_t boolean;
+        lxw_datetime datetime;
+    } u;
+
+    STAILQ_ENTRY (lxw_custom_property) list_pointers;
+
+} lxw_custom_property;
+
+/* Declarations required for unit testing. */
+#ifdef TESTING
+
+#endif /* TESTING */
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+}
+#endif
+/* *INDENT-ON* */
+
+#endif /* __LXW_COMMON_H__ */

data/libxlsxwriter/include/xlsxwriter/content_types.h

@@ -0,0 +1,74 @@
+/*
+ * libxlsxwriter
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ *
+ * content_types - A libxlsxwriter library for creating Excel XLSX
+ *                 content_types files.
+ *
+ */
+#ifndef __LXW_CONTENT_TYPES_H__
+#define __LXW_CONTENT_TYPES_H__
+
+#include <stdint.h>
+#include <string.h>
+
+#include "common.h"
+
+#define LXW_APP_PACKAGE  "application/vnd.openxmlformats-package."
+#define LXW_APP_DOCUMENT "application/vnd.openxmlformats-officedocument."
+
+/*
+ * Struct to represent a content_types.
+ */
+typedef struct lxw_content_types {
+
+    FILE *file;
+
+    struct lxw_tuples *default_types;
+    struct lxw_tuples *overrides;
+
+} lxw_content_types;
+
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+extern "C" {
+#endif
+/* *INDENT-ON* */
+
+lxw_content_types *lxw_content_types_new();
+void lxw_content_types_free(lxw_content_types *content_types);
+void lxw_content_types_assemble_xml_file(lxw_content_types *content_types);
+void lxw_ct_add_default(lxw_content_types *content_types, const char *key,
+                        const char *value);
+void lxw_ct_add_override(lxw_content_types *content_types, const char *key,
+                         const char *value);
+void lxw_ct_add_worksheet_name(lxw_content_types *content_types,
+                               const char *name);
+void lxw_ct_add_chart_name(lxw_content_types *content_types,
+                           const char *name);
+void lxw_ct_add_drawing_name(lxw_content_types *content_types,
+                             const char *name);
+void lxw_ct_add_shared_strings(lxw_content_types *content_types);
+void lxw_ct_add_calc_chain(lxw_content_types *content_types);
+void lxw_ct_add_custom_properties(lxw_content_types *content_types);
+
+/* Declarations required for unit testing. */
+#ifdef TESTING
+
+STATIC void _content_types_xml_declaration(lxw_content_types *self);
+STATIC void _write_default(lxw_content_types *self, const char *ext,
+                           const char *type);
+STATIC void _write_override(lxw_content_types *self, const char *part_name,
+                            const char *type);
+
+#endif /* TESTING */
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+}
+#endif
+/* *INDENT-ON* */
+
+#endif /* __LXW_CONTENT_TYPES_H__ */

data/libxlsxwriter/include/xlsxwriter/core.h

@@ -0,0 +1,51 @@
+/*
+ * libxlsxwriter
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ *
+ * core - A libxlsxwriter library for creating Excel XLSX core files.
+ *
+ */
+#ifndef __LXW_CORE_H__
+#define __LXW_CORE_H__
+
+#include <stdint.h>
+
+#include "workbook.h"
+#include "common.h"
+
+/*
+ * Struct to represent a core.
+ */
+typedef struct lxw_core {
+
+    FILE *file;
+    lxw_doc_properties *properties;
+
+} lxw_core;
+
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+extern "C" {
+#endif
+/* *INDENT-ON* */
+
+lxw_core *lxw_core_new();
+void lxw_core_free(lxw_core *core);
+void lxw_core_assemble_xml_file(lxw_core *self);
+
+/* Declarations required for unit testing. */
+#ifdef TESTING
+
+STATIC void _core_xml_declaration(lxw_core *self);
+
+#endif /* TESTING */
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+}
+#endif
+/* *INDENT-ON* */
+
+#endif /* __LXW_CORE_H__ */

data/libxlsxwriter/include/xlsxwriter/custom.h

@@ -0,0 +1,52 @@
+/*
+ * libxlsxwriter
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ *
+ * custom - A libxlsxwriter library for creating Excel custom property files.
+ *
+ */
+#ifndef __LXW_CUSTOM_H__
+#define __LXW_CUSTOM_H__
+
+#include <stdint.h>
+
+#include "common.h"
+
+/*
+ * Struct to represent a custom property file object.
+ */
+typedef struct lxw_custom {
+
+    FILE *file;
+
+    struct lxw_custom_properties *custom_properties;
+    uint32_t pid;
+
+} lxw_custom;
+
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+extern "C" {
+#endif
+/* *INDENT-ON* */
+
+lxw_custom *lxw_custom_new();
+void lxw_custom_free(lxw_custom *custom);
+void lxw_custom_assemble_xml_file(lxw_custom *self);
+
+/* Declarations required for unit testing. */
+#ifdef TESTING
+
+STATIC void _custom_xml_declaration(lxw_custom *self);
+
+#endif /* TESTING */
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+}
+#endif
+/* *INDENT-ON* */
+
+#endif /* __LXW_CUSTOM_H__ */

data/libxlsxwriter/include/xlsxwriter/drawing.h

@@ -0,0 +1,111 @@
+/*
+ * libxlsxwriter
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ *
+ * drawing - A libxlsxwriter library for creating Excel XLSX drawing files.
+ *
+ */
+#ifndef __LXW_DRAWING_H__
+#define __LXW_DRAWING_H__
+
+#include <stdint.h>
+
+#include "common.h"
+
+STAILQ_HEAD(lxw_drawing_objects, lxw_drawing_object);
+
+enum lxw_drawing_types {
+    LXW_DRAWING_NONE = 0,
+    LXW_DRAWING_IMAGE,
+    LXW_DRAWING_CHART,
+    LXW_DRAWING_SHAPE
+};
+
+enum lxw_anchor_types {
+    LXW_ANCHOR_TYPE_NONE = 0,
+    LXW_ANCHOR_TYPE_IMAGE,
+    LXW_ANCHOR_TYPE_CHART
+};
+
+enum lxw_anchor_edit_types {
+    LXW_ANCHOR_EDIT_AS_NONE = 0,
+    LXW_ANCHOR_EDIT_AS_RELATIVE,
+    LXW_ANCHOR_EDIT_AS_ONE_CELL,
+    LXW_ANCHOR_EDIT_AS_ABSOLUTE
+};
+
+enum image_types {
+    LXW_IMAGE_UNKNOWN = 0,
+    LXW_IMAGE_PNG,
+    LXW_IMAGE_JPEG,
+    LXW_IMAGE_BMP
+};
+
+/* Coordinates used in a drawing object. */
+typedef struct lxw_drawing_coords {
+    uint32_t col;
+    uint32_t row;
+    double col_offset;
+    double row_offset;
+} lxw_drawing_coords;
+
+/* Object to represent the properties of a drawing. */
+typedef struct lxw_drawing_object {
+    uint8_t anchor_type;
+    uint8_t edit_as;
+    struct lxw_drawing_coords from;
+    struct lxw_drawing_coords to;
+    uint32_t col_absolute;
+    uint32_t row_absolute;
+    uint32_t width;
+    uint32_t height;
+    uint8_t shape;
+    char *description;
+    char *url;
+    char *tip;
+
+    STAILQ_ENTRY (lxw_drawing_object) list_pointers;
+
+} lxw_drawing_object;
+
+/*
+ * Struct to represent a collection of drawings.
+ */
+typedef struct lxw_drawing {
+
+    FILE *file;
+
+    uint8_t embedded;
+
+    struct lxw_drawing_objects *drawing_objects;
+
+} lxw_drawing;
+
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+extern "C" {
+#endif
+/* *INDENT-ON* */
+
+lxw_drawing *lxw_drawing_new();
+void lxw_drawing_free(lxw_drawing *drawing);
+void lxw_drawing_assemble_xml_file(lxw_drawing *self);
+void lxw_free_drawing_object(struct lxw_drawing_object *drawing_object);
+void lxw_add_drawing_object(lxw_drawing *drawing,
+                            lxw_drawing_object *drawing_object);
+
+/* Declarations required for unit testing. */
+#ifdef TESTING
+
+STATIC void _drawing_xml_declaration(lxw_drawing *self);
+#endif /* TESTING */
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+}
+#endif
+/* *INDENT-ON* */
+
+#endif /* __LXW_DRAWING_H__ */