Compare commits

..

4 Commits

6 changed files with 12 additions and 29 deletions

View File

@@ -1,7 +1,7 @@
[package] [package]
name = "ansi" name = "ansi-control-codes"
description = "This library contains all ANSI Escape Codes that are defined in the ISO 6429 Standard" description = "This library contains all ANSI Escape Codes that are defined in the ISO 6429 Standard"
version = "0.1.0" version = "0.0.1"
edition = "2021" edition = "2021"
authors = ["Frank Zechert <rust.frank@zechert.net>"] authors = ["Frank Zechert <rust.frank@zechert.net>"]
@@ -9,8 +9,9 @@ repository = "https://git.zechert.net/fzechert/ansi.git"
license = "MIT" license = "MIT"
# crates.io # crates.io
publish = false publish = true
keywords = ["ansi", "escape codes", "ISO 6429", "ECMA 48", "ANSI X3.64"] keywords = ["ansi", "escape-codes", "ISO-6429", "ECMA-48", "ANSI-X364"]
categories = ["command-line-interface"] categories = ["command-line-interface"]
include = ["**/*.rs", "Cargo.toml"]
[dependencies] [dependencies]

View File

@@ -16,7 +16,7 @@
//! For example, designate the C0 set, then ring the bell. //! For example, designate the C0 set, then ring the bell.
//! //!
//! ``` //! ```
//! use ansi::c0::{ANNOUNCER_SEQUENCE, BEL}; //! use ansi_control_codes::c0::{ANNOUNCER_SEQUENCE, BEL};
//! println!("{}{}", ANNOUNCER_SEQUENCE, BEL); //! println!("{}{}", ANNOUNCER_SEQUENCE, BEL);
//! ``` //! ```
//! //!

View File

@@ -16,7 +16,7 @@
//! For example, designate the C1 set, then set a character tabulation stop. //! For example, designate the C1 set, then set a character tabulation stop.
//! //!
//! ``` //! ```
//! use ansi::c1::{ANNOUNCER_SEQUENCE, HTS}; //! use ansi_control_codes::c1::{ANNOUNCER_SEQUENCE, HTS};
//! println!("{}{}", ANNOUNCER_SEQUENCE, HTS); //! println!("{}{}", ANNOUNCER_SEQUENCE, HTS);
//! ``` //! ```
//! //!

View File

@@ -13,7 +13,7 @@
//! For example, move the cursor to line 5, character 13: //! For example, move the cursor to line 5, character 13:
//! //!
//! ``` //! ```
//! use ansi::control_sequences::CUP; //! use ansi_control_codes::control_sequences::CUP;
//! print!("{}", CUP(Some(5), Some(13))); //! print!("{}", CUP(Some(5), Some(13)));
//! ``` //! ```
//! //!

View File

@@ -12,7 +12,7 @@
//! For example, to disable manual input: //! For example, to disable manual input:
//! //!
//! ``` //! ```
//! use ansi::independent_control_functions::DMI; //! use ansi_control_codes::independent_control_functions::DMI;
//! println!("{}", DMI); //! println!("{}", DMI);
//! ``` //! ```
//! //!

View File

@@ -28,14 +28,14 @@
//! The control functions can be put into normal strings. For example, to ring the bell: //! The control functions can be put into normal strings. For example, to ring the bell:
//! //!
//! ``` //! ```
//! use ansi::c0::BEL; //! use ansi_control_codes::c0::BEL;
//! println!("Let's ring the bell {}", BEL); //! println!("Let's ring the bell {}", BEL);
//! ``` //! ```
//! //!
//! Or to move the cursor to line 5, column 13: //! Or to move the cursor to line 5, column 13:
//! //!
//! ``` //! ```
//! use ansi::control_sequences::CUP; //! use ansi_control_codes::control_sequences::CUP;
//! print!("{}", CUP(5.into(), 13.into())); //! print!("{}", CUP(5.into(), 13.into()));
//! ``` //! ```
//! //!
@@ -43,7 +43,7 @@
//! This is possible by invoking one of the announcer sequences. //! This is possible by invoking one of the announcer sequences.
//! //!
//! ``` //! ```
//! use ansi::c1::{ANNOUNCER_SEQUENCE, NEL}; //! use ansi_control_codes::c1::{ANNOUNCER_SEQUENCE, NEL};
//! // announce the C1 control function set, then move to the next line. //! // announce the C1 control function set, then move to the next line.
//! print!("{}{}", ANNOUNCER_SEQUENCE, NEL); //! print!("{}{}", ANNOUNCER_SEQUENCE, NEL);
//! ``` //! ```
@@ -65,7 +65,6 @@
//! [ecma-48]: https://www.ecma-international.org/publications-and-standards/standards/ecma-48/ //! [ecma-48]: https://www.ecma-international.org/publications-and-standards/standards/ecma-48/
//! [iso-6429]: https://www.iso.org/standard/12782.html //! [iso-6429]: https://www.iso.org/standard/12782.html
//! [wikipedia-ansi]: https://en.wikipedia.org/wiki/ANSI_escape_code //! [wikipedia-ansi]: https://en.wikipedia.org/wiki/ANSI_escape_code
#![allow(dead_code)]
use std::{fmt, str}; use std::{fmt, str};
@@ -139,15 +138,6 @@ enum ControlFunctionType {
/// ///
/// The independent control functions are defined in the module [independent_control_functions]. /// The independent control functions are defined in the module [independent_control_functions].
IndependentControlFunction, IndependentControlFunction,
/// Control Strings.
///
/// A control string is a string of bit combinations which may occur in the data stream as a logical entity for
/// control purposes. A control string consists of an opening delimiter, a command string or character string, and
/// a terminating delimiter, the String Terminator ([`ST`][c1::ST]).
///
/// The control strings are defined in the module [control_strings].
ControlString,
} }
impl fmt::Debug for ControlFunctionType { impl fmt::Debug for ControlFunctionType {
@@ -159,7 +149,6 @@ impl fmt::Debug for ControlFunctionType {
ControlFunctionType::IndependentControlFunction => { ControlFunctionType::IndependentControlFunction => {
write!(f, "Independent Control Function") write!(f, "Independent Control Function")
} }
ControlFunctionType::ControlString => write!(f, "Control String"),
} }
} }
} }
@@ -241,9 +230,6 @@ impl fmt::Display for ControlFunction {
ControlFunctionType::IndependentControlFunction => { ControlFunctionType::IndependentControlFunction => {
write!(f, "{}{}", c0::ESC, self.value) write!(f, "{}{}", c0::ESC, self.value)
} }
ControlFunctionType::ControlString => {
write!(f, "{}", self.value)
}
} }
} }
} }
@@ -296,10 +282,6 @@ mod tests {
format!("{:?}", ControlFunctionType::IndependentControlFunction), format!("{:?}", ControlFunctionType::IndependentControlFunction),
"Independent Control Function" "Independent Control Function"
); );
assert_eq!(
format!("{:?}", ControlFunctionType::ControlString),
"Control String"
);
} }
/// Test the debug format of [`ControlFunction`][crate::ControlFunction]. /// Test the debug format of [`ControlFunction`][crate::ControlFunction].