basic vector complete but untested, added destroy callback to vector
This commit is contained in:
herbglitch
parent
6e814f12e6
commit
4c0c5d377d
4 changed files with 445 additions and 97 deletions
|
|
@ -9,35 +9,6 @@ extern "C" {
|
|||
#include "arc/std/string.h"
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*/
|
||||
typedef enum ARC_Lexer_BasicTokens {
|
||||
LEXER_TOKEN_LAMBDA = 0,
|
||||
LEXER_TOKEN_COLON = ':',
|
||||
LEXER_TOKEN_SEMICOLON = ';',
|
||||
LEXER_TOKEN_COMMA = ',',
|
||||
LEXER_TOKEN_PERIOD = '.',
|
||||
LEXER_TOKEN_FORWARD_SLASH = '/',
|
||||
LEXER_TOKEN_BACK_SLASH = '\\',
|
||||
LEXER_TOKEN_LEFT_PARENTHESIS = '(',
|
||||
LEXER_TOKEN_RIGHT_PARENTHESIS = ')',
|
||||
LEXER_TOKEN_LEFT_CURLY_BRACE = '{',
|
||||
LEXER_TOKEN_RIGHT_CURLY_BRACE = '}',
|
||||
} ARC_Lexer_BasicTokens;
|
||||
|
||||
/**
|
||||
* @brief checks to see if a string is a type of token
|
||||
*
|
||||
* @param[in/out] string a string to be checked to see if it matches a token,
|
||||
* this needs to srip the token out for the lexer to avoid an infinite loop
|
||||
* @param[out] tokenData a place to store token data (like a variable name), can be NULL if not needed
|
||||
* @param[in] automataData any data that needs to be used for the ARC_Lexer_AutomataFn
|
||||
*
|
||||
* @return if a token was successfully found ARC_True, otherwise ARC_False
|
||||
*/
|
||||
typedef ARC_Bool (* ARC_Lexer_AutomataFn)(ARC_String **string, ARC_String **tokenData, void *automataData);
|
||||
|
||||
/**
|
||||
* @brief a lexer type
|
||||
*/
|
||||
|
|
@ -47,46 +18,110 @@ typedef struct ARC_Lexer ARC_Lexer;
|
|||
* @brief a lexer token type
|
||||
*/
|
||||
typedef struct ARC_LexerToken {
|
||||
uint32_t id;
|
||||
|
||||
ARC_Lexer_AutomataFn automataFn;
|
||||
void *automataData;
|
||||
//TODO: automataData free callback
|
||||
uint32_t rule;
|
||||
ARC_String *data;
|
||||
} ARC_LexerToken;
|
||||
|
||||
/**
|
||||
* @brief
|
||||
* @brief checks to see if a string is a type of token
|
||||
*
|
||||
* @note do not set tokenData if this function returns ARC_False, doing so will create a memory leak
|
||||
*
|
||||
* @param[in/out] string a string to be checked to see if it matches a token,
|
||||
* this needs to srip the token out for the lexer to avoid an infinite loop
|
||||
* @param[out] tokenData a place to store token data (like a variable name), can be NULL if not needed
|
||||
* @param[in] automataData any data that needs to be used for the ARC_Lexer_AutomataFn
|
||||
*
|
||||
* @return if a token was successfully found ARC_True, otherwise ARC_False
|
||||
*/
|
||||
typedef ARC_Bool (* ARC_LexerTokenRule_AutomataFn)(ARC_String **string, ARC_String **tokenData, void *automataData);
|
||||
|
||||
/**
|
||||
* @brief a callback function to clean up ARC_LexerTokenRule's automataData
|
||||
*
|
||||
* @param automataData the void * automataData to destroy
|
||||
*/
|
||||
typedef void (* ARC_LexerTokenRule_DestroyAutomataDataFn)(void *automataData);
|
||||
|
||||
|
||||
/**
|
||||
* @brief a lexer token rule type
|
||||
*/
|
||||
typedef struct ARC_LexerTokenRule {
|
||||
uint32_t id;
|
||||
|
||||
void *automataData;
|
||||
|
||||
ARC_LexerTokenRule_AutomataFn automataFn;
|
||||
ARC_LexerTokenRule_DestroyAutomataDataFn destroyAutomataDataFn;
|
||||
} ARC_LexerTokenRule;
|
||||
|
||||
/**
|
||||
* @brief creates an ARC_Lexer type
|
||||
*
|
||||
* @param[out] lexer
|
||||
*/
|
||||
void ARC_Lexer_Create(ARC_Lexer **lexer);
|
||||
|
||||
/**
|
||||
* @brief
|
||||
* @brief destroys an ARC_Lexer type
|
||||
*
|
||||
* @param[in] lexer ARC_Lexer to free
|
||||
*/
|
||||
void ARC_Lexer_Destroy(ARC_Lexer *lexer);
|
||||
|
||||
/**
|
||||
* @brief
|
||||
* @brief adds a token rule to a lexer
|
||||
*
|
||||
* @param [in] lexer
|
||||
* @param [in] token
|
||||
* @param [in] lexer the lexer to add a token rule to
|
||||
* @param [in] tokenRule the token rule to add
|
||||
*/
|
||||
void ARC_Lexer_RegisterToken(ARC_Lexer *lexer, ARC_LexerToken token);
|
||||
void ARC_Lexer_RegisterTokenRule(ARC_Lexer *lexer, ARC_LexerTokenRule tokenRule);
|
||||
|
||||
/**
|
||||
* @brief
|
||||
* @brief creates tokens using a given string with ARC_LexerToken rules
|
||||
*
|
||||
* @param[in] lexer
|
||||
* @param[in] path
|
||||
* @param[in] lexer the lexer to get the ARC_LexerTokens from
|
||||
* @param[in/out] data the string to lex, will be freed and set to NULL by the end of this function
|
||||
*/
|
||||
void ARC_Lexer_LexString(ARC_Lexer *lexer, ARC_String **data);
|
||||
|
||||
/**
|
||||
* @brief reads in and lexs a file
|
||||
*
|
||||
* @note this function will call ARC_Lexer_LexString, so it's notes are applicable to this function
|
||||
*
|
||||
* @param[in] lexer the lexer which holds to rules to use
|
||||
* @param[in] path path of file to read in and lex
|
||||
*/
|
||||
void ARC_Lexer_LexFile(ARC_Lexer *lexer, ARC_String *path);
|
||||
|
||||
/**
|
||||
* @brief gets a token at a given index from a lexer
|
||||
*
|
||||
* @note unless you have a very good reason, you probably don't want to mess with the tokens string.
|
||||
* that will probably change the token's string inside the lexer
|
||||
*
|
||||
* @param[in] lexer the lexer to get the token from
|
||||
* @param[in] index the index of the token in the lexer to get
|
||||
*
|
||||
* @return a copy of the token, or a token with max value for rule and NULL for data on error
|
||||
*/
|
||||
ARC_LexerToken ARC_Lexer_GetToken(ARC_Lexer *lexer, uint32_t index);
|
||||
|
||||
/**
|
||||
* @brief gets a token at a given index from a lexer
|
||||
*
|
||||
* @param[in] lexer the lexer to get the tokens size from
|
||||
*
|
||||
* @return the size of the token array in a lexer
|
||||
*/
|
||||
uint32_t ARC_Lexer_GetTokensSize(ARC_Lexer *lexer);
|
||||
|
||||
/**
|
||||
* @brief checks if the first character of string matches the automataData cast as a char
|
||||
*
|
||||
* @note this is intended as a helper callback
|
||||
* @note this function is a ARC_Lexer_AutomataFn callback
|
||||
*
|
||||
* @param[in/out] string a string to be checked to see if it matches a token,
|
||||
|
|
@ -101,6 +136,7 @@ ARC_Bool ARC_Lexer_AutomataMatchCharFn(ARC_String **string, ARC_String **tokenDa
|
|||
/**
|
||||
* @brief checks if the substring automataData as an ARC_String matches the first part of string
|
||||
*
|
||||
* @note this is intended as a helper callback
|
||||
* @note this function is a ARC_Lexer_AutomataFn callback
|
||||
*
|
||||
* @param[in/out] string a string to be checked to see if it matches a token,
|
||||
|
|
@ -112,6 +148,81 @@ ARC_Bool ARC_Lexer_AutomataMatchCharFn(ARC_String **string, ARC_String **tokenDa
|
|||
*/
|
||||
ARC_Bool ARC_Lexer_AutomataMatchStringFn(ARC_String **string, ARC_String **tokenData, void *automataData);
|
||||
|
||||
/**
|
||||
* @brief creates a ARC_LexerTokenRule with a given id and character
|
||||
*
|
||||
* @note this is intended as a helper funtion
|
||||
*
|
||||
* @param[in] id a tokens id (basically the token value)
|
||||
* @param[in] character the character to match against
|
||||
*
|
||||
* @return a token rule based in the id and character
|
||||
*/
|
||||
ARC_LexerTokenRule ARC_LexerTokenRule_CreateAndReturnMatchCharRule(uint32_t id, char character);
|
||||
|
||||
/**
|
||||
* @brief creates a ARC_LexerTokenRule with a given id and string
|
||||
*
|
||||
* @note this is intended as a helper funtion
|
||||
* #note string will not be freed (it will be copied and the copy will be freed)
|
||||
*
|
||||
* @param[in] id a tokens id (basically the token value)
|
||||
* @param[in] character the string to match against, will be copied
|
||||
*
|
||||
* @return a token rule based in the id and string
|
||||
*/
|
||||
ARC_LexerTokenRule ARC_LexerTokenRule_CreateAndReturnMatchStringRule(uint32_t id, ARC_String *string);
|
||||
|
||||
/**
|
||||
* @brief basic token type ids, chars, and tags
|
||||
*/
|
||||
#define LEXER_TOKEN_COLON_ID 1
|
||||
#define LEXER_TOKEN_COLON_CHAR ':'
|
||||
#define LEXER_TOKEN_COLON_TAG "COLON"
|
||||
#define LEXER_TOKEN_SEMICOLON_ID 2
|
||||
#define LEXER_TOKEN_SEMICOLON_CHAR ';'
|
||||
#define LEXER_TOKEN_SEMICOLON_TAG "SEMICOLON"
|
||||
#define LEXER_TOKEN_COMMA_ID 3
|
||||
#define LEXER_TOKEN_COMMA_CHAR ','
|
||||
#define LEXER_TOKEN_COMMA_TAG "COMMA"
|
||||
#define LEXER_TOKEN_PERIOD_ID 4
|
||||
#define LEXER_TOKEN_PERIOD_CHAR '.'
|
||||
#define LEXER_TOKEN_PERIOD_TAG "PERIOD"
|
||||
#define LEXER_TOKEN_FORWARD_SLASH_ID 5
|
||||
#define LEXER_TOKEN_FORWARD_SLASH_CHAR '/'
|
||||
#define LEXER_TOKEN_FORWARD_SLASH_TAG "FORWARD_SLASH"
|
||||
#define LEXER_TOKEN_BACK_SLASH_ID 6
|
||||
#define LEXER_TOKEN_BACK_SLASH_CHAR '\\'
|
||||
#define LEXER_TOKEN_BACK_SLASH_TAG "BACK_SLASH"
|
||||
#define LEXER_TOKEN_LEFT_PARENTHESIS_ID 7
|
||||
#define LEXER_TOKEN_LEFT_PARENTHESIS_CHAR '('
|
||||
#define LEXER_TOKEN_LEFT_PARENTHESIS_TAG "LEFT_PARENTHESIS"
|
||||
#define LEXER_TOKEN_RIGHT_PARENTHESIS_ID 8
|
||||
#define LEXER_TOKEN_RIGHT_PARENTHESIS_CHAR ')'
|
||||
#define LEXER_TOKEN_RIGHT_PARENTHESIS_TAG "RIGHT_PARENTHESIS"
|
||||
#define LEXER_TOKEN_LEFT_CURLY_BRACE_ID 9
|
||||
#define LEXER_TOKEN_LEFT_CURLY_BRACE_CHAR '{'
|
||||
#define LEXER_TOKEN_LEFT_CURLY_BRACE_TAG "LEFT_CURLY_BRACE"
|
||||
#define LEXER_TOKEN_RIGHT_CURLY_BRACE_ID 10
|
||||
#define LEXER_TOKEN_RIGHT_CURLY_BRACE_CHAR '}'
|
||||
#define LEXER_TOKEN_RIGHT_CURLY_BRACE_TAG "RIGHT_CURLY_BRACE"
|
||||
#define LEXER_TOKEN_BANG_ID 11
|
||||
#define LEXER_TOKEN_BANG_CHAR '!'
|
||||
#define LEXER_TOKEN_BANG_TAG "BANG"
|
||||
#define LEXER_TOKEN_AT_ID 12
|
||||
#define LEXER_TOKEN_AT_CHAR '!'
|
||||
#define LEXER_TOKEN_AT_TAG "AT"
|
||||
#define LEXER_TOKEN_HASH_ID 13
|
||||
#define LEXER_TOKEN_HASH_CHAR '#'
|
||||
#define LEXER_TOKEN_HASH_TAG "HASH"
|
||||
#define LEXER_TOKEN_PERCENT_ID 14
|
||||
#define LEXER_TOKEN_PERCENT_CHAR '%'
|
||||
#define LEXER_TOKEN_PERCENT_TAG "PERCENT"
|
||||
|
||||
/**
|
||||
* @brief adds a bunch of basic token rules (matching the BasicTokens above)
|
||||
*/
|
||||
void ARC_Lexer_InitBasicTokenRules(ARC_Lexer *lexer);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
|
|
|||
|
|
@ -26,9 +26,9 @@ typedef ARC_Bool (* ARC_Vector_CompareDataFn)(void *dataA, void *dataB);
|
|||
/**
|
||||
* @brief a callback that cleans up memory when it is removed from the vector
|
||||
*
|
||||
* @param[in] data the item to delete
|
||||
* @param[in] data the item to destroy
|
||||
*/
|
||||
typedef void (* ARC_Vector_DeleteDataFn)(void *data);
|
||||
typedef void (* ARC_Vector_DestroyDataFn)(void *data);
|
||||
|
||||
/**
|
||||
* @brief creates an ARC_Vector which is an "expandable" array
|
||||
|
|
@ -39,9 +39,9 @@ typedef void (* ARC_Vector_DeleteDataFn)(void *data);
|
|||
* @param[out] vector ARC_Vector to initialize
|
||||
* @param[in] compareDataFn a callback that checks if data stored in the array matches,
|
||||
* if set to NULL and ARC_Vector_Remove is called, the pointer addresses will be compared
|
||||
* @param[in] deleteDataFn a callback that frees an item on remove or clear, can be set to NULL to do nothing
|
||||
* @param[in] destroyDataFn a callback that frees an item on remove or clear, can be set to NULL to do nothing
|
||||
*/
|
||||
void ARC_Vector_Create(ARC_Vector **vector, ARC_Vector_CompareDataFn *compareDataFn, ARC_Vector_DeleteDataFn *deleteDataFn);
|
||||
void ARC_Vector_Create(ARC_Vector **vector, ARC_Vector_CompareDataFn *compareDataFn, ARC_Vector_DestroyDataFn *destroyDataFn);
|
||||
|
||||
/**
|
||||
* @brief destroys an ARC_Vector
|
||||
|
|
@ -86,6 +86,15 @@ void ARC_Vector_Remove(ARC_Vector *vector, void *data);
|
|||
*/
|
||||
void ARC_Vector_RemoveIndex(ARC_Vector *vector, uint32_t index);
|
||||
|
||||
/**
|
||||
* @brief clears all items from a vector
|
||||
*
|
||||
* @note this function will call ARC_Vector_RemoveIndex, so it's notes are also applicable to this function
|
||||
*
|
||||
* @param[in] vector ARC_Vector to clear
|
||||
*/
|
||||
void ARC_Vector_Clear(ARC_Vector *vector);
|
||||
|
||||
/**
|
||||
* @brief gets the current size of an ARC_Vector as an unsigned 32 bit integer
|
||||
*
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue