thijn/SqMod
1
0
Fork 0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2024-11-08 00:37:15 +01:00
Code Releases Activity

Implemented command argument tag/name to allow auto generation of command syntax information.

Browse Source
This commit is contained in:
Sandu Liviu Catalin 2015-11-08 22:31:03 +02:00
parent d26b9b560e
commit b6023b842e
4 changed files with 143 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
source/Command.cpp
View File

@ -491,21 +491,36 @@ CmdListener::CmdListener()
// ------------------------------------------------------------------------------------------------
CmdListener::CmdListener(const SQChar * name)
: CmdListener(name, _SC(""))
: CmdListener(name, _SC(""), NullArray(), 0, MAX_CMD_ARGS)
{
/* ... */
}
// ------------------------------------------------------------------------------------------------
CmdListener::CmdListener(const SQChar * name, const SQChar * spec)
: CmdListener(name, spec, 0, MAX_CMD_ARGS)
: CmdListener(name, spec, NullArray(), 0, MAX_CMD_ARGS)
{
/* ... */
}
// ------------------------------------------------------------------------------------------------
CmdListener::CmdListener(const SQChar * name, const SQChar * spec, Array & tags)
: CmdListener(name, spec, tags, 0, MAX_CMD_ARGS)
{
/* ... */
}
// ------------------------------------------------------------------------------------------------
CmdListener::CmdListener(const SQChar * name, const SQChar * spec, SQUint32 min, SQUint32 max)
: m_Args({{0}})
: CmdListener(name, spec, NullArray(), min, max)
{
/* ... */
}
// ------------------------------------------------------------------------------------------------
CmdListener::CmdListener(const SQChar * name, const SQChar * spec, Array & tags, SQUint32 min, SQUint32 max)
: m_Args({{CMDARG_ANY}})
, m_Argt({{_SC("")}})
, m_MinArgc(0)
, m_MaxArgc(MAX_CMD_ARGS)
, m_Name()
@ -524,6 +539,8 @@ CmdListener::CmdListener(const SQChar * name, const SQChar * spec, SQUint32 min,
// Set the minimum and maximum allowed arguments
SetMinArgC(min);
SetMaxArgC(max);
// Extract the specified argument tags
SetArgTags(tags);
// Bind to the specified command name
SetName(name);
// Apply the specified argument rules
@ -641,6 +658,73 @@ void CmdListener::SetSpec(const SQChar * spec)
}
}
// ------------------------------------------------------------------------------------------------
const SQChar * CmdListener::GetArgTag(SQUint32 arg) const
{
if (arg < MAX_CMD_ARGS)
{
return m_Argt[arg].c_str();
}
else
{
LogErr("Unable to <get command argument tag/name> because : argument is out of bounds %u > %u",
arg, MAX_CMD_ARGS);
}
// Argument failed inspection
return _SC("");
}
// ------------------------------------------------------------------------------------------------
void CmdListener::SetArgTag(SQUint32 arg, const SQChar * name)
{
if (arg < MAX_CMD_ARGS)
{
m_Argt[arg].assign(name);
}
else
{
LogErr("Unable to <set command argument tag/name> because : argument is out of bounds %u > %u",
arg, MAX_CMD_ARGS);
}
}
// ------------------------------------------------------------------------------------------------
Array CmdListener::GetArgTags() const
{
// Allocate an array to encapsulate all tags
Array arr(DefaultVM::Get(), MAX_CMD_ARGS);
// Put the tags to the allocated array
for (SQUint32 arg = 0; arg < MAX_CMD_ARGS; ++arg)
{
arr.SetValue(arg, m_Argt[arg]);
}
// Return the array with the tags
return arr;
}
// ------------------------------------------------------------------------------------------------
void CmdListener::SetArgTags(Array & tags)
{
// Attempt to retrieve the number of specified tags
const SQUint32 max = _SCU32(tags.Length());
// If no tags were specified then clear current tags
if (max == 0)
{
m_Argt.fill(Argt::value_type());
}
// See if we're in range
else if (max < MAX_CMD_ARGS)
{
// Attempt to get all arguments in one go
tags.GetArray(m_Argt.data(), max);
}
else
{
LogErr("Unable to <set command argument tag/name> because : argument is out of bounds %u > %u",
max, MAX_CMD_ARGS);
}
}
// ------------------------------------------------------------------------------------------------
const SQChar * CmdListener::GetHelp() const
{
@ -1010,7 +1094,9 @@ bool Register_Cmd(HSQUIRRELVM vm)
.Ctor()
.Ctor< const SQChar * >()
.Ctor< const SQChar *, const SQChar * >()
.Ctor< const SQChar *, const SQChar *, Array & >()
.Ctor< const SQChar *, const SQChar *, SQUint32, SQUint32 >()
.Ctor< const SQChar *, const SQChar *, Array &, SQUint32, SQUint32 >()
/* Metamethods */
.Func(_SC("_cmp"), &CmdListener::Cmp)
.Func(_SC("_tostring"), &CmdListener::ToString)
@ -1019,6 +1105,7 @@ bool Register_Cmd(HSQUIRRELVM vm)
.Prop(_SC("ldata"), &CmdListener::GetData, &CmdListener::SetData)
.Prop(_SC("name"), &CmdListener::GetName, &CmdListener::SetName)
.Prop(_SC("spec"), &CmdListener::GetSpec, &CmdListener::SetSpec)
.Prop(_SC("tags"), &CmdListener::GetArgTags, &CmdListener::SetArgTags)
.Prop(_SC("help"), &CmdListener::GetHelp, &CmdListener::SetHelp)
.Prop(_SC("info"), &CmdListener::GetInfo, &CmdListener::SetInfo)
.Prop(_SC("on_exec"), &CmdListener::GetOnExec, &CmdListener::SetOnExec)
@ -1030,6 +1117,8 @@ bool Register_Cmd(HSQUIRRELVM vm)
.Prop(_SC("min_args"), &CmdListener::GetMinArgC, &CmdListener::SetMinArgC)
.Prop(_SC("max_args"), &CmdListener::GetMaxArgC, &CmdListener::SetMaxArgC)
/* Functions */
.Func(_SC("get_arg_tag"), &CmdListener::GetArgTag)
.Func(_SC("set_arg_tag"), &CmdListener::SetArgTag)
.Func(_SC("set_on_exec"), &CmdListener::SetOnExec_Env)
.Func(_SC("set_on_auth"), &CmdListener::SetOnAuth_Env)
);

