summaryrefslogtreecommitdiff
path: root/src/sys/include/np/lex.h
blob: 9c6e69e7edbff8ae6bd8bba3e4f65fe34c37b15f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
 * Copyright (c) 2025 Ian Marco Moffett and L5 engineers
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the project nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _NP_LEX_H_
#define _NP_LEX_H_ 1

#include <sys/types.h>

struct np_work;

/* Keywords */
#define TOKEN_BEGIN "begin"
#define TOKEN_PROC "proc"
#define TOKEN_END "end"

/* Types */
#define TOKEN_U8 "u8"

/*
 * Represents the various token types that are
 * possible
 */
typedef enum {
    /* Symbols */
    TT_LPAREN,          /* '(' */
    TT_RPAREN,          /* ')' */
    TT_IDENT,           /* '<IDENTIFIER>' */
    TT_COMMA,           /* ',' */
    TT_STAR,            /* '*' */
    TT_MINUS,           /* '-' */
    TT_PLUS,            /* '+' */
    TT_SLASH,           /* '/' */
    TT_EQUALS,          /* '=' */
    TT_GT,              /* '>' */
    TT_LT,              /* '<' */
    TT_LBRACK,          /* '[' */
    TT_RBRACK,          /* ']' */
    TT_COLON,           /* ':' */

    /* Types */
    TT_U8,              /* 'u8' */

    /* Values */
    TT_NUMBER,          /* <numbers> */

    /* Keywords */
    TT_BEGIN,           /* 'begin' */
    TT_PROC,            /* 'proc' */
    TT_END,             /* 'end' */
} tt_t;

typedef uint64_t tokval_t;

/*
 * Represents a lexer token
 *
 * @token: Token type
 * @val: Integer value
 */
struct lex_token {
    tt_t token;
    union {
        tokval_t val;
        char *val_str;
    };
};

/*
 * Represents the lexer state machine
 *
 * @work: Current compiler work unit
 * @tok: Current token
 * @source_idx: Byte index into source stream
 */
struct lexer_state {
    struct np_work *work;
    struct lex_token tok;
    size_t source_idx;
};

/*
 * Initialize the lexer state machine into
 * a known state
 *
 * @state: Lexer state machine to initialize
 * @work: Work to initialize state machine with
 *
 * Returns zero on success, otherwise a less than
 * zero value on failure
 */
int lex_init(struct lexer_state *state, struct np_work *work);

/*
 * "Nom" a token from the source input and advance
 * to the next.
 *
 * @work: Current work
 * @res: Result is written here
 *
 * Returns zero on success, otherwise a less than
 * zero value on failure
 */
int lex_nom(struct np_work *work, struct lex_token *res);

#endif  /* !_NP_LEX_H_ */