twmap 0.10.0

Parse, edit and save Teeworlds and DDNet maps
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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
#![allow(clippy::upper_case_acronyms)]

use crate::automapper::{
    Automapper, Chance, Condition, Config, IndexRule, Rule, Run, TileCondition,
};
use crate::convert::TryTo;
use crate::{Tile, TileFlags};
use std::fmt;
use std::str;
use std::str::FromStr;
use thiserror::Error;
use vek::Vec2;

// Considerations:
// - Automapper with zero configs
// - Config with zero rules

struct Lines<'file> {
    lines: str::Lines<'file>,
    peeked_line: Option<(u32, &'file str)>,
    line_number: u32,
}

struct Tokens<'line> {
    line: &'line str,
    line_number: u32,
    split: str::Split<'line, &'static [char]>,
    next_index: u32,
    current: Option<(u32, &'line str)>,
}

impl<'file> Lines<'file> {
    fn new(file: &'file str) -> Self {
        Self {
            lines: file.lines(),
            peeked_line: None,
            line_number: 1,
        }
    }

    fn peek(&mut self) -> Option<Tokens<'file>> {
        if let Some(line) = self.peeked_line {
            return Some(Tokens::new(line));
        }
        loop {
            match self.lines.next() {
                None => break None,
                Some(line) => {
                    self.line_number += 1;
                    // Skip empty and comment lines
                    if line.is_empty()
                        || line.strip_prefix('#').is_some()
                        || line.chars().all(|c| SPLIT_CHARS.contains(&c))
                    {
                        continue;
                    } else {
                        self.peeked_line = Some((self.line_number, line));
                        break Some(Tokens::new(self.peeked_line.unwrap()));
                    }
                }
            }
        }
    }

    fn next(&mut self) -> Option<Tokens<'file>> {
        let next = self.peek();
        self.peeked_line = None;
        next
    }

    fn seek_peek(
        &mut self,
        cancel: &[Pattern],
        seek: &[Pattern],
    ) -> Result<Option<(Tokens<'file>, Pattern)>, SyntaxError> {
        match self.peek() {
            None => Ok(None),
            Some(mut tokens) => {
                if cancel.iter().any(|pattern| pattern.matches(tokens.line)) {
                    return Ok(None);
                }
                for pattern in seek {
                    if pattern.matches(tokens.line) {
                        return Ok(Some((tokens, *pattern)));
                    }
                }
                let expected: Vec<_> = seek
                    .iter()
                    .chain(cancel.iter())
                    .map(|p| p.inner())
                    .collect();
                println!("Line {}: {}", tokens.line_number, tokens.line);
                tokens.next().unwrap();
                Err(tokens.error(&expected))
            }
        }
    }

    /// Like seek_peek, but consumes the next element if a 'seek' is encountered
    fn consume_next(
        &mut self,
        cancel: &[Pattern],
        seek: &[Pattern],
    ) -> Result<Option<(Tokens<'file>, Pattern)>, SyntaxError> {
        Ok(match self.seek_peek(cancel, seek)? {
            None => None,
            Some(next) => {
                self.next();
                Some(next)
            }
        })
    }
}

const EOL: &str = "\n";
const SPLIT_CHARS: [char; 2] = [' ', '\t'];

