Merge from trunk.
[emacs.git] / src / xrdb.c
blob39637b04081c4a0fa5089f24fcdd2b83038e65e8
1 /* Deal with the X Resource Manager.
2 Copyright (C) 1990, 1993, 1994, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5 Author: Joseph Arceneaux
6 Created: 4/90
8 This file is part of GNU Emacs.
10 GNU Emacs is free software: you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation, either version 3 of the License, or
13 (at your option) any later version.
15 GNU Emacs is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #ifdef emacs
24 #include <config.h>
25 #endif
27 #ifdef HAVE_UNISTD_H
28 #include <unistd.h>
29 #endif
31 #include <errno.h>
32 #include <epaths.h>
34 #include <stdio.h>
35 #include <setjmp.h>
37 #include <X11/Xlib.h>
38 #include <X11/Xatom.h>
39 #include <X11/X.h>
40 #include <X11/Xutil.h>
41 #include <X11/Xresource.h>
42 #ifdef HAVE_PWD_H
43 #include <pwd.h>
44 #endif
45 #include <sys/stat.h>
47 #if !defined(S_ISDIR) && defined(S_IFDIR)
48 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
49 #endif
51 #include "lisp.h"
53 extern char *getenv (const char *);
55 /* This does cause trouble on AIX. I'm going to take the comment at
56 face value. */
57 #if 0
58 extern short getuid (); /* If this causes portability problems,
59 I think we should just delete it; it'll
60 default to `int' anyway. */
61 #endif
63 #ifdef DECLARE_GETPWUID_WITH_UID_T
64 extern struct passwd *getpwuid (uid_t);
65 extern struct passwd *getpwnam (const char *);
66 #else
67 extern struct passwd *getpwuid (uid_t);
68 extern struct passwd *getpwnam (const char *);
69 #endif
71 extern char *get_system_name (void);
73 /* Make sure not to #include anything after these definitions. Let's
74 not step on anyone's prototypes. */
75 #ifdef emacs
76 /* darwin.h may have already defined these. */
77 #undef malloc
78 #undef realloc
79 #undef free
80 #define malloc xmalloc
81 #define realloc xrealloc
82 #define free xfree
83 #endif
85 char *x_get_string_resource (XrmDatabase rdb, const char *name,
86 const char *class);
87 static int file_p (const char *filename);
90 /* X file search path processing. */
93 /* The string which gets substituted for the %C escape in XFILESEARCHPATH
94 and friends, or zero if none was specified. */
95 char *x_customization_string;
98 /* Return the value of the emacs.customization (Emacs.Customization)
99 resource, for later use in search path decoding. If we find no
100 such resource, return zero. */
101 char *
102 x_get_customization_string (XrmDatabase db, const char *name, const char *class)
104 char *full_name
105 = (char *) alloca (strlen (name) + sizeof ("customization") + 3);
106 char *full_class
107 = (char *) alloca (strlen (class) + sizeof ("Customization") + 3);
108 char *result;
110 sprintf (full_name, "%s.%s", name, "customization");
111 sprintf (full_class, "%s.%s", class, "Customization");
113 result = x_get_string_resource (db, full_name, full_class);
115 if (result)
117 char *copy = (char *) malloc (strlen (result) + 1);
118 strcpy (copy, result);
119 return copy;
121 else
122 return 0;
126 /* Expand all the Xt-style %-escapes in STRING, whose length is given
127 by STRING_LEN. Here are the escapes we're supposed to recognize:
129 %N The value of the application's class name
130 %T The value of the type parameter ("app-defaults" in this
131 context)
132 %S The value of the suffix parameter ("" in this context)
133 %L The language string associated with the specified display
134 (We use the "LANG" environment variable here, if it's set.)
135 %l The language part of the display's language string
136 (We treat this just like %L. If someone can tell us what
137 we're really supposed to do, dandy.)
138 %t The territory part of the display's language string
139 (This never gets used.)
140 %c The codeset part of the display's language string
141 (This never gets used either.)
142 %C The customization string retrieved from the resource
143 database associated with display.
144 (This is x_customization_string.)
146 Return the expanded file name if it exists and is readable, and
147 refers to %L only when the LANG environment variable is set, or
148 otherwise provided by X.
150 ESCAPED_SUFFIX and SUFFIX are postpended to STRING if they are
151 non-zero. %-escapes in ESCAPED_SUFFIX are expanded; STRING is left
152 alone.
154 Return NULL otherwise. */
156 static char *
157 magic_file_p (const char *string, int string_len, const char *class, const char *escaped_suffix, const char *suffix)
159 char *lang = getenv ("LANG");
161 int path_size = 100;
162 char *path = (char *) malloc (path_size);
163 int path_len = 0;
165 const char *p = string;
167 while (p < string + string_len)
169 /* The chunk we're about to stick on the end of result. */
170 const char *next = NULL;
171 int next_len;
173 if (*p == '%')
175 p++;
177 if (p >= string + string_len)
178 next_len = 0;
179 else
180 switch (*p)
182 case '%':
183 next = "%";
184 next_len = 1;
185 break;
187 case 'C':
188 next = (x_customization_string
189 ? x_customization_string
190 : "");
191 next_len = strlen (next);
192 break;
194 case 'N':
195 next = class;
196 next_len = strlen (class);
197 break;
199 case 'T':
200 next = "app-defaults";
201 next_len = strlen (next);
202 break;
204 default:
205 case 'S':
206 next_len = 0;
207 break;
209 case 'L':
210 case 'l':
211 if (! lang)
213 free (path);
214 return NULL;
217 next = lang;
218 next_len = strlen (next);
219 break;
221 case 't':
222 case 'c':
223 free (path);
224 return NULL;
227 else
228 next = p, next_len = 1;
230 /* Do we have room for this component followed by a '\0' ? */
231 if (path_len + next_len + 1 > path_size)
233 path_size = (path_len + next_len + 1) * 2;
234 path = (char *) realloc (path, path_size);
237 memcpy (path + path_len, next, next_len);
238 path_len += next_len;
240 p++;
242 /* If we've reached the end of the string, append ESCAPED_SUFFIX. */
243 if (p >= string + string_len && escaped_suffix)
245 string = escaped_suffix;
246 string_len = strlen (string);
247 p = string;
248 escaped_suffix = NULL;
252 /* Perhaps we should add the SUFFIX now. */
253 if (suffix)
255 int suffix_len = strlen (suffix);
257 if (path_len + suffix_len + 1 > path_size)
259 path_size = (path_len + suffix_len + 1);
260 path = (char *) realloc (path, path_size);
263 memcpy (path + path_len, suffix, suffix_len);
264 path_len += suffix_len;
267 path[path_len] = '\0';
269 if (! file_p (path))
271 free (path);
272 return NULL;
275 return path;
279 static char *
280 gethomedir (void)
282 struct passwd *pw;
283 char *ptr;
284 char *copy;
286 if ((ptr = getenv ("HOME")) == NULL)
288 if ((ptr = getenv ("LOGNAME")) != NULL
289 || (ptr = getenv ("USER")) != NULL)
290 pw = getpwnam (ptr);
291 else
292 pw = getpwuid (getuid ());
294 if (pw)
295 ptr = pw->pw_dir;
298 if (ptr == NULL)
299 return xstrdup ("/");
301 copy = (char *) malloc (strlen (ptr) + 2);
302 strcpy (copy, ptr);
303 strcat (copy, "/");
305 return copy;
309 static int
310 file_p (const char *filename)
312 struct stat status;
314 return (access (filename, 4) == 0 /* exists and is readable */
315 && stat (filename, &status) == 0 /* get the status */
316 && (S_ISDIR (status.st_mode)) == 0); /* not a directory */
320 /* Find the first element of SEARCH_PATH which exists and is readable,
321 after expanding the %-escapes. Return 0 if we didn't find any, and
322 the path name of the one we found otherwise. */
324 static char *
325 search_magic_path (const char *search_path, const char *class, const char *escaped_suffix, const char *suffix)
327 const char *s, *p;
329 for (s = search_path; *s; s = p)
331 for (p = s; *p && *p != ':'; p++)
334 if (p > s)
336 char *path = magic_file_p (s, p - s, class, escaped_suffix,
337 suffix);
338 if (path)
339 return path;
341 else if (*p == ':')
343 char *path;
345 s = "%N%S";
346 path = magic_file_p (s, strlen (s), class, escaped_suffix, suffix);
347 if (path)
348 return path;
351 if (*p == ':')
352 p++;
355 return 0;
358 /* Producing databases for individual sources. */
360 static XrmDatabase
361 get_system_app (const char *class)
363 XrmDatabase db = NULL;
364 char *path;
366 path = getenv ("XFILESEARCHPATH");
367 if (! path) path = PATH_X_DEFAULTS;
369 path = search_magic_path (path, class, 0, 0);
370 if (path)
372 db = XrmGetFileDatabase (path);
373 free (path);
376 return db;
380 static XrmDatabase
381 get_fallback (Display *display)
383 return NULL;
387 static XrmDatabase
388 get_user_app (const char *class)
390 char *path;
391 char *file = 0;
392 char *free_it = 0;
394 /* Check for XUSERFILESEARCHPATH. It is a path of complete file
395 names, not directories. */
396 if (((path = getenv ("XUSERFILESEARCHPATH"))
397 && (file = search_magic_path (path, class, 0, 0)))
399 /* Check for APPLRESDIR; it is a path of directories. In each,
400 we have to search for LANG/CLASS and then CLASS. */
401 || ((path = getenv ("XAPPLRESDIR"))
402 && ((file = search_magic_path (path, class, "/%L/%N", 0))
403 || (file = search_magic_path (path, class, "/%N", 0))))
405 /* Check in the home directory. This is a bit of a hack; let's
406 hope one's home directory doesn't contain any %-escapes. */
407 || (free_it = gethomedir (),
408 ((file = search_magic_path (free_it, class, "%L/%N", 0))
409 || (file = search_magic_path (free_it, class, "%N", 0)))))
411 XrmDatabase db = XrmGetFileDatabase (file);
412 free (file);
413 free (free_it);
414 return db;
417 free (free_it);
418 return NULL;
422 static XrmDatabase
423 get_user_db (Display *display)
425 XrmDatabase db;
426 char *xdefs;
428 #ifdef PBaseSize /* Cheap way to test for X11R4 or later. */
429 xdefs = XResourceManagerString (display);
430 #else
431 xdefs = display->xdefaults;
432 #endif
434 if (xdefs != NULL)
435 db = XrmGetStringDatabase (xdefs);
436 else
438 char *home;
439 char *xdefault;
441 home = gethomedir ();
442 xdefault = (char *) malloc (strlen (home) + sizeof (".Xdefaults"));
443 strcpy (xdefault, home);
444 strcat (xdefault, ".Xdefaults");
445 db = XrmGetFileDatabase (xdefault);
446 free (home);
447 free (xdefault);
450 #ifdef HAVE_XSCREENRESOURCESTRING
451 /* Get the screen-specific resources too. */
452 xdefs = XScreenResourceString (DefaultScreenOfDisplay (display));
453 if (xdefs != NULL)
455 XrmMergeDatabases (XrmGetStringDatabase (xdefs), &db);
456 XFree (xdefs);
458 #endif
460 return db;
463 static XrmDatabase
464 get_environ_db (void)
466 XrmDatabase db;
467 char *p;
468 char *path = 0, *home = 0, *host;
470 if ((p = getenv ("XENVIRONMENT")) == NULL)
472 home = gethomedir ();
473 host = get_system_name ();
474 path = (char *) malloc (strlen (home)
475 + sizeof (".Xdefaults-")
476 + strlen (host));
477 sprintf (path, "%s%s%s", home, ".Xdefaults-", host);
478 p = path;
481 db = XrmGetFileDatabase (p);
483 free (path);
484 free (home);
486 return db;
489 /* External interface. */
491 /* Types of values that we can find in a database */
493 #define XrmStringType "String" /* String representation */
494 XrmRepresentation x_rm_string; /* Quark representation */
496 /* Load X resources based on the display and a possible -xrm option. */
498 XrmDatabase
499 x_load_resources (Display *display, const char *xrm_string,
500 const char *myname, const char *myclass)
502 XrmDatabase user_database;
503 XrmDatabase rdb;
504 XrmDatabase db;
505 char line[256];
507 const char *helv = "-*-helvetica-medium-r-*--*-120-*-*-*-*-iso8859-1";
509 #ifdef USE_MOTIF
510 const char *courier = "-*-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1";
511 #endif
513 x_rm_string = XrmStringToQuark (XrmStringType);
514 #ifndef USE_X_TOOLKIT
515 /* pmr@osf.org says this shouldn't be done if USE_X_TOOLKIT.
516 I suspect it's because the toolkit version does this elsewhere. */
517 XrmInitialize ();
518 #endif
519 rdb = XrmGetStringDatabase ("");
521 /* Add some font defaults. If the font `helv' doesn't exist, widgets
522 will use some other default font. */
523 #ifdef USE_MOTIF
525 sprintf (line, "%s.pane.background: grey75", myclass);
526 XrmPutLineResource (&rdb, line);
527 sprintf (line, "%s*fontList: %s", myclass, helv);
528 XrmPutLineResource (&rdb, line);
529 sprintf (line, "%s*menu*background: grey75", myclass);
530 XrmPutLineResource (&rdb, line);
531 sprintf (line, "%s*menubar*background: grey75", myclass);
532 XrmPutLineResource (&rdb, line);
533 sprintf (line, "%s*verticalScrollBar.background: grey75", myclass);
534 XrmPutLineResource (&rdb, line);
535 sprintf (line, "%s*verticalScrollBar.troughColor: grey75", myclass);
536 XrmPutLineResource (&rdb, line);
537 sprintf (line, "%s.dialog*.background: grey75", myclass);
538 XrmPutLineResource (&rdb, line);
539 sprintf (line, "%s*fsb.Text.background: white", myclass);
540 XrmPutLineResource (&rdb, line);
541 sprintf (line, "%s*fsb.FilterText.background: white", myclass);
542 XrmPutLineResource (&rdb, line);
543 sprintf (line, "%s*fsb*DirList.background: white", myclass);
544 XrmPutLineResource (&rdb, line);
545 sprintf (line, "%s*fsb*ItemsList.background: white", myclass);
546 XrmPutLineResource (&rdb, line);
547 sprintf (line, "%s*fsb*background: grey75", myclass);
548 XrmPutLineResource (&rdb, line);
549 sprintf (line, "%s*fsb.Text.fontList: %s", myclass, courier);
550 XrmPutLineResource (&rdb, line);
551 sprintf (line, "%s*fsb.FilterText.fontList: %s", myclass, courier);
552 XrmPutLineResource (&rdb, line);
553 sprintf (line, "%s*fsb*ItemsList.fontList: %s", myclass, courier);
554 XrmPutLineResource (&rdb, line);
555 sprintf (line, "%s*fsb*DirList.fontList: %s", myclass, courier);
556 XrmPutLineResource (&rdb, line);
558 /* Set double click time of list boxes in the file selection
559 dialog from `double-click-time'. */
560 if (INTEGERP (Vdouble_click_time) && XINT (Vdouble_click_time) > 0)
562 sprintf (line, "%s*fsb*DirList.doubleClickInterval: %d",
563 myclass, XFASTINT (Vdouble_click_time));
564 XrmPutLineResource (&rdb, line);
565 sprintf (line, "%s*fsb*ItemsList.doubleClickInterval: %d",
566 myclass, XFASTINT (Vdouble_click_time));
567 XrmPutLineResource (&rdb, line);
570 #else /* not USE_MOTIF */
572 sprintf (line, "Emacs.dialog*.font: %s", helv);
573 XrmPutLineResource (&rdb, line);
574 sprintf (line, "Emacs.dialog*.background: grey75");
575 XrmPutLineResource (&rdb, line);
576 sprintf (line, "*XlwMenu*font: %s", helv);
577 XrmPutLineResource (&rdb, line);
578 sprintf (line, "*XlwMenu*background: grey75");
579 XrmPutLineResource (&rdb, line);
580 sprintf (line, "Emacs*verticalScrollBar.background: grey75");
581 XrmPutLineResource (&rdb, line);
583 #endif /* not USE_MOTIF */
585 user_database = get_user_db (display);
587 /* Figure out what the "customization string" is, so we can use it
588 to decode paths. */
589 free (x_customization_string);
590 x_customization_string
591 = x_get_customization_string (user_database, myname, myclass);
593 /* Get application system defaults */
594 db = get_system_app (myclass);
595 if (db != NULL)
596 XrmMergeDatabases (db, &rdb);
598 /* Get Fallback resources */
599 db = get_fallback (display);
600 if (db != NULL)
601 XrmMergeDatabases (db, &rdb);
603 /* Get application user defaults */
604 db = get_user_app (myclass);
605 if (db != NULL)
606 XrmMergeDatabases (db, &rdb);
608 /* get User defaults */
609 if (user_database != NULL)
610 XrmMergeDatabases (user_database, &rdb);
612 /* Get Environment defaults. */
613 db = get_environ_db ();
614 if (db != NULL)
615 XrmMergeDatabases (db, &rdb);
617 /* Last, merge in any specification from the command line. */
618 if (xrm_string != NULL)
620 db = XrmGetStringDatabase (xrm_string);
621 if (db != NULL)
622 XrmMergeDatabases (db, &rdb);
625 return rdb;
629 /* Retrieve the value of the resource specified by NAME with class CLASS
630 and of type TYPE from database RDB. The value is returned in RET_VALUE. */
633 x_get_resource (XrmDatabase rdb, const char *name, const char *class, XrmRepresentation expected_type, XrmValue *ret_value)
635 XrmValue value;
636 XrmName namelist[100];
637 XrmClass classlist[100];
638 XrmRepresentation type;
640 XrmStringToNameList(name, namelist);
641 XrmStringToClassList(class, classlist);
643 if (XrmQGetResource (rdb, namelist, classlist, &type, &value) == True
644 && (type == expected_type))
646 if (type == x_rm_string)
647 ret_value->addr = (char *) value.addr;
648 else
649 memcpy (ret_value->addr, value.addr, ret_value->size);
651 return value.size;
654 return 0;
657 /* Retrieve the string resource specified by NAME with CLASS from
658 database RDB. */
660 char *
661 x_get_string_resource (XrmDatabase rdb, const char *name, const char *class)
663 XrmValue value;
665 if (inhibit_x_resources)
666 /* --quick was passed, so this is a no-op. */
667 return NULL;
669 if (x_get_resource (rdb, name, class, x_rm_string, &value))
670 return (char *) value.addr;
672 return (char *) 0;
675 /* Stand-alone test facilities. */
677 #ifdef TESTRM
679 typedef char **List;
680 #define arg_listify(len, list) (list)
681 #define car(list) (*(list))
682 #define cdr(list) (list + 1)
683 #define NIL(list) (! *(list))
684 #define free_arglist(list)
686 static List
687 member (elt, list)
688 char *elt;
689 List list;
691 List p;
693 for (p = list; ! NIL (p); p = cdr (p))
694 if (! strcmp (elt, car (p)))
695 return p;
697 return p;
700 static void
701 fatal (msg, prog, x1, x2, x3, x4, x5)
702 char *msg, *prog;
703 int x1, x2, x3, x4, x5;
705 if (errno)
706 perror (prog);
708 (void) fprintf (stderr, msg, prog, x1, x2, x3, x4, x5);
709 exit (1);
712 main (argc, argv)
713 int argc;
714 char **argv;
716 Display *display;
717 char *displayname, *resource_string, *class, *name;
718 XrmDatabase xdb;
719 List arg_list, lp;
721 arg_list = arg_listify (argc, argv);
723 lp = member ("-d", arg_list);
724 if (!NIL (lp))
725 displayname = car (cdr (lp));
726 else
727 displayname = "localhost:0.0";
729 lp = member ("-xrm", arg_list);
730 if (! NIL (lp))
731 resource_string = car (cdr (lp));
732 else
733 resource_string = (char *) 0;
735 lp = member ("-c", arg_list);
736 if (! NIL (lp))
737 class = car (cdr (lp));
738 else
739 class = "Emacs";
741 lp = member ("-n", arg_list);
742 if (! NIL (lp))
743 name = car (cdr (lp));
744 else
745 name = "emacs";
747 free_arglist (arg_list);
749 if (!(display = XOpenDisplay (displayname)))
750 fatal ("Can't open display '%s'\n", XDisplayName (displayname));
752 xdb = x_load_resources (display, resource_string, name, class);
754 /* In a real program, you'd want to also do this: */
755 display->db = xdb;
757 while (1)
759 char query_name[90];
760 char query_class[90];
762 printf ("Name: ");
763 gets (query_name);
765 if (strlen (query_name))
767 char *value;
769 printf ("Class: ");
770 gets (query_class);
772 value = x_get_string_resource (xdb, query_name, query_class);
774 if (value != NULL)
775 printf ("\t%s(%s): %s\n\n", query_name, query_class, value);
776 else
777 printf ("\tNo Value.\n\n");
779 else
780 break;
782 printf ("\tExit.\n\n");
784 XCloseDisplay (display);
786 #endif /* TESTRM */
788 /* arch-tag: 37e6fbab-ed05-4363-9e76-6c4109ed511f
789 (do not change this comment) */