rpm-spec 0.3.4

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

//! Top-level sections (`%description`, `%prep`, `%files`, `%changelog`, …).
//!
//! Build-script sections (`%prep`, `%build`, `%install`, `%check`, …) and
//! scriptlet/trigger bodies are stored as [`ShellBody`] — sequences of text
//! lines that may contain macro references but are *not* parsed as bash.

#![allow(missing_docs)]

use super::changelog::ChangelogEntry;
use super::files::FilesContent;
use super::preamble::PreambleContent;
use super::scriptlet::{FileTrigger, Scriptlet, Trigger};
use super::text::Text;

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum Section<T = ()> {
    /// `%description [-n] [sub]` — free-form text body.
    Description {
        subpkg: Option<SubpkgRef>,
        body: TextBody,
        data: T,
    },
    /// `%package [-n] sub` — declares a subpackage with its own preamble.
    Package {
        name_arg: PackageName,
        content: Vec<PreambleContent<T>>,
        data: T,
    },
    /// `%prep` / `%conf` / `%build` / `%install` / `%check` / `%clean` /
    /// `%generate_buildrequires` — shell bodies.
    BuildScript {
        kind: BuildScriptKind,
        body: ShellBody,
        data: T,
    },
    /// `%files [-n sub] [-f filelist]` — a list of paths plus directives.
    Files {
        subpkg: Option<SubpkgRef>,
        /// `-f filelist` — repeatable. Each entry is a path (often a macro).
        file_lists: Vec<Text>,
        content: Vec<FilesContent<T>>,
        data: T,
    },
    Scriptlet(Scriptlet<T>),
    Trigger(Trigger<T>),
    FileTrigger(FileTrigger<T>),
    /// `%verify [-n sub]` — shell body executed by `rpm --verify`.
    Verify {
        subpkg: Option<SubpkgRef>,
        body: ShellBody,
        data: T,
    },
    /// `%changelog` — the single global changelog block.
    Changelog {
        entries: Vec<ChangelogEntry<T>>,
        data: T,
    },
    /// `%sourcelist` — alternative to numbered `SourceN:` tags.
    SourceList {
        entries: Vec<Text>,
        data: T,
    },
    /// `%patchlist` — alternative to numbered `PatchN:` tags.
    PatchList {
        entries: Vec<Text>,
        data: T,
    },
    /// `%sepolicy [-n sub]` — SELinux module section (RH family).
    Sepolicy {
        subpkg: Option<SubpkgRef>,
        body: ShellBody,
        data: T,
    },
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum BuildScriptKind {
    Prep,
    /// `%conf` — rpm ≥ 4.18.
    Conf,
    Build,
    Install,
    Check,
    /// `%clean` — deprecated; rpm cleans the buildroot itself.
    Clean,
    /// `%generate_buildrequires` — rpm ≥ 4.15.
    GenerateBuildRequires,
}

/// Argument of `%package`.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum PackageName {
    /// `%package foo` — appended to the main name: `<main>-foo`.
    Relative(Text),
    /// `%package -n foo` — absolute subpackage name `foo`.
    Absolute(Text),
}

/// `-n SUB` or bare `SUB` modifier on a section header.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum SubpkgRef {
    /// Bare suffix form: `<main>-SUB`.
    Relative(Text),
    /// `-n` form: absolute subpackage name.
    Absolute(Text),
}

/// Free-form text body (e.g. inside `%description`). Each entry is one line;
/// an empty [`Text`] denotes a blank line.
#[derive(Debug, Clone, PartialEq, Eq, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
pub struct TextBody {
    pub lines: Vec<Text>,
}

/// Shell body (e.g. inside `%prep`, `%build`, scriptlets). This crate does
/// *not* parse the bash grammar, but it does distinguish literal text from
/// embedded macro references so they can be expanded or printed cleanly.
///
/// Conditional blocks (`%if/%endif`) appearing inside a shell body are kept
/// as text lines, not as structural [`super::cond::Conditional`] nodes.
#[derive(Debug, Clone, PartialEq, Eq, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
pub struct ShellBody {
    pub lines: Vec<Text>,
}