Flummi/amxmodx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Introduce TextParser API.

Browse Source
This commit is contained in:
Arkshine
2014-07-21 21:12:35 +02:00
parent 5fbc5c074d
commit 9af7931a79
13 changed files with 2438 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

223
plugins/include/textparse.inc Normal file
View File

@ -0,0 +1,223 @@
/**
* vim: set ts=4 :
* =============================================================================
* SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
* =============================================================================
*
* This file is part of the SourceMod/SourcePawn SDK.
*
* 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, AlliedModders LLC gives you permission to link the
* code of this program (as well as its derivative works) to "Half-Life 2," the
* "Source Engine," the "SourcePawn JIT," 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, AlliedModders LLC grants
* this exception to all derivative works. AlliedModders LLC defines further
* exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
* or <http://www.sourcemod.net/license.php>.
*
* Version: $Id$
*/
#if defined _textparse_included
#endinput
#endif
#define _textparse_included
/**
* Everything below describes the SMC Parse, or "SourceMod Configuration" format.
* This parser is entirely event based. You must hook events to receive data.
* The file format itself is nearly identical to Valve's KeyValues format.
*/
/**
* Parse result directive.
*/
enum SMCResult
{
SMCParse_Continue, /**< Continue parsing */
SMCParse_Halt, /**< Stop parsing here */
SMCParse_HaltFail /**< Stop parsing and return failure */
};
/**
* Parse error codes.
*/
enum SMCError
{
SMCError_Okay = 0, /**< No error */
SMCError_StreamOpen, /**< Stream failed to open */
SMCError_StreamError, /**< The stream died... somehow */
SMCError_Custom, /**< A custom handler threw an error */
SMCError_InvalidSection1, /**< A section was declared without quotes, and had extra tokens */
SMCError_InvalidSection2, /**< A section was declared without any header */
SMCError_InvalidSection3, /**< A section ending was declared with too many unknown tokens */
SMCError_InvalidSection4, /**< A section ending has no matching beginning */
SMCError_InvalidSection5, /**< A section beginning has no matching ending */
SMCError_InvalidTokens, /**< There were too many unidentifiable strings on one line */
SMCError_TokenOverflow, /**< The token buffer overflowed */
SMCError_InvalidProperty1, /**< A property was declared outside of any section */
};
enum TextParser
{
Invalid_TextPaser = 0
};
/**
* Creates a new SMC file format parser.
* This is used to set parse hooks.
*
* @return A new Handle to an SMC Parse structure.
*/
native TextParser:SMC_CreateParser();
/**
* Parses an SMC file.
*
* @param smc A Handle to an SMC Parse structure.
* @param file A string containing the file path.
* @param line An optional by reference cell to store the last line number read.
* @param col An optional by reference cell to store the last column number read.
* @return An SMCParseError result.
* @error Invalid or corrupt Handle.
*/
native SMCError:SMC_ParseFile(TextParser:smc, const file[], &line = 0, &col = 0);
/**
* Gets an error string for an SMCError code.
*
* @note SMCError_Okay returns false.
* @note SMCError_Custom (which is thrown on SMCParse_HaltFail) returns false.
*
* @param error The SMCParseError code.
* @param buffer A string buffer for the error (contents undefined on failure).
* @param buf_max The maximum size of the buffer.
*
* @return True on success, false otherwise.
*/
native bool:SMC_GetErrorString(SMCError:error, buffer[], buf_max);
/**
* Sets the SMC_ParseStart function of a parse Handle.
* Below is the prototype of callback.:
*
* - ParseStart:
* Called when parsing is started.
*
* @param smc The SMC Parse Handle.
* @noreturn
*
* public SMC_ParseStart(TextParser:smc)
*
* @param smc Handle to an SMC Parse.
* @param func A ParseStart callback.
*
* @noreturn
* @error Invalid or corrupt Handle.
*/
native SMC_SetParseStart(TextParser:smc, const func[]);
/**
* Sets the SMC_ParseEnd of a parse handle.
* Below is the prototype of callback.:
*
* - ParseEnd:
* Called when parsing is halted.
*
* @param smc The SMC Parse Handle.
* @param halted True if abnormally halted, false otherwise.
* @param failed True if parsing failed, false otherwise.
* @noreturn
*
* public SMC_ParseEnd(TextParser:smc, bool:halted, bool:failed)
*
* @param smc Handle to an SMC Parse.
* @param func A ParseEnd callback..
*
* @noreturn
* @error Invalid or corrupt Handle.
*/
native SMC_SetParseEnd(TextParser:smc, const func[]);
/**
* Sets the three main reader functions.
* Below are the different prototypes of callbacks:
*
* - NewSection:
* Called when the parser finds the end of the current section.
* @note Enclosing quotes are always stripped.
*
* @param smc The SMC Parse Handle.
* @param name String containing section name.
* @return An SMCResult action to take.
*
* public SMCResult:SMC_NewSection(TextParser:smc, const name[])
*
* - KeyValue:
* Called when the parser finds a new key/value pair.
* @note Enclosing quotes are always stripped.
*
* @param smc The SMC Parse Handle.
* @param key String containing key name.
* @param value String containing value name.
* @return An SMCResult action to take.
*
* public SMCResult:SMC_KeyValue(TextParser:smc, const key[], const value[])
*
* - EndSection:
* Called when the parser finds the end of the current section.
*
* @param smc The SMC Parse Handle.
*
* public SMCResult:SMC_EndSection(TextParser:smc)
* -
* @param smc An SMC parse Handle.
* @param ns A NewSection callback.
* @param kv A KeyValue callback.
* @param es An EndSection callback.
*
* @noreturn
*/
native SMC_SetReaders(TextParser:smc, const nsFunc[], const kvFunc[], const esFunc[]);
/**
* Sets a raw line reader on an SMC parser Handle.
* Below is the prototype of callback.:
*
* - RawLine:
* Called whenever a raw line is read.
*
* @param smc The SMC Parse Handle.
* @param line A string containing the raw line from the file.
* @param lineno The line number it occurs on.
* @return An SMCResult action to take.
*
* public SMCResult:SMC_RawLine(TextParser:smc, const line[], lineno)
*
* @param smc Handle to an SMC Parse.
* @param func A RawLine callback..
* @noreturn
*/
native SMC_SetRawLine(TextParser:smc, const func[]);
/**
* Disposes of a text parser.
*
* @param smc Handle to an SMC Parse.
* @return True if disposed, false otherwise.
*/
native SMC_DestroyParser(&TextParser:smc);