38
source/Command.hpp
View File

@ -291,11 +291,21 @@ public:
*/
CmdListener(const SQChar * name, const SQChar * spec);
/* --------------------------------------------------------------------------------------------
* Construct and instance and attach it to the specified name.
*/
CmdListener(const SQChar * name, const SQChar * spec, Array & tags);
/* --------------------------------------------------------------------------------------------
* Construct and instance and attach it to the specified name.
*/
CmdListener(const SQChar * name, const SQChar * spec, SQUint32 min, SQUint32 max);
/* --------------------------------------------------------------------------------------------
* Construct and instance and attach it to the specified name.
*/
CmdListener(const SQChar * name, const SQChar * spec, Array & tags, SQUint32 min, SQUint32 max);
/* --------------------------------------------------------------------------------------------
* Copy constructor (disabled).
*/
@ -376,6 +386,26 @@ public:
*/
void SetSpec(const SQChar * spec);
/* --------------------------------------------------------------------------------------------
* Retrieve the tag/name of a command argument.
*/
const SQChar * GetArgTag(SQUint32 arg) const;
/* --------------------------------------------------------------------------------------------
* Change the tag/name of a command argument.
*/
void SetArgTag(SQUint32 arg, const SQChar * name);
/* --------------------------------------------------------------------------------------------
* Retrieve the tag/name of multiple command arguments.
*/
Array GetArgTags() const;
/* --------------------------------------------------------------------------------------------
* Change the tag/name of multiple command arguments.
*/
void SetArgTags(Array & tags);
/* --------------------------------------------------------------------------------------------
* Retrieve the help text associated with this command.
*/
@ -496,6 +526,9 @@ protected:
// --------------------------------------------------------------------------------------------
typedef std::array< Uint8 , MAX_CMD_ARGS > Args;
// --------------------------------------------------------------------------------------------
typedef std::array< String , MAX_CMD_ARGS > Argt;
/* --------------------------------------------------------------------------------------------
* Process the specifiers string.
*/
@ -508,6 +541,11 @@ private:
*/
Args m_Args;
/* --------------------------------------------------------------------------------------------
* Array of strings to be used as the tag/name for each argument.
*/
Argt m_Argt;
/* --------------------------------------------------------------------------------------------
* Minimum arguments allowed to execute this command.
*/

8
source/Common.cpp
View File

@ -479,4 +479,12 @@ SqObj & NullData()
return d;
}
// ------------------------------------------------------------------------------------------------
Array & NullArray()
{
static Array a;
a.Release();
return a;
}
} // Namespace:: SqMod

5
source/Common.hpp
View File

@ -33,6 +33,11 @@ extern PluginInfo* _Info;
*/
SqObj & NullData();
/* ------------------------------------------------------------------------------------------------
* ...
*/
Array & NullArray();
/* ------------------------------------------------------------------------------------------------
* Utility used to transform values into script objects on the default VM
*/