Version 0.26.1

Added ⭐

• Add synchronized output/update control (#756)
• Add kitty report alternate keys functionality (#754)
• Updated dev dependencies.

Fixed 🐛

• Fix incorrect return in kitty keyboard enhancement check (#751)
• Fix panic when using use-dev-tty feature flag (#762)

Contributors

@yyogo @jcdickinson @the-mikedavis

Added ⭐

• Add SetCursorStyle to set the cursor appearance and visibility. (#742)
• Add key release event for windows. (#745)
• Add a function to check if the kitty keyboard enhancement protocol is available. (#732)
• Add filedescriptors poll in order to move away from mio in the future (can be used via use-dev-tty). (#735)

Fixed 🐛

• Improved F1-F4 handling for kitty keyboard protocol. (#736)
• Improved parsing of event types/modifiers with certain keys for kitty protocol. (#716)

Breaking ⚠️

• Remove SetCursorShape in vavour of SetCursorStyle. (#742)
• Make Windows resize event match terminal::size (#714)

Contributors

@pianohacker , @AhoyISki , @Cl00e9ment , @yyogo , @the-mikedavis , @djarb , @Piturnah , @MitMaro , @Yusuto , @generic-user1 , @baldoalessandro , @CenTdemeern1 , @Blatko1 , @aaarkid @basilkohler , @TimonPost

BREAKING: Copy trait is removed from Event, you can keep it by removing the "bracked-paste" feature flag. However this flag might be standardized in the future. We removed the Copy from Event because the new Paste event, which contains a pasted string into the terminal, which is a non-copy string.

• Add ability to paste a string in into the terminal and fetch the pasted string via events (see Event::Paste and EnableBracketedPaste ).
• Add support for functional key codes from kitty keyboard protocol. Try out by PushKeyboardEnhancementFlags. This protocol allows for:
  • See: https://sw.kovidgoyal.net/kitty/keyboard-protocol/#modifiers
  • Press, Repeat, Release event kinds.
  • SUPER, HYPER, META modifiers.
  • Media keycodes
  • Right/left SHIFT, Control, Alt, Super, Hyper, Meta
  • IsoLevel3Shift, IsoLevel5Shift
  • Capslock, scroll lock, numlock
  • Printscreen, pauze, menue, keyboard begin.
• Create SetStyle command to allow setting various styling in one command.
• Terminal Focus events (see Event::FocusGained and Event::FocusLost)

• Add DoubleUnderlined, Undercurled, Underdots the text, Underdotted, Underdashes, Underdashed attributes and allow coloring their foreground / background color.
• Fix windows unicode character parsing, this fixed various key combinations and support typing unicode characters.
• Consistency and better documentation on mouse cursor operations (BREAKING CHANGE).
  • MoveTo, MoveToColumn, MoveToRow are 0-based. (left top most cell is 0,0). Moving like this is absolute
  • MoveToNextLine, MoveToPreviousLine, MoveUp, MoveDown, MoveRight, MoveLeft are 1-based,. Moving like this is relative. Moving 1 left means moving 1 left. Moving 0 to the left is not possible, wikipedia states that most terminals will just default to 1.
• terminal::size returns error when previously it returned (0,0).
• Remove println from serialisation code.
• Fix mouse up for middle and right buttons.
• Fix escape codes on Git-Bash + Windows Terminal / Alacritty / WezTerm.
• Add support for cursor keys in application mode.

• Update signal-hook and mio to version 0.8.

• Fix control key parsing problem.

• Update yanked version crossterm-winapi and move to crossterm-winapi 0.9.0.
• Changed panic to error when calling disable-mouse capture without setting it first.
• Update bitflags dependency.

• Fix panic when only setting bold and redirecting stdout.
• Use tty_fd for set/get terminal attributes

• Fix enabling ANSI support when stdout is redirected
• Update crossterm-winapi to 0.6.2

• Fix get position bug
• Fix windows 8 or lower write to user-given stdout instead of stdout.
• Make MoveCursor(Left/Right/Up/Dow) command with input 0 not move.
• Switch to futures-core to reduce dependencies.
• Command API restricts to only accept std::io::Write
• Make supports_ansi public
• Implement ALT + numbers windows systems.

• Fix cursor position retrieval bug linux.

• Add functionality to retrieve color based on passed ansi code.
• Switch from 'futures' to 'futures-util' crate to reduce dependency count
• Mio 0.7 update
• signal-hook update
• Make windows raw_mode act on CONIN$
• Added From<(u8, u8, u8)> Trait to Color::Rgb Enum
• Implement Color::try_from()
• Implement styler traits for &'a str

• Improved support of keymodifier for linux, arrow keys, function keys, home keys etc.
• Add SetTitle command to change the terminal title.
• Mio 0.7 update

• Add macros for Colorize and Styler impls, add an impl for String
• Add shift modifier to uppercase char events on unix

• Fix get terminal size mac os, this did not report the correct size.

• Windows unicode support

• Reverted bug in 0.17.0: "Make terminal size function fallback to STDOUT_FILENO if /dev/tty is missing.".
• Support for querying whether the current instance is a TTY.

• Change attribute vector in ContentStyle to bitmask.
• Add SetAttributes command.
• Add Attributes type, which is a bitfield of enabled attributes.
• Remove exit(), was useless.

• Fix CTRL + J key combination. This used to return an ENTER event.
• Add a generic implementation Command for &T: Command. This allows commands to be queued by reference, as well as by value.
• Remove unnecessary Clone trait bounds from StyledContent.
• Add StyledContent::style_mut.
• Handle error correctly for execute! and queue!.
• Fix minor syntax bug in execute! and queue!.
• Change ContentStyle::apply to take self by value instead of reference, to prevent an unnecessary extra clone.
• Added basic trait implementations (Debug, Clone, Copy, etc) to all of the command structs
• ResetColor uses &'static str instead of String

• Fix TIOCGWINSZ for FreeBSD

• Made windows cursor position relative to the window instead absolute to the screen buffer windows.
• Fix windows bug with queue macro were it consumed a type and required an type to be Copy.

• Remove thread from AsyncReader on Windows.
• Improve HANDLE management windows.

• New input::stop_reading_thread() function
  • Temporary workaround for the UNIX platform to stop the background reading thread and close the file descriptor
  • This function will be removed in the next version

• Async Reader fix, join background thread and avoid looping forever on windows.

Major API-change, removed old-api

• Remove Crossterm type
• Remove TerminalCursor, TerminalColor, Terminal
• Remove cursor(), color() , terminal()
• Remove re-exports at root, accessible via module::types (cursor::MoveTo)
• input module
  • Derive 'Copy' for 'KeyEvent'
  • Add the EnableMouseCapture and EnableMouseCapture commands
• cursor module
  • Introduce static function crossterm::cursor::position in place of TerminalCursor::pos
  • Rename Goto to MoveTo
  • Rename Up to MoveLeft
  • Rename Right to MoveRight
  • Rename Down to MoveDown
  • Rename BlinkOn to EnableBlinking
  • Rename BlinkOff to DisableBlinking
  • Rename ResetPos to ResetPosition
  • Rename SavePos to SavePosition
• terminal
  • Introduce static function crossterm::terminal::size in place of Terminal::size
  • Introduce static function crossterm::terminal::exit in place of Terminal::exit
• style module
  • Rename ObjectStyle to ContentStyle. Now full names are used for methods
  • Rename StyledObject to StyledContent and made members private
  • Rename PrintStyledFont to PrintStyledContent
  • Rename attr method to attribute.
  • Rename Attribute::NoInverse to NoReverse
  • Update documentation
  • Made Colored private, user should use commands instead
  • Rename SetFg -> SetForegroundColor
  • Rename SetBg -> SetBackgroundColor
  • Rename SetAttr -> SetAttribute
  • Rename ContentStyle::fg_color -> ContentStyle::foreground_color
  • Rename ContentStyle::bg_color -> ContentStyle::background_color
  • Rename ContentStyle::attrs -> ContentStyle::attributes
• Improve documentation
• Unix terminal size calculation with TPUT

• Move all the crossterm_ crates code was moved to the crossterm crate
  • crossterm_cursor is in the cursor module, etc.
  • All these modules are public
• No public API breaking changes

• Following crates are deprecated and no longer maintained
  • crossterm_cursor
  • crossterm_input
  • crossterm_screen
  • crossterm_style
  • crossterm_terminal
  • crossterm_utils

crossterm_cursor 0.4.0

• Fix examples link (PR #6)
• Sync documentation style (PR #7)
• Remove all references to the crossterm book (PR #8)
• Replace RAW_MODE_ENABLED with is_raw_mode_enabled (PR #9)
• Use SyncReader & InputEvent::CursorPosition for pos_raw() (PR #10)

crossterm_input 0.5.0

• Sync documentation style (PR #4)
• Sync SyncReader::next() Windows and UNIX behavior (PR #5)
• Remove all references to the crossterm book (PR #6)
• Mouse coordinates synchronized with the cursor (PR #7)
  • Upper/left reported as (0, 0)
• Fix bug that read sync didn't block (Windows) (PR #8)
• Refactor UNIX readers (PR #9)
  • AsyncReader produces mouse events
  • One reading thread per application, not per AsyncReader
  • Cursor position no longer consumed by another AsyncReader
  • Implement sync reader for read_char (requires raw mode)
  • Fix SIGTTIN when executed under the LLDB
  • Add mio for reading from FD and more efficient polling (UNIX only)
• Sync UNIX and Windows vertical mouse position (PR #11)
  • Top is always reported as 0

crossterm_screen 0.3.2

• to_alternate switch back to main screen if it fails to switch into raw mode (PR #4)
• Improve the documentation (PR #5)
  • Public API
  • Include the book content in the documentation
• Remove all references to the crossterm book (PR #6)
• New commands introduced (PR #7)
  • EnterAlternateScreen
  • LeaveAlternateScreen
• Sync Windows and UNIX raw mode behavior (PR #8)

crossterm_style 0.5.2

• Refactor (PR #2)
  • Added unit tests
  • Improved documentation and added book page to lib.rs
  • Fixed bug with SetBg command, WinApi logic
  • Fixed bug with StyledObject, used stdout for resetting terminal color
  • Introduced ResetColor command
• Sync documentation style (PR #3)
• Remove all references to the crossterm book (PR #4)
• Windows 7 grey/white foreground/intensity swapped (PR #5)

crossterm_terminal 0.3.2

• Removed crossterm_cursor::sys dependency (PR #2)
• Internal refactoring & documentation (PR #3)
• Removed all references to the crossterm book (PR #4)

crossterm_utils 0.4.0

• Add deprecation note (PR #3)
• Remove all references to the crossterm book (PR #4)
• Remove unsafe static mut (PR #5)
  • sys::unix::RAW_MODE_ENABLED replaced with sys::unix::is_raw_mode_enabled() (breaking)
  • New lazy_static dependency

crossterm_winapi 0.3.0

• Make read sync block for windows systems (PR #2)

• Maintenance release
• All sub-crates were moved to their own repositories in the crossterm-rs organization

As a preparation for crossterm 0.1.0 we have moved crossterm to an organisation called 'crossterm-rs'.

Code Quality

• Code Cleanup: warning-cleanup, crossterm_style-cleanup, crossterm_screen-cleanup, crossterm_terminal-cleanup, crossterm_utils-cleanup, 2018-cleanup, api-cleanup-1, api-cleanup-2, api-cleanup-3
• Examples: example-cleanup_1, example-cleanup_2, example-fix, commandbar-fix, snake-game-improved
• Fixed all broken tests and added tests

Important Changes

• Return written bytes: return-written-bytes
• Added derives: Debug for ObjectStyle debug-derive, Serialize/Deserialize for key events serde
• Improved error handling:
  • Return crossterm::Result from all api's: return_crossterm_result
    • TerminalCursor::pos() returns Result<(u16, u16)>
    • Terminal::size() returns Result<(u16, u16)>
    • TerminalCursor::move_* returns crossterm::Result
    • ExecutableCommand::queue returns crossterm::Result
    • QueueableCommand::queue returns crossterm::Result
    • get_available_color_count returns no result
    • RawScreen::into_raw_mode returns crossterm::Result instead of io::Result
    • RawScreen::disable_raw_mode returns crossterm::Result instead of io::Result
    • AlternateScreen::to_alternate returns crossterm::Result instead of io::Result
    • TerminalInput::read_line returns crossterm::Result instead of io::Result
    • TerminalInput::read_char returns crossterm::Result instead of io::Result
    • Maybe I forgot something, a lot of functions have changed
  • Removed all unwraps/expects from library
• Add KeyEvent::Enter and KeyEvent::Tab: added-key-event-enter, added-key-event-tab
• Sync set/get terminal size behaviour: fixed-get-set-terminal-size
• Method renames:
  • AsyncReader::stop_reading() to stop()
  • RawScreen::disable_raw_mode_on_drop to keep_raw_mode_on_drop
  • TerminalCursor::reset_position() to restore_position()
  • Command::get_anis_code() to ansi_code()
  • available_color_count to available_color_count()
  • Terminal::terminal_size to Terminal::size
  • Console::get_handle to Console::handle
• All i16 values for indexing: set size, set cursor pos, scrolling synced to u16 values
• Command API takes mutable self instead of self

• Implement command API, to have better performance and more control over how and when commands are executed. PR, issue
• Fix showing, hiding cursor windows implementation
• Remove some of the parsing logic from windows keys to ansi codes to key events PR
• Made terminal size 1-based PR
• Add some derives

• Copy for KeyEvent
• CTRL + Left, Down, Up, Right key support
• SHIFT + Left, Down, Up, Right key support
• Fixed UNIX cursor position bug issue, PR

• Prefetch buffer size for more efficient windows input reads. PR

• Reset foreground and background color individually. PR
• Backtap input support. PR
• Corrected white/grey and added dark grey.
• Fixed getting cursor position with raw screen enabled. PR
• Removed one redundant stdout lock

• Removed println from SyncReader

Version 0.9.2

• Terminal size linux was not 0-based
• Windows mouse input event position was 0-based and should be 1-based
• Result, ErrorKind are made re-exported
• Fixed some special key combination detections for UNIX systems
• Made FreeBSD compile

Version 0.9.1

• Fixed libc compile error

Version 0.9.0 (yanked)

This release is all about moving to a stabilized API for 1.0.

• Major refactor and cleanup.
• Improved performance;
  • No locking when writing to stdout.
  • UNIX doesn't have any dynamic dispatch anymore.
  • Windows has improved the way to check if ANSI modes are enabled.
  • Removed lot's of complex API calls: from_screen, from_output
  • Removed Arc<TerminalOutput> from all internal Api's.
• Removed termios dependency for UNIX systems.
• Upgraded deps.
• Removed about 1000 lines of code
  • TerminalOutput
  • Screen
  • unsafe code
  • Some duplicated code introduced by a previous refactor.
• Raw modes UNIX systems improved
• Added NoItalic attribute

Version 0.8.2

• Bug fix for sync reader UNIX.

Version 0.8.1

• Added public re-exports for input.

• Introduced KeyEvents
• Introduced MouseEvents
• Upgraded crossterm_winapi 0.2

• Introduced more Attributes
• Introduced easier ways to style text issue 87.
• Removed ColorType since it was unnecessary.

• Introduced feature flags; input, cursor, style, terminal, screen.
• All modules are moved to their own crate.
• Introduced crossterm workspace
• Less dependencies.
• Improved namespaces.

PR 84

• Error module is made public PR 78.

• WinApi rewrite and correctly error handled PR 67
• Windows attribute support PR 62
• Readline bug fix windows systems PR 62
• Error handling improvement.
• General refactoring, all warnings removed.
• Documentation improvement.

• Documentation refactor.
• Fixed broken API documentation PR 53.