fast_h2m 0.4.2

High-performance HTML to Markdown converter
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

//! Semantic HTML5 element handlers for HTML to Markdown conversion.
//!
//! This module provides specialized handlers for semantic HTML5 elements:
//! - Sectioning elements (article, section, nav, aside, header, footer, main)
//! - Figure elements (figure, figcaption)
//! - Interactive elements (details, summary, dialog)
//! - Semantic inline attributes (cite, q, abbr, dfn, time, data)
//!
//! These handlers are designed to be extracted from the main `converter.rs`
//! file and integrated through the dispatcher function.
//!
//! **Integration Pattern:**
//! Each handler function takes the same signature:
//! - `tag_name: &str` - The HTML tag being processed
//! - `node_handle: &NodeHandle` - The DOM node handle
//! - `parser: &Parser` - The HTML parser reference
//! - `output: &mut String` - The output buffer to write to
//! - `options: &ConversionOptions` - Conversion configuration
//! - `ctx: &Context` - Processing context (state tracking)
//! - `depth: usize` - Current DOM tree depth
//! - `dom_ctx: &DomContext` - DOM context for tree relationships
//!
//! The main dispatcher function `dispatch_semantic_handler` routes tags to
//! their appropriate handlers and returns a boolean indicating success.

pub mod attributes;
pub mod definition_list;
pub mod figure;
pub mod sectioning;
pub mod summary;

// Re-export types from parent module for submodule access
pub use super::walk_node;
pub use super::{Context, DomContext};

// Re-export handler functions for direct use
pub use attributes::handle as handle_attributes;
pub use definition_list::handle as handle_definition_list;
pub use figure::handle as handle_figure;
pub use sectioning::handle as handle_sectioning;
pub use summary::handle as handle_summary;

// Re-exports are done via the dispatch function parameter types

/// Dispatches semantic element handling to the appropriate handler.
///
/// This function routes semantic HTML5 elements to their specialized handlers
/// based on tag name. It is designed to be called from the main `walk_node`
/// function in `converter.rs`.
///
/// # Routing Table
///
/// The following tag routes are supported:
/// - **Sectioning**: article, section, nav, aside, header, footer, main
/// - **Figure**: figure, figcaption
/// - **Summary**: details, summary, dialog
/// - **Definition List**: hgroup, dl, dt, dd, menu
/// - **Attributes**: cite, q, abbr, dfn, time, data
///
/// # Returns
///
/// Returns `true` if the tag was successfully handled by a semantic handler,
/// `false` if the tag is not a semantic element and requires other handling.
///
/// # Example
///
/// ```text
/// if dispatch_semantic_handler(tag_name, &node_handle, &parser, output, options, ctx, depth, dom_ctx) {
///     // Tag was handled
/// } else {
///     // Continue with other handlers
/// }
/// ```
pub fn dispatch_semantic_handler(
    tag_name: &str,
    node_handle: &tl::NodeHandle,
    parser: &crate::tl_types::Parser,
    output: &mut String,
    options: &crate::options::ConversionOptions,
    ctx: &super::Context,
    depth: usize,
    dom_ctx: &super::DomContext,
) -> bool {
    match tag_name {
        // Sectioning elements
        "article" | "section" | "nav" | "aside" | "header" | "footer" | "main" => {
            handle_sectioning(
                tag_name,
                node_handle,
                parser,
                output,
                options,
                ctx,
                depth,
                dom_ctx,
            );
            true
        }
        // Figure elements
        "figure" | "figcaption" => {
            handle_figure(
                tag_name,
                node_handle,
                parser,
                output,
                options,
                ctx,
                depth,
                dom_ctx,
            );
            true
        }
        // Summary and interactive elements
        "details" | "summary" | "dialog" => {
            handle_summary(
                tag_name,
                node_handle,
                parser,
                output,
                options,
                ctx,
                depth,
                dom_ctx,
            );
            true
        }
        // Definition list and related elements
        "hgroup" | "dl" | "dt" | "dd" | "menu" => {
            handle_definition_list(
                tag_name,
                node_handle,
                parser,
                output,
                options,
                ctx,
                depth,
                dom_ctx,
            );
            true
        }
        // Semantic inline attributes
        "cite" | "q" | "abbr" | "dfn" | "time" | "data" => {
            handle_attributes(
                tag_name,
                node_handle,
                parser,
                output,
                options,
                ctx,
                depth,
                dom_ctx,
            );
            true
        }
        _ => false,
    }
}