oxirs-star 0.2.4

RDF-star and SPARQL-star grammar support for quoted triples
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
//! Tokenization utilities for RDF-star parsing.
//!
//! This module provides low-level tokenization functions used by the StarParser
//! to process RDF-star syntax including quoted triples, literals, and graph blocks.

use anyhow::Result;

use super::context::TrigParserState;

/// Strip inline comments from a line, respecting string boundaries.
///
/// Comments start with `#` outside of strings. This function handles:
/// - Escaped characters within strings (`\"`)
/// - Proper string boundary detection
/// - UTF-8 character boundaries
///
/// # Examples
///
/// ```ignore
/// # use oxirs_star::parser::tokenizer::strip_inline_comment;
/// assert_eq!(strip_inline_comment("ex:foo ex:bar \"value\" . # comment"), "ex:foo ex:bar \"value\" . ");
/// assert_eq!(strip_inline_comment("ex:foo ex:bar \"value # not a comment\" ."), "ex:foo ex:bar \"value # not a comment\" .");
/// ```
pub fn strip_inline_comment(line: &str) -> &str {
    let mut in_string = false;
    let mut escape_next = false;
    let mut byte_index = 0;

    for ch in line.chars() {
        if escape_next {
            escape_next = false;
            byte_index += ch.len_utf8();
            continue;
        }

        match ch {
            '\\' if in_string => {
                escape_next = true;
                byte_index += ch.len_utf8();
            }
            '"' => {
                in_string = !in_string;
                byte_index += ch.len_utf8();
            }
            '#' if !in_string => {
                // Found comment start outside of string
                return &line[..byte_index];
            }
            _ => {
                byte_index += ch.len_utf8();
            }
        }
    }

    // No comment found
    line
}

/// Check if a Turtle statement is complete (ends with '.').
///
/// This function handles:
/// - Directive completeness (`@prefix`, `@base` must end with `.`)
/// - Quoted triple nesting depth tracking (`<< ... >>`)
/// - Annotation block depth tracking (`{| ... |}`)
/// - String literal boundaries
/// - Escape sequences within strings
///
/// # Arguments
///
/// * `statement` - The statement to check for completeness
///
/// # Returns
///
/// `true` if the statement is complete, `false` otherwise
pub fn is_complete_turtle_statement(statement: &str) -> bool {
    let trimmed = statement.trim();

    // Directives are complete when they end with '.'
    if trimmed.starts_with("@prefix") || trimmed.starts_with("@base") {
        return trimmed.ends_with('.');
    }

    // Check if statement ends with '.' and is balanced
    let mut in_string = false;
    let mut escape_next = false;
    let mut quoted_triple_depth: i32 = 0;
    let mut annotation_depth: i32 = 0;
    let mut chars = statement.chars().peekable();

    while let Some(ch) = chars.next() {
        if escape_next {
            escape_next = false;
            continue;
        }

        match ch {
            '\\' if in_string => escape_next = true,
            '"' => in_string = !in_string,
            '<' if !in_string && chars.peek() == Some(&'<') => {
                // Quoted triple start
                chars.next(); // consume second '<'
                quoted_triple_depth += 1;
            }
            '>' if !in_string && quoted_triple_depth > 0 && chars.peek() == Some(&'>') => {
                // Quoted triple end
                chars.next(); // consume second '>'
                quoted_triple_depth = quoted_triple_depth.saturating_sub(1);
            }
            '{' if !in_string && quoted_triple_depth == 0 && chars.peek() == Some(&'|') => {
                // Annotation block start {|
                chars.next(); // consume '|'
                annotation_depth += 1;
            }
            '|' if !in_string
                && quoted_triple_depth == 0
                && annotation_depth > 0
                && chars.peek() == Some(&'}') =>
            {
                // Annotation block end |}
                chars.next(); // consume '}'
                annotation_depth = annotation_depth.saturating_sub(1);
            }
            '.' if !in_string && quoted_triple_depth == 0 && annotation_depth == 0 => {
                // Check if this is a period in a number (e.g., 0.9)
                // If the next character is a digit, this is part of a number, not a statement terminator
                if chars.peek().is_some_and(|c| c.is_ascii_digit()) {
                    // This is part of a numeric literal, not a statement terminator
                    continue;
                }
                // Statement ends with a dot and we're not in any nested structure
                return true;
            }
            _ => {}
        }
    }

    false
}

