/*****************************************************************************
 * rich_value_types - A library for creating Excel XLSX rich_value_types files.
 *
 * Used in conjunction with the libxlsxwriter library.
 *
 * Copyright 2014-2026, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
 *
 */

#include "xlsxwriter/xmlwriter.h"
#include "xlsxwriter/rich_value_types.h"
#include "xlsxwriter/utility.h"

/*
 * Forward declarations.
 */

/*****************************************************************************
 *
 * Private functions.
 *
 ****************************************************************************/

/*
 * Create a new rich_value_types object.
 */
lxw_rich_value_types *
lxw_rich_value_types_new(void)
{
    lxw_rich_value_types *rich_value_types =
        calloc(1, sizeof(lxw_rich_value_types));
    GOTO_LABEL_ON_MEM_ERROR(rich_value_types, mem_error);

    return rich_value_types;

mem_error:
    lxw_rich_value_types_free(rich_value_types);
    return NULL;
}

/*
 * Free a rich_value_types object.
 */
void
lxw_rich_value_types_free(lxw_rich_value_types *rich_value_types)
{
    if (!rich_value_types)
        return;

    free(rich_value_types);
}

/*****************************************************************************
 *
 * XML functions.
 *
 ****************************************************************************/

/*
 * Write the XML declaration.
 */
STATIC void
_rich_value_types_xml_declaration(lxw_rich_value_types *self)
{
    lxw_xml_declaration(self->file);
}

/*****************************************************************************
 *
 * XML file assembly functions.
 *
 ****************************************************************************/

/*
 * Write the <rvTypesInfo> element.
 */
STATIC void
_rich_value_types_write_rv_types_info(lxw_rich_value_types *self)
{
    struct xml_attribute_list attributes;
    struct xml_attribute *attribute;
    char xmlns[] =
        "http://schemas.microsoft.com/office/spreadsheetml/2017/richdata2";
    char xmlns_mc[] =
        "http://schemas.openxmlformats.org/markup-compatibility/2006";
    char xmlns_x[] =
        "http://schemas.openxmlformats.org/spreadsheetml/2006/main";
    char mc_ignorable[] = "x";

    LXW_INIT_ATTRIBUTES();
    LXW_PUSH_ATTRIBUTES_STR("xmlns", xmlns);
    LXW_PUSH_ATTRIBUTES_STR("xmlns:mc", xmlns_mc);
    LXW_PUSH_ATTRIBUTES_STR("mc:Ignorable", mc_ignorable);
    LXW_PUSH_ATTRIBUTES_STR("xmlns:x", xmlns_x);

    lxw_xml_start_tag(self->file, "rvTypesInfo", &attributes);

    LXW_FREE_ATTRIBUTES();
}

/*
 * Write the <flag> element.
 */
STATIC void
_rich_value_types_write_flag(lxw_rich_value_types *self, char *name)
{
    struct xml_attribute_list attributes;
    struct xml_attribute *attribute;

    LXW_INIT_ATTRIBUTES();
    LXW_PUSH_ATTRIBUTES_STR("name", name);
    LXW_PUSH_ATTRIBUTES_STR("value", "1");

    lxw_xml_empty_tag(self->file, "flag", &attributes);

    LXW_FREE_ATTRIBUTES();
}

/*
 * Write the <key> element.
 */
STATIC void
_rich_value_types_write_key(lxw_rich_value_types *self, char *name)
{
    struct xml_attribute_list attributes;
    struct xml_attribute *attribute;

    LXW_INIT_ATTRIBUTES();
    LXW_PUSH_ATTRIBUTES_STR("name", name);

    lxw_xml_start_tag(self->file, "key", &attributes);

    LXW_FREE_ATTRIBUTES();
}

/*
 * Write the <keyFlags> element.
 */
STATIC void
_rich_value_types_write_key_flags(lxw_rich_value_types *self)
{
    int i;
    char *key_flags[10][3] = {
        {"_Self", "ExcludeFromFile", "ExcludeFromCalcComparison"},
        {"_DisplayString", "ExcludeFromCalcComparison", ""},
        {"_Flags", "ExcludeFromCalcComparison", ""},
        {"_Format", "ExcludeFromCalcComparison", ""},
        {"_SubLabel", "ExcludeFromCalcComparison", ""},
        {"_Attribution", "ExcludeFromCalcComparison", ""},
        {"_Icon", "ExcludeFromCalcComparison", ""},
        {"_Display", "ExcludeFromCalcComparison", ""},
        {"_CanonicalPropertyNames", "ExcludeFromCalcComparison", ""},
        {"_ClassificationId", "ExcludeFromCalcComparison", ""},
    };

    lxw_xml_start_tag(self->file, "global", NULL);
    lxw_xml_start_tag(self->file, "keyFlags", NULL);

    for (i = 0; i < 10; i++) {
        char **flags = key_flags[i];

        _rich_value_types_write_key(self, flags[0]);
        _rich_value_types_write_flag(self, flags[1]);

        if (*flags[2]) {
            _rich_value_types_write_flag(self, flags[2]);

        }

        lxw_xml_end_tag(self->file, "key");
    }

    lxw_xml_end_tag(self->file, "keyFlags");
    lxw_xml_end_tag(self->file, "global");
}

/*
 * Assemble and write the XML file.
 */
void
lxw_rich_value_types_assemble_xml_file(lxw_rich_value_types *self)
{
    /* Write the XML declaration. */
    _rich_value_types_xml_declaration(self);

    /* Write the rvTypesInfo element. */
    _rich_value_types_write_rv_types_info(self);

    /* Write the keyFlags element. */
    _rich_value_types_write_key_flags(self);

    lxw_xml_end_tag(self->file, "rvTypesInfo");
}

/*****************************************************************************
 *
 * Public functions.
 *
 ****************************************************************************/
