view irccdctl/rule_info_cli.hpp @ 577:3d0dbc0bee7d

Irccd: update references to onChannel(Mode|Notice), onMode - Update hangman, logger and their tests, - Update dynlib_plugin and js_plugin.
author David Demelier <markand@malikania.fr>
date Thu, 30 Nov 2017 13:19:38 +0100
parents 9daccaeedcce
children 986ed3a7575d
line wrap: on
line source

/*
 * rule_info_cli.hpp -- implementation of irccdctl rule-info
 *
 * Copyright (c) 2013-2017 David Demelier <markand@malikania.fr>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef IRCCD_RULE_INFO_CLI_HPP
#define IRCCD_RULE_INFO_CLI_HPP

/**
 * \file rule_info_cli.hpp
 * \brief Implementation of irccdctl rule-info.
 */

#include "cli.hpp"

namespace irccd {

namespace ctl {

/**
 * \brief Implementation of irccdctl rule-info.
 */
class rule_info_cli : public cli {
public:
    /**
     * Pretty print a rule to stdout.
     *
     * \param json the rule information
     * \param index the rule index
     */
    static void print(const nlohmann::json& json, int index = 0);

    /**
     * \copydoc cli::name
     */
    std::string name() const override;

    /**
     * \copydoc cli::exec
     */
    void exec(ctl::controller& irccdctl, const std::vector<std::string>& args) override;
};

} // !ctl

} // !irccd

#endif // !IRCCD_RULE_INFO_CLI_HPP