/**

 * Relational pipes

 * Copyright © 2020 František Kučera (Frantovo.cz, GlobalCode.info)

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation, version 3 of the License.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program. If not, see <http://www.gnu.org/licenses/>.

 */

#pragma once

#include <string>

#include <istream>

#include "INIContentHandler.h"

#include "UnescapingProcessor.h"

namespace relpipe {

namespace in {

namespace ini {

namespace lib {

/**

 * TODO: Files in the src/lib directory will be moved to alt2xml and used as a shared library.

 */

class INIReader {

public:

	virtual ~INIReader() = default;

	/**

	 * TODO: after moving to alt2xml:

	 *        - option will be identified by globally unique URI/IRI

	 *        - parsers will provide catalog of supported options (names, enum values, documentation)

	 *        - options serves as both XML parser features and properties and are mapped to them

	 */

	virtual void setOption(const std::string& uri, const std::string& value) = 0;

	/**

	 * TODO: after moving to alt2xml:

	 *        - this will be generic handler for SAX event

	 *        - but both sides will know the schema (allowed elements and attributes for INI events)

	 */

	virtual void addHandler(INIContentHandler* handler) = 0;

	virtual void addUnescapingProcessor(std::shared_ptr<UnescapingProcessor> processor, const std::string uri, bool enabledByDefault) = 0;

	virtual void process() = 0;

	static INIReader* create(std::istream& input);

};

}

}

}

}