pdfni 0.1.0

Extract tables and Markdown from text-embedded PDFs, with a built-in pure-Rust PDF reader adapted from Mozilla pdf.js.
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
//! PDF構文解析とストリーム切り出し
//!
//! 準拠: pdf.js `parser.js` の Parser・makeStream・#findStreamLength

use crate::error::{Error, Result};

use super::lexer::{Cmd, Lexer, Op, Token};
use super::object::{Dict, Object, Ref, Stream};

/// 間接参照の解決。xref が実装する。/Length が Ref のときに使う
///
/// Ok(None) は未解決(Null 相当)、Err は解決処理自体の失敗
#[allow(dead_code)]
pub(crate) trait Resolver {
    fn resolve(&self, r: Ref) -> Result<Option<Object>>;
}

/// 何も解決しない Resolver(テスト・xref 未接続時用)
#[derive(Debug, Default, Clone, Copy)]
#[allow(dead_code)]
pub(crate) struct NullResolver;

impl Resolver for NullResolver {
    fn resolve(&self, _r: Ref) -> Result<Option<Object>> {
        Ok(None)
    }
}

/// "stream" のバイト長(完全一致判定)
const STREAM_SUFFIX_LEN: usize = 6;

/// dict/array のネスト上限。正当な入力を弾かない上限
const MAX_PARSE_DEPTH: usize = 200;

/// 2トークン先読みの Parser
#[allow(dead_code)]
pub(crate) struct Parser<'a> {
    data: &'a [u8],
    lexer: Lexer<'a>,
    buf1: Token,
    buf2: Token,
    depth: usize,
}

#[allow(dead_code)]
impl<'a> Parser<'a> {
    pub fn new(data: &'a [u8], start: usize) -> Self {
        let mut parser = Self {
            data,
            lexer: Lexer::new_at(data, start),
            buf1: Token::Eof,
            buf2: Token::Eof,
            depth: 0,
        };
        parser.refill();
        parser
    }

    fn refill(&mut self) {
        self.buf1 = self.lexer.next_token();
        self.buf2 = self.lexer.next_token();
    }

    /// 先読みを1つ進め、消費したトークンを返す
    fn shift(&mut self) -> Token {
        let next = self.lexer.next_token();
        std::mem::replace(&mut self.buf1, std::mem::replace(&mut self.buf2, next))
    }

    /// 1オブジェクトを構築する
    pub fn get_obj(&mut self, resolver: &dyn Resolver) -> Result<Object> {
        match self.shift() {
            Token::DictStart => self.parse_dict(resolver),
            Token::ArrayStart => self.parse_array(resolver),
            Token::Int(n) => {
                if let (Token::Int(g), Token::Cmd(Cmd::Op(Op::R))) = (&self.buf1, &self.buf2) {
                    if (0..=i64::from(u32::MAX)).contains(&n) && (0..=i64::from(u16::MAX)).contains(g)
                    {
                        let r = Ref::new(n as u32, *g as u16);
                        self.shift();
                        self.shift();
                        return Ok(Object::Ref(r));
                    }
                }
                Ok(Object::Int(n))
            }
            Token::Real(r) => Ok(Object::Real(r)),
            Token::Str(s) => Ok(Object::Str(s)),
            Token::Name(n) => Ok(Object::Name(n)),
            Token::Cmd(s) => match s {
                Cmd::Op(Op::True) => Ok(Object::Bool(true)),
                Cmd::Op(Op::False) => Ok(Object::Bool(false)),
                Cmd::Op(Op::Null) => Ok(Object::Null),
                // 構造以外のコマンドはオブジェクト値としては Null 扱い
                _ => Ok(Object::Null),
            },
            Token::Eof => Ok(Object::Null),
            // 予期しない区切りなどは読み飛ばし相当で Null
            Token::ArrayEnd | Token::DictEnd | Token::BraceStart | Token::BraceEnd => {
                Ok(Object::Null)
            }
        }
    }

    fn parse_dict(&mut self, resolver: &dyn Resolver) -> Result<Object> {
        if self.depth >= MAX_PARSE_DEPTH {
            return Ok(Object::Null);
        }
        self.depth += 1;
        let result = self.parse_dict_body(resolver);
        self.depth -= 1;
        result
    }

