tmux  3.2a
About: tmux is a terminal multiplexer that lets you switch easily between several programs in one terminal.
  Fossies Dox: tmux-3.2a.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

client Struct Reference

#include <tmux.h>

Collaboration diagram for client:
[legend]

Public Types

enum  { CLIENT_EXIT_RETURN , CLIENT_EXIT_SHUTDOWN , CLIENT_EXIT_DETACH }
 
enum  { PROMPT_ENTRY , PROMPT_COMMAND }
 

Public Member Functions

 TAILQ_ENTRY (client) entry
 

Data Fields

const char * name
 
struct tmuxpeerpeer
 
struct cmdq_listqueue
 
struct client_windows windows
 
struct control_statecontrol_state
 
u_int pause_age
 
pid_t pid
 
int fd
 
int out_fd
 
struct event event
 
int retval
 
struct timeval creation_time
 
struct timeval activity_time
 
struct environ * environ
 
struct format_job_tree * jobs
 
char * title
 
const char * cwd
 
char * term_name
 
int term_features
 
char * term_type
 
char ** term_caps
 
u_int term_ncaps
 
char * ttyname
 
struct tty tty
 
size_t written
 
size_t discarded
 
size_t redraw
 
struct event repeat_timer
 
struct event click_timer
 
u_int click_button
 
struct mouse_event click_event
 
struct status_line status
 
uint64_t flags
 
enum client:: { ... }  exit_type
 
enum msgtype exit_msgtype
 
char * exit_session
 
char * exit_message
 
struct key_tablekeytable
 
uint64_t redraw_panes
 
int message_ignore_keys
 
int message_ignore_styles
 
char * message_string
 
struct event message_timer
 
char * prompt_string
 
struct utf8_dataprompt_buffer
 
char * prompt_last
 
size_t prompt_index
 
prompt_input_cb prompt_inputcb
 
prompt_free_cb prompt_freecb
 
void * prompt_data
 
u_int prompt_hindex
 
enum client:: { ... }  prompt_mode
 
struct utf8_dataprompt_saved
 
int prompt_flags
 
struct sessionsession
 
struct sessionlast_session
 
int references
 
void * pan_window
 
u_int pan_ox
 
u_int pan_oy
 
overlay_check_cb overlay_check
 
overlay_mode_cb overlay_mode
 
overlay_draw_cb overlay_draw
 
overlay_key_cb overlay_key
 
overlay_free_cb overlay_free
 
void * overlay_data
 
struct event overlay_timer
 
struct client_files files
 

Detailed Description

Definition at line 1608 of file tmux.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
CLIENT_EXIT_RETURN 
CLIENT_EXIT_SHUTDOWN 
CLIENT_EXIT_DETACH 

Definition at line 1705 of file tmux.h.

◆ anonymous enum

anonymous enum
Enumerator
PROMPT_ENTRY 
PROMPT_COMMAND 

Definition at line 1731 of file tmux.h.

Member Function Documentation

◆ TAILQ_ENTRY()

client::TAILQ_ENTRY ( client  )

Field Documentation

◆ activity_time

◆ click_button

u_int client::click_button

Definition at line 1649 of file tmux.h.

Referenced by server_client_check_mouse().

◆ click_event

struct mouse_event client::click_event

Definition at line 1649 of file tmux.h.

Referenced by server_client_check_mouse(), and server_client_click_timer().

◆ click_timer

struct event client::click_timer

Definition at line 1644 of file tmux.h.

Referenced by server_client_check_mouse(), server_client_create(), and server_client_lost().

◆ control_state

◆ creation_time

struct timeval client::creation_time

Definition at line 1622 of file tmux.h.

Referenced by format_cb_client_created(), server_client_create(), and window_client_cmp().

◆ cwd

const char* client::cwd

◆ discarded

size_t client::discarded

Definition at line 1643 of file tmux.h.

Referenced by format_cb_client_discarded(), tty_block_maybe(), and tty_timer_callback().

◆ environ

◆ event

struct event client::event

Definition at line 1620 of file tmux.h.

◆ exit_message

char* client::exit_message

Definition at line 1712 of file tmux.h.

Referenced by control_check_age(), and server_client_check_exit().

◆ exit_msgtype

enum msgtype client::exit_msgtype

Definition at line 1703 of file tmux.h.

Referenced by server_client_check_exit(), and server_client_detach().

◆ exit_session

char* client::exit_session

Definition at line 1711 of file tmux.h.

Referenced by server_client_check_exit(), and server_client_detach().

◆ 

