xref: /foundation/ability/ability_runtime/tools/aa/include/shell_command.h

/*
 * Copyright (c) 2021 Huawei Device Co., Ltd.
 * 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 OHOS_ABILITY_RUNTIME_SHELL_COMMAND_H
#define OHOS_ABILITY_RUNTIME_SHELL_COMMAND_H

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

#include "errors.h"

namespace OHOS {
namespace AAFwk {
namespace {
const std::string HELP_MSG_NO_OPTION = "error: you must specify an option at least.";

const int OFFSET_REQUIRED_ARGUMENT = 2;
}  // namespace

class ShellCommand {
public:
    ShellCommand(int argc, char* argv[], std::string name);
    virtual ~ShellCommand();

    ErrCode OnCommand();
    std::string ExecCommand();
    std::string GetCommandErrorMsg() const;
    std::string GetUnknownOptionMsg(std::string& unknownOption) const;
    std::string GetMessageFromCode(const int32_t code) const;

    virtual ErrCode CreateCommandMap() = 0;
    virtual ErrCode CreateMessageMap() = 0;
    virtual ErrCode init() = 0;

protected:
    static constexpr int MIN_ARGUMENT_NUMBER = 2;
    static constexpr int MAX_ARGUMENT_NUMBER = 4096;

    int argc_ = 0;
    char** argv_ = nullptr;

    std::string cmd_;
    std::vector<std::string> argList_;

    std::string name_;
    std::map<std::string, std::function<int()>> commandMap_;
    std::map<int32_t, std::string> messageMap_;

    std::string resultReceiver_ = "";
};
}  // namespace AAFwk
}  // namespace OHOS

#endif  // OHOS_ABILITY_RUNTIME_SHELL_COMMAND_H