1948 lines
63 KiB
C
1948 lines
63 KiB
C
/* Define frame-object for GNU Emacs.
|
||
Copyright (C) 1993-1994, 1999-2024 Free Software Foundation, Inc.
|
||
|
||
This file is part of GNU Emacs.
|
||
|
||
GNU Emacs is free software: you can redistribute it and/or modify
|
||
it under the terms of the GNU General Public License as published by
|
||
the Free Software Foundation, either version 3 of the License, or (at
|
||
your option) any later version.
|
||
|
||
GNU Emacs is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU General Public License for more details.
|
||
|
||
You should have received a copy of the GNU General Public License
|
||
along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
|
||
|
||
#ifndef EMACS_FRAME_H
|
||
#define EMACS_FRAME_H
|
||
|
||
#include "termhooks.h"
|
||
#include "window.h"
|
||
|
||
INLINE_HEADER_BEGIN
|
||
|
||
enum vertical_scroll_bar_type
|
||
{
|
||
vertical_scroll_bar_none,
|
||
vertical_scroll_bar_left,
|
||
vertical_scroll_bar_right
|
||
};
|
||
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
|
||
enum fullscreen_type
|
||
{
|
||
FULLSCREEN_NONE,
|
||
FULLSCREEN_WIDTH = 0x1,
|
||
FULLSCREEN_HEIGHT = 0x2,
|
||
FULLSCREEN_BOTH = 0x3, /* Not a typo but means "width and height". */
|
||
FULLSCREEN_MAXIMIZED = 0x4,
|
||
#ifdef HAVE_NTGUI
|
||
FULLSCREEN_WAIT = 0x8
|
||
#endif
|
||
};
|
||
|
||
enum z_group
|
||
{
|
||
z_group_none,
|
||
z_group_above,
|
||
z_group_below,
|
||
z_group_above_suspended,
|
||
};
|
||
|
||
enum internal_border_part
|
||
{
|
||
INTERNAL_BORDER_NONE,
|
||
INTERNAL_BORDER_LEFT_EDGE,
|
||
INTERNAL_BORDER_TOP_LEFT_CORNER,
|
||
INTERNAL_BORDER_TOP_EDGE,
|
||
INTERNAL_BORDER_TOP_RIGHT_CORNER,
|
||
INTERNAL_BORDER_RIGHT_EDGE,
|
||
INTERNAL_BORDER_BOTTOM_RIGHT_CORNER,
|
||
INTERNAL_BORDER_BOTTOM_EDGE,
|
||
INTERNAL_BORDER_BOTTOM_LEFT_CORNER,
|
||
};
|
||
|
||
#ifdef NS_IMPL_COCOA
|
||
enum ns_appearance_type
|
||
{
|
||
ns_appearance_system_default,
|
||
ns_appearance_aqua,
|
||
ns_appearance_vibrant_dark
|
||
};
|
||
#endif
|
||
#endif /* HAVE_WINDOW_SYSTEM */
|
||
|
||
#ifdef HAVE_TEXT_CONVERSION
|
||
|
||
enum text_conversion_operation
|
||
{
|
||
TEXTCONV_START_BATCH_EDIT,
|
||
TEXTCONV_END_BATCH_EDIT,
|
||
TEXTCONV_COMMIT_TEXT,
|
||
TEXTCONV_FINISH_COMPOSING_TEXT,
|
||
TEXTCONV_SET_COMPOSING_TEXT,
|
||
TEXTCONV_SET_COMPOSING_REGION,
|
||
TEXTCONV_SET_POINT_AND_MARK,
|
||
TEXTCONV_DELETE_SURROUNDING_TEXT,
|
||
TEXTCONV_REQUEST_POINT_UPDATE,
|
||
TEXTCONV_BARRIER,
|
||
TEXTCONV_REPLACE_TEXT,
|
||
};
|
||
|
||
/* Structure describing a single edit being performed by the input
|
||
method that should be executed in the context of
|
||
kbd_buffer_get_event. */
|
||
|
||
struct text_conversion_action
|
||
{
|
||
/* The next text conversion action. */
|
||
struct text_conversion_action *next;
|
||
|
||
/* Any associated data. */
|
||
Lisp_Object data;
|
||
|
||
/* The operation being performed. */
|
||
enum text_conversion_operation operation;
|
||
|
||
/* Counter value. */
|
||
unsigned long counter;
|
||
};
|
||
|
||
/* Structure describing the text conversion state associated with a
|
||
frame. */
|
||
|
||
struct text_conversion_state
|
||
{
|
||
/* List of text conversion actions associated with this frame. */
|
||
struct text_conversion_action *actions;
|
||
|
||
/* Markers representing the composing region. */
|
||
Lisp_Object compose_region_start, compose_region_end;
|
||
|
||
/* Overlay representing the composing region. */
|
||
Lisp_Object compose_region_overlay;
|
||
|
||
/* Cons of (START END . WINDOW) holding the field to which text
|
||
conversion should be confined, or nil if no such field exists. */
|
||
Lisp_Object field;
|
||
|
||
/* The number of ongoing ``batch edits'' that are causing point
|
||
reporting to be delayed. */
|
||
int batch_edit_count;
|
||
|
||
/* Mask containing what must be updated after batch edits end. */
|
||
int batch_edit_flags;
|
||
};
|
||
|
||
#endif
|
||
|
||
/* The structure representing a frame. */
|
||
|
||
struct frame
|
||
{
|
||
union vectorlike_header header;
|
||
|
||
/* All Lisp_Object components must come first.
|
||
That ensures they are all aligned normally. */
|
||
|
||
/* Name of this frame: a Lisp string. It is used for looking up resources,
|
||
as well as for the title in some cases. */
|
||
Lisp_Object name;
|
||
|
||
/* The name to use for the icon, the last time
|
||
it was refreshed. nil means not explicitly specified. */
|
||
Lisp_Object icon_name;
|
||
|
||
/* This is the frame title specified explicitly, if any.
|
||
Usually it is nil. */
|
||
Lisp_Object title;
|
||
|
||
#if defined (HAVE_WINDOW_SYSTEM)
|
||
/* This frame's parent frame, if it has one. */
|
||
Lisp_Object parent_frame;
|
||
#endif /* HAVE_WINDOW_SYSTEM */
|
||
|
||
/* Last device to move over this frame. Any value that isn't a
|
||
string means the "Virtual core pointer". */
|
||
Lisp_Object last_mouse_device;
|
||
|
||
/* The frame which should receive keystrokes that occur in this
|
||
frame, or nil if they should go to the frame itself. This is
|
||
usually nil, but if the frame is minibufferless, we can use this
|
||
to redirect keystrokes to a surrogate minibuffer frame when
|
||
needed.
|
||
|
||
Note that a value of nil is different from having the field point
|
||
to the frame itself. Whenever the Fselect_frame function is used
|
||
to shift from one frame to the other, any redirections to the
|
||
original frame are shifted to the newly selected frame; if
|
||
focus_frame is nil, Fselect_frame will leave it alone. */
|
||
Lisp_Object focus_frame;
|
||
|
||
/* This frame's root window. Every frame has one.
|
||
If the frame has only a minibuffer window, this is it.
|
||
Otherwise, if the frame has a minibuffer window, this is its sibling. */
|
||
Lisp_Object root_window;
|
||
|
||
/* This frame's selected window.
|
||
Each frame has its own window hierarchy
|
||
and one of the windows in it is selected within the frame.
|
||
This window may be the mini-window of the frame, if any.
|
||
The selected window of the selected frame is Emacs's selected window. */
|
||
Lisp_Object selected_window;
|
||
|
||
/* This frame's selected window when run_window_change_functions was
|
||
called the last time on this frame. */
|
||
Lisp_Object old_selected_window;
|
||
|
||
/* This frame's minibuffer window.
|
||
Most frames have their own minibuffer windows,
|
||
but only the selected frame's minibuffer window
|
||
can actually appear to exist. */
|
||
Lisp_Object minibuffer_window;
|
||
|
||
/* Parameter alist of this frame.
|
||
These are the parameters specified when creating the frame
|
||
or modified with modify-frame-parameters. */
|
||
Lisp_Object param_alist;
|
||
|
||
/* List of scroll bars on this frame.
|
||
Actually, we don't specify exactly what is stored here at all; the
|
||
scroll bar implementation code can use it to store anything it likes.
|
||
This field is marked by the garbage collector. It is here
|
||
instead of in the `device' structure so that the garbage
|
||
collector doesn't need to look inside the window-system-dependent
|
||
structure. */
|
||
Lisp_Object scroll_bars;
|
||
Lisp_Object condemned_scroll_bars;
|
||
|
||
/* Vector describing the items to display in the menu bar.
|
||
Each item has four elements in this vector.
|
||
They are KEY, STRING, SUBMAP, and HPOS.
|
||
(HPOS is not used in when the X toolkit is in use.)
|
||
There are four additional elements of nil at the end, to terminate. */
|
||
Lisp_Object menu_bar_items;
|
||
|
||
/* Hash table of FACE-NAME keys and FACE-VECTOR-DATA values. */
|
||
Lisp_Object face_hash_table;
|
||
|
||
/* A vector that records the entire structure of this frame's menu bar.
|
||
For the format of the data, see extensive comments in xmenu.c.
|
||
Only the X toolkit version uses this. */
|
||
Lisp_Object menu_bar_vector;
|
||
|
||
/* Predicate for selecting buffers for other-buffer. */
|
||
Lisp_Object buffer_predicate;
|
||
|
||
/* List of buffers viewed in this frame, for other-buffer. */
|
||
Lisp_Object buffer_list;
|
||
|
||
/* List of buffers that were viewed, then buried in this frame. The
|
||
most recently buried buffer is first. For last-buffer. */
|
||
Lisp_Object buried_buffer_list;
|
||
|
||
#if defined HAVE_WINDOW_SYSTEM && !defined HAVE_EXT_MENU_BAR
|
||
/* A dummy window used to display menu bars under X when no X
|
||
toolkit support is available. */
|
||
Lisp_Object menu_bar_window;
|
||
#endif
|
||
|
||
#if defined (HAVE_WINDOW_SYSTEM)
|
||
/* A window used to display the tab-bar of a frame. */
|
||
Lisp_Object tab_bar_window;
|
||
|
||
/* Desired and current contents displayed in that window. */
|
||
Lisp_Object desired_tab_bar_string;
|
||
Lisp_Object current_tab_bar_string;
|
||
#endif
|
||
|
||
#if defined (HAVE_WINDOW_SYSTEM) && ! defined (HAVE_EXT_TOOL_BAR)
|
||
/* A window used to display the tool-bar of a frame. */
|
||
Lisp_Object tool_bar_window;
|
||
|
||
/* Desired and current contents displayed in that window. */
|
||
Lisp_Object desired_tool_bar_string;
|
||
Lisp_Object current_tool_bar_string;
|
||
#endif
|
||
|
||
/* Where tool bar is, can be left, right, top or bottom.
|
||
Except with GTK, the only supported position is `top'. */
|
||
Lisp_Object tool_bar_position;
|
||
|
||
#if defined (HAVE_XFT) || defined (HAVE_FREETYPE)
|
||
/* List of data specific to font-driver and frame, but common to faces. */
|
||
Lisp_Object font_data;
|
||
#endif
|
||
|
||
/* Desired and current tab-bar items. */
|
||
Lisp_Object tab_bar_items;
|
||
|
||
/* Desired and current tool-bar items. */
|
||
Lisp_Object tool_bar_items;
|
||
/* tool_bar_items should be the last Lisp_Object member. */
|
||
|
||
/* Cache of realized faces. */
|
||
struct face_cache *face_cache;
|
||
|
||
/* Tab-bar item index of the item on which a mouse button was pressed. */
|
||
int last_tab_bar_item;
|
||
|
||
#if defined (HAVE_WINDOW_SYSTEM) && ! defined (HAVE_EXT_TOOL_BAR)
|
||
/* Tool-bar item index of the item on which a mouse button was pressed. */
|
||
int last_tool_bar_item;
|
||
#endif
|
||
|
||
/* Number of elements in `menu_bar_vector' that have meaningful data. */
|
||
int menu_bar_items_used;
|
||
|
||
#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
|
||
/* A buffer to hold the frame's name. Since this is used by the
|
||
window system toolkit, we can't use the Lisp string's pointer
|
||
(`name', above) because it might get relocated. */
|
||
char *namebuf;
|
||
#endif
|
||
|
||
#ifdef USE_X_TOOLKIT
|
||
/* Used to pass geometry parameters to toolkit functions. */
|
||
char *shell_position;
|
||
#endif
|
||
|
||
/* Glyph pool and matrix. */
|
||
struct glyph_pool *current_pool;
|
||
struct glyph_pool *desired_pool;
|
||
struct glyph_matrix *desired_matrix;
|
||
struct glyph_matrix *current_matrix;
|
||
|
||
/* Bitfield area begins here. Keep them together to avoid extra padding. */
|
||
|
||
/* True means that glyphs on this frame have been initialized so it can
|
||
be used for output. */
|
||
bool_bf glyphs_initialized_p : 1;
|
||
|
||
/* Set to true in adjust_frame_size when one of the frame's sizes
|
||
changed. Clear the frame in clear_garbaged_frames if set. */
|
||
bool_bf resized_p : 1;
|
||
|
||
/* Set to true if the default face for the frame has been
|
||
realized. Reset to zero whenever the default face changes.
|
||
Used to see the difference between a font change and face change. */
|
||
bool_bf default_face_done_p : 1;
|
||
|
||
/* Set to true if this frame has already been hscrolled during
|
||
current redisplay. */
|
||
bool_bf already_hscrolled_p : 1;
|
||
|
||
/* Set to true when current redisplay has updated frame. */
|
||
bool_bf updated_p : 1;
|
||
|
||
#if defined (HAVE_WINDOW_SYSTEM)
|
||
/* Set to true to minimize tab-bar height even when
|
||
auto-resize-tab-bar is set to grow-only. */
|
||
bool_bf minimize_tab_bar_window_p : 1;
|
||
#endif
|
||
|
||
#if defined (HAVE_WINDOW_SYSTEM) && ! defined (HAVE_EXT_TOOL_BAR)
|
||
/* Set to true to minimize tool-bar height even when
|
||
auto-resize-tool-bar is set to grow-only. */
|
||
bool_bf minimize_tool_bar_window_p : 1;
|
||
|
||
/* Whether or not the tool bar contains a ``new line'' item. If
|
||
true, tool bar rows will be allowed to differ in height. */
|
||
bool_bf tool_bar_wraps_p : 1;
|
||
#endif
|
||
|
||
#ifdef HAVE_EXT_TOOL_BAR
|
||
/* True means using a tool bar that comes from the toolkit. */
|
||
bool_bf external_tool_bar : 1;
|
||
#endif
|
||
|
||
/* True means that fonts have been loaded since the last glyph
|
||
matrix adjustments. */
|
||
bool_bf fonts_changed : 1;
|
||
|
||
/* True means that cursor type has been changed. */
|
||
bool_bf cursor_type_changed : 1;
|
||
|
||
/* True if it needs to be redisplayed. */
|
||
bool_bf redisplay : 1;
|
||
|
||
#ifdef HAVE_EXT_MENU_BAR
|
||
/* True means using a menu bar that comes from the toolkit. */
|
||
bool_bf external_menu_bar : 1;
|
||
#endif
|
||
|
||
/* Next two bitfields are mutually exclusive. They might both be
|
||
zero if the frame has been made invisible without an icon. */
|
||
|
||
/* Nonzero if the frame is currently displayed; we check
|
||
it to see if we should bother updating the frame's contents.
|
||
|
||
On ttys and on Windows NT/9X, to avoid wasting effort updating
|
||
visible frames that are actually completely obscured by other
|
||
windows on the display, we bend the meaning of visible slightly:
|
||
if equal to 2, then the frame is obscured - we still consider
|
||
it to be "visible" as seen from lisp, but we don't bother
|
||
updating it. */
|
||
unsigned visible : 2;
|
||
|
||
/* True if the frame is currently iconified. Do not
|
||
set this directly, use SET_FRAME_ICONIFIED instead. */
|
||
bool_bf iconified : 1;
|
||
|
||
/* True if this frame should be fully redisplayed. Disables all
|
||
optimizations while rebuilding matrices and redrawing. */
|
||
bool_bf garbaged : 1;
|
||
|
||
/* False means, if this frame has just one window,
|
||
show no modeline for that window. */
|
||
bool_bf wants_modeline : 1;
|
||
|
||
/* True means raise this frame to the top of the heap when selected. */
|
||
bool_bf auto_raise : 1;
|
||
|
||
/* True means lower this frame to the bottom of the stack when left. */
|
||
bool_bf auto_lower : 1;
|
||
|
||
/* True if frame's root window can't be split. */
|
||
bool_bf no_split : 1;
|
||
|
||
/* If this is set, then Emacs won't change the frame name to indicate
|
||
the current buffer, etcetera. If the user explicitly sets the frame
|
||
name, this gets set. If the user sets the name to Qnil, this is
|
||
cleared. */
|
||
bool_bf explicit_name : 1;
|
||
|
||
/* True if at least one window on this frame changed since the last
|
||
call of run_window_change_functions. Changes are either "state
|
||
changes" (a window has been created, deleted or got assigned
|
||
another buffer) or "size changes" (the total or body size of a
|
||
window changed). run_window_change_functions exits early unless
|
||
either this flag is true or a window selection happened on this
|
||
frame. */
|
||
bool_bf window_change : 1;
|
||
|
||
/* True if running window state change functions has been explicitly
|
||
requested for this frame since last redisplay. */
|
||
bool_bf window_state_change : 1;
|
||
|
||
/* True if the mouse has moved on this display device
|
||
since the last time we checked. */
|
||
bool_bf mouse_moved : 1;
|
||
|
||
/* True means that the pointer is invisible. */
|
||
bool_bf pointer_invisible : 1;
|
||
|
||
/* True means that all windows except mini-window and
|
||
selected window on this frame have frozen window starts. */
|
||
bool_bf frozen_window_starts : 1;
|
||
|
||
/* The output method says how the contents of this frame are
|
||
displayed. It could be using termcap, or using an X window.
|
||
This must be the same as the terminal->type. */
|
||
ENUM_BF (output_method) output_method : 4;
|
||
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
/* True if this frame is a tooltip frame. */
|
||
bool_bf tooltip : 1;
|
||
|
||
/* See FULLSCREEN_ enum on top. */
|
||
ENUM_BF (fullscreen_type) want_fullscreen : 4;
|
||
|
||
/* If not vertical_scroll_bar_none, we should actually
|
||
display the scroll bars of this type on this frame. */
|
||
ENUM_BF (vertical_scroll_bar_type) vertical_scroll_bar_type : 2;
|
||
|
||
/* Nonzero if we should actually display horizontal scroll bars on this frame. */
|
||
bool_bf horizontal_scroll_bars : 1;
|
||
|
||
/* True if this is an undecorated frame. */
|
||
bool_bf undecorated : 1;
|
||
|
||
#ifndef HAVE_NTGUI
|
||
/* True if this is an override_redirect frame. */
|
||
bool_bf override_redirect : 1;
|
||
#endif
|
||
|
||
/* Nonzero if this frame's icon should not appear on its display's taskbar. */
|
||
bool_bf skip_taskbar : 1;
|
||
|
||
/* Nonzero if this frame's window F's X window does not want to
|
||
receive input focus when it is mapped. */
|
||
bool_bf no_focus_on_map : 1;
|
||
|
||
/* Nonzero if this frame's window does not want to receive input focus
|
||
via mouse clicks or by moving the mouse into it. */
|
||
bool_bf no_accept_focus : 1;
|
||
|
||
/* The z-group this frame's window belongs to. */
|
||
ENUM_BF (z_group) z_group : 2;
|
||
|
||
/* Non-zero if display of truncation and continuation glyphs outside
|
||
the fringes is suppressed. */
|
||
bool_bf no_special_glyphs : 1;
|
||
#endif /* HAVE_WINDOW_SYSTEM */
|
||
|
||
/* True means set_window_size_hook requests can be processed for
|
||
this frame. */
|
||
bool_bf can_set_window_size : 1;
|
||
|
||
/* Set to true after this frame was made by `make-frame'. */
|
||
bool_bf after_make_frame : 1;
|
||
|
||
/* Two sticky flags, that are both false when a frame is created.
|
||
'display_tab_bar' sets the former to true the first time it
|
||
displays the tab bar. When the former is true, the next call of
|
||
'x_change_tab_bar_height' and associates sets the latter true and
|
||
tries to adjust the frame height in a way that the now valid pixel
|
||
height of the tab bar is taken into account by the frame's native
|
||
height. */
|
||
bool_bf tab_bar_redisplayed : 1;
|
||
bool_bf tab_bar_resized : 1;
|
||
|
||
/* Two sticky flags, that are both false when a frame is created.
|
||
'redisplay_tool_bar' sets the former to true the first time it
|
||
displays the tool bar. When the former is true, the next call of
|
||
'x_change_tool_bar_height' and associates sets the latter true and
|
||
tries to adjust the frame height in a way that the now valid pixel
|
||
height of the tool bar is taken into account by the frame's native
|
||
height. */
|
||
bool_bf tool_bar_redisplayed : 1;
|
||
bool_bf tool_bar_resized : 1;
|
||
|
||
/* Inhibit implied resize before after_make_frame is set. */
|
||
bool_bf inhibit_horizontal_resize : 1;
|
||
bool_bf inhibit_vertical_resize : 1;
|
||
|
||
/* Non-zero if this frame's faces need to be recomputed. */
|
||
bool_bf face_change : 1;
|
||
|
||
/* Non-zero if this frame's image cache and face cache cannot be
|
||
freed because the frame is in the process of being redisplayed. */
|
||
bool_bf inhibit_clear_image_cache : 1;
|
||
|
||
/* True when new_width or new_height were set by change_frame_size,
|
||
false when they were set by adjust_frame_size internally or not
|
||
set. */
|
||
bool_bf new_size_p : 1;
|
||
|
||
/* True when frame was invisible before first MapNotify event. Used
|
||
in X builds only. */
|
||
bool_bf was_invisible : 1;
|
||
|
||
/* True when the frame isn't selected, and selecting it in the
|
||
future should select the mini-window rather than the currently
|
||
selected window in the frame, assuming there is still an active
|
||
minibuffer in that mini-window. */
|
||
bool_bf select_mini_window_flag : 1;
|
||
/* Bitfield area ends here. */
|
||
|
||
/* This frame's change stamp, set the last time window change
|
||
functions were run for this frame. Should never be 0 because
|
||
that's the change stamp of a new window. A window was not on a
|
||
frame the last run_window_change_functions was called on it if
|
||
it's change stamp differs from that of its frame. */
|
||
int change_stamp;
|
||
|
||
/* This frame's number of windows, set the last time window change
|
||
functions were run for this frame. Should never be 0 even for
|
||
minibuffer-only frames. If no window has been added, this allows
|
||
to detect whether a window was deleted on this frame since the
|
||
last time run_window_change_functions was called on it. */
|
||
ptrdiff_t number_of_windows;
|
||
|
||
/* Number of frame lines (rounded up) of tab bar. */
|
||
int tab_bar_lines;
|
||
|
||
/* Height of frame internal tab bar in pixels. */
|
||
int tab_bar_height;
|
||
|
||
int n_tab_bar_rows;
|
||
int n_tab_bar_items;
|
||
|
||
/* Number of frame lines (rounded up) of tool bar. */
|
||
int tool_bar_lines;
|
||
|
||
/* Height of frame internal tool bar in pixels. */
|
||
int tool_bar_height;
|
||
|
||
int n_tool_bar_rows;
|
||
int n_tool_bar_items;
|
||
|
||
/* A buffer for decode_mode_line. */
|
||
char *decode_mode_spec_buffer;
|
||
|
||
/* See do_line_insertion_deletion_costs for info on these arrays. */
|
||
/* Cost of inserting 1 line on this frame. */
|
||
int *insert_line_cost;
|
||
/* Cost of deleting 1 line on this frame. */
|
||
int *delete_line_cost;
|
||
/* Cost of inserting n lines on this frame. */
|
||
int *insert_n_lines_cost;
|
||
/* Cost of deleting n lines on this frame. */
|
||
int *delete_n_lines_cost;
|
||
|
||
/* Text width and height of this frame in (and maybe rounded to) frame
|
||
columns and lines. */
|
||
int text_cols, text_lines;
|
||
/* Text width and height of this frame in pixels. */
|
||
int text_width, text_height;
|
||
|
||
/* Native width of this frame in (and maybe rounded to) frame columns
|
||
and lines. */
|
||
int total_cols, total_lines;
|
||
/* Native width and height of this frame in pixels. */
|
||
int pixel_width, pixel_height;
|
||
/* New native width and height of this frame for pending size change,
|
||
in pixels. -1 if no change pending. */
|
||
int new_width, new_height;
|
||
|
||
/* Pixel position of the frame window (x and y offsets in root window). */
|
||
int left_pos, top_pos;
|
||
|
||
/* This is the gravity value for the specified window position. */
|
||
int win_gravity;
|
||
|
||
/* The geometry flags for this window. */
|
||
int size_hint_flags;
|
||
|
||
/* Border width of the frame window as known by the (X) window system. */
|
||
int border_width;
|
||
|
||
/* Width of child frames' internal border. Acts as
|
||
internal_border_width for child frames. */
|
||
int child_frame_border_width;
|
||
|
||
/* Width of the internal border. This is a line of background color
|
||
just inside the window's border. When the frame is selected,
|
||
a highlighting is displayed inside the internal border. */
|
||
int internal_border_width;
|
||
|
||
/* Widths of dividers between this frame's windows in pixels. */
|
||
int right_divider_width, bottom_divider_width;
|
||
|
||
/* Widths of fringes in pixels. */
|
||
int left_fringe_width, right_fringe_width;
|
||
|
||
/* Total width of fringes reserved for drawing truncation bitmaps,
|
||
continuation bitmaps and alike - REMOVE THIS !!!!. */
|
||
int fringe_cols;
|
||
|
||
/* Number of lines of menu bar. */
|
||
int menu_bar_lines;
|
||
|
||
/* Pixel height of menubar. */
|
||
int menu_bar_height;
|
||
|
||
/* Canonical X unit. Width of default font, in pixels. */
|
||
int column_width;
|
||
|
||
/* Canonical Y unit. Height of a line, in pixels. */
|
||
int line_height;
|
||
|
||
/* The terminal device that this frame uses. If this is NULL, then
|
||
the frame has been deleted. */
|
||
struct terminal *terminal;
|
||
|
||
/* Device-dependent, frame-local auxiliary data used for displaying
|
||
the contents. When the frame is deleted, this data is deleted as
|
||
well. */
|
||
union output_data
|
||
{
|
||
struct tty_output *tty; /* From termchar.h. */
|
||
struct x_output *x; /* From xterm.h. */
|
||
struct w32_output *w32; /* From w32term.h. */
|
||
struct ns_output *ns; /* From nsterm.h. */
|
||
struct pgtk_output *pgtk; /* From pgtkterm.h. */
|
||
struct haiku_output *haiku; /* From haikuterm.h. */
|
||
struct android_output *android; /* From androidterm.h. */
|
||
}
|
||
output_data;
|
||
|
||
/* List of font-drivers available on the frame. */
|
||
struct font_driver_list *font_driver_list;
|
||
|
||
#if defined HAVE_X_WINDOWS || defined HAVE_ANDROID
|
||
/* Used by x_wait_for_event when watching for an X event on this
|
||
frame. */
|
||
int wait_event_type;
|
||
#endif
|
||
|
||
/* What kind of text cursor should we draw in the future?
|
||
This should always be filled_box_cursor or bar_cursor. */
|
||
enum text_cursor_kinds desired_cursor;
|
||
|
||
/* Width of bar cursor (if we are using that). */
|
||
int cursor_width;
|
||
|
||
/* What kind of text cursor should we draw when the cursor blinks off?
|
||
This can be filled_box_cursor or bar_cursor or no_cursor. */
|
||
enum text_cursor_kinds blink_off_cursor;
|
||
|
||
/* Width of bar cursor (if we are using that) for blink-off state. */
|
||
int blink_off_cursor_width;
|
||
|
||
/* Configured width of the scroll bar, in pixels and in characters.
|
||
config_scroll_bar_cols tracks config_scroll_bar_width if the
|
||
latter is positive; a zero value in config_scroll_bar_width means
|
||
to compute the actual width on the fly, using config_scroll_bar_cols
|
||
and the current font width. */
|
||
int config_scroll_bar_width;
|
||
int config_scroll_bar_cols;
|
||
|
||
/* Configured height of the scroll bar, in pixels and in characters.
|
||
config_scroll_bar_lines tracks config_scroll_bar_height if the
|
||
latter is positive; a zero value in config_scroll_bar_height means
|
||
to compute the actual width on the fly, using
|
||
config_scroll_bar_lines and the current font width. */
|
||
int config_scroll_bar_height;
|
||
int config_scroll_bar_lines;
|
||
|
||
/* The baud rate that was used to calculate costs for this frame. */
|
||
intmax_t cost_calculation_baud_rate;
|
||
|
||
/* Frame opacity
|
||
alpha[0]: alpha transparency of the active frame
|
||
alpha[1]: alpha transparency of inactive frames
|
||
Negative values mean not to change alpha. */
|
||
double alpha[2];
|
||
|
||
/* Background opacity */
|
||
double alpha_background;
|
||
|
||
/* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
|
||
SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
|
||
frame parameter. 0 means don't do gamma correction. */
|
||
double gamma;
|
||
|
||
/* Additional space to put between text lines on this frame. */
|
||
int extra_line_spacing;
|
||
|
||
/* All display backends seem to need these two pixel values. */
|
||
unsigned long background_pixel;
|
||
unsigned long foreground_pixel;
|
||
|
||
#ifdef NS_IMPL_COCOA
|
||
/* NSAppearance theme used on this frame. */
|
||
enum ns_appearance_type ns_appearance;
|
||
bool_bf ns_transparent_titlebar;
|
||
#endif
|
||
|
||
#ifdef HAVE_TEXT_CONVERSION
|
||
/* Text conversion state used by certain input methods. */
|
||
struct text_conversion_state conversion;
|
||
#endif
|
||
} GCALIGNED_STRUCT;
|
||
|
||
/* Most code should use these functions to set Lisp fields in struct frame. */
|
||
|
||
INLINE void
|
||
fset_buffer_list (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->buffer_list = val;
|
||
}
|
||
INLINE void
|
||
fset_buried_buffer_list (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->buried_buffer_list = val;
|
||
}
|
||
INLINE void
|
||
fset_condemned_scroll_bars (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->condemned_scroll_bars = val;
|
||
}
|
||
INLINE void
|
||
fset_face_hash_table (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->face_hash_table = val;
|
||
}
|
||
#if defined (HAVE_WINDOW_SYSTEM)
|
||
INLINE void
|
||
fset_parent_frame (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->parent_frame = val;
|
||
}
|
||
#endif
|
||
INLINE void
|
||
fset_focus_frame (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->focus_frame = val;
|
||
}
|
||
INLINE void
|
||
fset_icon_name (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->icon_name = val;
|
||
}
|
||
INLINE void
|
||
fset_menu_bar_items (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->menu_bar_items = val;
|
||
}
|
||
INLINE void
|
||
fset_menu_bar_vector (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->menu_bar_vector = val;
|
||
}
|
||
#if defined HAVE_WINDOW_SYSTEM && !defined HAVE_EXT_MENU_BAR
|
||
INLINE void
|
||
fset_menu_bar_window (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->menu_bar_window = val;
|
||
}
|
||
#endif
|
||
INLINE void
|
||
fset_name (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->name = val;
|
||
}
|
||
INLINE void
|
||
fset_param_alist (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->param_alist = val;
|
||
}
|
||
INLINE void
|
||
fset_root_window (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->root_window = val;
|
||
}
|
||
INLINE void
|
||
fset_scroll_bars (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->scroll_bars = val;
|
||
}
|
||
INLINE void
|
||
fset_selected_window (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->selected_window = val;
|
||
}
|
||
INLINE void
|
||
fset_old_selected_window (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->old_selected_window = val;
|
||
}
|
||
INLINE void
|
||
fset_title (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->title = val;
|
||
}
|
||
INLINE void
|
||
fset_tab_bar_items (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->tab_bar_items = val;
|
||
}
|
||
#if defined (HAVE_WINDOW_SYSTEM)
|
||
INLINE void
|
||
fset_tab_bar_window (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->tab_bar_window = val;
|
||
}
|
||
INLINE void
|
||
fset_current_tab_bar_string (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->current_tab_bar_string = val;
|
||
}
|
||
INLINE void
|
||
fset_desired_tab_bar_string (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->desired_tab_bar_string = val;
|
||
}
|
||
#endif /* HAVE_WINDOW_SYSTEM */
|
||
INLINE void
|
||
fset_tool_bar_items (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->tool_bar_items = val;
|
||
}
|
||
|
||
#if defined (HAVE_WINDOW_SYSTEM) && ! defined (HAVE_EXT_TOOL_BAR)
|
||
|
||
INLINE void
|
||
fset_tool_bar_window (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->tool_bar_window = val;
|
||
}
|
||
INLINE void
|
||
fset_current_tool_bar_string (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->current_tool_bar_string = val;
|
||
}
|
||
INLINE void
|
||
fset_desired_tool_bar_string (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->desired_tool_bar_string = val;
|
||
}
|
||
|
||
#endif /* HAVE_WINDOW_SYSTEM && !HAVE_EXT_TOOL_BAR */
|
||
|
||
INLINE void
|
||
fset_tool_bar_position (struct frame *f, Lisp_Object val)
|
||
{
|
||
f->tool_bar_position = val;
|
||
}
|
||
|
||
INLINE double
|
||
NUMVAL (Lisp_Object x)
|
||
{
|
||
return NUMBERP (x) ? XFLOATINT (x) : -1;
|
||
}
|
||
|
||
INLINE double
|
||
default_pixels_per_inch_x (void)
|
||
{
|
||
Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
|
||
? XCAR (Vdisplay_pixels_per_inch)
|
||
: Vdisplay_pixels_per_inch);
|
||
return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
|
||
}
|
||
|
||
INLINE double
|
||
default_pixels_per_inch_y (void)
|
||
{
|
||
Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
|
||
? XCDR (Vdisplay_pixels_per_inch)
|
||
: Vdisplay_pixels_per_inch);
|
||
return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
|
||
}
|
||
|
||
#define FRAME_KBOARD(f) ((f)->terminal->kboard)
|
||
|
||
/* Return a pointer to the image cache of frame F. */
|
||
#define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
|
||
|
||
#define XFRAME(p) \
|
||
(eassert (FRAMEP (p)), XUNTAG (p, Lisp_Vectorlike, struct frame))
|
||
#define XSETFRAME(a, b) XSETPSEUDOVECTOR (a, b, PVEC_FRAME)
|
||
|
||
/* Given a window, return its frame as a Lisp_Object. */
|
||
#define WINDOW_FRAME(w) ((w)->frame)
|
||
|
||
/* Test a frame for particular kinds of display methods. */
|
||
#define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
|
||
#define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
|
||
#define FRAME_X_P(f) ((f)->output_method == output_x_window)
|
||
#ifndef HAVE_NTGUI
|
||
#define FRAME_W32_P(f) false
|
||
#else
|
||
#define FRAME_W32_P(f) ((f)->output_method == output_w32)
|
||
#endif
|
||
#ifndef MSDOS
|
||
#define FRAME_MSDOS_P(f) false
|
||
#else
|
||
#define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
|
||
#endif
|
||
#ifndef HAVE_NS
|
||
#define FRAME_NS_P(f) false
|
||
#else
|
||
#define FRAME_NS_P(f) ((f)->output_method == output_ns)
|
||
#endif
|
||
#ifndef HAVE_PGTK
|
||
#define FRAME_PGTK_P(f) false
|
||
#else
|
||
#define FRAME_PGTK_P(f) ((f)->output_method == output_pgtk)
|
||
#endif
|
||
#ifndef HAVE_HAIKU
|
||
#define FRAME_HAIKU_P(f) false
|
||
#else
|
||
#define FRAME_HAIKU_P(f) ((f)->output_method == output_haiku)
|
||
#endif
|
||
#ifndef HAVE_ANDROID
|
||
#define FRAME_ANDROID_P(f) false
|
||
#else
|
||
#define FRAME_ANDROID_P(f) ((f)->output_method == output_android)
|
||
#endif
|
||
|
||
/* FRAME_WINDOW_P tests whether the frame is a graphical window system
|
||
frame. */
|
||
#ifdef HAVE_X_WINDOWS
|
||
#define FRAME_WINDOW_P(f) FRAME_X_P (f)
|
||
#endif
|
||
#ifdef HAVE_NTGUI
|
||
#define FRAME_WINDOW_P(f) FRAME_W32_P (f)
|
||
#endif
|
||
#ifdef HAVE_NS
|
||
#define FRAME_WINDOW_P(f) FRAME_NS_P(f)
|
||
#endif
|
||
#ifdef HAVE_PGTK
|
||
#define FRAME_WINDOW_P(f) FRAME_PGTK_P(f)
|
||
#endif
|
||
#ifdef HAVE_HAIKU
|
||
#define FRAME_WINDOW_P(f) FRAME_HAIKU_P (f)
|
||
#endif
|
||
#ifdef HAVE_ANDROID
|
||
#define FRAME_WINDOW_P(f) FRAME_ANDROID_P (f)
|
||
#endif
|
||
#ifndef FRAME_WINDOW_P
|
||
#define FRAME_WINDOW_P(f) ((void) (f), false)
|
||
#endif
|
||
|
||
/* Dots per inch of the screen the frame F is on. */
|
||
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
|
||
#define FRAME_RES_X(f) \
|
||
(eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resx)
|
||
#define FRAME_RES_Y(f) \
|
||
(eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resy)
|
||
|
||
#ifdef HAVE_ANDROID
|
||
|
||
/* Android systems use a font scaling factor independent from the
|
||
display DPI. */
|
||
|
||
#define FRAME_RES(f) \
|
||
(eassert (FRAME_WINDOW_P (f)), \
|
||
FRAME_DISPLAY_INFO (f)->font_resolution)
|
||
|
||
#else /* !HAVE_ANDROID */
|
||
#define FRAME_RES(f) FRAME_RES_Y (f)
|
||
#endif /* HAVE_ANDROID */
|
||
|
||
#else /* !HAVE_WINDOW_SYSTEM */
|
||
|
||
/* Defaults when no window system available. */
|
||
|
||
#define FRAME_RES_X(f) default_pixels_per_inch_x ()
|
||
#define FRAME_RES_Y(f) default_pixels_per_inch_y ()
|
||
#define FRAME_RES(f) default_pixels_per_inch_y ()
|
||
|
||
#endif /* HAVE_WINDOW_SYSTEM */
|
||
|
||
/* Return a pointer to the structure holding information about the
|
||
region of text, if any, that is currently shown in mouse-face on
|
||
frame F. We need to define two versions because a TTY-only build
|
||
does not have FRAME_DISPLAY_INFO. */
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
#ifndef HAVE_ANDROID
|
||
# define MOUSE_HL_INFO(F) \
|
||
(FRAME_WINDOW_P (F) \
|
||
? &FRAME_DISPLAY_INFO(F)->mouse_highlight \
|
||
: &(F)->output_data.tty->display_info->mouse_highlight)
|
||
#else
|
||
/* There is no "struct tty_output" on Android at all. */
|
||
# define MOUSE_HL_INFO(F) \
|
||
(&FRAME_DISPLAY_INFO(F)->mouse_highlight)
|
||
#endif
|
||
#else
|
||
# define MOUSE_HL_INFO(F) \
|
||
(&(F)->output_data.tty->display_info->mouse_highlight)
|
||
#endif
|
||
|
||
/* True if frame F is still alive (not deleted). */
|
||
#define FRAME_LIVE_P(f) ((f)->terminal != 0)
|
||
|
||
/* True if frame F is a minibuffer-only frame. */
|
||
#define FRAME_MINIBUF_ONLY_P(f) \
|
||
EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
|
||
|
||
/* True if frame F contains it's own minibuffer window. Frame always has
|
||
minibuffer window, but it could use minibuffer window of another frame. */
|
||
#define FRAME_HAS_MINIBUF_P(f) \
|
||
(WINDOWP (f->minibuffer_window) \
|
||
&& XFRAME (XWINDOW (f->minibuffer_window)->frame) == f)
|
||
|
||
/* Scale factor of frame F. */
|
||
#if defined HAVE_NS
|
||
# define FRAME_SCALE_FACTOR(f) (FRAME_NS_P (f) ? ns_frame_scale_factor (f) : 1)
|
||
#elif defined HAVE_PGTK
|
||
# define FRAME_SCALE_FACTOR(f) (FRAME_PGTK_P (f) ? pgtk_frame_scale_factor (f) : 1)
|
||
#else
|
||
# define FRAME_SCALE_FACTOR(f) 1
|
||
#endif
|
||
|
||
/* Native width and height of frame F, in pixels and frame
|
||
columns/lines. */
|
||
#define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
|
||
#define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
|
||
#define FRAME_TOTAL_COLS(f) ((f)->total_cols)
|
||
#define FRAME_TOTAL_LINES(f) ((f)->total_lines)
|
||
|
||
/* Text width and height of frame F, in pixels and frame
|
||
columns/lines. */
|
||
#define FRAME_TEXT_WIDTH(f) (f)->text_width
|
||
#define FRAME_TEXT_HEIGHT(f) (f)->text_height
|
||
#define FRAME_COLS(f) ((f)->text_cols)
|
||
#define FRAME_LINES(f) ((f)->text_lines)
|
||
|
||
/* True if this frame should display an external menu bar. */
|
||
#ifdef HAVE_EXT_MENU_BAR
|
||
#define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
|
||
#else
|
||
#define FRAME_EXTERNAL_MENU_BAR(f) false
|
||
#endif
|
||
|
||
/* Size of frame F's internal menu bar in frame lines and pixels. */
|
||
#define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
|
||
#define FRAME_MENU_BAR_HEIGHT(f) (f)->menu_bar_height
|
||
|
||
/* Size of frame F's tab bar in frame lines and pixels. */
|
||
#define FRAME_TAB_BAR_LINES(f) (f)->tab_bar_lines
|
||
#define FRAME_TAB_BAR_HEIGHT(f) (f)->tab_bar_height
|
||
|
||
/* True if this frame should display an external tool bar. */
|
||
#ifdef HAVE_EXT_TOOL_BAR
|
||
#define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
|
||
#else
|
||
#define FRAME_EXTERNAL_TOOL_BAR(f) false
|
||
#endif
|
||
|
||
/* Position of F's tool bar; one of Qtop, Qleft, Qright, or
|
||
Qbottom.
|
||
|
||
Qleft and Qright are not supported outside GTK+. */
|
||
#define FRAME_TOOL_BAR_POSITION(f) (f)->tool_bar_position
|
||
|
||
/* Size of frame F's internal tool bar in frame lines and pixels. */
|
||
#define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
|
||
#define FRAME_TOOL_BAR_HEIGHT(f) (f)->tool_bar_height
|
||
|
||
/* Size of F's tool bar if it is placed at the top of the
|
||
frame, else 0. */
|
||
|
||
#define FRAME_TOOL_BAR_TOP_HEIGHT(f) \
|
||
((BASE_EQ ((f)->tool_bar_position, Qtop)) \
|
||
? (f)->tool_bar_height : 0)
|
||
|
||
#define FRAME_TOOL_BAR_TOP_LINES(f) \
|
||
((BASE_EQ ((f)->tool_bar_position, Qtop)) \
|
||
? (f)->tool_bar_lines : 0)
|
||
|
||
/* Size of F's tool bar if it is placed at the bottom of the
|
||
frame. */
|
||
#define FRAME_TOOL_BAR_BOTTOM_HEIGHT(f) \
|
||
((BASE_EQ ((f)->tool_bar_position, Qbottom)) \
|
||
? (f)->tool_bar_height : 0)
|
||
|
||
#define FRAME_TOOL_BAR_BOTTOM_LINES(f) \
|
||
((BASE_EQ ((f)->tool_bar_position, Qbottom)) \
|
||
? (f)->tool_bar_lines : 0)
|
||
|
||
/* Height of frame F's top margin in frame lines. */
|
||
#define FRAME_TOP_MARGIN(F) \
|
||
(FRAME_MENU_BAR_LINES (F) \
|
||
+ FRAME_TAB_BAR_LINES (F) \
|
||
+ FRAME_TOOL_BAR_TOP_LINES (F))
|
||
|
||
/* Pixel height of frame F's top margin. */
|
||
|
||
#define FRAME_TOP_MARGIN_HEIGHT(F) \
|
||
(FRAME_MENU_BAR_HEIGHT (F) \
|
||
+ FRAME_TAB_BAR_HEIGHT (F) \
|
||
+ FRAME_TOOL_BAR_TOP_HEIGHT (F))
|
||
|
||
/* Height of F's bottom margin in frame lines. */
|
||
|
||
#define FRAME_BOTTOM_MARGIN(f) \
|
||
FRAME_TOOL_BAR_BOTTOM_LINES (f)
|
||
|
||
/* Pixel height of frame F's bottom margin. */
|
||
|
||
#define FRAME_BOTTOM_MARGIN_HEIGHT(f) \
|
||
FRAME_TOOL_BAR_BOTTOM_HEIGHT (f)
|
||
|
||
/* Size of both vertical margins combined. */
|
||
|
||
#define FRAME_MARGINS(F) \
|
||
(FRAME_MENU_BAR_LINES (F) \
|
||
+ FRAME_TAB_BAR_LINES (F) \
|
||
+ FRAME_TOOL_BAR_LINES (F))
|
||
|
||
#define FRAME_MARGIN_HEIGHT(F) \
|
||
(FRAME_MENU_BAR_HEIGHT (F) \
|
||
+ FRAME_TAB_BAR_HEIGHT (F) \
|
||
+ FRAME_TOOL_BAR_HEIGHT (F))
|
||
|
||
/* True if frame F is currently visible. */
|
||
#define FRAME_VISIBLE_P(f) (f)->visible
|
||
|
||
/* True if frame F should be redisplayed. This is normally the same
|
||
as FRAME_VISIBLE_P (f). Under X, frames can continue to be
|
||
displayed to the user by the compositing manager even if they are
|
||
invisible, so this also checks whether or not the frame is reported
|
||
visible by the X server. */
|
||
|
||
#ifndef HAVE_X_WINDOWS
|
||
#define FRAME_REDISPLAY_P(f) FRAME_VISIBLE_P (f)
|
||
#else
|
||
#define FRAME_REDISPLAY_P(f) (FRAME_VISIBLE_P (f) \
|
||
|| (FRAME_X_P (f) \
|
||
&& FRAME_X_VISIBLE (f)))
|
||
#endif
|
||
|
||
/* True if frame F is currently visible but hidden. */
|
||
#define FRAME_OBSCURED_P(f) ((f)->visible > 1)
|
||
|
||
/* True if frame F is currently iconified. */
|
||
#define FRAME_ICONIFIED_P(f) (f)->iconified
|
||
|
||
/* Mark frame F as currently garbaged. */
|
||
#define SET_FRAME_GARBAGED(f) \
|
||
(frame_garbaged = true, fset_redisplay (f), f->garbaged = true)
|
||
|
||
/* True if frame F is currently garbaged. */
|
||
#define FRAME_GARBAGED_P(f) (f)->garbaged
|
||
|
||
/* True means do not allow splitting this frame's window. */
|
||
#define FRAME_NO_SPLIT_P(f) (f)->no_split
|
||
|
||
/* Not really implemented. */
|
||
#define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
|
||
|
||
/* True if all windows except selected window and mini window
|
||
are frozen on frame F. */
|
||
#define FRAME_WINDOWS_FROZEN(f) (f)->frozen_window_starts
|
||
|
||
/* True if at least one window changed on frame F since the last time
|
||
window change functions were run on F. */
|
||
#define FRAME_WINDOW_CHANGE(f) (f)->window_change
|
||
|
||
/* True if running window state change functions has been explicitly
|
||
requested for this frame since last redisplay. */
|
||
#define FRAME_WINDOW_STATE_CHANGE(f) (f)->window_state_change
|
||
|
||
/* The minibuffer window of frame F, if it has one; otherwise nil. */
|
||
#define FRAME_MINIBUF_WINDOW(f) f->minibuffer_window
|
||
|
||
/* The root window of the window tree of frame F. */
|
||
#define FRAME_ROOT_WINDOW(f) f->root_window
|
||
|
||
/* The currently selected window of frame F. */
|
||
#define FRAME_SELECTED_WINDOW(f) f->selected_window
|
||
/* The old selected window of frame F. */
|
||
#define FRAME_OLD_SELECTED_WINDOW(f) f->old_selected_window
|
||
|
||
#define FRAME_INSERT_COST(f) (f)->insert_line_cost
|
||
#define FRAME_DELETE_COST(f) (f)->delete_line_cost
|
||
#define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
|
||
#define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
|
||
#define FRAME_FOCUS_FRAME(f) f->focus_frame
|
||
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
/* This frame slot says whether scroll bars are currently enabled for frame F,
|
||
and which side they are on. */
|
||
#define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
|
||
#define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
|
||
((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
|
||
#define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
|
||
((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
|
||
#define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
|
||
((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
|
||
#else /* not HAVE_WINDOW_SYSTEM */
|
||
/* If there is no window system, there are no scroll bars. */
|
||
#define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) \
|
||
((void) (f), vertical_scroll_bar_none)
|
||
#define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((void) (f), 0)
|
||
#define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) ((void) (f), 0)
|
||
#define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) ((void) (f), 0)
|
||
#endif /* HAVE_WINDOW_SYSTEM */
|
||
|
||
#if defined (HAVE_WINDOW_SYSTEM)
|
||
#define FRAME_UNDECORATED(f) ((f)->undecorated)
|
||
#ifdef HAVE_NTGUI
|
||
#define FRAME_OVERRIDE_REDIRECT(f) ((void) (f), 0)
|
||
#else
|
||
#define FRAME_OVERRIDE_REDIRECT(f) ((f)->override_redirect)
|
||
#endif
|
||
#define FRAME_PARENT_FRAME(f) \
|
||
(NILP ((f)->parent_frame) \
|
||
? NULL \
|
||
: XFRAME ((f)->parent_frame))
|
||
#define FRAME_SKIP_TASKBAR(f) ((f)->skip_taskbar)
|
||
#define FRAME_NO_FOCUS_ON_MAP(f) ((f)->no_focus_on_map)
|
||
#define FRAME_NO_ACCEPT_FOCUS(f) ((f)->no_accept_focus)
|
||
#define FRAME_NO_SPECIAL_GLYPHS(f) ((f)->no_special_glyphs)
|
||
#define FRAME_Z_GROUP(f) ((f)->z_group)
|
||
#define FRAME_Z_GROUP_NONE(f) ((f)->z_group == z_group_none)
|
||
#define FRAME_Z_GROUP_ABOVE(f) ((f)->z_group == z_group_above)
|
||
#define FRAME_Z_GROUP_ABOVE_SUSPENDED(f) \
|
||
((f)->z_group == z_group_above_suspended)
|
||
#define FRAME_Z_GROUP_BELOW(f) ((f)->z_group == z_group_below)
|
||
#define FRAME_TOOLTIP_P(f) ((f)->tooltip)
|
||
#ifdef NS_IMPL_COCOA
|
||
#define FRAME_NS_APPEARANCE(f) ((f)->ns_appearance)
|
||
#define FRAME_NS_TRANSPARENT_TITLEBAR(f) ((f)->ns_transparent_titlebar)
|
||
#endif
|
||
#else /* not HAVE_WINDOW_SYSTEM */
|
||
#define FRAME_UNDECORATED(f) ((void) (f), 0)
|
||
#define FRAME_OVERRIDE_REDIRECT(f) ((void) (f), 0)
|
||
#define FRAME_PARENT_FRAME(f) ((void) (f), NULL)
|
||
#define FRAME_SKIP_TASKBAR(f) ((void) (f), 0)
|
||
#define FRAME_NO_FOCUS_ON_MAP(f) ((void) (f), 0)
|
||
#define FRAME_NO_ACCEPT_FOCUS(f) ((void) (f), 0)
|
||
#define FRAME_NO_SPECIAL_GLYPHS(f) ((void) (f), 0)
|
||
#define FRAME_Z_GROUP(f) ((void) (f), z_group_none)
|
||
#define FRAME_Z_GROUP_NONE(f) ((void) (f), true)
|
||
#define FRAME_Z_GROUP_ABOVE(f) ((void) (f), false)
|
||
#define FRAME_Z_GROUP_BELOW(f) ((void) (f), false)
|
||
#define FRAME_TOOLTIP_P(f) ((void) f, false)
|
||
#endif /* HAVE_WINDOW_SYSTEM */
|
||
|
||
/* Whether horizontal scroll bars are currently enabled for frame F. */
|
||
#if USE_HORIZONTAL_SCROLL_BARS
|
||
#define FRAME_HAS_HORIZONTAL_SCROLL_BARS(f) \
|
||
((f)->horizontal_scroll_bars)
|
||
#else
|
||
#define FRAME_HAS_HORIZONTAL_SCROLL_BARS(f) ((void) (f), 0)
|
||
#endif
|
||
|
||
/* Width that a scroll bar in frame F should have, if there is one.
|
||
Measured in pixels.
|
||
If scroll bars are turned off, this is still nonzero. */
|
||
#define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
|
||
|
||
/* Height that a scroll bar in frame F should have, if there is one.
|
||
Measured in pixels.
|
||
If scroll bars are turned off, this is still nonzero. */
|
||
#define FRAME_CONFIG_SCROLL_BAR_HEIGHT(f) ((f)->config_scroll_bar_height)
|
||
|
||
/* Width that a scroll bar in frame F should have, if there is one.
|
||
Measured in columns (characters).
|
||
If scroll bars are turned off, this is still nonzero. */
|
||
#define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
|
||
|
||
/* Height that a scroll bar in frame F should have, if there is one.
|
||
Measured in lines (characters).
|
||
If scroll bars are turned off, this is still nonzero. */
|
||
#define FRAME_CONFIG_SCROLL_BAR_LINES(f) ((f)->config_scroll_bar_lines)
|
||
|
||
/* Width of a left scroll bar in frame F, measured in pixels */
|
||
#define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
|
||
(FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
|
||
? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
|
||
: 0)
|
||
|
||
/* Width of a right scroll bar area in frame F, measured in pixels */
|
||
#define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
|
||
(FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
|
||
? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
|
||
: 0)
|
||
|
||
/* Width of a left scroll bar in frame F, measured in columns
|
||
(characters), but only if scroll bars are on the left. If scroll
|
||
bars are on the right in this frame, or there are no scroll bars,
|
||
value is 0. */
|
||
#define FRAME_LEFT_SCROLL_BAR_COLS(f) \
|
||
(FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
|
||
? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
|
||
: 0)
|
||
|
||
/* Width of a right scroll bar in frame F, measured in columns
|
||
(characters), but only if scroll bars are on the right. If scroll
|
||
bars are on the left in this frame, or there are no scroll bars,
|
||
value is 0. */
|
||
#define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
|
||
(FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
|
||
? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
|
||
: 0)
|
||
|
||
/* Width of a vertical scroll bar area in frame F, measured in
|
||
pixels. */
|
||
#define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
|
||
(FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
|
||
? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
|
||
: 0)
|
||
|
||
/* Height of horizontal scroll bar area in frame F, measured in
|
||
pixels. */
|
||
#define FRAME_SCROLL_BAR_AREA_HEIGHT(f) \
|
||
(FRAME_HAS_HORIZONTAL_SCROLL_BARS (f) \
|
||
? FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) \
|
||
: 0)
|
||
|
||
/* Width of vertical scroll bar in frame F, measured in columns. */
|
||
#define FRAME_SCROLL_BAR_COLS(f) \
|
||
(FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
|
||
? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
|
||
: 0)
|
||
|
||
/* Height of horizontal scroll bar in frame F, measured in lines. */
|
||
#define FRAME_SCROLL_BAR_LINES(f) \
|
||
(FRAME_HAS_HORIZONTAL_SCROLL_BARS (f) \
|
||
? FRAME_CONFIG_SCROLL_BAR_LINES (f) \
|
||
: 0)
|
||
|
||
/* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
|
||
#define FRAME_CURSOR_X_LIMIT(f) \
|
||
(FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
|
||
|
||
/* Nonzero if frame F has scroll bars. */
|
||
#define FRAME_SCROLL_BARS(f) (f->scroll_bars)
|
||
#define FRAME_CONDEMNED_SCROLL_BARS(f) (f->condemned_scroll_bars)
|
||
|
||
#define FRAME_MENU_BAR_ITEMS(f) (f->menu_bar_items)
|
||
#define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
|
||
|
||
#define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
|
||
#define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
|
||
#define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
|
||
#define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
|
||
|
||
#define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
|
||
#define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
|
||
|
||
/* Return a pointer to the face cache of frame F. */
|
||
#define FRAME_FACE_CACHE(F) (F)->face_cache
|
||
|
||
/* Return the size of message_buf of the frame F. We multiply the
|
||
width of the frame by 4 because multi-byte form may require at most
|
||
4-byte for a character. */
|
||
|
||
#define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
|
||
|
||
#define CHECK_FRAME(x) \
|
||
CHECK_TYPE (FRAMEP (x), Qframep, x)
|
||
|
||
#define CHECK_LIVE_FRAME(x) \
|
||
CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
|
||
|
||
/* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
|
||
`for' loop which iterates over the elements of Vframe_list. The
|
||
loop will set FRAME_VAR, a Lisp_Object, to each frame in
|
||
Vframe_list in succession and execute the statement. LIST_VAR
|
||
should be a Lisp_Object too; it is used to iterate through the
|
||
Vframe_list. Note that this macro walks over child frames and
|
||
the tooltip frame as well.
|
||
|
||
This macro is a holdover from a time when multiple frames weren't always
|
||
supported. An alternate definition of the macro would expand to
|
||
something which executes the statement once. */
|
||
#define FOR_EACH_FRAME(list_var, frame_var) \
|
||
for ((list_var) = Vframe_list; \
|
||
(CONSP (list_var) \
|
||
&& (frame_var = XCAR (list_var), true)); \
|
||
list_var = XCDR (list_var))
|
||
|
||
/* Reflect mouse movement when a complete frame update is performed. */
|
||
#define FRAME_MOUSE_UPDATE(frame) \
|
||
do { \
|
||
Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (frame); \
|
||
if (frame == hlinfo->mouse_face_mouse_frame) \
|
||
{ \
|
||
block_input (); \
|
||
note_mouse_highlight (hlinfo->mouse_face_mouse_frame, \
|
||
hlinfo->mouse_face_mouse_x, \
|
||
hlinfo->mouse_face_mouse_y); \
|
||
unblock_input (); \
|
||
} \
|
||
} while (false)
|
||
|
||
/* Handy macro to construct an argument to Fmodify_frame_parameters. */
|
||
#define AUTO_FRAME_ARG(name, parameter, value) \
|
||
AUTO_LIST1 (name, AUTO_CONS_EXPR (parameter, value))
|
||
|
||
/* False means there are no visible garbaged frames. */
|
||
extern bool frame_garbaged;
|
||
|
||
/* Set visibility of frame F.
|
||
We call redisplay_other_windows to make sure the frame gets redisplayed
|
||
if some changes were applied to it while it wasn't visible (and hence
|
||
wasn't redisplayed). */
|
||
INLINE void
|
||
SET_FRAME_VISIBLE (struct frame *f, int v)
|
||
{
|
||
eassert (0 <= v && v <= 2);
|
||
if (v)
|
||
{
|
||
if (v == 1 && f->visible != 1)
|
||
redisplay_other_windows ();
|
||
if (FRAME_GARBAGED_P (f))
|
||
frame_garbaged = true;
|
||
}
|
||
f->visible = v;
|
||
}
|
||
|
||
/* Set iconified status of frame F. */
|
||
INLINE void
|
||
SET_FRAME_ICONIFIED (struct frame *f, int i)
|
||
{
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
Lisp_Object frame;
|
||
#endif
|
||
|
||
eassert (0 <= (i) && (i) <= 1);
|
||
|
||
f->iconified = i;
|
||
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
/* Iconifying a frame might cause the frame title to change if no
|
||
title was explicitly specified. Force the frame title to be
|
||
recomputed. */
|
||
|
||
XSETFRAME (frame, f);
|
||
|
||
if (FRAME_WINDOW_P (f))
|
||
gui_consider_frame_title (frame);
|
||
#endif
|
||
}
|
||
|
||
extern Lisp_Object selected_frame;
|
||
extern Lisp_Object old_selected_frame;
|
||
|
||
extern int frame_default_tab_bar_height;
|
||
|
||
#ifndef HAVE_EXT_TOOL_BAR
|
||
extern int frame_default_tool_bar_height;
|
||
#endif
|
||
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
# define WINDOW_SYSTEM_RETURN
|
||
#else
|
||
# define WINDOW_SYSTEM_RETURN _Noreturn ATTRIBUTE_COLD
|
||
#endif
|
||
|
||
extern WINDOW_SYSTEM_RETURN struct frame *
|
||
decode_window_system_frame (Lisp_Object);
|
||
extern struct frame *decode_live_frame (Lisp_Object);
|
||
extern struct frame *decode_any_frame (Lisp_Object);
|
||
extern struct frame *make_initial_frame (void);
|
||
extern struct frame *make_frame (bool);
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
extern struct frame *make_minibuffer_frame (void);
|
||
extern struct frame *make_frame_without_minibuffer (Lisp_Object,
|
||
struct kboard *,
|
||
Lisp_Object);
|
||
extern bool display_available (void);
|
||
#endif
|
||
|
||
INLINE bool
|
||
window_system_available (struct frame *f)
|
||
{
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
return f ? FRAME_WINDOW_P (f) || FRAME_MSDOS_P (f) : display_available ();
|
||
#else
|
||
return false;
|
||
#endif
|
||
}
|
||
|
||
extern WINDOW_SYSTEM_RETURN void check_window_system (struct frame *);
|
||
extern void frame_make_pointer_invisible (struct frame *);
|
||
extern void frame_make_pointer_visible (struct frame *);
|
||
extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
|
||
extern bool frame_inhibit_resize (struct frame *, bool, Lisp_Object);
|
||
extern void adjust_frame_size (struct frame *, int, int, int, bool,
|
||
Lisp_Object);
|
||
extern Lisp_Object mouse_position (bool);
|
||
extern void frame_size_history_plain (struct frame *, Lisp_Object);
|
||
extern void frame_size_history_extra (struct frame *, Lisp_Object,
|
||
int, int, int, int, int, int);
|
||
#ifdef NS_IMPL_COCOA
|
||
/* Implemented in nsfns.m. */
|
||
extern void ns_make_frame_key_window (struct frame *);
|
||
#endif
|
||
extern Lisp_Object Vframe_list;
|
||
|
||
/* Value is a pointer to the selected frame. If the selected frame
|
||
isn't live, abort. */
|
||
|
||
#define SELECTED_FRAME() \
|
||
((FRAMEP (selected_frame) \
|
||
&& FRAME_LIVE_P (XFRAME (selected_frame))) \
|
||
? XFRAME (selected_frame) \
|
||
: (emacs_abort (), (struct frame *) 0))
|
||
|
||
|
||
/***********************************************************************
|
||
Display-related Macros
|
||
***********************************************************************/
|
||
|
||
/* Canonical y-unit on frame F.
|
||
This value currently equals the line height of the frame (which is
|
||
the height of the default font of F). */
|
||
#define FRAME_LINE_HEIGHT(F) ((F)->line_height)
|
||
|
||
/* Canonical x-unit on frame F.
|
||
This value currently equals the average width of the default font of F. */
|
||
#define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
|
||
|
||
/* Get a frame's window system dimension. If no window system, this is 0. */
|
||
|
||
INLINE int
|
||
frame_dimension (int x)
|
||
{
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
return x;
|
||
#else
|
||
return 0;
|
||
#endif
|
||
}
|
||
|
||
/* Total width of fringes reserved for drawing truncation bitmaps,
|
||
continuation bitmaps and alike. The width is in canonical char
|
||
units of the frame. This must currently be the case because window
|
||
sizes aren't pixel values. If it weren't the case, we wouldn't be
|
||
able to split windows horizontally nicely. */
|
||
INLINE int
|
||
FRAME_FRINGE_COLS (struct frame *f)
|
||
{
|
||
return frame_dimension (f->fringe_cols);
|
||
}
|
||
|
||
/* Pixel-width of the left and right fringe. */
|
||
|
||
INLINE int
|
||
FRAME_LEFT_FRINGE_WIDTH (struct frame *f)
|
||
{
|
||
return frame_dimension (f->left_fringe_width);
|
||
}
|
||
INLINE int
|
||
FRAME_RIGHT_FRINGE_WIDTH (struct frame *f)
|
||
{
|
||
return frame_dimension (f->right_fringe_width);
|
||
}
|
||
|
||
/* Total width of fringes in pixels. */
|
||
|
||
INLINE int
|
||
FRAME_TOTAL_FRINGE_WIDTH (struct frame *f)
|
||
{
|
||
return FRAME_LEFT_FRINGE_WIDTH (f) + FRAME_RIGHT_FRINGE_WIDTH (f);
|
||
}
|
||
|
||
INLINE int
|
||
FRAME_CHILD_FRAME_BORDER_WIDTH (struct frame *f)
|
||
{
|
||
return frame_dimension (f->child_frame_border_width);
|
||
}
|
||
|
||
/* Pixel-width of internal border. Uses child_frame_border_width for
|
||
child frames if possible, and falls back on internal_border_width
|
||
otherwise. */
|
||
INLINE int
|
||
FRAME_INTERNAL_BORDER_WIDTH (struct frame *f)
|
||
{
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
return (FRAME_PARENT_FRAME(f)
|
||
? (FRAME_CHILD_FRAME_BORDER_WIDTH(f) >= 0
|
||
? FRAME_CHILD_FRAME_BORDER_WIDTH(f)
|
||
: frame_dimension (f->internal_border_width))
|
||
: frame_dimension (f->internal_border_width));
|
||
#else
|
||
return frame_dimension (f->internal_border_width);
|
||
#endif
|
||
}
|
||
|
||
/* Pixel-size of window divider lines. */
|
||
INLINE int
|
||
FRAME_RIGHT_DIVIDER_WIDTH (struct frame *f)
|
||
{
|
||
return frame_dimension (f->right_divider_width);
|
||
}
|
||
|
||
INLINE int
|
||
FRAME_BOTTOM_DIVIDER_WIDTH (struct frame *f)
|
||
{
|
||
return frame_dimension (f->bottom_divider_width);
|
||
}
|
||
|
||
/* Return a non-null pointer to the cached face with ID on frame F. */
|
||
|
||
INLINE struct face *
|
||
FACE_FROM_ID (struct frame *f, int id)
|
||
{
|
||
eassert (0 <= id && id < FRAME_FACE_CACHE (f)->used);
|
||
return FRAME_FACE_CACHE (f)->faces_by_id[id];
|
||
}
|
||
|
||
/* Return a pointer to the face with ID on frame F, or null if such a
|
||
face doesn't exist. */
|
||
|
||
INLINE struct face *
|
||
FACE_FROM_ID_OR_NULL (struct frame *f, int id)
|
||
{
|
||
int used = FRAME_FACE_CACHE (f)->used;
|
||
eassume (0 <= used);
|
||
return 0 <= id && id < used ? FRAME_FACE_CACHE (f)->faces_by_id[id] : NULL;
|
||
}
|
||
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
|
||
/* A non-null pointer to the image with id ID on frame F. */
|
||
|
||
INLINE struct image *
|
||
IMAGE_FROM_ID (struct frame *f, int id)
|
||
{
|
||
eassert (0 <= id && id < FRAME_IMAGE_CACHE (f)->used);
|
||
return FRAME_IMAGE_CACHE (f)->images[id];
|
||
}
|
||
|
||
/* Value is a pointer to the image with id ID on frame F, or null if
|
||
no image with that id exists. */
|
||
|
||
INLINE struct image *
|
||
IMAGE_OPT_FROM_ID (struct frame *f, int id)
|
||
{
|
||
int used = FRAME_IMAGE_CACHE (f)->used;
|
||
eassume (0 <= used);
|
||
return 0 <= id && id < used ? FRAME_IMAGE_CACHE (f)->images[id] : NULL;
|
||
}
|
||
#endif
|
||
|
||
/***********************************************************************
|
||
Conversion between canonical units and pixels
|
||
***********************************************************************/
|
||
|
||
/* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
|
||
y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
|
||
represented as Lisp numbers, i.e. integers or floats. */
|
||
|
||
/* Convert canonical value X to pixels. F is the frame whose
|
||
canonical char width is to be used. X must be a Lisp integer or
|
||
float. Value is a C integer. */
|
||
#define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
|
||
((int) (XFLOATINT (X) * FRAME_COLUMN_WIDTH (F)))
|
||
|
||
/* Convert canonical value Y to pixels. F is the frame whose
|
||
canonical character height is to be used. X must be a Lisp integer
|
||
or float. Value is a C integer. */
|
||
#define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
|
||
((int) (XFLOATINT (Y) * FRAME_LINE_HEIGHT (F)))
|
||
|
||
/* Convert pixel-value X to canonical units. F is the frame whose
|
||
canonical character width is to be used. X is a C integer. Result
|
||
is a Lisp float if X is not a multiple of the canon width,
|
||
otherwise it's a Lisp integer. */
|
||
#define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
|
||
((X) % FRAME_COLUMN_WIDTH (F) != 0 \
|
||
? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
|
||
: make_fixnum ((X) / FRAME_COLUMN_WIDTH (F)))
|
||
|
||
/* Convert pixel-value Y to canonical units. F is the frame whose
|
||
canonical character height is to be used. Y is a C integer.
|
||
Result is a Lisp float if Y is not a multiple of the canon width,
|
||
otherwise it's a Lisp integer. */
|
||
#define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
|
||
((Y) % FRAME_LINE_HEIGHT (F) \
|
||
? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
|
||
: make_fixnum ((Y) / FRAME_LINE_HEIGHT (F)))
|
||
|
||
|
||
|
||
/* Manipulating pixel sizes and character sizes.
|
||
Knowledge of which factors affect the overall size of the window should
|
||
be hidden in these macros, if that's possible.
|
||
|
||
Return the upper/left pixel position of the character cell on frame F
|
||
at ROW/COL. */
|
||
#define FRAME_LINE_TO_PIXEL_Y(f, row) \
|
||
(((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
|
||
+ (row) * FRAME_LINE_HEIGHT (f))
|
||
|
||
#define FRAME_COL_TO_PIXEL_X(f, col) \
|
||
(FRAME_INTERNAL_BORDER_WIDTH (f) \
|
||
+ (col) * FRAME_COLUMN_WIDTH (f))
|
||
|
||
/* Return the pixel width/height of frame F if it has
|
||
COLS columns/LINES rows. */
|
||
#define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
|
||
((cols) * FRAME_COLUMN_WIDTH (f) \
|
||
+ FRAME_SCROLL_BAR_AREA_WIDTH (f) \
|
||
+ FRAME_TOTAL_FRINGE_WIDTH (f) \
|
||
+ 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
|
||
|
||
#define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
|
||
((lines) * FRAME_LINE_HEIGHT (f) \
|
||
+ FRAME_TOP_MARGIN_HEIGHT (f) \
|
||
+ FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
|
||
+ 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
|
||
|
||
/* Return the row/column (zero-based) of the character cell containing
|
||
the pixel on FRAME at Y/X. */
|
||
#define FRAME_PIXEL_Y_TO_LINE(f, y) \
|
||
(((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
|
||
? (y) \
|
||
: ((y) < (FRAME_TOP_MARGIN_HEIGHT (f) \
|
||
+ FRAME_INTERNAL_BORDER_WIDTH (f)) \
|
||
? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) \
|
||
+ FRAME_INTERNAL_BORDER_WIDTH (f) \
|
||
/* Arrange for the division to round down. */ \
|
||
+ FRAME_LINE_HEIGHT (f) - 1) \
|
||
: (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
|
||
/ FRAME_LINE_HEIGHT (f))
|
||
|
||
#define FRAME_PIXEL_X_TO_COL(f, x) \
|
||
(((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
|
||
/ FRAME_COLUMN_WIDTH (f))
|
||
|
||
/* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
|
||
frame F (so we round down)? */
|
||
#define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
|
||
(((width) \
|
||
- FRAME_TOTAL_FRINGE_WIDTH (f) \
|
||
- FRAME_SCROLL_BAR_AREA_WIDTH (f) \
|
||
- 2 * FRAME_INTERNAL_BORDER_WIDTH (f)) \
|
||
/ FRAME_COLUMN_WIDTH (f))
|
||
|
||
#define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
|
||
(((height) \
|
||
- FRAME_MARGIN_HEIGHT (f) \
|
||
- FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
|
||
- 2 * FRAME_INTERNAL_BORDER_WIDTH (f)) \
|
||
/ FRAME_LINE_HEIGHT (f))
|
||
|
||
/* Return the pixel width/height of frame F with a text size of
|
||
width/height. */
|
||
#define FRAME_TEXT_TO_PIXEL_WIDTH(f, width) \
|
||
((width) \
|
||
+ FRAME_SCROLL_BAR_AREA_WIDTH (f) \
|
||
+ FRAME_TOTAL_FRINGE_WIDTH (f) \
|
||
+ 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
|
||
|
||
#define FRAME_TEXT_TO_PIXEL_HEIGHT(f, height) \
|
||
((height) \
|
||
+ FRAME_MARGIN_HEIGHT (f) \
|
||
+ FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
|
||
+ 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
|
||
|
||
/* Return the text width/height of frame F with a pixel size of
|
||
width/height. */
|
||
#define FRAME_PIXEL_TO_TEXT_WIDTH(f, width) \
|
||
((width) \
|
||
- FRAME_SCROLL_BAR_AREA_WIDTH (f) \
|
||
- FRAME_TOTAL_FRINGE_WIDTH (f) \
|
||
- 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
|
||
|
||
#define FRAME_PIXEL_TO_TEXT_HEIGHT(f, height) \
|
||
((height) \
|
||
- FRAME_MARGIN_HEIGHT (f) \
|
||
- FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
|
||
- 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
|
||
|
||
#define FRAME_INNER_WIDTH(f) \
|
||
(FRAME_PIXEL_WIDTH (f) \
|
||
- 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
|
||
|
||
#define FRAME_INNER_HEIGHT(f) \
|
||
(FRAME_PIXEL_HEIGHT (f) \
|
||
- FRAME_MARGIN_HEIGHT (f) \
|
||
- 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
|
||
|
||
/* Value is the smallest width of any character in any font on frame F. */
|
||
#define FRAME_SMALLEST_CHAR_WIDTH(f) \
|
||
FRAME_DISPLAY_INFO (f)->smallest_char_width
|
||
|
||
/* Value is the smallest height of any font on frame F. */
|
||
#define FRAME_SMALLEST_FONT_HEIGHT(f) \
|
||
FRAME_DISPLAY_INFO (f)->smallest_font_height
|
||
|
||
/***********************************************************************
|
||
Frame Parameters
|
||
***********************************************************************/
|
||
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
|
||
/* The class of this X application. */
|
||
#define EMACS_CLASS "Emacs"
|
||
|
||
extern void gui_set_frame_parameters_1 (struct frame *, Lisp_Object, bool);
|
||
extern void gui_set_frame_parameters (struct frame *, Lisp_Object);
|
||
extern void gui_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_font (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_left_fringe (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_right_fringe (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_right_divider_width (struct frame *, Lisp_Object,
|
||
Lisp_Object);
|
||
extern void gui_set_bottom_divider_width (struct frame *, Lisp_Object,
|
||
Lisp_Object);
|
||
extern void gui_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_vertical_scroll_bars (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_horizontal_scroll_bars (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_scroll_bar_width (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_scroll_bar_height (struct frame *, Lisp_Object, Lisp_Object);
|
||
|
||
extern long gui_figure_window_size (struct frame *, Lisp_Object, bool, bool);
|
||
|
||
extern void gui_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_alpha_background (struct frame *, Lisp_Object, Lisp_Object);
|
||
extern void gui_set_no_special_glyphs (struct frame *, Lisp_Object, Lisp_Object);
|
||
|
||
extern void validate_x_resource_name (void);
|
||
|
||
extern Lisp_Object gui_display_get_resource (Display_Info *,
|
||
Lisp_Object attribute,
|
||
Lisp_Object class,
|
||
Lisp_Object component,
|
||
Lisp_Object subclass);
|
||
|
||
extern void set_frame_menubar (struct frame *f, bool deep_p);
|
||
extern void frame_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
|
||
extern void free_frame_menubar (struct frame *);
|
||
extern bool frame_ancestor_p (struct frame *af, struct frame *df);
|
||
extern enum internal_border_part frame_internal_border_part (struct frame *f, int x, int y);
|
||
|
||
#if defined HAVE_X_WINDOWS
|
||
extern void x_wm_set_icon_position (struct frame *, int, int);
|
||
#if !defined USE_X_TOOLKIT
|
||
extern const char *x_get_resource_string (const char *, const char *);
|
||
#endif
|
||
#endif /* HAVE_X_WINDOWS */
|
||
|
||
#if !defined (HAVE_NS) && !defined (HAVE_PGTK)
|
||
|
||
/* Set F's bitmap icon, if specified among F's parameters. */
|
||
|
||
INLINE void
|
||
gui_set_bitmap_icon (struct frame *f)
|
||
{
|
||
Lisp_Object obj = assq_no_quit (Qicon_type, f->param_alist);
|
||
|
||
if (CONSP (obj) && !NILP (XCDR (obj))
|
||
&& FRAME_TERMINAL (f)->set_bitmap_icon_hook)
|
||
FRAME_TERMINAL (f)->set_bitmap_icon_hook (f, XCDR (obj));
|
||
}
|
||
|
||
#endif /* !HAVE_NS */
|
||
#endif /* HAVE_WINDOW_SYSTEM */
|
||
|
||
INLINE void
|
||
flush_frame (struct frame *f)
|
||
{
|
||
struct redisplay_interface *rif = FRAME_RIF (f);
|
||
|
||
if (rif && rif->flush_display)
|
||
rif->flush_display (f);
|
||
}
|
||
|
||
/***********************************************************************
|
||
Multimonitor data
|
||
***********************************************************************/
|
||
|
||
#ifdef HAVE_WINDOW_SYSTEM
|
||
|
||
struct MonitorInfo {
|
||
Emacs_Rectangle geom, work;
|
||
int mm_width, mm_height;
|
||
char *name;
|
||
#ifdef HAVE_PGTK
|
||
double scale_factor;
|
||
#endif
|
||
};
|
||
|
||
extern void free_monitors (struct MonitorInfo *monitors, int n_monitors);
|
||
extern Lisp_Object make_monitor_attribute_list (struct MonitorInfo *monitors,
|
||
int n_monitors,
|
||
int primary_monitor,
|
||
Lisp_Object monitor_frames,
|
||
const char *source);
|
||
|
||
#endif /* HAVE_WINDOW_SYSTEM */
|
||
|
||
|
||
INLINE_HEADER_END
|
||
|
||
/* Suppress -Wsuggest-attribute=const if there are no scroll bars.
|
||
This is for functions like x_set_horizontal_scroll_bars that have
|
||
no effect in this case. */
|
||
#if ! USE_HORIZONTAL_SCROLL_BARS && GNUC_PREREQ (4, 6, 0)
|
||
# pragma GCC diagnostic ignored "-Wsuggest-attribute=const"
|
||
#endif
|
||
|
||
#endif /* not EMACS_FRAME_H */
|