wow-adt 0.6.4

Parser for World of Warcraft ADT terrain files with heightmap and texture layer 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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
//! Validation functions for ADT builder.
//!
//! Implements progressive validation strategy:
//! - Method-level: Basic parameter checks
//! - Build-level: Structural and reference validation

use crate::ChunkId;
use crate::chunks::DoodadPlacement;
use crate::chunks::WmoPlacement;
use crate::chunks::blend_mesh::{MbbbChunk, MbmhChunk, MbmiChunk, MbnvChunk};
use crate::error::{AdtError, Result};
use crate::version::AdtVersion;

/// Validate texture filename format.
///
/// # Validation Rules
///
/// - Filename not empty
/// - Uses forward slashes (not backslashes)
/// - Has .blp extension (case-insensitive)
///
/// # Examples
///
/// ```
/// # use wow_adt::builder::validation::validate_texture_filename;
/// assert!(validate_texture_filename("terrain/grass_01.blp").is_ok());
/// assert!(validate_texture_filename("").is_err());
/// assert!(validate_texture_filename("terrain\\grass.blp").is_err());
/// assert!(validate_texture_filename("terrain/grass.png").is_err());
/// ```
pub fn validate_texture_filename(filename: &str) -> Result<()> {
    if filename.is_empty() {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MTEX,
            offset: 0,
            details: "Texture filename cannot be empty".to_string(),
        });
    }

    if filename.contains('\\') {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MTEX,
            offset: 0,
            details: format!(
                "Texture filename '{}' contains backslashes - use forward slashes",
                filename
            ),
        });
    }

    if !filename.to_lowercase().ends_with(".blp") {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MTEX,
            offset: 0,
            details: format!("Texture filename '{}' must have .blp extension", filename),
        });
    }

    Ok(())
}

/// Validate M2 model filename format.
///
/// # Validation Rules
///
/// - Filename not empty
/// - Uses forward slashes (not backslashes)
/// - Has .m2 extension (case-insensitive)
pub fn validate_model_filename(filename: &str) -> Result<()> {
    if filename.is_empty() {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MMDX,
            offset: 0,
            details: "Model filename cannot be empty".to_string(),
        });
    }

    if filename.contains('\\') {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MMDX,
            offset: 0,
            details: format!(
                "Model filename '{}' contains backslashes - use forward slashes",
                filename
            ),
        });
    }

    if !filename.to_lowercase().ends_with(".m2") {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MMDX,
            offset: 0,
            details: format!("Model filename '{}' must have .m2 extension", filename),
        });
    }

    Ok(())
}

/// Validate WMO filename format.
///
/// # Validation Rules
///
/// - Filename not empty
/// - Uses forward slashes (not backslashes)
/// - Has .wmo extension (case-insensitive)
pub fn validate_wmo_filename(filename: &str) -> Result<()> {
    if filename.is_empty() {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MWMO,
            offset: 0,
            details: "WMO filename cannot be empty".to_string(),
        });
    }

    if filename.contains('\\') {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MWMO,
            offset: 0,
            details: format!(
                "WMO filename '{}' contains backslashes - use forward slashes",
                filename
            ),
        });
    }

    if !filename.to_lowercase().ends_with(".wmo") {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MWMO,
            offset: 0,
            details: format!("WMO filename '{}' must have .wmo extension", filename),
        });
    }

    Ok(())
}

