congenial - disco

Console library

This library gives your the opportunity to call functions by their's registered names, and pass input values as string parameters. You may use it to build the interface of your console application or to build a console system in your game or another GUI project. This library is header only has no external dependencies, it is yeasy to use it as external project of your cmake project.

Motivating example #0

#include "consolelib/disco.h"

int main() {
    disco::completer_impl completer;
    disco::string_command_executor invoker(new disco::function_proxy_impl, new disco::variable_proxy_impl,
        [&](auto&& name) {completer.add_name(name); });

    invoker.create_function("call", [] { std::cout << "call" << std::endl; });
    bool debug_mode = false;
    invoker.create_variable("debug_mode", debug_mode);
    
    invoker.invoke("call()"); // call lambda funnction and print call
    invoker.invole("debug_mode = true"); // change debug_mode variable and possible enables application's debug mode
    
    return 0;
}

Motivating example #1

Small sample illustrates how to use console library to build console client to the app.

#include <iostream>
#include "consolelib/disco.h"
#include "console_client.h" // imagine this header contains console client of the application

int main() {
    disco::completer_impl completer;
    disco::string_command_executor invoker(new disco::function_proxy_impl, new disco::variable_proxy_impl,
            [this](auto&& name) { completer.add_name(name); });
            
    console_client client;
    
    invoker.create_function("register", &client, &console_client::register_client);
    invoker.create_function("send", &client, &console_client::send_message);
    invoker.create_function("update", &console_client::update);
    
    for (;;) {
        std::string query;
        std::getline(std::cin, query);

        try {
            std::cout << invoker.invoke(query) << std::endl;
        }
        catch(const disco::exception& ex) {
            std::cout << "An exception occurred: " << ex.what() << std::endl;
        }
    }
    
    // you may register client with this string: [register "client_name"] or register("client_name")
    // or something like that, but with another delimiters
    return 0;
}

In this app you may register client with string: 'register "client_name"' or 'register("client_name")'. See doccumentation for more details.

Motivating example #2

Autocompletion

#include "consolelib/disco.h"

int main() {
    disco::completer_impl completer;
    disco::string_command_executor invoker(new disco::function_proxy_impl, new disco::variable_proxy_impl,
        [&](auto&& name) {completer.add_name(name); });

    invoker.create_function("call", [] { });
    invoker.create_function("call1", [] { });
    invoker.create_function("call2", [] { });
    
    auto&& call_completion = completer.complete("call");
    for (auto&& name : call_completion)
        std::cout << name << " ";
        
    return 0;
}

Output:call call1 call2

Opportunities

• Bind variable, change the variable value, query the variable value
• Bind static method, bind function, bind functional object, bind public method
• Call registered function and pass values as strings
• Query all the registered objects with given prefix

Technologies

• Uses std::tuple to hold parsed values
• Uses ADL to extend parsers and generators
• Throws exception if any error accured
• Uses function_traits to extract functions input paramters types (and return value type)
• No placeholders and legacy std::bind is required

Build

• Clone repository: git clone https://github.com/glensand/congenial-disco
• Generate platform dependent project: cmake -S [root_clone/lib] -B [root_clone\install]
• Go to root_clone\install and run cmake --build . --target install --config [Config]. The Config parameter might be Release or Debug

License

Distributed under the MIT License