pdbrust 0.7.0

A comprehensive Rust library for parsing and analyzing Protein Data Bank (PDB) files
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
//! Recursive descent parser for the selection language.

use super::ast::{ComparisonOp, SelectionExpr};
use super::error::SelectionError;
use super::lexer::{SpannedToken, Token};

/// Recursive descent parser for selection expressions.
pub struct Parser {
    tokens: Vec<SpannedToken>,
    position: usize,
}

impl Parser {
    /// Create a new parser from a token stream.
    pub fn new(tokens: Vec<SpannedToken>) -> Self {
        Self {
            tokens,
            position: 0,
        }
    }

    /// Parse the token stream into an AST.
    pub fn parse(&mut self) -> Result<SelectionExpr, SelectionError> {
        if self.tokens.is_empty() {
            return Err(SelectionError::EmptySelection);
        }

        if self.current_token() == &Token::Eof {
            return Err(SelectionError::EmptySelection);
        }

        let expr = self.parse_or()?;

        // Ensure we consumed all tokens
        if self.current_token() != &Token::Eof {
            return Err(SelectionError::UnexpectedToken {
                expected: "end of selection".to_string(),
                found: format!("{:?}", self.current_token()),
                position: self.current_position(),
            });
        }

        Ok(expr)
    }

    /// Parse OR expressions (lowest precedence).
    fn parse_or(&mut self) -> Result<SelectionExpr, SelectionError> {
        let mut left = self.parse_and()?;

        while self.current_token() == &Token::Or {
            self.advance();
            let right = self.parse_and()?;
            left = SelectionExpr::Or(Box::new(left), Box::new(right));
        }

        Ok(left)
    }

    /// Parse AND expressions (medium precedence).
    fn parse_and(&mut self) -> Result<SelectionExpr, SelectionError> {
        let mut left = self.parse_not()?;

        while self.current_token() == &Token::And {
            self.advance();
            let right = self.parse_not()?;
            left = SelectionExpr::And(Box::new(left), Box::new(right));
        }

        Ok(left)
    }

    /// Parse NOT expressions (highest precedence).
    fn parse_not(&mut self) -> Result<SelectionExpr, SelectionError> {
        if self.current_token() == &Token::Not {
            self.advance();
            let expr = self.parse_not()?; // Right-associative
            return Ok(SelectionExpr::Not(Box::new(expr)));
        }

        self.parse_primary()
    }

    /// Parse primary expressions (atoms, parenthesized, keywords).
    fn parse_primary(&mut self) -> Result<SelectionExpr, SelectionError> {
        let token = self.current_token().clone();
        let position = self.current_position();

        match token {
            Token::LParen => {
                let paren_pos = position;
                self.advance();
                let expr = self.parse_or()?;
                if self.current_token() != &Token::RParen {
                    return Err(SelectionError::UnclosedParenthesis {
                        position: paren_pos,
                    });
                }
                self.advance();
                Ok(expr)
            }
            Token::Chain => {
                self.advance();
                let id = self.expect_identifier()?;
                Ok(SelectionExpr::Chain(id))
            }
            Token::Name => {
                self.advance();
                let name = self.expect_identifier()?;
                Ok(SelectionExpr::Name(name))
            }
            Token::Resname => {
                self.advance();
                let name = self.expect_identifier()?;
                Ok(SelectionExpr::Resname(name))
            }
            Token::Resid => {
                self.advance();
                self.parse_resid()
            }
            Token::Element => {
                self.advance();
                let elem = self.expect_identifier()?;
                Ok(SelectionExpr::Element(elem))
            }
            Token::Bfactor => {
                self.advance();
                let (op, val) = self.parse_comparison()?;
                Ok(SelectionExpr::Bfactor(op, val))
            }
            Token::Occupancy => {
                self.advance();
                let (op, val) = self.parse_comparison()?;
                Ok(SelectionExpr::Occupancy(op, val))
            }
            Token::Backbone => {
                self.advance();
                Ok(SelectionExpr::Backbone)
            }
            Token::Protein => {
                self.advance();
                Ok(SelectionExpr::Protein)
            }
            Token::Nucleic => {
                self.advance();
                Ok(SelectionExpr::Nucleic)
            }
            Token::Water => {
                self.advance();
                Ok(SelectionExpr::Water)
            }
            Token::Hetero => {
                self.advance();
                Ok(SelectionExpr::Hetero)
            }
            Token::Hydrogen => {
                self.advance();
                Ok(SelectionExpr::Hydrogen)
            }
            Token::All => {
                self.advance();
                Ok(SelectionExpr::All)
            }
            Token::Identifier(ref s) => {
                // Check if this is an unknown keyword
                Err(SelectionError::UnknownKeyword {
                    keyword: s.clone(),
                    position,
                })
            }
            _ => Err(SelectionError::UnexpectedToken {
                expected: "selection keyword or '('".to_string(),
                found: format!("{:?}", token),
                position,
            }),
        }
    }

