src/Command.h
author František Kučera <franta-hg@frantovo.cz>
Tue, 22 Oct 2019 19:48:51 +0200
branchv_0
changeset 37 27f0ffa712d9
parent 26 aadef824dc93
permissions -rw-r--r--
fix license version: GNU GPLv3

/**
 * Relational pipes
 * Copyright © 2018 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 <cstdlib>
#include <iostream>
#include <string>
#include <vector>
#include <algorithm>


namespace relpipe {
namespace in {
namespace cli {

class Command {
public:
	virtual ~Command() = default;

	/**
	 * Processes the inputs (stream + arguments) and generates output in the relational pipes format.
	 * 
	 * @param input usually STDIN, may not be used if all data are passed as CLI arguments
	 * @param output usually STDOUT, relational data is passed here
	 * @param command command name, usualy not needed, may be significant if the same Command instance is used for several commands
	 * @param arguments CLI arguments containing data or parameters (format is specific to each command)
	 */
	virtual void process(std::istream& input, std::ostream& output, const relpipe::writer::string_t& command, const std::vector<relpipe::writer::string_t> &arguments) = 0;

};

}
}
}