parser test updated, and documentation added
This commit is contained in:
parent
4b8b1a98c0
commit
5a9d7ca07d
2 changed files with 89 additions and 213 deletions
|
|
@ -2,6 +2,86 @@
|
||||||
|
|
||||||
# Basic Overview
|
# Basic Overview
|
||||||
|
|
||||||
The ARC_Parser type
|
The ::ARC_Parser type is a generic parsing type. To create the type it is recommeded you use ARC_Parser_CreateFromString(
|
||||||
|
|
||||||
# Basic Example
|
# Basic Example
|
||||||
|
|
||||||
|
```c
|
||||||
|
const char *languageCString =
|
||||||
|
"<variable> -> ALPHA_UPPER_CHAR <variableName> | ALPHA_LOWER_CHAR <variableName> | UNDERSCORE <variableName>\n"
|
||||||
|
"<variableName> -> <variableChar> <variableName> | LAMBDA\n"
|
||||||
|
"<variableChar> -> ALPHA_UPPER_CHAR | ALPHA_LOWER_CHAR | UNDERSCORE | NUMBER\n";
|
||||||
|
|
||||||
|
#define ARC_DOC_UNDERSCORE 1
|
||||||
|
#define ARC_DOC_NUMBER 2
|
||||||
|
#define ARC_DOC_ALPHA_UPPER_CHAR 3
|
||||||
|
#define ARC_DOC_ALPHA_LOWER_CHAR 4
|
||||||
|
#define ARC_DOC_VARIABLE 5
|
||||||
|
#define ARC_DOC_VARIABLE_NAME 6
|
||||||
|
#define ARC_DOC_VARIABLE_CHAR 7
|
||||||
|
|
||||||
|
void ARC_TEST_InitLexerRulesFn(ARC_Lexer *lexer){
|
||||||
|
ARC_Lexer_RegisterTokenRule(lexer, ARC_LexerTokenRule_CreateAndReturnMatchCharRule(ARC_TEST_TAG_UNDERSCORE, '_' ));
|
||||||
|
|
||||||
|
ARC_Lexer_RegisterTokenRule(lexer, ARC_LexerTokenRule_CreateAndReturnMatchCharOrBetween(ARC_TEST_TAG_NUMBER , '0', '9'));
|
||||||
|
ARC_Lexer_RegisterTokenRule(lexer, ARC_LexerTokenRule_CreateAndReturnMatchCharOrBetween(ARC_TEST_TAG_ALPHA_LOWER_CHAR, 'a', 'z'));
|
||||||
|
ARC_Lexer_RegisterTokenRule(lexer, ARC_LexerTokenRule_CreateAndReturnMatchCharOrBetween(ARC_TEST_TAG_ALPHA_UPPER_CHAR, 'A', 'Z'));
|
||||||
|
}
|
||||||
|
|
||||||
|
uint32_t ARC_TEST_GetStringIdFn(ARC_String *string){
|
||||||
|
if(ARC_String_EqualsCStringWithStrlen(string, "LAMBDA")){
|
||||||
|
return ARC_PARSER_TAG_LAMBDA;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(ARC_String_EqualsCStringWithStrlen(string, "UNDERSCORE")){
|
||||||
|
return ARC_TEST_TAG_UNDERSCORE;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(ARC_String_EqualsCStringWithStrlen(string, "NUMBER")){
|
||||||
|
return ARC_TEST_TAG_NUMBER;
|
||||||
|
}
|
||||||
|
if(ARC_String_EqualsCStringWithStrlen(string, "ALPHA_UPPER_CHAR")){
|
||||||
|
return ARC_TEST_TAG_ALPHA_UPPER_CHAR;
|
||||||
|
}
|
||||||
|
if(ARC_String_EqualsCStringWithStrlen(string, "ALPHA_LOWER_CHAR")){
|
||||||
|
return ARC_TEST_TAG_ALPHA_LOWER_CHAR;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(ARC_String_EqualsCStringWithStrlen(string, "<variable>")){
|
||||||
|
return ARC_TEST_TAG_VARIABLE;
|
||||||
|
}
|
||||||
|
if(ARC_String_EqualsCStringWithStrlen(string, "<variableName>")){
|
||||||
|
return ARC_TEST_TAG_VARIABLE_NAME;
|
||||||
|
}
|
||||||
|
if(ARC_String_EqualsCStringWithStrlen(string, "<variableChar>")){
|
||||||
|
return ARC_TEST_TAG_VARIABLE_CHAR;
|
||||||
|
}
|
||||||
|
|
||||||
|
return ~(uint32_t)0;
|
||||||
|
}
|
||||||
|
|
||||||
|
void ARC_TESTData_CreateFn(void **data, ARC_ParserTagToken *parsedData, void *userData){
|
||||||
|
}
|
||||||
|
|
||||||
|
void ARC_TESTData_DestroyFn(void *data, ARC_Bool clear, void *userData){
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(){
|
||||||
|
ARC_String *languageString;
|
||||||
|
ARC_String_CreateWithStrlen(&languageString, (char *)languageCString);
|
||||||
|
|
||||||
|
ARC_Parser *parser;
|
||||||
|
ARC_ParserData_CreateFn createCharFn = ARC_TESTData_CreateFn;
|
||||||
|
ARC_ParserData_DestroyFn destroyCharFn = ARC_TESTData_DestroyFn;
|
||||||
|
ARC_Parser_CreateFromString(&parser, languageString, ARC_TEST_InitLexerRulesFn, ARC_TEST_GetStringIdFn, &createCharFn, &destroyCharFn, NULL);
|
||||||
|
ARC_String_Destroy(languageString);
|
||||||
|
|
||||||
|
//this destroys string, so no need for cleanup
|
||||||
|
ARC_String *tempString;
|
||||||
|
ARC_String_CreateWithStrlen(&tempString, "variable123");
|
||||||
|
ARC_Parser_Parse(parser, &tempString);
|
||||||
|
|
||||||
|
// cleanup
|
||||||
|
ARC_Parser_Destroy(parser);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
|
||||||
|
|
@ -2,25 +2,23 @@
|
||||||
#include "arc/std/bool.h"
|
#include "arc/std/bool.h"
|
||||||
#include "arc/std/errno.h"
|
#include "arc/std/errno.h"
|
||||||
#include "arc/std/parser.h"
|
#include "arc/std/parser.h"
|
||||||
#include "arc/std/parser/helpers.h"
|
|
||||||
#include "arc/std/lexer.h"
|
#include "arc/std/lexer.h"
|
||||||
#include "arc/std/vector.h"
|
|
||||||
#include <stddef.h>
|
#include <stddef.h>
|
||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
|
|
||||||
//TODO: rewrite these tests. ARC_Config does use both the parser and lexer so for now (very temporary) its tests function for these ones
|
//TODO: add more tests
|
||||||
const char *languageCString =
|
const char *languageCString =
|
||||||
"<variable> -> ALPHA_UPPER_CHAR <variableName> | ALPHA_LOWER_CHAR <variableName> | UNDERSCORE <variableName>\n"
|
"<variable> -> ALPHA_UPPER_CHAR <variableName> | ALPHA_LOWER_CHAR <variableName> | UNDERSCORE <variableName>\n"
|
||||||
"<variableName> -> <variableChar> <variableName> | LAMBDA\n"
|
"<variableName> -> <variableChar> <variableName> | LAMBDA\n"
|
||||||
"<variableChar> -> ALPHA_UPPER_CHAR | ALPHA_LOWER_CHAR | UNDERSCORE | NUMBER\n";
|
"<variableChar> -> ALPHA_UPPER_CHAR | ALPHA_LOWER_CHAR | UNDERSCORE | NUMBER\n";
|
||||||
|
|
||||||
#define ARC_TEST_TAG_UNDERSCORE 0
|
#define ARC_TEST_TAG_UNDERSCORE 1
|
||||||
#define ARC_TEST_TAG_NUMBER 1
|
#define ARC_TEST_TAG_NUMBER 2
|
||||||
#define ARC_TEST_TAG_ALPHA_UPPER_CHAR 2
|
#define ARC_TEST_TAG_ALPHA_UPPER_CHAR 3
|
||||||
#define ARC_TEST_TAG_ALPHA_LOWER_CHAR 3
|
#define ARC_TEST_TAG_ALPHA_LOWER_CHAR 4
|
||||||
#define ARC_TEST_TAG_VARIABLE 4
|
#define ARC_TEST_TAG_VARIABLE 5
|
||||||
#define ARC_TEST_TAG_VARIABLE_NAME 5
|
#define ARC_TEST_TAG_VARIABLE_NAME 6
|
||||||
#define ARC_TEST_TAG_VARIABLE_CHAR 6
|
#define ARC_TEST_TAG_VARIABLE_CHAR 7
|
||||||
|
|
||||||
void ARC_TEST_InitLexerRulesFn(ARC_Lexer *lexer){
|
void ARC_TEST_InitLexerRulesFn(ARC_Lexer *lexer){
|
||||||
ARC_Lexer_RegisterTokenRule(lexer, ARC_LexerTokenRule_CreateAndReturnMatchCharRule(ARC_TEST_TAG_UNDERSCORE, '_' ));
|
ARC_Lexer_RegisterTokenRule(lexer, ARC_LexerTokenRule_CreateAndReturnMatchCharRule(ARC_TEST_TAG_UNDERSCORE, '_' ));
|
||||||
|
|
@ -130,205 +128,3 @@ ARC_TEST(Parser_Basic_Parse){
|
||||||
/* ~ cleanup ~ */
|
/* ~ cleanup ~ */
|
||||||
ARC_Parser_Destroy(parser);
|
ARC_Parser_Destroy(parser);
|
||||||
}
|
}
|
||||||
|
|
||||||
//ARC_TEST(Parser_Basic_ParseError){
|
|
||||||
// ARC_Parser *parser;
|
|
||||||
// ARC_Parser_Create(&parser, &languageArray, TEST_Parser_InitLexerRulesFn, NULL, NULL, NULL);
|
|
||||||
//
|
|
||||||
// ARC_String *tempString;
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// /* ~ first test ~ */
|
|
||||||
// ARC_String_CreateWithStrlen(&tempString, "!myVar1");
|
|
||||||
//
|
|
||||||
// //this destroys string, so no need for cleanup
|
|
||||||
// ARC_Parser_Parse(parser, &tempString);
|
|
||||||
//
|
|
||||||
// ARC_CHECK(arc_errno == ARC_ERRNO_DATA);
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// /* ~ second test ~ */
|
|
||||||
// //check again with moved character
|
|
||||||
// arc_errno = 0;
|
|
||||||
// ARC_String_CreateWithStrlen(&tempString, "my!Var1");
|
|
||||||
//
|
|
||||||
// //this destroys string, so no need for cleanup
|
|
||||||
// ARC_Parser_Parse(parser, &tempString);
|
|
||||||
//
|
|
||||||
// ARC_CHECK(arc_errno == ARC_ERRNO_DATA);
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// /* ~ third test ~ */
|
|
||||||
// //check again with moved character
|
|
||||||
// arc_errno = 0;
|
|
||||||
// ARC_String_CreateWithStrlen(&tempString, "myVar1!");
|
|
||||||
//
|
|
||||||
// //this destroys string, so no need for cleanup
|
|
||||||
// ARC_Parser_Parse(parser, &tempString);
|
|
||||||
//
|
|
||||||
// ARC_CHECK(arc_errno == ARC_ERRNO_DATA);
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// /* ~ cleanup ~ */
|
|
||||||
// ARC_Parser_Destroy(parser);
|
|
||||||
//
|
|
||||||
// //reset for next test
|
|
||||||
// arc_errno = 0;
|
|
||||||
//}
|
|
||||||
//
|
|
||||||
//ARC_TEST(Parser_Basic_GetParsedValue){
|
|
||||||
// ARC_Parser *parser;
|
|
||||||
//
|
|
||||||
// ARC_ParserData_CreateFn createStringFn = TEST_ParserData_CreateStringFn;
|
|
||||||
// ARC_ParserData_DestroyFn destroyStringFn = TEST_ParserData_DestroyStringFn;
|
|
||||||
//
|
|
||||||
// ARC_Parser_Create(&parser, &languageArray, TEST_Parser_InitLexerRulesFn, &createStringFn, &destroyStringFn, NULL);
|
|
||||||
//
|
|
||||||
// ARC_String *tempString;
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// /* ~ first test ~ */
|
|
||||||
// ARC_String_CreateWithStrlen(&tempString, "myvar1");
|
|
||||||
//
|
|
||||||
// //this destroys string, so no need for cleanup
|
|
||||||
// ARC_Parser_Parse(parser, &tempString);
|
|
||||||
//
|
|
||||||
// ARC_CHECK(arc_errno == 0);
|
|
||||||
//
|
|
||||||
// ARC_String *checkValue = (ARC_String *)ARC_Parser_GetData(parser);
|
|
||||||
// ARC_CHECK(ARC_String_EqualsCStringWithStrlen(checkValue, "myvar1"));
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// /* ~ cleanup ~ */
|
|
||||||
// ARC_Parser_Destroy(parser);
|
|
||||||
//}
|
|
||||||
//
|
|
||||||
//ARC_TEST(Parser_ParserLang_BasicVector){
|
|
||||||
// ARC_Vector *testLanguage;
|
|
||||||
// ARC_Vector_Create(&testLanguage, NULL, NULL);
|
|
||||||
//
|
|
||||||
// ARC_Vector_Add(testLanguage, testTags + 0);
|
|
||||||
// ARC_Vector_Add(testLanguage, testTags + 1);
|
|
||||||
// ARC_Vector_Add(testLanguage, testTags + 2);
|
|
||||||
//
|
|
||||||
// ARC_Parser *parser;
|
|
||||||
// ARC_Parser_CreateFromVector(&parser, testLanguage, TEST_Parser_InitLexerRulesFn, NULL, NULL, NULL);
|
|
||||||
//
|
|
||||||
// ARC_String *tempString;
|
|
||||||
// ARC_String_CreateWithStrlen(&tempString, "variablename");
|
|
||||||
//
|
|
||||||
// //this destroys string, so no need for cleanup
|
|
||||||
// ARC_Parser_Parse(parser, &tempString);
|
|
||||||
//
|
|
||||||
// //cleanup
|
|
||||||
// ARC_Parser_Destroy(parser);
|
|
||||||
// ARC_Vector_Destroy(testLanguage);
|
|
||||||
//
|
|
||||||
// ARC_CHECK(arc_errno == 0);
|
|
||||||
//}
|
|
||||||
//
|
|
||||||
///* ~ parser tests ~ */
|
|
||||||
//void TEST_Parser_InitBasicLexerTokenRules(ARC_Lexer *lexer){
|
|
||||||
// //null
|
|
||||||
// ARC_Lexer_RegisterTokenRule(lexer, ARC_LexerTokenRule_CreateAndReturnMatchCharRule(ARC_PARSER_TAG_LAMBDA, 0));
|
|
||||||
//
|
|
||||||
// //alpha char
|
|
||||||
// ARC_Lexer_RegisterTokenRule(lexer, ARC_LexerTokenRule_CreateAndReturnMatchCharOrBetween(TEST_PARSER_ALPHA_LOWER_CHAR, 'a', 'z'));
|
|
||||||
// ARC_Lexer_RegisterTokenRule(lexer, ARC_LexerTokenRule_CreateAndReturnMatchCharOrBetween(TEST_PARSER_ALPHA_UPPER_CHAR, 'A', 'Z'));
|
|
||||||
//}
|
|
||||||
//
|
|
||||||
//uint32_t TEST_Parser_GetStringIdFn(ARC_String *string){
|
|
||||||
// if(ARC_String_EqualsCStringWithStrlen(string, "<alphaChar>")){
|
|
||||||
// return TEST_PARSER_ALPHA_CHAR;
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// if(ARC_String_EqualsCStringWithStrlen(string, "ALPHA_LOWER_CHAR")){
|
|
||||||
// return TEST_PARSER_ALPHA_LOWER_CHAR;
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// if(ARC_String_EqualsCStringWithStrlen(string, "ALPHA_UPPER_CHAR")){
|
|
||||||
// return TEST_PARSER_ALPHA_UPPER_CHAR;
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// return ~(uint32_t)0;
|
|
||||||
//}
|
|
||||||
//
|
|
||||||
//void TEST_ParserData_CreateCharFn(void **data, ARC_ParserTagToken *parsedData, void *userData){
|
|
||||||
// if(parsedData == NULL){
|
|
||||||
// *data = NULL;
|
|
||||||
// return;
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// char *alphaChar = (char *)malloc(sizeof(char));
|
|
||||||
//
|
|
||||||
// ARC_ParserTagToken *tagToken = (ARC_ParserTagToken *)ARC_Vector_Get(parsedData->tagTokens, 0);
|
|
||||||
// *alphaChar = tagToken->token->data->data[0];
|
|
||||||
//
|
|
||||||
// *data = (void *)alphaChar;
|
|
||||||
//}
|
|
||||||
//
|
|
||||||
//void TEST_ParserData_DestroyCharFn(void *data, ARC_Bool clear, void *userData){
|
|
||||||
// if(data == NULL){
|
|
||||||
// return;
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// free((char *)data);
|
|
||||||
//}
|
|
||||||
//
|
|
||||||
//ARC_TEST(Parser_Parser_BasicCreateWithStringTest){
|
|
||||||
// ARC_Parser *parser;
|
|
||||||
//
|
|
||||||
// /* ~ create the language ~ */
|
|
||||||
// ARC_String *languageString;
|
|
||||||
// ARC_String_CreateWithStrlen(&languageString, "<alphaChar> -> ALPHA_LOWER_CHAR | ALPHA_UPPER_CHAR\n");
|
|
||||||
//
|
|
||||||
// ARC_ParserData_CreateFn createCharFn = TEST_ParserData_CreateCharFn;
|
|
||||||
// ARC_ParserData_DestroyFn destroyCharFn = TEST_ParserData_DestroyCharFn;
|
|
||||||
// ARC_Parser_CreateFromString(&parser, languageString, TEST_Parser_InitBasicLexerTokenRules, TEST_Parser_GetStringIdFn, &createCharFn, &destroyCharFn, NULL);
|
|
||||||
//
|
|
||||||
// ARC_String_Destroy(languageString);
|
|
||||||
//
|
|
||||||
// ARC_CHECK(arc_errno == 0);
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// /* ~ check if a can be parsed ~ */
|
|
||||||
// ARC_String *tempString;
|
|
||||||
// ARC_String_CreateWithStrlen(&tempString, "a");
|
|
||||||
//
|
|
||||||
// ARC_Parser_Parse(parser, &tempString);
|
|
||||||
//
|
|
||||||
// char *data = (char *)ARC_Parser_GetData(parser);
|
|
||||||
//
|
|
||||||
// ARC_CHECK(*data == 'a');
|
|
||||||
//
|
|
||||||
// ARC_Parser_ClearData(parser);
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// /* ~ check if Z can be parsed ~ */
|
|
||||||
// ARC_String_CreateWithStrlen(&tempString, "Z");
|
|
||||||
//
|
|
||||||
// ARC_Parser_Parse(parser, &tempString);
|
|
||||||
//
|
|
||||||
// data = (char *)ARC_Parser_GetData(parser);
|
|
||||||
//
|
|
||||||
// ARC_CHECK(*data == 'Z');
|
|
||||||
//
|
|
||||||
// ARC_Parser_ClearData(parser);
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// /* ~ check if 8 errors ~ */
|
|
||||||
// ARC_String_CreateWithStrlen(&tempString, "8");
|
|
||||||
//
|
|
||||||
// ARC_Parser_Parse(parser, &tempString);
|
|
||||||
//
|
|
||||||
// data = (char *)ARC_Parser_GetData(parser);
|
|
||||||
//
|
|
||||||
// ARC_CHECK(arc_errno == ARC_ERRNO_DATA);
|
|
||||||
// arc_errno = 0;
|
|
||||||
//
|
|
||||||
// ARC_Parser_ClearData(parser);
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// //cleanup
|
|
||||||
// ARC_Parser_Destroy(parser);
|
|
||||||
//}
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue