File: strip_hz_control.Rd

package info (click to toggle)
r-cran-diffobj 0.3.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,432 kB
  • sloc: ansic: 455; javascript: 96; sh: 32; makefile: 8
file content (35 lines) | stat: -rwxr-xr-x 1,182 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/text.R
\name{strip_hz_control}
\alias{strip_hz_control}
\title{Replace Horizontal Spacing Control Characters}
\usage{
strip_hz_control(txt, stops = 8L, sgr.supported)
}
\arguments{
\item{txt}{character to covert}

\item{stops}{integer, what tab stops to use}

\item{sgr.supported}{logical whether the current display device supports
ANSI CSI SGR.  See \code{\link[=diffPrint]{diff*}}'s \code{sgr.supported}
parameter.}
}
\value{
character, `txt` with horizontal control sequences
  replaced.
}
\description{
Removes tabs, newlines, and manipulates the text so that
it looks the same as it did with those horizontal control
characters embedded.  Currently carriage returns are also processed, but
in the future they no longer will be.  This function is used when the
\code{convert.hz.white.space} parameter to the
\code{\link[=diffPrint]{diff*}} methods is active.  The term \dQuote{strip}
is a misnomer that remains for legacy reasons and lazyness.
}
\details{
This is an internal function with exposed documentation because it is
referenced in an external function's documentation.
}
\keyword{internal}