shell.h File Reference

This module provides a simple command line interface (CLI) for running specific commands within a program. More...

#include <memory>
#include <stdio.h>
#include <cobj.h>
#include <cstr.h>
#include <vector>
#include <string>

Go to the source code of this file.

Classes
class	CShellCmd
class	CShellObj

Detailed Description

This module provides a simple command line interface (CLI) for running specific commands within a program.

The shell module allows users to execute commands in a CLI environment, useful for debugging and tool development. Users can register new commands, execute them, display help for commands, maintain a history of commands, and run shell scripts.

This module is designed for use in tool and debug environments. It is not intended for use in actual games, as there is no serial console in such scenarios. The primary purpose of this module is for debugging, and its usage is optional.

Example usage:

#include <iostream>
#include <memory>
#include <string>
#include <vector>
#include "shell.h"
 
// Custom command class
class CMyShellCmd : public CShellCmd {
public:
    CMyShellCmd() : CShellCmd("mycmd") {}
 
    int vOnMain(const std::vector<str16>& tokens) override {
        if (ShowHelp(tokens, "Usage: mycmd [options]\n")) {
            return 0;
        }
        // Command execution logic here
        std::cout << "My Command Executed with tokens: ";
        for (const auto& token : tokens) {
            std::cout << token.c_str() << " ";
        }
        std::cout << std::endl;
        return 0;
    }
};
 
int main() {
    CShellObj shell;
 
    // Register custom command
    shell.Register(new CMyShellCmd());
 
    // Execute shell script
    auto script = std::make_shared<std::string>("mycmd arg1 arg2\nhelp\nclear\n");
    shell.ExecShellScript(script);
 
    // Simulate command input
    std::vector<u32> inputs = {'m', 'y', 'c', 'm', 'd', ' ', 'a', 'r', 'g', '1', ' ', 'a', 'r', 'g', '2', B8_HIF_KB_CODE_ENTER};
    for (u32 input : inputs) {
        shell.Input(input);
    }
 
    return 0;
}