efl/src/lib/eolian/eo_lexer.h

301 lines
9.3 KiB
C

#ifndef __EO_LEXER_H__
#define __EO_LEXER_H__
#include <setjmp.h>
#include <Eina.h>
#include <Eolian.h>
#include "eolian_database.h"
/* a token is an int, custom tokens start at this - single-char tokens are
* simply represented by their ascii */
#define START_CUSTOM 257
enum Tokens
{
TOK_EQ = START_CUSTOM, TOK_NQ, TOK_GE, TOK_LE,
TOK_AND, TOK_OR, TOK_LSH, TOK_RSH,
TOK_DOC, TOK_STRING, TOK_CHAR, TOK_NUMBER, TOK_VALUE
};
/* all keywords in eolian, they can still be used as names (they're TOK_VALUE)
* they just fill in the "kw" field of the token
*
* reserved for the future: @nullable
*/
#define KEYWORDS KW(class), KW(const), KW(enum), KW(return), KW(struct), \
\
KW(abstract), KW(c_prefix), KW(composite), KW(constructor), KW(constructors), \
KW(data), KW(destructor), KW(event_prefix), KW(events), KW(extends), \
KW(free), KW(get), KW(implements), KW(import), KW(interface), \
KW(keys), KW(legacy), KW(methods), KW(mixin), KW(params), \
KW(parse), KW(parts), KW(ptr), KW(set), KW(type), KW(values), KW(var), KW(requires), \
\
KWAT(auto), KWAT(beta), KWAT(c_name), KWAT(class), KWAT(const), KWAT(cref), \
KWAT(empty), KWAT(extern), KWAT(free), KWAT(hot), KWAT(in), KWAT(inout), \
KWAT(no_unused), KWAT(nullable), KWAT(optional), KWAT(out), KWAT(owned), \
KWAT(private), KWAT(property), KWAT(protected), KWAT(restart), \
KWAT(pure_virtual), \
\
KW(byte), KW(ubyte), KW(char), KW(short), KW(ushort), KW(int), KW(uint), \
KW(long), KW(ulong), KW(llong), KW(ullong), \
\
KW(int8), KW(uint8), KW(int16), KW(uint16), KW(int32), KW(uint32), \
KW(int64), KW(uint64), KW(int128), KW(uint128), \
\
KW(size), KW(ssize), KW(intptr), KW(uintptr), KW(ptrdiff), \
\
KW(time), \
\
KW(float), KW(double), \
\
KW(bool), \
\
KW(slice), KW(rw_slice), \
\
KW(void), \
\
KW(accessor), KW(array), KW(future), KW(iterator), KW(hash), KW(list), \
KW(any_value), KW(any_value_ptr), \
KW(mstring), KW(string), KW(stringshare), KW(strbuf), \
\
KW(void_ptr), \
KW(__builtin_free_cb), \
KW(function), \
KW(__undefined_type), \
\
KW(true), KW(false), KW(null), KWAT(ctor_param)
/* "regular" keyword and @ prefixed keyword */
#define KW(x) KW_##x
#define KWAT(x) KW_at_##x
enum Keywords
{
KW_UNKNOWN = 0,
KEYWORDS
};
#undef KW
#undef KWAT
enum Numbers
{
NUM_INT,
NUM_UINT,
NUM_LONG,
NUM_ULONG,
NUM_LLONG,
NUM_ULLONG,
NUM_FLOAT,
NUM_DOUBLE
};
typedef union
{
char c;
const char *s;
signed int i;
unsigned int u;
signed long l;
unsigned long ul;
signed long long ll;
unsigned long long ull;
float f;
double d;
Eolian_Documentation *doc;
} Eo_Token_Union;
/* a token - "token" is the actual token id, "value" is the value of a token
* if needed - NULL otherwise - for example the value of a TOK_VALUE, "kw"
* is the keyword id if this is a keyword, it's 0 when not a keyword */
typedef struct _Eo_Token
{
int token, kw;
Eo_Token_Union value;
} Eo_Token;
typedef struct _Lexer_Ctx
{
int line, column;
const char *linestr;
Eo_Token token;
} Lexer_Ctx;
typedef struct _Eo_Lexer_Dtor
{
Eina_Free_Cb free_cb;
void *data;
} Eo_Lexer_Dtor;
/* keeps all lexer state */
typedef struct _Eo_Lexer
{
/* current character being tested */
int current;
/* column is token aware column number, for example when lexing a keyword
* it points to the beginning of it after the lexing is done, icolumn is
* token unaware, always pointing to current column */
int column, icolumn;
/* the current line number, token aware and unaware */
int line_number, iline_number;
/* t: "normal" - token to lex into, "lookahead" - a lookahead token, used
* to look one token past "t", when we need to check for a token after the
* current one and use it in a conditional without consuming the current
* token - used in pretty few cases - because we have one extra lookahead
* token, that makes our grammar LL(2) - two tokens in total */
Eo_Token t, lookahead;
/* a string buffer used to keep contents of token currently being read,
* if needed at all */
Eina_Strbuf *buff;
/* a handle pointing to a memory mapped file representing the file we're
* currently lexing */
Eina_File *handle;
/* the source file name */
const char *source;
/* only basename */
const char *filename;
/* points to the current character in our mmapped file being lexed, just
* incremented until the end */
const char *stream;
/* end pointer - required to check if we've reached past the file, as
* mmapped data will give us no EOF */
const char *stream_end;
/* points to the current line being lexed, used by error messages to
* display the current line with a caret at the respective column */
const char *stream_line;
/* a pointer to the state this lexer belongs to */
Eolian_State *state;
/* the unit being filled during current parsing */
Eolian_Unit *unit;
/* this is jumped to when an error happens */
jmp_buf err_jmp;
/* saved context info */
Eina_List *saved_ctxs;
Eolian_Class *klass;
/* a dtor list; dtors can be pushed and popped during
* parser execution to simulate scoped resource management
*
* unpopped dtors (e.g. on error) are run when the state is freed
*/
Eina_List *dtors;
/* a node hash; eolian objects can be allocated through this and
* they are stored here (with 1 reference) until they're released
* into the environment (they also get deref'd)
*
* if the release never happens, everything is just freed when the state is
*/
Eina_Hash *nodes;
/* whether we allow lexing expression related tokens */
Eina_Bool expr_mode;
/* decimal point, by default '.' */
char decpoint;
} Eo_Lexer;
typedef enum _Eo_Lexer_Error
{
EO_LEXER_ERROR_UNKNOWN = 0,
EO_LEXER_ERROR_NORMAL,
EO_LEXER_ERROR_OOM
} Eo_Lexer_Error;
void eo_lexer_init (void);
void eo_lexer_shutdown (void);
Eo_Lexer *eo_lexer_new (Eolian_State *state, const char *source);
void eo_lexer_free (Eo_Lexer *ls);
/* gets a regular token, singlechar or one of TOK_something */
int eo_lexer_get (Eo_Lexer *ls);
/* lookahead token - see Eo_Lexer */
int eo_lexer_lookahead (Eo_Lexer *ls);
/* "throws" an error, with a custom message and custom token */
void eo_lexer_lex_error (Eo_Lexer *ls, const char *msg, int token);
/* like above, but uses the lexstate->t.token, a.k.a. current token */
void eo_lexer_syntax_error (Eo_Lexer *ls, const char *msg);
/* turns the token into a string, writes into the given buffer */
void eo_lexer_token_to_str (int token, char *buf);
/* returns the string representation of a keyword */
const char *eo_lexer_keyword_str_get(int kw);
/* checks if the given keyword is a builtin type */
Eina_Bool eo_lexer_is_type_keyword(int kw);
/* gets a keyword id from the keyword string */
int eo_lexer_keyword_str_to_id(const char *kw);
/* gets the C type name for a builtin type name - e.g. uchar -> unsigned char */
const char *eo_lexer_get_c_type (int kw);
/* save, restore and clear context (line, column, line string) */
void eo_lexer_context_push (Eo_Lexer *ls);
void eo_lexer_context_pop (Eo_Lexer *ls);
void eo_lexer_context_restore(Eo_Lexer *ls);
void eo_lexer_context_clear (Eo_Lexer *ls);
/* node ("heap") management */
Eolian_Object *eo_lexer_node_new(Eo_Lexer *ls, size_t objsize);
Eolian_Object *eo_lexer_node_release(Eo_Lexer *ls, Eolian_Object *obj);
static inline Eolian_Type *
eo_lexer_type_new(Eo_Lexer *ls)
{
return (Eolian_Type *)eo_lexer_node_new(ls, sizeof(Eolian_Type));
}
static inline Eolian_Type *
eo_lexer_type_release(Eo_Lexer *ls, Eolian_Type *tp)
{
return (Eolian_Type *)eo_lexer_node_release(ls, (Eolian_Object *)tp);
}
static inline Eolian_Typedecl *
eo_lexer_typedecl_new(Eo_Lexer *ls)
{
return (Eolian_Typedecl *)eo_lexer_node_new(ls, sizeof(Eolian_Typedecl));
}
static inline Eolian_Typedecl *
eo_lexer_typedecl_release(Eo_Lexer *ls, Eolian_Typedecl *tp)
{
return (Eolian_Typedecl *)eo_lexer_node_release(ls, (Eolian_Object *)tp);
}
static inline Eolian_Variable *
eo_lexer_variable_new(Eo_Lexer *ls)
{
return (Eolian_Variable *)eo_lexer_node_new(ls, sizeof(Eolian_Variable));
}
static inline Eolian_Variable *
eo_lexer_variable_release(Eo_Lexer *ls, Eolian_Variable *var)
{
return (Eolian_Variable *)eo_lexer_node_release(ls, (Eolian_Object *)var);
}
static inline Eolian_Expression *
eo_lexer_expr_new(Eo_Lexer *ls)
{
return (Eolian_Expression *)eo_lexer_node_new(ls, sizeof(Eolian_Expression));
}
static inline Eolian_Expression *
eo_lexer_expr_release(Eo_Lexer *ls, Eolian_Expression *expr)
{
return (Eolian_Expression *)eo_lexer_node_release(ls, (Eolian_Object *)expr);
}
static inline Eolian_Expression *
eo_lexer_expr_release_ref(Eo_Lexer *ls, Eolian_Expression *expr)
{
eolian_object_ref(&expr->base);
return eo_lexer_expr_release(ls, expr);
}
/* "stack" management, only to protect against errors (jumps) in parsing */
void eo_lexer_dtor_push(Eo_Lexer *ls, Eina_Free_Cb free_cb, void *data);
void eo_lexer_dtor_pop(Eo_Lexer *ls);
#endif /* __EO_LEXER_H__ */