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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
use quillmark_core::{
Backend, Diagnostic, Quill, QuillReference, RenderError, Severity, Version, VersionSelector,
};
use std::collections::{BTreeMap, HashMap};
use std::str::FromStr;
use std::sync::Arc;
use super::workflow::Workflow;
use super::QuillRef;
/// A set of versioned Quills for a given template name
struct VersionedQuillSet {
/// Map of version to Quill, sorted by version
versions: BTreeMap<Version, Quill>,
}
impl VersionedQuillSet {
/// Create a new empty VersionedQuillSet
fn new() -> Self {
Self {
versions: BTreeMap::new(),
}
}
/// Add a version to the set
fn insert(&mut self, version: Version, quill: Quill) {
self.versions.insert(version, quill);
}
/// Resolve a version selector to a specific version
fn resolve(&self, selector: &VersionSelector) -> Option<&Quill> {
match selector {
VersionSelector::Exact(v) => self.versions.get(v),
VersionSelector::Minor(major, minor) => {
// Find the highest patch version with matching major.minor
self.versions
.iter()
.rev()
.find(|(v, _)| v.major == *major && v.minor == *minor)
.map(|(_, quill)| quill)
}
VersionSelector::Major(major) => {
// Find the highest minor/patch version with matching major
self.versions
.iter()
.rev()
.find(|(v, _)| v.major == *major)
.map(|(_, quill)| quill)
}
VersionSelector::Latest => {
// Return the highest version overall
let result = self.versions.iter().next_back().map(|(_, quill)| quill);
debug_assert!(
result.is_some(),
"VersionedQuillSet should never be empty - quills must have at least one version"
);
result
}
}
}
/// Get all available versions, sorted in descending order
fn available_versions(&self) -> Vec<Version> {
self.versions.keys().rev().copied().collect()
}
}
/// High-level engine for orchestrating backends and quills. See [module docs](super) for usage patterns.
pub struct Quillmark {
backends: HashMap<String, Arc<dyn Backend>>,
quills: HashMap<String, VersionedQuillSet>,
warnings: Vec<Diagnostic>,
}
impl Quillmark {
/// Create a new Quillmark with auto-registered backends based on enabled features.
pub fn new() -> Self {
let mut engine = Self {
backends: HashMap::new(),
quills: HashMap::new(),
warnings: Vec::new(),
};
// Auto-register backends based on enabled features
#[cfg(feature = "typst")]
{
engine.register_backend(Box::new(quillmark_typst::TypstBackend));
}
engine
}
/// Register a backend with the engine.
///
/// This method allows registering custom backends or explicitly registering
/// feature-integrated backends. The backend is registered by its ID.
///
/// If the backend provides a default Quill and no Quill named `__default__`
/// is already registered, the default Quill will be automatically registered.
///
/// # Example
///
/// ```no_run
/// use quillmark::Quillmark;
/// # use quillmark_core::Backend;
/// # struct CustomBackend;
/// # impl Backend for CustomBackend {
/// # fn id(&self) -> &'static str { "custom" }
/// # fn supported_formats(&self) -> &'static [quillmark_core::OutputFormat] { &[] }
/// # fn plate_extension_types(&self) -> &'static [&'static str] { &[".custom"] }
/// # fn compile(&self, _: &str, _: &quillmark_core::Quill, _: &quillmark_core::RenderOptions, _: &serde_json::Value) -> Result<quillmark_core::RenderResult, quillmark_core::RenderError> {
/// # Ok(quillmark_core::RenderResult::new(vec![], quillmark_core::OutputFormat::Txt))
/// # }
/// # }
///
/// let mut engine = Quillmark::new();
/// let custom_backend = Box::new(CustomBackend);
/// engine.register_backend(custom_backend);
/// ```
pub fn register_backend(&mut self, backend: Box<dyn Backend>) {
let id = backend.id().to_string();
// Get default Quill before moving backend
let default_quill = backend.default_quill();
// Register backend first so it's available when registering default Quill
self.backends.insert(id.clone(), Arc::from(backend));
// Register default Quill if available and not already registered
if !self.quills.contains_key("__default__") {
if let Some(default_quill) = default_quill {
if let Err(e) = self.register_quill(default_quill) {
self.warnings.push(
Diagnostic::new(
Severity::Warning,
format!(
"Failed to register default Quill from backend '{}': {}",
id, e
),
)
.with_code("engine::default_quill_registration_failed".to_string()),
);
}
}
}
}
/// Returns all currently accumulated non-fatal engine warnings.
pub fn warnings(&self) -> &[Diagnostic] {
&self.warnings
}
/// Drains and returns all currently accumulated non-fatal engine warnings.
pub fn take_warnings(&mut self) -> Vec<Diagnostic> {
std::mem::take(&mut self.warnings)
}
/// Register a quill template with the engine by name.
///
/// Validates the quill configuration against the registered backend, including:
/// - Backend exists and is registered
/// - Plate file extension matches backend requirements
/// - Auto-plate is allowed if no plate file is specified
/// - Version is valid semver format (MAJOR.MINOR.PATCH or MAJOR.MINOR)
///
/// Multiple versions of the same quill can be registered.
pub fn register_quill(&mut self, quill: Quill) -> Result<(), RenderError> {
let name = quill.name.clone();
// Extract and validate version from quill metadata
let version_str = quill
.metadata
.get("version")
.and_then(|v| v.as_str())
.ok_or_else(|| RenderError::InvalidVersion {
diag: Box::new(
Diagnostic::new(
Severity::Error,
format!("Quill '{}' is missing required 'version' field", name),
)
.with_code("quill::missing_version".to_string())
.with_hint(
"Add 'version = \"1.0.0\"' to the [Quill] section of Quill.yaml"
.to_string(),
),
),
})?;
let version = Version::from_str(version_str).map_err(|e| RenderError::InvalidVersion {
diag: Box::new(
Diagnostic::new(
Severity::Error,
format!(
"Quill '{}' has invalid version '{}': {}",
name, version_str, e
),
)
.with_code("quill::invalid_version".to_string())
.with_hint("Version must be in semver format (e.g., '2.1.0' or '2.1')".to_string()),
),
})?;
// Check if this exact version is already registered
if let Some(version_set) = self.quills.get(&name) {
if version_set.versions.contains_key(&version) {
return Err(RenderError::QuillConfig {
diag: Box::new(
Diagnostic::new(
Severity::Error,
format!("Quill '{}' version {} is already registered", name, version),
)
.with_code("quill::version_collision".to_string())
.with_hint("Each version of a quill must be unique".to_string()),
),
});
}
}
// Get backend
let backend_id = quill.backend.as_str();
let backend = self
.backends
.get(backend_id)
.ok_or_else(|| RenderError::QuillConfig {
diag: Box::new(
Diagnostic::new(
Severity::Error,
format!(
"Backend '{}' specified in quill '{}' is not registered",
backend_id, name
),
)
.with_code("quill::backend_not_found".to_string())
.with_hint(format!(
"Available backends: {}",
self.backends.keys().cloned().collect::<Vec<_>>().join(", ")
)),
),
})?;
// Validate plate_file extension or auto_plate
if let Some(plate_file) = &quill.metadata.get("plate_file").and_then(|v| v.as_str()) {
let extension = std::path::Path::new(plate_file)
.extension()
.and_then(|e| e.to_str())
.map(|e| format!(".{}", e))
.unwrap_or_default();
if !backend
.plate_extension_types()
.contains(&extension.as_str())
{
return Err(RenderError::QuillConfig {
diag: Box::new(Diagnostic::new(
Severity::Error,
format!(
"Plate file '{}' has extension '{}' which is not supported by backend '{}'",
plate_file, extension, backend_id
),
)
.with_code("quill::plate_extension_mismatch".to_string())
.with_hint(format!(
"Supported extensions for '{}' backend: {}",
backend_id,
backend.plate_extension_types().join(", ")
))),
});
}
}
// Add the quill to the versioned set
self.quills
.entry(name.clone())
.or_insert_with(VersionedQuillSet::new)
.insert(version, quill);
Ok(())
}
/// Resolve a QuillReference to a specific Quill
fn resolve_quill_reference(&self, quill_ref: &QuillReference) -> Result<&Quill, RenderError> {
let version_set =
self.quills
.get(&quill_ref.name)
.ok_or_else(|| RenderError::QuillNotFound {
diag: Box::new(
Diagnostic::new(
Severity::Error,
format!("Quill '{}' not registered", quill_ref.name),
)
.with_code("engine::quill_not_found".to_string())
.with_hint(format!(
"Available quills: {}",
self.quills.keys().cloned().collect::<Vec<_>>().join(", ")
)),
),
})?;
version_set.resolve(&quill_ref.selector).ok_or_else(|| {
let available = version_set.available_versions();
let available_str: Vec<String> = available.iter().map(|v| v.to_string()).collect();
let suggestion = match &quill_ref.selector {
VersionSelector::Exact(v) => {
// Suggest using major version or listing available versions
if let Some(latest_major) = available.iter().find(|av| av.major == v.major) {
format!(
"Use @{} for latest {}.x (currently {}), or specify one of: {}",
v.major,
v.major,
latest_major,
available_str.join(", ")
)
} else {
format!("Available versions: {}", available_str.join(", "))
}
}
VersionSelector::Minor(major, minor) => {
format!(
"No versions found in {}.{}.x series. Available versions: {}",
major,
minor,
available_str.join(", ")
)
}
VersionSelector::Major(m) => {
format!(
"No versions found in {}.x series. Available versions: {}",
m,
available_str.join(", ")
)
}
VersionSelector::Latest => {
"No versions available (this should not happen)".to_string()
}
};
RenderError::VersionNotFound {
diag: Box::new(
Diagnostic::new(
Severity::Error,
format!(
"Version not found for quill '{}' with selector '{}'",
quill_ref.name, quill_ref.selector
),
)
.with_code("engine::version_not_found".to_string())
.with_hint(suggestion),
),
}
})
}
/// Load a workflow by quill reference (name, object, or parsed document)
///
/// This is the unified workflow creation method that accepts:
/// - `&str` - Looks up registered quill by name (uses latest version)
/// - `&Quill` - Uses quill directly (doesn't need to be registered)
/// - `&ParsedDocument` - Extracts quill reference and resolves version
///
/// # Example
///
/// ```no_run
/// # use quillmark::{Quillmark, Quill, ParsedDocument};
/// # let engine = Quillmark::new();
/// // By name (uses latest version)
/// let workflow = engine.workflow("my-quill")?;
///
/// // By object
/// # let quill = Quill::from_path("path/to/quill").unwrap();
/// let workflow = engine.workflow(&quill)?;
///
/// // From parsed document (with version resolution)
/// # let parsed = ParsedDocument::from_markdown("---\nQUILL: my-quill@2.1\n---\n# Hello").unwrap();
/// let workflow = engine.workflow(&parsed)?;
/// # Ok::<(), quillmark::RenderError>(())
/// ```
pub fn workflow<'a>(
&self,
quill_ref: impl Into<QuillRef<'a>>,
) -> Result<Workflow, RenderError> {
let quill_ref = quill_ref.into();
// Get the quill reference based on the parameter type
let quill = match quill_ref {
QuillRef::Name(name) => {
// Parse the name as a QuillReference (supports @version syntax)
let quill_reference =
QuillReference::from_str(name).map_err(|e| RenderError::InvalidVersion {
diag: Box::new(
Diagnostic::new(
Severity::Error,
format!("Invalid quill reference '{}': {}", name, e),
)
.with_code("engine::invalid_reference".to_string()),
),
})?;
self.resolve_quill_reference(&quill_reference)?
}
QuillRef::Object(quill) => {
// Use the provided quill directly
quill
}
QuillRef::Parsed(parsed) => {
// Extract quill reference from parsed document and resolve version
let quill_reference = parsed.quill_reference();
self.resolve_quill_reference(quill_reference)?
}
};
// Get backend ID from quill metadata
let backend_id = quill
.metadata
.get("backend")
.and_then(|v| v.as_str())
.ok_or_else(|| RenderError::EngineCreation {
diag: Box::new(
Diagnostic::new(
Severity::Error,
format!("Quill '{}' does not specify a backend", quill.name),
)
.with_code("engine::missing_backend".to_string())
.with_hint(
"Add 'backend = \"typst\"' to the [Quill] section of Quill.yaml"
.to_string(),
),
),
})?;
// Get the backend by ID
let backend =
self.backends
.get(backend_id)
.ok_or_else(|| RenderError::UnsupportedBackend {
diag: Box::new(
Diagnostic::new(
Severity::Error,
format!("Backend '{}' not registered or not enabled", backend_id),
)
.with_code("engine::backend_not_found".to_string())
.with_hint(format!(
"Available backends: {}",
self.backends.keys().cloned().collect::<Vec<_>>().join(", ")
)),
),
})?;
// Clone the Arc reference to the backend and the quill for the workflow
let backend_clone = Arc::clone(backend);
let quill_clone = quill.clone();
Workflow::new(backend_clone, quill_clone)
}
/// Get a list of registered backend IDs.
pub fn registered_backends(&self) -> Vec<&str> {
self.backends.keys().map(|s| s.as_str()).collect()
}
/// Get a list of registered quill names.
pub fn registered_quills(&self) -> Vec<&str> {
self.quills.keys().map(|s| s.as_str()).collect()
}
/// Get a list of registered quills with their exact versions.
/// Returns strings in the format "name@version" (e.g. "resume-template@2.1.0").
pub fn registered_quill_versions(&self) -> Vec<String> {
let mut result = Vec::new();
for (name, version_set) in &self.quills {
for version in version_set.available_versions() {
result.push(format!("{}@{}", name, version));
}
}
result
}
/// Get a reference to a registered quill by name (returns latest version).
///
/// Returns `None` if the quill is not registered.
///
/// # Example
///
/// ```no_run
/// # use quillmark::Quillmark;
/// # let engine = Quillmark::new();
/// if let Some(quill) = engine.get_quill("my-quill") {
/// println!("Found quill: {}", quill.name);
/// }
/// ```
pub fn get_quill(&self, name_or_ref: &str) -> Option<&Quill> {
// Parse input as QuillReference (defaults to Latest if no version specified)
QuillReference::from_str(name_or_ref)
.ok()
.and_then(|quill_ref| self.resolve_quill_reference(&quill_ref).ok())
}
/// Get a reference to a quill's metadata by name (returns latest version).
///
/// Returns `None` if the quill is not registered.
///
/// # Example
///
/// ```no_run
/// # use quillmark::Quillmark;
/// # let engine = Quillmark::new();
/// if let Some(metadata) = engine.get_quill_metadata("my-quill") {
/// println!("Metadata: {:?}", metadata);
/// }
/// ```
pub fn get_quill_metadata(
&self,
name: &str,
) -> Option<&HashMap<String, quillmark_core::value::QuillValue>> {
self.get_quill(name).map(|quill| &quill.metadata)
}
/// Unregister a quill by name or specific version.
///
/// If a base name is provided (e.g., "my-quill"), all versions of that quill are removed.
/// If a versioned name is provided (e.g., "my-quill@2.1.0"), only that specific version
/// is removed.
///
/// Returns `true` if any quill/version was removed, `false` if not found.
///
/// # Example
///
/// ```no_run
/// # use quillmark::Quillmark;
/// # let mut engine = Quillmark::new();
/// if engine.unregister_quill("my-quill@2.1.0") {
/// println!("Specific version unregistered");
/// }
/// if engine.unregister_quill("my-quill") {
/// println!("All remaining versions unregistered");
/// }
/// ```
pub fn unregister_quill(&mut self, name_or_ref: &str) -> bool {
// Try parsing as a reference to handle specific version unregistration
if let Ok(quill_ref) = QuillReference::from_str(name_or_ref) {
if let VersionSelector::Exact(v) = quill_ref.selector {
// Remove specific version
if let Some(version_set) = self.quills.get_mut(&quill_ref.name) {
let removed = version_set.versions.remove(&v).is_some();
// Clean up empty sets
if version_set.versions.is_empty() {
self.quills.remove(&quill_ref.name);
}
return removed;
}
return false;
}
}
// Default behavior: treat as base name and remove all versions
self.quills.remove(name_or_ref).is_some()
}
}
impl Default for Quillmark {
fn default() -> Self {
Self::new()
}
}