commands_wrap.cpp

/**
* =============================================================================
* Source Python
* Copyright (C) 2012-2015 Source Python Development Team.  All rights reserved.
* =============================================================================
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, version 3.0, as published by the
* Free Software Foundation.
*
* 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, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the Source Python Team gives you permission
* to link the code of this program (as well as its derivative works) to
* "Half-Life 2," the "Source Engine," and any Game MODs that run on software
* by the Valve Corporation.  You must obey the GNU General Public License in
* all respects for all other code used.  Additionally, the Source.Python
* Development Team grants this exception to all derivative works.
*/

//-----------------------------------------------------------------------------
// Includes.
//-----------------------------------------------------------------------------
#include "utilities/wrap_macros.h"
#include "export_main.h"
#include "modules/memory/memory_tools.h"
#include "commands_say.h"
#include "commands.h"
#include "commands_server.h"
#include "sp_main.h"


//-----------------------------------------------------------------------------
// Externals.
//-----------------------------------------------------------------------------
extern void InitServerCommands();
extern void ClearAllServerCommands();

extern void RegisterSayCommands();
extern void UnregisterSayCommands();

extern int GetCommandIndex();

//-----------------------------------------------------------------------------
// Initializes the Server and Say command modules.
//-----------------------------------------------------------------------------
void InitCommands()
{
	// Register the say and say_team commands
	DevMsg(1, MSG_PREFIX "Registering say and say_team commands...\n");
	RegisterSayCommands();

	// Register the ConVar accessor.
	DevMsg(1, MSG_PREFIX "Registering ConVar accessor...\n");
	InitServerCommands();
}


//-----------------------------------------------------------------------------
// Clears all command instances.
//-----------------------------------------------------------------------------
void ClearAllCommands()
{
	// Unregisters the say and say_team commands
	UnregisterSayCommands();

	// Clear all Server Commands
	ClearAllServerCommands();
}


//-----------------------------------------------------------------------------
// Forward declarations.
//-----------------------------------------------------------------------------
void export_command(scope);
void export_command_return(scope);
void export_concommandbase(scope);
void export_concommand(scope);


//-----------------------------------------------------------------------------
// Declare the _commands module.
//-----------------------------------------------------------------------------
DECLARE_SP_MODULE(_commands)
{
	export_command(_commands);
	export_command_return(_commands);
	export_concommandbase(_commands);
	export_concommand(_commands);

	def("get_command_index",
		&GetCommandIndex,
		"Returns the index of the player that issued the current command."
	);
}


//-----------------------------------------------------------------------------
// Expose CCommand.
//-----------------------------------------------------------------------------
void export_command(scope _commands)
{
	class_<CCommand>("Command")
		.def("__len__",
			&CCommand::ArgC,
			"Return the number of arguments in the command."
		)

		.add_property("arg_string",
			&CCommandExt::ArgS,
			"Return the argument string for the command (does not include the command itself)."
		)

		.add_property("command_string",
			&CCommandExt::GetCommandString,
			"Return the entire command string including the command itself."
		)

		.def("__getitem__",
			&CCommandExt::GetArg,
			"Return the argument at the given index.",
			args("index")
		)

		.def("tokenize",
			&CCommandExt::Tokenize
		)

		.add_static_property("max_command_length",
			&CCommand::MaxCommandLength
		)

		ADD_MEM_TOOLS(CCommand)
	;
}


//-----------------------------------------------------------------------------
// Expose CommandReturn.
//-----------------------------------------------------------------------------
void export_command_return(scope _commands)
{
	enum_<CommandReturn>("CommandReturn")
		.value("CONTINUE", CONTINUE)
		.value("BLOCK", BLOCK)
	;
}


//-----------------------------------------------------------------------------
// Expose ConCommandBase.
//-----------------------------------------------------------------------------
void export_concommandbase(scope _commands)
{
	class_<ConCommandBase>("ConCommandBase")
		.def(init< const char*, optional< const char*, int> >())

		.def("is_command",
			&ConCommandBase::IsCommand,
			"Returns whether it's a command."
		)

		.def("is_flag_set",
			&ConCommandBase::IsFlagSet,
			"Returns whether the given flag is set or not.",
			args("flag")
		)

		.def("add_flags",
			&AddConCommandFlags,
			"Adds the given flags to the ConVar.",
			args("flag")
		)

		.def("remove_flags",
			&RemoveConCommandFlags,
			"Removes the given flags from the ConVar.",
			args("flag")
		)
		
		.add_property("flags",
			&GetConCommandFlags,
			&SetConCommandFlags,
			"Returns its flags."
		)
		
		.add_property("name",
			&ConCommandBase::GetName,
			"Returns its name."
		)

		.add_property("help_text",
			&ConCommandBase::GetHelpText,
			"Returns the help text."
		)

		.add_property("next",
			make_function(
				GET_METHOD(ConCommandBase*, ConCommandBase, GetNext),
				reference_existing_object_policy()
			),
			"Returns the next ConCommandBase instance."
		)

		.def("is_registered",
			&ConCommandBase::IsRegistered,
			"Returns wheter the ConCommandBase instance is registered."
		)

		.add_property("dll_identifier",
			&ConCommandBase::GetDLLIdentifier,
			"Returns the DLL identifier."
		)

		ADD_MEM_TOOLS(ConCommandBase)
	;
}


//-----------------------------------------------------------------------------
// Expose ConCommand.
//-----------------------------------------------------------------------------
void export_concommand(scope _commands)
{
	class_<ConCommand, bases<ConCommandBase>, boost::noncopyable> _ConCommand("ConCommand", no_init);

	_ConCommand.def(
		"dispatch",
		&ConCommand::Dispatch,
		"Execute the command."
	);

	_ConCommand.def(
		"__call__",
		raw_method(&ConCommandExt::__call__),
		"Execute the command."
	);

	_ConCommand ADD_MEM_TOOLS(ConCommand);
}