a2kit 4.4.2

Retro 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

// test of prodos disk image module
use std::path::Path;
use std::fmt::Write;
use std::collections::HashMap;
use a2kit::fs::{prodos,DiskFS};
use a2kit::bios::Block;
use a2kit::fs::prodos::types::BLOCK_SIZE;
use a2kit::lang::applesoft;
use a2kit::commands::ItemType;

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

fn ignore_boot_blocks(ignore: &mut HashMap<Block,Vec<usize>>) {
    for block in 0..2 {
        let mut all: Vec<usize> = Vec::new();
        for i in 0..BLOCK_SIZE {
            all.push(i);
        }
        ignore.insert(Block::PO(block),all);
    }
}

fn get_tokens(filename: &str) -> Vec<u8> {
    let basic_program = std::fs::read_to_string(&Path::new("tests").
        join("disk_builders").
        join(filename)).expect("failed to read source code");
    let mut tokenizer = applesoft::tokenizer::Tokenizer::new();
    tokenizer.tokenize(&basic_program,2049).expect("tokenizer failed")
}

#[test]
fn format() {
    let img = a2kit::img::dsk_po::PO::create(280);
    let mut disk = prodos::Disk::from_img(Box::new(img)).expect("bad setup");
    disk.format(&String::from("NEW.DISK"),true,None).expect("failed to format");
    let ignore = disk.standardize(2);
    disk.compare(&Path::new("tests").join("prodos-blank.po"),&ignore);
}

#[test]
fn create_dirs() {
    let img = a2kit::img::dsk_po::PO::create(280);
    let mut disk = prodos::Disk::from_img(Box::new(img)).expect("bad setup");
    disk.format(&String::from("NEW.DISK"),true,None).expect("failed to format");
    let mut tokens = get_tokens("build_dirs.bas");
    tokens.push(0xc4); // Virtual II added an extra byte, why?
    disk.save("hello",&tokens,ItemType::ApplesoftTokens,None).expect("dimg error");
    disk.create(&String::from("INNER.DIRS")).expect("unreachable");
    for i in 1..55 {
        let mut path = "".to_string();
        write!(path,"INNER.DIRS/DIR{}",i).expect("unreachable");
        disk.create(&path).expect("unreachable");
    }
    let ignore = disk.standardize(2);
    disk.compare(&Path::new("tests").join("prodos-mkdir.dsk"),&ignore);
}

#[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("prodos-smallfiles.do")).expect("failed to read test image file");
    let mut emulator_disk = a2kit::create_fs_from_bytestream(&img,None,None).expect("file not found");

    // check the BASIC program
    let mut lib_tokens = get_tokens("disk_builder.abas");
    lib_tokens.push(196);
    let disk_tokens = emulator_disk.load("hello").expect("error");
    assert_eq!(disk_tokens,(2049,lib_tokens));

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

    // check the sequential text file
    let txt = emulator_disk.read_text("thetext").expect("error");
    assert_eq!(&txt,"HELLO FROM EMULATOR\n");
}

#[test]
fn write_small() {
    // Formatting: Copy2Plus, writing: Virtual II:
    // This tests a small BASIC program, binary, and text file
    let img = a2kit::img::dsk_po::PO::create(280);
    let mut disk = prodos::Disk::from_img(Box::new(img)).expect("bad setup");
    disk.format(&String::from("NEW.DISK"),true,None).expect("failed to format");

    // save the BASIC program
    let mut lib_tokens = get_tokens("disk_builder.abas");
    lib_tokens.push(196);
    disk.save("hello",&lib_tokens,ItemType::ApplesoftTokens,None).expect("error");

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

    // save the text
    disk.write_text("thetext","HELLO FROM EMULATOR").expect("error");

    let mut ignore = disk.standardize(2);
    ignore_boot_blocks(&mut ignore);
    disk.compare(&Path::new("tests").join("prodos-smallfiles.do"),&ignore);
}

