src/misc.C

   1 /*--------------------------------*-C-*---------------------------------*
   2  * File:        misc.c
   3  *----------------------------------------------------------------------*
   4  *
   5  * All portions of code are copyright by their respective author/s.
   6  * Copyright (c) 1996      mj olesen <olesen@me.QueensU.CA> Queen's Univ at Kingston
   7  * Copyright (c) 1997,1998 Oezguer Kesim <kesim@math.fu-berlin.de>
   8  * Copyright (c) 1998-2000 Geoff Wing <gcw@pobox.com>
   9  * Copyright (c) 2003-2004 Marc Lehmann <pcg@goof.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24  *----------------------------------------------------------------------*/
  25
  26 #include "../config.h"          /* NECESSARY */
  27 #include "rxvt.h"               /* NECESSARY */
  28 #include "misc.intpro"          /* PROTOS for internal routines */
  29
  30 /* EXTPROTO */
  31 char *
  32 rxvt_strdup (const char *str)
  33 {
  34   return str ? strdup (str) : 0;
  35 }
  36
  37 /* EXTPROTO */
  38 char *
  39 rxvt_r_basename (const char *str)
  40 {
  41   char *base = STRRCHR (str, '/');
  42
  43   return (char *) (base ? base + 1 : str);
  44 }
  45
  46 /*
  47  * Print an error message
  48  */
  49 /* EXTPROTO */
  50 void
  51 rxvt_print_error (const char *fmt,...)
  52 {
  53   va_list arg_ptr;
  54
  55   va_start (arg_ptr, fmt);
  56   fprintf (stderr, APL_NAME ": ");
  57   vfprintf (stderr, fmt, arg_ptr);
  58   fprintf (stderr, "\n");
  59   va_end (arg_ptr);
  60 }
  61
  62 /*
  63  * check that the first characters of S1 match S2
  64  *
  65  * No Match
  66  *      return: 0
  67  * Match
  68  *      return: STRLEN (S2)
  69  */
  70 /* EXTPROTO */
  71 int
  72 rxvt_Str_match (const char *s1, const char *s2)
  73 {
  74   int n = STRLEN (s2);
  75
  76   return ((STRNCMP (s1, s2, n) == 0) ? n : 0);
  77 }
  78
  79 /* EXTPROTO */
  80 const char *
  81 rxvt_Str_skip_space (const char *str)
  82 {
  83   if (str)
  84     while (*str && isspace (*str))
  85       str++;
  86
  87   return str;
  88 }
  89
  90 /*
  91  * remove leading/trailing space and strip-off leading/trailing quotes.
  92  * in place.
  93  */
  94 /* EXTPROTO */
  95 char           *
  96 rxvt_Str_trim (char *str)
  97 {
  98   char *r, *s;
  99   int n;
 100
 101   if (!str || !*str)            /* shortcut */
 102     return str;
 103
 104   /* skip leading spaces */
 105   for (s = str; *s && isspace (*s); s++) ;
 106   /* goto end of string */
 107   for (n = 0, r = s; *r++; n++) ;
 108   r -= 2;
 109   /* dump return */
 110   if (n > 0 && *r == '\n')
 111     n--, r--;
 112   /* backtrack along trailing spaces */
 113   for (; n > 0 && isspace (*r); r--, n--) ;
 114   /* skip matching leading/trailing quotes */
 115   if (*s == '"' && *r == '"' && n > 1)
 116     {
 117       s++;
 118       n -= 2;
 119     }
 120
 121   /* copy back over: forwards copy */
 122   for (r = str; n; n--)
 123     *r++ = *s++;
 124   *r = '\0';
 125
 126   return str;
 127 }
 128
 129 /*
 130  * in-place interpretation of string:
 131  *
 132  *      backslash-escaped:      "\a\b\E\e\n\r\t", "\octal"
 133  *      Ctrl chars:     ^@ .. ^_, ^?
 134  *
 135  *      Emacs-style:    "M-" prefix
 136  *
 137  * Also,
 138  *      "M-x" prefixed strings, append "\r" if needed
 139  *      "\E]" prefixed strings (XTerm escape sequence) append ST if needed
 140  *
 141  * returns the converted string length
 142  */
 143 /* EXTPROTO */
 144 int
 145 rxvt_Str_escaped (char *str)
 146 {
 147   char            ch, *s, *d;
 148   int             i, num, append = 0;
 149
 150   if (!str || !*str)
 151     return 0;
 152
 153   d = s = str;
 154
 155   if (*s == 'M' && s[1] == '-')
 156     {
 157       /* Emacs convenience, replace leading `M-..' with `\E..' */
 158       *d++ = C0_ESC;
 159       s += 2;
 160       if (toupper (*s) == 'X')
 161         /* append carriage-return for `M-xcommand' */
 162         for (*d++ = 'x', append = '\r', s++; isspace (*s); s++) ;
 163     }
 164   for (; (ch = *s++);)
 165     {
 166       if (ch == '\\')
 167         {
 168           ch = *s++;
 169           if (ch >= '0' && ch <= '7')
 170             {   /* octal */
 171               num = ch - '0';
 172               for (i = 0; i < 2; i++, s++)
 173                 {
 174                   ch = *s;
 175                   if (ch < '0' || ch > '7')
 176                     break;
 177                   num = num * 8 + ch - '0';
 178                 }
 179               ch = (char)num;
 180             }
 181           else if (ch == 'a')
 182             ch = C0_BEL;        /* bell */
 183           else if (ch == 'b')
 184             ch = C0_BS; /* backspace */
 185           else if (ch == 'E' || ch == 'e')
 186             ch = C0_ESC;        /* escape */
 187           else if (ch == 'n')
 188             ch = '\n';  /* newline */
 189           else if (ch == 'r')
 190             ch = '\r';  /* carriage-return */
 191           else if (ch == 't')
 192             ch = C0_HT; /* tab */
 193         }
 194       else if (ch == '^')
 195         {
 196           ch = *s++;
 197           ch = toupper (ch);
 198           ch = (ch == '?' ? 127 : (ch - '@'));
 199         }
 200       *d++ = ch;
 201     }
 202
 203   /* ESC] is an XTerm escape sequence, must be terminated */
 204   if (*str == '\0' && str[1] == C0_ESC && str[2] == ']')
 205     append = CHAR_ST;
 206
 207   /* add trailing character as required */
 208   if (append && d[-1] != append)
 209     *d++ = append;
 210   *d = '\0';
 211
 212   return (d - str);
 213 }
 214
 215 /*
 216  * Split a comma-separated string into an array, stripping leading and
 217  * trailing spaces (and paired quotes) from each entry.  Empty strings
 218  * are properly returned
 219  * Caller should free each entry and array when done
 220  */
 221 /* EXTPROTO */
 222 char          **
 223 rxvt_splitcommastring (const char *cs)
 224 {
 225   int             l, n, p;
 226   const char     *s, *t;
 227   char          **ret;
 228
 229   if ((s = cs) == NULL)
 230     s = "";
 231
 232   for (n = 1, t = s; *t; t++)
 233     if (*t == ',')
 234       n++;
 235   ret = (char **)malloc ((n + 1) * sizeof (char *));
 236   ret[n] = NULL;
 237
 238   for (l = 0, t = s; l < n; l++)
 239     {
 240       for ( ; *t && *t != ','; t++) ;
 241       p = t - s;
 242       ret[l] = (char *)malloc (p + 1);
 243       strncpy (ret[l], s, p);
 244       ret[l][p] = '\0';
 245       rxvt_Str_trim (ret[l]);
 246       s = ++t;
 247     }
 248   return ret;
 249 }
 250
 251 /*----------------------------------------------------------------------*
 252  * file searching
 253  */
 254
 255 /* #define DEBUG_SEARCH_PATH */
 256
 257 #if defined (XPM_BACKGROUND) || (MENUBAR_MAX)
 258 /*
 259  * search for FILE in the current working directory, and within the
 260  * colon-delimited PATHLIST, adding the file extension EXT if required.
 261  *
 262  * FILE is either semi-colon or zero terminated
 263  */
 264 /* INTPROTO */
 265 char           *
 266 rxvt_File_search_path (const char *pathlist, const char *file, const char *ext)
 267 {
 268   int             maxpath, len;
 269   const char     *p, *path;
 270   char            name[256];
 271
 272   if (!access (file, R_OK))     /* found (plain name) in current directory */
 273     return STRDUP (file);
 274
 275   /* semi-colon delimited */
 276   if ((p = STRCHR (file, ';')))
 277     len = (p - file);
 278   else
 279     len = STRLEN (file);
 280
 281 #ifdef DEBUG_SEARCH_PATH
 282   getcwd (name, sizeof (name));
 283   fprintf (stderr, "pwd: \"%s\"\n", name);
 284   fprintf (stderr, "find: \"%.*s\"\n", len, file);
 285 #endif
 286
 287   /* leave room for an extra '/' and trailing '\0' */
 288   maxpath = sizeof (name) - (len + (ext ? STRLEN (ext) : 0) + 2);
 289   if (maxpath <= 0)
 290     return NULL;
 291
 292   /* check if we can find it now */
 293   STRNCPY (name, file, len);
 294   name[len] = '\0';
 295
 296   if (!access (name, R_OK))
 297     return STRDUP (name);
 298   if (ext)
 299     {
 300       STRCAT (name, ext);
 301       if (!access (name, R_OK))
 302         return STRDUP (name);
 303     }
 304   for (path = pathlist; path != NULL && *path != '\0'; path = p)
 305     {
 306       int             n;
 307
 308       /* colon delimited */
 309       if ((p = STRCHR (path, ':')) == NULL)
 310         p = STRCHR (path, '\0');
 311
 312       n = (p - path);
 313       if (*p != '\0')
 314         p++;
 315
 316       if (n > 0 && n <= maxpath)
 317         {
 318           STRNCPY (name, path, n);
 319           if (name[n - 1] != '/')
 320             name[n++] = '/';
 321           name[n] = '\0';
 322           STRNCAT (name, file, len);
 323
 324           if (!access (name, R_OK))
 325             return STRDUP (name);
 326           if (ext)
 327             {
 328               STRCAT (name, ext);
 329               if (!access (name, R_OK))
 330                 return STRDUP (name);
 331             }
 332         }
 333     }
 334   return NULL;
 335 }
 336
 337 /* EXTPROTO */
 338 char           *
 339 rxvt_File_find (const char *file, const char *ext, const char *path)
 340 {
 341   char           *f;
 342
 343   if (file == NULL || *file == '\0')
 344     return NULL;
 345
 346   /* search environment variables here too */
 347   if ((f = rxvt_File_search_path (path, file, ext)) == NULL)
 348 #ifdef PATH_ENV
 349     if ((f = rxvt_File_search_path (getenv (PATH_ENV), file, ext)) == NULL)
 350 #endif
 351       f = rxvt_File_search_path (getenv ("PATH"), file, ext);
 352
 353 #ifdef DEBUG_SEARCH_PATH
 354   if (f)
 355     fprintf (stderr, "found: \"%s\"\n", f);
 356 #endif
 357
 358   return f;
 359 }
 360 #endif                          /* defined (XPM_BACKGROUND) || (MENUBAR_MAX) */
 361
 362 /*----------------------------------------------------------------------*
 363  * miscellaneous drawing routines
 364  */
 365
 366 /*
 367  * Draw top/left and bottom/right border shadows around windows
 368  */
 369 #if defined(RXVT_SCROLLBAR) || defined(MENUBAR)
 370 /* EXTPROTO */
 371 void
 372 rxvt_Draw_Shadow (Display *display, Window win, GC topShadow, GC botShadow, int x, int y, int w, int h)
 373 {
 374   int             shadow;
 375
 376   shadow = (w == 0 || h == 0) ? 1 : SHADOW;
 377   w += x - 1;
 378   h += y - 1;
 379   for (; shadow-- > 0; x++, y++, w--, h--)
 380     {
 381       XDrawLine (display, win, topShadow, x, y, w, y);
 382       XDrawLine (display, win, topShadow, x, y, x, h);
 383       XDrawLine (display, win, botShadow, w, h, w, y + 1);
 384       XDrawLine (display, win, botShadow, w, h, x + 1, h);
 385     }
 386 }
 387 #endif
 388
 389 /* button shapes */
 390 #ifdef MENUBAR
 391 /* EXTPROTO */
 392 void
 393 rxvt_Draw_Triangle (Display *display, Window win, GC topShadow, GC botShadow, int x, int y, int w, int type)
 394 {
 395   switch (type)
 396     {
 397       case 'r':                 /* right triangle */
 398         XDrawLine (display, win, topShadow, x, y, x, y + w);
 399         XDrawLine (display, win, topShadow, x, y, x + w, y + w / 2);
 400         XDrawLine (display, win, botShadow, x, y + w, x + w, y + w / 2);
 401         break;
 402
 403       case 'l':                 /* left triangle */
 404         XDrawLine (display, win, botShadow, x + w, y + w, x + w, y);
 405         XDrawLine (display, win, botShadow, x + w, y + w, x, y + w / 2);
 406         XDrawLine (display, win, topShadow, x, y + w / 2, x + w, y);
 407         break;
 408
 409       case 'd':                 /* down triangle */
 410         XDrawLine (display, win, topShadow, x, y, x + w / 2, y + w);
 411         XDrawLine (display, win, topShadow, x, y, x + w, y);
 412         XDrawLine (display, win, botShadow, x + w, y, x + w / 2, y + w);
 413         break;
 414
 415       case 'u':                 /* up triangle */
 416         XDrawLine (display, win, botShadow, x + w, y + w, x + w / 2, y);
 417         XDrawLine (display, win, botShadow, x + w, y + w, x, y + w);
 418         XDrawLine (display, win, topShadow, x, y + w, x + w / 2, y);
 419         break;
 420 #if 0
 421       case 's':                 /* square */
 422         XDrawLine (display, win, topShadow, x + w, y, x, y);
 423         XDrawLine (display, win, topShadow, x, y, x, y + w);
 424         XDrawLine (display, win, botShadow, x, y + w, x + w, y + w);
 425         XDrawLine (display, win, botShadow, x + w, y + w, x + w, y);
 426         break;
 427 #endif
 428
 429     }
 430 }
 431 #endif
 432 /*----------------------- end-of-file (C source) -----------------------*/