source: util.c @ 96828e4

release-1.8release-1.9
Last change on this file since 96828e4 was 96828e4, checked in by Anders Kaseorg <andersk@mit.edu>, 11 years ago
Replace owl_malloc with g_new and g_new0. Signed-off-by: Anders Kaseorg <andersk@mit.edu> Reviewed-by: Karl Ramm <kcr@mit.edu>
  • Property mode set to 100644
File size: 20.3 KB
Line 
1#include "owl.h"
2#include <stdlib.h>
3#include <string.h>
4#include <unistd.h>
5#include <ctype.h>
6#include <pwd.h>
7#include <sys/stat.h>
8#include <sys/types.h>
9#include <assert.h>
10#include <stdarg.h>
11#include <glib.h>
12#include <glib/gstdio.h>
13#include <glib-object.h>
14
15const char *skiptokens(const char *buff, int n) {
16  /* skips n tokens and returns where that would be. */
17  char quote = 0;
18  while (*buff && n>0) {
19      while (*buff == ' ') buff++;
20      while (*buff && (quote || *buff != ' ')) {
21        if(quote) {
22          if(*buff == quote) quote = 0;
23        } else if(*buff == '"' || *buff == '\'') {
24          quote = *buff;
25        }
26        buff++;
27      }
28      while (*buff == ' ') buff++;
29      n--;
30  }
31  return buff;
32}
33
34/* Return a "nice" version of the path.  Tilde expansion is done, and
35 * duplicate slashes are removed.  Caller must free the return.
36 */
37char *owl_util_makepath(const char *in)
38{
39  int i, j, x;
40  char *out, user[MAXPATHLEN];
41  struct passwd *pw;
42
43  out=g_new(char, MAXPATHLEN+1);
44  out[0]='\0';
45  j=strlen(in);
46  x=0;
47  for (i=0; i<j; i++) {
48    if (in[i]=='~') {
49      if ( (i==(j-1)) ||          /* last character */
50           (in[i+1]=='/') ) {     /* ~/ */
51        /* use my homedir */
52        pw=getpwuid(getuid());
53        if (!pw) {
54          out[x]=in[i];
55        } else {
56          out[x]='\0';
57          strcat(out, pw->pw_dir);
58          x+=strlen(pw->pw_dir);
59        }
60      } else {
61        /* another user homedir */
62        int a, b;
63        b=0;
64        for (a=i+1; i<j; a++) {
65          if (in[a]==' ' || in[a]=='/') {
66            break;
67          } else {
68            user[b]=in[a];
69            i++;
70            b++;
71          }
72        }
73        user[b]='\0';
74        pw=getpwnam(user);
75        if (!pw) {
76          out[x]=in[i];
77        } else {
78          out[x]='\0';
79          strcat(out, pw->pw_dir);
80          x+=strlen(pw->pw_dir);
81        }
82      }
83    } else if (in[i]=='/') {
84      /* check for a double / */
85      if (i<(j-1) && (in[i+1]=='/')) {
86        /* do nothing */
87      } else {
88        out[x]=in[i];
89        x++;
90      }
91    } else {
92      out[x]=in[i];
93      x++;
94    }
95  }
96  out[x]='\0';
97  return(out);
98}
99
100void owl_parse_delete(char **argv, int argc)
101{
102  g_strfreev(argv);
103}
104
105char **owl_parseline(const char *line, int *argc)
106{
107  /* break a command line up into argv, argc.  The caller must free
108     the returned values.  If there is an error argc will be set to
109     -1, argv will be NULL and the caller does not need to free
110     anything. The returned vector is NULL-terminated. */
111
112  GPtrArray *argv;
113  int i, len, between=1;
114  GString *curarg;
115  char quote;
116
117  argv = g_ptr_array_new();
118  len=strlen(line);
119  curarg = g_string_new("");
120  quote='\0';
121  *argc=0;
122  for (i=0; i<len+1; i++) {
123    /* find the first real character */
124    if (between) {
125      if (line[i]==' ' || line[i]=='\t' || line[i]=='\0') {
126        continue;
127      } else {
128        between=0;
129        i--;
130        continue;
131      }
132    }
133
134    /* deal with a quote character */
135    if (line[i]=='"' || line[i]=="'"[0]) {
136      /* if this type of quote is open, close it */
137      if (quote==line[i]) {
138        quote='\0';
139        continue;
140      }
141
142      /* if no quoting is open then open with this */
143      if (quote=='\0') {
144        quote=line[i];
145        continue;
146      }
147
148      /* if another type of quote is open then treat this as a literal */
149      g_string_append_c(curarg, line[i]);
150      continue;
151    }
152
153    /* if it's not a space or end of command, then use it */
154    if (line[i]!=' ' && line[i]!='\t' && line[i]!='\n' && line[i]!='\0') {
155      g_string_append_c(curarg, line[i]);
156      continue;
157    }
158
159    /* otherwise, if we're not in quotes, add the whole argument */
160    if (quote=='\0') {
161      /* add the argument */
162      g_ptr_array_add(argv, g_string_free(curarg, false));
163      curarg = g_string_new("");
164      between=1;
165      continue;
166    }
167
168    /* if it is a space and we're in quotes, then use it */
169    g_string_append_c(curarg, line[i]);
170  }
171
172  *argc = argv->len;
173  g_ptr_array_add(argv, NULL);
174  g_string_free(curarg, true);
175
176  /* check for unbalanced quotes */
177  if (quote!='\0') {
178    /* TODO: when we move to requiring glib 2.22+, use
179     * g_ptr_array_new_with_free_func. */
180    g_ptr_array_foreach(argv, (GFunc)owl_free, NULL);
181    g_ptr_array_free(argv, true);
182    *argc = -1;
183    return(NULL);
184  }
185
186  return (char**)g_ptr_array_free(argv, false);
187}
188
189/* Appends a quoted version of arg suitable for placing in a
190 * command-line to a GString. Does not append a space. */
191void owl_string_append_quoted_arg(GString *buf, const char *arg)
192{
193  const char *argp;
194  if (arg[0] == '\0') {
195    /* Quote the empty string. */
196    g_string_append(buf, "''");
197  } else if (arg[strcspn(arg, "'\" \n\t")] == '\0') {
198    /* If there are no nasty characters, return as-is. */
199    g_string_append(buf, arg);
200  } else if (!strchr(arg, '\'')) {
201    /* Single-quote if possible. */
202    g_string_append_c(buf, '\'');
203    g_string_append(buf, arg);
204    g_string_append_c(buf, '\'');
205  } else {
206    /* Nasty case: double-quote, but change all internal "s to "'"'"
207     * so that they are single-quoted because we're too cool for
208     * backslashes.
209     */
210    g_string_append_c(buf, '"');
211    for (argp = arg; *argp; argp++) {
212      if (*argp == '"')
213        g_string_append(buf, "\"'\"'\"");
214      else
215        g_string_append_c(buf, *argp);
216    }
217    g_string_append_c(buf, '"');
218  }
219}
220
221/*
222 * Appends 'tmpl' to 'buf', replacing any instances of '%q' with arguments from
223 * the varargs provided, quoting them to be safe for placing in a barnowl
224 * command line.
225 */
226void owl_string_appendf_quoted(GString *buf, const char *tmpl, ...)
227{
228  va_list ap;
229  va_start(ap, tmpl);
230  owl_string_vappendf_quoted(buf, tmpl, ap);
231  va_end(ap);
232}
233
234void owl_string_vappendf_quoted(GString *buf, const char *tmpl, va_list ap)
235{
236  const char *p = tmpl, *last = tmpl;
237  while (true) {
238    p = strchr(p, '%');
239    if (p == NULL) break;
240    if (*(p+1) != 'q') {
241      p++;
242      if (*p) p++;
243      continue;
244    }
245    g_string_append_len(buf, last, p - last);
246    owl_string_append_quoted_arg(buf, va_arg(ap, char *));
247    p += 2; last = p;
248  }
249
250  g_string_append(buf, last);
251}
252
253char *owl_string_build_quoted(const char *tmpl, ...)
254{
255  GString *buf = g_string_new("");
256  va_list ap;
257  va_start(ap, tmpl);
258  owl_string_vappendf_quoted(buf, tmpl, ap);
259  va_end(ap);
260  return g_string_free(buf, false); 
261}
262
263/* Returns a quoted version of arg suitable for placing in a
264 * command-line. Result should be freed with owl_free. */
265char *owl_arg_quote(const char *arg)
266{
267  GString *buf = g_string_new("");;
268  owl_string_append_quoted_arg(buf, arg);
269  return g_string_free(buf, false);
270}
271
272/* caller must free the return */
273char *owl_util_minutes_to_timestr(int in)
274{
275  int days, hours;
276  long run;
277  char *out;
278
279  run=in;
280
281  days=run/1440;
282  run-=days*1440;
283  hours=run/60;
284  run-=hours*60;
285
286  if (days>0) {
287    out=owl_sprintf("%i d %2.2i:%2.2li", days, hours, run);
288  } else {
289    out=owl_sprintf("    %2.2i:%2.2li", hours, run);
290  }
291  return(out);
292}
293
294/* hooks for doing memory allocation et. al. in owl */
295
296void owl_free(void *ptr)
297{
298  g_free(ptr);
299}
300
301char *owl_strdup(const char *s1)
302{
303  return(g_strdup(s1));
304}
305
306void *owl_realloc(void *ptr, size_t size)
307{
308  return(g_realloc(ptr, size));
309}
310
311/* allocates memory and returns the string or null.
312 * caller must free the string.
313 */
314char *owl_sprintf(const char *fmt, ...)
315{
316  va_list ap;
317  char *ret = NULL;
318  va_start(ap, fmt);
319  ret = g_strdup_vprintf(fmt, ap);
320  va_end(ap);
321  return ret;
322}
323
324/* These are in order of their value in owl.h */
325static const struct {
326  int number;
327  const char *name;
328} color_map[] = {
329  {OWL_COLOR_INVALID, "invalid"},
330  {OWL_COLOR_DEFAULT, "default"},
331  {OWL_COLOR_BLACK, "black"},
332  {OWL_COLOR_RED, "red"},
333  {OWL_COLOR_GREEN, "green"},
334  {OWL_COLOR_YELLOW,"yellow"},
335  {OWL_COLOR_BLUE, "blue"},
336  {OWL_COLOR_MAGENTA, "magenta"},
337  {OWL_COLOR_CYAN, "cyan"},
338  {OWL_COLOR_WHITE, "white"},
339};
340
341/* Return the owl color associated with the named color.  Return -1
342 * if the named color is not available
343 */
344int owl_util_string_to_color(const char *color)
345{
346  int c, i;
347  char *p;
348
349  for (i = 0; i < (sizeof(color_map)/sizeof(color_map[0])); i++)
350    if (strcasecmp(color, color_map[i].name) == 0)
351      return color_map[i].number;
352
353  c = strtol(color, &p, 10);
354  if (p != color && c >= -1 && c < COLORS) {
355    return(c);
356  }
357  return(OWL_COLOR_INVALID);
358}
359
360/* Return a string name of the given owl color */
361const char *owl_util_color_to_string(int color)
362{
363  if (color >= OWL_COLOR_INVALID && color <= OWL_COLOR_WHITE)
364    return color_map[color - OWL_COLOR_INVALID].name;
365  return("Unknown color");
366}
367
368/* Get the default tty name.  Caller must free the return */
369char *owl_util_get_default_tty(void)
370{
371  const char *tmp;
372  char *out;
373
374  if (getenv("DISPLAY")) {
375    out=owl_strdup(getenv("DISPLAY"));
376  } else if ((tmp=ttyname(fileno(stdout)))!=NULL) {
377    out=owl_strdup(tmp);
378    if (!strncmp(out, "/dev/", 5)) {
379      owl_free(out);
380      out=owl_strdup(tmp+5);
381    }
382  } else {
383    out=owl_strdup("unknown");
384  }
385  return(out);
386}
387
388/* strip leading and trailing new lines.  Caller must free the
389 * return.
390 */
391char *owl_util_stripnewlines(const char *in)
392{
393 
394  char  *tmp, *ptr1, *ptr2, *out;
395
396  ptr1=tmp=owl_strdup(in);
397  while (ptr1[0]=='\n') {
398    ptr1++;
399  }
400  ptr2=ptr1+strlen(ptr1)-1;
401  while (ptr2>ptr1 && ptr2[0]=='\n') {
402    ptr2[0]='\0';
403    ptr2--;
404  }
405
406  out=owl_strdup(ptr1);
407  owl_free(tmp);
408  return(out);
409}
410
411
412/* If filename is a link, recursively resolve symlinks.  Otherwise, return the filename
413 * unchanged.  On error, call owl_function_error and return NULL.
414 *
415 * This function assumes that filename eventually resolves to an acutal file.
416 * If you want to check this, you should stat() the file first.
417 *
418 * The caller of this function is responsible for freeing the return value.
419 *
420 * Error conditions are the same as g_file_read_link.
421 */
422gchar *owl_util_recursive_resolve_link(const char *filename)
423{
424  gchar *last_path = g_strdup(filename);
425  GError *err = NULL;
426
427  while (g_file_test(last_path, G_FILE_TEST_IS_SYMLINK)) {
428    gchar *link_path = g_file_read_link(last_path, &err);
429    if (link_path == NULL) {
430      owl_function_error("Cannot resolve symlink %s: %s",
431                         last_path, err->message);
432      g_error_free(err);
433      g_free(last_path);
434      return NULL;
435    }
436
437    /* Deal with obnoxious relative paths. If we really care, all this
438     * is racy. Whatever. */
439    if (!g_path_is_absolute(link_path)) {
440      char *last_dir = g_path_get_dirname(last_path);
441      char *tmp = g_build_path(G_DIR_SEPARATOR_S,
442                               last_dir,
443                               link_path,
444                               NULL);
445      g_free(last_dir);
446      g_free(link_path);
447      link_path = tmp;
448    }
449
450    g_free(last_path);
451    last_path = link_path;
452  }
453  return last_path;
454}
455
456/* Delete all lines matching "line" from the named file.  If no such
457 * line is found the file is left intact.  If backup==1 then leave a
458 * backup file containing the original contents.  The match is
459 * case-insensitive.
460 *
461 * Returns the number of lines removed on success.  Returns -1 on failure.
462 */
463int owl_util_file_deleteline(const char *filename, const char *line, int backup)
464{
465  char *backupfile, *newfile, *buf = NULL;
466  gchar *actual_filename; /* gchar; we need to g_free it */
467  FILE *old, *new;
468  struct stat st;
469  int numremoved = 0;
470
471  if ((old = fopen(filename, "r")) == NULL) {
472    owl_function_error("Cannot open %s (for reading): %s",
473                       filename, strerror(errno));
474    return -1;
475  }
476
477  if (fstat(fileno(old), &st) != 0) {
478    owl_function_error("Cannot stat %s: %s", filename, strerror(errno));
479    return -1;
480  }
481
482  /* resolve symlinks, because link() fails on symlinks, at least on AFS */
483  actual_filename = owl_util_recursive_resolve_link(filename);
484  if (actual_filename == NULL)
485    return -1; /* resolving the symlink failed, but we already logged this error */
486
487  newfile = owl_sprintf("%s.new", actual_filename);
488  if ((new = fopen(newfile, "w")) == NULL) {
489    owl_function_error("Cannot open %s (for writing): %s",
490                       actual_filename, strerror(errno));
491    owl_free(newfile);
492    fclose(old);
493    free(actual_filename);
494    return -1;
495  }
496
497  if (fchmod(fileno(new), st.st_mode & 0777) != 0) {
498    owl_function_error("Cannot set permissions on %s: %s",
499                       actual_filename, strerror(errno));
500    unlink(newfile);
501    fclose(new);
502    owl_free(newfile);
503    fclose(old);
504    free(actual_filename);
505    return -1;
506  }
507
508  while (owl_getline_chomp(&buf, old))
509    if (strcasecmp(buf, line) != 0)
510      fprintf(new, "%s\n", buf);
511    else
512      numremoved++;
513  owl_free(buf);
514
515  fclose(new);
516  fclose(old);
517
518  if (backup) {
519    backupfile = owl_sprintf("%s.backup", actual_filename);
520    unlink(backupfile);
521    if (link(actual_filename, backupfile) != 0) {
522      owl_function_error("Cannot link %s: %s", backupfile, strerror(errno));
523      owl_free(backupfile);
524      unlink(newfile);
525      owl_free(newfile);
526      return -1;
527    }
528    owl_free(backupfile);
529  }
530
531  if (rename(newfile, actual_filename) != 0) {
532    owl_function_error("Cannot move %s to %s: %s",
533                       newfile, actual_filename, strerror(errno));
534    numremoved = -1;
535  }
536
537  unlink(newfile);
538  owl_free(newfile);
539
540  g_free(actual_filename);
541
542  return numremoved;
543}
544
545/* Return the base class or instance from a zephyr class, by removing
546   leading `un' or trailing `.d'.
547   The caller is responsible for freeing the allocated string.
548*/
549char * owl_util_baseclass(const char * class)
550{
551  char *start, *end;
552
553  while(!strncmp(class, "un", 2)) {
554    class += 2;
555  }
556
557  start = owl_strdup(class);
558  end = start + strlen(start) - 1;
559  while(end > start && *end == 'd' && *(end-1) == '.') {
560    end -= 2;
561  }
562  *(end + 1) = 0;
563
564  return start;
565}
566
567const char * owl_get_datadir(void)
568{
569  const char * datadir = getenv("BARNOWL_DATA_DIR");
570  if(datadir != NULL)
571    return datadir;
572  return DATADIR;
573}
574
575const char * owl_get_bindir(void)
576{
577  const char * bindir = getenv("BARNOWL_BIN_DIR");
578  if(bindir != NULL)
579    return bindir;
580  return BINDIR;
581}
582
583/* Strips format characters from a valid utf-8 string. Returns the
584   empty string if 'in' does not validate. */
585char * owl_strip_format_chars(const char *in)
586{
587  char *r;
588  if (g_utf8_validate(in, -1, NULL)) {
589    const char *s, *p;
590    r = g_new(char, strlen(in)+1);
591    r[0] = '\0';
592    s = in;
593    p = strchr(s, OWL_FMTEXT_UC_STARTBYTE_UTF8);
594    while(p) {
595      /* If it's a format character, copy up to it, and skip all
596         immediately following format characters. */
597      if (owl_fmtext_is_format_char(g_utf8_get_char(p))) {
598        strncat(r, s, p-s);
599        p = g_utf8_next_char(p);
600        while (owl_fmtext_is_format_char(g_utf8_get_char(p))) {
601          p = g_utf8_next_char(p);
602        }
603        s = p;
604        p = strchr(s, OWL_FMTEXT_UC_STARTBYTE_UTF8);
605      }
606      else {
607        p = strchr(p+1, OWL_FMTEXT_UC_STARTBYTE_UTF8);
608      }
609    }
610    if (s) strcat(r,s);
611  }
612  else {
613    r = owl_strdup("");
614  }
615  return r;
616}
617
618/* If in is not UTF-8, convert from ISO-8859-1. We may want to allow
619 * the caller to specify an alternative in the future. We also strip
620 * out characters in Unicode Plane 16, as we use that plane internally
621 * for formatting.
622 */
623char * owl_validate_or_convert(const char *in)
624{
625  if (g_utf8_validate(in, -1, NULL)) {
626    return owl_strip_format_chars(in);
627  }
628  else {
629    return g_convert(in, -1,
630                     "UTF-8", "ISO-8859-1",
631                     NULL, NULL, NULL);
632  }
633}
634/*
635 * Validate 'in' as UTF-8, and either return a copy of it, or an empty
636 * string if it is invalid utf-8.
637 */
638char * owl_validate_utf8(const char *in)
639{
640  char *out;
641  if (g_utf8_validate(in, -1, NULL)) {
642    out = owl_strdup(in);
643  } else {
644    out = owl_strdup("");
645  }
646  return out;
647}
648
649/* This is based on _extract() and _isCJ() from perl's Text::WrapI18N */
650int owl_util_can_break_after(gunichar c)
651{
652 
653  if (c == ' ') return 1;
654  if (c >= 0x3000 && c <= 0x312f) {
655    /* CJK punctuations, Hiragana, Katakana, Bopomofo */
656    if (c == 0x300a || c == 0x300c || c == 0x300e ||
657        c == 0x3010 || c == 0x3014 || c == 0x3016 ||
658        c == 0x3018 || c == 0x301a)
659      return 0;
660    return 1;
661  }
662  if (c >= 0x31a0 && c <= 0x31bf) {return 1;}  /* Bopomofo */
663  if (c >= 0x31f0 && c <= 0x31ff) {return 1;}  /* Katakana extension */
664  if (c >= 0x3400 && c <= 0x9fff) {return 1;}  /* Han Ideogram */
665  if (c >= 0xf900 && c <= 0xfaff) {return 1;}  /* Han Ideogram */
666  if (c >= 0x20000 && c <= 0x2ffff) {return 1;}  /* Han Ideogram */
667  return 0;
668}
669
670char *owl_escape_highbit(const char *str)
671{
672  GString *out = g_string_new("");
673  unsigned char c;
674  while((c = (*str++))) {
675    if(c == '\\') {
676      g_string_append(out, "\\\\");
677    } else if(c & 0x80) {
678      g_string_append_printf(out, "\\x%02x", (int)c);
679    } else {
680      g_string_append_c(out, c);
681    }
682  }
683  return g_string_free(out, 0);
684}
685
686/* innards of owl_getline{,_chomp} below */
687static int owl_getline_internal(char **s, FILE *fp, int newline)
688{
689  int size = 0;
690  int target = 0;
691  int count = 0;
692  int c;
693
694  while (1) {
695    c = getc(fp);
696    if ((target + 1) > size) {
697      size += BUFSIZ;
698      *s = owl_realloc(*s, size);
699    }
700    if (c == EOF)
701      break;
702    count++;
703    if (c != '\n' || newline)
704        (*s)[target++] = c;
705    if (c == '\n')
706      break;
707  }
708  (*s)[target] = 0;
709
710  return count;
711}
712
713/* Read a line from fp, allocating memory to hold it, returning the number of
714 * byte read.  *s should either be NULL or a pointer to memory allocated with
715 * g_malloc; it will be owl_realloc'd as appropriate.  The caller must
716 * eventually free it.  (This is roughly the interface of getline in the gnu
717 * libc).
718 *
719 * The final newline will be included if it's there.
720 */
721int owl_getline(char **s, FILE *fp)
722{
723  return owl_getline_internal(s, fp, 1);
724}
725
726/* As above, but omitting the final newline */
727int owl_getline_chomp(char **s, FILE *fp)
728{
729  return owl_getline_internal(s, fp, 0);
730}
731
732/* Read the rest of the input available in fp into a string. */
733char *owl_slurp(FILE *fp)
734{
735  char *buf = NULL;
736  char *p;
737  int size = 0;
738  int count;
739
740  while (1) {
741    buf = owl_realloc(buf, size + BUFSIZ);
742    p = &buf[size];
743    size += BUFSIZ;
744
745    if ((count = fread(p, 1, BUFSIZ, fp)) < BUFSIZ)
746      break;
747  }
748  p[count] = 0;
749
750  return buf;
751}
752
753gulong owl_dirty_window_on_signal(owl_window *w, gpointer sender, const gchar *detailed_signal)
754{
755  return owl_signal_connect_object(sender, detailed_signal, G_CALLBACK(owl_window_dirty), w, G_CONNECT_SWAPPED);
756}
757
758typedef struct { /*noproto*/
759  GObject  *sender;
760  gulong    signal_id;
761} SignalData;
762
763static void _closure_invalidated(gpointer data, GClosure *closure);
764
765/*
766 * GObject's g_signal_connect_object has a documented bug. This function is
767 * identical except it does not leak the signal handler.
768 */
769gulong owl_signal_connect_object(gpointer sender, const gchar *detailed_signal, GCallback c_handler, gpointer receiver, GConnectFlags connect_flags)
770{
771  g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (sender), 0);
772  g_return_val_if_fail (detailed_signal != NULL, 0);
773  g_return_val_if_fail (c_handler != NULL, 0);
774
775  if (receiver) {
776    SignalData *sdata;
777    GClosure *closure;
778    gulong signal_id;
779
780    g_return_val_if_fail (G_IS_OBJECT (receiver), 0);
781
782    closure = ((connect_flags & G_CONNECT_SWAPPED) ? g_cclosure_new_object_swap : g_cclosure_new_object) (c_handler, receiver);
783    signal_id = g_signal_connect_closure (sender, detailed_signal, closure, connect_flags & G_CONNECT_AFTER);
784
785    /* Register the missing hooks */
786    sdata = g_slice_new0(SignalData);
787    sdata->sender = sender;
788    sdata->signal_id = signal_id;
789
790    g_closure_add_invalidate_notifier(closure, sdata, _closure_invalidated);
791
792    return signal_id;
793  } else {
794    return g_signal_connect_data(sender, detailed_signal, c_handler, NULL, NULL, connect_flags);
795  }
796}
797
798/*
799 * There are three ways the signal could come to an end:
800 *
801 * 1. The user explicitly disconnects it with the returned signal_id.
802 *    - In that case, the disconnection unref's the closure, causing it
803 *      to first be invalidated. The handler's already disconnected, so
804 *      we have no work to do.
805 * 2. The sender gets destroyed.
806 *    - GObject will disconnect each signal which then goes into the above
807 *      case. Our handler does no work.
808 * 3. The receiver gets destroyed.
809 *    - The GClosure was created by g_cclosure_new_object_{,swap} which gets
810 *      invalidated when the receiver is destroyed. We then follow through case 1
811 *      again, but *this* time, the handler has not been disconnected. We then
812 *      clean up ourselves.
813 *
814 * We can't actually hook into this process earlier with weakrefs as GObject
815 * will, on object dispose, first disconnect signals, then invalidate closures,
816 * and notify weakrefs last.
817 */
818static void _closure_invalidated(gpointer data, GClosure *closure)
819{
820  SignalData *sdata = data;
821  if (g_signal_handler_is_connected(sdata->sender, sdata->signal_id)) {
822    g_signal_handler_disconnect(sdata->sender, sdata->signal_id);
823  }
824  g_slice_free(SignalData, sdata);
825}
826
Note: See TracBrowser for help on using the repository browser.