command-line-interface.hpp

Go to the documentation of this file.

/*
 *  Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
 *
 *  Contact: Mateusz Malicki <m.malicki2@samsung.com>
 *
 *  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 CLI_COMMAND_LINE_INTERFACE_HPP
#define CLI_COMMAND_LINE_INTERFACE_HPP

#include <vasum-client.h>

#include <map>
#include <vector>
#include <functional>
#include <ostream>
#include <string>

namespace vasum {
namespace cli {

#define MODE_COMMAND_LINE  (1 << 0)
#define MODE_INTERACTIVE   (1 << 1)

typedef std::vector<std::string> Args;

struct ArgSpec {
    std::string name;
    std::string description;
    std::string format;
};

class CommandLineInterface {

public:
    typedef std::function<void(const Args& argv)> ExecutorCallback;

    typedef std::vector<ArgSpec> ArgsSpec;

    CommandLineInterface()
        : mAvailability(0) {}

    CommandLineInterface(const ExecutorCallback& executorCallback,
                         const std::string& name,
                         const std::string& description,
                         const unsigned int& availability,
                         const ArgsSpec& argsSpec)
        : mExecutorCallback(executorCallback),
          mName(name),
          mDescription(description),
          mAvailability(availability),
          mArgsSpec(argsSpec) {}

    static void connect();

    static void disconnect();

    static void executeCallback(const std::function<VsmStatus(VsmClient)>& fun);

    const std::string& getName() const;

    const std::string& getDescription() const;

    void printUsage(std::ostream& out) const;

    bool isAvailable(unsigned int mode) const;

    void execute(const Args& argv) const;

    const std::vector<std::string> buildCompletionList(const Args& argv) const;

private:
    static VsmClient client;

    const ExecutorCallback mExecutorCallback;
    const std::string mName;
    const std::string mDescription;
    const unsigned int mAvailability;
    const ArgsSpec mArgsSpec;
};

void lock_queue(const Args& argv);

void unlock_queue(const Args& argv);

void set_active_zone(const Args& argv);

void create_zone(const Args& argv);

void destroy_zone(const Args& argv);

void shutdown_zone(const Args& argv);

void start_zone(const Args& argv);

void console_zone(const Args& argv);

void lock_zone(const Args& argv);

void unlock_zone(const Args& argv);

void get_zones_status(const Args& argv);

void get_zone_ids(const Args& argv);

void get_active_zone(const Args& argv);

void grant_device(const Args& argv);

void revoke_device(const Args& argv);

void create_netdev(const Args& argv);

void destroy_netdev(const Args& argv);

void netdev_list(const Args& argv);

void netdev_add_ip_addr(const Args& argv);

void netdev_del_ip_addr(const Args& argv);

void netdev_up(const Args& argv);

void netdev_down(const Args& argv);

void clean_up_zones_root(const Args& argv);

} // namespace cli
} // namespace vasum

#endif /* CLI_COMMAND_LINE_INTERFACE_HPP */