src/Configuration.h
author František Kučera <franta-hg@frantovo.cz>
Tue, 22 Oct 2019 22:03:24 +0200
branchv_0
changeset 26 421608ecc12a
parent 23 6ee7a9e311e9
permissions -rw-r--r--
fix license version: GNU GPLv3

/**
 * Relational pipes
 * Copyright © 2019 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 <vector>
#include <tuple>

#include <relpipe/writer/AttributeMetadata.h>
#include <relpipe/writer/typedefs.h>

namespace relpipe {
namespace tr {
namespace guile {

class DefinitionRecipe {
public:

	virtual ~DefinitionRecipe() {
	}

	relpipe::writer::string_t name;
	relpipe::writer::string_t type;
	relpipe::writer::string_t value;
};

class RelationConfiguration {
public:

	virtual ~RelationConfiguration() {
	}

	relpipe::writer::string_t relation;
	relpipe::writer::string_t guileBeforeRecords;
	relpipe::writer::string_t guileAfterRecords;
	relpipe::writer::string_t guileForEach;
	relpipe::writer::string_t guileWhere;
	relpipe::writer::string_t guileHasMoreRecords;
	
	/**
	 * If true, additional relation will be generated: mapping between relpipe attribute names and Guile variable names
	 */
	bool debugVariableMapping = false;

	/**
	 * If true, Guile code will be executed, but no output will be generated.
	 */
	bool drop = false;

	/**
	 * Variable definitions for this relation.
	 * Can be used as a safe way for passing parameters from the outside environment.
	 * See also Configuration::definitions (can be overridden by relation's definitions)
	 */
	std::vector<DefinitionRecipe> definitions;

	/**
	 * If empty, output relation will have same metadata as the input relation.
	 */
	std::vector<relpipe::writer::AttributeMetadata> writerMetadata;

	/**
	 * Whether original attributes should be appended to those specified using --output-attribute
	 */
	bool inputAttributesAppend = false;

	/**
	 * Whether original attributes should be prepended to those specified using --output-attribute
	 */
	bool inputAttributesPrepend = false;
};

class Configuration {
public:

	vector<RelationConfiguration> relationConfigurations;
	/**
	 * Global definitions for all relations.
	 * Can be used as a safe way for passing parameters from the outside environment.
	 * See also RelationConfiguration::definitions
	 */
	std::vector<DefinitionRecipe> definitions;

	// TODO: --create t2 3 a integer b boolean '…guile…' – allow creating new relations? Or allow calling startRelation() and attribute() from Guile?
	// TODO: --has-more-relations '…guile…' – called after all relations … ?
	// TODO: --dynamic-output-attributes '…guile…' – used instead or together with --output-attribute

	virtual ~Configuration() {
	}
};

}
}
}