116
plugins/testsuite/textparse_test.sma Normal file
View File

@ -0,0 +1,116 @@
#include <amxmodx>
#include <textparse>
new SuccessCount;
new Trie:ExpectedKVData;
public plugin_init()
{
register_concmd("textparse_vdf", "ConsoleCommand_TextParseVDF");
register_clcmd("textparse_ini", "ServerCommand_TextParseINI");
}
/**
* VDF Config format
*/
public ConsoleCommand_TextParseVDF()
{
server_print("Testing text parser with VDF config file format...");
new const configFile[] = "addons/amxmodx/scripting/testsuite/textparse_test.cfg";
ExpectedKVData = TrieCreate();
TrieSetString(ExpectedKVData, "Logging", "on");
TrieSetString(ExpectedKVData, "LogMode", "daily");
TrieSetString(ExpectedKVData, "ServerLang", "en");
TrieSetString(ExpectedKVData, "PublicChatTrigger", "!");
TrieSetString(ExpectedKVData, "SilentChatTrigger", "/");
TrieSetString(ExpectedKVData, "SilentFailSuppress", "no");
TrieSetString(ExpectedKVData, "PassInfoVar", "_password");
TrieSetString(ExpectedKVData, "MenuItemSound", "buttons/button14.wav");
TrieSetString(ExpectedKVData, "MenuExitSound", "buttons/combine_button7.wav");
TrieSetString(ExpectedKVData, "MenuExitBackSound", "buttons/combine_button7.wav");
TrieSetString(ExpectedKVData, "AllowClLanguageVar", "On");
TrieSetString(ExpectedKVData, "DisableAutoUpdate", "no");
TrieSetString(ExpectedKVData, "ForceRestartAfterUpdate", "no");
TrieSetString(ExpectedKVData, "AutoUpdateURL", "http://update.sourcemod.net/update/");
TrieSetString(ExpectedKVData, "DebugSpew", "no");
TrieSetString(ExpectedKVData, "SteamAuthstringValidation", "yes");
TrieSetString(ExpectedKVData, "BlockBadPlugins", "yes");
TrieSetString(ExpectedKVData, "SlowScriptTimeout", "8");
new const expectedSectionCount = 2; // Include start and end.
new const expectedStartEndCount = 2;
new const expectedKeyValueCount = TrieGetSize(ExpectedKVData);
new const expectedLineCount = file_size(configFile, .flag = 1) - 1;
new TextParser:parser = SMC_CreateParser();
SMC_SetReaders(parser, "ReadCore_NewSection", "ReadCore_KeyValue", "ReadCore_EndSection");
SMC_SetParseStart(parser, "ReadCore_ParseStart");
SMC_SetRawLine(parser, "ReadCore_CurrentLine");
SMC_SetParseEnd(parser, "ReadCore_ParseEnd");
new line, col;
new SMCError:err = SMC_ParseFile_VDF(parser, configFile, line, col);
if (err != SMCError_Okay)
{
new buffer[64];
server_print("%s", SMC_GetErrorString(err, buffer, charsmax(buffer)) ? buffer : "Fatal parse error");
}
if (line == expectedLineCount + 1 && col == 2)
{
++SuccessCount;
}
SMC_DestroyParser(parser);
server_print("^tTests successful: %d/%d", SuccessCount, expectedStartEndCount + expectedSectionCount + expectedKeyValueCount + expectedLineCount + 1);
}
public ReadCore_ParseStart(TextParser:smc)
{
++SuccessCount;
}
public ReadCore_NewSection(TextParser:smc, const name[])
{
++SuccessCount;
}
public ReadCore_KeyValue(TextParser:smc, const key[], const value[])
{
new buffer[128];
if (TrieGetString(ExpectedKVData, key, buffer, charsmax(buffer)) && equal(value, buffer))
{
++SuccessCount;
}
}
public ReadCore_EndSection(TextParser:smc)
{
++SuccessCount;
}
public ReadCore_CurrentLine(TextParser:smc, const line[], lineno)
{
++SuccessCount;
}
public ReadCore_ParseEnd(TextParser:smc)
{
++SuccessCount;
}
/**
* INI Config format
*/
public ServerCommand_TextParseINI()
{
}