roff-0.2.1/.cargo_vcs_info.json0000644000000001360000000000100117700ustar { "git": { "sha1": "f2284b904c1aaed8ed9302c6c725e18320cd6bb4" }, "path_in_vcs": "" }roff-0.2.1/Cargo.toml0000644000000035160000000000100077730ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] name = "roff" version = "0.2.1" include = ["build.rs", "src/**/*", "Cargo.toml", "LICENSE*", "README.md", "benches/**/*", "examples/**/*"] description = "ROFF (man page format) generation library" homepage = "https://github.com/rust-cli/roff-rs" documentation = "https://docs.rs/roff" readme = "README.md" keywords = ["cli", "man", "roff"] categories = ["development-tools::testing"] license = "MIT OR Apache-2.0" repository = "https://github.com/rust-cli/roff-rs" [[package.metadata.release.pre-release-replacements]] file = "CHANGELOG.md" min = 1 replace = "{{version}}" search = "Unreleased" [[package.metadata.release.pre-release-replacements]] exactly = 1 file = "CHANGELOG.md" replace = "...{{tag_name}}" search = "\\.\\.\\.HEAD" [[package.metadata.release.pre-release-replacements]] file = "CHANGELOG.md" min = 1 replace = "{{date}}" search = "ReleaseDate" [[package.metadata.release.pre-release-replacements]] exactly = 1 file = "CHANGELOG.md" replace = "\n## [Unreleased] - ReleaseDate\n" search = "" [[package.metadata.release.pre-release-replacements]] exactly = 1 file = "CHANGELOG.md" replace = "\n[Unreleased]: https://github.com/rust-cli/roff-rs/compare/{{tag_name}}...HEAD" search = "" [dependencies] [dev-dependencies.duct] version = "0.13" [dev-dependencies.pretty_assertions] version = "1.0.0" roff-0.2.1/Cargo.toml.orig000064400000000000000000000022210072674642500134740ustar 00000000000000[package] name = "roff" version = "0.2.1" description = "ROFF (man page format) generation library" license = "MIT OR Apache-2.0" repository = "https://github.com/rust-cli/roff-rs" homepage = "https://github.com/rust-cli/roff-rs" documentation = "https://docs.rs/roff" readme = "README.md" categories = ["development-tools::testing"] keywords = ["cli", "man", "roff"] include = [ "build.rs", "src/**/*", "Cargo.toml", "LICENSE*", "README.md", "benches/**/*", "examples/**/*" ] [package.metadata.release] pre-release-replacements = [ {file="CHANGELOG.md", search="Unreleased", replace="{{version}}", min=1}, {file="CHANGELOG.md", search="\\.\\.\\.HEAD", replace="...{{tag_name}}", exactly=1}, {file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}", min=1}, {file="CHANGELOG.md", search="", replace="\n## [Unreleased] - ReleaseDate\n", exactly=1}, {file="CHANGELOG.md", search="", replace="\n[Unreleased]: https://github.com/rust-cli/roff-rs/compare/{{tag_name}}...HEAD", exactly=1}, ] [dependencies] [dev-dependencies] pretty_assertions = "1.0.0" duct = "0.13" roff-0.2.1/LICENSE-APACHE000064400000000000000000000261360072674642500125440ustar 00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} 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. roff-0.2.1/LICENSE-MIT000064400000000000000000000020520072674642500122430ustar 00000000000000Copyright (c) 2015 The roff-rs Developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. roff-0.2.1/README.md000064400000000000000000000052330072674642500120720ustar 00000000000000# roff-rs [![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation] ![License](https://img.shields.io/crates/l/roff.svg) [![crates.io](https://img.shields.io/crates/v/roff.svg)][Crates.io] [Crates.io]: https://crates.io/crates/roff [Documentation]: https://docs.rs/roff/ [Roff](http://man7.org/linux/man-pages/man7/roff.7.html) generation library. ## Examples ```rust use roff::{bold, italic, roman, Roff}; fn main() { let page = Roff::new() .control("TH", ["CORRUPT", "1"]) .control("SH", ["NAME"]) .text([roman("corrupt - modify files by randomly changing bits")]) .control("SH", ["SYNOPSIS"]) .text([bold("corrupt"), roman(" ["), bold("-n"), roman(" "), italic("BITS"), roman("] ["), bold("--bits"), roman(" "), italic("BITS"), roman("] "), italic("FILE"), roman("..."), ]) .control("SH", ["DESCRIPTION"]) .text([bold("corrupt"), roman(" modifies files by toggling a randomly chosen bit.")]) .control("SH", ["OPTIONS"]) .control("TP", []) .text([bold("-n"), roman(", "), bold("--bits"), roman("="), italic("BITS")]) .text([roman("Set the number of bits to modify. Default is one bit.")]); .render(); print!("{}", page); ``` Which outputs: ```troff .ie \n(.g .ds Aq \(aq .el .ds Aq ' .TH CORRUPT 1 .SH NAME corrupt \- modify files by randomly changing bits .SH SYNOPSIS \fBcorrupt\fR [\fB\-n\fR \fIBITS\fR] [\fB\-\-bits\fR \fIBITS\fR] \fIFILE\fR... .SH DESCRIPTION \fBcorrupt\fR modifies files by toggling a randomly chosen bit. .SH OPTIONS .TP \fB\-n\fR, \fB\-\-bits\fR=\fIBITS\fR Set the number of bits to modify. Default is one bit. ``` Which will be shown by the `man(1)` command as: ```txt CORRUPT(1) General Commands Manual CORRUPT(1) NAME corrupt - modify files by randomly changing bits SYNOPSIS corrupt [-n BITS] [--bits BITS] FILE... DESCRIPTION corrupt modifies files by toggling a randomly chosen bit. OPTIONS -n, --bits=BITS Set the number of bits to modify. Default is one bit. CORRUPT(1) ``` ## License Licensed under either of * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. ### Contribution Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. roff-0.2.1/src/lib.rs000064400000000000000000000340520072674642500125170ustar 00000000000000//! A document in the ROFF format. //! //! [ROFF] is a family of Unix text-formatting languages, implemented //! by the `nroff`, `troff`, and `groff` programs, among others. See //! [groff(7)] for a description of the language. This structure is an //! abstract representation of a document in ROFF format. It is meant //! for writing code to generate ROFF documents, such as manual pages. //! //! # Example //! //! ``` //! # use roff::*; //! let doc = Roff::new().text(vec![roman("hello, world")]).render(); //! assert!(doc.ends_with("hello, world\n")); //! ``` //! //! [ROFF]: https://en.wikipedia.org/wiki/Roff_(software) //! [groff(7)]: https://manpages.debian.org/bullseye/groff/groff.7.en.html #![warn(missing_docs)] use std::io::Write; use std::write; /// A ROFF document, consisting of lines. /// /// Lines are either control lines (requests that are built in, or /// invocations of macros), or text lines. /// /// # Example /// /// ``` /// # use roff::*; /// let doc = Roff::new() /// .control("TH", ["FOO", "1"]) /// .control("SH", ["NAME"]) /// .text([roman("foo - do a foo thing")]) /// .render(); /// assert!(doc.ends_with(".TH FOO 1\n.SH NAME\nfoo \\- do a foo thing\n")); /// ``` #[derive(Debug, PartialEq, Eq, Default)] pub struct Roff { lines: Vec, } impl Roff { /// Instantiate a `Roff` pub fn new() -> Self { Default::default() } /// Append a control line. /// /// The line consist of the name of a built-in command or macro, /// and some number of arguments. Arguments that contain spaces /// will be enclosed with double quotation marks. pub fn control<'a>( &mut self, name: impl Into, args: impl IntoIterator, ) -> &mut Self { self.lines.push(Line::control( name.into(), args.into_iter().map(|s| s.to_string()).collect(), )); self } /// Append a text line. /// /// The line will be rendered in a way that ensures it can't be /// interpreted as a control line. The caller does not need to /// ensure, for example, that the line doesn't start with a /// period ("`.`") or an apostrophe ("`'`"). pub fn text(&mut self, inlines: impl Into>) -> &mut Self { self.lines.push(Line::text(inlines.into())); self } /// Render as ROFF source text that can be fed to a ROFF implementation. pub fn render(&self) -> String { let mut buf = vec![]; self.to_writer(&mut buf).unwrap(); // writing to a Vec always works String::from_utf8(buf) .expect("output is utf8 if all input is utf8 and our API guarantees that") } /// Write to a writer. pub fn to_writer(&self, w: &mut dyn Write) -> Result<(), std::io::Error> { w.write_all(APOSTROPHE_PREABMLE.as_bytes())?; for line in self.lines.iter() { line.render(w, Apostrophes::Handle)?; } Ok(()) } /// Render without handling apostrophes specially. /// /// You probably want [`render`](Roff::render) or /// [`to_writer`](Roff::to_writer) instead of this method. /// /// Without special handling, apostrophes get typeset as right /// single quotes, including in words like "don't". In most /// situations, such as in manual pages, that's unwanted. The /// other methods handle apostrophes specially to prevent it, but /// for completeness, and for testing, this method is provided to /// avoid it. pub fn to_roff(&self) -> String { let mut buf = vec![]; for line in self.lines.iter() { // Writing to a Vec always works, so we discard any error. line.render(&mut buf, Apostrophes::DontHandle).unwrap(); } String::from_utf8(buf) .expect("output is utf8 if all input is utf8 and our API guarantees that") } } impl> From for Roff { fn from(other: I) -> Self { let mut r = Roff::new(); r.text([other.into()]); r } } impl> std::iter::FromIterator for Roff { fn from_iter>(iter: I) -> Self { let mut r = Roff::new(); for i in iter { r.lines.extend(i.into().lines) } r } } impl> Extend for Roff { fn extend>(&mut self, iter: T) { for i in iter { self.lines.extend(i.into().lines) } } } /// A part of a text line. /// /// Text will be escaped for ROFF. No inline escape sequences will be /// passed to ROFF. The text may contain newlines, but leading periods /// will be escaped so that they won't be interpreted by ROFF as /// control lines. /// /// Note that the strings stored in the variants are stored as they're /// received from the API user. The Line::render function handles /// escaping etc. #[derive(Debug, PartialEq, Eq, Clone)] pub enum Inline { /// Text in the "roman" font, which is the normal font if nothing /// else is specified. Roman(String), /// Text in the italic (slanted) font. Italic(String), /// Text in a bold face font. Bold(String), /// A hard line break. This is an inline element so it's easy to /// insert a line break in a paragraph. LineBreak, } /// Turn a string slice into inline text in the roman font. /// /// This is equivalent to the [roman] function, but may be more /// convenient to use. impl> From for Inline { fn from(s: S) -> Self { roman(s) } } /// Return some inline text in the "roman" font. /// /// The roman font is the normal font, if no other font is chosen. pub fn roman(input: impl Into) -> Inline { Inline::Roman(input.into()) } /// Return some inline text in the bold font. pub fn bold(input: impl Into) -> Inline { Inline::Bold(input.into()) } /// Return some inline text in the italic font. pub fn italic(input: impl Into) -> Inline { Inline::Italic(input.into()) } /// Return an inline element for a hard line break. pub fn line_break() -> Inline { Inline::LineBreak } /// A line in a ROFF document. #[derive(Debug, PartialEq, Eq, Clone)] pub(crate) enum Line { /// A control line. Control { /// Name of control request or macro being invoked. name: String, /// Arguments on control line. args: Vec, }, /// A text line. Text(Vec), } impl Line { /// Append a control line. pub(crate) fn control(name: String, args: Vec) -> Self { Self::Control { name, args } } /// Append a text line, consisting of inline elements. pub(crate) fn text(parts: Vec) -> Self { Self::Text(parts) } /// Generate a ROFF line. /// /// All the ROFF code generation and special handling happens here. fn render( &self, out: &mut dyn Write, handle_apostrophes: Apostrophes, ) -> Result<(), std::io::Error> { match self { Self::Control { name, args } => { write!(out, ".{}", name)?; for arg in args { write!(out, " {}", &escape_spaces(arg))?; } } Self::Text(inlines) => { let mut at_line_start = true; for inline in inlines.iter() { // We need to handle line breaking specially: it // introduces a control line to the ROFF, and the // leading period of that mustn't be escaped. match inline { Inline::LineBreak => { if at_line_start { writeln!(out, ".br")?; } else { writeln!(out, "\n.br")?; } } Inline::Roman(text) | Inline::Italic(text) | Inline::Bold(text) => { let mut text = escape_inline(text); if handle_apostrophes == Apostrophes::Handle { text = escape_apostrophes(&text) }; let text = escape_leading_cc(&text); if let Inline::Bold(_) = inline { write!(out, r"\fB{}\fR", text)?; } else if let Inline::Italic(_) = inline { write!(out, r"\fI{}\fR", text)?; } else { if at_line_start && starts_with_cc(&text) { // Line would start with a period, so we // insert a non-printable, zero-width glyph to // prevent it from being interpreted as such. // We only do that when it's needed, though, // to avoid making the output ugly. // // Note that this isn't handled by // escape_leading_cc, as it // doesn't know when an inline // element is at the start of a // line. write!(out, r"\&").unwrap(); } write!(out, "{}", text)?; } } } at_line_start = false; } } }; writeln!(out)?; Ok(()) } } /// Does line start with a control character? fn starts_with_cc(line: &str) -> bool { line.starts_with('.') || line.starts_with('\'') } /// This quotes strings with spaces. This doesn't handle strings with /// quotes in any way: there doesn't seem to a way to escape them. fn escape_spaces(w: &str) -> String { if w.contains(' ') { format!("\"{}\"", w) } else { w.to_string() } } /// Prevent leading periods or apostrophes on lines to be interpreted /// as control lines. Note that this needs to be done for apostrophes /// whether they need special handling for typesetting or not: a /// leading apostrophe on a line indicates a control line. fn escape_leading_cc(s: &str) -> String { s.replace("\n.", "\n\\&.").replace("\n'", "\n\\&'") } /// Escape anything that may be interpreted by the roff processor in a /// text line: dashes and backslashes are escaped with a backslash. /// Apostrophes are not handled. fn escape_inline(text: &str) -> String { text.replace(r"\", r"\\").replace('-', r"\-") } /// Handle apostrophes. fn escape_apostrophes(text: &str) -> String { text.replace('\'', APOSTROPHE) } #[derive(Eq, PartialEq)] enum Apostrophes { Handle, DontHandle, } /// Use the apostrophe string variable. const APOSTROPHE: &str = r"\*(Aq"; /// A preamble added to the start of rendered output. /// /// This defines a string variable that contains an apostrophe. For /// historical reasons, there seems to be no other portable way to /// represent apostrophes across various implementations of the ROFF /// language. In implementations that produce output like PostScript /// or PDF, an apostrophe gets typeset as a right single quote, which /// looks different from an apostrophe. For terminal output ("ASCII"), /// such as when using nroff, an apostrophe looks indistinguishable /// from a right single quote. For manual pages, and similar content, /// an apostrophe is more generally desired than the right single /// quote, so we convert all apostrophe characters in input text into /// a use of the string variable defined in the preamble. /// /// The special handling of apostrophes is avoided in the /// [`to_roff`](Roff::to_roff) method, but it's used in the /// [`render`](Roff::render) and [`to_writer`](Roff::to_writer) /// methods. /// /// See: const APOSTROPHE_PREABMLE: &str = r#".ie \n(.g .ds Aq \(aq .el .ds Aq ' "#; #[cfg(test)] mod test { use super::*; #[test] fn escape_dash() { assert_eq!(r"\-", escape_inline("-")); } #[test] fn escape_backslash() { assert_eq!(r"\\x", escape_inline(r"\x")); } #[test] fn escape_backslash_and_dash() { assert_eq!(r"\\\-", escape_inline(r"\-")); } #[test] fn escapes_leading_control_chars() { assert_eq!("foo\n\\&.bar\n\\&'yo", escape_leading_cc("foo\n.bar\n'yo")); } #[test] fn escape_plain() { assert_eq!("abc", escape_inline("abc")); } #[test] fn render_roman() { let text = Roff::new().text([roman("foo")]).to_roff(); assert_eq!(text, "foo\n"); } #[test] fn render_dash() { let text = Roff::new().text([roman("foo-bar")]).to_roff(); assert_eq!(text, "foo\\-bar\n"); } #[test] fn render_italic() { let text = Roff::new().text([italic("foo")]).to_roff(); assert_eq!(text, "\\fIfoo\\fR\n"); } #[test] fn render_bold() { let text = Roff::new().text([bold("foo")]).to_roff(); assert_eq!(text, "\\fBfoo\\fR\n"); } #[test] fn render_text() { let text = Roff::new().text([roman("roman")]).to_roff(); assert_eq!(text, "roman\n"); } #[test] fn render_text_with_leading_period() { let text = Roff::new().text([roman(".roman")]).to_roff(); assert_eq!(text, "\\&.roman\n"); } #[test] fn render_text_with_newline_period() { let text = Roff::new().text([roman("foo\n.roman")]).to_roff(); assert_eq!(text, "foo\n\\&.roman\n"); } #[test] fn render_line_break() { let text = Roff::new() .text([roman("roman"), Inline::LineBreak, roman("more")]) .to_roff(); assert_eq!(text, "roman\n.br\nmore\n"); } #[test] fn render_control() { let text = Roff::new().control("foo", ["bar", "foo and bar"]).to_roff(); assert_eq!(text, ".foo bar \"foo and bar\"\n"); } }