/// Check if a TriG statement is complete (enhanced version).
///
/// This function handles:
/// - Directive completeness (`@prefix`, `@base`)
/// - Graph block opening/closing (`{ ... }`)
/// - Brace depth tracking for nested structures
/// - Quoted triple nesting (`<< ... >>`)
/// - String literal boundaries
/// - State transitions for graph block parsing
///
/// # Arguments
///
/// * `statement` - The statement to check for completeness
/// * `state` - Mutable reference to the TriG parser state
///
/// # Returns
///
/// `true` if the statement is complete, `false` otherwise
pub fn is_complete_trig_statement(statement: &str, state: &mut TrigParserState) -> bool {
    let trimmed = statement.trim();

    // Handle directives (always complete on one line)
    if trimmed.starts_with("@prefix") || trimmed.starts_with("@base") {
        return trimmed.ends_with('.');
    }

    // Handle graph block closing
    if trimmed == "}" {
        return true;
    }

    let mut brace_count: i32 = 0;
    let mut in_string = false;
    let mut escape_next = false;
    let mut quoted_triple_depth: i32 = 0;
    let mut chars = statement.chars().peekable();

    while let Some(ch) = chars.next() {
        if escape_next {
            escape_next = false;
            continue;
        }

        match ch {
            '\\' if in_string => escape_next = true,
            '"' => in_string = !in_string,
            '<' if !in_string && chars.peek() == Some(&'<') => {
                // Quoted triple start
                chars.next(); // consume second '<'
                quoted_triple_depth += 1;
            }
            '>' if !in_string && quoted_triple_depth > 0 && chars.peek() == Some(&'>') => {
                // Quoted triple end
                chars.next(); // consume second '>'
                quoted_triple_depth = quoted_triple_depth.saturating_sub(1);
            }
            '{' if !in_string && quoted_triple_depth == 0 => {
                brace_count += 1;
                if !state.in_graph_block {
                    state.parsing_graph_name = false;
                }
            }
            '}' if !in_string && quoted_triple_depth == 0 => {
                brace_count = brace_count.saturating_sub(1);
            }
            '.' if !in_string && quoted_triple_depth == 0 && brace_count == 0 => {
                // Check if this is a period in a number (e.g., 0.9)
                // If the next character is a digit, this is part of a number, not a statement terminator
                if chars.peek().is_some_and(|c| c.is_ascii_digit()) {
                    // This is part of a numeric literal, not a statement terminator
                    continue;
                }
                // Statement ends with a dot and we're not in any nested structure
                return true;
            }
            _ => {}
        }
    }

    // Special handling for graph declarations
    if brace_count > 0 && !state.in_graph_block {
        // We have an opening brace - this is a complete graph declaration start
        return true;
    }

    // Check for complete graph block
    if brace_count == 0 && state.in_graph_block && trimmed.ends_with('}') {
        return true;
    }

    false
}