impl<'line> Tokens<'line> {
    fn new(line: (u32, &'line str)) -> Self {
        Self {
            line: line.1,
            line_number: line.0,
            split: line.1.split(&SPLIT_CHARS),
            next_index: 0,
            current: None,
        }
    }

    fn next(&mut self) -> Option<&str> {
        loop {
            match self.split.next() {
                None => break None,
                Some(token) => {
                    self.current = Some((self.next_index, token));

                    self.next_index += token.len().try_to::<u32>();
                    self.next_index += 1; // Space separator
                    if token.strip_prefix('#').is_some() {
                        // Consume rest of iterator
                        for _ in self.split.by_ref() {}
                        break None;
                    }
                    match token.is_empty() {
                        true => continue, // Skip multiple spaces
                        false => break Some(token),
                    }
                }
            }
        }
    }

    fn error(&self, expected: &[&'static str]) -> SyntaxError {
        let (character, unexpected) = match self.current {
            Some(token) => token,
            None => (self.line.len().try_to(), EOL),
        };
        SyntaxError {
            line: self.line_number,
            character,
            expected: expected.to_vec(),
            unexpected: unexpected.to_owned(),
        }
    }

    fn line_error(&self, character: u32, expected: &[&'static str]) -> SyntaxError {
        SyntaxError {
            line: self.line_number,
            character,
            expected: expected.to_vec(),
            unexpected: self.line.to_owned(),
        }
    }

    fn expect_eol(&mut self) -> Result<(), SyntaxError> {
        match self.next() {
            None => Ok(()),
            Some(_) => Err(self.error(&[EOL])),
        }
    }

    /// Patterns may only be Token patterns.
    /// The first token must already be checked via Pattern::matches
    fn single_token(mut self, pattern: Pattern) -> Result<(), SyntaxError> {
        let expected_token = match pattern {
            Pattern::Prefix(_) => unreachable!(),
            Pattern::Token(token) => token,
        };
        assert_eq!(self.next().unwrap(), expected_token);
        self.expect_eol()
    }

    fn expect_some<T: FromStr>(&mut self, expected: &[&'static str]) -> Result<T, SyntaxError> {
        let token = match self.next() {
            None => return Err(self.error(expected)),
            Some(t) => t,
        };
        T::from_str(token).map_err(|_| self.error(expected))
    }
}

#[derive(Debug, Copy, Clone, Eq, PartialEq)]
enum Pattern {
    Prefix(&'static str),
    Token(&'static str),
}

const NEW_CONFIG: Pattern = Pattern::Prefix("[");
const NEW_RUN: Pattern = Pattern::Token("NewRun");
const NEW_NO_COPY: Pattern = Pattern::Token("NoLayerCopy");
const NEW_RULE: Pattern = Pattern::Token("Index");
const NEW_NO_DEFAULT: Pattern = Pattern::Token("NoDefaultRule");
const NEW_CONDITION: Pattern = Pattern::Token("Pos");
const NEW_RANDOM: Pattern = Pattern::Token("Random");

impl Pattern {
    fn inner(&self) -> &'static str {
        match self {
            Pattern::Prefix(p) => p,
            Pattern::Token(t) => t,
        }
    }

    fn matches(&self, line: &str) -> bool {
        match self {
            Pattern::Prefix(p) => line.strip_prefix(p).is_some(),
            Pattern::Token(t) => line.split(&SPLIT_CHARS).next().unwrap() == *t,
        }
    }
}

impl Automapper {
    pub fn parse(name: String, file: &str) -> Result<Self, SyntaxError> {
        let mut configs = Vec::new();
        let mut lines = Lines::new(file);
        while lines.seek_peek(&[], &[NEW_CONFIG])?.is_some() {
            configs.push(Config::parse(&mut lines)?);
        }
        Ok(Self { name, configs })
    }
}

#[derive(Error, Debug, Clone)]
pub struct SyntaxError {
    line: u32,
    character: u32,
    expected: Vec<&'static str>,
    unexpected: String,
}

fn token_str(token: &str) -> &str {
    match token {
        EOL => "End of Line",
        other => other,
    }
}

impl fmt::Display for SyntaxError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Syntax error in line {}, starting at character {}: ",
            self.line, self.character
        )?;
        match self.expected.len() {
            0 => {}
            1 => write!(f, "Expected \"{}. \"", self.expected[0])?,
            n => {
                write!(f, "Expected either ")?;
                for i in 0..n - 1 {
                    write!(f, "\"{}\", ", token_str(self.expected[i]))?;
                }
                write!(f, "or \"{}\". ", self.expected.last().unwrap())?;
            }
        };
        write!(f, "Unexpected input: \"{}\"", token_str(&self.unexpected))
    }
}

impl Config {
    /// Expects the line with the name immediately
    fn parse(lines: &mut Lines) -> Result<Self, SyntaxError> {
        let tokens = lines.next().unwrap();
        let line = tokens.line;
        let mut name = line.strip_prefix('[').unwrap(); // Guaranteed by prefix pattern
        name = name
            .strip_suffix(']')
            .ok_or_else(|| tokens.line_error(line.len().try_to(), &["]"]))?;
        let name = name.to_owned();
        let mut runs = Vec::new();
        while lines
            .seek_peek(&[NEW_CONFIG], &[NEW_RUN, NEW_NO_COPY, NEW_RULE])?
            .is_some()
        {
            runs.push(Run::parse(lines)?);
        }
        Ok(Self { name, runs })
    }
}

impl Run {
    /// Will consume the next 'NextRun' line
    fn parse(lines: &mut Lines) -> Result<Self, SyntaxError> {
        let mut rules = Vec::new();
        let mut layer_copy = true;
        let mut seek: &[_] = &[NEW_NO_COPY, NEW_RULE, NEW_RUN];
        while let Some((tokens, p)) = lines.seek_peek(&[NEW_CONFIG], seek)? {
            match p {
                NEW_NO_COPY => {
                    layer_copy = false;
                    tokens.single_token(NEW_NO_COPY)?;
                    seek = &[NEW_RULE, NEW_RUN];
                    lines.next().unwrap();
                }
                NEW_RULE => rules.push(IndexRule::parse(lines)?),
                NEW_RUN => {
                    tokens.single_token(NEW_RUN)?;
                    // Remove NewRun line
                    lines.next().unwrap();
                    break;
                }
                _ => unreachable!(),
            }
        }
        Ok(Self { layer_copy, rules })
    }
}

macro_rules! token {
    ( $token_name:ident, $( $variant:ident ),* ) => {
        enum $token_name {
            $(
                $variant,
            )*
        }

        impl $token_name {
            #[allow(dead_code)]
            const fn as_str(&self) -> &'static str {
                match self {
                    $(
                        Self::$variant => stringify!($variant),
                    )*
                }
            }

            fn parse(token: &str) -> Result<Self, ()> {
                match token {
                    $(
                        stringify!($variant) => Ok(Self::$variant),
                    )*
                    _ => Err(()),
                }
            }

            fn next(tokens: &mut Tokens) -> Result<Self, SyntaxError> {
                match tokens.next() {
                    None => Err(tokens.error(&[$(stringify!($variant), )*])),
                    Some(token) => match Self::parse(token) {
                        Ok(parsed) => Ok(parsed),
                        Err(()) => Err(tokens.error(&[$(stringify!($variant), )*])),
                    }
                }
            }
        }
    };
}

macro_rules! eol_token {
    ( $token_name:ident, $( $variant:ident ),* ) => {
        enum $token_name {
            $(
                $variant,
            )*
        }

        impl $token_name {
            #[allow(dead_code)]
            const fn as_str(&self) -> &'static str {
                match self {
                    $(
                        Self::$variant => stringify!($variant),
                    )*
                }
            }

            fn parse(token: Option<&str>) -> Result<Option<Self>, ()> {
                match token {
                    None => Ok(None),
                    $(
                        Some(stringify!($variant)) => Ok(Some(Self::$variant)),
                    )*
                    Some(_) => Err(()),
                }
            }

            fn next_maybe(tokens: &mut Tokens) -> Result<Option<Self>, SyntaxError> {
                Self::parse(tokens.next()).map_err(|_| tokens.error(&[$(stringify!($variant), )*]))
            }
        }
    };
}

