murkdown 0.1.1

An experimental semantic markup language and static site generator for composing and decomposing hypertext documents
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

use std::{
    collections::HashMap,
    path::PathBuf,
    sync::{Arc, Mutex, Weak},
};

use thiserror::Error;

use crate::{
    ast::Node,
    compiler::{self, rule::LangRule},
    parser,
};

/// Uniform Resource Identifier (eg. load:foo.fd)
pub type URI = String;

/// Map from URI to AST node
pub type AstMap = HashMap<String, Arc<Mutex<Node>>>;

/// Map from processing stage (eg. preprocess) to list of rules
pub(crate) type RuleMap = HashMap<&'static str, Vec<LangRule>>;

/// Map from Resource path (eg. foo.fd) to location on disk
pub type LocationMap = HashMap<String, Location>;

#[derive(Debug, Clone)]
pub struct Pointer(pub Weak<Mutex<Node>>);

#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum Location {
    Path(PathBuf),
    DataURL(String),
}

impl From<PathBuf> for Location {
    fn from(value: PathBuf) -> Self {
        Self::Path(value)
    }
}

/// Dependency discovered by the preprocessor or compiler
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
pub enum Dependency {
    URI(&'static str, URI),
    Exec {
        id: String,
        cmd: String,
        input: Option<String>,
        artifact: ExecArtifact,
    },
}

#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum ExecArtifact {
    Stdout(String),
    Path(PathBuf),
}

#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub enum ExecInput {
    String(String),
    URI(URI),
}

/// Pointer equality is ignored
impl PartialEq for Pointer {
    fn eq(&self, _: &Pointer) -> bool {
        true
    }
}

impl Eq for Pointer {}

#[derive(Error, Debug, thiserror_ext::Construct)]
pub enum LibError {
    #[error(transparent)]
    ParseError(#[from] Box<pest::error::Error<parser::Rule>>),
    #[error(transparent)]
    ParseRuleError(#[from] Box<pest::error::Error<compiler::Rule>>),
    #[error(transparent)]
    BadRuleRegex(#[from] regex::Error),
    #[error("missing root")]
    MissingRoot,
    #[error("unknown rule section `{0}`")]
    UnknownRuleSection(String),
    #[error("invalid rule `{0}`")]
    InvalidRule(String),
    #[error("invalid argument `{0}`")]
    InvalidRuleArgument(String),
    #[error("invalid argument type `{0}` expected `{1}`")]
    InvalidRuleArgumentType(String, &'static str),
}

pub trait LibErrorPathCtx<T> {
    fn with_path(self, id: &str) -> Result<T, LibError>;
}

impl<T> LibErrorPathCtx<T> for Result<T, LibError> {
    fn with_path(self, path: &str) -> Result<T, LibError> {
        self.map_err(|e| match e {
            LibError::ParseError(error) => LibError::ParseError(Box::new(error.with_path(path))),
            _ => e,
        })
    }
}