    fn parse_dict_body(&mut self, resolver: &dyn Resolver) -> Result<Object> {
        let mut dict = Dict::new();
        while !matches!(self.buf1, Token::DictEnd | Token::Eof) {
            let key = match self.shift() {
                Token::Name(n) => n,
                // キーが Name でないトークンは読み飛ばして継続
                _ => continue,
            };
            if matches!(self.buf1, Token::Eof) {
                break;
            }
            let value = self.get_obj(resolver)?;
            dict.set(key, value);
        }

        if matches!(self.buf1, Token::Eof) {
            // EOF 到達時は読めた分を返す
            return Ok(Object::Dict(dict));
        }

        // buf1 は DictEnd。直後が stream ならストリーム化
        if matches!(&self.buf2, Token::Cmd(Cmd::Op(Op::Stream))) {
            return self.make_stream(dict, resolver);
        }
        self.shift(); // >>
        Ok(Object::Dict(dict))
    }

    fn parse_array(&mut self, resolver: &dyn Resolver) -> Result<Object> {
        if self.depth >= MAX_PARSE_DEPTH {
            return Ok(Object::Null);
        }
        self.depth += 1;
        let result = self.parse_array_body(resolver);
        self.depth -= 1;
        result
    }

    fn parse_array_body(&mut self, resolver: &dyn Resolver) -> Result<Object> {
        let mut arr = Vec::new();
        while !matches!(self.buf1, Token::ArrayEnd | Token::Eof) {
            arr.push(self.get_obj(resolver)?);
        }
        if !matches!(self.buf1, Token::Eof) {
            self.shift(); // ]
        }
        // EOF 到達時は読めた分を返す
        Ok(Object::Array(arr))
    }

    /// pdf.js makeStream 相当。ストリーム本文のデコードは行わない
    fn make_stream(&mut self, dict: Dict, resolver: &dyn Resolver) -> Result<Object> {
        // buf1 = >> , buf2 = stream。字句位置は stream トークン消費後
        // stream キーワード直後の改行を飛ばし、本文開始位置を得る
        self.lexer.skip_to_next_line();
        let start = self.lexer.byte_pos();

        let mut length = resolve_length(&dict, resolver)?;
        let max_len = self.data.len().saturating_sub(start);
        if length > max_len {
            length = 0;
        }

        let length = if self.is_endstream_at(start + length) {
            length
        } else {
            self.find_stream_length(start).ok_or_else(|| {
                Error::Reader("Missing endstream command.".into())
            })?
        };

        // endstream(または誤植・切詰)の後へ字句位置を進めてバッファを張り直す
        self.lexer.set_pos(start + length);
        let _ = self.lexer.next_token();
        self.refill();

        Ok(Object::Stream(Stream::new(dict, start, length)))
    }

    /// `pos` から空白を飛ばして `endstream` があるか
    fn is_endstream_at(&self, pos: usize) -> bool {
        if pos > self.data.len() {
            return false;
        }
        let mut lex = Lexer::new_at(self.data, pos);
        matches!(lex.next_token(), Token::Cmd(Cmd::Op(Op::EndStream)))
    }

    /// /Length が合わないときの endstream 救済スキャン
    /// 全データがメモリ上にあるためブロック分割はせず末尾まで走査する
    fn find_stream_length(&self, start_pos: usize) -> Option<usize> {
        let data = self.data;
        // 後続候補: stream(正常)/ steam(誤植)/ strea(切詰)
        const PARTIALS: &[&[u8]] = &[b"stream", b"steam", b"strea"];

        if data.len() < start_pos + 3 {
            return None;
        }
        for i in start_pos..=data.len() - 3 {
            if !data[i..].starts_with(b"end") {
                continue;
            }
            let rest = &data[i + 3..];
            for part in PARTIALS {
                let k = rest.iter().zip(*part).take_while(|(a, b)| a == b).count();
                if k >= STREAM_SUFFIX_LEN {
                    // endstream
                    return Some(i - start_pos);
                }
                if k == part.len() {
                    // endsteam / endstrea。直後が空白なら採用
                    if rest.get(k).copied().is_some_and(is_endstream_whitespace) {
                        return Some(i - start_pos);
                    }
                    break;
                }
            }
        }
        None
    }
}

fn is_endstream_whitespace(b: u8) -> bool {
    matches!(b, 0x20 | 0x09 | 0x0d | 0x0a)
}

