wow-cdbc 0.6.2

Parser for World of Warcraft DBC (client database) files with serialization support
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
282
283
284
285
286
287
288
289

//! Integration tests for the DBC parser.

use std::io::Cursor;
use wow_cdbc::{DbcHeader, DbcParser, FieldType, Schema, SchemaField, StringRef, Value};

#[test]
fn test_header_parsing() {
    // Create a test DBC file
    let data = create_test_dbc();
    let mut cursor = Cursor::new(&data);

    // Parse the header
    let header = DbcHeader::parse(&mut cursor).unwrap();

    // Check header values
    assert_eq!(header.magic, *b"WDBC");
    assert_eq!(header.record_count, 2);
    assert_eq!(header.field_count, 3);
    assert_eq!(header.record_size, 12);
    assert_eq!(header.string_block_size, 19);
}

#[test]
fn test_schema_validation() {
    // Create a test DBC file
    let data = create_test_dbc();
    let mut cursor = Cursor::new(&data);

    // Parse the DBC file
    let parser = DbcParser::parse(&mut cursor).unwrap();
    let header = parser.header();

    // Create a valid schema
    let mut schema = Schema::new("Test");
    schema.add_field(SchemaField::new("ID", FieldType::UInt32));
    schema.add_field(SchemaField::new("Name", FieldType::String));
    schema.add_field(SchemaField::new("Value", FieldType::UInt32));
    schema.set_key_field("ID");

    // Validate the schema
    assert!(
        schema
            .validate(header.field_count, header.record_size)
            .is_ok()
    );

    // Create an invalid schema (missing a field)
    let mut invalid_schema = Schema::new("Invalid");
    invalid_schema.add_field(SchemaField::new("ID", FieldType::UInt32));
    invalid_schema.add_field(SchemaField::new("Name", FieldType::String));

    // Validate the invalid schema
    assert!(
        invalid_schema
            .validate(header.field_count, header.record_size)
            .is_err()
    );
}

#[test]
fn test_record_parsing() {
    // Create a test DBC file
    let data = create_test_dbc();

    // Parse the DBC file
    let parser = DbcParser::parse_bytes(&data).unwrap();

    // Create a schema
    let mut schema = Schema::new("Test");
    schema.add_field(SchemaField::new("ID", FieldType::UInt32));
    schema.add_field(SchemaField::new("Name", FieldType::String));
    schema.add_field(SchemaField::new("Value", FieldType::UInt32));
    schema.set_key_field("ID");

    // Apply the schema and parse records
    let parser = parser.with_schema(schema).unwrap();
    let record_set = parser.parse_records().unwrap();

    // Check record count
    assert_eq!(record_set.len(), 2);

    // Check first record
    let record = record_set.get_record(0).unwrap();
    if let Value::UInt32(id) = record.get_value_by_name("ID").unwrap() {
        assert_eq!(*id, 1);
    } else {
        panic!("Expected UInt32 for ID");
    }

    if let Value::StringRef(name_ref) = record.get_value_by_name("Name").unwrap() {
        let name = record_set.get_string(*name_ref).unwrap();
        assert_eq!(name, "First");
    } else {
        panic!("Expected StringRef for Name");
    }

    if let Value::UInt32(value) = record.get_value_by_name("Value").unwrap() {
        assert_eq!(*value, 100);
    } else {
        panic!("Expected UInt32 for Value");
    }

    // Check second record
    let record = record_set.get_record(1).unwrap();
    if let Value::UInt32(id) = record.get_value_by_name("ID").unwrap() {
        assert_eq!(*id, 2);
    } else {
        panic!("Expected UInt32 for ID");
    }

    if let Value::StringRef(name_ref) = record.get_value_by_name("Name").unwrap() {
        let name = record_set.get_string(*name_ref).unwrap();
        assert_eq!(name, "Second");
    } else {
        panic!("Expected StringRef for Name");
    }

    if let Value::UInt32(value) = record.get_value_by_name("Value").unwrap() {
        assert_eq!(*value, 200);
    } else {
        panic!("Expected UInt32 for Value");
    }
}

#[test]
fn test_key_lookup() {
    // Create a test DBC file
    let data = create_test_dbc();

    // Parse the DBC file
    let parser = DbcParser::parse_bytes(&data).unwrap();

    // Create a schema
    let mut schema = Schema::new("Test");
    schema.add_field(SchemaField::new("ID", FieldType::UInt32));
    schema.add_field(SchemaField::new("Name", FieldType::String));
    schema.add_field(SchemaField::new("Value", FieldType::UInt32));
    schema.set_key_field("ID");

    // Apply the schema and parse records
    let parser = parser.with_schema(schema).unwrap();
    let record_set = parser.parse_records().unwrap();

    // Look up record by key
    let record = record_set.get_record_by_key(2).unwrap();
    if let Value::StringRef(name_ref) = record.get_value_by_name("Name").unwrap() {
        let name = record_set.get_string(*name_ref).unwrap();
        assert_eq!(name, "Second");
    } else {
        panic!("Expected StringRef for Name");
    }

    // Try to look up a non-existent key
    let record = record_set.get_record_by_key(999);
    assert!(record.is_none());
}

