a2kit 0.3.0

Apple II disk image and language utility
Documentation 
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

// test of dos33 disk image module
use std::path::Path;
use a2kit::dos33;
use a2kit::disk_base::TextEncoder;
use a2kit::disk_base::{ItemType,A2Disk};
use a2kit::applesoft;

pub const JSON_REC: &str = "
{
    \"a2kit_type\": \"rec\",
    \"record_length\": 127,
    \"records\": {
        \"2000\": [\"HELLO FROM TREE 2\"],
        \"4000\": [\"HELLO FROM TREE 2\"]
    }
}";

#[test]
fn format() {
    // DOS tracks can vary some depending on who did the formatting.
    // We are compatible with CiderPress.  The "last track" field in the VTOC
    // is left with value 18, *as if* a greeting program had been written there.
    let mut disk = dos33::Disk::new();
    disk.format(254,true,18);
    disk.compare(&Path::new("tests").join("dos33-boot.do"),&disk.standardize(0));
}

#[test]
fn read_small() {
    // Formatting: Copy2Plus, Writing: Virtual II
    // This tests a small BASIC program, binary, and text files
    let img = std::fs::read(&Path::new("tests").join("dos33-smallfiles.dsk")).expect("failed to read test image file");
    let emulator_disk = a2kit::create_disk_from_bytestream(&img);

    // check the BASIC program
    let basic_program = "
    10 D$ =  CHR$ (4)
    20  POKE 768,6: POKE 769,5: POKE 770,0: POKE 771,2
    30  PRINT D$;\"BSAVE THE CHIP,A768,L4\"
    40  PRINT D$;\"OPEN THETEXT\"
    50  PRINT D$;\"WRITE THETEXT\"
    60  PRINT \"HELLO FROM DOS 3.3\"
    70  PRINT D$;\"CLOSE THETEXT\"";
    let mut tokenizer = applesoft::tokenizer::Tokenizer::new();
    let lib_tokens = tokenizer.tokenize(basic_program,2049);
    let disk_tokens = emulator_disk.load("hello").expect("error");
    assert_eq!(disk_tokens,(0,lib_tokens));

    // check the binary
    let binary_data = emulator_disk.bload("the chip").expect("error");
    assert_eq!(binary_data,(768,vec![6,5,0,2]));

    // check the sequential text file
    let text = emulator_disk.read_text("thetext").expect("error");
    let encoder = dos33::types::Encoder::new(Some(0x8d));
    assert_eq!(text,(0,encoder.encode("HELLO FROM DOS 3.3").unwrap()));
}

#[test]
fn write_small() {
    // Formatting: Copy2Plus, Writing: Virtual II
    // This tests a small BASIC program, binary, and text file
    let mut disk = dos33::Disk::new();
    disk.format(254,false,17);

    // save the BASIC program
    let basic_program = "
    10 D$ =  CHR$ (4)
    20  POKE 768,6: POKE 769,5: POKE 770,0: POKE 771,2
    30  PRINT D$;\"BSAVE THE CHIP,A768,L4\"
    40  PRINT D$;\"OPEN THETEXT\"
    50  PRINT D$;\"WRITE THETEXT\"
    60  PRINT \"HELLO FROM DOS 3.3\"
    70  PRINT D$;\"CLOSE THETEXT\"";
    let mut tokenizer = applesoft::tokenizer::Tokenizer::new();
    let lib_tokens = tokenizer.tokenize(basic_program,2049);
    disk.save("hello",&lib_tokens,ItemType::ApplesoftTokens,None).expect("error");

    // save the binary
    disk.bsave("the chip",&[6,5,0,2].to_vec(),768,None).expect("error");

    // save the text
    let encoder = dos33::types::Encoder::new(Some(0x8d));
    disk.write_text("thetext",&encoder.encode("HELLO FROM DOS 3.3").unwrap()).expect("error");

    let mut ignore = disk.standardize(0);
    // loop to ignore boot tracks for this test
    for i in 0..3*16*256 {
        ignore.push(i);
    }
    disk.compare(&Path::new("tests").join("dos33-smallfiles.dsk"),&ignore);
}

#[test]
fn out_of_space() {
    let mut disk = dos33::Disk::new();
    let big: Vec<u8> = vec![0;0x7f00];
    disk.format(254,true,17);
    disk.bsave("f1",&big,0x800,None).expect("error");
    disk.bsave("f2",&big,0x800,None).expect("error");
    disk.bsave("f3",&big,0x800,None).expect("error");
    match disk.bsave("f4",&big,0x800,None) {
        Ok(l) => assert!(false,"wrote {} but should be disk full",l),
        Err(e) => match e.to_string().as_str() {
            "DISK FULL" => assert!(true),
            _ => assert!(false,"unexpected error")
        }
    }
}

