Files
craft-libs/crates/timeline/src/report.rs
T
Dylan M. TaylorandNetterSilver 2f8f9ad8c9 craft-timeline: exact media time, reports, ALE and CMX 3600 EDL (from FilmCraft) (#911)
* craft-timeline: exact media time, reports, media paths, ALE and CMX 3600 EDL

New crate for editorial timeline interchange (#782), moved from FilmCraft at
4bec22bd:

- time: filmcraft-time whole (Tick, FrameRate, TimeRange, SMPTE timecode,
  feet+frames, typed-timecode parsing) with its tests.
- report: Report / Level / ReportEntry.
- path: file URL and path conversion, relative references joined to a folder.
- rate: timebase+ntsc and floating rates to exact rates, MAX_RATE.
- ale: AleDoc, parse, write, standard heading and columns.
- edl: the parser (events, lines, timecode fields, M2, AUD, comment extensions),
  the frame-rate guess, and the line layout of the writer, on frame counts.
- Format, detect_text, decode_text.

Each format module gives the document as the format writes it. Mapping onto an
application's timeline stays in the application.

* craft-timeline: strip a UTF-8 byte order mark when parsing ALE files

An ALE saved with a BOM was refused as "not an ALE file": the mark made the
first line something other than "Heading".

Ported from storytold/filmcraft#4531.

---------

Co-authored-by: NetterSilver <133535268+Silvertree2010@users.noreply.github.com>
2026-11-11 17:32:53 -05:00

76 lines
2.5 KiB
Rust
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
//! What an import or export could not represent exactly.
/// Severity of a report entry.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Level {
/// Informational (an assumption the importer made).
Info,
/// Something was dropped or approximated.
Warning,
}
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ReportEntry {
pub level: Level,
pub message: String,
/// How many times this message occurred.
pub count: u32,
}
/// What an import/export could not represent exactly. Identical messages are merged with a count.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Report {
pub entries: Vec<ReportEntry>,
}
impl Report {
pub fn push(&mut self, level: Level, message: impl Into<String>) {
let message = message.into();
if let Some(e) = self.entries.iter_mut().find(|e| e.level == level && e.message == message) {
e.count += 1;
} else {
self.entries.push(ReportEntry { level, message, count: 1 });
}
}
pub fn warn(&mut self, message: impl Into<String>) {
self.push(Level::Warning, message);
}
pub fn info(&mut self, message: impl Into<String>) {
self.push(Level::Info, message);
}
pub fn is_empty(&self) -> bool {
self.entries.is_empty()
}
pub fn warnings(&self) -> impl Iterator<Item = &ReportEntry> {
self.entries.iter().filter(|e| e.level == Level::Warning)
}
pub fn has_warnings(&self) -> bool {
self.warnings().next().is_some()
}
/// Whether any entry contains `needle` (case-insensitive).
pub fn mentions(&self, needle: &str) -> bool {
let n = needle.to_ascii_lowercase();
self.entries.iter().any(|e| e.message.to_ascii_lowercase().contains(&n))
}
}
impl std::fmt::Display for Report {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
for e in &self.entries {
let lvl = match e.level {
Level::Info => "info",
Level::Warning => "warning",
};
if e.count > 1 {
writeln!(f, "{lvl}: {} (×{})", e.message, e.count)?;
} else {
writeln!(f, "{lvl}: {}", e.message)?;
}
}
Ok(())
}
}