/// Tokenize a triple pattern into its constituent terms.
///
/// This function splits a triple pattern (subject predicate object) into
/// individual tokens while respecting:
/// - Quoted triple boundaries (`<< ... >>`)
/// - String literal boundaries (`"..."`)
/// - Escape sequences within strings
/// - Whitespace as token separators (only at depth 0)
///
/// # Arguments
///
/// * `pattern` - The triple pattern string to tokenize
///
/// # Returns
///
/// A vector of token strings representing the terms
///
/// # Examples
///
/// ```ignore
/// let tokens = tokenize_triple("ex:alice ex:knows ex:bob")?;
/// assert_eq!(tokens.len(), 3);
/// ```
pub fn tokenize_triple(pattern: &str) -> Result<Vec<String>> {
    let mut tokens = Vec::new();
    let mut current_token = String::new();
    let mut chars = pattern.chars().peekable();
    let mut depth = 0;
    let mut in_string = false;
    let mut escape_next = false;

    while let Some(ch) = chars.next() {
        if escape_next {
            current_token.push(ch);
            escape_next = false;
            continue;
        }

        match ch {
            '\\' if in_string => {
                escape_next = true;
                current_token.push(ch);
            }
            '"' => {
                in_string = !in_string;
                current_token.push(ch);
            }
            '<' if !in_string && chars.peek() == Some(&'<') => {
                // Start of quoted triple
                chars.next(); // consume second '<'
                depth += 1;
                current_token.push_str("<<");
            }
            '>' if !in_string && chars.peek() == Some(&'>') => {
                // End of quoted triple
                chars.next(); // consume second '>'
                depth -= 1;
                current_token.push_str(">>");
            }
            ' ' | '\t' if !in_string && depth == 0 => {
                // Whitespace at top level - end of token
                if !current_token.trim().is_empty() {
                    tokens.push(current_token.trim().to_string());
                    current_token.clear();
                }
            }
            _ => {
                current_token.push(ch);
            }
        }
    }

    // Add final token
    if !current_token.trim().is_empty() {
        tokens.push(current_token.trim().to_string());
    }

    Ok(tokens)
}

