printer: move PathPrinter into grep-printer

I originally did not put PathPrinter into grep-printer because I
considered it somewhat extraneous to what a "grep" program does, and
also that its implementation was rather simple. But now with hyperlink
support, its implementation has grown a smidge more complicated. And
more importantly, its existence required exposing a lot more of the
hyperlink guts. Without it, we can keep things like HyperlinkPath and
HyperlinkSpan completely private.

We can now also keep `PrinterPath` completely private as well. And this
is a breaking change.

Author: BurntSushi

crates/core/args.rs

@@ -18,8 +18,9 @@ use grep::pcre2::{
     RegexMatcherBuilder as PCRE2RegexMatcherBuilder,
 };
 use grep::printer::{
-    default_color_specs, ColorSpecs, HyperlinkPattern, JSONBuilder, Standard,
-    StandardBuilder, Stats, Summary, SummaryBuilder, SummaryKind, JSON,
+    default_color_specs, ColorSpecs, HyperlinkPattern, JSONBuilder,
+    PathPrinter, PathPrinterBuilder, Standard, StandardBuilder, Stats,
+    Summary, SummaryBuilder, SummaryKind, JSON,
 };
 use grep::regex::{
     RegexMatcher as RustRegexMatcher,
@@ -38,7 +39,6 @@ use crate::app;
 use crate::config;
 use crate::logger::Logger;
 use crate::messages::{set_ignore_messages, set_messages};
-use crate::path_printer::{PathPrinter, PathPrinterBuilder};
 use crate::search::{
     PatternMatcher, Printer, SearchWorker, SearchWorkerBuilder,
 };

crates/core/main.rs

@@ -16,7 +16,6 @@ mod app;
 mod args;
 mod config;
 mod logger;
-mod path_printer;
 mod search;
 mod subject;
 
@@ -248,7 +247,7 @@ fn files(args: &Args) -> Result<bool> {
             if quit_after_match {
                 break;
             }
-            if let Err(err) = path_printer.write_path(subject.path()) {
+            if let Err(err) = path_printer.write(subject.path()) {
                 // A broken pipe means graceful termination.
                 if err.kind() == io::ErrorKind::BrokenPipe {
                     break;
@@ -293,7 +292,7 @@ fn files_parallel(args: &Args) -> Result<bool> {
 
     let print_thread = thread::spawn(move || -> io::Result<()> {
         for subject in rx.iter() {
-            path_printer.write_path(subject.path())?;
+            path_printer.write(subject.path())?;
         }
         Ok(())
     });

crates/core/path_printer.rs

@@ -59,7 +59,7 @@ pub enum HyperlinkPatternError {
 
 /// The values to replace the pattern placeholders with.
 #[derive(Clone, Debug)]
-pub struct HyperlinkValues<'a> {
+pub(crate) struct HyperlinkValues<'a> {
     file: &'a HyperlinkPath,
     line: u64,
     column: u64,
@@ -70,7 +70,7 @@ pub struct HyperlinkValues<'a> {
 /// This is the value to use as-is in the hyperlink, converted from an OS file
 /// path.
 #[derive(Clone, Debug)]
-pub struct HyperlinkPath(Vec<u8>);
+pub(crate) struct HyperlinkPath(Vec<u8>);
 
 impl HyperlinkPatternBuilder {
     /// Creates a new hyperlink pattern builder.
@@ -222,7 +222,7 @@ impl HyperlinkPattern {
     }
 
     /// Renders this pattern with the given values to the given output.
-    pub fn render(
+    pub(crate) fn render(
         &self,
         values: &HyperlinkValues,
         output: &mut impl Write,
@@ -353,7 +353,7 @@ impl std::error::Error for HyperlinkPatternError {}
 
 impl<'a> HyperlinkValues<'a> {
     /// Creates a new set of hyperlink values.
-    pub fn new(
+    pub(crate) fn new(
         file: &'a HyperlinkPath,
         line: Option<u64>,
         column: Option<u64>,
@@ -369,7 +369,7 @@ impl<'a> HyperlinkValues<'a> {
 impl HyperlinkPath {
     /// Returns a hyperlink path from an OS path.
     #[cfg(unix)]
-    pub fn from_path(path: &Path) -> Option<Self> {
+    pub(crate) fn from_path(path: &Path) -> Option<Self> {
         // On Unix, this function returns the absolute file path without the
         // leading slash, as it makes for more natural hyperlink patterns, for
         // instance:
@@ -506,14 +506,14 @@ impl std::fmt::Display for HyperlinkPath {
 /// A simple abstraction over a hyperlink span written to the terminal. This
 /// helps tracking whether a hyperlink has been started, and should be ended.
 #[derive(Debug, Default)]
-pub struct HyperlinkSpan {
+pub(crate) struct HyperlinkSpan {
     active: bool,
 }
 
 impl HyperlinkSpan {
     /// Starts a hyperlink and returns a span which tracks whether it is still
     /// in effect.
-    pub fn start(
+    pub(crate) fn start(
         wtr: &mut impl WriteColor,
         hyperlink: &HyperlinkSpec,
     ) -> io::Result<Self> {
@@ -526,7 +526,7 @@ impl HyperlinkSpan {
     }
 
     /// Ends the hyperlink span if it is active.
-    pub fn end(&mut self, wtr: &mut impl WriteColor) -> io::Result<()> {
+    pub(crate) fn end(&mut self, wtr: &mut impl WriteColor) -> io::Result<()> {
         if self.is_active() {
             wtr.set_hyperlink(&HyperlinkSpec::close())?;
             self.active = false;
@@ -535,7 +535,7 @@ impl HyperlinkSpan {
     }
 
     /// Returns true if there is currently an active hyperlink.
-    pub fn is_active(&self) -> bool {
+    pub(crate) fn is_active(&self) -> bool {
         self.active
     }
 }

crates/printer/src/hyperlink.rs

@@ -65,13 +65,12 @@ assert_eq!(output, expected);
 pub use crate::{
     color::{default_color_specs, ColorError, ColorSpecs, UserColorSpec},
     hyperlink::{
-        HyperlinkPath, HyperlinkPattern, HyperlinkPatternBuilder,
-        HyperlinkPatternError, HyperlinkSpan, HyperlinkValues,
+        HyperlinkPattern, HyperlinkPatternBuilder, HyperlinkPatternError,
     },
+    path::{PathPrinter, PathPrinterBuilder},
     standard::{Standard, StandardBuilder, StandardSink},
     stats::Stats,
     summary::{Summary, SummaryBuilder, SummaryKind, SummarySink},
-    util::PrinterPath,
 };
 
 #[cfg(feature = "serde")]
@@ -99,6 +98,7 @@ mod hyperlink_aliases;
 mod json;
 #[cfg(feature = "serde")]
 mod jsont;
+mod path;
 mod standard;
 mod stats;
 mod summary;