File: ui_window.h

package info (click to toggle)
mlterm 3.9.4-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 25,340 kB
  • sloc: ansic: 154,713; sh: 5,302; cpp: 2,953; objc: 2,776; java: 2,472; makefile: 2,445; perl: 1,674; xml: 44
file content (482 lines) | stat: -rw-r--r-- 15,481 bytes parent folder | download
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
/* -*- c-basic-offset:2; tab-width:2; indent-tabs-mode:nil -*- */

#ifndef __UI_WINDOW_H__
#define __UI_WINDOW_H__

#include <pobl/bl_types.h>
#include <mef/ef_parser.h>

#include "ui_display.h"
#include "ui_font.h"
#include "ui_color.h"
#include "ui_gc.h"
#include "ui_bel_mode.h"

#define ACTUAL_WIDTH(win) ((win)->width + (win)->hmargin * 2)
#define ACTUAL_HEIGHT(win) ((win)->height + (win)->vmargin * 2)

/*
 * Don't use win->parent in xlib to check if win is root window or not
 * because mlterm can work as libvte.
 *   vte window
 *      |
 *   mlterm window ... ui_window_t::parent == NULL
 *                     ui_window_t::parent_window == vte window
 */
#define PARENT_WINDOWID_IS_TOP(win) ((win)->parent_window == (win)->disp->my_window)

/*
 * Hint for libvte (x11), in addition to bitmask hints (0x0-0x20) returned by
 * XParseGeometry().
 * (see ui_window_show(), Xutil.h)
 */
#define HINT_CHILD_WINDOW_ATTR 0x1000

typedef enum ui_resize_flag {
  NOTIFY_TO_NONE = 0x0,
  NOTIFY_TO_CHILDREN = 0x01,
  NOTIFY_TO_PARENT = 0x02,
  NOTIFY_TO_MYSELF = 0x04,

  LIMIT_RESIZE = 0x08,

} ui_resize_flag_t;

typedef enum ui_maximize_flag {
  MAXIMIZE_RESTORE = 0x0,
  MAXIMIZE_VERTICAL = 0x1,
  MAXIMIZE_HORIZONTAL = 0x2,
  MAXIMIZE_FULL = 0x3,

} ui_maximize_flag_t;

typedef enum ui_sizehint_flag {
  SIZEHINT_NONE = 0x0,
  SIZEHINT_WIDTH = 0x1,
  SIZEHINT_HEIGHT = 0x2,
} ui_sizehint_flag_t;

/* PRIMARY and CLIPBOARD are distinguished only in xlib/wayland. */
typedef enum ui_selection_flag {
  SEL_NONE = 0x0, /* Not own selection */
  SEL_PRIMARY = 0x1,
  SEL_CLIPBOARD = 0x2,
} ui_selection_flag_t;

typedef struct ui_xim_event_listener {
  void *self;

  int (*get_spot)(void *, int *, int *);
  XFontSet (*get_fontset)(void *);
  ui_color_t *(*get_fg_color)(void *);
  ui_color_t *(*get_bg_color)(void *);

} ui_xim_event_listener_t;

/* Defined in ui_xic.h */
typedef struct ui_xic *ui_xic_ptr_t;

/* Defined in ui_xim.h */
typedef struct ui_xim *ui_xim_ptr_t;

/* Defined in ui_dnd.h */
typedef struct ui_dnd_context *ui_dnd_context_ptr_t;

/* Defined in ui_picture.h */
typedef struct ui_picture_modifier *ui_picture_modifier_ptr_t;
typedef struct ui_icon_picture *ui_icon_picture_ptr_t;
typedef struct _XftDraw *xft_draw_ptr_t;
typedef struct _cairo *cairo_ptr_t;

