Command.h
branchv_0
changeset 26 aadef824dc93
parent 25 454cfb01cf95
child 27 930b8f1b836e
equal deleted inserted replaced
25:454cfb01cf95 26:aadef824dc93
     1 /**
       
     2  * Relational pipes
       
     3  * Copyright © 2018 František Kučera (Frantovo.cz, GlobalCode.info)
       
     4  *
       
     5  * This program is free software: you can redistribute it and/or modify
       
     6  * it under the terms of the GNU General Public License as published by
       
     7  * the Free Software Foundation, either version 3 of the License, or
       
     8  * (at your option) any later version.
       
     9  *
       
    10  * This program is distributed in the hope that it will be useful,
       
    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
       
    13  * GNU General Public License for more details.
       
    14  *
       
    15  * You should have received a copy of the GNU General Public License
       
    16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
       
    17  */
       
    18 #pragma once
       
    19 
       
    20 #include <cstdlib>
       
    21 #include <iostream>
       
    22 #include <string>
       
    23 #include <vector>
       
    24 #include <algorithm>
       
    25 
       
    26 
       
    27 namespace relpipe {
       
    28 namespace in {
       
    29 namespace cli {
       
    30 
       
    31 class Command {
       
    32 public:
       
    33 	virtual ~Command() = default;
       
    34 
       
    35 	/**
       
    36 	 * Processes the inputs (stream + arguments) and generates output in the relational pipes format.
       
    37 	 * 
       
    38 	 * @param input usually STDIN, may not be used if all data are passed as CLI arguments
       
    39 	 * @param output usually STDOUT, relational data is passed here
       
    40 	 * @param command command name, usualy not needed, may be significant if the same Command instance is used for several commands
       
    41 	 * @param arguments CLI arguments containing data or parameters (format is specific to each command)
       
    42 	 */
       
    43 	virtual void process(std::istream& input, std::ostream& output, const relpipe::writer::string_t& command, const std::vector<relpipe::writer::string_t> &arguments) = 0;
       
    44 
       
    45 };
       
    46 
       
    47 }
       
    48 }
       
    49 }