annotate lwasm/lwasm.h @ 344:0215a0fbf61b

Added assembly error system and additional checks for symbol syntax
author lost@starbug
date Thu, 25 Mar 2010 22:06:50 -0600
parents 7b4123dce741
children 7416c3f9c321
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
323
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
1 /*
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
2 lwasm.h
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
3
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
4 Copyright © 2010 William Astle
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
5
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
6 This file is part of LWTOOLS.
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
7
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
8 LWTOOLS is free software: you can redistribute it and/or modify it under the
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
9 terms of the GNU General Public License as published by the Free Software
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
10 Foundation, either version 3 of the License, or (at your option) any later
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
11 version.
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
12
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
13 This program is distributed in the hope that it will be useful, but WITHOUT
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
16 more details.
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
17
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
18 You should have received a copy of the GNU General Public License along with
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
19 this program. If not, see <http://www.gnu.org/licenses/>.
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
20 */
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
21
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
22 #ifndef ___lwasm_h_seen___
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
23 #define ___lwasm_h_seen___
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
24
337
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
25 #include <lw_expr.h>
324
be63116281b0 Created lwlib folder and added first bits to it
lost
parents: 323
diff changeset
26 #include <lw_stringlist.h>
329
c15cca3ae6a2 Created first pass of input layer
lost
parents: 325
diff changeset
27 #include <lw_stack.h>
324
be63116281b0 Created lwlib folder and added first bits to it
lost
parents: 323
diff changeset
28
337
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
29 enum
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
30 {
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
31 lwasm_expr_linelen = 1
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
32 };
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
33
323
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
34 enum lwasm_output_e
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
35 {
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
36 OUTPUT_DECB = 0, // DECB multirecord format
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
37 OUTPUT_RAW, // raw sequence of bytes
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
38 OUTPUT_OBJ, // proprietary object file format
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
39 OUTPUT_RAWREL, // raw bytes where ORG causes a SEEK in the file
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
40 OUTPUT_OS9 // os9 module target
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
41 };
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
42
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
43 enum lwasm_target_e
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
44 {
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
45 TARGET_6309 = 0, // target 6309 CPU
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
46 TARGET_6809 // target 6809 CPU (no 6309 ops)
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
47 };
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
48
325
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
49 enum lwasm_flags_e
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
50 {
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
51 FLAG_NONE = 0,
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
52 FLAG_LIST = 0x0001,
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
53 FLAG_DEPEND = 0x0002
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
54 };
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
55
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
56 enum lwasm_pragmas_e
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
57 {
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
58 PRAGMA_NONE = 0, // no pragmas in effect
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
59 PRAGMA_DOLLARNOTLOCAL = 0x0001, // dollar sign does not make a symbol local
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
60 PRAGMA_NOINDEX0TONONE = 0x0002, // do not change implicit 0,R to ,R
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
61 PRAGMA_UNDEFEXTERN = 0x0004, // undefined symbols are considered to be external
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
62 PRAGMA_CESCAPES = 0x0008, // allow C style escapes in fcc, fcs, fcn, etc.
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
63 PRAGMA_IMPORTUNDEFEXPORT = 0x0010 // imports symbol if undefined upon export
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
64 };
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
65
344
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
66 typedef struct lwasm_error_s lwasm_error_t;
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
67 struct lwasm_error_s
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
68 {
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
69 char *mess; // actual error message
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
70 lwasm_error_t *next; // ptr to next error
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
71 };
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
72
337
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
73 typedef struct line_s line_t;
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
74 struct line_s
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
75 {
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
76 lw_expr_t addr; // assembly address of the line
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
77 int len; // the "size" this line occupies (address space wise) (-1 if unknown)
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
78 int insn; // number of insn in insn table
342
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
79 int symset; // set if the line symbol was consumed by the instruction
340
1a6fc6ebb31c Checkpoint
lost
parents: 337
diff changeset
80 char *sym; // symbol, if any, on the line
344
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
81 lwasm_error_t *err; // list of errors
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
82 line_t *prev; // previous line
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
83 line_t *next; // next line
337
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
84 };
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
85
342
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
86 enum
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
87 {
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
88 symbol_flag_set = 1, // symbol was used with "set"
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
89 symbol_flag_none = 0 // no flags
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
90 };
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
91
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
92 struct symtabe
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
93 {
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
94 char *symbol; // the name of the symbol
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
95 int context; // symbol context (-1 for global)
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
96 int version; // version of the symbol (for "set")
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
97 int flags; // flags for the symbol
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
98 lw_expr_t value; // symbol value
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
99 struct symtabe *next; // next symbol in the table
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
100 };
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
101
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
102 typedef struct
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
103 {
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
104 struct symtabe *head; // start of symbol table
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
105 } symtab_t;
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
106
323
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
107 typedef struct
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
108 {
324
be63116281b0 Created lwlib folder and added first bits to it
lost
parents: 323
diff changeset
109 int output_format; // output format
be63116281b0 Created lwlib folder and added first bits to it
lost
parents: 323
diff changeset
110 int target; // assembly target
be63116281b0 Created lwlib folder and added first bits to it
lost
parents: 323
diff changeset
111 int debug_level; // level of debugging requested
325
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
112 int flags; // assembly flags
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
113 int pragmas; // pragmas currently in effect
344
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
114 int errorcount; // number of errors encountered
325
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
115
337
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
116 line_t *line_head; // start of lines list
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
117 line_t *line_tail; // tail of lines list
342
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
118
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
119 int context; // the current "context"
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
120
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
121 symtab_t symtab; // meta data for the symbol table
337
04c80c51b16a Checkpoint development
lost
parents: 330
diff changeset
122
325
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
123 char *list_file; // name of file to list to
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
124 char *output_file; // output file name
324
be63116281b0 Created lwlib folder and added first bits to it
lost
parents: 323
diff changeset
125 lw_stringlist_t input_files; // files to assemble
330
81c005b82775 More tinkering with input subsystem
lost
parents: 329
diff changeset
126 void *input_data; // opaque data used by the input system
325
619fd6ad4ab9 Completed command line parsing
lost
parents: 324
diff changeset
127 lw_stringlist_t include_list; // include paths
329
c15cca3ae6a2 Created first pass of input layer
lost
parents: 325
diff changeset
128 lw_stack_t file_dir; // stack of the "current file" dir
323
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
129 } asmstate_t;
473ed9b353eb Started framework for lwasm binary
lost
parents:
diff changeset
130
342
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
131 #ifndef ___symbol_c_seen___
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
132
344
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
133 extern struct symtabe *register_symbol(asmstate_t *as, line_t *cl, char *sym, lw_expr_t value, int flags);
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
134 extern struct symtabe *lookup_symbol(asmstate_t *as, line_t *cl, char *sym, int context, int version);
342
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
135
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
136 #endif
7b4123dce741 Added basic symbol registration
lost@starbug
parents: 340
diff changeset
137
344
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
138 #ifndef ___lwasm_c_seen___
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
139
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
140 extern void lwasm_register_error(asmstate_t *as, line_t *cl, const char *msg, ...);
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
141
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
142 #endif
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
143
0215a0fbf61b Added assembly error system and additional checks for symbol syntax
lost@starbug
parents: 342
diff changeset
144
324
be63116281b0 Created lwlib folder and added first bits to it
lost
parents: 323
diff changeset
145 #endif /* ___lwasm_h_seen___ */