typedef struct ui_window {
  ui_display_t *disp;

  Window my_window;

#ifdef USE_XLIB
  /*
   * Don't remove if USE_XFT and USE_CAIRO are not defined to keep the size of
   * ui_window_t
   * for ui_im_xxx_screen_t.
   */
  xft_draw_ptr_t xft_draw;
  cairo_ptr_t cairo_draw;
#endif

  ui_color_t fg_color;
  ui_color_t bg_color;

  ui_gc_t *gc;

  Window parent_window;     /* This member of root window is DefaultRootWindow */
  struct ui_window *parent; /* This member of root window is NULL */
  struct ui_window **children;
  u_int num_children;

  u_int cursor_shape;

  long event_mask;

  int x; /* relative to a root window. */
  int y; /* relative to a root window. */
  u_int width;
  u_int height;
  u_int min_width;
  u_int min_height;
  u_int width_inc;
  u_int height_inc;

  /* actual window size is +margin on north/south/east/west */
  u_int16_t hmargin;
  u_int16_t vmargin;

/*
 * mlterm-con doesn't use these members, but they are necessary to keep
 * the size of ui_window_t as the same as mlterm-fb for input method plugins.
 */
#ifdef MANAGE_SUB_WINDOWS_BY_MYSELF
  u_int clip_y;
  u_int clip_height;
#endif

  /* used by ui_xim */
  ui_xim_ptr_t xim;
  ui_xim_event_listener_t *xim_listener;
  ui_xic_ptr_t xic; /* Only root window manages xic in win32 */

#if defined(USE_WIN32GUI)
  WORD update_window_flag;
  int cmd_show;
#elif defined(USE_QUARTZ) || defined(USE_BEOS)
  int update_window_flag;
#endif

  /* button */
  Time prev_clicked_time;
  int prev_clicked_button;
  XButtonEvent prev_button_press_event;

  ui_picture_modifier_ptr_t pic_mod;

  /*
   * XDND
   */
  /*
   * Don't remove if DISABLE_XDND is defined to keep the size of ui_window_t for
   * ui_im_xxx_screen_t.
   */
  ui_dnd_context_ptr_t dnd;

  /*
   * XClassHint
   */
  char *app_name;

/*
 * flags etc.
 */

#ifdef USE_XLIB
  char *wm_role;
  int8_t wall_picture_is_set;     /* Actually set picture (including transparency)
                                     or not. */
  int8_t wait_copy_area_response; /* Used for XCopyArea() */
  int8_t configure_root;
#else
  Pixmap wall_picture;
#endif
#ifdef USE_WIN32GUI
  int8_t is_sel_owner;
#endif
  int8_t is_transparent;
  int8_t is_scrollable;
  int8_t is_focused;
  int8_t inputtable; /* 1: focused, -1: unfocused */
  int8_t is_mapped;
#ifdef __ANDROID__
  int8_t saved_mapped;
#endif
  int8_t create_gc;

  /* button */
  int8_t button_is_pressing;
  int8_t click_num;

  u_int8_t sizehint_flag;

  void (*window_realized)(struct ui_window *);
  void (*window_finalized)(struct ui_window *);
  void (*window_destroyed)(struct ui_window *);
  void (*mapping_notify)(struct ui_window *);
  /* Win32: gc->gc is not None. */
  void (*window_exposed)(struct ui_window *, int, int, u_int, u_int);
  /* Win32: gc->gc is not None. */
  void (*update_window)(struct ui_window *, int);
  void (*window_focused)(struct ui_window *);
  void (*window_unfocused)(struct ui_window *);
  void (*key_pressed)(struct ui_window *, XKeyEvent *);
  void (*pointer_motion)(struct ui_window *, XMotionEvent *);
  void (*button_motion)(struct ui_window *, XMotionEvent *);
  void (*button_released)(struct ui_window *, XButtonEvent *);
  void (*button_pressed)(struct ui_window *, XButtonEvent *, int);
  void (*button_press_continued)(struct ui_window *, XButtonEvent *);
  void (*window_resized)(struct ui_window *);
  void (*child_window_resized)(struct ui_window *, struct ui_window *);
  void (*selection_cleared)(struct ui_window *);
  void (*xct_selection_requested)(struct ui_window *, XSelectionRequestEvent *, Atom);
  void (*utf_selection_requested)(struct ui_window *, XSelectionRequestEvent *, Atom);
  void (*xct_selection_notified)(struct ui_window *, u_char *, size_t);
  void (*utf_selection_notified)(struct ui_window *, u_char *, size_t);
  /*
   * Don't remove if DISABLE_XDND is defined to keep the size of ui_window_t
   * for ui_im_xxx_screen_t.
   */
  void (*set_xdnd_config)(struct ui_window *, const char *, const char *, const char *);
  void (*idling)(struct ui_window *);
#ifdef UIWINDOW_SUPPORTS_PREEDITING
  void (*preedit)(struct ui_window *, const char *, const char *);
#endif

} ui_window_t;

int ui_window_init(ui_window_t *win, u_int width, u_int height, u_int min_width, u_int min_height,
                   u_int width_inc, u_int height_inc, u_int hmargin, u_int vmargin, int create_gc,
                   int inputtable);

void ui_window_final(ui_window_t *win);

void ui_window_set_type_engine(ui_window_t *win, ui_type_engine_t type_engine);