    /// Parse residue ID (single value or range).
    fn parse_resid(&mut self) -> Result<SelectionExpr, SelectionError> {
        let start = self.expect_integer()?;

        if self.current_token() == &Token::Colon {
            self.advance();
            let end = self.expect_integer()?;
            Ok(SelectionExpr::ResidRange { start, end })
        } else {
            Ok(SelectionExpr::Resid(start))
        }
    }

    /// Parse numeric comparison (e.g., < 30.0).
    fn parse_comparison(&mut self) -> Result<(ComparisonOp, f64), SelectionError> {
        let position = self.current_position();
        let op = match self.current_token() {
            Token::Lt => ComparisonOp::Lt,
            Token::Gt => ComparisonOp::Gt,
            Token::Le => ComparisonOp::Le,
            Token::Ge => ComparisonOp::Ge,
            Token::Eq => ComparisonOp::Eq,
            _ => {
                return Err(SelectionError::UnexpectedToken {
                    expected: "comparison operator (<, >, <=, >=, =)".to_string(),
                    found: format!("{:?}", self.current_token()),
                    position,
                });
            }
        };
        self.advance();

        let value = self.expect_number()?;
        Ok((op, value))
    }

    fn expect_identifier(&mut self) -> Result<String, SelectionError> {
        let position = self.current_position();
        match self.current_token().clone() {
            Token::Identifier(s) => {
                self.advance();
                Ok(s)
            }
            // Also accept integers as identifiers (for chain IDs like "1")
            Token::Integer(n) => {
                self.advance();
                Ok(n.to_string())
            }
            other => Err(SelectionError::UnexpectedToken {
                expected: "identifier".to_string(),
                found: format!("{:?}", other),
                position,
            }),
        }
    }

    fn expect_integer(&mut self) -> Result<i32, SelectionError> {
        let position = self.current_position();
        match self.current_token().clone() {
            Token::Integer(n) => {
                self.advance();
                Ok(n)
            }
            other => Err(SelectionError::UnexpectedToken {
                expected: "integer".to_string(),
                found: format!("{:?}", other),
                position,
            }),
        }
    }

    fn expect_number(&mut self) -> Result<f64, SelectionError> {
        let position = self.current_position();
        match self.current_token().clone() {
            Token::Float(f) => {
                self.advance();
                Ok(f)
            }
            Token::Integer(n) => {
                self.advance();
                Ok(n as f64)
            }
            other => Err(SelectionError::UnexpectedToken {
                expected: "number".to_string(),
                found: format!("{:?}", other),
                position,
            }),
        }
    }

    fn current_token(&self) -> &Token {
        self.tokens
            .get(self.position)
            .map(|t| &t.token)
            .unwrap_or(&Token::Eof)
    }

    fn current_position(&self) -> usize {
        self.tokens.get(self.position).map(|t| t.start).unwrap_or(0)
    }