/// /Length を解決する。非整数・未解決は 0
fn resolve_length(dict: &Dict, resolver: &dyn Resolver) -> Result<usize> {
    Ok(match dict.get("Length") {
        Some(Object::Int(n)) if *n >= 0 => *n as usize,
        Some(Object::Ref(r)) => match resolver.resolve(*r)? {
            Some(Object::Int(n)) if n >= 0 => n as usize,
            _ => 0,
        },
        _ => 0,
    })
}

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

    fn parse(input: &[u8]) -> Object {
        let mut p = Parser::new(input, 0);
        p.get_obj(&NullResolver).expect("parse")
    }

    fn parse_with(input: &[u8], resolver: &dyn Resolver) -> Object {
        let mut p = Parser::new(input, 0);
        p.get_obj(resolver).expect("parse")
    }

    #[test]
    fn dict_basic() {
        let obj = parse(b"<< /Type /Page /Count 3 >>");
        let Object::Dict(d) = obj else {
            panic!("expected Dict");
        };
        assert!(matches!(d.get("Type"), Some(Object::Name(n)) if n == "Page"));
        assert!(matches!(d.get("Count"), Some(Object::Int(3))));
    }

    #[test]
    fn array_basic() {
        let obj = parse(b"[1 2 /Foo (bar)]");
        let Object::Array(a) = obj else {
            panic!("expected Array");
        };
        assert_eq!(a.len(), 4);
        assert!(matches!(a[0], Object::Int(1)));
        assert!(matches!(a[1], Object::Int(2)));
        assert!(matches!(&a[2], Object::Name(n) if n == "Foo"));
        assert!(matches!(&a[3], Object::Str(s) if s == b"bar"));
    }

    #[test]
    fn nested_dict_and_array() {
        let obj = parse(b"<< /Kids [1 0 R 2 0 R] /MediaBox [0 0 612 792] >>");
        let Object::Dict(d) = obj else {
            panic!("expected Dict");
        };
        let Object::Array(kids) = d.get("Kids").unwrap() else {
            panic!("expected Kids array");
        };
        assert_eq!(kids.len(), 2);
        assert!(matches!(
            kids[0],
            Object::Ref(Ref {
                num: 1,
                generation: 0
            })
        ));
        assert!(matches!(
            kids[1],
            Object::Ref(Ref {
                num: 2,
                generation: 0
            })
        ));
        let Object::Array(mb) = d.get("MediaBox").unwrap() else {
            panic!("expected MediaBox array");
        };
        assert_eq!(mb.len(), 4);
    }

    #[test]
    fn indirect_ref() {
        let obj = parse(b"1 0 R");
        assert!(matches!(
            obj,
            Object::Ref(Ref {
                num: 1,
                generation: 0
            })
        ));
    }

    #[test]
    fn ref_inside_dict() {
        let obj = parse(b"<< /Parent 3 0 R /Type /Pages >>");
        let Object::Dict(d) = obj else {
            panic!("expected Dict");
        };
        assert!(matches!(
            d.get("Parent"),
            Some(Object::Ref(Ref {
                num: 3,
                generation: 0
            }))
        ));
    }

    #[test]
    fn non_name_dict_key_skipped() {
        // キー位置に整数が来たら読み飛ばし、続く /Type /Page は通常どおり
        let obj = parse(b"<< 42 /Type /Page >>");
        let Object::Dict(d) = obj else {
            panic!("expected Dict");
        };
        assert!(matches!(d.get("Type"), Some(Object::Name(n)) if n == "Page"));
        // 42 をキーとして飛ばしたあと /Type が値側に回る可能性もあるが、
        // pdf.js 同様「キーが Name でないトークンを1つ捨てて継続」する
        // 入力 `42 /Type /Page` では 42 を捨て → /Type がキー、/Page が値
        assert_eq!(d.len(), 1);
    }

    #[test]
    fn array_eof_returns_partial() {
        let obj = parse(b"[1 2 3");
        let Object::Array(a) = obj else {
            panic!("expected Array");
        };
        assert_eq!(a.len(), 3);
        assert!(matches!(a[2], Object::Int(3)));
    }

    #[test]
    fn bool_and_null() {
        let obj = parse(b"[true false null]");
        let Object::Array(a) = obj else {
            panic!("expected Array");
        };
        assert!(matches!(a[0], Object::Bool(true)));
        assert!(matches!(a[1], Object::Bool(false)));
        assert!(matches!(a[2], Object::Null));
    }

    #[test]
    fn stream_with_correct_length() {
        // stream\n + "hello" (5) + \nendstream
        let input = b"<< /Length 5 >>\nstream\nhello\nendstream";
        let obj = parse(input);
        let Object::Stream(s) = obj else {
            panic!("expected Stream, got {obj:?}");
        };
        assert_eq!(s.length, 5);
        assert_eq!(&input[s.start..s.start + s.length], b"hello");
        assert!(matches!(s.dict.get("Length"), Some(Object::Int(5))));
    }

    #[test]
    fn stream_with_crlf_after_stream_keyword() {
        let input = b"<< /Length 3 >>\r\nstream\r\nabc\r\nendstream";
        let obj = parse(input);
        let Object::Stream(s) = obj else {
            panic!("expected Stream, got {obj:?}");
        };
        assert_eq!(s.length, 3);
        assert_eq!(&input[s.start..s.start + s.length], b"abc");
    }

    #[test]
    fn stream_length_wrong_endstream_recovery() {
        // Length は 2 だが本文は "abcdef" (6)
        let input = b"<< /Length 2 >>\nstream\nabcdef\nendstream";
        let obj = parse(input);
        let Object::Stream(s) = obj else {
            panic!("expected Stream, got {obj:?}");
        };
        assert_eq!(&input[s.start..s.start + s.length], b"abcdef\n");
        // endstream の直前まで(改行を含む)
        assert!(
            input[s.start + s.length..].starts_with(b"endstream"),
            "endstream should follow stream data"
        );
    }

    #[test]
    fn stream_length_wrong_steam_recovery() {
        // 誤植 endsteam
        let input = b"<< /Length 0 >>\nstream\nXY\nendsteam\n";
        let obj = parse(input);
        let Object::Stream(s) = obj else {
            panic!("expected Stream, got {obj:?}");
        };
        assert_eq!(&input[s.start..s.start + s.length], b"XY\n");
        assert!(input[s.start + s.length..].starts_with(b"endsteam"));
    }

    #[test]
    fn stream_length_wrong_strea_recovery() {
        // 切詰 endstrea
        let input = b"<< /Length 99 >>\nstream\nZ\nendstrea\n";
        let obj = parse(input);
        let Object::Stream(s) = obj else {
            panic!("expected Stream, got {obj:?}");
        };
        assert_eq!(&input[s.start..s.start + s.length], b"Z\n");
        assert!(input[s.start + s.length..].starts_with(b"endstrea"));
    }

    /// /Length が間接参照のときのテスト用 Resolver
    struct MapResolver {
        num: u32,
        value: i64,
    }

    impl Resolver for MapResolver {
        fn resolve(&self, r: Ref) -> Result<Option<Object>> {
            if r.num == self.num {
                Ok(Some(Object::Int(self.value)))
            } else {
                Ok(None)
            }
        }
    }

    #[test]
    fn stream_length_indirect_ref() {
        let input = b"<< /Length 10 0 R >>\nstream\nhello\nendstream";
        let resolver = MapResolver {
            num: 10,
            value: 5,
        };
        let obj = parse_with(input, &resolver);
        let Object::Stream(s) = obj else {
            panic!("expected Stream, got {obj:?}");
        };
        assert_eq!(s.length, 5);
        assert_eq!(&input[s.start..s.start + s.length], b"hello");
    }

    #[test]
    fn stream_length_indirect_unresolved_falls_back_to_scan() {
        // NullResolver では Length Ref が解決できず 0 扱い → 救済スキャン
        let input = b"<< /Length 10 0 R >>\nstream\nhello\nendstream";
        let obj = parse(input);
        let Object::Stream(s) = obj else {
            panic!("expected Stream, got {obj:?}");
        };
        assert_eq!(&input[s.start..s.start + s.length], b"hello\n");
    }

    #[test]
    fn stream_missing_endstream_errors() {
        let input = b"<< /Length 5 >>\nstream\nhello";
        let mut p = Parser::new(input, 0);
        let err = p.get_obj(&NullResolver).unwrap_err();
        let msg = format!("{err}");
        assert!(
            msg.contains("endstream") || msg.contains("Missing"),
            "unexpected error: {msg}"
        );
    }

    #[test]
    fn parser_start_offset() {
        let input = b"garbage << /A 1 >>";
        let mut p = Parser::new(input, 8); // at '<<'
        let obj = p.get_obj(&NullResolver).unwrap();
        let Object::Dict(d) = obj else {
            panic!("expected Dict");
        };
        assert!(matches!(d.get("A"), Some(Object::Int(1))));
    }
}