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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
// Copyright 2018-2019 Sebastian Wiesner <sebastian@swsnr.de>
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#![deny(warnings, clippy::all)]
//! Show CommonMark documents on TTYs.
use mdcat;
use clap::value_t;
use pulldown_cmark::{Options, Parser};
use std::error::Error;
use std::fs::File;
use std::io::prelude::*;
use std::io::{stdin, stdout};
use std::path::PathBuf;
use syntect::parsing::SyntaxSet;
use mdcat::{ResourceAccess, TerminalCapabilities, TerminalSize};
/// Read input for `filename`.
///
/// If `filename` is `-` read from standard input, otherwise try to open and
/// read the given file.
fn read_input<T: AsRef<str>>(filename: T) -> std::io::Result<(PathBuf, String)> {
let cd = std::env::current_dir()?;
let mut buffer = String::new();
if filename.as_ref() == "-" {
stdin().read_to_string(&mut buffer)?;
Ok((cd, buffer))
} else {
let mut source = File::open(filename.as_ref())?;
source.read_to_string(&mut buffer)?;
let base_dir = cd
.join(filename.as_ref())
.parent()
.map(|p| p.to_path_buf())
.unwrap_or(cd);
Ok((base_dir, buffer))
}
}
fn process_arguments(size: TerminalSize, args: Arguments) -> Result<(), Box<dyn Error>> {
if args.detect_only {
println!("Terminal: {}", args.terminal_capabilities.name);
Ok(())
} else {
let (base_dir, input) = read_input(&args.filename)?;
let mut options = Options::empty();
options.insert(Options::ENABLE_TASKLISTS);
options.insert(Options::ENABLE_STRIKETHROUGH);
let parser = Parser::new_ext(&input, options);
if args.dump_events {
mdcat::dump_events(&mut std::io::stdout(), parser)?;
Ok(())
} else {
let syntax_set = SyntaxSet::load_defaults_newlines();
mdcat::push_tty(
&mut stdout(),
args.terminal_capabilities,
TerminalSize {
width: args.columns,
..size
},
parser,
&base_dir,
args.resource_access,
syntax_set,
)?;
Ok(())
}
}
}
/// Represent command line arguments.
struct Arguments {
filename: String,
terminal_capabilities: TerminalCapabilities,
resource_access: ResourceAccess,
columns: usize,
dump_events: bool,
detect_only: bool,
}
impl Arguments {
/// Create command line arguments from matches.
fn from_matches(matches: &clap::ArgMatches<'_>) -> clap::Result<Self> {
let terminal_capabilities = if matches.is_present("no_colour") {
// If the user disabled colours assume a dumb terminal
TerminalCapabilities::none()
} else if matches.is_present("ansi_only") {
TerminalCapabilities::ansi()
} else {
TerminalCapabilities::detect()
};
// On Windows 10 we need to enable ANSI term explicitly.
#[cfg(windows)]
{
ansi_term::enable_ansi_support().ok();
}
let filename = value_t!(matches, "filename", String)?;
let dump_events = matches.is_present("dump_events");
let detect_only = matches.is_present("detect_only");
let columns = value_t!(matches, "columns", usize)?;
let resource_access = if matches.is_present("local_only") {
ResourceAccess::LocalOnly
} else {
ResourceAccess::RemoteAllowed
};
Ok(Arguments {
filename,
columns,
resource_access,
dump_events,
detect_only,
terminal_capabilities,
})
}
}
fn main() {
use clap::*;
let size = TerminalSize::detect().unwrap_or_default();
let columns = size.width.to_string();
let app = app_from_crate!()
// Merge flags and options w/ arguments together, include args in usage
// string and show options in the order of declaration. And also:
// COLOURS <3
.setting(AppSettings::UnifiedHelpMessage)
.setting(AppSettings::DontCollapseArgsInUsage)
.setting(AppSettings::DeriveDisplayOrder)
.setting(AppSettings::ColoredHelp)
.after_help(
"mdcat uses the standardized CommonMark dialect. It formats
markdown documents for viewing in text terminals:
• Colours for headings, block quotes, etc
• Syntax highlighting for code blocks
• In some terminals: Inline images and inline links
• In iTerm2: Jump marks for headings
Copyright (C) 2018 Sebastian Wiesner
Licensed under the Apache License, Version 2.0
Report issues to <https://github.com/lunaryorn/mdcat>.",
)
.arg(
Arg::with_name("filename")
.help("The file to read. If - read from standard input instead")
.default_value("-"),
)
.arg(
Arg::with_name("no_colour")
.short("c")
.long("--no-colour")
.aliases(&["nocolour", "no-color", "nocolor"])
.help("Disable all colours and other styles."),
)
.arg(
Arg::with_name("columns")
.long("columns")
.help("Maximum number of columns to use for output")
.default_value(&columns),
)
.arg(
Arg::with_name("local_only")
.short("l")
.long("local")
.help("Do not load remote resources like images"),
)
.arg(
Arg::with_name("dump_events")
.long("dump-events")
.help("Dump Markdown parser events and exit")
.hidden(true),
)
.arg(
Arg::with_name("detect_only")
.long("detect-only")
.help("Only detect the terminal type and exit")
.hidden(true),
)
.arg(
Arg::with_name("ansi_only")
.long("ansi-only")
.help("Limit to standard ANSI formatting")
.conflicts_with("no_colour")
.hidden(true),
);
let matches = app.get_matches();
let arguments = Arguments::from_matches(&matches).unwrap_or_else(|e| e.exit());
match process_arguments(size, arguments) {
Ok(_) => std::process::exit(0),
Err(error) => {
eprintln!("Error: {}", error);
std::process::exit(1);
}
}
}
|
