feat(parse): Kickstart with vtes code base

In #4, I researched different libs I could use for this but none fit the
bill.  I approached `vte` about making changes to fit our needs but it
didn't seem like there was interest
(alacritty/vte#82), so instead we are using it
as the base for what we need.

crates/anstyle-parse/Cargo.toml

@@ -19,3 +19,13 @@ pre-release-replacements = [
   {file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\n## [Unreleased] - ReleaseDate\n", exactly=1},
   {file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/rust-cli/anstyle/compare/{{tag_name}}...HEAD", exactly=1},
 ]
+
+[dependencies]
+vte_generate_state_changes = { version = "0.1.0" }
+arrayvec = { version = "0.7.2", default-features = false, optional = true }
+utf8parse = { version = "0.2.0" }
+
+[features]
+default = ["no_std"]
+no_std = ["arrayvec"]
+nightly = ["utf8parse/nightly"]

crates/anstyle-parse/LICENSE-APACHE

@@ -199,4 +199,3 @@
    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.
-

crates/anstyle-parse/LICENSE-MIT

@@ -1,19 +1,25 @@
-Copyright (c) 2015 Josh Triplett, 2022 The rust-cli Developers
+Copyright (c) 2016 Joe Wilm and individual contributors
 
-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:
+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 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.
+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.

crates/anstyle-parse/examples/parselog.rs

@@ -0,0 +1,78 @@
+//! Parse input from stdin and log actions on stdout
+use std::io::{self, Read};
+
+use anstyle_parse::{Params, Parser, Perform};
+
+/// A type implementing Perform that just logs actions
+struct Log;
+
+impl Perform for Log {
+    fn print(&mut self, c: char) {
+        println!("[print] {:?}", c);
+    }
+
+    fn execute(&mut self, byte: u8) {
+        println!("[execute] {:02x}", byte);
+    }
+
+    fn hook(&mut self, params: &Params, intermediates: &[u8], ignore: bool, c: char) {
+        println!(
+            "[hook] params={:?}, intermediates={:?}, ignore={:?}, char={:?}",
+            params, intermediates, ignore, c
+        );
+    }
+
+    fn put(&mut self, byte: u8) {
+        println!("[put] {:02x}", byte);
+    }
+
+    fn unhook(&mut self) {
+        println!("[unhook]");
+    }
+
+    fn osc_dispatch(&mut self, params: &[&[u8]], bell_terminated: bool) {
+        println!(
+            "[osc_dispatch] params={:?} bell_terminated={}",
+            params, bell_terminated
+        );
+    }
+
+    fn csi_dispatch(&mut self, params: &Params, intermediates: &[u8], ignore: bool, c: char) {
+        println!(
+            "[csi_dispatch] params={:#?}, intermediates={:?}, ignore={:?}, char={:?}",
+            params, intermediates, ignore, c
+        );
+    }
+
+    fn esc_dispatch(&mut self, intermediates: &[u8], ignore: bool, byte: u8) {
+        println!(
+            "[esc_dispatch] intermediates={:?}, ignore={:?}, byte={:02x}",
+            intermediates, ignore, byte
+        );
+    }
+}
+
+fn main() {
+    let input = io::stdin();
+    let mut handle = input.lock();
+
+    let mut statemachine = Parser::new();
+    let mut performer = Log;
+
+    let mut buf = [0; 2048];
+
+    loop {
+        match handle.read(&mut buf) {
+            Ok(0) => break,
+            Ok(n) => {
+                for byte in &buf[..n] {
+                    statemachine.advance(&mut performer, *byte);
+                }
+            }
+            Err(err) => {
+                println!("err: {}", err);
+                break;
+            }
+        }
+    }
+}

crates/anstyle-parse/src/definitions.rs

@@ -0,0 +1,114 @@
+use core::mem;
+
+#[allow(dead_code)]
+#[derive(Debug, Copy, Clone)]
+pub enum State {
+    Anywhere = 0,
+    CsiEntry = 1,
+    CsiIgnore = 2,
+    CsiIntermediate = 3,
+    CsiParam = 4,
+    DcsEntry = 5,
+    DcsIgnore = 6,
+    DcsIntermediate = 7,
+    DcsParam = 8,
+    DcsPassthrough = 9,
+    Escape = 10,
+    EscapeIntermediate = 11,
+    Ground = 12,
+    OscString = 13,
+    SosPmApcString = 14,
+    Utf8 = 15,
+}
+
+impl Default for State {
+    fn default() -> State {
+        State::Ground
+    }
+}
+
+#[allow(dead_code)]
+#[derive(Debug, Clone, Copy)]
+pub enum Action {
+    None = 0,
+    Clear = 1,
+    Collect = 2,
+    CsiDispatch = 3,
+    EscDispatch = 4,
+    Execute = 5,
+    Hook = 6,
+    Ignore = 7,
+    OscEnd = 8,
+    OscPut = 9,
+    OscStart = 10,
+    Param = 11,
+    Print = 12,
+    Put = 13,
+    Unhook = 14,
+    BeginUtf8 = 15,
+}
+
+/// Unpack a u8 into a State and Action
+///
+/// The implementation of this assumes that there are *precisely* 16 variants for both Action and
+/// State. Furthermore, it assumes that the enums are tag-only; that is, there is no data in any
+/// variant.
+///
+/// Bad things will happen if those invariants are violated.
+#[inline(always)]
+pub fn unpack(delta: u8) -> (State, Action) {
+    unsafe {
+        (
+            // State is stored in bottom 4 bits
+            mem::transmute(delta & 0x0f),
+            // Action is stored in top 4 bits
+            mem::transmute(delta >> 4),
+        )
+    }
+}
+
+#[inline(always)]
+pub const fn pack(state: State, action: Action) -> u8 {
+    (action as u8) << 4 | state as u8
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn unpack_state_action() {
+        match unpack(0xee) {
+            (State::SosPmApcString, Action::Unhook) => (),
+            _ => panic!("unpack failed"),
+        }
+
+        match unpack(0x0f) {
+            (State::Utf8, Action::None) => (),
+            _ => panic!("unpack failed"),
+        }
+
+        match unpack(0xff) {
+            (State::Utf8, Action::BeginUtf8) => (),
+            _ => panic!("unpack failed"),
+        }
+    }
+
+    #[test]
+    fn pack_state_action() {
+        match unpack(0xee) {
+            (State::SosPmApcString, Action::Unhook) => (),
+            _ => panic!("unpack failed"),
+        }
+
+        match unpack(0x0f) {
+            (State::Utf8, Action::None) => (),
+            _ => panic!("unpack failed"),
+        }
+
+        match unpack(0xff) {
+            (State::Utf8, Action::BeginUtf8) => (),
+            _ => panic!("unpack failed"),
+        }
+    }
+}