eol_token!(TileFlagsToken, XFLIP, YFLIP, ROTATE);
token!(RulePrefixToken, Index);
token!(RandomPrefixToken, Random);

const TILE_ID_EXPECTED: &str = "Tile id (Number between 0 and 256)";
const NO_DUPLICATE_ORIENTATION_EXPECTED: &str = "No duplicate orientation";
const RANDOM_EXPECTED: [&str; 2] = ["Number greater than 1", "Percentage lower than 100%"];

impl FromStr for Chance {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.strip_suffix('%') {
            None => {
                let f = s.parse::<f32>().map_err(|_| ())?;
                if f.is_nan() || f <= 1. || f.is_infinite() {
                    Err(())
                } else {
                    Ok(Self::OneOutOf(f))
                }
            }
            Some(s) => {
                let f = s.parse::<f32>().map_err(|_| ())?;
                if f.is_nan() || f <= 0. || f >= 100. {
                    Err(())
                } else {
                    Ok(Self::Percentage(f))
                }
            }
        }
    }
}

impl IndexRule {
    fn parse(lines: &mut Lines) -> Result<Self, SyntaxError> {
        let mut tokens = lines.next().unwrap();
        RulePrefixToken::next(&mut tokens).unwrap();
        // Guaranteed until here by matching NEWRULE pattern
        let id = tokens.expect_some::<u8>(&[TILE_ID_EXPECTED])?;
        let mut flags = TileFlags::empty();
        while let Some(flag_token) = TileFlagsToken::next_maybe(&mut tokens)? {
            let flag = match flag_token {
                TileFlagsToken::XFLIP => TileFlags::FLIP_X,
                TileFlagsToken::YFLIP => TileFlags::FLIP_Y,
                TileFlagsToken::ROTATE => TileFlags::ROTATE,
            };
            if flags.contains(flag) {
                return Err(tokens.error(&[NO_DUPLICATE_ORIENTATION_EXPECTED]));
            } else {
                flags.insert(flag);
            }
        }
        let tile = Tile::new(id, flags);

        let mut conditions = Vec::new();
        let mut chance = Chance::Always;
        let mut default_rule = true;
        let mut seek: &[_] = &[NEW_NO_DEFAULT, NEW_CONDITION, NEW_RANDOM];
        while let Some((mut tokens, p)) =
            lines.consume_next(&[NEW_CONFIG, NEW_RUN, NEW_NO_COPY, NEW_RULE], seek)?
        {
            match p {
                NEW_NO_DEFAULT => {
                    default_rule = false;
                    tokens.single_token(NEW_NO_DEFAULT)?;
                    seek = &[NEW_CONDITION, NEW_RANDOM];
                }
                NEW_CONDITION => {
                    conditions.push(Rule::parse(tokens)?);
                }
                NEW_RANDOM => {
                    RandomPrefixToken::next(&mut tokens).unwrap();
                    chance = tokens.expect_some::<Chance>(&RANDOM_EXPECTED)?;
                    tokens.expect_eol()?;
                }
                _ => unreachable!(),
            }
        }
        Ok(Self {
            tile,
            default_rule,
            chance,
            conditions,
        })
    }
}

