components/x11/cmap_compact/src/cmcutil.c

   1 /*
   2 * Copyright (c) 1990, 2015, Oracle and/or its affiliates. All rights reserved.
   3 *
   4 * Permission is hereby granted, free of charge, to any person obtaining a
   5 * copy of this software and associated documentation files (the "Software"),
   6 * to deal in the Software without restriction, including without limitation
   7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 * and/or sell copies of the Software, and to permit persons to whom the
   9 * Software is furnished to do so, subject to the following conditions:
  10 *
  11 * The above copyright notice and this permission notice (including the next
  12 * paragraph) shall be included in all copies or substantial portions of the
  13 * Software.
  14 *
  15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 * DEALINGS IN THE SOFTWARE.
  22 *
  23 */
  24
  25
  26 #include <stdio.h>
  27 #include <X11/Xlib.h>
  28 #include <X11/Xatom.h>
  29 #include "cmcutil.h"
  30 #include "cmc.h"
  31
  32
  33 /*
  34 ** Common utility routines shared by the Workspace Colors programs
  35 ** cmcsave, cmcshow, cmcinit.
  36 */
  37
  38 /*ARGSUSED*/
  39 static int
  40 disp_err_handler (Display *dpy)
  41
  42 {
  43         fatal_error("cannot open display \"%s\"", display_name);
  44 }
  45
  46 /*
  47 ** Open display and handle any errors.
  48 */
  49
  50 Display *
  51 open_display (const char *dpyname)
  52 {
  53         Display *dpy;
  54
  55         /*
  56         **  Catch errors opening display so user doesn't
  57         **  get confusing 'XIOError: Broken Pipe' message.
  58         */
  59         XSetIOErrorHandler(disp_err_handler);
  60
  61         display_name = XDisplayName(dpyname);
  62         if (!(dpy = XOpenDisplay(dpyname)))
  63                 return NULL;
  64
  65         XSync(dpy, 0);
  66         XSetIOErrorHandler(NULL);
  67
  68         return dpy;
  69 }
  70
  71
  72 /*
  73 ** Return true if default visual of screen is dynamic.
  74 */
  75
  76 int
  77 dynamic_indexed_default_visual (Screen *screen)
  78 {
  79         int class = DefaultVisualOfScreen(screen)->class;
  80
  81         return (class == GrayScale      ||
  82                 class == PseudoColor);
  83 }
  84
  85 /*
  86 ** If file name is not already absolute, make absolute
  87 ** relative to home directory.
  88 */
  89
  90 static const char *
  91 fn_absolutize (const char *relname)
  92
  93 {
  94         static char     filename[256];
  95         const char      *homedir;
  96
  97         if (*relname == '/')
  98                 return relname;
  99
 100         if (!(homedir = (char *) getenv("HOME")))
 101                 homedir = "/";
 102         sprintf(filename, "%s/%s", homedir, relname);
 103         return filename;
 104 }
 105
 106
 107 const char *
 108 comp_colors_filename (const char *basename)
 109
 110 {
 111         if (!basename)
 112                 basename = COMPACTED_COLORS_FILE;
 113         return fn_absolutize(basename);
 114
 115 }
 116
 117 int
 118 cmc_write (
 119     FILE        *f,
 120     int         scr_num,
 121     int         ncolors,
 122     XColor      *colors)
 123
 124 {
 125         (void)fwrite(&scr_num, sizeof(int), 1, f);
 126         (void)fwrite(&ncolors, sizeof(int), 1, f);
 127         (void)fwrite(colors, sizeof(XColor), ncolors, f);
 128
 129         return 1;
 130 }
 131
 132
 133 /*
 134 ** 0 is returned on EOF; 1 otherwise
 135 */
 136
 137 int
 138 cmc_read (
 139     FILE        *f,
 140     int         *scr_num,
 141     int         *ncolors,
 142     XColor      **colors)
 143
 144 {
 145         if (!fread(scr_num, sizeof(int), 1, f))
 146                 return 0;
 147
 148         if (!fread(ncolors, sizeof(int), 1, f)) {
 149                 fprintf(stderr, "error: premature end-of-file\n");
 150                 fatal_error("cannot read number of saved colors");
 151         }
 152
 153         if (!(*colors = (XColor *) malloc(*ncolors * sizeof(XColor))))
 154                 fatal_error("not enough memory");
 155
 156         if (!fread(*colors, sizeof(XColor), *ncolors, f)) {
 157                 fprintf(stderr, "error: premature end-of-file\n");
 158                 fatal_error("cannot read saved colors");
 159         }
 160
 161         return 1;
 162 }
 163
 164
 165 void
 166 cmc_header_write (
 167     FILE        *f)
 168
 169 {
 170         int     value;
 171
 172         /* write magic number and version */
 173         value = CMC_MAGIC;
 174         (void)fwrite(&value, sizeof(int), 1, f);
 175         value = CMC_VERSION;
 176         (void)fwrite(&value, sizeof(int), 1, f);
 177 }
 178
 179
 180 void
 181 cmc_header_test (
 182     FILE        *f)
 183
 184 {
 185         int     value;
 186
 187         /* check magic number */
 188         if (!fread(&value, sizeof(int), 1, f) ||
 189             value != CMC_MAGIC)
 190                 fatal_error("Unrecognized colors file.  Expected magic number = %x,  \
 191 Actual = %x", CMC_MAGIC, value);
 192
 193         /* check version number */
 194         if (!fread(&value, sizeof(int), 1, f) ||
 195             value != CMC_VERSION)
 196                 fatal_error("Unrecognized colors file.  Expected version number = %x,  \
 197 Actual = %x", CMC_VERSION, value);
 198 }
 199
 200
 201 void
 202 prop_update (
 203     Display     *dpy,
 204     Window      w,
 205     const char  *name,
 206     Atom        type,
 207     int         format,
 208     int         data,
 209     int         nelem)
 210
 211 {
 212         /* intern the property name */
 213         Atom    atom = XInternAtom(dpy, name, 0);
 214
 215         /* create or replace the property */
 216         XChangeProperty(dpy, w, atom, type, format, PropModeReplace,
 217                 (unsigned char *)&data, nelem);
 218 }
 219
 220
 221 /*
 222 ** Sets the close-down mode of the cmc client to 'RetainPermanent'
 223 ** so all client resources will be preserved after the client
 224 ** exits.  Puts a property on the default root window containing
 225 ** an XID of the client so that the resources can later be killed.
 226 */
 227
 228 void
 229 resource_preserve (
 230     Display     *dpy)
 231
 232 {
 233         Window  w = DefaultRootWindow(dpy);
 234
 235         /* create dummy resource */
 236         Pixmap  pm = XCreatePixmap(dpy, w, 1, 1, 1);
 237
 238         /* create/replace the property */
 239         prop_update(dpy, w, RETAIN_PROP_NAME, XA_PIXMAP, 32, (int)pm, 1);
 240
 241         /* retain all client resources until explicitly killed */
 242         XSetCloseDownMode(dpy, RetainPermanent);
 243 }
 244
 245
 246 /*
 247 ** Flushes any resources previously retained by a cmc client,
 248 ** if any exist.
 249 */
 250
 251 void
 252 resource_discard (
 253     Display     *dpy)
 254
 255 {
 256         Pixmap  *pm;
 257         Atom    actual_type;            /* NOTUSED */
 258         int     format;
 259         unsigned long   nitems;
 260         unsigned long   bytes_after;
 261
 262         /* intern the property name */
 263         Atom    atom = XInternAtom(dpy, RETAIN_PROP_NAME, 0);
 264
 265         /* look for existing resource allocation */
 266         if (XGetWindowProperty(dpy, DefaultRootWindow(dpy), atom, 0, 1,
 267                 1/*delete*/, AnyPropertyType, &actual_type, &format, &nitems,
 268                 &bytes_after, (unsigned char **) &pm) == Success
 269             && nitems == 1) {
 270
 271                 if (actual_type == XA_PIXMAP && format == 32 &&
 272                     nitems == 1 && bytes_after == 0) {
 273                         /* blast it away */
 274                         XKillClient(dpy, *pm);
 275                         XFree(pm);
 276                 } else if (actual_type != None) {
 277                     extern char *program;
 278                     fprintf(stderr, "%s: warning: invalid format encountered for property %s\n",
 279                                  RETAIN_PROP_NAME, program);
 280                 }
 281         }
 282 }
 283
 284
 285
 286