void ui_window_add_event_mask(ui_window_t *win, long event_mask);

void ui_window_remove_event_mask(ui_window_t *win, long event_mask);

#define ui_window_check_event_mask(win, mask) ((win)->event_mask & (mask))

/* int  ui_window_grab_pointer( ui_window_t *  win) ; */

void ui_window_ungrab_pointer(ui_window_t *win);

int ui_window_set_wall_picture(ui_window_t *win, Pixmap pic, int do_expose);

int ui_window_unset_wall_picture(ui_window_t *win, int do_expose);

#ifdef USE_XLIB
#define ui_window_has_wall_picture(win) ((win)->wall_picture_is_set)
#else
#define ui_window_has_wall_picture(win) ((win)->wall_picture != None)
#endif

int ui_window_set_transparent(ui_window_t *win, ui_picture_modifier_ptr_t pic_mod);

int ui_window_unset_transparent(ui_window_t *win);

void ui_window_set_cursor(ui_window_t *win, u_int cursor_shape);

int ui_window_set_fg_color(ui_window_t *win, ui_color_t *fg_color);

int ui_window_set_bg_color(ui_window_t *win, ui_color_t *bg_color);

int ui_window_add_child(ui_window_t *win, ui_window_t *child, int x, int y, int map);

int ui_window_remove_child(ui_window_t *win, ui_window_t *child);

ui_window_t *ui_get_root_window(ui_window_t *win);

GC ui_window_get_fg_gc(ui_window_t *win);

GC ui_window_get_bg_gc(ui_window_t *win);

int ui_window_show(ui_window_t *win, int hint);

void ui_window_map(ui_window_t *win);

void ui_window_unmap(ui_window_t *win);

int ui_window_resize(ui_window_t *win, u_int width, u_int height, ui_resize_flag_t flag);

int ui_window_resize_with_margin(ui_window_t *win, u_int width, u_int height,
                                 ui_resize_flag_t flag);

void ui_window_set_maximize_flag(ui_window_t *win, ui_maximize_flag_t flag);

void ui_window_set_normal_hints(ui_window_t *win, u_int min_width, u_int min_height,
                                u_int width_inc, u_int height_inc);

void ui_window_set_override_redirect(ui_window_t *win, int flag);

int ui_window_set_borderless_flag(ui_window_t *win, int flag);

int ui_window_move(ui_window_t *win, int x, int y);

void ui_window_clear(ui_window_t *win, int x, int y, u_int width, u_int height);

void ui_window_clear_all(ui_window_t *win);

void ui_window_fill(ui_window_t *win, int x, int y, u_int width, u_int height);

void ui_window_fill_with(ui_window_t *win, ui_color_t *color, int x, int y, u_int width,
                        u_int height);

void ui_window_blank(ui_window_t *win);

#if 0
/* Not used */
void ui_window_blank_with(ui_window_t *win, ui_color_t *color);
#endif

/* if flag is 0, no update. */
void ui_window_update(ui_window_t *win, int flag);

void ui_window_update_all(ui_window_t *win);

void ui_window_idling(ui_window_t *win);

int ui_window_receive_event(ui_window_t *win, XEvent *event);

size_t ui_window_get_str(ui_window_t *win, u_char *seq, size_t seq_len, ef_parser_t **parser,
                         KeySym *keysym, XKeyEvent *event);

#ifdef MANAGE_ROOT_WINDOWS_BY_MYSELF
int ui_window_is_scrollable(ui_window_t *win);
#else
#define ui_window_is_scrollable(win) ((win)->is_scrollable)
#endif

int ui_window_scroll_upward(ui_window_t *win, u_int height);

int ui_window_scroll_upward_region(ui_window_t *win, int boundary_start, int boundary_end,
                                   u_int height);

int ui_window_scroll_downward(ui_window_t *win, u_int height);

int ui_window_scroll_downward_region(ui_window_t *win, int boundary_start, int boundary_end,
                                     u_int height);

int ui_window_scroll_leftward(ui_window_t *win, u_int width);

int ui_window_scroll_leftward_region(ui_window_t *win, int boundary_start, int boundary_end,
                                     u_int width);

int ui_window_scroll_rightward_region(ui_window_t *win, int boundary_start, int boundary_end,
                                      u_int width);

int ui_window_scroll_rightward(ui_window_t *win, u_int width);

int ui_window_copy_area(ui_window_t *win, Pixmap src, PixmapMask mask, int src_x, int src_y,
                        u_int width, u_int height, int dst_x, int dst_y);

