/**
License:
	Boost Software License - Version 1.0 - August 17th, 2003

	Permission is hereby granted, free of charge, to any person or organization
	obtaining a copy of the software and accompanying documentation covered by
	this license (the "Software") to use, reproduce, display, distribute,
	execute, and transmit the Software, and to prepare derivative works of the
	Software, and to permit third-parties to whom the Software is furnished to
	do so, all subject to the following:

	The copyright notices in the Software and this entire statement, including
	the above license grant, this restriction and the following disclaimer,
	must be included in all copies of the Software, in whole or in part, and
	all derivative works of the Software, unless such copies or derivative
	works are solely in the form of machine-executable object code generated by
	a source language processor.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
	SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
	FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
	ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
	DEALINGS IN THE SOFTWARE.

Authors:
	aermicioi
**/
module aermicioi.aedi_property_reader.xml.xml;

import aermicioi.aedi : qualifier, component, lref;
import aermicioi.aedi.storage.storage;
import aermicioi.aedi.storage.locator;
import aermicioi.aedi_property_reader.xml.accessor;
import aermicioi.aedi_property_reader.xml.convertor;
import aermicioi.aedi_property_reader.convertor.accessor;
import aermicioi.aedi_property_reader.convertor.convertor;
import aermicioi.aedi_property_reader.convertor.chaining_convertor : ByTypePricingStrategy;
import aermicioi.aedi_property_reader.convertor.type_guesser;
import aermicioi.aedi_property_reader.core.document;
import aermicioi.aedi_property_reader.core.core;
import aermicioi.aedi_property_reader.convertor.std_conv;
import aermicioi.aedi_property_reader.xml.type_guesser;
import std.experimental.allocator;
import std.experimental.logger;
import std.xml;
import std.traits;

auto XmlConvertors(
    XmlConvertor xmlConvertor,
    CombinedConvertor combined,
) {
    combined.add(xmlConvertor);
};

auto XmlArrayConvertors(
    CombinedConvertor convertor,
    ByTypePricingStrategy byTypePricingStrategy
) {
    import std.meta : AliasSeq;

    static foreach (FromType; AliasSeq!(Element[])) {
        byTypePricingStrategy.add(typeid(FromType), 900);
        static foreach (ToType; AliasSeq!(ScalarArrayConvertibleTypes, StringArrayConvertibleTypes)) {
            byTypePricingStrategy.add(typeid(ToType), 900);
            convertor.add(new RangeToArrayConvertor!(ToType, FromType)(convertor));
        }
    }
};

alias XmlDocumentContainer = PolicyDocument!(
    Element,
    Element,
    WithContainerScanning!(
        aermicioi.aedi_property_reader.core.config,
    )(),
    WithInitializer!(
        StdConvStringPrebuiltConvertorsFactory
    )(),
    WithConvertorAggregation!CombinedConvertor(),
    WithContainerScanning!(
        aermicioi.aedi_property_reader.xml.type_guesser,
        aermicioi.aedi_property_reader.xml.accessor,
        aermicioi.aedi_property_reader.xml.inspector,
        aermicioi.aedi_property_reader.xml.convertor,
        aermicioi.aedi_property_reader.xml.xml
    )(),
    WithLocatorForUnregisteredComponents("xml-document-locator"),
    WithInitializer!(
        XmlConvertors
    )(),
    WithInitializer!(
        XmlArrayConvertors
    )(),
    WithDefaultRegisterers
);

/**
Create a convertor container with data source being xml document.

Params:
    value = source of data for container to use to construct components.
    accessor = property accessing logic
    guesser = type guesser based on held xml value
    allocator = allocator used to allocate converted values
Returns:
    XmlConvertorContainer
**/
auto xml(Element value) {

    XmlDocumentContainer container = XmlDocumentContainer(value);

    return container;
}

/**
ditto
**/
auto xml() {

    return new Document("<root><root>").xml();
}


/**
Create a convertor container with data source being xml document.

Params:
    pathOrData = path to a xml file or xml data itself
    returnEmpty = wheter to return or not a locator with empty data source
Returns:
    XmlConvertorContainer
**/
auto xml(string pathOrData, bool returnEmpty = true) {
    import std.experimental.logger : trace;
    import std.file : exists, readText;
    debug(trace) trace("Loading xml document from ", pathOrData);

    try {
        debug(trace) trace("Attempting to parse ", pathOrData, " as xml");

        check(pathOrData);

        debug(trace) trace("Parsed as xml");
        return xml(new Document(pathOrData));
    } catch (CheckException e) {

        debug(trace) trace(pathOrData, " is does not contain valid xml due to: ", e);
    }

    debug(trace) trace("Attempting to parse ", pathOrData, " as xml file");
    if (pathOrData.exists) {

        pathOrData = pathOrData.readText();

        try {
            check(pathOrData);

            debug(trace) trace("Parsed as xml");
            return xml(new Document(pathOrData));
        } catch(CheckException e) {

            debug(trace) trace(pathOrData, " does not contain valid xml due to: ", e);
            if (returnEmpty) {
                debug(trace) trace("Returning empty document");
                return xml();
            }

            throw new Exception(
                "Could not create xml convertor container from file or content passed in pathOrData: " ~ pathOrData, e
            );
        }
    }

    if (returnEmpty) {
        return xml();
    }

    throw new Exception(
        "Could not create xml convertor container from file or content passed in pathOrData: " ~ pathOrData
    );
}