rpm-spec 0.3.3

Parser and pretty-printer for RPM .spec files
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
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

//! Body of the `%files` section: per-file directives and paths.

#![allow(missing_docs)]

use super::cond::Conditional;
use super::macros::Comment;
use super::text::Text;

/// One element of a `%files` body.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum FilesContent<T = ()> {
    Entry(FileEntry<T>),
    Conditional(Conditional<T, FilesContent<T>>),
    Comment(Comment<T>),
    Blank,
}

/// One logical row inside `%files`: zero or more directives plus an optional
/// path. `%defattr(...)` on its own line yields `path = None`.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
pub struct FileEntry<T = ()> {
    pub directives: Vec<FileDirective>,
    pub path: Option<FilePath>,
    pub data: T,
}

/// One `%files` directive.
///
/// `Defattr` and `Attr` carry their fields in a boxed sub-struct so the
/// enum stays compact: zero-payload variants like `Doc`/`Dir`/`Ghost` are
/// the common case, and inlining four [`AttrField`]s into every variant
/// would balloon `FileDirective` to ~128 bytes.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum FileDirective {
    /// `%defattr(fmode, user, group [, dmode])` — set defaults for the
    /// remainder of the section.
    Defattr(Box<DefattrFields>),
    /// `%attr(mode, user, group) path` — per-file override.
    Attr(Box<AttrFields>),
    /// `%dir path` — own a directory but not its contents.
    Dir,
    /// `%doc path…` — install under `%{_docdir}` when the path is relative.
    Doc,
    /// `%license path…` — install under `%{_defaultlicensedir}` (rpm ≥ 4.11).
    License,
    /// `%config[(noreplace|missingok|…)] path`.
    Config(Vec<ConfigFlag>),
    /// `%ghost path` — own the path but do not package it.
    Ghost,
    /// `%verify([not] checks…) path`.
    Verify {
        negate: bool,
        checks: Vec<VerifyCheck>,
    },
    /// `%lang(ru) path` — locale-specific files.
    Lang(Text),
    /// `%caps(cap_…=ep) path` — Linux capabilities.
    Caps(Text),
    /// `%artifact path` (rpm ≥ 4.14.1).
    Artifact,
    /// `%missingok path` (rpm ≥ 4.14).
    MissingOk,
}

/// Payload of [`FileDirective::Defattr`].
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
pub struct DefattrFields {
    pub fmode: AttrField,
    pub user: AttrField,
    pub group: AttrField,
    pub dmode: Option<AttrField>,
}

/// Payload of [`FileDirective::Attr`].
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
pub struct AttrFields {
    pub mode: AttrField,
    pub user: AttrField,
    pub group: AttrField,
}

/// A single field inside `%defattr(...)` or `%attr(...)`.
///
/// The type is *permissive*: an [`AttrField::Numeric`] value may exceed
/// the conventional `0..=0o7777` range, in which case the parser emits
/// a [`crate::parse_result::codes::W_INVALID_NUMBER`] diagnostic but
/// still preserves the original bytes verbatim. Consumers that need a
/// validated mode should re-check the range when reading the AST.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum AttrField {
    /// `-` — leave the value untouched / default.
    Default,
    /// Numeric octal mode such as `0644` or `0755`. Range: `0..=0o7777`.
    Numeric(u32),
    /// User or group name (may contain macros).
    Name(Text),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum ConfigFlag {
    NoReplace,
    MissingOk,
}

/// File verification check (`rpm --verify`).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum VerifyCheck {
    Md5,
    FileDigest,
    Size,
    Link,
    User,
    Group,
    Mtime,
    Mode,
    Rdev,
    Caps,
}

/// File path, potentially containing macros and shell globs. The parser
/// keeps the path in a single [`Text`] without further decomposition.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
pub struct FilePath {
    pub path: Text,
}