#[test]
fn read_big() {
    // Formatting: Copy2Plus, Writing: MicroM8
    // This tests a small BASIC program, large binary, and two sparse text files
    let img = std::fs::read(&Path::new("tests").join("dos33-bigfiles.do")).expect("failed to read test image file");
    let emulator_disk = a2kit::create_disk_from_bytestream(&img);
    let mut buf: Vec<u8>;

    // check the BASIC program
    let basic_program = "
    10 D$ = CHR$(4)
    20 PRINT D$;\"OPEN TREE1,L128\"
    30 PRINT D$;\"WRITE TREE1,R2000\"
    40 PRINT \"HELLO FROM TREE 1\"
    50 PRINT D$;\"CLOSE TREE1\"
    60 PRINT D$;\"OPEN TREE2,L127\"
    70 PRINT D$;\"WRITE TREE2,R2000\"
    80 PRINT \"HELLO FROM TREE 2\"
    90 PRINT D$;\"WRITE TREE2,R4000\"
    100 PRINT \"HELLO FROM TREE 2\"
    110 PRINT D$;\"CLOSE TREE2\"
    120 FOR I = 16384 TO 32767: POKE I,256*((I-16384)/256 - INT((I-16384)/256)): NEXT
    130 PRINT D$;\"BSAVE SAPLING,A16384,L16384\"";
    let mut tokenizer = applesoft::tokenizer::Tokenizer::new();
    let mut lib_tokens = tokenizer.tokenize(basic_program,2049);
    let disk_tokens = emulator_disk.load("make.big").expect("error");
    lib_tokens.push(0x43); // Virtual II added an extra byte, why?
    assert_eq!(disk_tokens,(0,lib_tokens));

    // check the text records
    let recs = emulator_disk.read_records("tree1", 128).expect("failed to read tree1");
    assert_eq!(recs.map.get(&2000).unwrap(),"HELLO FROM TREE 1\n");
    let recs = emulator_disk.read_records("tree2", 127).expect("failed to read tree2");
    assert_eq!(recs.map.get(&2000).unwrap(),"HELLO FROM TREE 2\n");
    assert_eq!(recs.map.get(&4000).unwrap(),"HELLO FROM TREE 2\n");

    // check a large binary (sapling terminology is vestigial)
    buf = vec![0;16384];
    for i in 0..16384 {
        buf[i] = (i%256) as u8;
    }
    let binary_data = emulator_disk.bload("sapling").expect("dimg error");
    assert_eq!(binary_data,(16384,buf));

}

#[test]
fn write_big() {
    // Formatting: Copy2Plus, Writing: MicroM8
    // This tests a small BASIC program, large binary, and two sparse text files
    let mut buf: Vec<u8>;
    let mut disk = dos33::Disk::new();
    disk.format(254,false,17);

    // create and save the BASIC program
    let basic_program = "
    10 D$ = CHR$(4)
    20 PRINT D$;\"OPEN TREE1,L128\"
    30 PRINT D$;\"WRITE TREE1,R2000\"
    40 PRINT \"HELLO FROM TREE 1\"
    50 PRINT D$;\"CLOSE TREE1\"
    60 PRINT D$;\"OPEN TREE2,L127\"
    70 PRINT D$;\"WRITE TREE2,R2000\"
    80 PRINT \"HELLO FROM TREE 2\"
    90 PRINT D$;\"WRITE TREE2,R4000\"
    100 PRINT \"HELLO FROM TREE 2\"
    110 PRINT D$;\"CLOSE TREE2\"
    120 FOR I = 16384 TO 32767: POKE I,256*((I-16384)/256 - INT((I-16384)/256)): NEXT
    130 PRINT D$;\"BSAVE SAPLING,A16384,L16384\"";
    let mut tokenizer = applesoft::tokenizer::Tokenizer::new();
    let mut tokens = tokenizer.tokenize(basic_program,2049);
    tokens.push(0x43); // MicroM8 added this and counted it, n.b. also the trailing byte it did not count
    disk.save("make.big",&tokens,ItemType::ApplesoftTokens,Some(&vec![0x41])).expect("dimg error");

    // make tree files directly and from JSON
    let mut records = a2kit::disk_base::Records::new(128);
    records.add_record(2000, "HELLO FROM TREE 1");
    disk.write_records("tree1", &records).expect("dimg error");
    let records = a2kit::disk_base::Records::from_json(JSON_REC).expect("could not parse JSON");
    disk.write_records("tree2", &records).expect("dimg error");

    // write a large binary (sapling terminology is vestigial)
    buf = vec![0;16384];
    for i in 0..16384 {
        buf[i] = (i%256) as u8;
    }
    disk.bsave("sapling",&buf,16384,None).expect("dimg error");

    let mut ignore = disk.standardize(0);
    // loop to ignore boot tracks for this test
    for i in 0..3*16*256 {
        ignore.push(i);
    }
    disk.compare(&Path::new("tests").join("dos33-bigfiles.do"),&ignore);
}

