diff options
Diffstat (limited to 'parser.h')
| -rw-r--r-- | parser.h | 129 |
1 files changed, 115 insertions, 14 deletions
@@ -1,3 +1,23 @@ +/** + * @file parser.h + * Main library component; parses, manages and runs script + * + * Copyright (C) 2018 Clyne Sullivan + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * 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 <https://www.gnu.org/licenses/>. + */ + #ifndef PARSER_H_ #define PARSER_H_ @@ -5,36 +25,117 @@ #include <stdint.h> +/** + * Contains data for an 'instance' of script. + * Multiple instances can be created to run different scripts at once. + */ typedef struct { - variable *vars; - char **names; - uint32_t *stack; - uint32_t stidx; - variable ***lines; - uint32_t lnidx; - variable *ret; - uint8_t indent; - uint8_t sindent; + variable *vars; /**< An array of defined variables */ + char **names; /**< An array of names for the variables */ + uint32_t *stack; /**< The instance's stack */ + uint32_t stidx; /**< The instance's position in the stack */ + variable ***lines; /**< Compiled data for each line of script */ + uint32_t lnidx; /**< Position in script/line being run */ + variable *ret; /**< Pointer to the last returned variable */ + uint8_t indent; /**< Current indent/scope of the instance */ + uint8_t sindent; /**< Indent of scope to skip, for false conditionals */ } instance; +/** + * A flag to set in instance.sindent to determine if code should be skipped + * over. + */ #define SKIP (1 << 7) typedef int (*func_t)(instance *); +/** + * Creates a new parser instance, loading the built-in library into it. + * @return a new, malloc'd instance + */ instance *inewinstance(void); + +/** + * Destroys an instance, freeing all used memory including for the instance + * itself. + * @param it the instance to destroy + */ void idelinstance(instance *it); +/** + * Adds and runs the line through the parser instance. + * This parses and runs the line, while storing it at the current line index. + * @param it the current instance + * @param s the line to parse/run + */ int idoline(instance *it, const char *s); -variable **iparse(instance *it, const char *s); -variable *isolve(instance *it, variable **ops, uint32_t count); +/** + * Makes a C function visible to the script. + * @param it the current instance + * @param name the name of the function when called from the script + * @param func the C function + */ void inew_cfunc(instance *it, const char *name, func_t func); -variable *make_varf(variable *v, float f); -variable *make_vars(variable *v, const char *s); - +/** + * Pops a word from the instance's stack. + * @param it the current instance + * @return the popped value + */ uint32_t ipop(instance *it); + +/** + * Pushes a word to the instance's stack. + * @param it the current instance + * @param v the word to push + */ void ipush(instance *it, uint32_t v); + +/** + * Gets the nth argument passed to the current C function. + * This call has no protections. + * @param it the current instance + * @param n the index of the argument, zero-based + * @return the argument's variable + */ variable *igetarg(instance *it, uint32_t n); + + +/** + * Parses the given line, returning compiled data to run. + * For internal use only. + * @param it the current instance + * @param s the string to parse + * @return the 'compiled code' + */ +variable **iparse(instance *it, const char *s); + +/** + * 'Solves' (runs) the given compiled data, returning what the line returns. + * For internal use only. + * @param it the current instance + * @param ops the compiled data to run + * @param count the size of the ops array, zero if unknown + * @return the variable returned by the line, null if none + */ +variable *isolve(instance *it, variable **ops, uint32_t count); + +/** + * Makes a number out of the given variable. + * @param v the variable to use, if zero one is malloc'd + * @param f the number to assign the variable + * @return the new float variable + */ +variable *make_varf(variable *v, float f); + +/** + * Makes a string out of the given variable. + * @param v the variable to use, if zero one is malloc'd + * @param f the string to assign the variable + * @return the new string variable + */ +variable *make_vars(variable *v, const char *s); + #endif // PARSER_H_ |