use the <wmclass> for startup notfication in the execute action. when present don...
[mikachu/openbox.git] / openbox / startupnotify.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    startupnotify.c for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #include "startupnotify.h"
21 #include "gettext.h"
22 #include "event.h"
23
24 #include <stdlib.h>
25
26 #ifndef USE_LIBSN
27
28 void sn_startup(gboolean reconfig) {}
29 void sn_shutdown(gboolean reconfig) {}
30 gboolean sn_app_starting() { return FALSE; }
31 Time sn_app_started(const gchar *id, const gchar *wmclass, const gchar *name)
32 {
33     return CurrentTime;
34 }
35 gboolean sn_get_desktop(gchar *id, guint *desktop) { return FALSE; }
36 void sn_setup_spawn_environment(const gchar *program, const gchar *name,
37                                 const gchar *icon_name, const gchar *wmclass,
38                                 gint desktop) {}
39 void sn_spawn_cancel() {}
40
41 #else
42
43 #include "openbox.h"
44 #include "mainloop.h"
45 #include "screen.h"
46
47 #define SN_API_NOT_YET_FROZEN
48 #include <libsn/sn.h>
49
50 static SnDisplay *sn_display;
51 static SnMonitorContext *sn_context;
52 static SnLauncherContext *sn_launcher;
53 static GSList *sn_waits; /* list of SnStartupSequences we're waiting on */
54
55 static SnStartupSequence* sequence_find(const gchar *id);
56
57 static void sn_handler(const XEvent *e, gpointer data);
58 static void sn_event_func(SnMonitorEvent *event, gpointer data);
59
60 void sn_startup(gboolean reconfig)
61 {
62     if (reconfig) return;
63
64     sn_display = sn_display_new(ob_display, NULL, NULL);
65     sn_context = sn_monitor_context_new(sn_display, ob_screen,
66                                         sn_event_func, NULL, NULL);
67     sn_launcher = sn_launcher_context_new(sn_display, ob_screen);
68
69     ob_main_loop_x_add(ob_main_loop, sn_handler, NULL, NULL);
70 }
71
72 void sn_shutdown(gboolean reconfig)
73 {
74     GSList *it;
75
76     if (reconfig) return;
77
78     ob_main_loop_x_remove(ob_main_loop, sn_handler);
79
80     for (it = sn_waits; it; it = g_slist_next(it))
81         sn_startup_sequence_unref((SnStartupSequence*)it->data);
82     g_slist_free(sn_waits);
83     sn_waits = NULL;
84
85     screen_set_root_cursor();
86
87     sn_launcher_context_unref(sn_launcher);
88     sn_monitor_context_unref(sn_context);
89     sn_display_unref(sn_display);
90 }
91
92 static SnStartupSequence* sequence_find(const gchar *id)
93 {
94     SnStartupSequence*ret = NULL;
95     GSList *it;
96
97     for (it = sn_waits; it; it = g_slist_next(it)) {
98         SnStartupSequence *seq = it->data;
99         if (!strcmp(id, sn_startup_sequence_get_id(seq))) {
100             ret = seq;
101             break;
102         }
103     }
104     return ret;
105 }
106
107 gboolean sn_app_starting(void)
108 {
109     return sn_waits != NULL;
110 }
111
112 static gboolean sn_wait_timeout(gpointer data)
113 {
114     SnStartupSequence *seq = data;
115     sn_waits = g_slist_remove(sn_waits, seq);
116     screen_set_root_cursor();
117     return FALSE; /* don't repeat */
118 }
119
120 static void sn_handler(const XEvent *e, gpointer data)
121 {
122     XEvent ec;
123     ec = *e;
124     sn_display_process_event(sn_display, &ec);
125 }
126
127 static void sn_event_func(SnMonitorEvent *ev, gpointer data)
128 {
129     SnStartupSequence *seq;
130     gboolean change = FALSE;
131
132     if (!(seq = sn_monitor_event_get_startup_sequence(ev)))
133         return;
134
135     switch (sn_monitor_event_get_type(ev)) {
136     case SN_MONITOR_EVENT_INITIATED:
137         sn_startup_sequence_ref(seq);
138         sn_waits = g_slist_prepend(sn_waits, seq);
139         /* 20 second timeout for apps to start if the launcher doesn't
140            have a timeout */
141         ob_main_loop_timeout_add(ob_main_loop, 20 * G_USEC_PER_SEC,
142                                  sn_wait_timeout, seq,
143                                  g_direct_equal,
144                                  (GDestroyNotify)sn_startup_sequence_unref);
145         change = TRUE;
146         break;
147     case SN_MONITOR_EVENT_CHANGED:
148         /* XXX feedback changed? */
149         change = TRUE;
150         break;
151     case SN_MONITOR_EVENT_COMPLETED:
152     case SN_MONITOR_EVENT_CANCELED:
153         if ((seq = sequence_find(sn_startup_sequence_get_id(seq)))) {
154             sn_waits = g_slist_remove(sn_waits, seq);
155             ob_main_loop_timeout_remove_data(ob_main_loop, sn_wait_timeout,
156                                              seq, FALSE);
157             change = TRUE;
158         }
159         break;
160     };
161
162     if (change)
163         screen_set_root_cursor();
164 }
165
166 Time sn_app_started(const gchar *id, const gchar *wmclass, const gchar *name)
167 {
168     GSList *it;
169     Time t = CurrentTime;
170
171     if (!id && !wmclass)
172         return t;
173
174     for (it = sn_waits; it; it = g_slist_next(it)) {
175         SnStartupSequence *seq = it->data;
176         gboolean found = FALSE;
177         const gchar *seqid, *seqclass, *seqbin;
178         seqid = sn_startup_sequence_get_id(seq);
179         seqclass = sn_startup_sequence_get_wmclass(seq);
180         seqbin = sn_startup_sequence_get_binary_name(seq);
181
182         if (id && seqid) {
183             /* if the app has a startup id, then look for that for highest
184                accuracy */
185             if (!strcmp(seqid, id))
186                 found = TRUE;
187         }
188         else if (seqclass) {
189             /* seqclass = "a string to match against the "resource name" or
190                "resource class" hints.  These are WM_CLASS[0] and WM_CLASS[1]"
191                - from the startup-notification spec
192             */
193             found = (seqclass && !strcmp(seqclass, wmclass)) ||
194                 (seqclass && !strcmp(seqclass, name));
195         }
196         else if (seqbin) {
197             /* Check the binary name against the class and name hints
198                as well, to help apps that don't have the class set
199                correctly */
200             found = (seqbin && !g_ascii_strcasecmp(seqbin, wmclass)) ||
201                 (seqbin && !g_ascii_strcasecmp(seqbin, name));
202         }
203
204         if (found) {
205             sn_startup_sequence_complete(seq);
206             t = sn_startup_sequence_get_timestamp(seq);
207             break;
208         }
209     }
210     return t;
211 }
212
213 gboolean sn_get_desktop(gchar *id, guint *desktop)
214 {
215     SnStartupSequence *seq;
216
217     if (id && (seq = sequence_find(id))) {
218         gint desk = sn_startup_sequence_get_workspace(seq);
219         if (desk != -1) {
220             *desktop = desk;
221             return TRUE;
222         }
223     }
224     return FALSE;
225 }
226
227 static gboolean sn_launch_wait_timeout(gpointer data)
228 {
229     SnLauncherContext *sn = data;
230     sn_launcher_context_complete(sn);
231     return FALSE; /* don't repeat */
232 }
233
234 void sn_setup_spawn_environment(const gchar *program, const gchar *name,
235                                 const gchar *icon_name, const gchar *wmclass,
236                                 gint desktop)
237 {
238     gchar *desc;
239     const char *id;
240
241     desc = g_strdup_printf(_("Running %s\n"), program);
242
243     if (sn_launcher_context_get_initiated(sn_launcher)) {
244         sn_launcher_context_unref(sn_launcher);
245         sn_launcher = sn_launcher_context_new(sn_display, ob_screen);
246     }
247
248     sn_launcher_context_set_name(sn_launcher, name ? name : program);
249     sn_launcher_context_set_description(sn_launcher, desc);
250     sn_launcher_context_set_icon_name(sn_launcher, icon_name ?
251                                       icon_name : program);
252     sn_launcher_context_set_binary_name(sn_launcher, program);
253     if (wmclass) sn_launcher_context_set_wmclass(sn_launcher, wmclass);
254     if (desktop >= 0 && (unsigned) desktop < screen_num_desktops)
255         sn_launcher_context_set_workspace(sn_launcher, (signed) desktop);
256     sn_launcher_context_initiate(sn_launcher, "openbox", program,
257                                  event_curtime);
258     id = sn_launcher_context_get_startup_id(sn_launcher);
259
260     /* 20 second timeout for apps to start */
261     sn_launcher_context_ref(sn_launcher);
262     ob_main_loop_timeout_add(ob_main_loop, 20 * G_USEC_PER_SEC,
263                              sn_launch_wait_timeout, sn_launcher,
264                              g_direct_equal,
265                              (GDestroyNotify)sn_launcher_context_unref);
266
267     putenv(g_strdup_printf("DESKTOP_STARTUP_ID=%s", id));
268
269     g_free(desc);
270 }
271
272 void sn_spawn_cancel(void)
273 {
274     sn_launcher_context_complete(sn_launcher);
275 }
276
277 #endif