token!(ConditionPrefixToken, Pos);
token!(ConditionVariantToken, FULL, EMPTY, INDEX, NOTINDEX);

const X_OFFSET_EXPECTED: &str = "x-offset of condition";
const Y_OFFSET_EXPECTED: &str = "y-offset of condition";

impl Rule {
    fn parse(mut tokens: Tokens) -> Result<Self, SyntaxError> {
        ConditionPrefixToken::next(&mut tokens).unwrap();
        let x = tokens.expect_some::<i32>(&[X_OFFSET_EXPECTED])?;
        let y = tokens.expect_some::<i32>(&[Y_OFFSET_EXPECTED])?;
        let condition = Condition::parse(&mut tokens)?;

        Ok(Self {
            offset: Vec2 { x, y },
            condition,
        })
    }
}

impl Condition {
    fn parse(tokens: &mut Tokens) -> Result<Self, SyntaxError> {
        let condition = match ConditionVariantToken::next(tokens)? {
            ConditionVariantToken::FULL => Condition::Full,
            ConditionVariantToken::EMPTY => Condition::Empty,
            ConditionVariantToken::INDEX => {
                Condition::WhiteList(TileCondition::parse_list(tokens)?)
            }
            ConditionVariantToken::NOTINDEX => {
                Condition::BlackList(TileCondition::parse_list(tokens)?)
            }
        };
        tokens.expect_eol()?;
        Ok(condition)
    }
}