#[test]
fn test_string_block() {
    // Create a test DBC file
    let data = create_test_dbc();

    // Parse the DBC file
    let parser = DbcParser::parse_bytes(&data).unwrap();
    let record_set = parser.parse_records().unwrap();

    // Check string retrieval
    let string = record_set.get_string(StringRef::new(0)).unwrap();
    assert_eq!(string, "First");

    let string = record_set.get_string(StringRef::new(6)).unwrap();
    assert_eq!(string, "Second");

    let string = record_set.get_string(StringRef::new(13)).unwrap();
    assert_eq!(string, "Extra");

    // Try to get a string with an invalid offset
    let result = record_set.get_string(StringRef::new(999));
    assert!(result.is_err());
}

#[test]
fn test_array_fields() {
    // Create a test DBC file with array fields
    let data = create_test_dbc_with_arrays();
    let mut cursor = Cursor::new(&data);

    // Parse the DBC file
    let parser = DbcParser::parse(&mut cursor).unwrap();

    // Create a schema with array fields
    let mut schema = Schema::new("TestArray");
    schema.add_field(SchemaField::new("ID", FieldType::UInt32));
    schema.add_field(SchemaField::new_array("Values", FieldType::UInt32, 3));
    schema.set_key_field("ID");

    // Apply the schema and parse records
    let parser = parser.with_schema(schema).unwrap();
    let record_set = parser.parse_records().unwrap();

    // Check record count
    assert_eq!(record_set.len(), 2);

    // Check first record
    let record = record_set.get_record(0).unwrap();
    if let Value::UInt32(id) = record.get_value_by_name("ID").unwrap() {
        assert_eq!(*id, 1);
    } else {
        panic!("Expected UInt32 for ID");
    }

    if let Value::Array(values) = record.get_value_by_name("Values").unwrap() {
        assert_eq!(values.len(), 3);
        if let Value::UInt32(v1) = &values[0] {
            assert_eq!(*v1, 10);
        } else {
            panic!("Expected UInt32 for Values[0]");
        }
        if let Value::UInt32(v2) = &values[1] {
            assert_eq!(*v2, 20);
        } else {
            panic!("Expected UInt32 for Values[1]");
        }
        if let Value::UInt32(v3) = &values[2] {
            assert_eq!(*v3, 30);
        } else {
            panic!("Expected UInt32 for Values[2]");
        }
    } else {
        panic!("Expected Array for Values");
    }
}

// Helper function to create a test DBC file
fn create_test_dbc() -> Vec<u8> {
    let mut data = Vec::new();

    // Header
    data.extend_from_slice(b"WDBC"); // Magic
    data.extend_from_slice(&2u32.to_le_bytes()); // Record count
    data.extend_from_slice(&3u32.to_le_bytes()); // Field count
    data.extend_from_slice(&12u32.to_le_bytes()); // Record size
    data.extend_from_slice(&19u32.to_le_bytes()); // String block size

    // Records
    // Record 1
    data.extend_from_slice(&1u32.to_le_bytes()); // ID
    data.extend_from_slice(&0u32.to_le_bytes()); // Name offset
    data.extend_from_slice(&100u32.to_le_bytes()); // Value

    // Record 2
    data.extend_from_slice(&2u32.to_le_bytes()); // ID
    data.extend_from_slice(&6u32.to_le_bytes()); // Name offset
    data.extend_from_slice(&200u32.to_le_bytes()); // Value

    // String block
    data.extend_from_slice(b"First\0Second\0Extra\0"); // String block

    data
}

// Helper function to create a test DBC file with array fields
fn create_test_dbc_with_arrays() -> Vec<u8> {
    let mut data = Vec::new();

    // Header
    data.extend_from_slice(b"WDBC"); // Magic
    data.extend_from_slice(&2u32.to_le_bytes()); // Record count
    data.extend_from_slice(&4u32.to_le_bytes()); // Field count
    data.extend_from_slice(&16u32.to_le_bytes()); // Record size
    data.extend_from_slice(&0u32.to_le_bytes()); // String block size

    // Records
    // Record 1
    data.extend_from_slice(&1u32.to_le_bytes()); // ID
    data.extend_from_slice(&10u32.to_le_bytes()); // Values[0]
    data.extend_from_slice(&20u32.to_le_bytes()); // Values[1]
    data.extend_from_slice(&30u32.to_le_bytes()); // Values[2]

    // Record 2
    data.extend_from_slice(&2u32.to_le_bytes()); // ID
    data.extend_from_slice(&40u32.to_le_bytes()); // Values[0]
    data.extend_from_slice(&50u32.to_le_bytes()); // Values[1]
    data.extend_from_slice(&60u32.to_le_bytes()); // Values[2]

    // Empty string block

    data
}