mdka 2.2.0

A HTML to Markdown converter that balances conversion quality with runtime efficiency
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
use std::fmt::Write;

use crate::utils;

#[derive(Debug, Clone)]
pub enum ListKind {
    Unordered,
    Ordered { counter: usize },
}

#[derive(Debug, Clone)]
pub struct ListContext {
    pub kind: ListKind,
}

#[derive(Debug)]
enum InlineCapture {
    Link {
        href: String,
        title: Option<String>,
        buf: String,
    },
    None,
}

pub struct MarkdownRenderer {
    pub output: String,
    pub list_stack: Vec<ListContext>,
    pub blockquote_depth: usize,
    pub newlines_emitted: usize,
    pub in_pre: bool,
    pub pre_lang: Option<String>,
    last_was_space: bool,
    at_line_start: bool,
    inline_capture: InlineCapture,
    capture_depth: usize,
    link_depth: usize,
}

impl MarkdownRenderer {
    pub fn new(capacity: usize) -> Self {
        Self {
            output: String::with_capacity(capacity),
            list_stack: Vec::with_capacity(8),
            blockquote_depth: 0,
            newlines_emitted: 0,
            in_pre: false,
            pre_lang: None,
            last_was_space: false,
            at_line_start: true,
            inline_capture: InlineCapture::None,
            capture_depth: 0,
            link_depth: 0,
        }
    }

    // ─── 改行制御 ──────────────────────────────────────────────────────────

    pub fn ensure_newlines(&mut self, count: usize) {
        // 出力が空のときは先頭に改行を入れない
        // (scraper が補完する <html><body> の begin_block 対策)
        if self.output.is_empty() {
            self.at_line_start = true;
            return;
        }
        while self.newlines_emitted < count {
            self.output.push('\n');
            self.newlines_emitted += 1;
        }
        self.last_was_space = false;
        self.at_line_start = true;
    }

    /// 遅延プレフィックス: コンテンツ書き込み直前に呼ぶ。
    /// 行頭かつ blockquote 内なら "> "×depth を出力してフラグをリセット。
    fn emit_pending_prefix(&mut self) {
        if self.at_line_start && self.blockquote_depth > 0 {
            for _ in 0..self.blockquote_depth {
                self.output.push_str("> ");
            }
            self.at_line_start = false;
        }
    }

    fn begin_block(&mut self) {
        // プレフィックスはここでは出力しない。
        // コンテンツ書き込み時に emit_pending_prefix() が担う。
        self.ensure_newlines(2);
    }

    fn end_block(&mut self) {
        self.ensure_newlines(2);
    }

    // ─── 生文字列プッシュ ──────────────────────────────────────────────────

    pub fn push_raw(&mut self, s: &str) {
        if s.is_empty() {
            return;
        }
        self.output.push_str(s);
        let trailing = s
            .as_bytes()
            .iter()
            .rev()
            .take_while(|&&b| b == b'\n')
            .count();
        if trailing > 0 {
            self.newlines_emitted = trailing;
            self.at_line_start = true;
            self.last_was_space = false;
        } else {
            self.newlines_emitted = 0;
            self.at_line_start = false;
        }
    }

    // ─── テキスト処理 ──────────────────────────────────────────────────────

    pub fn process_text(&mut self, text: &str) {
        if self.in_pre {
            self.push_raw(text);
            return;
        }
        if self.capture_depth > 0 {
            if let InlineCapture::Link { buf, .. } = &mut self.inline_capture {
                let mut _ls = false;
                let mut _al = false;
                utils::write_normalised(text, buf, &mut _ls, false, &mut _al);
            }
            return;
        }
        // 実際のテキストを書く前にプレフィックスを確定させる
        if !text.trim().is_empty() {
            self.emit_pending_prefix();
        }
        let at_block = self.at_line_start;
        utils::write_normalised(
            text,
            &mut self.output,
            &mut self.last_was_space,
            at_block,
            &mut self.at_line_start,
        );
        if !text.trim().is_empty() {
            self.newlines_emitted = 0;
        }
    }

    // ─── アンカー(id 属性) ──────────────────────────────────────────────

