src/wdefaults.c

   1 /* wdefaults.c - window specific defaults
   2  *
   3  *  Window Maker window manager
   4  *
   5  *  Copyright (c) 1997-2003 Alfredo K. Kojima
   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  *  You should have received a copy of the GNU General Public License along
  18  *  with this program; if not, write to the Free Software Foundation, Inc.,
  19  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include "wconfig.h"
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <unistd.h>
  27 #include <string.h>
  28 #include <strings.h>
  29 #include <ctype.h>
  30
  31 #include <X11/Xlib.h>
  32 #include <X11/Xutil.h>
  33 #include <X11/keysym.h>
  34
  35 #include <wraster.h>
  36
  37 #include "WindowMaker.h"
  38 #include "window.h"
  39 #include "appicon.h"
  40 #include "screen.h"
  41 #include "funcs.h"
  42 #include "workspace.h"
  43 #include "defaults.h"
  44 #include "icon.h"
  45
  46 #define APPLY_VAL(value, flag, attrib)  \
  47     if (value) {attr->flag = getBool(attrib, value); \
  48     if (mask) mask->flag = 1;}
  49
  50 /* Global stuff */
  51 extern WPreferences wPreferences;
  52 extern WDDomain *WDWindowAttributes;
  53
  54 /* Local stuff */
  55
  56 /* type converters */
  57 static int getBool(WMPropList *, WMPropList *);
  58 static char *getString(WMPropList *, WMPropList *);
  59 static WMPropList *ANoTitlebar = NULL;
  60 static WMPropList *ANoResizebar;
  61 static WMPropList *ANoMiniaturizeButton;
  62 static WMPropList *ANoMiniaturizable;
  63 static WMPropList *ANoCloseButton;
  64 static WMPropList *ANoBorder;
  65 static WMPropList *ANoHideOthers;
  66 static WMPropList *ANoMouseBindings;
  67 static WMPropList *ANoKeyBindings;
  68 static WMPropList *ANoAppIcon;  /* app */
  69 static WMPropList *AKeepOnTop;
  70 static WMPropList *AKeepOnBottom;
  71 static WMPropList *AOmnipresent;
  72 static WMPropList *ASkipWindowList;
  73 static WMPropList *ASkipSwitchPanel;
  74 static WMPropList *AKeepInsideScreen;
  75 static WMPropList *AUnfocusable;
  76 static WMPropList *AAlwaysUserIcon;
  77 static WMPropList *AStartMiniaturized;
  78 static WMPropList *AStartMaximized;
  79 static WMPropList *AStartHidden;        /* app */
  80 static WMPropList *ADontSaveSession;    /* app */
  81 static WMPropList *AEmulateAppIcon;
  82 static WMPropList *AFocusAcrossWorkspace;
  83 static WMPropList *AFullMaximize;
  84 static WMPropList *ASharedAppIcon;      /* app */
  85 #ifdef XKB_BUTTON_HINT
  86 static WMPropList *ANoLanguageButton;
  87 #endif
  88 static WMPropList *AStartWorkspace;
  89 static WMPropList *AIcon;
  90 static WMPropList *AnyWindow;
  91 static WMPropList *No;
  92
  93 static void init_wdefaults(void)
  94 {
  95         AIcon = WMCreatePLString("Icon");
  96
  97         ANoTitlebar = WMCreatePLString("NoTitlebar");
  98         ANoResizebar = WMCreatePLString("NoResizebar");
  99         ANoMiniaturizeButton = WMCreatePLString("NoMiniaturizeButton");
 100         ANoMiniaturizable = WMCreatePLString("NoMiniaturizable");
 101         ANoCloseButton = WMCreatePLString("NoCloseButton");
 102         ANoBorder = WMCreatePLString("NoBorder");
 103         ANoHideOthers = WMCreatePLString("NoHideOthers");
 104         ANoMouseBindings = WMCreatePLString("NoMouseBindings");
 105         ANoKeyBindings = WMCreatePLString("NoKeyBindings");
 106         ANoAppIcon = WMCreatePLString("NoAppIcon");
 107         AKeepOnTop = WMCreatePLString("KeepOnTop");
 108         AKeepOnBottom = WMCreatePLString("KeepOnBottom");
 109         AOmnipresent = WMCreatePLString("Omnipresent");
 110         ASkipWindowList = WMCreatePLString("SkipWindowList");
 111         ASkipSwitchPanel = WMCreatePLString("SkipSwitchPanel");
 112         AKeepInsideScreen = WMCreatePLString("KeepInsideScreen");
 113         AUnfocusable = WMCreatePLString("Unfocusable");
 114         AAlwaysUserIcon = WMCreatePLString("AlwaysUserIcon");
 115         AStartMiniaturized = WMCreatePLString("StartMiniaturized");
 116         AStartHidden = WMCreatePLString("StartHidden");
 117         AStartMaximized = WMCreatePLString("StartMaximized");
 118         ADontSaveSession = WMCreatePLString("DontSaveSession");
 119         AEmulateAppIcon = WMCreatePLString("EmulateAppIcon");
 120         AFocusAcrossWorkspace = WMCreatePLString("FocusAcrossWorkspace");
 121         AFullMaximize = WMCreatePLString("FullMaximize");
 122         ASharedAppIcon = WMCreatePLString("SharedAppIcon");
 123 #ifdef XKB_BUTTON_HINT
 124         ANoLanguageButton = WMCreatePLString("NoLanguageButton");
 125 #endif
 126
 127         AStartWorkspace = WMCreatePLString("StartWorkspace");
 128
 129         AnyWindow = WMCreatePLString("*");
 130         No = WMCreatePLString("No");
 131 }
 132
 133 /* Returns the correct WMPropList, using instance+class or instance, or class, or default */
 134 static WMPropList *get_value(WMPropList * dict_win, WMPropList * dict_class, WMPropList * dict_name,
 135                              WMPropList * dict_any, WMPropList * option, WMPropList * default_value,
 136                              Bool useGlobalDefault)
 137 {
 138         WMPropList *value;
 139
 140         if (dict_win) {
 141                 value = WMGetFromPLDictionary(dict_win, option);
 142                 if (value)
 143                         return value;
 144         }
 145
 146         if (dict_name) {
 147                 value = WMGetFromPLDictionary(dict_name, option);
 148                 if (value)
 149                         return value;
 150         }
 151
 152         if (dict_class) {
 153                 value = WMGetFromPLDictionary(dict_class, option);
 154                 if (value)
 155                         return value;
 156         }
 157
 158         if (!useGlobalDefault)
 159                 return NULL;
 160
 161         if (dict_any) {
 162                 value = WMGetFromPLDictionary(dict_any, option);
 163                 if (value)
 164                         return value;
 165         }
 166
 167         return default_value;
 168 }
 169
 170 static WMPropList *get_value_from_instanceclass(char *value)
 171 {
 172         WMPropList *key, *val = NULL;
 173
 174         if (!value)
 175                 return NULL;
 176
 177         key = WMCreatePLString(value);
 178
 179         WMPLSetCaseSensitive(True);
 180
 181         if (WDWindowAttributes->dictionary)
 182                 val = key ? WMGetFromPLDictionary(WDWindowAttributes->dictionary, key) : NULL;
 183
 184         if (key)
 185                 WMReleasePropList(key);
 186
 187         WMPLSetCaseSensitive(False);
 188
 189         return val;
 190 }
 191
 192 /*
 193  *----------------------------------------------------------------------
 194  * wDefaultFillAttributes--
 195  *      Retrieves attributes for the specified instance/class and
 196  * fills attr with it. Values that are actually defined are also
 197  * set in mask. If useGlobalDefault is True, the default for
 198  * all windows ("*") will be used for when no values are found
 199  * for that instance/class.
 200  *
 201  *----------------------------------------------------------------------
 202  */
 203 void wDefaultFillAttributes(char *instance, char *class,
 204                             WWindowAttributes *attr, WWindowAttributes *mask,
 205                             Bool useGlobalDefault)
 206 {
 207         WMPropList *value, *dw, *dc, *dn, *da;
 208         char *buffer;
 209
 210         dw = dc = dn = da = NULL;
 211
 212         if (!ANoTitlebar)
 213                 init_wdefaults();
 214
 215         if (class && instance) {
 216                 buffer = StrConcatDot(instance, class);
 217                 dw = get_value_from_instanceclass(buffer);
 218                 wfree(buffer);
 219         }
 220
 221         dn = get_value_from_instanceclass(instance);
 222         dc = get_value_from_instanceclass(class);
 223
 224         WMPLSetCaseSensitive(True);
 225
 226         if ((WDWindowAttributes->dictionary) && (useGlobalDefault))
 227                 da = WMGetFromPLDictionary(WDWindowAttributes->dictionary, AnyWindow);
 228
 229         /* get the data */
 230         value = get_value(dw, dc, dn, da, ANoTitlebar, No, useGlobalDefault);
 231         APPLY_VAL(value, no_titlebar, ANoTitlebar);
 232
 233         value = get_value(dw, dc, dn, da, ANoResizebar, No, useGlobalDefault);
 234         APPLY_VAL(value, no_resizebar, ANoResizebar);
 235
 236         value = get_value(dw, dc, dn, da, ANoMiniaturizeButton, No, useGlobalDefault);
 237         APPLY_VAL(value, no_miniaturize_button, ANoMiniaturizeButton);
 238
 239         value = get_value(dw, dc, dn, da, ANoMiniaturizable, No, useGlobalDefault);
 240         APPLY_VAL(value, no_miniaturizable, ANoMiniaturizable);
 241
 242         value = get_value(dw, dc, dn, da, ANoCloseButton, No, useGlobalDefault);
 243         APPLY_VAL(value, no_close_button, ANoCloseButton);
 244
 245         value = get_value(dw, dc, dn, da, ANoBorder, No, useGlobalDefault);
 246         APPLY_VAL(value, no_border, ANoBorder);
 247
 248         value = get_value(dw, dc, dn, da, ANoHideOthers, No, useGlobalDefault);
 249         APPLY_VAL(value, no_hide_others, ANoHideOthers);
 250
 251         value = get_value(dw, dc, dn, da, ANoMouseBindings, No, useGlobalDefault);
 252         APPLY_VAL(value, no_bind_mouse, ANoMouseBindings);
 253
 254         value = get_value(dw, dc, dn, da, ANoKeyBindings, No, useGlobalDefault);
 255         APPLY_VAL(value, no_bind_keys, ANoKeyBindings);
 256
 257         value = get_value(dw, dc, dn, da, ANoAppIcon, No, useGlobalDefault);
 258         APPLY_VAL(value, no_appicon, ANoAppIcon);
 259
 260         value = get_value(dw, dc, dn, da, ASharedAppIcon, No, useGlobalDefault);
 261         APPLY_VAL(value, shared_appicon, ASharedAppIcon);
 262
 263         value = get_value(dw, dc, dn, da, AKeepOnTop, No, useGlobalDefault);
 264         APPLY_VAL(value, floating, AKeepOnTop);
 265
 266         value = get_value(dw, dc, dn, da, AKeepOnBottom, No, useGlobalDefault);
 267         APPLY_VAL(value, sunken, AKeepOnBottom);
 268
 269         value = get_value(dw, dc, dn, da, AOmnipresent, No, useGlobalDefault);
 270         APPLY_VAL(value, omnipresent, AOmnipresent);
 271
 272         value = get_value(dw, dc, dn, da, ASkipWindowList, No, useGlobalDefault);
 273         APPLY_VAL(value, skip_window_list, ASkipWindowList);
 274
 275         value = get_value(dw, dc, dn, da, ASkipSwitchPanel, No, useGlobalDefault);
 276         APPLY_VAL(value, skip_switchpanel, ASkipSwitchPanel);
 277
 278         value = get_value(dw, dc, dn, da, AKeepInsideScreen, No, useGlobalDefault);
 279         APPLY_VAL(value, dont_move_off, AKeepInsideScreen);
 280
 281         value = get_value(dw, dc, dn, da, AUnfocusable, No, useGlobalDefault);
 282         APPLY_VAL(value, no_focusable, AUnfocusable);
 283
 284         value = get_value(dw, dc, dn, da, AAlwaysUserIcon, No, useGlobalDefault);
 285         APPLY_VAL(value, always_user_icon, AAlwaysUserIcon);
 286
 287         value = get_value(dw, dc, dn, da, AStartMiniaturized, No, useGlobalDefault);
 288         APPLY_VAL(value, start_miniaturized, AStartMiniaturized);
 289
 290         value = get_value(dw, dc, dn, da, AStartHidden, No, useGlobalDefault);
 291         APPLY_VAL(value, start_hidden, AStartHidden);
 292
 293         value = get_value(dw, dc, dn, da, AStartMaximized, No, useGlobalDefault);
 294         APPLY_VAL(value, start_maximized, AStartMaximized);
 295
 296         value = get_value(dw, dc, dn, da, ADontSaveSession, No, useGlobalDefault);
 297         APPLY_VAL(value, dont_save_session, ADontSaveSession);
 298
 299         value = get_value(dw, dc, dn, da, AEmulateAppIcon, No, useGlobalDefault);
 300         APPLY_VAL(value, emulate_appicon, AEmulateAppIcon);
 301
 302         value = get_value(dw, dc, dn, da, AFocusAcrossWorkspace, No, useGlobalDefault);
 303         APPLY_VAL(value, focus_across_wksp, AFocusAcrossWorkspace);
 304
 305         value = get_value(dw, dc, dn, da, AFullMaximize, No, useGlobalDefault);
 306         APPLY_VAL(value, full_maximize, AFullMaximize);
 307
 308 #ifdef XKB_BUTTON_HINT
 309         value = get_value(dw, dc, dn, da, ANoLanguageButton, No, useGlobalDefault);
 310         APPLY_VAL(value, no_language_button, ANoLanguageButton);
 311 #endif
 312
 313         /* clean up */
 314         WMPLSetCaseSensitive(False);
 315 }
 316
 317 static WMPropList *get_generic_value(char *instance, char *class,
 318                                      WMPropList *option, Bool noDefault)
 319 {
 320         WMPropList *value, *key, *dict;
 321
 322         value = NULL;
 323
 324         WMPLSetCaseSensitive(True);
 325
 326         /* Search the icon name using class and instance */
 327         if (class && instance) {
 328                 char *buffer;
 329
 330                 buffer = wmalloc(strlen(class) + strlen(instance) + 2);
 331                 sprintf(buffer, "%s.%s", instance, class);
 332                 key = WMCreatePLString(buffer);
 333                 wfree(buffer);
 334
 335                 dict = WMGetFromPLDictionary(WDWindowAttributes->dictionary, key);
 336                 WMReleasePropList(key);
 337
 338                 if (dict)
 339                         value = WMGetFromPLDictionary(dict, option);
 340         }
 341
 342         /* Search the icon name using instance */
 343         if (!value && instance) {
 344                 key = WMCreatePLString(instance);
 345
 346                 dict = WMGetFromPLDictionary(WDWindowAttributes->dictionary, key);
 347                 WMReleasePropList(key);
 348
 349                 if (dict)
 350                         value = WMGetFromPLDictionary(dict, option);
 351         }
 352
 353         /* Search the icon name using class */
 354         if (!value && class) {
 355                 key = WMCreatePLString(class);
 356
 357                 dict = WMGetFromPLDictionary(WDWindowAttributes->dictionary, key);
 358                 WMReleasePropList(key);
 359
 360                 if (dict)
 361                         value = WMGetFromPLDictionary(dict, option);
 362         }
 363
 364         /* Search the default icon name - See noDefault argument! */
 365         if (!value && !noDefault) {
 366                 /* AnyWindow is "*" - see wdefaults.c */
 367                 dict = WMGetFromPLDictionary(WDWindowAttributes->dictionary, AnyWindow);
 368
 369                 if (dict)
 370                         value = WMGetFromPLDictionary(dict, option);
 371         }
 372
 373         WMPLSetCaseSensitive(False);
 374
 375         return value;
 376 }
 377
 378 /* Get the file name of the image, using instance and class */
 379 char *get_default_icon_filename(WScreen *scr, char *winstance, char *wclass, char *command,
 380                                 Bool noDefault)
 381 {
 382         char *file_name = NULL;
 383         char *file_path = NULL;
 384
 385         /* Get the file name of the image, using instance and class */
 386         file_name = wDefaultGetIconFile(winstance, wclass, noDefault);
 387
 388         /* If the specific (or generic if noDefault is False) icon filename
 389          * is not found, and command is specified, then include the .app icons
 390          * and re-do the search, but now always including the default icon
 391          * so the icon is found always. The .app is selected before default */
 392         if (!file_name && scr && command) {
 393                 wApplicationExtractDirPackIcon(scr, command, winstance, wclass);
 394                 file_name = wDefaultGetIconFile(winstance, wclass, False);
 395         }
 396
 397         /* Get the full path for the image file */
 398         if (file_name) {
 399                 file_path = FindImage(wPreferences.icon_path, file_name);
 400
 401                 if (!file_path)
 402                         wwarning(_("could not find icon file \"%s\""), file_name);
 403
 404                 /* FIXME: Here, if file_path don't exists, then the icon is in the
 405                  * "icon database" (WDWindowAttributes->dictionary), but the icon
 406                  * is not en disk. Therefore, we should remove it from the icon
 407                  * database.
 408                  * OTOH, probably the correct message should be "could not find the
 409                  * icon file %s, please, check your configuration files", because
 410                  * the icons are loaded in the icon database from the configuration
 411                  * files
 412                  */
 413
 414                 /* Don't wfree(file_name) here, because is a pointer to the icon
 415                  * dictionary (WDWindowAttributes->dictionary) value.
 416                  */
 417         }
 418
 419         return file_path;
 420 }
 421
 422 /* This function returns the image picture for the file_name file */
 423 RImage *get_default_icon_rimage(WScreen *scr, char *file_name, int max_size)
 424 {
 425         RImage *image = NULL;
 426
 427         if (!file_name)
 428                 return NULL;
 429
 430         image = RLoadImage(scr->rcontext, file_name, 0);
 431         if (!image)
 432                 wwarning(_("error loading image file \"%s\": %s"), file_name,
 433                          RMessageForError(RErrorCode));
 434
 435         image = wIconValidateIconSize(image, max_size);
 436
 437         return image;
 438 }
 439
 440 RImage *wDefaultGetImage(WScreen * scr, char *winstance, char *wclass, int max_size)
 441 {
 442         char *file_name = NULL;
 443
 444         /* Get the file name of the image, using instance and class */
 445         file_name = get_default_icon_filename(scr, winstance, wclass, NULL, False);
 446         if (!file_name)
 447                 return NULL;
 448
 449         return get_default_icon_rimage(scr, file_name, max_size);
 450 }
 451
 452 int wDefaultGetStartWorkspace(WScreen * scr, char *instance, char *class)
 453 {
 454         WMPropList *value;
 455         int w;
 456         char *tmp;
 457
 458         if (!ANoTitlebar)
 459                 init_wdefaults();
 460
 461         if (!WDWindowAttributes->dictionary)
 462                 return -1;
 463
 464         value = get_generic_value(instance, class, AStartWorkspace, False);
 465
 466         if (!value)
 467                 return -1;
 468
 469         tmp = getString(AStartWorkspace, value);
 470
 471         if (!tmp || strlen(tmp) == 0)
 472                 return -1;
 473
 474         /* Get the workspace number for the workspace name */
 475         w = wGetWorkspaceNumber(scr, tmp);
 476
 477         return w;
 478 }
 479
 480 /* Get the name of the Icon File. If noDefault is False, then, default value included */
 481 char *wDefaultGetIconFile(char *instance, char *class, Bool noDefault)
 482 {
 483         WMPropList *value;
 484         char *tmp;
 485
 486         if (!ANoTitlebar)
 487                 init_wdefaults();
 488
 489         if (!WDWindowAttributes || !WDWindowAttributes->dictionary)
 490                 return NULL;
 491
 492         value = get_generic_value(instance, class, AIcon, noDefault);
 493
 494         if (!value)
 495                 return NULL;
 496
 497         tmp = getString(AIcon, value);
 498
 499         return tmp;
 500 }
 501
 502 void wDefaultChangeIcon(WScreen * scr, char *instance, char *class, char *file)
 503 {
 504         WDDomain *db = WDWindowAttributes;
 505         WMPropList *icon_value = NULL, *value, *attr, *key, *def_win, *def_icon = NULL;
 506         WMPropList *dict = db->dictionary;
 507         int same = 0;
 508
 509         if (!dict) {
 510                 dict = WMCreatePLDictionary(NULL, NULL);
 511                 if (dict)
 512                         db->dictionary = dict;
 513                 else
 514                         return;
 515         }
 516
 517         WMPLSetCaseSensitive(True);
 518
 519         if (instance && class) {
 520                 char *buffer;
 521
 522                 buffer = StrConcatDot(instance, class);
 523                 key = WMCreatePLString(buffer);
 524                 wfree(buffer);
 525         } else if (instance) {
 526                 key = WMCreatePLString(instance);
 527         } else if (class) {
 528                 key = WMCreatePLString(class);
 529         } else {
 530                 key = WMRetainPropList(AnyWindow);
 531         }
 532
 533         if (file) {
 534                 value = WMCreatePLString(file);
 535                 icon_value = WMCreatePLDictionary(AIcon, value, NULL);
 536                 WMReleasePropList(value);
 537
 538                 if ((def_win = WMGetFromPLDictionary(dict, AnyWindow)) != NULL)
 539                         def_icon = WMGetFromPLDictionary(def_win, AIcon);
 540
 541                 if (def_icon && !strcmp(WMGetFromPLString(def_icon), file))
 542                         same = 1;
 543         }
 544
 545         if ((attr = WMGetFromPLDictionary(dict, key)) != NULL) {
 546                 if (WMIsPLDictionary(attr)) {
 547                         if (icon_value != NULL && !same)
 548                                 WMMergePLDictionaries(attr, icon_value, False);
 549                         else
 550                                 WMRemoveFromPLDictionary(attr, AIcon);
 551                 }
 552         } else if (icon_value != NULL && !same) {
 553                 WMPutInPLDictionary(dict, key, icon_value);
 554         }
 555
 556         if (!wPreferences.flags.noupdates)
 557                 UpdateDomainFile(db);
 558
 559         WMReleasePropList(key);
 560         if (icon_value)
 561                 WMReleasePropList(icon_value);
 562
 563         WMPLSetCaseSensitive(False);
 564 }
 565
 566 /* --------------------------- Local ----------------------- */
 567
 568 static int getBool(WMPropList * key, WMPropList * value)
 569 {
 570         char *val;
 571
 572         if (!WMIsPLString(value)) {
 573                 wwarning(_("Wrong option format for key \"%s\". Should be %s."),
 574                          WMGetFromPLString(key), "Boolean");
 575                 return 0;
 576         }
 577         val = WMGetFromPLString(value);
 578
 579         if ((val[1] == '\0' && (val[0] == 'y' || val[0] == 'Y' || val[0] == 'T' || val[0] == 't' || val[0] == '1'))
 580             || (strcasecmp(val, "YES") == 0 || strcasecmp(val, "TRUE") == 0)) {
 581
 582                 return 1;
 583         } else if ((val[1] == '\0'
 584                     && (val[0] == 'n' || val[0] == 'N' || val[0] == 'F' || val[0] == 'f' || val[0] == '0'))
 585                    || (strcasecmp(val, "NO") == 0 || strcasecmp(val, "FALSE") == 0)) {
 586
 587                 return 0;
 588         } else {
 589                 wwarning(_("can't convert \"%s\" to boolean"), val);
 590                 /* We return False if we can't convert to BOOLEAN.
 591                  * This is because all options defaults to False.
 592                  * -1 is not checked and thus is interpreted as True,
 593                  * which is not good.*/
 594                 return 0;
 595         }
 596 }
 597
 598 /* WARNING: Do not free the value returned by this function!! */
 599 static char *getString(WMPropList * key, WMPropList * value)
 600 {
 601         if (!WMIsPLString(value)) {
 602                 wwarning(_("Wrong option format for key \"%s\". Should be %s."), WMGetFromPLString(key), "String");
 603                 return NULL;
 604         }
 605
 606         return WMGetFromPLString(value);
 607 }