Merge pull request #101 from Arkshine/textparsers
Introduce TextParser API
This commit is contained in:
Vincent Herbet
@ -27,6 +27,8 @@
|
||||
#include <celltrie>
|
||||
#include <datapack>
|
||||
#include <newmenus>
|
||||
#include <textparse_smc>
|
||||
#include <textparse_ini>
|
||||
|
||||
/* Function is called just after server activation.
|
||||
* Good place for configuration loading, commands and cvars registration. */
|
||||
|
||||
206
plugins/include/textparse_ini.inc
Normal file
206
plugins/include/textparse_ini.inc
Normal file
@ -0,0 +1,206 @@
|
||||
// vim: set ts=4 sw=4 tw=99 noet:
|
||||
//
|
||||
// AMX Mod X, based on AMX Mod by Aleksander Naszko ("OLO").
|
||||
// Copyright (C) The AMX Mod X Development Team.
|
||||
//
|
||||
// This software is licensed under the GNU General Public License, version 3 or higher.
|
||||
// Additional exceptions apply. For full license details, see LICENSE.txt or visit:
|
||||
// https://alliedmods.net/amxmodx-license
|
||||
|
||||
//
|
||||
// INI Parser Functions
|
||||
//
|
||||
|
||||
#if defined _textparse_ini_included
|
||||
#endinput
|
||||
#endif
|
||||
#define _textparse_ini_included
|
||||
|
||||
/**
|
||||
* This parser API is entirely event based.
|
||||
* You must hook events to receive data.
|
||||
*/
|
||||
|
||||
/**
|
||||
* The INI file format is defined as:
|
||||
* WHITESPACE: 0x20, \n, \t, \r
|
||||
* IDENTIFIER: A-Z a-z 0-9 _ - , + . $ ? /
|
||||
* STRING : Any set of symbols
|
||||
*
|
||||
* Basic syntax is comprised of SECTIONs.
|
||||
* A SECTION is defined as:
|
||||
* [SECTIONNAME]
|
||||
* OPTION
|
||||
* OPTION
|
||||
* OPTION...
|
||||
*
|
||||
* SECTIONNAME is an IDENTIFIER.
|
||||
* OPTION can be repeated any number of times, once per line.
|
||||
* OPTION is defined as one of:
|
||||
* KEY = "VALUE"
|
||||
* KEY = VALUE
|
||||
* KEY
|
||||
* Where KEY is an IDENTIFIER and VALUE is a STRING.
|
||||
*
|
||||
* WHITESPACE should always be omitted.
|
||||
* COMMENTS should be stripped, and are defined as text occurring in:
|
||||
* ;<TEXT>
|
||||
*
|
||||
* Example file below. Note that the second line is technically invalid.
|
||||
* The event handler must decide whether this should be allowed.
|
||||
* --FILE BELOW--
|
||||
* [gaben]
|
||||
* hi = clams
|
||||
* bye = "NO CLAMS"
|
||||
*
|
||||
* [valve]
|
||||
* cannot
|
||||
* maintain
|
||||
* products
|
||||
*/
|
||||
|
||||
/**
|
||||
* Parser invalid code.
|
||||
*/
|
||||
enum INIParser
|
||||
{
|
||||
Invalid_INIParser = 0
|
||||
};
|
||||
|
||||
/**
|
||||
* Creates a new INI parser.
|
||||
* This is used to set parse hooks.
|
||||
*
|
||||
* @return A new handle to an INI Parse structure.
|
||||
*/
|
||||
native INIParser:INI_CreateParser();
|
||||
|
||||
/**
|
||||
* Disposes of an INI parser.
|
||||
*
|
||||
* @param handle Handle to an INI Parse structure.
|
||||
*
|
||||
* @return True if disposed, false otherwise.
|
||||
*/
|
||||
native INI_DestroyParser(&INIParser:handle);
|
||||
|
||||
/**
|
||||
* Parses an INI config file.
|
||||
*
|
||||
* @param handle A handle to an INI 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 bool:INI_ParseFile(INIParser:handle, const file[], &line = 0, &col = 0);
|
||||
|
||||
/**
|
||||
* Sets the INI_ParseStart function of a parse handle.
|
||||
*
|
||||
* @note Below is the prototype of callback:
|
||||
* -
|
||||
* Called when parsing is started.
|
||||
*
|
||||
* @param handle A handle to an INI Parse structure.
|
||||
*
|
||||
* @noreturn
|
||||
*
|
||||
* public OnParseStart(INIParser:handle)
|
||||
* -
|
||||
* @param handle Handle to an INI Parse structure.
|
||||
* @param func A ParseStart callback.
|
||||
*
|
||||
* @noreturn
|
||||
* @error Invalid or corrupt handle.
|
||||
*/
|
||||
native INI_SetParseStart(INIParser:handle, const func[]);
|
||||
|
||||
/**
|
||||
* Sets the INI_ParseEnd function of a parse handle.
|
||||
*
|
||||
* @note Below is the prototype of callback:
|
||||
* -
|
||||
* Called when parsing is halted.
|
||||
*
|
||||
* @param handle A handle to an INI Parse structure.
|
||||
* @param halted True if abnormally halted, false otherwise.
|
||||
*
|
||||
* @noreturn
|
||||
*
|
||||
* public OnParseEnd(INIParser:handle, bool:halted)
|
||||
* -
|
||||
* @param handle Handle to an INI Parse structure.
|
||||
* @param func A ParseEnd callback.
|
||||
*
|
||||
* @noreturn
|
||||
* @error Invalid or corrupt handle.
|
||||
*/
|
||||
native INI_SetParseEnd(INIParser:handle, const func[]);
|
||||
|
||||
/**
|
||||
* Sets the two main reader functions.
|
||||
*
|
||||
* @note Below is the prototype of callback:
|
||||
* -
|
||||
* NewSection:
|
||||
* Called when the parser finds a new section.
|
||||
*
|
||||
* @param handle Handle to an INI Parse structure.
|
||||
* @param section Name of section in between the [ and ] characters.
|
||||
* @param invalid_tokens True if invalid tokens were detected in the name.
|
||||
* @param close_bracket True if a closing bracket was detected, false otherwise.
|
||||
* @param extra_tokens True if extra tokens were detected on the line.
|
||||
* @param curtok Contains current token in the line where the section name starts.
|
||||
* You can add to this offset when failing to point to a token.
|
||||
* @return True to keep parsing, false otherwise.
|
||||
*
|
||||
* public bool:OnNewSection(INIParser:handle, const section[], bool:invalid_tokens, bool:close_bracket, bool:extra_tokens, curtok)
|
||||
*
|
||||
* KeyValue:
|
||||
* Called when the parser finds a new key/value pair.
|
||||
*
|
||||
* @param handle Handle to an INI Parse structure.
|
||||
* @param key Name of key.
|
||||
* @param value String containing value (with quotes stripped, if any).
|
||||
* @param invalid_tokens Whether or not the key contained invalid tokens.
|
||||
* @param equal_token There was an '=' sign present (in case the value is missing).
|
||||
* @param quotes Whether value was enclosed in quotes.
|
||||
* @param curtok Contains the token index of the start of the value string.
|
||||
* This can be changed when returning false.
|
||||
* @return True to keep parsing, false otherwise.
|
||||
*
|
||||
* public bool:OnKeyValue(INIParser:handle, const key[], const value[], bool:invalid_tokens, bool:equal_token, bool:quotes, curtok)
|
||||
* -
|
||||
* @param handle Handle to an INI Parse structure.
|
||||
* @param kv A KeyValue callback.
|
||||
* @param ns An optional NewSection callback.
|
||||
*
|
||||
* @noreturn
|
||||
*/
|
||||
native INI_SetReaders(INIParser:smc, const kvFunc[], const nsFunc[] = "" );
|
||||
|
||||
/**
|
||||
* Sets a raw line reader on an INI parser handle.
|
||||
*
|
||||
* @note Below is the prototype of callback:
|
||||
* -
|
||||
* Called whenever a raw line is read.
|
||||
*
|
||||
* @param handle The INI Parse handle.
|
||||
* @param line Contents of line.
|
||||
* @param lineno The line number it occurs on.
|
||||
* @param curtok Pointer to optionally store failed position in string.
|
||||
*
|
||||
* @return True to keep parsing, false otherwise.
|
||||
*
|
||||
* public bool:OnRawLine(INIParser:smc, const line[], lineno, curtok)
|
||||
*
|
||||
* @param handle Handle to an INI Parse structure.
|
||||
* @param func A RawLine callback.
|
||||
*
|
||||
* @noreturn
|
||||
*/
|
||||
native INI_SetRawLine(INIParser:handle, const func[]);
|
||||
254
plugins/include/textparse_smc.inc
Normal file
254
plugins/include/textparse_smc.inc
Normal file
@ -0,0 +1,254 @@
|
||||
// vim: set ts=4 sw=4 tw=99 noet:
|
||||
//
|
||||
// AMX Mod X, based on AMX Mod by Aleksander Naszko ("OLO").
|
||||
// Copyright (C) The AMX Mod X Development Team.
|
||||
//
|
||||
// This software is licensed under the GNU General Public License, version 3 or higher.
|
||||
// Additional exceptions apply. For full license details, see LICENSE.txt or visit:
|
||||
// https://alliedmods.net/amxmodx-license
|
||||
|
||||
//
|
||||
// SMC Parser Functions
|
||||
//
|
||||
|
||||
#if defined _textparse_smc_included
|
||||
#endinput
|
||||
#endif
|
||||
#define _textparse_smc_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 (also known as VDF).
|
||||
*/
|
||||
|
||||
/**
|
||||
* The SMC file format is defined as:
|
||||
* WHITESPACE: 0x20, \n, \t, \r
|
||||
* IDENTIFIER: Any ASCII character EXCLUDING ", {, }, ;, //, / *, or WHITESPACE.
|
||||
* STRING : Any set of symbols enclosed in quotes.
|
||||
*
|
||||
* Note: if a STRING does not have quotes, it is parsed as an IDENTIFIER.
|
||||
*
|
||||
* Basic syntax is comprised of SECTIONBLOCKs.
|
||||
* A SECTIONBLOCK defined as:
|
||||
*
|
||||
* SECTIONNAME
|
||||
* {
|
||||
* OPTION
|
||||
* }
|
||||
*
|
||||
* OPTION can be repeated any number of times inside a SECTIONBLOCK.
|
||||
* A new line will terminate an OPTION, but there can be more than one OPTION per line.
|
||||
* OPTION is defined any of:
|
||||
* "KEY" "VALUE"
|
||||
* SECTIONBLOCK
|
||||
*
|
||||
* SECTIONNAME, KEY, VALUE, and SINGLEKEY are strings
|
||||
* SECTIONNAME cannot have trailing characters if quoted, but the quotes can be optionally removed.
|
||||
* If SECTIONNAME is not enclosed in quotes, the entire sectionname string is used (minus surrounding whitespace).
|
||||
* If KEY is not enclosed in quotes, the key is terminated at first whitespace.
|
||||
* If VALUE is not properly enclosed in quotes, the entire value string is used (minus surrounding whitespace).
|
||||
* The VALUE may have inner quotes, but the key string may not.
|
||||
*
|
||||
* For an example, see scripting/testsuite/textparse_test.cfg
|
||||
*
|
||||
* WHITESPACE should be ignored.
|
||||
* Comments are text occurring inside the following tokens, and should be stripped
|
||||
* unless they are inside literal strings:
|
||||
* ;<TEXT>
|
||||
* //<TEXT>
|
||||
* / *<TEXT> * /
|
||||
*/
|
||||
|
||||
/**
|
||||
* Parser invalid code.
|
||||
*/
|
||||
enum SMCParser
|
||||
{
|
||||
Invalid_SMCParser = 0
|
||||
};
|
||||
|
||||
/**
|
||||
* 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 */
|
||||
};
|
||||
|
||||
/**
|
||||
* Creates a new SMC parser.
|
||||
* This is used to set parse hooks.
|
||||
*
|
||||
* @return A new handle to an SMC Parse structure.
|
||||
*/
|
||||
native SMCParser:SMC_CreateParser();
|
||||
|
||||
/**
|
||||
* Disposes of an SMC parser.
|
||||
*
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
*
|
||||
* @return True if disposed, false otherwise.
|
||||
*/
|
||||
native SMC_DestroyParser(&SMCParser:handle);
|
||||
|
||||
/**
|
||||
* Parses a config file.
|
||||
*
|
||||
* @param handle 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(SMCParser:handle, const file[], &line = 0, &col = 0);
|
||||
|
||||
/**
|
||||
* Sets the SMC_ParseStart function of a parse handle.
|
||||
*
|
||||
* @note Below is the prototype of callback:
|
||||
* -
|
||||
* Called when parsing is started.
|
||||
*
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
*
|
||||
* @noreturn
|
||||
*
|
||||
* public OnParseStart(SMCParser:handle)
|
||||
* -
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
* @param func A ParseStart callback.
|
||||
*
|
||||
* @noreturn
|
||||
* @error Invalid or corrupt handle.
|
||||
*/
|
||||
native SMC_SetParseStart(SMCParser:handle, const func[]);
|
||||
|
||||
/**
|
||||
* Sets the SMC_ParseEnd function of a parse handle.
|
||||
*
|
||||
* @note Below is the prototype of callback:
|
||||
* -
|
||||
* Called when parsing is halted.
|
||||
*
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
* @param halted True if abnormally halted, false otherwise.
|
||||
* @param failed True if parsing failed, false otherwise.
|
||||
*
|
||||
* @noreturn
|
||||
*
|
||||
* public OnParseEnd(SMCParser:handle, bool:halted, bool:failed)
|
||||
* -
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
* @param func A ParseEnd callback.
|
||||
*
|
||||
* @noreturn
|
||||
* @error Invalid or corrupt handle.
|
||||
*/
|
||||
native SMC_SetParseEnd(SMCParser:handle, const func[]);
|
||||
|
||||
/**
|
||||
* Sets the three main reader functions.
|
||||
*
|
||||
* @note Enclosing quotes are always stripped.
|
||||
* @note Below is the prototype of callbacks:
|
||||
* -
|
||||
* NewSection:
|
||||
* Called when the parser finds a new section or sub-section.
|
||||
*
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
* @param name String containing section name.
|
||||
*
|
||||
* @return An SMCResult action to take.
|
||||
*
|
||||
* public SMCResult:OnNewSection(SMCParser:handle, const name[])
|
||||
*
|
||||
* KeyValue:
|
||||
* Called when the parser finds a new key/value pair.
|
||||
*
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
* @param key String containing key name.
|
||||
* @param value String containing value name.
|
||||
*
|
||||
* @return An SMCResult action to take.
|
||||
*
|
||||
* public SMCResult:OnKeyValue(SMCParser:handle, const key[], const value[])
|
||||
*
|
||||
* EndSection:
|
||||
* Called when the parser finds the end of the current section.
|
||||
*
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
*
|
||||
* @return An SMCResult action to take.
|
||||
*
|
||||
* public SMCResult:OnEndSection(SMCParser:handle)
|
||||
* -
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
* @param kv A KeyValue callback.
|
||||
* @param ns An optional NewSection callback.
|
||||
* @param es An optional EndSection callback.
|
||||
*
|
||||
* @noreturn
|
||||
*/
|
||||
native SMC_SetReaders(SMCParser:smc, const kvFunc[], const nsFunc[] = "", const esFunc[] = "");
|
||||
|
||||
/**
|
||||
* Sets a raw line reader on an text parser handle.
|
||||
*
|
||||
* @note Below is the prototype of callbacks:
|
||||
* -
|
||||
* Called whenever a raw line is read.
|
||||
*
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
* @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(SMCParser:handle, const line[], lineno)
|
||||
* -
|
||||
* @param handle Handle to an SMC Parse structure.
|
||||
* @param func A RawLine callback.
|
||||
*
|
||||
* @noreturn
|
||||
*/
|
||||
native SMC_SetRawLine(SMCParser:handle, const func[]);
|
||||
|
||||
/**
|
||||
* 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);
|
||||
Reference in New Issue
Block a user