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

Fix documentation.

Browse Source
This commit is contained in:
Arkshine 2014-08-07 01:16:44 +02:00
parent a0852adf18
commit 6b5387f428
2 changed files with 40 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
plugins/include/textparse_ini.inc
View File

@ -17,11 +17,8 @@
#define _textparse_ini_included #define _textparse_ini_included
/** /**
* This parser API is entirely event based. You must hook events to receive data. * This parser API is entirely event based.
* The file format can ben either INI or SMC (also known as "SourceMod Configuration". * You must hook events to receive data.
* SMC format is nearly identical to VDF (also known as "Valve's KeyValues format").
* Also please note INI format is handled differently. Because more "simple" to parse, some
* event doesn't exist and callback prototype can be different.
*/ */
/** /**
@ -79,23 +76,23 @@ enum INIParser
native INIParser:INI_CreateParser(); native INIParser:INI_CreateParser();
/** /**
* Disposes of a INI parser. * Disposes of an INI parser.
* *
* @param handle Handle to a INI Parse. * @param handle Handle to an INI Parse structure.
* *
* @return True if disposed, false otherwise. * @return True if disposed, false otherwise.
*/ */
native INI_DestroyParser(&INIParser:handle); native INI_DestroyParser(&INIParser:handle);
/** /**
* Parses a INI config file. * Parses an INI config file.
* *
* @param handle A handle to an INI Parse structure. * @param handle A handle to an INI Parse structure.
* @param file A string containing the file path. * @param file A string containing the file path.
* @param line An optional by reference cell to store the last line number read. * @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. * @param col An optional by reference cell to store the last column number read.
* @return A SMCParseError result. * @return An SMCParseError result.
* @error Invalid or corrupt handle. * @error Invalid or corrupt handle.
*/ */
native bool:INI_ParseFile(INIParser:handle, const file[], &line = 0, &col = 0); native bool:INI_ParseFile(INIParser:handle, const file[], &line = 0, &col = 0);
@ -107,7 +104,7 @@ native bool:INI_ParseFile(INIParser:handle, const file[], &line = 0, &col = 0);
* - * -
* Called when parsing is started. * Called when parsing is started.
* *
* @param handle The INI Parse handle. * @param handle A handle to an INI Parse structure.
* *
* @noreturn * @noreturn
* *
@ -122,21 +119,21 @@ native bool:INI_ParseFile(INIParser:handle, const file[], &line = 0, &col = 0);
native INI_SetParseStart(INIParser:handle, const func[]); native INI_SetParseStart(INIParser:handle, const func[]);
/** /**
* Sets the INI_ParseEnd of a parse handle. * Sets the INI_ParseEnd function of a parse handle.
* *
* @note Below is the prototype of callback: * @note Below is the prototype of callback:
* - * -
* Called when parsing is halted. * Called when parsing is halted.
* *
* @param handle The INI Parse handle. * @param handle A handle to an INI Parse structure.
* @param halted True if abnormally halted, false otherwise. * @param halted True if abnormally halted, false otherwise.
* *
* @noreturn * @noreturn
* *
* public OnParseEnd(INIParser:handle, bool:halted) * public OnParseEnd(INIParser:handle, bool:halted)
* - * -
* @param handle Handle to a INI Parse. * @param handle Handle to an INI Parse structure.
* @param func A ParseEnd callback.. * @param func A ParseEnd callback.
* *
* @noreturn * @noreturn
* @error Invalid or corrupt handle. * @error Invalid or corrupt handle.
@ -144,19 +141,20 @@ native INI_SetParseStart(INIParser:handle, const func[]);
native INI_SetParseEnd(INIParser:handle, const func[]); native INI_SetParseEnd(INIParser:handle, const func[]);
/** /**
* Sets the three main reader functions. * Sets the two main reader functions.
* *
* @note Below is the prototype of callback: * @note Below is the prototype of callback:
* - * -
* NewSection: * NewSection:
* Called when the parser finds the end of the current section. * 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 section Name of section in between the [ and ] characters.
* @param invalid_tokens True if invalid tokens were detected in the name. * @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 close_bracket True if a closing bracket was detected, false otherwise.
* @param extra_tokens True if extra tokens were detected on the line. * @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. * @param curtok Contains current token in the line where the section name starts.
* can add to this offset when failing to point to a token. * You can add to this offset when failing to point to a token.
* @return True to keep parsing, false otherwise. * @return True to keep parsing, false otherwise.
* *
* public bool:OnNewSection(INIParser:handle, const section[], bool:invalid_tokens, bool:close_bracket, bool:extra_tokens, curtok) * public bool:OnNewSection(INIParser:handle, const section[], bool:invalid_tokens, bool:close_bracket, bool:extra_tokens, curtok)
@ -164,7 +162,7 @@ native INI_SetParseEnd(INIParser:handle, const func[]);
* KeyValue: * KeyValue:
* Called when the parser finds a new key/value pair. * Called when the parser finds a new key/value pair.
* *
* @param handle The INI Parse handle. * @param handle Handle to an INI Parse structure.
* @param key Name of key. * @param key Name of key.
* @param value String containing value (with quotes stripped, if any). * @param value String containing value (with quotes stripped, if any).
* @param invalid_tokens Whether or not the key contained invalid tokens. * @param invalid_tokens Whether or not the key contained invalid tokens.
@ -176,7 +174,7 @@ native INI_SetParseEnd(INIParser:handle, const func[]);
* *
* public bool:OnKeyValue(INIParser:handle, const key[], const value[], bool:invalid_tokens, bool:equal_token, bool:quotes, curtok) * public bool:OnKeyValue(INIParser:handle, const key[], const value[], bool:invalid_tokens, bool:equal_token, bool:quotes, curtok)
* - * -
* @param handle The INI parse handle. * @param handle Handle to an INI Parse structure.
* @param kv A KeyValue callback. * @param kv A KeyValue callback.
* @param ns An optional NewSection callback. * @param ns An optional NewSection callback.
* *
@ -200,7 +198,7 @@ native INI_SetReaders(INIParser:smc, const kvFunc[], const nsFunc[] = "" );
* *
* public bool:OnRawLine(INIParser:smc, const line[], lineno, curtok) * public bool:OnRawLine(INIParser:smc, const line[], lineno, curtok)
* *
* @param handle Handle to an INI Parse. * @param handle Handle to an INI Parse structure.
* @param func A RawLine callback. * @param func A RawLine callback.
* *
* @noreturn * @noreturn

44
plugins/include/textparse_smc.inc
View File

@ -17,11 +17,9 @@
#define _textparse_smc_included #define _textparse_smc_included
/** /**
* This parser API is entirely event based. You must hook events to receive data. * Everything below describes the SMC Parse, or "SourceMod Configuration" format.
* The file format can ben either INI or SMC (also known as "SourceMod Configuration". * This parser is entirely event based. You must hook events to receive data.
* SMC format is nearly identical to VDF (also known as "Valve's KeyValues format"). * The file format itself is nearly identical to Valve's KeyValues format (also known as VDF).
* Also please note INI format is handled differently. Because more "simple" to parse, some
* event doesn't exist and callback prototype can be different.
*/ */
/** /**
@ -109,9 +107,9 @@ enum SMCError
native SMCParser:SMC_CreateParser(); native SMCParser:SMC_CreateParser();
/** /**
* Disposes of a SMC parser. * Disposes of an SMC parser.
* *
* @param handle Handle to a SMC Parse * @param handle Handle to an SMC Parse structure.
* *
* @return True if disposed, false otherwise. * @return True if disposed, false otherwise.
*/ */
@ -125,7 +123,7 @@ native SMC_DestroyParser(&SMCParser:handle);
* @param line An optional by reference cell to store the last line number read. * @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. * @param col An optional by reference cell to store the last column number read.
* *
* @return A SMCParseError result. * @return An SMCParseError result.
* @error Invalid or corrupt handle. * @error Invalid or corrupt handle.
*/ */
native SMCError:SMC_ParseFile(SMCParser:handle, const file[], &line = 0, &col = 0); native SMCError:SMC_ParseFile(SMCParser:handle, const file[], &line = 0, &col = 0);
@ -137,13 +135,13 @@ native SMCError:SMC_ParseFile(SMCParser:handle, const file[], &line = 0, &col =
* - * -
* Called when parsing is started. * Called when parsing is started.
* *
* @param handle The Text Parse handle. * @param handle Handle to an SMC Parse structure.
* *
* @noreturn * @noreturn
* *
* public OnParseStart(SMCParser:handle) * public OnParseStart(SMCParser:handle)
* - * -
* @param handle Handle to a Text Parse. * @param handle Handle to an SMC Parse structure.
* @param func A ParseStart callback. * @param func A ParseStart callback.
* *
* @noreturn * @noreturn
@ -152,13 +150,13 @@ native SMCError:SMC_ParseFile(SMCParser:handle, const file[], &line = 0, &col =
native SMC_SetParseStart(SMCParser:handle, const func[]); native SMC_SetParseStart(SMCParser:handle, const func[]);
/** /**
* Sets the SMC_ParseEnd of a parse handle. * Sets the SMC_ParseEnd function of a parse handle.
* *
* @note Below is the prototype of callback: * @note Below is the prototype of callback:
* - * -
* Called when parsing is halted. * Called when parsing is halted.
* *
* @param handle The Text Parse handle. * @param handle Handle to an SMC Parse structure.
* @param halted True if abnormally halted, false otherwise. * @param halted True if abnormally halted, false otherwise.
* @param failed True if parsing failed, false otherwise. * @param failed True if parsing failed, false otherwise.
* *
@ -166,8 +164,8 @@ native SMC_SetParseStart(SMCParser:handle, const func[]);
* *
* public OnParseEnd(SMCParser:handle, bool:halted, bool:failed) * public OnParseEnd(SMCParser:handle, bool:halted, bool:failed)
* - * -
* @param handle Handle to a Text Parse. * @param handle Handle to an SMC Parse structure.
* @param func A ParseEnd callback.. * @param func A ParseEnd callback.
* *
* @noreturn * @noreturn
* @error Invalid or corrupt handle. * @error Invalid or corrupt handle.
@ -181,9 +179,9 @@ native SMC_SetParseEnd(SMCParser:handle, const func[]);
* @note Below is the prototype of callbacks: * @note Below is the prototype of callbacks:
* - * -
* NewSection: * NewSection:
* Called when the parser finds the end of the current section. * Called when the parser finds a new section or sub-section.
* *
* @param handle The Text Parse handle. * @param handle Handle to an SMC Parse structure.
* @param name String containing section name. * @param name String containing section name.
* *
* @return An SMCResult action to take. * @return An SMCResult action to take.
@ -193,22 +191,24 @@ native SMC_SetParseEnd(SMCParser:handle, const func[]);
* KeyValue: * KeyValue:
* Called when the parser finds a new key/value pair. * Called when the parser finds a new key/value pair.
* *
* @param handle The Text Parse handle. * @param handle Handle to an SMC Parse structure.
* @param key String containing key name. * @param key String containing key name.
* @param value String containing value name. * @param value String containing value name.
* *
* @return A SMCResult action to take. * @return An SMCResult action to take.
* *
* public SMCResult:OnKeyValue(SMCParser:handle, const key[], const value[]) * public SMCResult:OnKeyValue(SMCParser:handle, const key[], const value[])
* *
* EndSection: * EndSection:
* Called when the parser finds the end of the current section. * Called when the parser finds the end of the current section.
* *
* @param handle The Text Parse handle. * @param handle Handle to an SMC Parse structure.
*
* @return An SMCResult action to take.
* *
* public SMCResult:OnEndSection(SMCParser:handle) * public SMCResult:OnEndSection(SMCParser:handle)
* - * -
* @param handle The Text parse handle. * @param handle Handle to an SMC Parse structure.
* @param kv A KeyValue callback. * @param kv A KeyValue callback.
* @param ns An optional NewSection callback. * @param ns An optional NewSection callback.
* @param es An optional EndSection callback. * @param es An optional EndSection callback.
@ -224,7 +224,7 @@ native SMC_SetReaders(SMCParser:smc, const kvFunc[], const nsFunc[] = "", const
* - * -
* Called whenever a raw line is read. * Called whenever a raw line is read.
* *
* @param handle The Text Parse handle. * @param handle Handle to an SMC Parse structure.
* @param line A string containing the raw line from the file. * @param line A string containing the raw line from the file.
* @param lineno The line number it occurs on. * @param lineno The line number it occurs on.
* *
@ -232,7 +232,7 @@ native SMC_SetReaders(SMCParser:smc, const kvFunc[], const nsFunc[] = "", const
* *
* public SMCResult:SMC_RawLine(SMCParser:handle, const line[], lineno) * public SMCResult:SMC_RawLine(SMCParser:handle, const line[], lineno)
* - * -
* @param handle Handle to an Text Parse. * @param handle Handle to an SMC Parse structure.
* @param func A RawLine callback. * @param func A RawLine callback.
* *
* @noreturn * @noreturn