eol_token!(TileConditionToken, NONE, XFLIP, YFLIP, ROTATE, OR);
eol_token!(AnotherTileConditionToken, OR);
eol_token!(OrTileFlagToken, XFLIP, YFLIP, ROTATE, OR);

const OUTSIDE_INDEX_EXPECTED: [&str; 2] = [
    "Tile id (Number between 0 and 256)",
    "-1 (outside of tilemap)",
];

struct OutsideIndex(Option<u8>);
impl FromStr for OutsideIndex {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "-1" => Ok(Self(None)),
            _ => match s.parse::<u8>() {
                Ok(n) => Ok(Self(Some(n))),
                Err(_) => Err(()),
            },
        }
    }
}

impl Tokens<'_> {
    fn another_tile_token(&mut self) -> Result<bool, SyntaxError> {
        Ok(match AnotherTileConditionToken::next_maybe(self)? {
            None => false,
            Some(AnotherTileConditionToken::OR) => true,
        })
    }
}

impl TileCondition {
    fn parse_list(tokens: &mut Tokens) -> Result<Vec<Self>, SyntaxError> {
        let mut another_one = true;
        let mut conditions = Vec::new();
        while another_one {
            let (condition, still_another_one) = Self::parse(tokens)?;
            conditions.push(condition);
            another_one = still_another_one;
        }
        Ok(conditions)
    }

    fn parse(tokens: &mut Tokens) -> Result<(Self, bool), SyntaxError> {
        let OutsideIndex(index) = tokens.expect_some::<OutsideIndex>(&OUTSIDE_INDEX_EXPECTED)?;
        Ok(match index {
            None => (Self::Outside, tokens.another_tile_token()?),
            Some(id) => match TileConditionToken::next_maybe(tokens)? {
                None => (Self::Index(id), false),
                Some(TileConditionToken::OR) => (Self::Index(id), true),
                Some(TileConditionToken::NONE) => (
                    Self::Tile(Tile::new(id, TileFlags::empty())),
                    tokens.another_tile_token()?,
                ),
                Some(orientation) => {
                    let mut flags = match orientation {
                        TileConditionToken::XFLIP => TileFlags::FLIP_X,
                        TileConditionToken::YFLIP => TileFlags::FLIP_Y,
                        TileConditionToken::ROTATE => TileFlags::ROTATE,
                        _ => unreachable!(),
                    };
                    loop {
                        let flag_token = match OrTileFlagToken::next_maybe(tokens)? {
                            None => break (Self::Tile(Tile::new(id, flags)), false),
                            Some(flag) => flag,
                        };
                        let flag = match flag_token {
                            OrTileFlagToken::OR => break (Self::Tile(Tile::new(id, flags)), true),
                            OrTileFlagToken::XFLIP => TileFlags::FLIP_X,
                            OrTileFlagToken::YFLIP => TileFlags::FLIP_Y,
                            OrTileFlagToken::ROTATE => TileFlags::ROTATE,
                        };
                        if flags.contains(flag) {
                            return Err(tokens.error(&[NO_DUPLICATE_ORIENTATION_EXPECTED]));
                        } else {
                            flags.insert(flag);
                        }
                    }
                }
            },
        })
    }
}