cmd.h

Go to the documentation of this file.

/*
Copyright (C) 1997-2001 Id Software, Inc.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#pragma once

#include "filesys.h"
#include "../shared/cxx.h"
#include "../shared/sharedptr.h"
#include <stdarg.h>

#include "../shared/cxx.h"
void Cbuf_Init(void);
void Cbuf_Shutdown(void);
void Cbuf_AddText(const char* format, ...) __attribute__((format(__printf__, 1, 2)));

/* inserted at the beginning of the buffer, before any remaining unexecuted */
/* commands. */
void Cbuf_InsertText(const char* text);

void Cbuf_AddEarlyCommands(bool clear);

bool Cbuf_AddLateCommands(void);

void Cbuf_Execute(void);

void Cbuf_CopyToDefer(void);
void Cbuf_InsertFromDefer(void);

#ifdef DEBUG
void Cmd_PrintDebugCommands(void);
#endif


/*=========================================================================== */


typedef void (*xcommand_t) (void);

typedef struct cmdList_s {
    const char* name;
    xcommand_t function;
    const char* description;
} cmdList_t;

class CmdListener {
public:
    virtual ~CmdListener() {}
    virtual void onAdd (const char* cmdName) = 0;
    virtual void onRemove (const char* cmdName) = 0;
};

typedef SharedPtr<CmdListener> CmdListenerPtr;

void Cmd_Init(void);
void Cmd_Shutdown(void);

void Cmd_AddCommand(const char* cmd_name, xcommand_t function, const char* desc = nullptr);

void Cmd_RemoveCommand(const char* cmd_name);
void Cmd_TableCheck(void);
void Cmd_TableAddList(const cmdList_t* cmdList);
void Cmd_TableRemoveList(const cmdList_t* cmdList);

void Cmd_AddParamCompleteFunction(const char* cmd_name, int (*function)(const char* partial, const char** match));

void Cmd_AddUserdata(const char* cmd_name, void* userdata);
void* Cmd_GetUserdata (const char* cmd_name);

bool Cmd_GenericCompleteFunction(char const* candidate, char const* partial, char const** match);

bool Cmd_Exists(const char* cmd_name);

void Cmd_RegisterCmdListener(CmdListenerPtr listener);

void Cmd_UnRegisterCmdListener(CmdListenerPtr listener);

int Cmd_CompleteCommandParameters(const char* command, const char* partial, const char** match);
int Cmd_CompleteCommand(const char* partial, const char** match);

int Cmd_Argc(void);
const char* Cmd_Argv(int arg);
const char* Cmd_Args(void);
void* Cmd_Userdata(void);

void Cmd_TokenizeString(const char* text, bool macroExpand, bool replaceWhitespaces = true);

void Cmd_ExecuteString(const char* text, ...) __attribute__((format(__printf__, 1, 2)));
void Cmd_vExecuteString(const char* fmt, va_list ap);

void Cmd_ForwardToServer(void);

const char* Cmd_GetCommandDesc(const char* command);

void Cmd_BufClear(void);

void Cmd_WriteAliases(qFILE* f);

void Cmd_Dummy_f(void);

#include "ScopedCommand.h"