diff options
author | Bilal Elmoussaoui <belmouss@redhat.com> | 2022-05-26 15:38:32 +0200 |
---|---|---|
committer | Bilal Elmoussaoui <belmouss@redhat.com> | 2022-05-26 15:40:44 +0200 |
commit | 0253df7f5e0d4cf1dd31e28e013de2473790b801 (patch) | |
tree | 38e71a21825a913d6367b855cb6a334d0a58674d | |
parent | e83491d9b96c92f2edc6aa55fb30ae9d2f1e993b (diff) | |
download | mutter-bilelmoussaoui/libxcursor.tar.gz |
Core: Include a small subset of xcursor in-treebilelmoussaoui/libxcursor
For a Wayland only build, we would like to avoid linking against libXucrsor
which on it turn, links back to all the X11.
In order to achieve that, we include a small subset of xcursor that
is needed for a Wayland only build cursor loading.
In case Mutter is built with X11 or with both Wayland & X11, we link against
libXcursor and don't make use of the in-tree implementation.
This patch mimics what GTK 4 do by shipping an in-tree copy of xcursor.
Especially that libwayland-cursor doesn't provide an alternative to xcursor
itself.
-rw-r--r-- | src/backends/meta-cursor-sprite-xcursor.c | 4 | ||||
-rw-r--r-- | src/backends/meta-cursor-sprite-xcursor.h | 6 | ||||
-rw-r--r-- | src/core/xcursor.c | 775 | ||||
-rw-r--r-- | src/core/xcursor.h | 320 | ||||
-rw-r--r-- | src/meson.build | 8 |
5 files changed, 1113 insertions, 0 deletions
diff --git a/src/backends/meta-cursor-sprite-xcursor.c b/src/backends/meta-cursor-sprite-xcursor.c index 742e1a0bf..8659eec2d 100644 --- a/src/backends/meta-cursor-sprite-xcursor.c +++ b/src/backends/meta-cursor-sprite-xcursor.c @@ -95,6 +95,7 @@ translate_meta_cursor (MetaCursor cursor) return NULL; } +#ifdef HAVE_X11_CLIENT static Cursor create_blank_cursor (Display *xdisplay) { @@ -121,6 +122,7 @@ create_blank_cursor (Display *xdisplay) return cursor; } +#endif static XcursorImages * create_blank_cursor_images (void) @@ -143,6 +145,7 @@ meta_cursor_sprite_xcursor_get_cursor (MetaCursorSpriteXcursor *sprite_xcursor) return sprite_xcursor->cursor; } +#ifdef HAVE_X11_CLIENT Cursor meta_create_x_cursor (Display *xdisplay, MetaCursor cursor) @@ -152,6 +155,7 @@ meta_create_x_cursor (Display *xdisplay, return XcursorLibraryLoadCursor (xdisplay, translate_meta_cursor (cursor)); } +#endif static XcursorImages * load_cursor_on_client (MetaCursor cursor, int scale) diff --git a/src/backends/meta-cursor-sprite-xcursor.h b/src/backends/meta-cursor-sprite-xcursor.h index dcb74817c..5361ce5a8 100644 --- a/src/backends/meta-cursor-sprite-xcursor.h +++ b/src/backends/meta-cursor-sprite-xcursor.h @@ -20,7 +20,11 @@ #define META_CURSOR_SPRITE_XCURSOR_H #include <glib-object.h> +#ifdef HAVE_X11_CLIENT #include <X11/Xcursor/Xcursor.h> +#else +#include "core/xcursor.h" +#endif #include "backends/meta-cursor.h" #include "meta/types.h" @@ -39,7 +43,9 @@ MetaCursor meta_cursor_sprite_xcursor_get_cursor (MetaCursorSpriteXcursor *sprit XcursorImage * meta_cursor_sprite_xcursor_get_current_image (MetaCursorSpriteXcursor *sprite_xcursor); +#ifdef HAVE_X11_CLIENT Cursor meta_create_x_cursor (Display *xdisplay, MetaCursor cursor); +#endif #endif /* META_CURSOR_SPRITE_XCURSOR_H */ diff --git a/src/core/xcursor.c b/src/core/xcursor.c new file mode 100644 index 000000000..d7d4ec2e7 --- /dev/null +++ b/src/core/xcursor.c @@ -0,0 +1,775 @@ +/* + * Copyright © 2002 Keith Packard + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice (including the + * next paragraph) shall be included in all copies or substantial + * portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS + * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN + * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * + * A slightly modified version of XCursor used with Wayland only builds. + */ + +#include "xcursor.h" +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <dirent.h> +#include <glib.h> + + +static void +XcursorImagesSetName (XcursorImages *images, + const char *name) +{ + char *new; + + if (!images || !name) + return; + + new = strdup (name); + + if (!new) + return; + + if (images->name) + free (images->name); + images->name = new; +} + +static void +_XcursorAddPathElt (char *path, + const char *elt, + int len) +{ + gsize pathlen = strlen (path); + + /* append / if the path doesn't currently have one */ + if (path[0] == '\0' || path[pathlen - 1] != '/') + { + strcat (path, "/"); + pathlen++; + } + if (len == -1) + len = (int)strlen (elt); + /* strip leading slashes */ + while (len && elt[0] == '/') + { + elt++; + len--; + } + strncpy (path + pathlen, elt, (gsize)len); + path[pathlen + (gsize)len] = '\0'; +} + +static char * +_XcursorThemeInherits (const char *full) +{ + char line[8192]; + char *result = NULL; + FILE *f; + + if (!full) + return NULL; + + f = fopen (full, "r"); + if (f) + { + while (fgets (line, sizeof(line), f)) + { + if (!strncmp (line, "Inherits", 8)) + { + char *l = line + 8; + while (*l == ' ') + l++; + if (*l != '=') + continue; + l++; + while (*l == ' ') + l++; + result = malloc (strlen (l) + 1); + if (result) + { + char *r = result; + while (*l) + { + while (XcursorSep (*l) || XcursorWhite (*l)) + l++; + if (!*l) + break; + if (r != result) + *r++ = ':'; + while (*l && !XcursorWhite (*l) && !XcursorSep (*l)) + *r++ = *l++; + } + *r++ = '\0'; + } + break; + } + } + fclose(f); + } + return result; +} + +static char * +_XcursorBuildFullname (const char *dir, + const char *subdir, + const char *file) +{ + char *full; + + if (!dir || !subdir || !file) + return NULL; + + full = malloc (strlen (dir) + 1 + strlen (subdir) + 1 + strlen (file) + 1); + if (!full) + return NULL; + full[0] = '\0'; + _XcursorAddPathElt (full, dir, -1); + _XcursorAddPathElt (full, subdir, -1); + _XcursorAddPathElt (full, file, -1); + return full; +} + +static char * +_XcursorBuildThemeDir (const char *dir, + const char *theme) +{ + const char *colon; + const char *tcolon; + char *full; + char *home; + int dirlen; + int homelen; + int themelen; + int len; + + if (!dir || !theme) + return NULL; + + colon = strchr (dir, ':'); + if (!colon) + colon = dir + strlen (dir); + + dirlen = (int)(colon - dir); + + tcolon = strchr (theme, ':'); + if (!tcolon) + tcolon = theme + strlen (theme); + + themelen = (int)(tcolon - theme); + + home = NULL; + homelen = 0; + if (*dir == '~') + { + home = getenv ("HOME"); + if (!home) + return NULL; + homelen = (int)strlen (home); + dir++; + dirlen--; + } + + /* + * add space for any needed directory separators, one per component, + * and one for the trailing null + */ + len = 1 + homelen + 1 + dirlen + 1 + themelen + 1; + + full = malloc ((gsize)len); + if (!full) + return NULL; + full[0] = '\0'; + + if (home) + _XcursorAddPathElt (full, home, -1); + _XcursorAddPathElt (full, dir, dirlen); + _XcursorAddPathElt (full, theme, themelen); + return full; +} + +static const char * +_XcursorNextPath (const char *path) +{ + char *colon = strchr (path, ':'); + + if (!colon) + return NULL; + return colon + 1; +} + +static int +XcursorLibraryShape (const char *library) +{ + int low, high; + + low = 0; + high = NUM_STANDARD_NAMES - 1; + while (low < high - 1) + { + int mid = (low + high) >> 1; + int c = strcmp (library, STANDARD_NAME(mid)); + if (c == 0) + return (mid << 1); + if (c > 0) + low = mid; + else + high = mid; + } + while (low <= high) + { + if (!strcmp (library, STANDARD_NAME (low))) + return (low << 1); + low++; + } + return -1; +} + +static const char * +XcursorLibraryPath (void) +{ + static const char *path; + + if (!path) + { + path = getenv ("XCURSOR_PATH"); + if (!path) + path = XCURSORPATH; + } + return path; +} + +static FILE * +XcursorScanTheme (const char *theme, + const char *name) +{ + FILE *f = NULL; + char *full; + char *dir; + const char *path; + XcursorInherit inherits[MAX_INHERITS_DEPTH + 1]; + int d; + + if (!theme || !name) + return NULL; + + /* + * XCURSOR_CORE_THEME is a magic name; cursors from the core set + * are never found in any directory. Instead, a magic value is + * returned which truncates any search so that overlying functions + * can switch to equivalent core cursors + */ + if (!strcmp (theme, XCURSOR_CORE_THEME) && XcursorLibraryShape (name) >= 0) + return XCURSOR_SCAN_CORE; + + memset (inherits, 0, sizeof(inherits)); + + d = 0; + inherits[d].theme = theme; + + while (f == NULL && d >= 0 && inherits[d].theme != NULL) + { + /* + * Scan this theme + */ + for (path = XcursorLibraryPath (); + path && f == NULL; + path = _XcursorNextPath (path)) + { + dir = _XcursorBuildThemeDir (path, inherits[d].theme); + if (dir) + { + full = _XcursorBuildFullname (dir, "cursors", name); + if (full) + { + f = fopen (full, "r"); + free (full); + } + if (!f && inherits[d + 1].line == NULL) + { + if (d + 1 >= MAX_INHERITS_DEPTH) + { + free (dir); + goto finish; + } + full = _XcursorBuildFullname (dir, "", "index.theme"); + if (full) + { + inherits[d + 1].line = _XcursorThemeInherits (full); + inherits[d + 1].theme = inherits[d + 1].line; + free (full); + } + } + free (dir); + } + } + + d++; + while (d > 0 && inherits[d].theme == NULL) + { + free(inherits[d].line); + inherits[d].line = NULL; + + if (--d == 0) + inherits[d].theme = NULL; + else + inherits[d].theme = _XcursorNextPath (inherits[d].theme); + } + + /* + * Detect and break self reference loop early on. + */ + if (inherits[d].theme != NULL && strcmp (inherits[d].theme, theme) == 0) + break; + } + +finish: + for (d = 1; d <= MAX_INHERITS_DEPTH; d++) + free (inherits[d].line); + + return f; +} + +/* + * From libXcursor/src/file.c + */ + +XcursorImage * +XcursorImageCreate (int width, + int height) +{ + XcursorImage *image; + + if (width < 0 || height < 0) + return NULL; + if (width > XCURSOR_IMAGE_MAX_SIZE || height > XCURSOR_IMAGE_MAX_SIZE) + return NULL; + + image = malloc (sizeof(XcursorImage) + width * height * sizeof(XcursorPixel)); + if (!image) + return NULL; + image->version = XCURSOR_IMAGE_VERSION; + image->pixels = (XcursorPixel *)(image + 1); + image->size = width > height ? width : height; + image->width = width; + image->height = height; + image->delay = 0; + return image; +} + +void +XcursorImageDestroy(XcursorImage *image) +{ + free (image); +} + +XcursorImages * +XcursorImagesCreate(int size) +{ + XcursorImages *images; + + images = malloc (sizeof(XcursorImages) + size * sizeof(XcursorImage *)); + if (!images) + return NULL; + images->nimage = 0; + images->images = (XcursorImage **)(images + 1); + images->name = NULL; + return images; +} + +void XcursorImagesDestroy (XcursorImages *images) +{ + int n; + + if (!images) + return; + + for (n = 0; n < images->nimage; n++) + XcursorImageDestroy (images->images[n]); + if (images->name) + free (images->name); + free (images); +} + +static gboolean +_XcursorReadUInt (XcursorFile *file, + unsigned int *u) +{ + unsigned char bytes[4]; + + if (!file || !u) + return FALSE; + + if ((*file->read)(file, bytes, 4) != 4) + return FALSE; + *u = ((bytes[0] << 0) | + (bytes[1] << 8) | + (bytes[2] << 16) | + (bytes[3] << 24)); + return TRUE; +} + +static void +_XcursorFileHeaderDestroy (XcursorFileHeader *fileHeader) +{ + free (fileHeader); +} + +static XcursorFileHeader * +_XcursorFileHeaderCreate (int ntoc) +{ + XcursorFileHeader *fileHeader; + + if (ntoc > 0x10000) + return NULL; + fileHeader = malloc (sizeof(XcursorFileHeader) + ntoc * sizeof(XcursorFileToc)); + if (!fileHeader) + return NULL; + fileHeader->magic = XCURSOR_MAGIC; + fileHeader->header = XCURSOR_FILE_HEADER_LEN; + fileHeader->version = XCURSOR_FILE_VERSION; + fileHeader->ntoc = ntoc; + fileHeader->tocs = (XcursorFileToc *)(fileHeader + 1); + return fileHeader; +} + +static XcursorFileHeader * +_XcursorReadFileHeader (XcursorFile *file) +{ + XcursorFileHeader head, *fileHeader; + unsigned int skip; + unsigned int n; + + if (!file) + return NULL; + + if (!_XcursorReadUInt (file, &head.magic)) + return NULL; + if (head.magic != XCURSOR_MAGIC) + return NULL; + if (!_XcursorReadUInt (file, &head.header)) + return NULL; + if (!_XcursorReadUInt (file, &head.version)) + return NULL; + if (!_XcursorReadUInt (file, &head.ntoc)) + return NULL; + skip = head.header - XCURSOR_FILE_HEADER_LEN; + if (skip) + if ((*file->seek)(file, skip, SEEK_CUR) == EOF) + return NULL; + fileHeader = _XcursorFileHeaderCreate (head.ntoc); + if (!fileHeader) + return NULL; + fileHeader->magic = head.magic; + fileHeader->header = head.header; + fileHeader->version = head.version; + fileHeader->ntoc = head.ntoc; + for (n = 0; n < fileHeader->ntoc; n++) + { + if (!_XcursorReadUInt (file, &fileHeader->tocs[n].type)) + break; + if (!_XcursorReadUInt (file, &fileHeader->tocs[n].subtype)) + break; + if (!_XcursorReadUInt (file, &fileHeader->tocs[n].position)) + break; + } + if (n != fileHeader->ntoc) + { + _XcursorFileHeaderDestroy (fileHeader); + return NULL; + } + return fileHeader; +} + +static gboolean +_XcursorSeekToToc (XcursorFile *file, + XcursorFileHeader *fileHeader, + int toc) +{ + if (!file || !fileHeader || + (*file->seek)(file, fileHeader->tocs[toc].position, SEEK_SET) == EOF) + return FALSE; + return TRUE; +} + +static gboolean +_XcursorFileReadChunkHeader (XcursorFile *file, + XcursorFileHeader *fileHeader, + int toc, + XcursorChunkHeader *chunkHeader) +{ + if (!file || !fileHeader || !chunkHeader) + return FALSE; + if (!_XcursorSeekToToc (file, fileHeader, toc)) + return FALSE; + if (!_XcursorReadUInt (file, &chunkHeader->header)) + return FALSE; + if (!_XcursorReadUInt (file, &chunkHeader->type)) + return FALSE; + if (!_XcursorReadUInt (file, &chunkHeader->subtype)) + return FALSE; + if (!_XcursorReadUInt (file, &chunkHeader->version)) + return FALSE; + /* sanity check */ + if (chunkHeader->type != fileHeader->tocs[toc].type || + chunkHeader->subtype != fileHeader->tocs[toc].subtype) + return FALSE; + return TRUE; +} + +#define dist(a, b) ((a) > (b) ? (a) - (b) : (b) - (a)) + +static unsigned int +_XcursorFindBestSize (XcursorFileHeader *fileHeader, + unsigned int size, + int *nsizesp) +{ + unsigned int n; + int nsizes = 0; + unsigned int bestSize = 0; + unsigned int thisSize; + + if (!fileHeader || !nsizesp) + return 0; + + for (n = 0; n < fileHeader->ntoc; n++) + { + if (fileHeader->tocs[n].type != XCURSOR_IMAGE_TYPE) + continue; + thisSize = fileHeader->tocs[n].subtype; + if (!bestSize || dist (thisSize, size) < dist (bestSize, size)) + { + bestSize = thisSize; + nsizes = 1; + } + else if (thisSize == bestSize) + nsizes++; + } + *nsizesp = nsizes; + return bestSize; +} + +static int +_XcursorFindImageToc (XcursorFileHeader *fileHeader, + unsigned int size, + int count) +{ + unsigned int toc; + unsigned int thisSize; + + if (!fileHeader) + return 0; + + for (toc = 0; toc < fileHeader->ntoc; toc++) + { + if (fileHeader->tocs[toc].type != XCURSOR_IMAGE_TYPE) + continue; + thisSize = fileHeader->tocs[toc].subtype; + if (thisSize != size) + continue; + if (!count) + break; + count--; + } + if (toc == fileHeader->ntoc) + return -1; + return toc; +} + +static XcursorImage * +_XcursorReadImage (XcursorFile *file, + XcursorFileHeader *fileHeader, + int toc) +{ + XcursorChunkHeader chunkHeader; + XcursorImage head; + XcursorImage *image; + int n; + XcursorPixel *p; + + if (!file || !fileHeader) + return NULL; + + if (!_XcursorFileReadChunkHeader (file, fileHeader, toc, &chunkHeader)) + return NULL; + if (!_XcursorReadUInt (file, &head.width)) + return NULL; + if (!_XcursorReadUInt (file, &head.height)) + return NULL; + if (!_XcursorReadUInt (file, &head.xhot)) + return NULL; + if (!_XcursorReadUInt (file, &head.yhot)) + return NULL; + if (!_XcursorReadUInt (file, &head.delay)) + return NULL; + /* sanity check data */ + if (head.width > XCURSOR_IMAGE_MAX_SIZE || head.height > XCURSOR_IMAGE_MAX_SIZE) + return NULL; + if (head.width == 0 || head.height == 0) + return NULL; + if (head.xhot > head.width || head.yhot > head.height) + return NULL; + + /* Create the image and initialize it */ + image = XcursorImageCreate (head.width, head.height); + if (image == NULL) + return NULL; + if (chunkHeader.version < image->version) + image->version = chunkHeader.version; + image->size = chunkHeader.subtype; + image->xhot = head.xhot; + image->yhot = head.yhot; + image->delay = head.delay; + n = image->width * image->height; + p = image->pixels; + while (n--) + { + if (!_XcursorReadUInt (file, p)) + { + XcursorImageDestroy (image); + return NULL; + } + p++; + } + return image; +} + +static XcursorImages * +XcursorXcFileLoadImages (XcursorFile *file, + int size) +{ + XcursorFileHeader *fileHeader; + unsigned int bestSize; + int nsize; + XcursorImages *images; + int n; + int toc; + + if (!file || size < 0) + return NULL; + fileHeader = _XcursorReadFileHeader (file); + if (!fileHeader) + return NULL; + bestSize = _XcursorFindBestSize (fileHeader, ( unsigned int)size, &nsize); + if (!bestSize) + { + _XcursorFileHeaderDestroy (fileHeader); + return NULL; + } + images = XcursorImagesCreate (nsize); + if (!images) + { + _XcursorFileHeaderDestroy (fileHeader); + return NULL; + } + for (n = 0; n < nsize; n++) + { + toc = _XcursorFindImageToc (fileHeader, bestSize, n); + if (toc < 0) + break; + images->images[images->nimage] = _XcursorReadImage (file, fileHeader, + toc); + if (!images->images[images->nimage]) + break; + images->nimage++; + } + _XcursorFileHeaderDestroy (fileHeader); + if (images->nimage != nsize) + { + XcursorImagesDestroy (images); + images = NULL; + } + return images; +} + +static int +_XcursorStdioFileRead (XcursorFile *file, + unsigned char *buf, + int len) +{ + FILE *f = file->closure; + return fread (buf, 1, len, f); +} + +static int +_XcursorStdioFileWrite (XcursorFile *file, + unsigned char *buf, + int len) +{ + FILE *f = file->closure; + return fwrite (buf, 1, len, f); +} + +static int +_XcursorStdioFileSeek (XcursorFile *file, + long offset, + int whence) +{ + FILE *f = file->closure; + return fseek (f, offset, whence); +} + +static void +_XcursorStdioFileInitialize (FILE *stdfile, + XcursorFile *file) +{ + file->closure = stdfile; + file->read = _XcursorStdioFileRead; + file->write = _XcursorStdioFileWrite; + file->seek = _XcursorStdioFileSeek; +} + +static XcursorImages * +XcursorFileLoadImages (FILE *file, + int size) +{ + XcursorFile f; + + if (!file) + return NULL; + + _XcursorStdioFileInitialize (file, &f); + return XcursorXcFileLoadImages (&f, size); +} + +XcursorImages * +XcursorLibraryLoadImages (const char *file, + const char *theme, + int size) +{ + FILE *f = NULL; + XcursorImages *images = NULL; + + if (!file) + return NULL; + + if (theme) + f = XcursorScanTheme (theme, file); + if (!f) + f = XcursorScanTheme ("default", file); + if (f != NULL && f != XCURSOR_SCAN_CORE) + { + images = XcursorFileLoadImages (f, size); + if (images) + XcursorImagesSetName (images, file); + fclose (f); + } + return images; +} diff --git a/src/core/xcursor.h b/src/core/xcursor.h new file mode 100644 index 000000000..d9856132a --- /dev/null +++ b/src/core/xcursor.h @@ -0,0 +1,320 @@ +/* + * Copyright © 2002 Keith Packard + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice (including the + * next paragraph) shall be included in all copies or substantial + * portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS + * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN + * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * + * A slightly modified version of XCursor used with Wayland only builds. + */ + +#ifndef XCURSOR_H +#define XCURSOR_H + +#ifndef ICONDIR +#define ICONDIR "/usr/X11R6/lib/X11/icons" +#endif + +#ifndef XCURSORPATH +#define XCURSORPATH "~/.local/share/icons:~/.icons:/usr/share/icons:/usr/share/pixmaps:"ICONDIR +#endif + +#define XCURSOR_SCAN_CORE ((FILE *) 1) +#define XCURSOR_CORE_THEME "core" +#define MAX_INHERITS_DEPTH 32 + +static const unsigned short _XcursorStandardNameOffsets[] = { + 0, 9, 15, 32, 47, 52, 61, 80, 100, 112, 123, 134, 145, 152, 158, + 169, 175, 189, 199, 213, 217, 224, 237, 249, 261, 272, 281, 287, + 295, 301, 307, 313, 319, 324, 335, 344, 354, 363, 374, 383, 392, + 396, 409, 415, 422, 429, 434, 449, 459, 470, 480, 492, 501, 510, + 524, 542, 556, 571, 583, 601, 609, 616, 623, 632, 637, 644, 651, + 666, 682, 699, 708, 716, 721, 730, 739, 748, 754 +}; + +#define NUM_STANDARD_NAMES (sizeof _XcursorStandardNameOffsets / sizeof _XcursorStandardNameOffsets[0]) + +#define STANDARD_NAME(id) \ + _XcursorStandardNames + _XcursorStandardNameOffsets[id] + +#define XcursorWhite(c) ((c) == ' ' || (c) == '\t' || (c) == '\n') +#define XcursorSep(c) ((c) == ';' || (c) == ',') + +static const char _XcursorStandardNames[] = + "X_cursor\0" + "arrow\0" + "based_arrow_down\0" + "based_arrow_up\0" + "boat\0" + "bogosity\0" + "bottom_left_corner\0" + "bottom_right_corner\0" + "bottom_side\0" + "bottom_tee\0" + "box_spiral\0" + "center_ptr\0" + "circle\0" + "clock\0" + "coffee_mug\0" + "cross\0" + "cross_reverse\0" + "crosshair\0" + "diamond_cross\0" + "dot\0" + "dotbox\0" + "double_arrow\0" + "draft_large\0" + "draft_small\0" + "draped_box\0" + "exchange\0" + "fleur\0" + "gobbler\0" + "gumby\0" + "hand1\0" + "hand2\0" + "heart\0" + "icon\0" + "iron_cross\0" + "left_ptr\0" + "left_side\0" + "left_tee\0" + "leftbutton\0" + "ll_angle\0" + "lr_angle\0" + "man\0" + "middlebutton\0" + "mouse\0" + "pencil\0" + "pirate\0" + "plus\0" + "question_arrow\0" + "right_ptr\0" + "right_side\0" + "right_tee\0" + "rightbutton\0" + "rtl_logo\0" + "sailboat\0" + "sb_down_arrow\0" + "sb_h_double_arrow\0" + "sb_left_arrow\0" + "sb_right_arrow\0" + "sb_up_arrow\0" + "sb_v_double_arrow\0" + "shuttle\0" + "sizing\0" + "spider\0" + "spraycan\0" + "star\0" + "target\0" + "tcross\0" + "top_left_arrow\0" + "top_left_corner\0" + "top_right_corner\0" + "top_side\0" + "top_tee\0" + "trek\0" + "ul_angle\0" + "umbrella\0" + "ur_angle\0" + "watch\0" + "xterm"; + +/* + * Cursor files start with a header. The header + * contains a magic number, a version number and a + * table of contents which has type and offset information + * for the remaining tables in the file. + * + * File minor versions increment for compatible changes + * File major versions increment for incompatible changes (never, we hope) + * + * Chunks of the same type are always upward compatible. Incompatible + * changes are made with new chunk types; the old data can remain under + * the old type. Upward compatible changes can add header data as the + * header lengths are specified in the file. + * + * File: + * FileHeader + * LISTofChunk + * + * FileHeader: + * CARD32 magic magic number + * CARD32 header bytes in file header + * CARD32 version file version + * CARD32 ntoc number of toc entries + * LISTofFileToc toc table of contents + * + * FileToc: + * CARD32 type entry type + * CARD32 subtype entry subtype (size for images) + * CARD32 position absolute file position + */ + +#define XCURSOR_MAGIC 0x72756358 /* "Xcur" LSBFirst */ + +/* + * The rest of the file is a list of chunks, each tagged by type + * and version. + * + * Chunk: + * ChunkHeader + * <extra type-specific header fields> + * <type-specific data> + * + * ChunkHeader: + * CARD32 header bytes in chunk header + type header + * CARD32 type chunk type + * CARD32 subtype chunk subtype + * CARD32 version chunk type version + */ +#define XCURSOR_CHUNK_HEADER_LEN (4 * 4) + +/* + * This version number is stored in cursor files; changes to the + * file format require updating this version number + */ +#define XCURSOR_FILE_MAJOR 1 +#define XCURSOR_FILE_MINOR 0 +#define XCURSOR_FILE_VERSION ((XCURSOR_FILE_MAJOR << 16) | (XCURSOR_FILE_MINOR)) +#define XCURSOR_FILE_HEADER_LEN (4 * 4) +#define XCURSOR_FILE_TOC_LEN (3 * 4) +/* + * Here's a list of the known chunk types + */ + +/* + * Comments consist of a 4-byte length field followed by + * UTF-8 encoded text + * + * Comment: + * ChunkHeader header chunk header + * CARD32 length bytes in text + * LISTofCARD8 text UTF-8 encoded text + */ + +#define XCURSOR_COMMENT_TYPE 0xfffe0001 +#define XCURSOR_COMMENT_VERSION 1 +#define XCURSOR_COMMENT_HEADER_LEN (XCURSOR_CHUNK_HEADER_LEN + (1 *4)) +#define XCURSOR_COMMENT_COPYRIGHT 1 +#define XCURSOR_COMMENT_LICENSE 2 +#define XCURSOR_COMMENT_OTHER 3 +#define XCURSOR_COMMENT_MAX_LEN 0x100000 + +/* + * Each cursor image occupies a separate image chunk. + * The length of the image header follows the chunk header + * so that future versions can extend the header without + * breaking older applications + * + * Image: + * ChunkHeader header chunk header + * CARD32 width actual width + * CARD32 height actual height + * CARD32 xhot hot spot x + * CARD32 yhot hot spot y + * CARD32 delay animation delay + * LISTofCARD32 pixels ARGB pixels + */ +#define XCURSOR_IMAGE_TYPE 0xfffd0002 +#define XCURSOR_IMAGE_VERSION 1 +#define XCURSOR_IMAGE_MAX_SIZE 0x7fff /* 32767x32767 max cursor size */ + +typedef struct _XcursorFileToc { + unsigned int type; /* chunk type */ + unsigned int subtype; /* subtype (size for images) */ + unsigned int position; /* absolute position in file */ +} XcursorFileToc; + +typedef struct _XcursorFileHeader { + unsigned int magic; /* magic number */ + unsigned int header; /* byte length of header */ + unsigned int version; /* file version number */ + unsigned int ntoc; /* number of toc entries */ + XcursorFileToc *tocs; /* table of contents */ +} XcursorFileHeader; + +typedef struct _XcursorChunkHeader { + unsigned int header; /* bytes in chunk header */ + unsigned int type; /* chunk type */ + unsigned int subtype; /* chunk subtype (size for images) */ + unsigned int version; /* version of this type */ +} XcursorChunkHeader; + +typedef struct _XcursorComment { + unsigned int version; + unsigned int comment_type; + char *comment; +} XcursorComment; + +typedef struct _XcursorFile XcursorFile; + +struct _XcursorFile { + void *closure; + int (*read) (XcursorFile *file, unsigned char *buf, int len); + int (*write) (XcursorFile *file, unsigned char *buf, int len); + int (*seek) (XcursorFile *file, long offset, int whence); +}; + +typedef struct _XcursorComments { + int ncomment; /* number of comments */ + XcursorComment **comments; /* array of XcursorComment pointers */ +} XcursorComments; + +typedef struct _XcursorInherit { + char *line; + const char *theme; +} XcursorInherit; + + +typedef unsigned int XcursorPixel; + +typedef struct _XcursorImage { + unsigned int version; /* version of the image data */ + unsigned int size; /* nominal size for matching */ + unsigned int width; /* actual width */ + unsigned int height; /* actual height */ + unsigned int xhot; /* hot spot x (must be inside image) */ + unsigned int yhot; /* hot spot y (must be inside image) */ + unsigned int delay; /* animation delay to next frame (ms) */ + XcursorPixel *pixels; /* pointer to pixels */ +} XcursorImage; + +/* + * Other data structures exposed by the library API + */ +typedef struct _XcursorImages { + int nimage; /* number of images */ + XcursorImage **images; /* array of XcursorImage pointers */ + char *name; /* name used to load images */ +} XcursorImages; + +void XcursorImagesDestroy (XcursorImages *images); + +XcursorImages * XcursorImagesCreate (int size); + +XcursorImages * XcursorLibraryLoadImages (const char *library, + const char *theme, + int size); + +XcursorImage * XcursorImageCreate (int width, int height); + +void XcursorImageDestroy (XcursorImage *image); + +#endif diff --git a/src/meson.build b/src/meson.build index 42d7a5a55..24843c3f7 100644 --- a/src/meson.build +++ b/src/meson.build @@ -534,6 +534,14 @@ if have_remote_desktop endif if have_wayland + + if not have_x11_client + mutter_sources += [ + 'core/xcursor.c', + 'core/xcursor.h', + ] + endif + mutter_sources += [ 'compositor/meta-surface-actor-wayland.c', 'compositor/meta-surface-actor-wayland.h', |