/// Validate version-chunk compatibility.
///
/// # Validation Rules
///
/// - MFBO requires TBC+
/// - MH2O requires WotLK+
/// - MAMP requires Cataclysm+
/// - MTXP requires MoP+
/// - MBMH, MBBB, MBNV, MBMI require MoP+ (blend mesh system)
pub fn validate_version_chunk_compatibility(version: AdtVersion, chunk: ChunkId) -> Result<()> {
    match chunk {
        ChunkId::MFBO => {
            if !matches!(
                version,
                AdtVersion::TBC | AdtVersion::WotLK | AdtVersion::Cataclysm | AdtVersion::MoP
            ) {
                return Err(AdtError::ChunkParseError {
                    chunk: ChunkId::MFBO,
                    offset: 0,
                    details: format!(
                        "MFBO (flight bounds) requires TBC or later, but version is {:?}",
                        version
                    ),
                });
            }
        }
        ChunkId::MH2O => {
            if !matches!(
                version,
                AdtVersion::WotLK | AdtVersion::Cataclysm | AdtVersion::MoP
            ) {
                return Err(AdtError::ChunkParseError {
                    chunk: ChunkId::MH2O,
                    offset: 0,
                    details: format!(
                        "MH2O (advanced water) requires WotLK or later, but version is {:?}",
                        version
                    ),
                });
            }
        }
        ChunkId::MAMP => {
            if !matches!(version, AdtVersion::Cataclysm | AdtVersion::MoP) {
                return Err(AdtError::ChunkParseError {
                    chunk: ChunkId::MAMP,
                    offset: 0,
                    details: format!(
                        "MAMP (texture amplifier) requires Cataclysm or later, but version is {:?}",
                        version
                    ),
                });
            }
        }
        ChunkId::MTXP | ChunkId::MBMH | ChunkId::MBBB | ChunkId::MBNV | ChunkId::MBMI => {
            if version != AdtVersion::MoP {
                let chunk_name = match chunk {
                    ChunkId::MTXP => "MTXP (texture parameters)",
                    ChunkId::MBMH => "MBMH (blend mesh headers)",
                    ChunkId::MBBB => "MBBB (blend mesh bounds)",
                    ChunkId::MBNV => "MBNV (blend mesh vertices)",
                    ChunkId::MBMI => "MBMI (blend mesh indices)",
                    _ => unreachable!(),
                };
                return Err(AdtError::ChunkParseError {
                    chunk,
                    offset: 0,
                    details: format!("{} requires MoP, but version is {:?}", chunk_name, version),
                });
            }
        }
        _ => {}
    }

    Ok(())
}

/// Validate doodad placement references.
///
/// # Validation Rules
///
/// - name_id < model_count
/// - scale > 0
pub fn validate_doodad_placement_references(
    placements: &[DoodadPlacement],
    model_count: usize,
) -> Result<()> {
    for (idx, placement) in placements.iter().enumerate() {
        if placement.name_id as usize >= model_count {
            return Err(AdtError::InvalidModelReference {
                index: placement.name_id,
                count: model_count as u32,
            });
        }

        if placement.scale == 0 {
            return Err(AdtError::ChunkParseError {
                chunk: ChunkId::MDDF,
                offset: 0,
                details: format!("Doodad placement {} has invalid scale 0 (must be > 0)", idx),
            });
        }
    }

    Ok(())
}

/// Validate WMO placement references.
///
/// # Validation Rules
///
/// - name_id < wmo_count
pub fn validate_wmo_placement_references(
    placements: &[WmoPlacement],
    wmo_count: usize,
) -> Result<()> {
    for placement in placements {
        if placement.name_id as usize >= wmo_count {
            return Err(AdtError::InvalidModelReference {
                index: placement.name_id,
                count: wmo_count as u32,
            });
        }
    }

    Ok(())
}

