aboutsummaryrefslogtreecommitdiff
path: root/src/command.h
blob: b45f8b9e3dbde2a858b1a726fe9bbad86198e0d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
#ifndef COMMAND_H
#define COMMAND_H

#include <stdio.h>
#include "common.h"

/*
 * the current command system polecat uses is simple and depends on
 * int (*)(int, char**) function pointers, exactly the same as main
 * because keeping track of all of those is rather tedious making 
 * macros was an easier solution to get rid of the redundancy
 * for the sake of less readability.
 * argc and argv are marked as UNUSED (defined in common.h)
 * because the functions defined using this macro might not
 * actually use either of them so this is required to
 * supress warnings
 */
#define COMMAND(GROUP, COMMAND) \
    int GROUP##_##COMMAND(UNUSED int argc, UNUSED char** argv)


/*
 * all help functions in polecat look the same invoking the print_help
 * helper function defined in common.c with the command groups list
 * of available commands.
 * This also exists to reduce redundancy. 
 */
#define COMMAND_HELP(GROUP, MSG) \
    COMMAND(GROUP, help) \
    { \
        fprintf(stderr, USAGE_STR MSG " <command>\n\nList of commands:\n"); \
        print_help(GROUP##_commands, ARRAY_LEN(GROUP##_commands)); \
        return 0; \
    }

/*
 * This is the same as the COMMAND macro except dedicated to the actual
 * command group name, which is the thing called from the actual main
 * function. 
 */
#define COMMAND_GROUP(GROUP) \
    int GROUP(int argc, char** argv)


/*
 * the main command group function is only suppose to find given command
 * by the name and then invoke it.
 *
 * If the desired command is not found we should tell the user that.
 *
 * If no command is provided we should just print the list of commands by
 * calling the groups help command.
 */
#define COMMAND_GROUP_FUNC(GROUP) \
    COMMAND_GROUP(GROUP) \
    { \
        if (argc > 1) \
        { \
            for (unsigned long i = 0; i < ARRAY_LEN(GROUP##_commands); ++i) \
                if (!strcmp(GROUP##_commands[i].name, argv[1])) return GROUP##_commands[i].func(argc-1, argv+1); \
            fprintf(stderr, NAME ": '%s' is not a command\n", argv[1]); \
            return 0; \
        } \
        return GROUP##_help(argc-1, argv+1); \
    }

#endif