io

Comprehensive terminal settings for cross-platform compatibility.

^{part of SuperZIG/io/terminal module.}

^{🔥 Built for power. Designed for speed. Ready for production. 🔥}

• Features 🌟

  • 🌍 Cross Platform

    Support for Linux, Windows, and macOS.

  • ⚡ Full Control

    Easily enable/disable all the flags you want and toggle RawMode with just one instruction.

  • 🛠 Easy-to-use API

    An intuitive API designed for ease of use, allowing developers to seamlessly integrate terminal settings into their applications with minimal effort.

  • 📈 Performance Optimized

    Efficient and fast, ensuring minimal impact on your system’s resources.

  • 🔧 Customizable

    Highly configurable settings to tailor the terminal behavior to your needs.

  • 🛡️ Rock-Solid Stability

    Every function is rigorously tested, making the library safe, reliable, and ready for production.

• 📖 Table of Contents

  🔹 🚀 Quick Start – A quick guide to get you started with the library.

  🔹 🎇 API Reference – Detailed documentation of available functions.

• Quick Start 🚀

  If you have not already added the library to your project, please review the installation guide for more information.

    const settings = @import("io").terminal.settings;
  

  The settings module provides powerful tools for handling terminal settings. Let’s explore some of its features.

  For example, let’s get the current terminal settings.

    var terminal_settings = try settings.get();
  

  Now, you can access the settings.

    _ = terminal_settings.options.rawMode; // 👉 true/false
  
    // or
  
    _ = settings.isRawModeEnabled(); // 👉 true/false
  

  Now, let’s change the terminal settings and apply the changes.

    // change the terminal settings
    terminal_settings.options.rawMode = true;
  
    // apply the changes
    try settings.set(terminal_settings);
  

• API 🎇

  • ✨ Methods

    Function	Description
    get	Get current terminal settings.
    set	Set current terminal settings.
    enableRawMode	Enable raw mode.
    disableRawMode	Disable raw mode.
    isRawModeEnabled	Returns true if raw mode is enabled.

  • 🍃 Types

    • TerminalSettings

      Field	Type	Description
      core	struct	to hold the os terminal settings.
      handles	struct	to hold the os i/o handles.
      options	TerminalOptions	to hold the terminal settings options(flags/modes).

    • TerminalOptions

      Field	Type	Description	Supported OS
      rawMode	bool	true if the raw mode is enabled.	All
      echo	bool	true if the echo is enabled.	Linux
      canonical	bool	true if the canonical input is enabled.	Linux
      extended	bool	true if the extended input processing is enabled.	Linux
      signals	bool	true if the signals (SIGINT, SIGTSTP, SIGTTIN, SIGTTOU) are enabled.	Linux

• 🔗 Related

  • Info

    Detailed terminal information ensuring cross-platform compatibility.

  • ansi

    Utility functions for ANSI escape code manipulation and terminal styling.

  • cli

    Seamless Command Line Integration with ZIG.

  • Events

    Robust event handling for terminal key presses and mouse events.

  • Prompt

    Interactive prompts for user input.

This site is open source. Improve this page.