/// Tokenize a quad pattern (similar to triple but allows 4 terms).
///
/// This function splits a quad pattern (subject predicate object graph) into
/// individual tokens while respecting the same boundaries as `tokenize_triple`.
///
/// # Arguments
///
/// * `pattern` - The quad pattern string to tokenize
///
/// # Returns
///
/// A vector of token strings representing the terms
///
/// # Examples
///
/// ```ignore
/// let tokens = tokenize_quad("ex:alice ex:knows ex:bob ex:socialGraph")?;
/// assert_eq!(tokens.len(), 4);
/// ```
pub fn tokenize_quad(pattern: &str) -> Result<Vec<String>> {
    let mut tokens = Vec::new();
    let mut current_token = String::new();
    let mut chars = pattern.chars().peekable();
    let mut depth = 0;
    let mut in_string = false;
    let mut escape_next = false;

    while let Some(ch) = chars.next() {
        if escape_next {
            current_token.push(ch);
            escape_next = false;
            continue;
        }

        match ch {
            '\\' if in_string => {
                escape_next = true;
                current_token.push(ch);
            }
            '"' => {
                in_string = !in_string;
                current_token.push(ch);
            }
            '<' if !in_string && chars.peek() == Some(&'<') => {
                // Start of quoted triple
                chars.next(); // consume second '<'
                depth += 1;
                current_token.push_str("<<");
            }
            '>' if !in_string && chars.peek() == Some(&'>') => {
                // End of quoted triple
                chars.next(); // consume second '>'
                depth -= 1;
                current_token.push_str(">>");
            }
            ' ' | '\t' if !in_string && depth == 0 => {
                // Whitespace at top level - end of token
                if !current_token.trim().is_empty() {
                    tokens.push(current_token.trim().to_string());
                    current_token.clear();
                }
            }
            _ => {
                current_token.push(ch);
            }
        }
    }

    // Add final token
    if !current_token.trim().is_empty() {
        tokens.push(current_token.trim().to_string());
    }

    Ok(tokens)
}

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

    #[test]
    fn test_strip_inline_comment() {
        assert_eq!(strip_inline_comment("ex:foo ex:bar ."), "ex:foo ex:bar .");
        assert_eq!(
            strip_inline_comment("ex:foo ex:bar . # comment"),
            "ex:foo ex:bar . "
        );
        assert_eq!(
            strip_inline_comment("ex:foo ex:bar \"value # not a comment\" ."),
            "ex:foo ex:bar \"value # not a comment\" ."
        );
        assert_eq!(
            strip_inline_comment("ex:foo ex:bar \"value\\\" # still in string\" . # comment"),
            "ex:foo ex:bar \"value\\\" # still in string\" . "
        );
    }

    #[test]
    fn test_is_complete_turtle_statement() {
        // Complete statements
        assert!(is_complete_turtle_statement("ex:alice ex:knows ex:bob ."));
        assert!(is_complete_turtle_statement(
            "@prefix ex: <http://example.org/> ."
        ));

        // Incomplete statements
        assert!(!is_complete_turtle_statement("ex:alice ex:knows ex:bob"));
        assert!(!is_complete_turtle_statement(
            "@prefix ex: <http://example.org/>"
        ));

        // Quoted triples
        assert!(is_complete_turtle_statement(
            "<< ex:alice ex:knows ex:bob >> ex:certainty 0.9 ."
        ));
        assert!(!is_complete_turtle_statement(
            "<< ex:alice ex:knows ex:bob >> ex:certainty 0.9"
        ));

        // Annotation blocks
        assert!(is_complete_turtle_statement(
            "ex:alice ex:knows ex:bob {| ex:since 2020 |} ."
        ));
        assert!(!is_complete_turtle_statement(
            "ex:alice ex:knows ex:bob {| ex:since 2020 |}"
        ));
    }

    #[test]
    fn test_tokenize_triple() {
        // Simple triple
        let tokens = tokenize_triple("ex:alice ex:knows ex:bob").unwrap();
        assert_eq!(tokens, vec!["ex:alice", "ex:knows", "ex:bob"]);

        // Triple with quoted triple
        let tokens = tokenize_triple("<< ex:alice ex:knows ex:bob >> ex:certainty 0.9").unwrap();
        assert_eq!(
            tokens,
            vec!["<< ex:alice ex:knows ex:bob >>", "ex:certainty", "0.9"]
        );

        // Triple with literal
        let tokens = tokenize_triple("ex:alice ex:name \"Alice Wonder\"").unwrap();
        assert_eq!(tokens, vec!["ex:alice", "ex:name", "\"Alice Wonder\""]);
    }

    #[test]
    fn test_tokenize_quad() {
        // Simple quad
        let tokens = tokenize_quad("ex:alice ex:knows ex:bob ex:graph1").unwrap();
        assert_eq!(tokens, vec!["ex:alice", "ex:knows", "ex:bob", "ex:graph1"]);

        // Quad with quoted triple
        let tokens =
            tokenize_quad("<< ex:alice ex:knows ex:bob >> ex:certainty 0.9 ex:graph1").unwrap();
        assert_eq!(
            tokens,
            vec![
                "<< ex:alice ex:knows ex:bob >>",
                "ex:certainty",
                "0.9",
                "ex:graph1"
            ]
        );
    }

    #[test]
    fn test_is_complete_trig_statement() {
        let mut state = TrigParserState::new();

        // Complete statements
        assert!(is_complete_trig_statement(
            "ex:alice ex:knows ex:bob .",
            &mut state
        ));
        assert!(is_complete_trig_statement(
            "@prefix ex: <http://example.org/> .",
            &mut state
        ));

        // Graph block opening
        state = TrigParserState::new();
        assert!(is_complete_trig_statement("ex:graph1 {", &mut state));

        // Graph block closing
        state = TrigParserState::new();
        state.in_graph_block = true;
        assert!(is_complete_trig_statement("}", &mut state));

        // Incomplete statements
        state = TrigParserState::new();
        assert!(!is_complete_trig_statement(
            "ex:alice ex:knows ex:bob",
            &mut state
        ));
    }
}