git.iko.soy/bat
on master help sign in
Add InputDescription API
9813529Ethan P
CHANGELOG.md+1
compare with master
unifiedsplit
@@ -49,6 +49,7 @@
49## `bat` as a library
49## `bat` as a library
50
50
51- `PrettyPrinter::vcs_modification_markers` has been marked deprecated when building without the `git` feature, see #997 and #1020 (@eth-p, @sharkdp)
51- `PrettyPrinter::vcs_modification_markers` has been marked deprecated when building without the `git` feature, see #997 and #1020 (@eth-p, @sharkdp)
52+- Add APIs to provide `Input` descriptions with `InputDescription` (@eth-p)
52
53
53## Packaging
54## Packaging
54
55
src/input.rs+85−44
@@ -8,18 +8,55 @@ use crate::error::*;
8
8
9const THEME_PREVIEW_FILE: &[u8] = include_bytes!("../assets/theme_preview.rs");
9const THEME_PREVIEW_FILE: &[u8] = include_bytes!("../assets/theme_preview.rs");
10
10
11−/// A description for an Input source.
11+/// A description of an Input source.
12/// This tells bat how to refer to the input.
12/// This tells bat how to refer to the input.
13−#[derive(Debug, Clone)]
13+#[derive(Clone)]
14−pub(crate) struct InputDescription {
14+pub struct InputDescription {
15− /// The name of the input used when printing warnings.
15+ name: String,
16+ kind: Option<String>,
17+ summary: Option<String>,
18+}
19+
20+impl InputDescription {
21+ /// Creates a description for an input.
22+ ///
23+ /// The name should uniquely describes where the input came from (e.g. "README.md")
16− pub full: String,
24+ pub fn new(name: impl Into<String>) -> Self {
25+ InputDescription {
26+ name: name.into(),
27+ kind: None,
28+ summary: None,
29+ }
30+ }
17
31
18− /// The prefix string for the input when displaying it in the header.
32+ /// A description for the type of input (e.g. "File")
19− pub prefix: String,
33+ pub fn with_kind(mut self, kind: Option<impl Into<String>>) -> Self {
34+ self.kind = kind.map(|kind| kind.into());
35+ self
36+ }
37+
38+ /// A summary description of the input.
39+ ///
40+ /// Defaults to "{kind} '{name}'"
41+ pub fn with_summary(mut self, summary: Option<impl Into<String>>) -> Self {
42+ self.summary = summary.map(|summary| summary.into());
43+ self
44+ }
45+
46+ pub fn name(&self) -> &String {
47+ &self.name
48+ }
20
49
21− /// The name of the input.
50+ pub fn kind(&self) -> Option<&String> {
51+ self.kind.as_ref()
52+ }
53+
22− pub name: String,
54+ pub fn summary(&self) -> String {
55+ self.summary.clone().unwrap_or_else(|| match &self.kind {
56+ None => self.name.clone(),
57+ Some(kind) => format!("{} '{}'", kind.to_lowercase(), self.name),
58+ })
59+ }
23}
60}
24
61
25pub(crate) enum InputKind<'a> {
62pub(crate) enum InputKind<'a> {
@@ -29,6 +66,19 @@ pub(crate) enum InputKind<'a> {
29 CustomReader(Box<dyn Read + 'a>),
66 CustomReader(Box<dyn Read + 'a>),
30}
67}
31
68
69+impl<'a> InputKind<'a> {
70+ pub fn description(&self) -> InputDescription {
71+ match self {
72+ InputKind::OrdinaryFile(ref path) => {
73+ InputDescription::new(path.to_string_lossy()).with_kind(Some("File"))
74+ }
75+ InputKind::StdIn => InputDescription::new("STDIN"),
76+ InputKind::ThemePreviewFile => InputDescription::new(""),
77+ InputKind::CustomReader(_) => InputDescription::new("READER"),
78+ }
79+ }
80+}
81+
32#[derive(Clone, Default)]
82#[derive(Clone, Default)]
33pub(crate) struct InputMetadata {
83pub(crate) struct InputMetadata {
34 pub(crate) user_provided_name: Option<OsString>,
84 pub(crate) user_provided_name: Option<OsString>,
@@ -37,6 +87,7 @@ pub(crate) struct InputMetadata {
37pub struct Input<'a> {
87pub struct Input<'a> {
38 pub(crate) kind: InputKind<'a>,
88 pub(crate) kind: InputKind<'a>,
39 pub(crate) metadata: InputMetadata,
89 pub(crate) metadata: InputMetadata,
90+ pub(crate) description: Option<InputDescription>,
40}
91}
41
92
42pub(crate) enum OpenedInputKind {
93pub(crate) enum OpenedInputKind {
@@ -59,6 +110,7 @@ pub(crate) struct OpenedInput<'a> {
59 pub(crate) kind: OpenedInputKind,
110 pub(crate) kind: OpenedInputKind,
60 pub(crate) metadata: InputMetadata,
111 pub(crate) metadata: InputMetadata,
61 pub(crate) reader: InputReader<'a>,
112 pub(crate) reader: InputReader<'a>,
113+ pub(crate) description: InputDescription,
62}
114}
63
115
64impl<'a> Input<'a> {
116impl<'a> Input<'a> {
@@ -66,6 +118,7 @@ impl<'a> Input<'a> {
66 Input {
118 Input {
67 kind: InputKind::OrdinaryFile(path.to_os_string()),
119 kind: InputKind::OrdinaryFile(path.to_os_string()),
68 metadata: InputMetadata::default(),
120 metadata: InputMetadata::default(),
121+ description: None,
69 }
122 }
70 }
123 }
71
124
@@ -73,6 +126,7 @@ impl<'a> Input<'a> {
73 Input {
126 Input {
74 kind: InputKind::StdIn,
127 kind: InputKind::StdIn,
75 metadata: InputMetadata::default(),
128 metadata: InputMetadata::default(),
129+ description: None,
76 }
130 }
77 }
131 }
78
132
@@ -80,6 +134,7 @@ impl<'a> Input<'a> {
80 Input {
134 Input {
81 kind: InputKind::ThemePreviewFile,
135 kind: InputKind::ThemePreviewFile,
82 metadata: InputMetadata::default(),
136 metadata: InputMetadata::default(),
137+ description: None,
83 }
138 }
84 }
139 }
85
140
@@ -87,6 +142,7 @@ impl<'a> Input<'a> {
87 Input {
142 Input {
88 kind: InputKind::CustomReader(reader),
143 kind: InputKind::CustomReader(reader),
89 metadata: InputMetadata::default(),
144 metadata: InputMetadata::default(),
145+ description: None,
90 }
146 }
91 }
147 }
92
148
@@ -103,15 +159,33 @@ impl<'a> Input<'a> {
103 self
159 self
104 }
160 }
105
161
162+ pub fn with_description(mut self, description: Option<InputDescription>) -> Self {
163+ self.description = description;
164+ self
165+ }
166+
167+ pub fn description(&self) -> InputDescription {
168+ if let Some(ref description) = self.description {
169+ description.clone()
170+ } else if let Some(ref name) = self.metadata.user_provided_name {
171+ InputDescription::new(name.to_string_lossy()).with_kind(Some("File"))
172+ } else {
173+ self.kind.description()
174+ }
175+ }
176+
106 pub(crate) fn open<R: BufRead + 'a>(self, stdin: R) -> Result<OpenedInput<'a>> {
177 pub(crate) fn open<R: BufRead + 'a>(self, stdin: R) -> Result<OpenedInput<'a>> {
178+ let description = self.description().clone();
107 match self.kind {
179 match self.kind {
108 InputKind::StdIn => Ok(OpenedInput {
180 InputKind::StdIn => Ok(OpenedInput {
109 kind: OpenedInputKind::StdIn,
181 kind: OpenedInputKind::StdIn,
182+ description,
110 metadata: self.metadata,
183 metadata: self.metadata,
111 reader: InputReader::new(stdin),
184 reader: InputReader::new(stdin),
112 }),
185 }),
113 InputKind::OrdinaryFile(path) => Ok(OpenedInput {
186 InputKind::OrdinaryFile(path) => Ok(OpenedInput {
114 kind: OpenedInputKind::OrdinaryFile(path.clone()),
187 kind: OpenedInputKind::OrdinaryFile(path.clone()),
188+ description,
115 metadata: self.metadata,
189 metadata: self.metadata,
116 reader: {
190 reader: {
117 let file = File::open(&path)
191 let file = File::open(&path)
@@ -124,10 +198,12 @@ impl<'a> Input<'a> {
124 }),
198 }),
125 InputKind::ThemePreviewFile => Ok(OpenedInput {
199 InputKind::ThemePreviewFile => Ok(OpenedInput {
126 kind: OpenedInputKind::ThemePreviewFile,
200 kind: OpenedInputKind::ThemePreviewFile,
201+ description,
127 metadata: self.metadata,
202 metadata: self.metadata,
128 reader: InputReader::new(THEME_PREVIEW_FILE),
203 reader: InputReader::new(THEME_PREVIEW_FILE),
129 }),
204 }),
130 InputKind::CustomReader(reader) => Ok(OpenedInput {
205 InputKind::CustomReader(reader) => Ok(OpenedInput {
206+ description,
131 kind: OpenedInputKind::CustomReader,
207 kind: OpenedInputKind::CustomReader,
132 metadata: self.metadata,
208 metadata: self.metadata,
133 reader: InputReader::new(BufReader::new(reader)),
209 reader: InputReader::new(BufReader::new(reader)),
@@ -136,41 +212,6 @@ impl<'a> Input<'a> {
136 }
212 }
137}
213}
138
214
139−impl<'a> OpenedInput<'a> {
140− pub fn description(&self) -> InputDescription {
141− if let Some(ref name) = self.metadata.user_provided_name {
142− InputDescription {
143− full: format!("file '{}'", name.to_string_lossy()),
144− prefix: "File: ".to_owned(),
145− name: name.to_string_lossy().into_owned(),
146− }
147− } else {
148− match self.kind {
149− OpenedInputKind::OrdinaryFile(ref path) => InputDescription {
150− full: format!("file '{}'", path.to_string_lossy()),
151− prefix: "File: ".to_owned(),
152− name: path.to_string_lossy().into_owned(),
153− },
154− OpenedInputKind::StdIn => InputDescription {
155− full: "STDIN".to_owned(),
156− prefix: "".to_owned(),
157− name: "STDIN".to_owned(),
158− },
159− OpenedInputKind::ThemePreviewFile => InputDescription {
160− full: "".to_owned(),
161− prefix: "".to_owned(),
162− name: "".to_owned(),
163− },
164− OpenedInputKind::CustomReader => InputDescription {
165− full: "reader".to_owned(),
166− prefix: "".to_owned(),
167− name: "READER".into(),
168− },
169− }
170− }
171− }
172−}
173−
174pub(crate) struct InputReader<'a> {
215pub(crate) struct InputReader<'a> {
175 inner: Box<dyn BufRead + 'a>,
216 inner: Box<dyn BufRead + 'a>,
176 pub(crate) first_line: Vec<u8>,
217 pub(crate) first_line: Vec<u8>,
src/printer.rs+7−4
@@ -249,7 +249,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
249 (but will be present if the output of 'bat' is piped). You can use 'bat -A' \
249 (but will be present if the output of 'bat' is piped). You can use 'bat -A' \
250 to show the binary file contents.",
250 to show the binary file contents.",
251 Yellow.paint("[bat warning]"),
251 Yellow.paint("[bat warning]"),
252− input.description().full,
252+ input.description.summary(),
253 )?;
253 )?;
254 } else if self.config.style_components.grid() {
254 } else if self.config.style_components.grid() {
255 self.print_horizontal_line(handle, '┬')?;
255 self.print_horizontal_line(handle, '┬')?;
@@ -283,13 +283,16 @@ impl<'a> Printer for InteractivePrinter<'a> {
283 _ => "",
283 _ => "",
284 };
284 };
285
285
286− let description = input.description();
286+ let description = &input.description;
287
287
288 writeln!(
288 writeln!(
289 handle,
289 handle,
290 "{}{}{}",
290 "{}{}{}",
291− description.prefix,
291+ description
292+ .kind()
293+ .map(|kind| format!("{}: ", kind))
294+ .unwrap_or("".into()),
292− self.colors.filename.paint(&description.name),
295+ self.colors.filename.paint(description.name()),
293 mode
296 mode
294 )?;
297 )?;
295
298