client::exit_type { ... } enum

◆ fd

◆ files

◆ flags

uint64_t client::flags

Definition at line 1703 of file tmux.h.

Referenced by alerts_set_message(), cmd_confirm_before_callback(), cmd_find_session_better(), cmd_load_buffer_done(), cmd_select_pane_exec(), cmdq_error(), cmdq_guard(), cmdq_print(), control_append_data(), control_check_age(), control_error(), control_error_callback(), control_pane_offset(), control_read_callback(), control_start(), control_stop(), file_can_print(), file_create_with_client(), file_fire_done_cb(), file_push_cb(), file_read(), file_write(), format_cb_client_control_mode(), format_cb_client_readonly(), format_cb_client_utf8(), ignore_client_size(), key_bindings_dispatch(), menu_key_cb(), popup_redraw_cb(), popup_set_client_cb(), recalculate_sizes_now(), screen_redraw_draw_borders_cell(), screen_redraw_screen(), screen_write_set_client_cb(), server_client_check_exit(), server_client_check_modes(), server_client_check_mouse(), server_client_check_pane_buffer(), server_client_check_pane_focus(), server_client_check_redraw(), server_client_click_timer(), server_client_command_done(), server_client_create(), server_client_detach(), server_client_dispatch_command(), server_client_dispatch_identify(), server_client_get_flags(), server_client_get_pane(), server_client_handle_key(), server_client_how_many(), server_client_lost(), server_client_open(), server_client_repeat_timer(), server_client_reset_state(), server_client_set_flags(), server_client_suspend(), server_destroy_session(), server_lock_client(), server_loop(), server_redraw_client(), server_redraw_window_borders(), server_send_exit(), server_start(), server_status_client(), status_at_line(), status_line_size(), status_message_clear(), status_message_set(), status_prompt_clear(), status_prompt_key(), status_prompt_menu_callback(), status_prompt_set(), status_prompt_translate_key(), status_prompt_update(), status_redraw(), status_timer_callback(), tty_acs_needed(), tty_check_codeset(), tty_client_ready(), tty_keys_next(), tty_timer_callback(), tty_update_client_offset(), window_client_build(), window_client_draw(), window_pane_input_callback(), and window_pane_read_callback().

◆ jobs

struct format_job_tree* client::jobs

Definition at line 1628 of file tmux.h.

Referenced by format_job_get(), format_lost_client(), and format_tidy_jobs().

◆ keytable

◆ last_session

struct session* client::last_session

Definition at line 1744 of file tmux.h.

Referenced by format_cb_client_last_session(), and server_destroy_session().

◆ message_ignore_keys

int client::message_ignore_keys

Definition at line 1718 of file tmux.h.

Referenced by server_client_handle_key(), and status_message_set().

◆ message_ignore_styles

int client::message_ignore_styles

Definition at line 1719 of file tmux.h.

Referenced by status_message_redraw(), and status_message_set().

◆ message_string

◆ message_timer

struct event client::message_timer

Definition at line 1720 of file tmux.h.

Referenced by server_client_lost(), and status_message_set().

◆ name

const char* client::name

Definition at line 1609 of file tmux.h.

Referenced by clients_calculate_size(), cmd_display_panes_draw(), cmd_find_client(), cmd_show_messages_exec(), cmdq_add_message(), cmdq_error(), cmdq_name(), control_check_age(), control_error(), control_flush_all_blocks(), control_notify_client_detached(), control_notify_client_session_changed(), control_read_callback(), control_vwrite(), control_write(), control_write_callback(), control_write_data(), control_write_pending(), default_window_size(), format_cb_client_name(), format_cb_session_attached_list(), format_cb_session_group_attached_list(), format_cb_window_active_clients_list(), format_defaults(), screen_redraw_draw_borders(), screen_redraw_draw_pane(), screen_redraw_draw_pane_status(), screen_redraw_draw_panes(), screen_redraw_draw_status(), screen_redraw_screen(), screen_redraw_set_context(), server_client_check_mouse(), server_client_check_pane_buffer(), server_client_check_redraw(), server_client_dispatch_identify(), server_client_free(), server_client_reset_state(), server_client_set_flags(), server_client_set_pane(), status_message_set(), tty_add(), tty_block_maybe(), tty_clear_area(), tty_clear_line(), tty_clear_pane_line(), tty_draw_pane(), tty_keys_device_attributes(), tty_keys_extended_device_attributes(), tty_keys_extended_key(), tty_keys_mouse(), tty_keys_next(), tty_keys_next1(), tty_read_callback(), tty_redraw_region(), tty_resize(), tty_start_timer_callback(), tty_start_tty(), tty_sync_end(), tty_sync_start(), tty_timer_callback(), tty_update_client_offset(), tty_update_mode(), tty_write_callback(), window_client_build(), and window_client_cmp().