    fn advance(&mut self) {
        if self.position < self.tokens.len() {
            self.position += 1;
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::filter::selection::lexer::Lexer;

    fn parse(s: &str) -> Result<SelectionExpr, SelectionError> {
        let tokens = Lexer::new(s).tokenize()?;
        Parser::new(tokens).parse()
    }

    #[test]
    fn test_parse_chain() {
        let expr = parse("chain A").unwrap();
        assert!(matches!(expr, SelectionExpr::Chain(s) if s == "A"));
    }

    #[test]
    fn test_parse_name() {
        let expr = parse("name CA").unwrap();
        assert!(matches!(expr, SelectionExpr::Name(s) if s == "CA"));
    }

    #[test]
    fn test_parse_resname() {
        let expr = parse("resname ALA").unwrap();
        assert!(matches!(expr, SelectionExpr::Resname(s) if s == "ALA"));
    }

    #[test]
    fn test_parse_resid() {
        let expr = parse("resid 50").unwrap();
        assert!(matches!(expr, SelectionExpr::Resid(50)));
    }

    #[test]
    fn test_parse_resid_range() {
        let expr = parse("resid 1:100").unwrap();
        assert!(matches!(
            expr,
            SelectionExpr::ResidRange { start: 1, end: 100 }
        ));
    }

    #[test]
    fn test_parse_and() {
        let expr = parse("chain A and name CA").unwrap();
        assert!(matches!(expr, SelectionExpr::And(_, _)));
    }

    #[test]
    fn test_parse_or() {
        let expr = parse("chain A or chain B").unwrap();
        assert!(matches!(expr, SelectionExpr::Or(_, _)));
    }

    #[test]
    fn test_parse_not() {
        let expr = parse("not hydrogen").unwrap();
        assert!(matches!(expr, SelectionExpr::Not(_)));
    }

    #[test]
    fn test_parse_parentheses() {
        let expr = parse("(chain A or chain B) and backbone").unwrap();
        // Should parse as: (chain A or chain B) and backbone
        if let SelectionExpr::And(left, right) = expr {
            assert!(matches!(*left, SelectionExpr::Or(_, _)));
            assert!(matches!(*right, SelectionExpr::Backbone));
        } else {
            panic!("Expected And expression");
        }
    }

    #[test]
    fn test_parse_precedence_and_or() {
        // OR has lower precedence than AND
        let expr = parse("chain A and name CA or chain B").unwrap();
        // Should parse as: (chain A and name CA) or chain B
        if let SelectionExpr::Or(left, _) = expr {
            assert!(matches!(*left, SelectionExpr::And(_, _)));
        } else {
            panic!("Expected Or expression at top level");
        }
    }

    #[test]
    fn test_parse_precedence_not_and() {
        // NOT binds tighter than AND
        let expr = parse("not hydrogen and protein").unwrap();
        // Should parse as: (not hydrogen) and protein
        if let SelectionExpr::And(left, _) = expr {
            assert!(matches!(*left, SelectionExpr::Not(_)));
        } else {
            panic!("Expected And expression at top level");
        }
    }

    #[test]
    fn test_parse_bfactor() {
        let expr = parse("bfactor < 30.0").unwrap();
        if let SelectionExpr::Bfactor(op, val) = expr {
            assert_eq!(op, ComparisonOp::Lt);
            assert!((val - 30.0).abs() < f64::EPSILON);
        } else {
            panic!("Expected Bfactor expression");
        }
    }

    #[test]
    fn test_parse_complex() {
        let expr = parse("(chain A or chain B) and backbone and not hydrogen").unwrap();
        // Should parse without errors
        assert!(matches!(expr, SelectionExpr::And(_, _)));
    }

    #[test]
    fn test_parse_error_unclosed_paren() {
        let result = parse("(chain A and name CA");
        assert!(matches!(
            result,
            Err(SelectionError::UnclosedParenthesis { .. })
        ));
    }

    #[test]
    fn test_parse_error_empty() {
        let result = parse("");
        assert!(matches!(result, Err(SelectionError::EmptySelection)));
    }

    #[test]
    fn test_parse_error_unknown_keyword() {
        let result = parse("unknown_keyword");
        assert!(matches!(result, Err(SelectionError::UnknownKeyword { .. })));
    }

    #[test]
    fn test_parse_all() {
        let expr = parse("all").unwrap();
        assert!(matches!(expr, SelectionExpr::All));

        let expr = parse("*").unwrap();
        assert!(matches!(expr, SelectionExpr::All));
    }

    #[test]
    fn test_parse_keywords() {
        assert!(matches!(
            parse("backbone").unwrap(),
            SelectionExpr::Backbone
        ));
        assert!(matches!(parse("protein").unwrap(), SelectionExpr::Protein));
        assert!(matches!(parse("nucleic").unwrap(), SelectionExpr::Nucleic));
        assert!(matches!(parse("water").unwrap(), SelectionExpr::Water));
        assert!(matches!(parse("hetero").unwrap(), SelectionExpr::Hetero));
        assert!(matches!(
            parse("hydrogen").unwrap(),
            SelectionExpr::Hydrogen
        ));
    }
}