    /// `preserve_ids` が有効かつ非空の `id` を持つ要素の「先頭コンテンツ」として
    /// アンカーを出力する。見出しの `# `、リスト項目の `- `、blockquote の `> `
    /// など、要素自身のプレフィックス/マーカーの直後に置くため、この呼び出しは
    /// 通常、各タグの処理(`match tag` 内)の**後**に行う。
    ///
    /// 例外は `a` と `pre`:この2つは自身の処理で `capture_depth` /
    /// `in_pre` を立てるため、後に呼ぶと自分自身の `id` まで「キャプチャ中」
    /// と誤認して抑制してしまう。そのため呼び出し側(`enter_element`)は
    /// この2タグに限り `match tag` の**前**に呼ぶ。祖先から継承した
    /// `capture_depth` / `in_pre`(子孫要素の `id`)は、その時点ですでに
    /// 立っているため、以下のガードで引き続き正しく抑制される。
    ///
    /// リンクキャプチャ中(`capture_depth > 0`)とコードブロック内(`in_pre`)は
    /// 出力先が異なる/内容を改変してはならないため対象外とする。
    fn emit_id_anchor(&mut self, elem: &scraper::node::Element, preserve_ids: bool) {
        if !preserve_ids || self.capture_depth > 0 || self.in_pre {
            return;
        }
        let Some(id) = elem.attr("id") else { return };
        if id.is_empty() {
            return;
        }
        self.emit_pending_prefix();
        self.flush_space();
        let mut anchor = String::with_capacity(id.len() + 10);
        anchor.push_str("<a id=\"");
        for c in id.chars() {
            match c {
                '&' => anchor.push_str("&amp;"),
                '"' => anchor.push_str("&quot;"),
                other => anchor.push(other),
            }
        }
        anchor.push_str("\"></a>");
        self.push_raw(&anchor);
    }

    // ─── 要素 Enter ────────────────────────────────────────────────────────

    pub fn enter_element(&mut self, elem: &scraper::node::Element, preserve_ids: bool) {
        let tag = elem.name();
        // "a"/"pre" は自身の match アームで capture_depth/in_pre を立てる
        // ため、アンカーは先に出す(要素の前に置く旧配置)。他のタグは通常
        // 通り後に出す(要素内の先頭コンテンツとして置く)。
        let anchor_before = matches!(tag, "a" | "pre");
        if anchor_before {
            self.emit_id_anchor(elem, preserve_ids);
        }
        match tag {
            "h1" | "h2" | "h3" | "h4" | "h5" | "h6" => {
                self.begin_block();
                self.emit_pending_prefix();
                let level = (tag.as_bytes()[1] - b'0') as usize;
                for _ in 0..level {
                    self.output.push('#');
                }
                self.output.push(' ');
                self.newlines_emitted = 0;
                self.at_line_start = false;
                self.last_was_space = false;
            }
            "p" | "div" | "article" | "section" | "main" | "header" | "footer" | "nav"
            | "aside" | "figure" | "figcaption" => {
                self.begin_block();
            }
            "ul" => {
                if self.list_stack.is_empty() {
                    self.begin_block();
                }
                self.list_stack.push(ListContext {
                    kind: ListKind::Unordered,
                });
            }
            "ol" => {
                if self.list_stack.is_empty() {
                    self.begin_block();
                }
                let start = elem
                    .attr("start")
                    .and_then(|s| s.parse::<usize>().ok())
                    .unwrap_or(1);
                self.list_stack.push(ListContext {
                    kind: ListKind::Ordered { counter: start },
                });
            }
            "li" => {
                self.ensure_newlines(1);
                self.emit_pending_prefix();
                let depth = self.list_stack.len().saturating_sub(1);
                for _ in 0..depth {
                    self.output.push_str("  ");
                }
                if let Some(ctx) = self.list_stack.last_mut() {
                    match &mut ctx.kind {
                        ListKind::Unordered => self.output.push_str("- "),
                        ListKind::Ordered { counter } => {
                            let n = *counter;
                            *counter += 1;
                            push_usize(&mut self.output, n);
                            self.output.push_str(". ");
                        }
                    }
                }
                self.newlines_emitted = 0;
                self.at_line_start = false;
                self.last_was_space = false;
            }
            "blockquote" => {
                self.begin_block();
                self.blockquote_depth += 1;
                // プレフィックスは次のコンテンツ書き込み時に emit_pending_prefix() が出す
            }
            "pre" => {
                self.begin_block();
                self.emit_pending_prefix();
                // `anchor_before`(下記 §要素 Enter)が `"pre"` を判定基準に
                // 使っている。ここでガード状態を立てる他のタグを追加する場合は
                // `anchor_before` も更新すること — さもないと、その要素自身の
                // `id` のアンカーが自分自身のガードに引っかかって消える
                // (RFC 006 Slice D、過去に "a" と "pre" 自体で二度発生)。
                self.in_pre = true;
                self.pre_lang = None;
            }
            "code" if self.in_pre => {
                let lang = elem
                    .attr("class")
                    .and_then(|cls| utils::extract_code_lang(Some(cls)))
                    .unwrap_or("");
                self.output.push_str("```");
                self.output.push_str(lang);
                self.output.push('\n');
                self.newlines_emitted = 0;
                self.at_line_start = true;
                self.pre_lang = if lang.is_empty() {
                    None
                } else {
                    Some(lang.to_string())
                };
            }
            "code" => {
                self.flush_space();
                self.output.push('`');
                self.newlines_emitted = 0;
                self.at_line_start = false;
            }
            "strong" | "b" => {
                self.flush_space();
                self.output.push_str("**");
                self.newlines_emitted = 0;
                self.at_line_start = false;
            }
            "em" | "i" => {
                self.flush_space();
                self.output.push('*');
                self.newlines_emitted = 0;
                self.at_line_start = false;
            }
            "a" => {
                self.link_depth += 1;
                if self.link_depth == 1 {
                    let href = elem.attr("href").unwrap_or("").to_string();
                    let title = elem.attr("title").map(|t| t.to_string());
                    self.flush_space();
                    self.inline_capture = InlineCapture::Link {
                        href,
                        title,
                        buf: String::new(),
                    };
                    // `anchor_before`(下記 §要素 Enter)が `"a"` を判定基準に
                    // 使っている。ここでガード状態を立てる他のタグを追加する場合は
                    // `anchor_before` も更新すること — さもないと、その要素自身の
                    // `id` のアンカーが自分自身のガードに引っかかって消える
                    // (RFC 006 Slice D、過去に "a" と "pre" 自体で二度発生)。
                    self.capture_depth += 1;
                }
            }
            "img" => {
                let src = elem.attr("src").unwrap_or("");
                let alt = elem.attr("alt").unwrap_or("");
                let title = elem.attr("title");
                self.flush_space();
                self.output.push_str("![");
                self.output.push_str(alt);
                self.output.push_str("](");
                self.output.push_str(src);
                if let Some(t) = title {
                    self.output.push_str(" \"");
                    self.output.push_str(t);
                    self.output.push('"');
                }
                self.output.push(')');
                self.newlines_emitted = 0;
                self.at_line_start = false;
                self.last_was_space = false;
            }
            "hr" => {
                self.begin_block();
                self.emit_pending_prefix();
                self.push_raw("---");
                self.end_block();
            }
            "br" => {
                self.output.push_str("  \n");
                self.newlines_emitted = 1;
                self.at_line_start = true;
                self.last_was_space = false;
                // br 後の行頭プレフィックスは次のコンテンツ書き込み時に出る
            }
            _ => {}
        }
        if !anchor_before {
            self.emit_id_anchor(elem, preserve_ids);
        }
    }

