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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
use std::collections::HashMap;
use crate::{
memory::{
define::{Define, Value},
label::AddressReference,
Address, ZeroPage,
},
validator::AssemblerResult,
Application, Module,
};
use super::finalize::finalize;
#[derive(Clone)]
pub struct ApplicationBuilder {
application: Application,
}
impl Default for ApplicationBuilder {
fn default() -> Self {
Self {
application: Application {
name: String::default(),
entry_point: 0x0800,
modules: vec![],
defines: vec![],
address_lookup: HashMap::default(),
},
}
}
}
impl ApplicationBuilder {
/// Set the name of the application.
///
/// Is used in comments when exporting to a dasm source using [crate::generator::DasmGenerator]
///
/// ```
/// use c64_assembler::builder::ApplicationBuilder;
/// let application = ApplicationBuilder::default()
/// .name("My application")
/// .build();
/// ```
pub fn name(&mut self, name: &str) -> &mut Self {
self.application.name = name.to_string();
self
}
/// Change the entry point of the application.
///
/// NOTE: When not set to 0x0800 [crate::builder::instruction::InstructionBuilder::add_basic_header]
/// cannot be used.
///
/// Default entry point is set to 0x0800.
///
/// ```
/// use c64_assembler::builder::ApplicationBuilder;
/// let application = ApplicationBuilder::default()
/// .entry_point(0x0800)
/// .build();
/// ```
pub fn entry_point(&mut self, entry_point: Address) -> &mut Self {
self.application.entry_point = entry_point;
self
}
/// Define a static address.
///
/// When using instructions each address needs to be accessed by its name. This function
/// allows to add a new named address. There is no difference between zeropaged and regular
/// addresses. When building the instruction stream the actual address will decide which
/// opcode is used.
///
/// ```
/// use c64_assembler::builder::ApplicationBuilder;
/// let application = ApplicationBuilder::default()
/// .define_address("VIC_BORDER_COLOR", 0xD020)
/// .define_address("ZEROPAGE_FE", 0xFE)
/// .build();
/// ```
pub fn define_address(&mut self, name: &str, address: Address) -> &mut Self {
self.application.address_lookup.insert(name.to_string(), address);
if address.is_zeropage() {
self.application
.defines
.push(Define::new(name, Value::Zeropage(address)));
} else {
self.application
.defines
.push(Define::new(name, Value::Address(address)));
}
self
}
/// Add the address defines useful when using the VIC2.
///
/// | Address Name | Physical Address | Description |
/// |---------------------------------|-----------------|--------------------------------------------------|
/// | VIC2_BASE | 0xD000 | Base address for VIC registers |
/// | VIC2_SPRITE_0_X | 0xD000 | X coordinate of sprite 0 |
/// | VIC2_SPRITE_0_Y | 0xD001 | Y coordinate of sprite 0 |
/// | VIC2_SPRITE_1_X | 0xD002 | X coordinate of sprite 1 |
/// | VIC2_SPRITE_1_Y | 0xD003 | Y coordinate of sprite 1 |
/// | VIC2_SPRITE_2_X | 0xD004 | X coordinate of sprite 2 |
/// | VIC2_SPRITE_2_Y | 0xD005 | Y coordinate of sprite 2 |
/// | VIC2_SPRITE_3_X | 0xD006 | X coordinate of sprite 3 |
/// | VIC2_SPRITE_3_Y | 0xD007 | Y coordinate of sprite 3 |
/// | VIC2_SPRITE_4_X | 0xD008 | X coordinate of sprite 4 |
/// | VIC2_SPRITE_4_Y | 0xD009 | Y coordinate of sprite 4 |
/// | VIC2_SPRITE_5_X | 0xD00A | X coordinate of sprite 5 |
/// | VIC2_SPRITE_5_Y | 0xD00B | Y coordinate of sprite 5 |
/// | VIC2_SPRITE_6_X | 0xD00C | X coordinate of sprite 6 |
/// | VIC2_SPRITE_6_Y | 0xD00D | Y coordinate of sprite 6 |
/// | VIC2_SPRITE_7_X | 0xD00E | X coordinate of sprite 7 |
/// | VIC2_SPRITE_7_Y | 0xD00F | Y coordinate of sprite 7 |
/// | VIC2_SPRITE_X_MSB | 0xD010 | Most significant bit for sprite X coordinates |
/// | VIC2_CONTROL_1 | 0xD011 | Screen control register 1 |
/// | VIC2_RASTER | 0xD012 | Raster line position |
/// | VIC2_LIGHT_PEN_X | 0xD013 | Light pen X position |
/// | VIC2_LIGHT_PEN_Y | 0xD014 | Light pen Y position |
/// | VIC2_SPRITE_ENABLE | 0xD015 | Enables sprites |
/// | VIC2_CONTROL_2 | 0xD016 | Screen control register 2 |
/// | VIC2_SPRITE_EXPAND_X | 0xD017 | Expands sprites horizontally |
/// | VIC2_MEMORY_SETUP | 0xD018 | VIC memory setup |
/// | VIC2_IRQ_STATUS | 0xD019 | Interrupt request status |
/// | VIC2_IRQ_ENABLE | 0xD01A | Interrupt request enable |
/// | VIC2_SPRITE_PRIORITY | 0xD01B | Sprite priority over background |
/// | VIC2_SPRITE_MULTICOLOR | 0xD01C | Enables multicolor mode for sprites |
/// | VIC2_SPRITE_EXPAND_Y | 0xD01D | Expands sprites vertically |
/// | VIC2_SPRITE_COLLISION | 0xD01E | Sprite-to-sprite collision detection |
/// | VIC2_SPRITE_BG_COLLISION | 0xD01F | Sprite-to-background collision detection |
/// | VIC2_BORDER_COLOR | 0xD020 | Border color |
/// | VIC2_BACKGROUND_COLOR | 0xD021 | Background color |
/// | VIC2_BACKGROUND_COLOR_0 | 0xD021 | Background color 0 |
/// | VIC2_BACKGROUND_COLOR_1 | 0xD022 | Background color 1 |
/// | VIC2_BACKGROUND_COLOR_2 | 0xD023 | Background color 2 |
/// | VIC2_BACKGROUND_COLOR_3 | 0xD024 | Background color 3 |
/// | VIC2_SPRITE_MULTICOLOR_0 | 0xD025 | Multicolor mode color 0 for sprites |
/// | VIC2_SPRITE_MULTICOLOR_1 | 0xD026 | Multicolor mode color 1 for sprites |
/// | VIC2_SPRITE_0_COLOR | 0xD027 | Color of sprite 0 |
/// | VIC2_SPRITE_1_COLOR | 0xD028 | Color of sprite 1 |
/// | VIC2_SPRITE_2_COLOR | 0xD029 | Color of sprite 2 |
/// | VIC2_SPRITE_3_COLOR | 0xD02A | Color of sprite 3 |
/// | VIC2_SPRITE_4_COLOR | 0xD02B | Color of sprite 4 |
/// | VIC2_SPRITE_5_COLOR | 0xD02C | Color of sprite 5 |
/// | VIC2_SPRITE_6_COLOR | 0xD02D | Color of sprite 6 |
/// | VIC2_SPRITE_7_COLOR | 0xD02E | Color of sprite 7 |
///
/// ```
/// use c64_assembler::builder::ApplicationBuilder;
/// let application = ApplicationBuilder::default()
/// .include_vic2_defines()
/// .build();
/// ```
pub fn include_vic2_defines(&mut self) -> &mut Self {
self.define_address("VIC2_BASE", 0xD000)
.define_address("VIC2_SPRITE_0_X", 0xD000)
.define_address("VIC2_SPRITE_0_Y", 0xD001)
.define_address("VIC2_SPRITE_1_X", 0xD002)
.define_address("VIC2_SPRITE_1_Y", 0xD003)
.define_address("VIC2_SPRITE_2_X", 0xD004)
.define_address("VIC2_SPRITE_2_Y", 0xD005)
.define_address("VIC2_SPRITE_3_X", 0xD006)
.define_address("VIC2_SPRITE_3_Y", 0xD007)
.define_address("VIC2_SPRITE_4_X", 0xD008)
.define_address("VIC2_SPRITE_4_Y", 0xD009)
.define_address("VIC2_SPRITE_5_X", 0xD00A)
.define_address("VIC2_SPRITE_5_Y", 0xD00B)
.define_address("VIC2_SPRITE_6_X", 0xD00C)
.define_address("VIC2_SPRITE_6_Y", 0xD00D)
.define_address("VIC2_SPRITE_7_X", 0xD00E)
.define_address("VIC2_SPRITE_7_Y", 0xD00F)
.define_address("VIC2_SPRITE_X_MSB", 0xD010)
.define_address("VIC2_CONTROL_1", 0xD011)
.define_address("VIC2_RASTER", 0xD012)
.define_address("VIC2_LIGHT_PEN_X", 0xD013)
.define_address("VIC2_LIGHT_PEN_Y", 0xD014)
.define_address("VIC2_SPRITE_ENABLE", 0xD015)
.define_address("VIC2_CONTROL_2", 0xD016)
.define_address("VIC2_SPRITE_EXPAND_X", 0xD017)
.define_address("VIC2_MEMORY_SETUP", 0xD018)
.define_address("VIC2_IRQ_STATUS", 0xD019)
.define_address("VIC2_IRQ_ENABLE", 0xD01A)
.define_address("VIC2_SPRITE_PRIORITY", 0xD01B)
.define_address("VIC2_SPRITE_MULTICOLOR", 0xD01C)
.define_address("VIC2_SPRITE_EXPAND_Y", 0xD01D)
.define_address("VIC2_SPRITE_COLLISION", 0xD01E)
.define_address("VIC2_SPRITE_BG_COLLISION", 0xD01F)
.define_address("VIC2_BORDER_COLOR", 0xD020)
.define_address("VIC2_BACKGROUND_COLOR", 0xD021)
.define_address("VIC2_BACKGROUND_COLOR_0", 0xD021)
.define_address("VIC2_BACKGROUND_COLOR_1", 0xD022)
.define_address("VIC2_BACKGROUND_COLOR_2", 0xD023)
.define_address("VIC2_BACKGROUND_COLOR_3", 0xD024)
.define_address("VIC2_SPRITE_MULTICOLOR_0", 0xD025)
.define_address("VIC2_SPRITE_MULTICOLOR_1", 0xD026)
.define_address("VIC2_SPRITE_0_COLOR", 0xD027)
.define_address("VIC2_SPRITE_1_COLOR", 0xD028)
.define_address("VIC2_SPRITE_2_COLOR", 0xD029)
.define_address("VIC2_SPRITE_3_COLOR", 0xD02A)
.define_address("VIC2_SPRITE_4_COLOR", 0xD02B)
.define_address("VIC2_SPRITE_5_COLOR", 0xD02C)
.define_address("VIC2_SPRITE_6_COLOR", 0xD02D)
.define_address("VIC2_SPRITE_7_COLOR", 0xD02E)
}
/// Add the address defines useful when using the SID.
///
/// | Address Name | Physical Address | Description |
/// |-------------------------------|-----------------|-------------------------------------------------|
/// | SID_BASE | 0xD400 | Base address for SID registers |
/// | SID_VOICE_1_FREQ_LO | 0xD400 | Voice 1 frequency (low byte) |
/// | SID_VOICE_1_FREQ_HI | 0xD401 | Voice 1 frequency (high byte) |
/// | SID_VOICE_1_PW_LO | 0xD402 | Voice 1 pulse width (low byte) |
/// | SID_VOICE_1_PW_HI | 0xD403 | Voice 1 pulse width (high byte) |
/// | SID_VOICE_1_CTRL | 0xD404 | Voice 1 control register |
/// | SID_VOICE_1_AD | 0xD405 | Voice 1 attack/decay settings |
/// | SID_VOICE_1_SR | 0xD406 | Voice 1 sustain/release settings |
/// | SID_VOICE_2_FREQ_LO | 0xD407 | Voice 2 frequency (low byte) |
/// | SID_VOICE_2_FREQ_HI | 0xD408 | Voice 2 frequency (high byte) |
/// | SID_VOICE_2_PW_LO | 0xD409 | Voice 2 pulse width (low byte) |
/// | SID_VOICE_2_PW_HI | 0xD40A | Voice 2 pulse width (high byte) |
/// | SID_VOICE_2_CTRL | 0xD40B | Voice 2 control register |
/// | SID_VOICE_2_AD | 0xD40C | Voice 2 attack/decay settings |
/// | SID_VOICE_2_SR | 0xD40D | Voice 2 sustain/release settings |
/// | SID_VOICE_3_FREQ_LO | 0xD40E | Voice 3 frequency (low byte) |
/// | SID_VOICE_3_FREQ_HI | 0xD40F | Voice 3 frequency (high byte) |
/// | SID_VOICE_3_PW_LO | 0xD410 | Voice 3 pulse width (low byte) |
/// | SID_VOICE_3_PW_HI | 0xD411 | Voice 3 pulse width (high byte) |
/// | SID_VOICE_3_CTRL | 0xD412 | Voice 3 control register |
/// | SID_VOICE_3_AD | 0xD413 | Voice 3 attack/decay settings |
/// | SID_VOICE_3_SR | 0xD414 | Voice 3 sustain/release settings |
/// | SID_FILTER_CUTOFF_LO | 0xD415 | Filter cutoff frequency (low byte) |
/// | SID_FILTER_CUTOFF_HI | 0xD416 | Filter cutoff frequency (high byte) |
/// | SID_FILTER_CTRL | 0xD417 | Filter control register |
/// | SID_VOLUME_FC | 0xD418 | Volume and filter control |
/// | SID_POT_X | 0xD419 | Paddle X position (read) |
/// | SID_POT_Y | 0xD41A | Paddle Y position (read) |
/// | SID_OSC3_RANDOM | 0xD41B | Oscillator 3 output/random number generator |
/// | SID_ENV3 | 0xD41C | Envelope generator for voice 3 (read) |
///
/// ```
/// use c64_assembler::builder::ApplicationBuilder;
/// let application = ApplicationBuilder::default()
/// .include_sid_defines()
/// .build();
/// ```
pub fn include_sid_defines(&mut self) -> &mut Self {
self.define_address("SID_BASE", 0xD400)
.define_address("SID_VOICE_1_FREQ_LO", 0xD400)
.define_address("SID_VOICE_1_FREQ_HI", 0xD401)
.define_address("SID_VOICE_1_PW_LO", 0xD402)
.define_address("SID_VOICE_1_PW_HI", 0xD403)
.define_address("SID_VOICE_1_CTRL", 0xD404)
.define_address("SID_VOICE_1_AD", 0xD405)
.define_address("SID_VOICE_1_SR", 0xD406)
.define_address("SID_VOICE_2_FREQ_LO", 0xD407)
.define_address("SID_VOICE_2_FREQ_HI", 0xD408)
.define_address("SID_VOICE_2_PW_LO", 0xD409)
.define_address("SID_VOICE_2_PW_HI", 0xD40A)
.define_address("SID_VOICE_2_CTRL", 0xD40B)
.define_address("SID_VOICE_2_AD", 0xD40C)
.define_address("SID_VOICE_2_SR", 0xD40D)
.define_address("SID_VOICE_3_FREQ_LO", 0xD40E)
.define_address("SID_VOICE_3_FREQ_HI", 0xD40F)
.define_address("SID_VOICE_3_PW_LO", 0xD410)
.define_address("SID_VOICE_3_PW_HI", 0xD411)
.define_address("SID_VOICE_3_CTRL", 0xD412)
.define_address("SID_VOICE_3_AD", 0xD413)
.define_address("SID_VOICE_3_SR", 0xD414)
.define_address("SID_FILTER_CUTOFF_LO", 0xD415)
.define_address("SID_FILTER_CUTOFF_HI", 0xD416)
.define_address("SID_FILTER_CTRL", 0xD417)
.define_address("SID_VOLUME_FC", 0xD418)
.define_address("SID_POT_X", 0xD419)
.define_address("SID_POT_Y", 0xD41A)
.define_address("SID_OSC3_RANDOM", 0xD41B)
.define_address("SID_ENV3", 0xD41C)
}
pub fn module(&mut self, module: Module) -> &mut Self {
self.application.modules.push(module);
self
}
/// Build the application
pub fn build(&mut self) -> AssemblerResult<Application> {
finalize(&mut self.application)?;
Ok(self.application.clone())
}
}
impl Application {
pub(crate) fn define_mut(&mut self, define_name: &String) -> &mut Define {
self.defines
.iter_mut()
.find(|define| &define.name == define_name)
.unwrap()
}
pub fn address(&self, address_reference: &AddressReference) -> Address {
self.address_lookup.get(&address_reference.name).unwrap() + address_reference.offset
}
}