-
Notifications
You must be signed in to change notification settings - Fork 0
/
tooltip.c
339 lines (300 loc) · 8.99 KB
/
tooltip.c
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
///
/// @file tooltip.c @brief tooltip functions.
///
/// Copyright (c) 2009 - 2011, 2021 by Lutz Sammer. All Rights Reserved.
///
/// Contributor(s):
///
/// License: AGPLv3
///
/// This program is free software: you can redistribute it and/or modify
/// it under the terms of the GNU Affero General Public License as
/// published by the Free Software Foundation, either version 3 of the
/// License.
///
/// This program 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 Affero General Public License for more details.
///
/// $Id$
//////////////////////////////////////////////////////////////////////////////
///
/// @ingroup draw
/// @defgroup tooltip The tooltip module.
///
/// This module contains the tooltip functions.
///
/// Uses:
/// #TOOLTIP_DEFAULT_DELAY from config section
/// #TOOLTIP_MAXIMAL_MOVE from config section
///
///< @{
#include <xcb/xcb.h>
#include "uwm.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <xcb/xcb_aux.h>
#include "core-array/core-array.h"
#include "core-rc/core-rc.h"
#include "misc.h"
#include "draw.h"
#include "tooltip.h"
#include "screen.h"
//////////////////////////////////////////////////////////////////////////////
/**
** Tooltip structure.
*/
typedef struct _tooltip_
{
unsigned Active:1; ///< flag tooltip is shown
//unsigned Timeout:1; ///< flag tooltip shown timeout
int16_t X; ///< x-coordinate of tooltip window
int16_t Y; ///< y-coordinate of tooltip window
uint16_t Width; ///< tooltip window width
uint16_t Height; ///< tooltip window height
int16_t MouseX; ///< mouse x-coordinate as created
int16_t MouseY; ///< mouse x-coordinate as created
char *Text; ///< tooltip text
xcb_window_t Window; ///< tooltip X11 window
uint16_t LastX; ///< last mouse x-coordinate
uint16_t LastY; ///< last mouse y-coordinate
uint32_t LastTick; ///< last tooltip tick
void (*DrawTooltip)(int, int); ///< tooltip callback to draw text
} Tooltip;
static Tooltip TooltipVars[1]; ///< current tooltip data
/// tooltip delay in milliseconds
int TooltipDelay;
static int TooltipEnabled; ///< flag tooltips are enabled
//////////////////////////////////////////////////////////////////////////////
/**
** Register tooltip draw callback.
**
** @param x current mouse x-coordinate
** @param y current mouse y-coordinate
** @param draw function called to draw tooltip
*/
void TooltipRegister(int x, int y, void (*draw)(int, int))
{
TooltipVars->LastX = x;
TooltipVars->LastY = y;
TooltipVars->LastTick = GetMsTicks();
TooltipVars->DrawTooltip = draw;
}
/**
** Draw the tooltip window.
*/
static void TooltipDraw(void)
{
xcb_aux_clear_window(Connection, TooltipVars->Window);
FontDrawString(TooltipVars->Window, &Fonts.Tooltip, Colors.TooltipFG.Pixel,
4, 1, TooltipVars->Width, NULL, TooltipVars->Text);
}
/**
** Show tooltip window.
**
** @param x x-coordinate of the tooltip window
** @param y y-coordinate of the tooltip window
** @param text text to display in the tooltip
**
** @todo check if same tooltip is redawn.
** support multiline tooltips.
*/
void TooltipShow(int x, int y, const char *text)
{
xcb_query_text_extents_cookie_t cookie;
int len;
const Screen *screen;
unsigned width;
uint32_t values[5];
if (!TooltipEnabled) {
return;
}
// FIXME: see above, same text again?
free(TooltipVars->Text);
TooltipVars->Text = NULL;
if (!text || !(len = strlen(text))) { // none or empty string
return;
}
cookie = FontQueryExtentsRequest(&Fonts.Tooltip, len, text);
screen = ScreenGetByXY(x, y);
TooltipVars->Text = strdup(text);
TooltipVars->Height = Fonts.Tooltip.Height;
width = FontTextWidthReply(cookie);
TooltipVars->Width = width;
TooltipVars->Height += 2;
TooltipVars->Width += 9;
if (TooltipVars->Width > screen->Width) {
TooltipVars->Width = screen->Width;
// FIXME: make multiline tooltip
}
TooltipVars->X = x;
TooltipVars->Y = y - TooltipVars->Height - 2;
// make sure tooltip is shown as much as possible
if (TooltipVars->X + TooltipVars->Width >= screen->X + screen->Width) {
TooltipVars->X = screen->X + screen->Width - TooltipVars->Width - 2;
}
if (TooltipVars->Y < screen->Y) {
TooltipVars->Y = y + 2;
}
if (TooltipVars->Y + TooltipVars->Height >= screen->Y + screen->Height) {
TooltipVars->Y = screen->Y + screen->Height - TooltipVars->Height - 2;
}
if (TooltipVars->Window) { // move and resize the window
values[0] = TooltipVars->X;
values[1] = TooltipVars->Y;
values[2] = TooltipVars->Width;
values[3] = TooltipVars->Height;
xcb_configure_window(Connection, TooltipVars->Window,
XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y | XCB_CONFIG_WINDOW_WIDTH
| XCB_CONFIG_WINDOW_HEIGHT, values);
} else { // create new window
TooltipVars->Window = xcb_generate_id(Connection);
values[0] = Colors.TooltipBG.Pixel;
values[1] = Colors.TooltipOutline.Pixel;
values[2] = 1;
values[3] =
XCB_EVENT_MASK_POINTER_MOTION | XCB_EVENT_MASK_POINTER_MOTION_HINT
| XCB_EVENT_MASK_EXPOSURE;
values[4] =
XCB_EVENT_MASK_POINTER_MOTION | XCB_EVENT_MASK_BUTTON_PRESS |
XCB_EVENT_MASK_BUTTON_RELEASE;
xcb_create_window(Connection, XCB_COPY_FROM_PARENT,
TooltipVars->Window, XcbScreen->root, TooltipVars->X,
TooltipVars->Y, TooltipVars->Width, TooltipVars->Height, 1,
XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_COPY_FROM_PARENT,
XCB_CW_BACK_PIXEL | XCB_CW_BORDER_PIXEL | XCB_CW_SAVE_UNDER |
XCB_CW_EVENT_MASK | XCB_CW_DONT_PROPAGATE, values);
}
TooltipVars->MouseX = x;
TooltipVars->MouseY = y;
if (TooltipVars->Active) {
TooltipDraw();
} else {
// raise window
values[0] = XCB_STACK_MODE_ABOVE;
xcb_configure_window(Connection, TooltipVars->Window,
XCB_CONFIG_WINDOW_STACK_MODE, values);
// map window on the screen
xcb_map_window(Connection, TooltipVars->Window);
TooltipVars->Active = 1;
// FIXME: tooltip isn't shown, only empty window!
Debug(3, "tooltip %x mapped, should get expose next\n",
TooltipVars->Window);
}
}
/**
** Hide tooltip.
*/
void TooltipHide(void)
{
if (TooltipVars->Active) {
xcb_unmap_window(Connection, TooltipVars->Window);
TooltipVars->Active = 0;
}
}
/**
** Handle an expose event on tooltip window.
**
** @param event X11 expose event
**
** @returns true if the event was for the tooltip module, 0 otherwise.
**
** @note multiple exposes are already handled by main event handler.
*/
int TooltipHandleExpose(const xcb_expose_event_t * event)
{
Debug(3, "tooltip %d vs %d\n", event->window, TooltipVars->Window);
if (TooltipVars->Active && event->window == TooltipVars->Window) {
TooltipDraw();
return 1;
}
return 0;
}
/**
** Timeout tooltip (this is used to hide tooltips after movement).
**
** @param tick current tick in ms
** @param x current mouse x-coordinate
** @param y current mouse y-coordinate
*/
void TooltipTimeout(uint32_t tick, int x, int y)
{
if (TooltipVars->Active
&& (abs(TooltipVars->MouseX - x) > TOOLTIP_MAXIMAL_MOVE
|| abs(TooltipVars->MouseY - y) > TOOLTIP_MAXIMAL_MOVE)) {
Debug(3, "tooltip moved unmap\n");
TooltipHide();
}
//
// Check if mouse stayed long enough on same place, to show tooltip
// The tooltip is redrawn in TooltipDelay intervals
//
if (TooltipVars->DrawTooltip
&& abs(TooltipVars->LastX - x) < TOOLTIP_MAXIMAL_MOVE
&& abs(TooltipVars->LastY - y) < TOOLTIP_MAXIMAL_MOVE
&& tick >= TooltipVars->LastTick + TooltipDelay) {
// call draw tooltip callback
TooltipVars->DrawTooltip(x, y);
}
}
#if 0
/**
** Handle an motion notify event on tooltip window.
**
** @param event X11 motion notify event
**
** @returns true if the event was for the tooltip module, 0 otherwise.
*/
int TooltipHandleMotionNotify(const xcb_motion_notify_event_t * event)
{
if (TooltipVars->Active && event->window == TooltipVars->Window) {
xcb_unmap_window(Connection, TooltipVars->Window);
TooltipVars->Active = 0;
return 1;
}
return 0;
}
#endif
/**
** Cleanup tooltips.
*/
void TooltipExit(void)
{
free(TooltipVars->Text);
TooltipVars->Text = NULL;
if (TooltipVars->Window) {
xcb_destroy_window(Connection, TooltipVars->Window);
TooltipVars->Window = XCB_NONE;
}
}
// ------------------------------------------------------------------------ //
// Config
#ifdef USE_RC // {
/**
** Get tooltip configuration.
**
** @param config global config dictionary
*/
void TooltipConfig(const Config * config)
{
ssize_t ival;
int i;
TooltipDelay = TOOLTIP_DEFAULT_DELAY;
if (ConfigStringsGetInteger(ConfigDict(config), &ival, "tooltip", "delay",
NULL)) {
if (ival < 0) {
Warning("invalid tooltip delay specified: %zd\n", ival);
} else {
TooltipDelay = ival;
}
}
TooltipEnabled = 1;
if ((i = ConfigStringsGetBoolean(ConfigDict(config), "tooltip", "enabled",
NULL)) >= 0) {
TooltipEnabled = i;
}
}
#endif // } USE_RC
/// @}