void ui_window_set_clip(ui_window_t *win, int x, int y, u_int width, u_int height);

void ui_window_unset_clip(ui_window_t *win);

void ui_window_draw_decsp_string(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color, int x,
                                 int y, u_char *str, u_int len);

void ui_window_draw_decsp_image_string(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color,
                                       ui_color_t *bg_color, int x, int y, u_char *str, u_int len);

/*
 * ui_window_draw_*_string functions are used by ui_draw_str.[ch].
 * Use ui_draw_str* functions usually.
 */

#if !defined(NO_DYNAMIC_LOAD_TYPE) || defined(USE_TYPE_XCORE)
void ui_window_draw_string(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color, int x, int y,
                           u_char *str, u_int len);

void ui_window_draw_string16(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color, int x, int y,
                             XChar2b *str, u_int len);

void ui_window_draw_image_string(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color,
                                 ui_color_t *bg_color, int x, int y, u_char *str, u_int len);

void ui_window_draw_image_string16(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color,
                                   ui_color_t *bg_color, int x, int y, XChar2b *str, u_int len);
#endif

#ifdef USE_CONSOLE
void ui_window_console_draw_decsp_string(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color,
                                         ui_color_t *bg_color, int x, int y, u_char *str, u_int len,
                                         int line_style);

void ui_window_console_draw_string(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color,
                                   ui_color_t *bg_color, int x, int y, u_char *str, u_int len,
                                   int line_style);

void ui_window_console_draw_string16(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color,
                                     ui_color_t *bg_color, int x, int y, XChar2b *str, u_int len,
                                     int line_style);
#endif

#if !defined(NO_DYNAMIC_LOAD_TYPE) || defined(USE_TYPE_XFT) || defined(USE_TYPE_CAIRO)
void ui_window_ft_draw_string8(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color, int x,
                               int y, u_char *str, size_t len);

void ui_window_ft_draw_string32(ui_window_t *win, ui_font_t *font, ui_color_t *fg_color, int x,
                                int y, /* FcChar32 */ u_int32_t *str, u_int len);
#endif

void ui_window_draw_rect_frame(ui_window_t *win, int x1, int y1, int x2, int y2);

int ui_window_set_selection_owner(ui_window_t *win, Time time, ui_selection_flag_t selection);

#if defined(USE_XLIB) || defined(USE_WAYLAND)
#define ui_window_is_selection_owner(win, selection) \
  ((selection) == SEL_CLIPBOARD ? (win) == (win)->disp->clipboard_owner : \
                               (win) == (win)->disp->selection_owner)
#else
#define ui_window_is_selection_owner(win, selection) \
  ((win) == (win)->disp->selection_owner)
#endif

int ui_window_xct_selection_request(ui_window_t *win, Time time, ui_selection_flag_t selection);

int ui_window_utf_selection_request(ui_window_t *win, Time time, ui_selection_flag_t selection);

void ui_window_send_picture_selection(ui_window_t *win, Pixmap pixmap, u_int width, u_int height);

void ui_window_send_text_selection(ui_window_t *win, XSelectionRequestEvent *event,
                                   u_char *sel_data, size_t sel_len, Atom sel_type);

void ui_set_window_name(ui_window_t *win, u_char *name);

void ui_set_icon_name(ui_window_t *win, u_char *name);

void ui_window_set_icon(ui_window_t *win, ui_icon_picture_ptr_t icon);

void ui_window_remove_icon(ui_window_t *win);

void ui_set_click_interval(int interval);

int ui_get_click_interval(void);

#define ui_window_get_modifier_mapping(win) ui_display_get_modifier_mapping((win)->disp)

u_int ui_window_get_mod_ignore_mask(ui_window_t *win, KeySym *keysyms);

u_int ui_window_get_mod_meta_mask(ui_window_t *win, char *mod_key);

#ifdef SUPPORT_URGENT_BELL
void ui_set_use_urgent_bell(int use);
#else
#define ui_set_use_urgent_bell(use) (0)
#endif

void ui_window_bell(ui_window_t *win, ui_bel_mode_t mode);

void ui_window_translate_coordinates(ui_window_t *win, int x, int y, int *global_x, int *global_y);

void ui_window_set_input_focus(ui_window_t *win);

#ifdef USE_XLIB
void ui_window_flush(ui_window_t *win);
#else
#define ui_window_flush(win) (0)
#endif

#ifdef DEBUG
void ui_window_dump_children(ui_window_t *win);
#endif

#endif