asciidoc-parser 0.19.1

Parser for AsciiDoc format
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

use crate::document::InterpretedValue;

/// Document attributes are used either to configure behavior in the processor
/// or to relay information about the document and its environment.
///
/// Attribute values can be established via the API using the
/// [`Parser::with_intrinsic_attribute()`] or
/// [`Parser::with_intrinsic_attribute_bool()`] functions.
///
/// [`Parser::with_intrinsic_attribute()`]: crate::Parser::with_intrinsic_attribute
/// [`Parser::with_intrinsic_attribute_bool()`]: crate::Parser::with_intrinsic_attribute_bool
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct AttributeValue {
    /// Allowable values for the attribute.
    pub(crate) allowable_value: AllowableValue,

    /// Allowable contexts for modifying the attribute value.
    pub(crate) modification_context: ModificationContext,

    /// Whether a rejected write (a document header or body assignment that
    /// [`modification_context`](Self::modification_context) does not permit) is
    /// silently ignored instead of recording an
    /// [`AttributeValueIsLocked`](crate::warnings::WarningType::AttributeValueIsLocked)
    /// warning.
    ///
    /// This is orthogonal to the scope axis: it does not change *where* the
    /// attribute may be set, only whether a rejected write warns. It exists so
    /// a caller can reproduce Asciidoctor's *silent* safe-mode attribute
    /// restrictions — under `SERVER`/`SECURE`, a document assignment of a
    /// restricted conversion attribute (`backend`, `doctype`, `docinfo`,
    /// `source-highlighter`) is simply dropped, with no diagnostic.
    pub(crate) silent_when_locked: bool,

    /// Current value of the attribute.
    pub(crate) value: InterpretedValue,
}

/// Allowable values for the attribute.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum AllowableValue {
    /// Any value is accepted.
    Any,

    /// Indicates the attribute doesn't require an explicit value. The
    /// attribute is simply turned on by being set.
    Empty,

    /// In some cases, an empty value is interpreted by the processor as one of
    /// the allowable non-empty values. This effective value is prefixed with an
    /// equals sign and enclosed in square brackets (e.g., `[=auto]`). An
    /// attribute reference will resolve to an empty value rather than the
    /// effective value.
    Effective(InterpretedValue),

    /// Built-in attributes that are not set may have an implied value. The
    /// implied value is enclosed in parentheses (e.g., (attributes)). An
    /// implied value can't be resolved using an attribute reference.
    Implied(&'static str),
}

/// Allowable context(s) for modification of this attribute value.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ModificationContext {
    /// Value can only be configured via API.
    ApiOnly,

    /// The attribute must be set or unset by the end of the document header
    /// (i.e., set by the API or in the document header).
    ApiOrHeader,

    /// The attribute was set by API. It can not be overridden in the document
    /// header, but can be set in the document body. Changing the attribute's
    /// value only affects behavior for content that follows the assignment (in
    /// document order).
    ApiOrDocumentBody,

    /// The attribute can be set anywhere in the document. However, changing an
    /// attribute only affects behavior for content that follows the assignment
    /// (in document order).
    Anywhere,
}