source: util.c @ 9b9efa2b

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