/// Validate blend mesh data completeness and consistency (MoP+).
///
/// # Validation Rules
///
/// - All four blend mesh chunks must be present together or all absent
/// - Headers cannot be empty if present
/// - Bounds count must match headers count
/// - Total vertices/indices counts must match headers' ranges
///
/// # Examples
///
/// ```
/// # use wow_adt::builder::validation::validate_blend_mesh_data;
/// # use wow_adt::chunks::blend_mesh::{MbmhChunk, MbbbChunk, MbnvChunk, MbmiChunk};
/// // All None - valid
/// assert!(validate_blend_mesh_data(&None, &None, &None, &None).is_ok());
///
/// // All present with matching counts - valid
/// let headers = MbmhChunk::default();
/// let bounds = MbbbChunk::default();
/// let vertices = MbnvChunk::default();
/// let indices = MbmiChunk::default();
/// // This would validate if counts match
/// ```
pub fn validate_blend_mesh_data(
    headers: &Option<MbmhChunk>,
    bounds: &Option<MbbbChunk>,
    vertices: &Option<MbnvChunk>,
    indices: &Option<MbmiChunk>,
) -> Result<()> {
    // Check completeness: all 4 chunks present or all 4 absent
    let present = [
        headers.is_some(),
        bounds.is_some(),
        vertices.is_some(),
        indices.is_some(),
    ];

    let some_count = present.iter().filter(|&&x| x).count();
    if some_count != 0 && some_count != 4 {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MBMH,
            offset: 0,
            details: format!(
                "Blend mesh chunks must all be present or all absent (found {} of 4)",
                some_count
            ),
        });
    }

    // If all absent, validation complete
    if some_count == 0 {
        return Ok(());
    }

    // All 4 are present - validate consistency
    let headers = headers.as_ref().unwrap();
    let bounds = bounds.as_ref().unwrap();
    let vertices = vertices.as_ref().unwrap();
    let indices = indices.as_ref().unwrap();

    // Headers cannot be empty
    if headers.entries.is_empty() {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MBMH,
            offset: 0,
            details: "Blend mesh headers cannot be empty".to_string(),
        });
    }

    // Bounds count must match headers count
    if bounds.entries.len() != headers.entries.len() {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MBBB,
            offset: 0,
            details: format!(
                "Blend mesh bounds count {} does not match headers count {}",
                bounds.entries.len(),
                headers.entries.len()
            ),
        });
    }

    // Validate that index/vertex counts in headers match actual data
    let total_indices: u32 = headers.entries.iter().map(|h| h.mbmi_count).sum();
    let total_vertices: u32 = headers.entries.iter().map(|h| h.mbnv_count).sum();

    if indices.indices.len() != total_indices as usize {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MBMI,
            offset: 0,
            details: format!(
                "Blend mesh indices count {} does not match headers total {}",
                indices.indices.len(),
                total_indices
            ),
        });
    }

    if vertices.vertices.len() != total_vertices as usize {
        return Err(AdtError::ChunkParseError {
            chunk: ChunkId::MBNV,
            offset: 0,
            details: format!(
                "Blend mesh vertices count {} does not match headers total {}",
                vertices.vertices.len(),
                total_vertices
            ),
        });
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_validate_texture_filename_valid() {
        assert!(validate_texture_filename("terrain/grass_01.blp").is_ok());
        assert!(validate_texture_filename("Terrain/Grass.BLP").is_ok());
        assert!(validate_texture_filename("a/b/c/texture.blp").is_ok());
    }

    #[test]
    fn test_validate_texture_filename_empty() {
        assert!(validate_texture_filename("").is_err());
    }

    #[test]
    fn test_validate_texture_filename_backslash() {
        assert!(validate_texture_filename("terrain\\grass.blp").is_err());
    }

    #[test]
    fn test_validate_texture_filename_wrong_extension() {
        assert!(validate_texture_filename("terrain/grass.png").is_err());
        assert!(validate_texture_filename("terrain/grass.jpg").is_err());
    }

    #[test]
    fn test_validate_model_filename_valid() {
        assert!(validate_model_filename("doodad/tree_01.m2").is_ok());
        assert!(validate_model_filename("Doodad/Tree.M2").is_ok());
    }

    #[test]
    fn test_validate_model_filename_wrong_extension() {
        assert!(validate_model_filename("doodad/tree.mdx").is_err());
    }

    #[test]
    fn test_validate_wmo_filename_valid() {
        assert!(validate_wmo_filename("building/house_01.wmo").is_ok());
        assert!(validate_wmo_filename("Building/House.WMO").is_ok());
    }

    #[test]
    fn test_validate_version_chunk_mfbo() {
        assert!(validate_version_chunk_compatibility(AdtVersion::TBC, ChunkId::MFBO).is_ok());
        assert!(
            validate_version_chunk_compatibility(AdtVersion::VanillaEarly, ChunkId::MFBO).is_err()
        );
    }

    #[test]
    fn test_validate_version_chunk_mh2o() {
        assert!(validate_version_chunk_compatibility(AdtVersion::WotLK, ChunkId::MH2O).is_ok());
        assert!(validate_version_chunk_compatibility(AdtVersion::TBC, ChunkId::MH2O).is_err());
    }

    #[test]
    fn test_validate_version_chunk_mamp() {
        assert!(validate_version_chunk_compatibility(AdtVersion::Cataclysm, ChunkId::MAMP).is_ok());
        assert!(validate_version_chunk_compatibility(AdtVersion::WotLK, ChunkId::MAMP).is_err());
    }

    #[test]
    fn test_validate_version_chunk_mtxp() {
        assert!(validate_version_chunk_compatibility(AdtVersion::MoP, ChunkId::MTXP).is_ok());
        assert!(
            validate_version_chunk_compatibility(AdtVersion::Cataclysm, ChunkId::MTXP).is_err()
        );
    }

    #[test]
    fn test_validate_doodad_placement_valid() {
        let placements = vec![
            DoodadPlacement {
                name_id: 0,
                unique_id: 1,
                position: [0.0, 0.0, 0.0],
                rotation: [0.0, 0.0, 0.0],
                scale: 1024,
                flags: 0,
            },
            DoodadPlacement {
                name_id: 1,
                unique_id: 2,
                position: [100.0, 100.0, 0.0],
                rotation: [0.0, 0.0, 0.0],
                scale: 512,
                flags: 0,
            },
        ];

        assert!(validate_doodad_placement_references(&placements, 2).is_ok());
    }

    #[test]
    fn test_validate_doodad_placement_invalid_reference() {
        let placements = vec![DoodadPlacement {
            name_id: 5,
            unique_id: 1,
            position: [0.0, 0.0, 0.0],
            rotation: [0.0, 0.0, 0.0],
            scale: 1024,
            flags: 0,
        }];

        assert!(validate_doodad_placement_references(&placements, 2).is_err());
    }

    #[test]
    fn test_validate_doodad_placement_zero_scale() {
        let placements = vec![DoodadPlacement {
            name_id: 0,
            unique_id: 1,
            position: [0.0, 0.0, 0.0],
            rotation: [0.0, 0.0, 0.0],
            scale: 0,
            flags: 0,
        }];

        assert!(validate_doodad_placement_references(&placements, 1).is_err());
    }

    #[test]
    fn test_validate_wmo_placement_valid() {
        let placements = vec![WmoPlacement {
            name_id: 0,
            unique_id: 1,
            position: [0.0, 0.0, 0.0],
            rotation: [0.0, 0.0, 0.0],
            extents_min: [-100.0, -100.0, 0.0],
            extents_max: [100.0, 100.0, 200.0],
            flags: 0,
            doodad_set: 0,
            name_set: 0,
            scale: 1024,
        }];

        assert!(validate_wmo_placement_references(&placements, 1).is_ok());
    }

    #[test]
    fn test_validate_wmo_placement_invalid_reference() {
        let placements = vec![WmoPlacement {
            name_id: 3,
            unique_id: 1,
            position: [0.0, 0.0, 0.0],
            rotation: [0.0, 0.0, 0.0],
            extents_min: [-100.0, -100.0, 0.0],
            extents_max: [100.0, 100.0, 200.0],
            flags: 0,
            doodad_set: 0,
            name_set: 0,
            scale: 1024,
        }];

        assert!(validate_wmo_placement_references(&placements, 1).is_err());
    }
}