use regex::Regex;
use std::borrow::Cow;
use std::sync::LazyLock;
pub const HTML_TAG_NAME_PATTERN: &str = "[A-Za-z][A-Za-z0-9-]*";
pub const HTML_TAG_ATTRIBUTES_PATTERN: &str = r#"(?:\s+[^\s"'>/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s"'=<>`]+))?)*"#;
pub static HTML_OPEN_TAG: LazyLock<Regex> = LazyLock::new(|| {
Regex::new(&format!(
r"<({HTML_TAG_NAME_PATTERN}){HTML_TAG_ATTRIBUTES_PATTERN}\s*/?>"
))
.unwrap()
});
pub const HTML_BLOCK_TAG_NAME_PATTERN: &str = r"[A-Za-z][^\s/>]*";
pub static HTML_BLOCK_OPEN_TAG: LazyLock<Regex> = LazyLock::new(|| {
Regex::new(&format!(
r"<({HTML_BLOCK_TAG_NAME_PATTERN}){HTML_TAG_ATTRIBUTES_PATTERN}\s*/?>"
))
.unwrap()
});
static HTML_ANCHOR_CLOSING_TAG: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"(?i)^\s*</a\s*>").unwrap());
static HEADER_ID_PATTERN: LazyLock<Regex> =
LazyLock::new(|| Regex::new(r"\s*\{\s*:?\s*([^}]*?#[^}]*?)\s*\}\s*$").unwrap());
static ID_VALIDATE_PATTERN: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"^[a-zA-Z0-9_\-:]+$").unwrap());
static STANDALONE_ATTR_LIST_PATTERN: LazyLock<Regex> =
LazyLock::new(|| Regex::new(r"^\s*\{\s*:?\s*([^}]*#[a-zA-Z0-9_\-:]+[^}]*)\s*\}\s*$").unwrap());
pub fn extract_header_id(line: &str) -> (String, Option<String>) {
let line = strip_html_anchor_elements(line);
let line = line.as_ref();
if let Some(captures) = HEADER_ID_PATTERN.captures(line)
&& let Some(full_match) = captures.get(0)
&& let Some(attr_content) = captures.get(1)
{
let attr_str = attr_content.as_str().trim();
if let Some(hash_pos) = attr_str.find('#') {
let after_hash = &attr_str[hash_pos + 1..];
let is_simple_format = !attr_str.contains(' ') && !attr_str.contains('=') && attr_str.starts_with('#');
if is_simple_format {
let potential_id = after_hash;
if ID_VALIDATE_PATTERN.is_match(potential_id) && !potential_id.is_empty() {
let clean_text = line[..full_match.start()].trim_end().to_string();
return (clean_text, Some(potential_id.to_string()));
}
} else {
if let Some(delimiter_pos) = after_hash.find(|c: char| c.is_whitespace() || c == '.' || c == '=') {
let potential_id = &after_hash[..delimiter_pos];
if ID_VALIDATE_PATTERN.is_match(potential_id) && !potential_id.is_empty() {
let clean_text = line[..full_match.start()].trim_end().to_string();
return (clean_text, Some(potential_id.to_string()));
}
} else {
let potential_id = after_hash;
if ID_VALIDATE_PATTERN.is_match(potential_id) && !potential_id.is_empty() {
let clean_text = line[..full_match.start()].trim_end().to_string();
return (clean_text, Some(potential_id.to_string()));
}
}
}
}
}
(line.to_string(), None)
}
fn strip_html_anchor_elements(text: &str) -> Cow<'_, str> {
let anchors = empty_anchor_elements(text);
if anchors.is_empty() {
return Cow::Borrowed(text);
}
let mut stripped = String::with_capacity(text.len());
let mut copied_up_to = 0;
for (range, _) in anchors {
stripped.push_str(&text[copied_up_to..range.start]);
copied_up_to = range.end;
}
stripped.push_str(&text[copied_up_to..]);
Cow::Owned(stripped.trim().to_string())
}
pub fn extract_html_anchor_ids(text: &str) -> Vec<String> {
empty_anchor_elements(text)
.into_iter()
.filter_map(|(_, open_tag)| html_tag_attribute(open_tag, "id").or_else(|| html_tag_attribute(open_tag, "name")))
.map(str::to_string)
.collect()
}
fn empty_anchor_elements(text: &str) -> Vec<(std::ops::Range<usize>, &str)> {
if !text.contains('<') {
return Vec::new();
}
let opaque = opaque_ranges(text);
let mut anchors = Vec::new();
let mut pos = 0;
while let Some(tag) = HTML_OPEN_TAG.captures_at(text, pos) {
let open_tag = tag.get(0).unwrap();
if is_within(&opaque, open_tag.start()) || is_backslash_escaped(text, open_tag.start()) {
pos = open_tag.start() + 1;
continue;
}
pos = open_tag.end();
if !tag[1].eq_ignore_ascii_case("a") {
continue;
}
if let Some(closing_tag) = HTML_ANCHOR_CLOSING_TAG.find(&text[open_tag.end()..]) {
pos = open_tag.end() + closing_tag.end();
anchors.push((open_tag.start()..pos, open_tag.as_str()));
}
}
anchors
}
fn opaque_ranges(text: &str) -> Vec<(usize, usize)> {
let bytes = text.as_bytes();
let mut ranges = Vec::new();
let mut pos = 0;
while pos < bytes.len() {
if bytes[pos] == b'`' {
let run_end = pos + bytes[pos..].iter().take_while(|&&b| b == b'`').count();
let run_len = run_end - pos;
match closing_backtick_run(bytes, run_end, run_len) {
Some(close_start) => {
ranges.push((pos, close_start + run_len));
pos = close_start + run_len;
}
None => pos = run_end,
}
} else if bytes[pos..].starts_with(b"<!--") {
let end = text[pos + 2..]
.find("-->")
.map_or(bytes.len(), |offset| pos + 2 + offset + 3);
ranges.push((pos, end));
pos = end;
} else {
pos += 1;
}
}
ranges
}
fn closing_backtick_run(bytes: &[u8], from: usize, run_len: usize) -> Option<usize> {
let mut pos = from;
while pos < bytes.len() {
if bytes[pos] != b'`' {
pos += 1;
continue;
}
let run_end = pos + bytes[pos..].iter().take_while(|&&b| b == b'`').count();
if run_end - pos == run_len {
return Some(pos);
}
pos = run_end;
}
None
}
fn is_within(ranges: &[(usize, usize)], pos: usize) -> bool {
ranges.iter().any(|&(start, end)| start <= pos && pos < end)
}
pub fn is_backslash_escaped(text: &str, pos: usize) -> bool {
text.as_bytes()[..pos].iter().rev().take_while(|&&b| b == b'\\').count() % 2 == 1
}
pub fn html_tag_attribute<'a>(tag: &'a str, name: &str) -> Option<&'a str> {
let bytes = tag.as_bytes();
if bytes.first() != Some(&b'<') {
return None;
}
let ends_name = |b: u8| b.is_ascii_whitespace() || matches!(b, b'=' | b'>' | b'/');
let mut pos = 1 + bytes[1..].iter().take_while(|&&b| !ends_name(b)).count();
loop {
pos += bytes[pos..].iter().take_while(|b| b.is_ascii_whitespace()).count();
if pos >= bytes.len() || matches!(bytes[pos], b'>' | b'/') {
return None;
}
let name_start = pos;
pos += bytes[pos..].iter().take_while(|&&b| !ends_name(b)).count();
let attribute = &tag[name_start..pos];
let after_name = pos + bytes[pos..].iter().take_while(|b| b.is_ascii_whitespace()).count();
let value = if bytes.get(after_name) == Some(&b'=') {
let value_start = after_name
+ 1
+ bytes[after_name + 1..]
.iter()
.take_while(|b| b.is_ascii_whitespace())
.count();
match bytes.get(value_start) {
Some("e @ (b'"' | b'\'')) => {
let value_end = value_start + 1 + tag[value_start + 1..].find(quote as char)?;
pos = value_end + 1;
&tag[value_start + 1..value_end]
}
_ => {
let value_end = value_start
+ bytes[value_start..]
.iter()
.take_while(|&&b| !b.is_ascii_whitespace() && b != b'>')
.count();
pos = value_end;
&tag[value_start..value_end]
}
}
} else {
""
};
if attribute.eq_ignore_ascii_case(name) {
return (!value.is_empty()).then_some(value);
}
}
}
pub fn is_standalone_attr_list(line: &str) -> bool {
STANDALONE_ATTR_LIST_PATTERN.is_match(line)
}
pub fn extract_standalone_attr_list_id(line: &str) -> Option<String> {
if let Some(captures) = STANDALONE_ATTR_LIST_PATTERN.captures(line)
&& let Some(attr_content) = captures.get(1)
{
let attr_str = attr_content.as_str().trim();
if let Some(hash_pos) = attr_str.find('#') {
let after_hash = &attr_str[hash_pos + 1..];
let is_simple_format = !attr_str.contains(' ') && !attr_str.contains('=') && attr_str.starts_with('#');
if is_simple_format {
let potential_id = after_hash;
if ID_VALIDATE_PATTERN.is_match(potential_id) && !potential_id.is_empty() {
return Some(potential_id.to_string());
}
} else {
if let Some(delimiter_pos) = after_hash.find(|c: char| c.is_whitespace() || c == '.' || c == '=') {
let potential_id = &after_hash[..delimiter_pos];
if ID_VALIDATE_PATTERN.is_match(potential_id) && !potential_id.is_empty() {
return Some(potential_id.to_string());
}
} else {
let potential_id = after_hash;
if ID_VALIDATE_PATTERN.is_match(potential_id) && !potential_id.is_empty() {
return Some(potential_id.to_string());
}
}
}
}
}
None
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_kramdown_format_extraction() {
let (text, id) = extract_header_id("# Header {#simple}");
assert_eq!(text, "# Header");
assert_eq!(id, Some("simple".to_string()));
let (text, id) = extract_header_id("## Section {#section-id}");
assert_eq!(text, "## Section");
assert_eq!(id, Some("section-id".to_string()));
}
#[test]
fn test_python_markdown_attr_list_extraction() {
let (text, id) = extract_header_id("# Header {:#colon-id}");
assert_eq!(text, "# Header");
assert_eq!(id, Some("colon-id".to_string()));
let (text, id) = extract_header_id("# Header {: #spaced-id }");
assert_eq!(text, "# Header");
assert_eq!(id, Some("spaced-id".to_string()));
}
#[test]
fn test_extended_attr_list_extraction() {
let (text, id) = extract_header_id("# Header {: #with-class .highlight }");
assert_eq!(text, "# Header");
assert_eq!(id, Some("with-class".to_string()));
let (text, id) = extract_header_id("## Section {: #multi .class1 .class2 }");
assert_eq!(text, "## Section");
assert_eq!(id, Some("multi".to_string()));
let (text, id) = extract_header_id("### Subsection {: #with-attrs data-test=\"value\" style=\"color: red\" }");
assert_eq!(text, "### Subsection");
assert_eq!(id, Some("with-attrs".to_string()));
let (text, id) = extract_header_id("#### Complex {: #complex .highlight data-role=\"button\" title=\"Test\" }");
assert_eq!(text, "#### Complex");
assert_eq!(id, Some("complex".to_string()));
let (text, id) = extract_header_id("##### Quotes {: #quotes title=\"Has \\\"nested\\\" quotes\" }");
assert_eq!(text, "##### Quotes");
assert_eq!(id, Some("quotes".to_string()));
}
#[test]
fn test_attr_list_detection_edge_cases() {
let (text, id) = extract_header_id("# Header {: .class-only }");
assert_eq!(text, "# Header {: .class-only }");
assert_eq!(id, None);
let (text, id) = extract_header_id("# Header { no-hash }");
assert_eq!(text, "# Header { no-hash }");
assert_eq!(id, None);
let (text, id) = extract_header_id("# Header {: # }");
assert_eq!(text, "# Header {: # }");
assert_eq!(id, None);
let (text, id) = extract_header_id("# Header {: #middle } with more text");
assert_eq!(text, "# Header {: #middle } with more text");
assert_eq!(id, None);
}
#[test]
fn test_standalone_attr_list_detection() {
assert!(is_standalone_attr_list("{#custom-id}"));
assert!(is_standalone_attr_list("{ #spaced-id }"));
assert!(is_standalone_attr_list("{:#colon-id}"));
assert!(is_standalone_attr_list("{: #full-format }"));
assert!(is_standalone_attr_list("{: #with-class .highlight }"));
assert!(is_standalone_attr_list("{: #multi .class1 .class2 }"));
assert!(is_standalone_attr_list("{: #complex .highlight data-test=\"value\" }"));
assert!(!is_standalone_attr_list("Some text {#not-standalone}"));
assert!(!is_standalone_attr_list("Text before {#id}"));
assert!(!is_standalone_attr_list("{#id} text after"));
assert!(!is_standalone_attr_list(""));
assert!(!is_standalone_attr_list(" ")); assert!(!is_standalone_attr_list("{: .class-only }")); }
#[test]
fn test_standalone_attr_list_id_extraction() {
assert_eq!(extract_standalone_attr_list_id("{#simple}"), Some("simple".to_string()));
assert_eq!(
extract_standalone_attr_list_id("{ #spaced }"),
Some("spaced".to_string())
);
assert_eq!(extract_standalone_attr_list_id("{:#colon}"), Some("colon".to_string()));
assert_eq!(extract_standalone_attr_list_id("{: #full }"), Some("full".to_string()));
assert_eq!(
extract_standalone_attr_list_id("{: #with-class .highlight }"),
Some("with-class".to_string())
);
assert_eq!(
extract_standalone_attr_list_id("{: #complex .class1 .class2 data=\"value\" }"),
Some("complex".to_string())
);
assert_eq!(extract_standalone_attr_list_id("Not an attr-list"), None);
assert_eq!(extract_standalone_attr_list_id("Text {#not-standalone}"), None);
assert_eq!(extract_standalone_attr_list_id("{: .class-only }"), None);
assert_eq!(extract_standalone_attr_list_id(""), None);
}
#[test]
fn test_backward_compatibility() {
let test_cases = vec![
("# Header {#a}", "# Header", Some("a".to_string())),
("# Header {#simple-id}", "# Header", Some("simple-id".to_string())),
("## Heading {#heading-2}", "## Heading", Some("heading-2".to_string())),
(
"### With-Hyphens {#with-hyphens}",
"### With-Hyphens",
Some("with-hyphens".to_string()),
),
];
for (input, expected_text, expected_id) in test_cases {
let (text, id) = extract_header_id(input);
assert_eq!(text, expected_text, "Text mismatch for input: {input}");
assert_eq!(id, expected_id, "ID mismatch for input: {input}");
}
}
#[test]
fn test_invalid_id_with_dots() {
let (text, id) = extract_header_id("## Another. {#id.with.dots}");
assert_eq!(text, "## Another. {#id.with.dots}"); assert_eq!(id, None);
let (text, id) = extract_header_id("## Another. {#id.more.dots}");
assert_eq!(text, "## Another. {#id.more.dots}");
assert_eq!(id, None);
}
#[test]
fn test_html_anchor_stripping() {
let (text, id) = extract_header_id("<a name=\"cheatsheets\"></a>Cheat Sheets");
assert_eq!(text, "Cheat Sheets");
assert_eq!(id, None);
let (text, id) = extract_header_id("<a id=\"tools\"></a>Tools and session management");
assert_eq!(text, "Tools and session management");
assert_eq!(id, None);
let (text, id) = extract_header_id("<a name=\"foo\"></a> Heading with space");
assert_eq!(text, "Heading with space");
assert_eq!(id, None);
let (text, id) = extract_header_id("<a name=\"old\"></a>My Section {#my-custom-id}");
assert_eq!(text, "My Section");
assert_eq!(id, Some("my-custom-id".to_string()));
}
#[test]
fn test_html_anchor_ids_are_read_from_empty_anchor_elements_in_order() {
assert_eq!(extract_html_anchor_ids(r#"Heading<a id="target"></a>"#), ["target"]);
assert_eq!(
extract_html_anchor_ids(r#"<A class="legacy" NAME='fallback' ID='preferred'></A>Heading"#),
["preferred"]
);
assert_eq!(
extract_html_anchor_ids(r#"<a name='legacy'></a><a id="newer"></a>Heading"#),
["legacy", "newer"]
);
assert_eq!(extract_html_anchor_ids("<a id=plain></a>Heading"), ["plain"]);
assert!(extract_html_anchor_ids(r##"<a href="#target"></a>Heading"##).is_empty());
assert!(extract_html_anchor_ids(r#"<span id="target"></span>Heading"#).is_empty());
assert!(extract_html_anchor_ids(r#"<a id="target">text</a>Heading"#).is_empty());
}
#[test]
fn test_an_attribute_merely_ending_in_id_or_name_is_not_an_anchor() {
assert!(extract_html_anchor_ids(r#"Foo<a data-id="tracking" data-name="pixel"></a>"#).is_empty());
assert!(extract_html_anchor_ids(r#"Foo<a id=""></a>"#).is_empty());
}
#[test]
fn test_a_quoted_attribute_value_may_contain_a_closing_angle_bracket() {
let raw = r#"<a title="a > b" id="target"></a>Heading"#;
assert_eq!(extract_html_anchor_ids(raw), ["target"]);
assert_eq!(extract_header_id(raw), ("Heading".to_string(), None));
}
#[test]
fn test_anchor_markup_inside_a_code_span_is_heading_text() {
let raw = "Showing `<a id=\"literal\"></a>` syntax";
assert!(extract_html_anchor_ids(raw).is_empty());
assert_eq!(extract_header_id(raw), (raw.to_string(), None));
let raw = "Showing `<a id=\"literal\"></a>` syntax<a id=\"real\"></a>";
assert_eq!(extract_html_anchor_ids(raw), ["real"]);
assert_eq!(extract_header_id(raw).0, "Showing `<a id=\"literal\"></a>` syntax");
}
#[test]
fn test_anchor_markup_inside_an_html_comment_is_not_a_target() {
let raw = "Foo <!-- <a id=\"hidden\"></a> -->";
assert!(extract_html_anchor_ids(raw).is_empty());
assert_eq!(extract_header_id(raw), (raw.to_string(), None));
}
#[test]
fn test_html_tag_attribute_matches_whole_names_case_insensitively() {
assert_eq!(html_tag_attribute(r#"<div data-id="x" ID="y">"#, "id"), Some("y"));
assert_eq!(html_tag_attribute("<a name = 'legacy' >", "name"), Some("legacy"));
assert_eq!(html_tag_attribute("<a id=plain>", "id"), Some("plain"));
assert_eq!(html_tag_attribute(r#"<a id="first" id="second">"#, "id"), Some("first"));
assert_eq!(html_tag_attribute(r#"<a id="">"#, "id"), None);
assert_eq!(html_tag_attribute(r#"<a hidden id="x">"#, "hidden"), None);
assert_eq!(html_tag_attribute(r#"<a hidden id="x">"#, "id"), Some("x"));
assert_eq!(html_tag_attribute(r#"<a title="a > b" id="x">"#, "id"), Some("x"));
assert_eq!(html_tag_attribute(r#"<video title="id=fake">"#, "id"), None);
assert_eq!(html_tag_attribute("<br/>", "id"), None);
}
#[test]
fn test_html_anchor_stripping_handles_attribute_variations() {
let (text, id) = extract_header_id(r#"<A class="legacy" ID='target'></A>Heading"#);
assert_eq!(text, "Heading");
assert_eq!(id, None);
}
#[test]
fn test_a_backslash_escaped_anchor_element_is_heading_text() {
let raw = r#"Show \<a id="example"></a> syntax"#;
assert!(extract_html_anchor_ids(raw).is_empty());
assert_eq!(extract_header_id(raw), (raw.to_string(), None));
let raw = r#"Show \\<a id="example"></a> syntax"#;
assert_eq!(extract_html_anchor_ids(raw), ["example"]);
assert_eq!(extract_header_id(raw).0, r"Show \\ syntax");
}
#[test]
fn test_stripping_an_anchor_element_keeps_the_whitespace_beside_it() {
assert_eq!(extract_header_id(r#"Foo<a id="alias"></a> Bar"#).0, "Foo Bar");
assert_eq!(extract_header_id(r#"Foo <a id="alias"></a>Bar"#).0, "Foo Bar");
assert_eq!(extract_header_id(r#"<a id="alias"></a> Foo"#).0, "Foo");
assert_eq!(extract_header_id(r#"Foo <a id="alias"></a>"#).0, "Foo");
}
#[test]
fn test_an_anchor_inside_another_tags_attribute_value_is_not_an_element() {
let raw = r#"<span title='<a id="fake"></a>'>Foo</span>"#;
assert!(extract_html_anchor_ids(raw).is_empty());
assert_eq!(extract_header_id(raw), (raw.to_string(), None));
let raw = r#"<span title='x'><a id="real"></a>Foo</span>"#;
assert_eq!(extract_html_anchor_ids(raw), ["real"]);
assert_eq!(extract_header_id(raw).0, "<span title='x'>Foo</span>");
}
#[test]
fn test_an_escaped_tag_does_not_hide_the_element_written_inside_it() {
let raw = r#"\<span title='<a id="real"></a>'>Foo"#;
assert_eq!(extract_html_anchor_ids(raw), ["real"]);
assert_eq!(extract_header_id(raw).0, r#"\<span title=''>Foo"#);
}
#[test]
fn test_a_degenerate_comment_ends_at_its_own_closer() {
assert_eq!(extract_html_anchor_ids(r#"<!--> <a id="x"></a> --> Foo"#), ["x"]);
assert_eq!(extract_html_anchor_ids(r#"<!---> <a id="y"></a> --> Foo"#), ["y"]);
assert!(extract_html_anchor_ids(r#"<!-- <a id="z"></a> --> Foo"#).is_empty());
}
#[test]
fn test_is_backslash_escaped_counts_the_run_of_backslashes() {
assert!(!is_backslash_escaped("<a>", 0));
assert!(is_backslash_escaped(r"\<a>", 1));
assert!(!is_backslash_escaped(r"\\<a>", 2));
assert!(is_backslash_escaped(r"\\\<a>", 3));
assert!(!is_backslash_escaped(r"x<a>", 1));
}
}