◆ out_fd

int client::out_fd

◆ overlay_check

◆ overlay_data

◆ overlay_draw

◆ overlay_free

overlay_free_cb client::overlay_free

Definition at line 1756 of file tmux.h.

Referenced by server_client_clear_overlay(), and server_client_set_overlay().

◆ overlay_key

overlay_key_cb client::overlay_key

◆ overlay_mode

overlay_mode_cb client::overlay_mode

◆ overlay_timer

struct event client::overlay_timer

Definition at line 1757 of file tmux.h.

Referenced by server_client_clear_overlay(), and server_client_set_overlay().

◆ pan_ox

u_int client::pan_ox

Definition at line 1749 of file tmux.h.

Referenced by tty_window_offset1().

◆ pan_oy

u_int client::pan_oy

Definition at line 1750 of file tmux.h.

Referenced by tty_window_offset1().

◆ pan_window

void* client::pan_window

Definition at line 1748 of file tmux.h.

Referenced by tty_window_offset1().

◆ pause_age

u_int client::pause_age

Definition at line 1616 of file tmux.h.

Referenced by server_client_control_flags(), and server_client_get_flags().

◆ peer

◆ pid

pid_t client::pid

Definition at line 1618 of file tmux.h.

Referenced by format_cb_client_pid(), and server_client_dispatch_identify().

◆ prompt_buffer

◆ prompt_data

void* client::prompt_data

Definition at line 1729 of file tmux.h.

Referenced by status_prompt_clear(), status_prompt_key(), and status_prompt_set().

◆ prompt_flags

◆ prompt_freecb

prompt_free_cb client::prompt_freecb

Definition at line 1728 of file tmux.h.

Referenced by status_prompt_clear(), and status_prompt_set().

◆ prompt_hindex

u_int client::prompt_hindex

Definition at line 1730 of file tmux.h.

Referenced by status_prompt_key(), status_prompt_set(), and status_prompt_update().

◆ prompt_index

◆ prompt_inputcb

prompt_input_cb client::prompt_inputcb

Definition at line 1727 of file tmux.h.

Referenced by cmd_command_prompt_callback(), status_prompt_key(), and status_prompt_set().

◆ prompt_last

char* client::prompt_last

Definition at line 1725 of file tmux.h.

Referenced by status_prompt_clear(), status_prompt_key(), and status_prompt_set().

◆ 

client::prompt_mode { ... } enum

◆ prompt_saved

struct utf8_data* client::prompt_saved

◆ prompt_string

◆ queue

struct cmdq_list* client::queue

Definition at line 1611 of file tmux.h.

Referenced by cmdq_get(), server_client_create(), and server_client_free().

◆ redraw

size_t client::redraw

Definition at line 1644 of file tmux.h.

Referenced by server_client_check_redraw(), and tty_write_callback().

◆ redraw_panes

uint64_t client::redraw_panes

Definition at line 1716 of file tmux.h.

Referenced by server_client_check_redraw().

◆ references

◆ repeat_timer

struct event client::repeat_timer

Definition at line 1644 of file tmux.h.

Referenced by server_client_create(), and server_client_lost().

◆ retval

int client::retval

◆ session

struct session* client::session

Definition at line 1743 of file tmux.h.

