Skip to main content

Crate par_term_config

Crate par_term_config 

Source
Expand description

Configuration system for par-term terminal emulator.

This crate provides configuration loading, saving, and default values for the terminal emulator. It includes:

  • Terminal configuration types and settings
  • Theme definitions and color schemes
  • Shader configuration management
  • Snippets and automation support
  • Configuration file watching
  • Status bar widget configuration
  • Profile configuration types and manager

Re-exports§

pub use cell::Cell;
pub use config::Config;
pub use config::CustomAcpAgentActionConfig;
pub use config::CustomAcpAgentConfig;
pub use config::substitute_variables;
pub use scrollback_mark::ScrollbackMark;
pub use themes::Color;
pub use themes::Theme;
pub use automation::CoprocessDefConfig;
pub use automation::RestartPolicy;
pub use automation::TriggerActionConfig;
pub use automation::TriggerConfig;
pub use scripting::ScriptConfig;
pub use snippets::BuiltInVariable;
pub use snippets::CustomActionConfig;
pub use snippets::SnippetConfig;
pub use snippets::SnippetLibrary;
pub use status_bar::StatusBarSection;
pub use status_bar::StatusBarWidgetConfig;
pub use status_bar::WidgetId;
pub use status_bar::default_widgets;
pub use profile::ConflictResolution;
pub use profile::DynamicProfileSource;
pub use profile_types::Profile;
pub use profile_types::ProfileId;
pub use profile_types::ProfileManager;
pub use profile_types::ProfileSource;
pub use shader_config::resolve_cursor_shader_config;
pub use shader_config::resolve_shader_config;
pub use shader_metadata::CursorShaderMetadataCache;
pub use shader_metadata::ShaderMetadataCache;
pub use shader_metadata::parse_cursor_shader_metadata;
pub use shader_metadata::parse_shader_metadata;
pub use shader_metadata::update_cursor_shader_metadata_file;
pub use shader_metadata::update_shader_metadata_file;
pub use config::prettifier::PrettifierConfigOverride;
pub use config::prettifier::PrettifierYamlConfig;
pub use config::prettifier::ResolvedPrettifierConfig;
pub use config::prettifier::resolve_prettifier_config;

Modules§

automation
Configuration types for triggers and coprocesses.
cell
config
Terminal configuration management.
defaults
Default value functions for configuration.
profile
Profile configuration types.
profile_types
Profile types and manager for terminal session configurations
scripting
Configuration types for external observer scripts.
scrollback_mark
shader_config
Shader configuration resolution.
shader_metadata
Shader metadata parsing and caching.
snippets
Configuration types for snippets and custom actions.
status_bar
Status bar widget configuration types.
themes
watcher
Config file watcher for automatic reload.

Structs§

AlertSoundConfig
Configuration for an alert sound tied to a specific event
CursorShaderConfig
Cursor shader specific configuration.
CursorShaderMetadata
Metadata embedded in cursor shader files via YAML block comments.
DividerRect
A divider rectangle between panes
FontRange
Font mapping for a specific Unicode range
IntegrationVersions
Tracks installed and prompted versions for integrations
KeyBinding
A keybinding configuration entry
ModifierRemapping
Modifier remapping configuration.
PaneBackground
Per-pane background image configuration (runtime state)
PaneBackgroundConfig
Per-pane background image configuration (for config persistence)
ResolvedCursorShaderConfig
Fully resolved cursor shader configuration with all values filled in.
ResolvedShaderConfig
Fully resolved shader configuration with all values filled in.
ShaderConfig
Per-shader configuration settings.
ShaderMetadata
Metadata embedded in shader files via YAML block comments.
SmartSelectionRule
A smart selection rule for pattern-based text selection.

Enums§

AlertEvent
Terminal events that can trigger alert sounds
AmbiguousWidth
Treatment of East Asian Ambiguous width characters.
BackgroundImageMode
Background image display mode
BackgroundMode
Background source selection
CursorStyle
Cursor style
DividerStyle
Style of dividers between panes
DownloadSaveLocation
Default save location for downloaded files
DroppedFileQuoteStyle
Quote style for dropped file paths
ImageScalingMode
Image scaling quality for inline graphics (Sixel, iTerm2, Kitty)
InstallPromptState
State of an integration’s install prompt
KeyModifier
Keyboard modifier for keybindings.
LinkUnderlineStyle
Style for link highlight underlines.
LogLevel
Log level for debug logging to file.
ModifierTarget
Target modifier for remapping.
NormalizationForm
Unicode normalization form for terminal text.
OptionKeyMode
Option/Alt key behavior mode
PaneTitlePosition
Position of pane title bars
PowerPreference
GPU power preference for adapter selection
ProgressBarPosition
Progress bar position on screen
ProgressBarStyle
Progress bar visual style
SemanticHistoryEditorMode
Editor selection mode for semantic history
SessionLogFormat
Log format for session logging
ShaderInstallPrompt
Shader install prompt mode
ShellExitAction
Action to take when the shell process exits
ShellType
Detected shell type
SmartSelectionPrecision
Precision level for smart selection rules.
StartupDirectoryMode
Startup directory mode
StatusBarPosition
Status bar position
TabBarMode
Tab bar visibility mode
TabBarPosition
Tab bar position
TabStyle
Tab visual style preset
TabTitleMode
Controls how tab titles are automatically updated
ThinStrokesMode
Thin strokes / font smoothing mode
UnfocusedCursorStyle
Unfocused cursor style - how the cursor appears when window loses focus
UnicodeVersion
Unicode version for width calculation tables.
UpdateCheckFrequency
Update check frequency
VsyncMode
VSync mode (presentation mode)
WindowType
Window type for different display modes

Functions§

default_smart_selection_rules
Get the default smart selection rules (based on iTerm2’s defaults)

Type Aliases§

PaneId
Unique identifier for a pane
SeparatorMark
Visible command separator mark: (row, col_offset, optional_color)
TabId
Unique identifier for a tab