#[test]
fn out_of_space() {
    let img = a2kit::img::dsk_po::PO::create(280);
    let mut disk = prodos::Disk::from_img(Box::new(img)).expect("bad setup");
    let big: Vec<u8> = vec![0;0x7f00];
    disk.format(&String::from("NEW.DISK"),true,None).expect("failed to format");
    disk.bsave("f1",&big,Some(0x800),None).expect("error");
    disk.bsave("f2",&big,Some(0x800),None).expect("error");
    disk.bsave("f3",&big,Some(0x800),None).expect("error");
    disk.bsave("f4",&big,Some(0x800),None).expect("error");
    match disk.bsave("f5",&big,Some(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: Virtual II
    // This tests a seedling, a sapling, and two trees (both sparse)
    let img = std::fs::read(&Path::new("tests").join("prodos-bigfiles.dsk")).expect("failed to read test image file");
    let mut emulator_disk = a2kit::create_fs_from_bytestream(&img,None,None).expect("could not interpret image");
    let mut buf: Vec<u8>;

    // check the BASIC program, this is a seedling file
    let mut lib_tokens = get_tokens("disk_builder.abas");
    let disk_tokens = emulator_disk.load("hello").expect("error");
    lib_tokens.push(0xc4); // Virtual II added an extra byte, why?
    assert_eq!(disk_tokens,(2049,lib_tokens));

    // check the text records
    let recs = emulator_disk.read_records("tree1", None).expect("failed to read tree1");
    assert_eq!(recs.map.get(&2000).unwrap(),"HELLO FROM TREE 1\n");
    let recs = emulator_disk.read_records("tree2", None).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, this is a non-sparse sapling
    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: Virtual II
    // This tests a seedling, a sapling, and two trees (both sparse)
    let mut buf: Vec<u8>;
    let img = a2kit::img::dsk_po::PO::create(280);
    let mut disk = prodos::Disk::from_img(Box::new(img)).expect("bad setup");
    disk.format(&String::from("NEW.DISK"),true,None).expect("failed to format");

    // create and save the BASIC program, this is a seedling file
    let mut lib_tokens = get_tokens("disk_builder.abas");
    lib_tokens.push(0xc4); // Virtual II added an extra byte, why?
    disk.save("hello",&lib_tokens,ItemType::ApplesoftTokens,None).expect("dimg error");

    // make tree files using random access text module
    let mut records = a2kit::fs::Records::new(128);
    records.add_record(2000, "HELLO FROM TREE 1");
    disk.write_records("tree1", &records).expect("dimg error");
    let records = a2kit::fs::Records::from_json(JSON_REC).expect("could not parse JSON");
    disk.write_records("tree2", &records).expect("dimg error");

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

    let ignore = disk.standardize(2);
    disk.compare(&Path::new("tests").join("prodos-bigfiles.dsk"),&ignore);
}

#[test]
fn fill_dirs() {
    // Formatting: Copy2Plus, Writing: Virtual II
    // Make a lot of directories and put sparse files in a few of them
    let img = a2kit::img::dsk_po::PO::create(280);
    let mut disk = prodos::Disk::from_img(Box::new(img)).expect("bad setup");
    disk.format(&String::from("NEW.DISK"),true,None).expect("failed to format");

    let mut tokens = get_tokens("build_dirs.bas");
    tokens.push(0xc4); // extra and it was counted
    disk.save("hello",&tokens,ItemType::ApplesoftTokens,None).expect("dimg error");

    disk.create(&String::from("inner.dirs")).expect("unreachable");
    for i in 1..55 {
        let mut path = "".to_string();
        write!(path,"inner.dirs/dir{}",i).expect("unreachable");
        disk.create(&path).expect("unreachable");
    }

    // make tree files using random access text module
    let mut records = a2kit::fs::Records::new(127);
    records.add_record(4000, "HELLO FROM TREE");

    let n_set = [5,19,32,53];
    for n in n_set {
        let mut path = "".to_string();
        write!(path,"inner.dirs/dir{}/tree",n).expect("unreachable");
        disk.write_records(&path, &records).expect("dimg error");
    }

    let ignore = disk.standardize(2);
    disk.compare(&Path::new("tests").join("prodos-fill-dirs.dsk"),&ignore);
}

#[test]
fn rename_delete() {
    // Formatting: Copy2Plus, Writing: Virtual II
    // test delete and rename of sparse tree files and directories inside a large subdirectory
    let img = a2kit::img::dsk_po::PO::create(280);
    let mut disk = prodos::Disk::from_img(Box::new(img)).expect("bad setup");
    disk.format(&String::from("NEW.DISK"),true,None).expect("failed to format");

    let mut tokens = get_tokens("build_dirs.bas");
    tokens.push(0xc4); // extra and it was counted
    disk.save("hello",&tokens,ItemType::ApplesoftTokens,None).expect("dimg error");

    disk.create(&String::from("inner.dirs")).expect("unreachable");
    for i in 1..55 {
        let mut path = "".to_string();
        write!(path,"inner.dirs/dir{}",i).expect("unreachable");
        disk.create(&path).expect("unreachable");
    }

    // make tree files using random access text module
    let mut records = a2kit::fs::Records::new(127);
    records.add_record(4000, "HELLO FROM TREE");

    let n_set = [5,19,32,53];
    for n in n_set {
        let mut path = "".to_string();
        write!(path,"inner.dirs/dir{}/tree",n).expect("unreachable");
        disk.write_records(&path, &records).expect("dimg error");
    }

    let ignore = disk.standardize(2);

    // delete and rename
    disk.delete("inner.dirs/dir1").expect("dimg error");
    disk.delete("inner.dirs/dir32/tree").expect("dimg error");
    disk.delete("inner.dirs/dir32").expect("dimg error");
    disk.rename("inner.dirs/dir53/tree","tree53").expect("dimg error");

    disk.compare(&Path::new("tests").join("prodos-ren-del.dsk"),&ignore);
}

#[test]
fn read_big_woz1() {
    // Formatting: Copy2Plus, Writing: Virtual II
    // This tests the same file system information used for read_big and write_big.
    // An important wrinkle is the volume in the sector address fields is 1 rather than the usual 254.

    let buf = Path::new("tests").join("prodos-bigfiles.woz");
    let woz1_path = buf.to_str().expect("could not get path");
    let mut disk = a2kit::create_fs_from_file(woz1_path,None).expect("could not interpret image");
    let ignore = disk.standardize(2);
    disk.compare(&Path::new("tests").join("prodos-bigfiles.dsk"),&ignore);    
}