Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add --no-syntax option #3102

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@
- Use bat's ANSI iterator during tab expansion, see #2998 (@eth-p)
- Support 'statically linked binary' for aarch64 in 'Release' page, see #2992 (@tzq0301)
- Update options in shell completions and the man page of `bat`, see #2995 (@akinomyoga)
- Significantly improve performance by using a buffered writer, see #3101 (@MoSal)
- Add --no-syntax option, see #3102 (@MoSal)

## Syntaxes

Expand Down
3 changes: 3 additions & 0 deletions doc/long-help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ Options:
Alias for '--decorations=always --color=always'. This is useful if the output of bat is
piped to another program, but you want to keep the colorization/decorations.

--no-syntax
Don't pass text to the syntax highlighter in plain mode.

--paging <when>
Specify when to use the pager. To disable the pager, use --paging=never' or its
alias,'-P'. To disable the pager permanently, set BAT_PAGING to 'never'. To control which
Expand Down
5 changes: 5 additions & 0 deletions src/bin/bat/app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,11 @@ impl App {
)),
};

// Add syntax.
if !self.matches.get_flag("no-syntax") {
styled_components.0.insert(StyleComponent::Syntax);
}

// If `grid` is set, remove `rule` as it is a subset of `grid`, and print a warning.
if styled_components.grid() && styled_components.0.remove(&StyleComponent::Rule) {
bat_warning!("Style 'rule' is a subset of style 'grid', 'rule' will not be visible.");
Expand Down
8 changes: 8 additions & 0 deletions src/bin/bat/clap_app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,14 @@ pub fn build_app(interactive_output: bool) -> Command {
if the output of bat is piped to another program, but you want \
to keep the colorization/decorations.")
)
.arg(
Arg::new("no-syntax")
.long("no-syntax")
.action(ArgAction::SetTrue)
.overrides_with("no-syntax")
.hide_short_help(true)
.long_help("Don't pass text to the syntax highlighter in plain mode.")
)
.arg(
Arg::new("paging")
.long("paging")
Expand Down
26 changes: 15 additions & 11 deletions src/controller.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::io::{self, BufRead, Write};
use std::io::{self, BufRead, BufWriter, Write};

use crate::assets::HighlightingAssets;
use crate::config::{Config, VisibleLines};
Expand Down Expand Up @@ -88,9 +88,12 @@ impl<'b> Controller<'b> {
clircle::Identifier::stdout()
};

const BUF_W_SZ: usize = 1 << 14;
let mut writer = match output_buffer {
Some(buf) => OutputHandle::FmtWrite(buf),
None => OutputHandle::IoWrite(output_type.handle()?),
None => {
OutputHandle::IoWrite(BufWriter::with_capacity(BUF_W_SZ, output_type.handle()?))
}
};
let mut no_errors: bool = true;
let stderr = io::stderr();
Expand Down Expand Up @@ -124,10 +127,10 @@ impl<'b> Controller<'b> {
Ok(no_errors)
}

fn print_input<R: BufRead>(
fn print_input<R: BufRead, W: io::Write>(
&self,
input: Input,
writer: &mut OutputHandle,
writer: &mut OutputHandle<W>,
stdin: R,
stdout_identifier: Option<&Identifier>,
is_first: bool,
Expand Down Expand Up @@ -174,7 +177,7 @@ impl<'b> Controller<'b> {
None
};

let mut printer: Box<dyn Printer> = if self.config.loop_through {
let mut printer: Box<dyn Printer<_>> = if self.config.loop_through {
Box::new(SimplePrinter::new(self.config))
} else {
Box::new(InteractivePrinter::new(
Expand All @@ -196,10 +199,10 @@ impl<'b> Controller<'b> {
)
}

fn print_file(
fn print_file<W: io::Write>(
&self,
printer: &mut dyn Printer,
writer: &mut OutputHandle,
printer: &mut dyn Printer<W>,
writer: &mut OutputHandle<W>,
input: &mut OpenedInput,
add_header_padding: bool,
#[cfg(feature = "git")] line_changes: &Option<LineChanges>,
Expand Down Expand Up @@ -234,10 +237,10 @@ impl<'b> Controller<'b> {
Ok(())
}

fn print_file_ranges(
fn print_file_ranges<W: io::Write>(
&self,
printer: &mut dyn Printer,
writer: &mut OutputHandle,
printer: &mut dyn Printer<W>,
writer: &mut OutputHandle<W>,
reader: &mut InputReader,
line_ranges: &LineRanges,
) -> Result<()> {
Expand Down Expand Up @@ -279,6 +282,7 @@ impl<'b> Controller<'b> {
line_number += 1;
line_buffer.clear();
}
writer.flush()?;
Ok(())
}
}
72 changes: 45 additions & 27 deletions src/printer.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use std::fmt;
use std::io;
use std::io::{self, BufWriter, Write};
use std::vec::Vec;

use nu_ansi_term::Color::{Fixed, Green, Red, Yellow};
Expand Down Expand Up @@ -67,35 +67,42 @@ const EMPTY_SYNTECT_STYLE: syntect::highlighting::Style = syntect::highlighting:
font_style: FontStyle::empty(),
};

pub enum OutputHandle<'a> {
IoWrite(&'a mut dyn io::Write),
pub enum OutputHandle<'a, W: io::Write> {
IoWrite(BufWriter<W>),
FmtWrite(&'a mut dyn fmt::Write),
}

impl<'a> OutputHandle<'a> {
impl<'a, W: io::Write> OutputHandle<'a, W> {
fn write_fmt(&mut self, args: fmt::Arguments<'_>) -> Result<()> {
match self {
Self::IoWrite(handle) => handle.write_fmt(args).map_err(Into::into),
Self::FmtWrite(handle) => handle.write_fmt(args).map_err(Into::into),
}
}

pub(crate) fn flush(&mut self) -> Result<()> {
match self {
Self::IoWrite(handle) => handle.flush().map_err(Into::into),
Self::FmtWrite(_handle) => Ok(()),
}
}
}

pub(crate) trait Printer {
pub(crate) trait Printer<W: io::Write> {
fn print_header(
&mut self,
handle: &mut OutputHandle,
handle: &mut OutputHandle<W>,
input: &OpenedInput,
add_header_padding: bool,
) -> Result<()>;
fn print_footer(&mut self, handle: &mut OutputHandle, input: &OpenedInput) -> Result<()>;
fn print_footer(&mut self, handle: &mut OutputHandle<W>, input: &OpenedInput) -> Result<()>;

fn print_snip(&mut self, handle: &mut OutputHandle) -> Result<()>;
fn print_snip(&mut self, handle: &mut OutputHandle<W>) -> Result<()>;

fn print_line(
&mut self,
out_of_range: bool,
handle: &mut OutputHandle,
handle: &mut OutputHandle<W>,
line_number: usize,
line_buffer: &[u8],
) -> Result<()>;
Expand All @@ -115,28 +122,28 @@ impl<'a> SimplePrinter<'a> {
}
}

impl<'a> Printer for SimplePrinter<'a> {
impl<'a, W: io::Write> Printer<W> for SimplePrinter<'a> {
fn print_header(
&mut self,
_handle: &mut OutputHandle,
_handle: &mut OutputHandle<W>,
_input: &OpenedInput,
_add_header_padding: bool,
) -> Result<()> {
Ok(())
}

fn print_footer(&mut self, _handle: &mut OutputHandle, _input: &OpenedInput) -> Result<()> {
fn print_footer(&mut self, _handle: &mut OutputHandle<W>, _input: &OpenedInput) -> Result<()> {
Ok(())
}

fn print_snip(&mut self, _handle: &mut OutputHandle) -> Result<()> {
fn print_snip(&mut self, _handle: &mut OutputHandle<W>) -> Result<()> {
Ok(())
}

fn print_line(
&mut self,
out_of_range: bool,
handle: &mut OutputHandle,
handle: &mut OutputHandle<W>,
_line_number: usize,
line_buffer: &[u8],
) -> Result<()> {
Expand Down Expand Up @@ -321,9 +328,9 @@ impl<'a> InteractivePrinter<'a> {
})
}

fn print_horizontal_line_term(
fn print_horizontal_line_term<W: io::Write>(
&mut self,
handle: &mut OutputHandle,
handle: &mut OutputHandle<W>,
style: Style,
) -> Result<()> {
writeln!(
Expand All @@ -334,7 +341,11 @@ impl<'a> InteractivePrinter<'a> {
Ok(())
}

fn print_horizontal_line(&mut self, handle: &mut OutputHandle, grid_char: char) -> Result<()> {
fn print_horizontal_line<W: io::Write>(
&mut self,
handle: &mut OutputHandle<W>,
grid_char: char,
) -> Result<()> {
if self.panel_width == 0 {
self.print_horizontal_line_term(handle, self.colors.grid)?;
} else {
Expand Down Expand Up @@ -372,7 +383,10 @@ impl<'a> InteractivePrinter<'a> {
}
}

fn print_header_component_indent(&mut self, handle: &mut OutputHandle) -> Result<()> {
fn print_header_component_indent<W: io::Write>(
&mut self,
handle: &mut OutputHandle<W>,
) -> Result<()> {
if self.config.style_components.grid() {
write!(
handle,
Expand All @@ -387,18 +401,18 @@ impl<'a> InteractivePrinter<'a> {
}
}

fn print_header_component_with_indent(
fn print_header_component_with_indent<W: io::Write>(
&mut self,
handle: &mut OutputHandle,
handle: &mut OutputHandle<W>,
content: &str,
) -> Result<()> {
self.print_header_component_indent(handle)?;
writeln!(handle, "{content}")
}

fn print_header_multiline_component(
fn print_header_multiline_component<W: io::Write>(
&mut self,
handle: &mut OutputHandle,
handle: &mut OutputHandle<W>,
content: &str,
) -> Result<()> {
let mut content = content;
Expand Down Expand Up @@ -446,10 +460,10 @@ impl<'a> InteractivePrinter<'a> {
}
}

impl<'a> Printer for InteractivePrinter<'a> {
impl<'a, W: io::Write> Printer<W> for InteractivePrinter<'a> {
fn print_header(
&mut self,
handle: &mut OutputHandle,
handle: &mut OutputHandle<W>,
input: &OpenedInput,
add_header_padding: bool,
) -> Result<()> {
Expand Down Expand Up @@ -549,7 +563,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
Ok(())
}

fn print_footer(&mut self, handle: &mut OutputHandle, _input: &OpenedInput) -> Result<()> {
fn print_footer(&mut self, handle: &mut OutputHandle<W>, _input: &OpenedInput) -> Result<()> {
if self.config.style_components.grid()
&& (self.content_type.map_or(false, |c| c.is_text()) || self.config.show_nonprintable)
{
Expand All @@ -559,7 +573,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
}
}

fn print_snip(&mut self, handle: &mut OutputHandle) -> Result<()> {
fn print_snip(&mut self, handle: &mut OutputHandle<W>) -> Result<()> {
let panel = self.create_fake_panel(" ...");
let panel_count = panel.chars().count();

Expand All @@ -586,7 +600,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
fn print_line(
&mut self,
out_of_range: bool,
handle: &mut OutputHandle,
handle: &mut OutputHandle<W>,
line_number: usize,
line_buffer: &[u8],
) -> Result<()> {
Expand Down Expand Up @@ -625,6 +639,10 @@ impl<'a> Printer for InteractivePrinter<'a> {
line
};

if self.config.style_components.plain() && !self.config.style_components.syntax() {
return write!(handle, "{line}");
}

let regions = self.highlight_regions_for_line(&line)?;
if out_of_range {
return Ok(());
Expand Down
Loading
Loading