Referenced by alerts_set_message(), clients_with_window(), cmd_display_menu_exec(), cmd_display_panes_draw(), cmd_display_panes_draw_pane(), cmd_display_panes_exec(), cmd_find_best_client(), cmd_find_client(), cmd_find_current_client(), cmd_find_from_client(), cmd_find_get_session(), cmd_load_buffer_done(), cmd_select_pane_exec(), cmd_source_file_complete(), cmdq_add_message(), cmdq_error(), cmdq_print(), control_check_subs_all_panes(), control_check_subs_all_windows(), control_check_subs_pane(), control_check_subs_session(), control_check_subs_window(), control_error(), control_notify_client_session_changed(), control_notify_window_layout_changed(), control_notify_window_linked(), control_notify_window_renamed(), control_notify_window_unlinked(), control_window_pane(), default_window_size_skip_client(), file_can_print(), format_cb_client_session(), format_cb_session_attached_list(), format_cb_session_group_attached_list(), format_cb_window_active_clients(), format_cb_window_active_clients_list(), format_defaults(), format_defaults_client(), ignore_client_size(), menu_draw_cb(), options_push_changes(), recalculate_size_skip_client(), recalculate_sizes_now(), screen_redraw_cell_border(), screen_redraw_check_cell(), screen_redraw_draw_borders(), screen_redraw_draw_borders_cell(), screen_redraw_draw_borders_style(), screen_redraw_draw_pane(), screen_redraw_draw_pane_status(), screen_redraw_draw_panes(), screen_redraw_draw_status(), screen_redraw_make_pane_status(), screen_redraw_set_context(), screen_redraw_type_of_cell(), screen_redraw_update(), screen_write_set_client_cb(), server_client_attached_lost(), server_client_check_modes(), server_client_check_mouse(), server_client_check_pane_buffer(), server_client_check_pane_focus(), server_client_check_redraw(), server_client_command_done(), server_client_detach(), server_client_exec(), server_client_get_cwd(), server_client_get_key_table(), server_client_get_pane(), server_client_handle_key(), server_client_how_many(), server_client_key_callback(), server_client_loop(), server_client_reset_state(), server_client_set_pane(), server_client_set_title(), server_client_suspend(), server_destroy_session(), server_lock(), server_lock_client(), server_lock_session(), server_loop(), server_redraw_session(), server_redraw_window(), server_redraw_window_borders(), server_send_exit(), server_status_session(), spawn_pane(), status_at_line(), status_line_size(), status_message_redraw(), status_message_set(), status_prompt_complete(), status_prompt_complete_list_menu(), status_prompt_complete_window_menu(), status_prompt_key(), status_prompt_redraw(), status_redraw(), status_timer_callback(), status_timer_start(), tty_client_ready(), tty_update_window_offset(), tty_window_bigger(), tty_window_offset1(), window_client_build(), window_client_draw(), and window_pane_read_callback().

◆ status

◆ term_caps

char** client::term_caps

Definition at line 1636 of file tmux.h.

Referenced by server_client_dispatch_identify(), server_client_lost(), and tty_open().

◆ term_features

◆ term_name

char* client::term_name

◆ term_ncaps

u_int client::term_ncaps

Definition at line 1637 of file tmux.h.

Referenced by server_client_dispatch_identify(), server_client_lost(), and tty_open().

◆ term_type

char* client::term_type

◆ title

char* client::title

Definition at line 1630 of file tmux.h.

Referenced by server_client_lost(), server_client_set_title(), and tty_set_title().

◆ tty

struct tty client::tty

Definition at line 1639 of file tmux.h.

Referenced by alerts_set_message(), clients_calculate_size(), cmd_display_menu_exec(), cmd_display_panes_draw_pane(), cmd_load_buffer_done(), cmd_resize_pane_mouse_update(), cmd_select_pane_exec(), cmd_show_messages_exec(), default_window_size(), format_cb_client_cell_height(), format_cb_client_cell_width(), format_cb_client_height(), format_cb_client_width(), format_cb_window_bigger(), format_cb_window_offset_x(), format_cb_window_offset_y(), menu_display(), menu_draw_cb(), options_push_changes(), popup_display(), popup_draw_cb(), popup_editor(), popup_handle_drag(), popup_job_update_cb(), popup_set_client_cb(), recalculate_sizes_now(), screen_redraw_draw_borders(), screen_redraw_draw_borders_cell(), screen_redraw_draw_pane(), screen_redraw_draw_pane_status(), screen_redraw_draw_status(), screen_redraw_pane(), screen_redraw_screen(), screen_redraw_set_context(), screen_write_set_client_cb(), server_client_check_mouse(), server_client_check_redraw(), server_client_clear_overlay(), server_client_command_done(), server_client_create(), server_client_dispatch_identify(), server_client_lost(), server_client_open(), server_client_reset_state(), server_client_set_overlay(), server_client_set_title(), server_client_suspend(), server_lock_client(), status_at_line(), status_init(), status_message_clear(), status_message_redraw(), status_message_set(), status_prompt_clear(), status_prompt_complete_list_menu(), status_prompt_complete_window_menu(), status_prompt_redraw(), status_prompt_set(), status_push_screen(), status_redraw(), tty_client_ready(), tty_update_client_offset(), tty_write(), window_client_cmp(), and window_copy_start_drag().

◆ ttyname

◆ windows

struct client_windows client::windows

◆ written

size_t client::written

Definition at line 1642 of file tmux.h.

Referenced by format_cb_client_written(), and tty_add().


The documentation for this struct was generated from the following file: