Command.hpp

Go to the documentation of this file.

// Copyright 2010 Complete Genomics, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you
// may not use this file except in compliance with the License. You
// may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.

#ifndef CGA_TOOLS_COMMAND_COMMAND_HPP_
#define CGA_TOOLS_COMMAND_COMMAND_HPP_ 1


#include "cgatools/core.hpp"
#include <iosfwd>
#include <string>
#include <boost/program_options.hpp>

namespace cgatools { namespace command {

    namespace po = boost::program_options;

    class Command
    {
    public:
        int operator()(int argc, char** argv);

        void help(std::ostream& out, bool html);

        const std::string& getName() const
        {
            return name_;
        }

        const std::string& getShortDescription() const
        {
            return shortDescription_;
        }

        std::string getCommandLine() const;

        static std::string formatDescription(
            const std::string& description, size_t indent, size_t maxLineLength, bool html);

        static size_t getHelpLineLength();

    protected:
        Command(const std::string& name,
                const std::string& shortDescription,
                const std::string& formatVersionSupported,
                const std::string& longDescription);

        virtual ~Command()
        {
        }

        std::istream& openStdin (const std::string& path);

        std::ostream& openStdout(const std::string& path);

        void requireParam(const po::variables_map& vm, const std::string& param);

        virtual int run(po::variables_map& vm) = 0;

    private:
        std::string escapeArgument(const std::string& arg) const;
        static std::string formatLine(
            const std::string& line, size_t indent, size_t maxLineLength, bool html);

        std::string name_;
        std::string formatVersionSupported_;
        std::string shortDescription_;
        std::string longDescription_;
        bool beta_;
        boost::shared_ptr<std::istream> myIn_;
        boost::shared_ptr<std::ostream> myOut_;

        int argc_;
        char** argv_;

    protected:
        po::options_description options_;
        po::options_description hiddenOptions_;
        po::positional_options_description positionalOptions_;

        std::string pipelineVersion_;
    };

} } // cgatools::command

#endif // CGA_TOOLS_COMMAND_COMMAND_HPP_

---