#[test]
fn rename_delete() {
    // Formatting: CiderPress, Writing: Virtual II
    // Adds deletion and renaming to scenario in `write_big`.
    let mut buf: Vec<u8>;
    let mut disk = dos33::Disk::new();
    disk.format(254,true,18);

    // create and save the BASIC program
    let basic_program = "
    10 D$ = CHR$(4)
    20 PRINT D$;\"OPEN TREE1,L128\"
    30 PRINT D$;\"WRITE TREE1,R2000\"
    40 PRINT \"HELLO FROM TREE 1\"
    50 PRINT D$;\"CLOSE TREE1\"
    60 PRINT D$;\"OPEN TREE2,L127\"
    70 PRINT D$;\"WRITE TREE2,R2000\"
    80 PRINT \"HELLO FROM TREE 2\"
    90 PRINT D$;\"WRITE TREE2,R4000\"
    100 PRINT \"HELLO FROM TREE 2\"
    110 PRINT D$;\"CLOSE TREE2\"
    120 FOR I = 16384 TO 32767: POKE I,256*((I-16384)/256 - INT((I-16384)/256)): NEXT
    130 PRINT D$;\"BSAVE SAPLING,A16384,L16384\"
    200 print D$;\"DELETE TREE2\"
    210 print D$;\"RENAME SAPLING,SAP\"
    220 print D$;\"RENAME TREE1,MYTREE1\"";
    let mut tokenizer = applesoft::tokenizer::Tokenizer::new();
    let mut tokens = tokenizer.tokenize(basic_program,2049);
    tokens.push(0x0a); // Virtual II added an extra byte *and* counted it in the length
    disk.save("ren.del",&tokens,ItemType::ApplesoftTokens,None).expect("dimg error");

    // make tree files using random access text module
    let mut records = a2kit::disk_base::Records::new(128);
    records.add_record(2000, "HELLO FROM TREE 1");
    disk.write_records("tree1", &records).expect("dimg error");
    records = a2kit::disk_base::Records::new(127);
    records.add_record(2000, "HELLO FROM TREE 2");
    records.add_record(4000, "HELLO FROM TREE 2");
    disk.write_records("tree2", &records).expect("dimg error");

    // write a large binary (sapling terminology is vestigial)
    buf = vec![0;16384];
    for i in 0..16384 {
        buf[i] = (i%256) as u8;
    }
    disk.bsave("sapling",&buf,16384,Some(&vec![0xc9])).expect("dimg error");

    // delete and rename
    disk.delete("tree2").expect("dimg error");
    disk.rename("sapling","sap").expect("dimg error");
    disk.rename("tree1","mytree1").expect("dimg error");

    disk.compare(&Path::new("tests").join("dos33-ren-del.do"),&disk.standardize(0));
}

#[test]
fn read_big_woz1() {
    // Formatting: Copy2Plus, Writing: MicroM8
    // This tests the same file system information used for read_big and write_big.
    // We do not expect our WOZ track bits to be identical to those from an emulator.
    // So the strategy is to load the WOZ image as created by the emulator,
    // convert to DSK, and compare with a DSK that was also created via the emulator.
    // In testing the conversion we test a lot of underlying WOZ machinery.

    if let Some(woz1_path) = (Path::new("tests").join("dos33-bigfiles.woz")).to_str() {
        if let Some((_img,disk)) = a2kit::create_img_and_disk_from_file(woz1_path) {
            let mut ignore = disk.standardize(2);
            // loop to ignore boot tracks for this test
            for i in 0..3*16*256 {
                ignore.push(i);
            }
            disk.compare(&Path::new("tests").join("dos33-bigfiles.do"),&ignore);    
        }
    }
}