use crate::{Error, Object, ObjectRef, Pdf, Result};
use std::collections::BTreeSet;
use std::io::{Read, Seek};
pub const DEFAULT_MAX_OUTLINE_DEPTH: usize = 100;
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct OutlineItem {
pub object_ref: ObjectRef,
pub depth: usize,
pub title: String,
}
pub fn outline_items<R: Read + Seek>(pdf: &mut Pdf<R>) -> Result<Vec<OutlineItem>> {
outline_items_with_max_depth(pdf, DEFAULT_MAX_OUTLINE_DEPTH)
}
pub fn outline_items_with_max_depth<R: Read + Seek>(
pdf: &mut Pdf<R>,
max_depth: usize,
) -> Result<Vec<OutlineItem>> {
let Some(catalog_ref) = pdf.root_ref() else {
return Ok(Vec::new());
};
let catalog = pdf.resolve_borrowed(catalog_ref)?;
let Object::Dictionary(catalog) = catalog else {
return Ok(Vec::new());
};
let Some(outlines_ref) = catalog.get_ref("Outlines") else {
return Ok(Vec::new());
};
let outline_root = pdf.resolve_borrowed(outlines_ref)?;
let Object::Dictionary(outline_root) = outline_root else {
return Ok(Vec::new());
};
let Some(first) = outline_root.get_ref("First") else {
return Ok(Vec::new());
};
let mut visited = BTreeSet::new();
let mut items = Vec::new();
walk_outline(pdf, first, 0, &mut visited, &mut items, max_depth)?;
Ok(items)
}
fn walk_outline<R: Read + Seek>(
pdf: &mut Pdf<R>,
start: ObjectRef,
depth: usize,
visited: &mut BTreeSet<ObjectRef>,
items: &mut Vec<OutlineItem>,
max_depth: usize,
) -> Result<()> {
if depth >= max_depth {
return Err(Error::Unsupported(format!(
"outline depth exceeds maximum of {max_depth} at {start}"
)));
}
let mut current = Some(start);
while let Some(current_ref) = current {
if !visited.insert(current_ref) {
break;
}
let current_obj = pdf.resolve_borrowed(current_ref)?;
let Object::Dictionary(dict) = current_obj else {
break;
};
let title = read_outline_title(dict.get("Title"));
let first = dict.get_ref("First");
let next = dict.get_ref("Next");
items.push(OutlineItem {
object_ref: current_ref,
depth,
title,
});
if let Some(first) = first {
walk_outline(pdf, first, depth + 1, visited, items, max_depth)?;
}
current = next;
}
Ok(())
}
fn read_outline_title(value: Option<&Object>) -> String {
match value {
Some(Object::String(value)) => String::from_utf8_lossy(value).into_owned(),
Some(other) => {
let mut bytes = Vec::new();
other.write_pdf(&mut bytes);
String::from_utf8_lossy(&bytes).into_owned()
}
None => String::from("<untitled>"),
}
}