    // ─── 要素 Leave ────────────────────────────────────────────────────────

    pub fn leave_element(&mut self, elem: &scraper::node::Element) {
        let tag = elem.name();
        match tag {
            "h1" | "h2" | "h3" | "h4" | "h5" | "h6" => self.end_block(),
            "p" | "div" | "article" | "section" | "main" | "header" | "footer" | "nav"
            | "aside" | "figure" | "figcaption" => self.end_block(),
            "ul" | "ol" => {
                self.list_stack.pop();
                if self.list_stack.is_empty() {
                    self.end_block();
                }
            }
            "li" => self.ensure_newlines(1),
            "blockquote" => {
                self.blockquote_depth = self.blockquote_depth.saturating_sub(1);
                self.end_block();
            }
            "pre" => {
                if !self.output.ends_with('\n') {
                    self.output.push('\n');
                }
                self.push_raw("```");
                self.in_pre = false;
                self.pre_lang = None;
                self.end_block();
            }
            "code" if !self.in_pre => {
                self.output.push('`');
                self.newlines_emitted = 0;
            }
            "strong" | "b" => {
                self.output.push_str("**");
                self.newlines_emitted = 0;
            }
            "em" | "i" => {
                self.output.push('*');
                self.newlines_emitted = 0;
            }
            "a" => {
                if self.link_depth == 1 {
                    self.capture_depth = self.capture_depth.saturating_sub(1);
                    let captured = std::mem::replace(&mut self.inline_capture, InlineCapture::None);
                    if let InlineCapture::Link { href, title, buf } = captured {
                        self.output.push('[');
                        self.output.push_str(&buf);
                        self.output.push_str("](");
                        self.output.push_str(&href);
                        if let Some(t) = &title {
                            self.output.push_str(" \"");
                            self.output.push_str(t);
                            self.output.push('"');
                        }
                        self.output.push(')');
                        self.newlines_emitted = 0;
                        self.at_line_start = false;
                        self.last_was_space = false;
                    }
                }
                self.link_depth = self.link_depth.saturating_sub(1);
            }
            _ => {}
        }
    }

    fn flush_space(&mut self) {
        if self.last_was_space && !self.at_line_start {
            self.output.push(' ');
            self.last_was_space = false;
        }
    }

    pub fn finish(mut self) -> String {
        // 末尾の空白・改行を除去
        let end = self.output.trim_end().len();
        self.output.truncate(end);
        if !self.output.is_empty() {
            self.output.push('\n');
        }
        self.output
    }
}

/// usize を String へ直接書き込む(`format!` によるアロケーション回避)。
#[inline]
fn push_usize(s: &mut String, n: usize) {
    let _ = write!(s, "{n}");
}