mirrored from git://git.sv.gnu.org/emacs.git
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
frame.h
1943 lines (1592 loc) · 63.1 KB
/
frame.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Define frame-object for GNU Emacs.
Copyright (C) 1993-1994, 1999-2023 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;
/* 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. */