console.h

Go to the documentation of this file.

#ifndef _CONSOLE_H
#define _CONSOLE_H
/*
 * z64555's debug console, created for the FreeSpace Source Code project
 *
 * Portions of this source code are based on works by Volition, Inc. circa 1999. You may not sell or otherwise
 * commercially exploit the source or things you created based on the source.
 */

#include "debugconsole/consoleparse.h"
#include "globalincs/pstypes.h"
#include "globalincs/vmallocator.h"

#define DC_MAX_COMMANDS 300

class debug_command;

#define DCF(function_name, help_text)   \
                void dcf_##function_name();     \
                debug_command dcmd_##function_name(#function_name, help_text, dcf_##function_name);     \
                void dcf_##function_name()

#define DCF_BOOL(function_name, bool_variable)  \
        void dcf_##function_name();             \
        debug_command dcmd_##function_name(#function_name, "Sets or toggles the boolean: "#bool_variable, dcf_##function_name );        \
        void dcf_##function_name() {    \
                bool bool_tmp = bool_variable != 0;     \
                if (dc_optional_string_either("help", "--help")) {      \
                                dc_printf( "Usage: %s [bool]\nSets %s to true or false.  If nothing passed, then toggles it.\n", #function_name, #bool_variable );      \
                                return;         \
                }       \
                if (dc_optional_string_either("status", "--status") || dc_optional_string_either("?", "--?")) { \
                        dc_printf("%s = %s\n", #bool_variable, (bool_variable ? "TRUE" : "FALSE"));             \
                        return;         \
                }       \
                if (!dc_maybe_stuff_boolean(&bool_tmp)) {       \
                        if (bool_variable != 0) \
                                bool_variable = 0; \
                        else \
                                bool_variable = 1;      \
                } else { \
                        if (bool_tmp) \
                                bool_variable = 1; \
                        else \
                                bool_variable = 0;      \
                }       \
                dc_printf("%s set to %s\n", #bool_variable, (bool_variable != 0 ? "TRUE" : "FALSE"));   \
        }


#define DCF_BOOL2(function_name, bool_variable, short_help, long_help)  \
        void dcf_##function_name();             \
        debug_command dcmd_##function_name(#function_name, short_help, dcf_##function_name );   \
        void dcf_##function_name() {    \
                if (dc_optional_string_either("help", "--help")) {      \
                        dc_printf( #long_help );        \
                                return;         \
                }       \
                if (dc_optional_string_either("status", "--status") || dc_optional_string_either("?", "--?")) { \
                        dc_printf("%s = %s\n", #function_name, (bool_variable ? "TRUE" : "FALSE"));             \
                        return;         \
                }       \
                if (!dc_maybe_stuff_boolean(&bool_variable)) {  \
                        bool_variable = !bool_variable; \
                }       \
        }

 #define DCF_FLOAT(function_name, float_variable, short_help)   \
        void dcf_##function_name();             \
        debug_command dcmd_##function_name(#function_name, short_help, dcf_##function_name );   \
        void dcf_##function_name() {    \
                float value;    \
                if (dc_optional_string_either("status", "--status") || dc_optional_string_either("?", "--?")) { \
                        dc_printf("%s = %f\n", #float_variable, float_variable);                \
                        return;         \
                }       \
                dc_stuff_float(&value); \
                float_variable = value; \
                dc_printf("%s set to %f\n", #float_variable, float_variable);   \
        }

 #define DCF_FLOAT2(function_name, float_variable, lower_bounds, upper_bounds, short_help)      \
        void dcf_##function_name();             \
        debug_command dcmd_##function_name(#function_name, short_help, dcf_##function_name );   \
        void dcf_##function_name() {    \
                float value;    \
                if (dc_optional_string_either("status", "--status") || dc_optional_string_either("?", "--?")) { \
                        dc_printf("%s = %f\n", #float_variable, float_variable);                \
                        return;         \
                }       \
                dc_stuff_float(&value); \
                CLAMP(float_variable, lower_bounds, upper_bounds);      \
                float_variable = value; \
                dc_printf("%s set to %f\n", #float_variable, float_variable);   \
        }

 #define DCF_INT(function_name, int_variable, short_help)       \
        void dcf_##function_name();             \
        debug_command dcmd_##function_name(#function_name, short_help, dcf_##function_name );   \
        void dcf_##function_name() {    \
                int value;      \
                if (dc_optional_string_either("status", "--status") || dc_optional_string_either("?", "--?")) { \
                        dc_printf("%s = %i\n", #int_variable, int_variable);            \
                        return;         \
                }       \
                dc_stuff_int(&value);   \
                int_variable = value;   \
                dc_printf("%s set to %i\n", #int_variable, int_variable);       \
        }

 #define DCF_INT2(function_name, int_variable, lower_bounds, upper_bounds, short_help)  \
        void dcf_##function_name();             \
        debug_command dcmd_##function_name(#function_name, short_help, dcf_##function_name );   \
        void dcf_##function_name() {    \
                int value;      \
                if (dc_optional_string_either("status", "--status") || dc_optional_string_either("?", "--?")) { \
                        dc_printf("%s = %i\n", #int_variable, int_variable);            \
                        return;         \
                }       \
                dc_stuff_int(&value);   \
                CLAMP(int_variable, lower_bounds, upper_bounds);        \
                int_variable = value;   \
                dc_printf("%s set to %i\n", #int_variable, int_variable);       \
        }

class debug_command {
public:
        const char *name;               
        const char *help;               
        void (*func)(); 

        debug_command();

        debug_command(const char *name, const char *help, void (*func)());
};

class is_dcmd {
public:
        const char *name;

        is_dcmd(const char *_name) : name(_name) {}

        bool operator() (debug_command* dcmd)
        {
                return (strcmp(name, dcmd->name) == 0);
        }
};

extern bool Dc_debug_on;
extern int dc_commands_size;
extern uint lastline;
extern SCP_string dc_command_str;       // The rest of the command line, from the end of the last processed arg on.

bool dc_pause_output(void);

void dc_printf(const char *format, ...);

void debug_console(void (*func)(void) = NULL);

#endif // _CONSOLE_H