47 Commits

Author SHA1 Message Date
2da6de7593 Rewrite WMFontPanel in Rust. 2026-04-06 19:27:30 -04:00
6c17cc3a12 Add allow(non_snake_case) for WMList and WMButton FFI functions. 2026-04-06 19:27:30 -04:00
c24a199243 Start porting the base WINGs widget type to Rust.
Porting WINGs widgets to Rust will require using some WINGs abstractions. One of them is the base widget type, which is implemented by giving all widgets a common layout (with the first two fields always being the same basic types).
2026-04-06 19:27:30 -04:00
1ea3c1b8db Reimplement the WMAddListItem macro in Rust.
This was originally a macro in C. We reimplement it as a Rust function.
2026-04-06 19:27:30 -04:00
39efd22bed Reimplment the WMCreateCommandButton macro in Rust.
This is a macro in C, and it would be helpful to be able to do the same thing in Rust. It is simply ported over as a Rust function.
2026-04-06 19:27:30 -04:00
52fc9eec43 Clean up bindgen invocation for WINGs somewhat.
This is still a mess, but it's not all in one big line now.

Going forward, commits that need new bindgen functions and types should put them on their own lines. That will make it easier to figure out which commit introduced the use of a given symbol.
2026-04-06 19:27:30 -04:00
d2a42971c8 Name the anonymous enum for WMButton behaviors.
This is needed so that bindgen cann refer to the enum properly when generating a corresponding Rust type.
2026-04-06 19:27:30 -04:00
d02d67ec61 Eliminate accidentally commited temporary file. 2026-04-06 19:27:30 -04:00
b1eca604b2 Fix false positive improper_ctypes warnings for structs that are opaque types from C. 2026-04-06 19:27:30 -04:00
797ef1ace8 Fix false positive improper_ctypes warnings for structs that are opaque types from C (#27)
This should be simple enough not to need further review. It gets rid of a bunch of warnings about struct fields defined with Rust-only types which are not visible from C.

Reviewed-on: #27
2026-04-05 19:58:39 -04:00
b5e94932c9 Update snapshot test of font panel rendering.
This accounts for a bugfix in array iteration, which had been causing font entries to be duplicated.
2026-03-31 11:20:46 -04:00
efec1e8d1e Fix off-by-one error in WMArray iteration macro behavior 2026-03-31 11:17:36 -04:00
2aa0b0bf53 Create an integration test for the WMFontPanel widget. 2026-03-26 23:48:29 -04:00
d4c8f986a6 Bump to public insta-image crate. 2026-03-26 23:47:15 -04:00
ec1761f4f3 Utilities for X11 image capture and acceptance testing.
These are put in their own crate so that we can link tests against libwings freely.

Once libwings is entirely rewritten in Rust, we should be able to move these tests back into the wings-rs crate.
2026-03-26 16:59:23 -04:00
32cf67b012 Fix panic when a handler triggers handler scheduling. 2026-03-07 21:19:00 -05:00
ee28e9d0a2 Drop debugging print that was committed by accident. 2026-03-02 12:22:22 -05:00
e882fd1f13 Make WMCreateCommandButton into a proper function instead of a macro. 2026-03-02 12:18:21 -05:00
eaabf7e20c Fix panic when notification dispatch triggers notification dispatch.
The global `NotificationCenter` is kept behind a mutex, which was locked when notifications were dispatched.

As a result, if notification dispatch triggered dispatch of other notifications, we would fail to unlock the mutex and panic.

This change copies dispatch instructions out from inside the mutex, releases the mutex, and then actually does the dispatch.
2026-03-02 12:12:25 -05:00
7c7b9aa97c Rewrite WINGs handlers.c in Rust. 2026-02-15 23:15:22 -05:00
223a64286f Remove WINGs input handlers.
Input handlers date back to early versions of WINGs. They provide
a way to listen for state changes on file descriptors (including
networking sockets) as part of the WINGs event loop.

This functionality is not actually used in the Window Maker source
tree. It may have been more useful in the past, when WINGs provided
a networking socket API. The status quo appears to be that this is
largely dead code. Pumping the X11 event queue is special-cased in
the input handling code, so it can stay in for now.
2026-02-12 12:53:14 -05:00
ce97a3b39f Drop select(2)-based input FD polling.
This is an intermediate step in the process of dropping input FD
polling entirely (except for pumping the X11 event queue).

There is code to use poll(2) instead of select(2) to wait for events
on file descriptors (which includes waiting for events from the X11
event queue). It appears not to have been used in quite some time,
or perhaps never, as it contains a typo (`poll fd` instead of `pollfd`
on its first line).

To reduce code bloat and make source code easier to navigate, it
makes sense to prefer only one of these codepaths.

After correcting this typo, waiting for X11 events appears to work, so
the poll(2)-based code seems to be good enough. Keeping the poll-based
code is vaguely preferable because poll(2) has a slightly better
interface than select(2), and poll(2) has been a standard Unix API
for 30 years.

Since this code is slated to be replaced, the decision to use the
poll(2)-based code here is probably not very important. But future
programmers may want to use this as a branching-off point for switching
to epoll(7) or some other, less-select(2)-like interface.
2026-02-12 12:53:14 -05:00
5075c877fa Remove WMDeleteTimerWithClientData.
This function requires tracking an explict client data pointer, which it would be preferable not to have in the Rust rewrite.

Removing this function entails tracking timer handlers explicitly, but this is not an undue burden.
2026-02-12 12:53:14 -05:00
fa67563c2b Break out Sendable into its own utility module. 2025-12-20 13:09:32 -05:00
cd711ba52b Restore function prototype for W_ClearNotificationCenter.
This was mistakenly removed when writing wutil-rs/src/notification.rs.
2025-12-20 12:38:29 -05:00
d46810291b Remove unused import. 2025-12-20 12:38:29 -05:00
7c875284dc Add build-generated files to .gitignore. 2025-12-20 12:35:10 -05:00
52db12fbf2 Merge pull request 'Merge refactor/wings-rs into refactor/riir' (#13) from refactor/wings-rs into refactor/riir
Reviewed-on: #13
2025-12-15 13:03:10 -05:00
b2481cf657 Name arguments directly instead of aping the Google C++ style guide. 2025-12-15 13:00:00 -05:00
c371e26d05 Add new Rust source files to Makefile.am.
Forgot to do this earlier.
2025-12-15 13:00:00 -05:00
98421afc38 Rewrite all functions from WINGs wfont.c in Rust.
This starts to establish the structure for an in-place rewrite of WINGs. An
actual redesign of WINGs may follow, but for now there are no plans to alter the
structure of WINGs substantially.
2025-12-15 13:00:00 -05:00
9e49ed98a2 Make WINGs configuration visible from Rust. 2025-12-15 13:00:00 -05:00
a466f17c35 Fix build order issues by moving wings-rs/ into WINGs/.
Having wings-rs depend on WINGs/WINGs/WINGsP.h was not working very well if all
of WINGs/ had to be built before wings-rs/. Moving wings-rs/ into WINGs/
addresses this.
2025-12-15 13:00:00 -05:00
d33c05ef08 Ignore target dir for nested Cargo subdirs, too. 2025-12-15 13:00:00 -05:00
79873413db Tweak build so that WINGsP.rs gets generated at the right time. 2025-12-15 13:00:00 -05:00
57ac6b8178 Put the font and y (ascent) fields of W_Font behind accessors. 2025-12-15 13:00:00 -05:00
d30fe6182d Mark wings-rs as a staticlib. 2025-12-15 13:00:00 -05:00
e20009a880 Use bindgen to generate Rust bindings for WINGs types.
We will use these to port W_Font, W_Screen, etc., to Rust.

Bindings are regenerated whenever the relevant C source files change and then
patched to make sure they will build. This is a bit hacky but will serve our
purposes: the struct definitions should be migrated to Rust sooner rather than
later, so the hackishness should be transient.
2025-12-15 13:00:00 -05:00
ee71db6693 Remove unused functions WMSetWidgetDefaultFont, WMSetWidgetDefaultBoldFont. 2025-12-15 13:00:00 -05:00
01c7eb7275 Remove unused function WMCopyFontWithStyle. 2025-12-15 13:00:00 -05:00
fa99c12fd7 Remove unused function WMIsAntialiasingEnabled. 2025-12-15 13:00:00 -05:00
d7e815010b Merge pull request 'Merge refactor/wutil-rs into refactor/riir' (#12) from trurl/wmaker:refactor/wutil-rs into refactor/riir
Reviewed-on: #12
2025-12-15 12:50:52 -05:00
a31fa582bd Merge branch 'refactor/riir' into refactor/wutil-rs 2025-12-15 12:49:49 -05:00
e0fc92bf51 Fix omissions in WMHashEnumerator C interface.
The WMHashTable rewrite branch was prematurely merged. This patch fixes some of
the things that were overlooked in that merge. WMHashEnumerator should be an
opaque type that is free'd after it is created.

We hope to axe WMHashTable entirely, but it's reasonable to get this fix in for
now so that the WMFontPanel integration test in WINGs/Tests can run on top of
the changes we've made so far. As of this commit, it's still broken, but it
behaves better than it did.
2025-11-29 12:51:51 -05:00
f8df6447ea Store addresses insead of pointers in WMArray.
Prior to this patch, when WINGs/Tests/wtest.c tries to build a FontPanel, it
crashes. This is because the rewritten WMSortArray passes pointers to array
items to its comparator function, but the original API passed pointers to
pointers to array items to its comparator function. This has been corrected, and
now WMSortArray should behave more like it originally did.

This patch also stores `usize` addresses instead of `NonNull` pointers because
some WMArray use sites actually store non-pointer data (by casting it to
uintptr_t or similar).
2025-11-29 12:51:51 -05:00
bd18e0c600 add some hacky lines to start-captive-wmaker.sh to ease debugging of X11 integration from Emacs 2025-11-21 16:01:41 -05:00
50caed30c0 Add a wings-rs crate for porting WINGs proper to Rust. 2025-11-14 01:07:40 -05:00
68 changed files with 5060 additions and 2029 deletions

17
.gitignore vendored
View File

@@ -83,13 +83,20 @@ WINGs/Tests/wtest
WPrefs.app/WPrefs
# These files are generated from make rules
wmlib/wmlib.pc
wrlib/wrlib.pc
WINGs/WINGs.pc
WINGs/WUtil.pc
doc/wmaker.1
doc/wmsetbg.1
wrlib/libwraster.map
WindowMaker/appearance.menu
WindowMaker/appearance.menu.fy
WindowMaker/appearance.menu.nl
WindowMaker/appearance.menu.sr
WindowMaker/menu
WindowMaker/menu.bg
WindowMaker/menu.fi
@@ -99,6 +106,7 @@ WindowMaker/menu.ko
WindowMaker/menu.nl
WindowMaker/menu.ro
WindowMaker/menu.sk
WindowMaker/menu.sr
WindowMaker/menu.zh_TW
WindowMaker/plmenu
WindowMaker/plmenu.bg
@@ -111,6 +119,7 @@ WindowMaker/plmenu.nl
WindowMaker/plmenu.pl
WindowMaker/plmenu.ro
WindowMaker/plmenu.sk
WindowMaker/plmenu.sr
WindowMaker/plmenu.zh_CN
WindowMaker/plmenu.zh_TW
WindowMaker/wmmacros
@@ -142,4 +151,10 @@ WPrefs.app/WPrefs.desktop
.pc
# Rust stuff.
/*/target/**
/**/target/**
WINGs/wings-rs-tests/Cargo.lock
WINGs/wings-rs/Cargo.lock
WINGs/wings-rs/src/WINGsP.rs
wmaker-rs/Cargo.lock
wrlib-rs/src/ffi.rs
wutil-rs/Cargo.lock

View File

@@ -2,7 +2,7 @@
AUTOMAKE_OPTIONS =
SUBDIRS = WINGs . po Documentation Resources
SUBDIRS = WINGs wings-rs wings-rs-tests . po Documentation Resources
DIST_SUBDIRS = $(SUBDIRS) Tests Examples Extras
libWINGs_la_LDFLAGS = -version-info @WINGS_VERSION@
@@ -41,8 +41,6 @@ libWINGs_la_SOURCES = \
wevent.c \
wfilepanel.c \
wframe.c \
wfont.c \
wfontpanel.c \
widgets.c \
winputmethod.c \
wlabel.c \
@@ -68,7 +66,6 @@ libWUtil_la_SOURCES = \
error.c \
error.h \
findfile.c \
handlers.c \
menuparser.c \
menuparser.h \
menuparser_macros.c \
@@ -78,8 +75,7 @@ libWUtil_la_SOURCES = \
userdefaults.h \
usleep.c \
wapplication.c \
wconfig.h \
wutil.c
wconfig.h
AM_CFLAGS = @PANGO_CFLAGS@

View File

@@ -4,14 +4,17 @@ AUTOMAKE_OPTIONS =
noinst_PROGRAMS = wtest wmquery wmfile testmywidget
LDADD= $(top_builddir)/WINGs/libWINGs.la $(top_builddir)/wrlib/libwraster.la \
LDADD= $(top_builddir)/WINGs/libWINGs.la \
$(top_builddir)/wrlib/libwraster.la \
$(top_builddir)/WINGs/libWUtil.la \
@XFT_LIBS@ @INTLIBS@ @XLIBS@
$(top_builddir)/WINGs/wings-rs/target/debug/libwings_rs.a \
@XFT_LIBS@ @INTLIBS@ @XLIBS@ @FCLIBS@ @PANGO_LIBS@
testmywidget_SOURCES = testmywidget.c mywidget.c mywidget.h
wtest_DEPENDENCIES = $(top_builddir)/WINGs/libWINGs.la
wtest_DEPENDENCIES = $(top_builddir)/WINGs/libWINGs.la \
$(top_builddir)/WINGs/wings-rs/target/debug/libwings_rs.a
EXTRA_DIST = logo.xpm upbtn.xpm wm.html wm.png

View File

@@ -132,7 +132,7 @@ typedef enum {
} WMButtonType;
/* button behaviour masks */
enum {
typedef enum {
WBBSpringLoadedMask = (1 << 0),
WBBPushInMask = (1 << 1),
WBBPushChangeMask = (1 << 2),
@@ -140,7 +140,7 @@ enum {
WBBStateLightMask = (1 << 5),
WBBStateChangeMask = (1 << 6),
WBBStatePushMask = (1 << 7)
};
} WMButtonBehaviorMask;
/* frame title positions */
@@ -778,12 +778,8 @@ void WMSetViewDragDestinationProcs(WMView *view, WMDragDestinationProcs *procs);
/* ---[ WINGs/wfont.c ]--------------------------------------------------- */
Bool WMIsAntialiasingEnabled(WMScreen *scrPtr);
WMFont* WMCreateFont(WMScreen *scrPtr, const char *fontName);
WMFont* WMCopyFontWithStyle(WMScreen *scrPtr, WMFont *font, WMFontStyle style);
WMFont* WMRetainFont(WMFont *font);
void WMReleaseFont(WMFont *font);
@@ -792,12 +788,10 @@ char* WMGetFontName(WMFont *font);
unsigned int WMFontHeight(WMFont *font);
unsigned int WMFontAscent(WMFont *font);
void WMGetScaleBaseFromSystemFont(WMScreen *scrPtr, int *alphabetWidth, int *fontHeight);
void WMSetWidgetDefaultFont(WMScreen *scr, WMFont *font);
void WMSetWidgetDefaultBoldFont(WMScreen *scr, WMFont *font);
WMFont* WMDefaultSystemFont(WMScreen *scrPtr);
WMFont* WMDefaultBoldSystemFont(WMScreen *scrPtr);
@@ -815,6 +809,8 @@ void WMDrawImageString(WMScreen *scr, Drawable d, WMColor *color,
int WMWidthOfString(WMFont *font, const char *text, int length);
struct _XftFont *WMFontXftFont(WMFont *font);
/* ---[ WINGs/wpixmap.c ]------------------------------------------------- */
WMPixmap* WMRetainPixmap(WMPixmap *pixmap);
@@ -1043,11 +1039,7 @@ void WMCloseWindow(WMWindow *win);
void WMSetButtonAction(WMButton *bPtr, WMAction *action, void *clientData);
#define WMCreateCommandButton(parent) \
WMCreateCustomButton((parent), WBBSpringLoadedMask\
|WBBPushInMask\
|WBBPushLightMask\
|WBBPushChangeMask)
WMButton* WMCreateCommandButton(WMWidget *parent);
#define WMCreateRadioButton(parent) \
WMCreateButton((parent), WBTRadio)

View File

@@ -122,8 +122,6 @@ typedef struct W_Screen {
WMOpenPanel *sharedOpenPanel;
WMSavePanel *sharedSavePanel;
struct W_FontPanel *sharedFontPanel;
struct W_ColorPanel *sharedColorPanel;
Pixmap stipple;
@@ -152,11 +150,11 @@ typedef struct W_Screen {
GC drawImStringGC; /* for WMDrawImageString() */
struct W_Font *normalFont;
WMFont *normalFont;
struct W_Font *boldFont;
WMFont *boldFont;
WMHashTable *fontCache;
void *fontCache; /* owned/maintainted by wings-rs/src/screen.rs */
Bool antialiasedText;
@@ -369,8 +367,12 @@ Bool W_CheckIdleHandlers(void);
void W_CheckTimerHandlers(void);
Bool W_HandleInputEvents(Bool waitForInput, int inputfd);
/*
* Returns the duration in milliseconds until the next timer event should go off
* (saturating at INT_MAX). If there is no such timer event, returns a negative
* value.
*/
int W_DelayUntilNextTimerEvent_millis();
/* ---[ notification.c ]-------------------------------------------------- */
@@ -378,6 +380,8 @@ void W_InitNotificationCenter(void);
void W_ReleaseNotificationCenter(void);
void W_ClearNotificationCenter(void);
/* ---[ selection.c ]----------------------------------------------------- */
@@ -441,24 +445,6 @@ typedef struct W_EventHandler {
void W_CallDestroyHandlers(W_View *view);
/* ---[ wfont.c ]--------------------------------------------------------- */
typedef struct W_Font {
struct W_Screen *screen;
struct _XftFont *font;
short height;
short y;
short refCount;
char *name;
@USE_PANGO@ PangoLayout *layout;
} W_Font;
#define W_FONTID(f) (f)->font->fid
/* ---[ widgets.c ]------------------------------------------------------- */
#define WC_UserWidget 128
@@ -504,7 +490,7 @@ void W_DrawReliefWithGC(W_Screen *scr, Drawable d, int x, int y,
GC black, GC dark, GC light, GC white);
void W_PaintTextAndImage(W_View *view, int wrap, WMColor *textColor,
W_Font *font, WMReliefType relief, const char *text,
WMFont *font, WMReliefType relief, const char *text,
WMAlignment alignment, W_Pixmap *image,
WMImagePosition position, WMColor *backColor, int ofs);

View File

@@ -156,12 +156,7 @@ typedef struct {
/* DO NOT ACCESS THE CONTENTS OF THIS STRUCT */
typedef struct {
void *table;
void *nextItem;
int index;
} WMHashEnumerator;
typedef struct WMHashEnumerator WMHashEnumerator;
typedef struct {
@@ -302,34 +297,20 @@ void wusleep(unsigned int usec);
/* Event handlers: timer, idle, input */
WMHandlerID WMAddTimerHandler(int milliseconds, WMCallback *callback,
WMHandlerID WMAddTimerHandler(unsigned milliseconds, WMCallback *callback,
void *cdata);
WMHandlerID WMAddPersistentTimerHandler(int milliseconds, WMCallback *callback,
WMHandlerID WMAddPersistentTimerHandler(unsigned milliseconds, WMCallback *callback,
void *cdata);
void WMDeleteTimerWithClientData(void *cdata);
void WMDeleteTimerHandler(WMHandlerID handlerID);
WMHandlerID WMAddIdleHandler(WMCallback *callback, void *cdata);
void WMDeleteIdleHandler(WMHandlerID handlerID);
WMHandlerID WMAddInputHandler(int fd, int condition, WMInputProc *proc,
void *clientData);
void WMDeleteInputHandler(WMHandlerID handlerID);
/* This function is used _only_ if you create a non-GUI program.
* For GUI based programs use WMNextEvent()/WMHandleEvent() instead.
* This function will handle all input/timer/idle events, then return.
*/
void WHandleEvents(void);
/* ---[ WINGs/hashtable.c ]----------------------------------------------- */
/* ---[ wutil-rs/src/hash_table.rs ]----------------------------------------------- */
WMHashTable* WMCreateIdentityHashTable();
@@ -361,7 +342,7 @@ void* WMHashInsert(WMHashTable *table, const void *key, const void *data);
void WMHashRemove(WMHashTable *table, const void *key);
/* warning: do not manipulate the table while using the enumerator functions */
WMHashEnumerator WMEnumerateHashTable(WMHashTable *table);
WMHashEnumerator* WMEnumerateHashTable(WMHashTable *table);
void* WMNextHashEnumeratorItem(WMHashEnumerator *enumerator);
@@ -376,7 +357,7 @@ Bool WMNextHashEnumeratorItemAndKey(WMHashEnumerator *enumerator,
void **item, void **key);
void WMFreeHashEnumerator(WMHashEnumerator *enumerator);
/* some predefined callback sets */

View File

@@ -1,554 +0,0 @@
/*
* WINGs internal handlers: timer, idle and input handlers
*/
#include "wconfig.h"
#include "WINGsP.h"
#include <sys/types.h>
#include <unistd.h>
#include <X11/Xos.h>
#ifdef HAVE_SYS_SELECT_H
# include <sys/select.h>
#endif
#include <time.h>
#ifndef X_GETTIMEOFDAY
#define X_GETTIMEOFDAY(t) gettimeofday(t, (struct timezone*)0)
#endif
typedef struct TimerHandler {
WMCallback *callback; /* procedure to call */
struct timeval when; /* when to call the callback */
void *clientData;
struct TimerHandler *next;
int nextDelay; /* 0 if it's one-shot */
} TimerHandler;
typedef struct IdleHandler {
WMCallback *callback;
void *clientData;
} IdleHandler;
typedef struct InputHandler {
WMInputProc *callback;
void *clientData;
int fd;
int mask;
} InputHandler;
/* queue of timer event handlers */
static TimerHandler *timerHandler = NULL;
static WMArray *idleHandler = NULL;
static WMArray *inputHandler = NULL;
#define timerPending() (timerHandler)
static void rightNow(struct timeval *tv)
{
X_GETTIMEOFDAY(tv);
}
/* is t1 after t2 ? */
#define IS_AFTER(t1, t2) (((t1).tv_sec > (t2).tv_sec) || \
(((t1).tv_sec == (t2).tv_sec) \
&& ((t1).tv_usec > (t2).tv_usec)))
#define IS_ZERO(tv) (tv.tv_sec == 0 && tv.tv_usec == 0)
#define SET_ZERO(tv) tv.tv_sec = 0, tv.tv_usec = 0
static void addmillisecs(struct timeval *tv, int milliseconds)
{
tv->tv_usec += milliseconds * 1000;
tv->tv_sec += tv->tv_usec / 1000000;
tv->tv_usec = tv->tv_usec % 1000000;
}
static void enqueueTimerHandler(TimerHandler * handler)
{
TimerHandler *tmp;
/* insert callback in queue, sorted by time left */
if (!timerHandler || !IS_AFTER(handler->when, timerHandler->when)) {
/* first in the queue */
handler->next = timerHandler;
timerHandler = handler;
} else {
tmp = timerHandler;
while (tmp->next && IS_AFTER(handler->when, tmp->next->when)) {
tmp = tmp->next;
}
handler->next = tmp->next;
tmp->next = handler;
}
}
static void delayUntilNextTimerEvent(struct timeval *delay)
{
struct timeval now;
TimerHandler *handler;
handler = timerHandler;
while (handler && IS_ZERO(handler->when))
handler = handler->next;
if (!handler) {
/* The return value of this function is only valid if there _are_
timers active. */
delay->tv_sec = 0;
delay->tv_usec = 0;
return;
}
rightNow(&now);
if (IS_AFTER(now, handler->when)) {
delay->tv_sec = 0;
delay->tv_usec = 0;
} else {
delay->tv_sec = handler->when.tv_sec - now.tv_sec;
delay->tv_usec = handler->when.tv_usec - now.tv_usec;
if (delay->tv_usec < 0) {
delay->tv_usec += 1000000;
delay->tv_sec--;
}
}
}
WMHandlerID WMAddTimerHandler(int milliseconds, WMCallback * callback, void *cdata)
{
TimerHandler *handler;
handler = wmalloc(sizeof(TimerHandler));
if (!handler)
return NULL;
rightNow(&handler->when);
addmillisecs(&handler->when, milliseconds);
handler->callback = callback;
handler->clientData = cdata;
handler->nextDelay = 0;
enqueueTimerHandler(handler);
return handler;
}
WMHandlerID WMAddPersistentTimerHandler(int milliseconds, WMCallback * callback, void *cdata)
{
TimerHandler *handler = WMAddTimerHandler(milliseconds, callback, cdata);
if (handler != NULL)
handler->nextDelay = milliseconds;
return handler;
}
void WMDeleteTimerWithClientData(void *cdata)
{
TimerHandler *handler, *tmp;
if (!cdata || !timerHandler)
return;
tmp = timerHandler;
if (tmp->clientData == cdata) {
tmp->nextDelay = 0;
if (!IS_ZERO(tmp->when)) {
timerHandler = tmp->next;
wfree(tmp);
}
} else {
while (tmp->next) {
if (tmp->next->clientData == cdata) {
handler = tmp->next;
handler->nextDelay = 0;
if (IS_ZERO(handler->when))
break;
tmp->next = handler->next;
wfree(handler);
break;
}
tmp = tmp->next;
}
}
}
void WMDeleteTimerHandler(WMHandlerID handlerID)
{
TimerHandler *tmp, *handler = (TimerHandler *) handlerID;
if (!handler || !timerHandler)
return;
tmp = timerHandler;
handler->nextDelay = 0;
if (IS_ZERO(handler->when))
return;
if (tmp == handler) {
timerHandler = handler->next;
wfree(handler);
} else {
while (tmp->next) {
if (tmp->next == handler) {
tmp->next = handler->next;
wfree(handler);
break;
}
tmp = tmp->next;
}
}
}
WMHandlerID WMAddIdleHandler(WMCallback * callback, void *cdata)
{
IdleHandler *handler;
handler = wmalloc(sizeof(IdleHandler));
if (!handler)
return NULL;
handler->callback = callback;
handler->clientData = cdata;
/* add handler at end of queue */
if (!idleHandler) {
idleHandler = WMCreateArrayWithDestructor(16, wfree);
}
WMAddToArray(idleHandler, handler);
return handler;
}
void WMDeleteIdleHandler(WMHandlerID handlerID)
{
IdleHandler *handler = (IdleHandler *) handlerID;
if (!handler || !idleHandler)
return;
WMRemoveFromArray(idleHandler, handler);
}
WMHandlerID WMAddInputHandler(int fd, int condition, WMInputProc * proc, void *clientData)
{
InputHandler *handler;
handler = wmalloc(sizeof(InputHandler));
handler->fd = fd;
handler->mask = condition;
handler->callback = proc;
handler->clientData = clientData;
if (!inputHandler)
inputHandler = WMCreateArrayWithDestructor(16, wfree);
WMAddToArray(inputHandler, handler);
return handler;
}
void WMDeleteInputHandler(WMHandlerID handlerID)
{
InputHandler *handler = (InputHandler *) handlerID;
if (!handler || !inputHandler)
return;
WMRemoveFromArray(inputHandler, handler);
}
Bool W_CheckIdleHandlers(void)
{
IdleHandler *handler;
WMArray *handlerCopy;
WMArrayIterator iter;
if (!idleHandler || WMGetArrayItemCount(idleHandler) == 0) {
/* make sure an observer in queue didn't added an idle handler */
return (idleHandler != NULL && WMGetArrayItemCount(idleHandler) > 0);
}
handlerCopy = WMCreateArrayWithArray(idleHandler);
WM_ITERATE_ARRAY(handlerCopy, handler, iter) {
/* check if the handler still exist or was removed by a callback */
if (WMGetFirstInArray(idleHandler, handler) == WANotFound)
continue;
(*handler->callback) (handler->clientData);
WMDeleteIdleHandler(handler);
}
WMFreeArray(handlerCopy);
/* this is not necesarrily False, because one handler can re-add itself */
return (WMGetArrayItemCount(idleHandler) > 0);
}
void W_CheckTimerHandlers(void)
{
TimerHandler *handler;
struct timeval now;
if (!timerHandler) {
return;
}
rightNow(&now);
handler = timerHandler;
while (handler && IS_AFTER(now, handler->when)) {
if (!IS_ZERO(handler->when)) {
SET_ZERO(handler->when);
(*handler->callback) (handler->clientData);
}
handler = handler->next;
}
while (timerHandler && IS_ZERO(timerHandler->when)) {
handler = timerHandler;
timerHandler = timerHandler->next;
if (handler->nextDelay > 0) {
handler->when = now;
addmillisecs(&handler->when, handler->nextDelay);
enqueueTimerHandler(handler);
} else {
wfree(handler);
}
}
}
/*
* This functions will handle input events on all registered file descriptors.
* Input:
* - waitForInput - True if we want the function to wait until an event
* appears on a file descriptor we watch, False if we
* want the function to immediately return if there is
* no data available on the file descriptors we watch.
* - inputfd - Extra input file descriptor to watch for input.
* This is only used when called from wevent.c to watch
* on ConnectionNumber(dpy) to avoid blocking of X events
* if we wait for input from other file handlers.
* Output:
* if waitForInput is False, the function will return False if there are no
* input handlers registered, or if there is no data
* available on the registered ones, and will return True
* if there is at least one input handler that has data
* available.
* if waitForInput is True, the function will return False if there are no
* input handlers registered, else it will block until an
* event appears on one of the file descriptors it watches
* and then it will return True.
*
* If the retured value is True, the input handlers for the corresponding file
* descriptors are also called.
*
* Parametersshould be passed like this:
* - from wevent.c:
* waitForInput - apropriate value passed by the function who called us
* inputfd = ConnectionNumber(dpy)
* - from wutil.c:
* waitForInput - apropriate value passed by the function who called us
* inputfd = -1
*
*/
Bool W_HandleInputEvents(Bool waitForInput, int inputfd)
{
#if defined(HAVE_POLL) && defined(HAVE_POLL_H) && !defined(HAVE_SELECT)
struct poll fd *fds;
InputHandler *handler;
int count, timeout, nfds, i, extrafd;
extrafd = (inputfd < 0) ? 0 : 1;
if (inputHandler)
nfds = WMGetArrayItemCount(inputHandler);
else
nfds = 0;
if (!extrafd && nfds == 0) {
return False;
}
fds = wmalloc((nfds + extrafd) * sizeof(struct pollfd));
if (extrafd) {
/* put this to the end of array to avoid using ranges from 1 to nfds+1 */
fds[nfds].fd = inputfd;
fds[nfds].events = POLLIN;
}
/* use WM_ITERATE_ARRAY() here */
for (i = 0; i < nfds; i++) {
handler = WMGetFromArray(inputHandler, i);
fds[i].fd = handler->fd;
fds[i].events = 0;
if (handler->mask & WIReadMask)
fds[i].events |= POLLIN;
if (handler->mask & WIWriteMask)
fds[i].events |= POLLOUT;
#if 0 /* FIXME */
if (handler->mask & WIExceptMask)
FD_SET(handler->fd, &eset);
#endif
}
/*
* Setup the timeout to the estimated time until the
* next timer expires.
*/
if (!waitForInput) {
timeout = 0;
} else if (timerPending()) {
struct timeval tv;
delayUntilNextTimerEvent(&tv);
timeout = tv.tv_sec * 1000 + tv.tv_usec / 1000;
} else {
timeout = -1;
}
count = poll(fds, nfds + extrafd, timeout);
if (count > 0 && nfds > 0) {
WMArray *handlerCopy = WMCreateArrayWithArray(inputHandler);
int mask;
/* use WM_ITERATE_ARRAY() here */
for (i = 0; i < nfds; i++) {
handler = WMGetFromArray(handlerCopy, i);
/* check if the handler still exist or was removed by a callback */
if (WMGetFirstInArray(inputHandler, handler) == WANotFound)
continue;
mask = 0;
if ((handler->mask & WIReadMask) &&
(fds[i].revents & (POLLIN | POLLRDNORM | POLLRDBAND | POLLPRI)))
mask |= WIReadMask;
if ((handler->mask & WIWriteMask) && (fds[i].revents & (POLLOUT | POLLWRBAND)))
mask |= WIWriteMask;
if ((handler->mask & WIExceptMask) && (fds[i].revents & (POLLHUP | POLLNVAL | POLLERR)))
mask |= WIExceptMask;
if (mask != 0 && handler->callback) {
(*handler->callback) (handler->fd, mask, handler->clientData);
}
}
WMFreeArray(handlerCopy);
}
wfree(fds);
return (count > 0);
#else
#ifdef HAVE_SELECT
struct timeval timeout;
struct timeval *timeoutPtr;
fd_set rset, wset, eset;
int maxfd, nfds, i;
int count;
InputHandler *handler;
if (inputHandler)
nfds = WMGetArrayItemCount(inputHandler);
else
nfds = 0;
if (inputfd < 0 && nfds == 0) {
return False;
}
FD_ZERO(&rset);
FD_ZERO(&wset);
FD_ZERO(&eset);
if (inputfd < 0) {
maxfd = 0;
} else {
FD_SET(inputfd, &rset);
maxfd = inputfd;
}
/* use WM_ITERATE_ARRAY() here */
for (i = 0; i < nfds; i++) {
handler = WMGetFromArray(inputHandler, i);
if (handler->mask & WIReadMask)
FD_SET(handler->fd, &rset);
if (handler->mask & WIWriteMask)
FD_SET(handler->fd, &wset);
if (handler->mask & WIExceptMask)
FD_SET(handler->fd, &eset);
if (maxfd < handler->fd)
maxfd = handler->fd;
}
/*
* Setup the timeout to the estimated time until the
* next timer expires.
*/
if (!waitForInput) {
SET_ZERO(timeout);
timeoutPtr = &timeout;
} else if (timerPending()) {
delayUntilNextTimerEvent(&timeout);
timeoutPtr = &timeout;
} else {
timeoutPtr = (struct timeval *)0;
}
count = select(1 + maxfd, &rset, &wset, &eset, timeoutPtr);
if (count > 0 && nfds > 0) {
WMArray *handlerCopy = WMCreateArrayWithArray(inputHandler);
int mask;
/* use WM_ITERATE_ARRAY() here */
for (i = 0; i < nfds; i++) {
handler = WMGetFromArray(handlerCopy, i);
/* check if the handler still exist or was removed by a callback */
if (WMGetFirstInArray(inputHandler, handler) == WANotFound)
continue;
mask = 0;
if ((handler->mask & WIReadMask) && FD_ISSET(handler->fd, &rset))
mask |= WIReadMask;
if ((handler->mask & WIWriteMask) && FD_ISSET(handler->fd, &wset))
mask |= WIWriteMask;
if ((handler->mask & WIExceptMask) && FD_ISSET(handler->fd, &eset))
mask |= WIExceptMask;
if (mask != 0 && handler->callback) {
(*handler->callback) (handler->fd, mask, handler->clientData);
}
}
WMFreeArray(handlerCopy);
}
return (count > 0);
#else /* not HAVE_SELECT, not HAVE_POLL */
# error Neither select nor poll. You lose.
#endif /* HAVE_SELECT */
#endif /* HAVE_POLL */
}

View File

@@ -456,12 +456,12 @@ static void handleEvents(XEvent * event, void *data)
static void destroyBalloon(Balloon * bPtr)
{
WMHashEnumerator e;
WMHashEnumerator *e;
char *str;
e = WMEnumerateHashTable(bPtr->table);
while ((str = WMNextHashEnumeratorItem(&e))) {
while ((str = WMNextHashEnumeratorItem(e))) {
wfree(str);
}
WMFreeHashTable(bPtr->table);
@@ -472,5 +472,7 @@ static void destroyBalloon(Balloon * bPtr)
if (bPtr->font)
WMReleaseFont(bPtr->font);
WMFreeHashEnumerator(e);
wfree(bPtr);
}

View File

@@ -216,6 +216,14 @@ WMButton *WMCreateButton(WMWidget * parent, WMButtonType type)
return bPtr;
}
WMButton *WMCreateCommandButton(WMWidget *parent)
{
return WMCreateCustomButton(
parent,
WBBSpringLoadedMask|WBBPushInMask|WBBPushLightMask|WBBPushChangeMask
);
}
static void updateDisabledMask(WMButton * bPtr)
{
WMScreen *scr = WMWidgetScreen(bPtr);

View File

@@ -3,8 +3,17 @@
* This event handling stuff was inspired on Tk.
*/
#include "wconfig.h"
#include "WINGsP.h"
#if !HAVE_POLL
# error poll(2) is not present on this system
#endif
#if HAVE_POLL_H
# include <poll.h>
#endif
/* table to map event types to event masks */
static const unsigned long eventMasks[] = {
0,
@@ -349,6 +358,9 @@ int WMIsDoubleClick(XEvent * event)
*/
static Bool waitForEvent(Display * dpy, unsigned long xeventmask, Bool waitForInput)
{
struct pollfd pfd;
int timeout, inputfd;
XSync(dpy, False);
if (xeventmask == 0) {
if (XPending(dpy))
@@ -361,7 +373,18 @@ static Bool waitForEvent(Display * dpy, unsigned long xeventmask, Bool waitForIn
}
}
return W_HandleInputEvents(waitForInput, ConnectionNumber(dpy));
inputfd = ConnectionNumber(dpy);
if (inputfd < 0) {
return False;
}
pfd.fd = inputfd;
pfd.events = POLLIN;
timeout = waitForInput ? W_DelayUntilNextTimerEvent_millis() : 0;
return poll(&pfd, 1, timeout) > 0;
}
void WMNextEvent(Display * dpy, XEvent * event)

View File

@@ -1,433 +0,0 @@
#include <stdlib.h>
#include "wconfig.h"
#include "WINGsP.h"
#include <wraster.h>
#include <assert.h>
#include <X11/Xlocale.h>
#include <X11/Xft/Xft.h>
#include <fontconfig/fontconfig.h>
#ifdef USE_PANGO
#include <pango/pango.h>
#include <pango/pangofc-fontmap.h>
#include <pango/pangoxft.h>
#endif
#define DEFAULT_FONT "sans serif:pixelsize=12"
#define DEFAULT_SIZE WINGsConfiguration.defaultFontSize
static FcPattern *xlfdToFcPattern(const char *xlfd)
{
FcPattern *pattern;
char *fname, *ptr;
/* Just skip old font names that contain %d in them.
* We don't support that anymore. */
if (strchr(xlfd, '%') != NULL)
return FcNameParse((FcChar8 *) DEFAULT_FONT);
fname = wstrdup(xlfd);
if ((ptr = strchr(fname, ','))) {
*ptr = 0;
}
pattern = XftXlfdParse(fname, False, False);
wfree(fname);
if (!pattern) {
wwarning(_("invalid font: %s. Trying '%s'"), xlfd, DEFAULT_FONT);
pattern = FcNameParse((FcChar8 *) DEFAULT_FONT);
}
return pattern;
}
static char *xlfdToFcName(const char *xlfd)
{
FcPattern *pattern;
char *fname;
char *result;
pattern = xlfdToFcPattern(xlfd);
fname = (char *)FcNameUnparse(pattern);
result = wstrdup(fname);
free(fname);
FcPatternDestroy(pattern);
return result;
}
static Bool hasProperty(FcPattern * pattern, const char *property)
{
FcValue val;
if (FcPatternGet(pattern, property, 0, &val) == FcResultMatch) {
return True;
}
return False;
}
static Bool hasPropertyWithStringValue(FcPattern * pattern, const char *object, const char *value)
{
FcChar8 *str;
int id;
if (!value || value[0] == 0)
return True;
id = 0;
while (FcPatternGetString(pattern, object, id, &str) == FcResultMatch) {
if (strcasecmp(value, (char *)str) == 0) {
return True;
}
id++;
}
return False;
}
static char *makeFontOfSize(const char *font, int size, const char *fallback)
{
FcPattern *pattern;
char *name;
char *result;
if (font[0] == '-') {
pattern = xlfdToFcPattern(font);
} else {
pattern = FcNameParse((const FcChar8 *) font);
}
/*FcPatternPrint(pattern); */
if (size > 0) {
FcPatternDel(pattern, FC_PIXEL_SIZE);
FcPatternAddDouble(pattern, FC_PIXEL_SIZE, (double)size);
} else if (size == 0 && !hasProperty(pattern, "size") && !hasProperty(pattern, FC_PIXEL_SIZE)) {
FcPatternAddDouble(pattern, FC_PIXEL_SIZE, (double)DEFAULT_SIZE);
}
if (fallback && !hasPropertyWithStringValue(pattern, FC_FAMILY, fallback)) {
FcPatternAddString(pattern, FC_FAMILY, (const FcChar8 *) fallback);
}
/*FcPatternPrint(pattern); */
name = (char *)FcNameUnparse(pattern);
result = wstrdup(name);
free(name);
FcPatternDestroy(pattern);
return result;
}
WMFont *WMCreateFont(WMScreen * scrPtr, const char *fontName)
{
Display *display = scrPtr->display;
WMFont *font;
char *fname;
#ifdef USE_PANGO
PangoFontMap *fontmap;
PangoContext *context;
PangoLayout *layout;
FcPattern *pattern;
PangoFontDescription *description;
double size;
#endif
if (fontName[0] == '-') {
fname = xlfdToFcName(fontName);
} else {
fname = wstrdup(fontName);
}
if (!WINGsConfiguration.antialiasedText && !strstr(fname, ":antialias=")) {
fname = wstrappend(fname, ":antialias=false");
}
font = WMHashGet(scrPtr->fontCache, fname);
if (font) {
WMRetainFont(font);
wfree(fname);
return font;
}
font = wmalloc(sizeof(WMFont));
font->screen = scrPtr;
font->font = XftFontOpenName(display, scrPtr->screen, fname);
if (!font->font) {
wfree(font);
wfree(fname);
return NULL;
}
font->height = font->font->ascent + font->font->descent;
font->y = font->font->ascent;
font->refCount = 1;
font->name = fname;
#ifdef USE_PANGO
fontmap = pango_xft_get_font_map(scrPtr->display, scrPtr->screen);
context = pango_font_map_create_context(fontmap);
layout = pango_layout_new(context);
pattern = FcNameParse((FcChar8 *) font->name);
description = pango_fc_font_description_from_pattern(pattern, FALSE);
/* Pango examines FC_SIZE but not FC_PIXEL_SIZE of the patten, but
* font-name has only "pixelsize", so set the size manually here.
*/
if (FcPatternGetDouble(pattern, FC_PIXEL_SIZE, 0, &size) == FcResultMatch)
pango_font_description_set_absolute_size(description, size * PANGO_SCALE);
pango_layout_set_font_description(layout, description);
font->layout = layout;
#endif
assert(WMHashInsert(scrPtr->fontCache, font->name, font) == NULL);
return font;
}
WMFont *WMRetainFont(WMFont * font)
{
wassertrv(font != NULL, NULL);
font->refCount++;
return font;
}
void WMReleaseFont(WMFont * font)
{
wassertr(font != NULL);
font->refCount--;
if (font->refCount < 1) {
XftFontClose(font->screen->display, font->font);
if (font->name) {
WMHashRemove(font->screen->fontCache, font->name);
wfree(font->name);
}
wfree(font);
}
}
Bool WMIsAntialiasingEnabled(WMScreen * scrPtr)
{
return scrPtr->antialiasedText;
}
unsigned int WMFontHeight(WMFont * font)
{
wassertrv(font != NULL, 0);
return font->height;
}
char *WMGetFontName(WMFont * font)
{
wassertrv(font != NULL, NULL);
return font->name;
}
void WMGetScaleBaseFromSystemFont(WMScreen *scrPtr, int *alphabetWidth, int *fontHeight)
{
WMFont *font;
font = WMDefaultSystemFont(scrPtr);
*alphabetWidth = WMWidthOfString(font, "abcdefghijklmnopqrstuvwxyz", 26);
*fontHeight = WMFontHeight(font);
WMReleaseFont(font);
}
WMFont *WMDefaultSystemFont(WMScreen * scrPtr)
{
return WMRetainFont(scrPtr->normalFont);
}
WMFont *WMDefaultBoldSystemFont(WMScreen * scrPtr)
{
return WMRetainFont(scrPtr->boldFont);
}
WMFont *WMSystemFontOfSize(WMScreen * scrPtr, int size)
{
WMFont *font;
char *fontSpec;
fontSpec = makeFontOfSize(WINGsConfiguration.systemFont, size, NULL);
font = WMCreateFont(scrPtr, fontSpec);
if (!font) {
wwarning(_("could not load font: %s."), fontSpec);
}
wfree(fontSpec);
return font;
}
WMFont *WMBoldSystemFontOfSize(WMScreen * scrPtr, int size)
{
WMFont *font;
char *fontSpec;
fontSpec = makeFontOfSize(WINGsConfiguration.boldSystemFont, size, NULL);
font = WMCreateFont(scrPtr, fontSpec);
if (!font) {
wwarning(_("could not load font: %s."), fontSpec);
}
wfree(fontSpec);
return font;
}
int WMWidthOfString(WMFont * font, const char *text, int length)
{
#ifdef USE_PANGO
const char *previous_text;
int width;
#else
XGlyphInfo extents;
#endif
wassertrv(font != NULL && text != NULL, 0);
#ifdef USE_PANGO
previous_text = pango_layout_get_text(font->layout);
if ((previous_text == NULL) || (strncmp(text, previous_text, length) != 0) || previous_text[length] != '\0')
pango_layout_set_text(font->layout, text, length);
pango_layout_get_pixel_size(font->layout, &width, NULL);
return width;
#else
XftTextExtentsUtf8(font->screen->display, font->font, (XftChar8 *) text, length, &extents);
return extents.xOff; /* don't ask :P */
#endif
}
void WMDrawString(WMScreen * scr, Drawable d, WMColor * color, WMFont * font, int x, int y, const char *text, int length)
{
XftColor xftcolor;
#ifdef USE_PANGO
const char *previous_text;
#endif
wassertr(font != NULL);
xftcolor.color.red = color->color.red;
xftcolor.color.green = color->color.green;
xftcolor.color.blue = color->color.blue;
xftcolor.color.alpha = color->alpha;;
xftcolor.pixel = W_PIXEL(color);
XftDrawChange(scr->xftdraw, d);
#ifdef USE_PANGO
previous_text = pango_layout_get_text(font->layout);
if ((previous_text == NULL) || (strcmp(text, previous_text) != 0))
pango_layout_set_text(font->layout, text, length);
pango_xft_render_layout(scr->xftdraw, &xftcolor, font->layout, x * PANGO_SCALE, y * PANGO_SCALE);
#else
XftDrawStringUtf8(scr->xftdraw, &xftcolor, font->font, x, y + font->y, (XftChar8 *) text, length);
#endif
}
void
WMDrawImageString(WMScreen * scr, Drawable d, WMColor * color, WMColor * background,
WMFont * font, int x, int y, const char *text, int length)
{
XftColor textColor;
XftColor bgColor;
#ifdef USE_PANGO
const char *previous_text;
#endif
wassertr(font != NULL);
textColor.color.red = color->color.red;
textColor.color.green = color->color.green;
textColor.color.blue = color->color.blue;
textColor.color.alpha = color->alpha;;
textColor.pixel = W_PIXEL(color);
bgColor.color.red = background->color.red;
bgColor.color.green = background->color.green;
bgColor.color.blue = background->color.blue;
bgColor.color.alpha = background->alpha;;
bgColor.pixel = W_PIXEL(background);
XftDrawChange(scr->xftdraw, d);
XftDrawRect(scr->xftdraw, &bgColor, x, y, WMWidthOfString(font, text, length), font->height);
#ifdef USE_PANGO
previous_text = pango_layout_get_text(font->layout);
if ((previous_text == NULL) || (strcmp(text, previous_text) != 0))
pango_layout_set_text(font->layout, text, length);
pango_xft_render_layout(scr->xftdraw, &textColor, font->layout, x * PANGO_SCALE, y * PANGO_SCALE);
#else
XftDrawStringUtf8(scr->xftdraw, &textColor, font->font, x, y + font->y, (XftChar8 *) text, length);
#endif
}
WMFont *WMCopyFontWithStyle(WMScreen * scrPtr, WMFont * font, WMFontStyle style)
{
FcPattern *pattern;
WMFont *copy;
char *name;
if (!font)
return NULL;
/* It's enough to add italic to slant, even if the font has no italic
* variant, but only oblique. This is because fontconfig will actually
* return the closest match font to what we requested which is the
* oblique font. Same goes for using bold for weight.
*/
pattern = FcNameParse((FcChar8 *) WMGetFontName(font));
switch (style) {
case WFSNormal:
FcPatternDel(pattern, FC_WEIGHT);
FcPatternDel(pattern, FC_SLANT);
break;
case WFSBold:
FcPatternDel(pattern, FC_WEIGHT);
FcPatternAddString(pattern, FC_WEIGHT, (FcChar8 *) "bold");
break;
case WFSItalic:
FcPatternDel(pattern, FC_SLANT);
FcPatternAddString(pattern, FC_SLANT, (FcChar8 *) "italic");
break;
case WFSBoldItalic:
FcPatternDel(pattern, FC_WEIGHT);
FcPatternDel(pattern, FC_SLANT);
FcPatternAddString(pattern, FC_WEIGHT, (FcChar8 *) "bold");
FcPatternAddString(pattern, FC_SLANT, (FcChar8 *) "italic");
break;
}
name = (char *)FcNameUnparse(pattern);
copy = WMCreateFont(scrPtr, name);
FcPatternDestroy(pattern);
free(name);
return copy;
}

View File

@@ -1,825 +0,0 @@
#include "WINGsP.h"
#include "WUtil.h"
#include "wconfig.h"
#include <ctype.h>
#include <string.h>
#include <strings.h>
#include <stdint.h>
#include <X11/Xft/Xft.h>
#include <fontconfig/fontconfig.h>
/* XXX TODO */
char *WMFontPanelFontChangedNotification = "WMFontPanelFontChangedNotification";
typedef struct W_FontPanel {
WMWindow *win;
WMFrame *upperF;
WMTextField *sampleT;
WMSplitView *split;
WMFrame *lowerF;
WMLabel *famL;
WMList *famLs;
WMLabel *typL;
WMList *typLs;
WMLabel *sizL;
WMTextField *sizT;
WMList *sizLs;
WMAction2 *action;
void *data;
WMButton *revertB;
WMButton *setB;
WMPropList *fdb;
} FontPanel;
#define MIN_UPPER_HEIGHT 20
#define MIN_LOWER_HEIGHT 140
#define BUTTON_SPACE_HEIGHT 40
#define MIN_WIDTH 250
#define MIN_HEIGHT (MIN_UPPER_HEIGHT+MIN_LOWER_HEIGHT+BUTTON_SPACE_HEIGHT)
#define DEF_UPPER_HEIGHT 60
#define DEF_LOWER_HEIGHT 310
#define DEF_WIDTH 320
#define DEF_HEIGHT (DEF_UPPER_HEIGHT+DEF_LOWER_HEIGHT)
static const int scalableFontSizes[] = {
8,
10,
11,
12,
14,
16,
18,
20,
24,
36,
48,
64
};
static void setFontPanelFontName(FontPanel * panel, const char *family, const char *style, double size);
static int isXLFD(const char *font, int *length_ret);
static void arrangeLowerFrame(FontPanel * panel);
static void familyClick(WMWidget *, void *);
static void typefaceClick(WMWidget *, void *);
static void sizeClick(WMWidget *, void *);
static void listFamilies(WMScreen * scr, WMFontPanel * panel);
static void splitViewConstrainCallback(WMSplitView * sPtr, int indView, int *min, int *max)
{
/* Parameter not used, but tell the compiler that it is ok */
(void) sPtr;
(void) max;
if (indView == 0)
*min = MIN_UPPER_HEIGHT;
else
*min = MIN_LOWER_HEIGHT;
}
static void notificationObserver(void *self, WMNotification * notif)
{
WMFontPanel *panel = (WMFontPanel *) self;
void *object = WMGetNotificationObject(notif);
if (WMGetNotificationName(notif) == WMViewSizeDidChangeNotification) {
if (object == WMWidgetView(panel->win)) {
int h = WMWidgetHeight(panel->win);
int w = WMWidgetWidth(panel->win);
WMResizeWidget(panel->split, w, h - BUTTON_SPACE_HEIGHT);
WMMoveWidget(panel->setB, w - 80, h - (BUTTON_SPACE_HEIGHT - 5));
WMMoveWidget(panel->revertB, w - 240, h - (BUTTON_SPACE_HEIGHT - 5));
} else if (object == WMWidgetView(panel->upperF)) {
if (WMWidgetHeight(panel->upperF) < MIN_UPPER_HEIGHT) {
WMResizeWidget(panel->upperF, WMWidgetWidth(panel->upperF), MIN_UPPER_HEIGHT);
} else {
WMResizeWidget(panel->sampleT, WMWidgetWidth(panel->upperF) - 20,
WMWidgetHeight(panel->upperF) - 10);
}
} else if (object == WMWidgetView(panel->lowerF)) {
if (WMWidgetHeight(panel->lowerF) < MIN_LOWER_HEIGHT) {
WMResizeWidget(panel->upperF, WMWidgetWidth(panel->upperF), MIN_UPPER_HEIGHT);
WMMoveWidget(panel->lowerF, 0, WMWidgetHeight(panel->upperF)
+ WMGetSplitViewDividerThickness(panel->split));
WMResizeWidget(panel->lowerF, WMWidgetWidth(panel->lowerF),
WMWidgetWidth(panel->split) - MIN_UPPER_HEIGHT
- WMGetSplitViewDividerThickness(panel->split));
} else {
arrangeLowerFrame(panel);
}
}
}
}
static void closeWindow(WMWidget * w, void *data)
{
FontPanel *panel = (FontPanel *) data;
/* Parameter not used, but tell the compiler that it is ok */
(void) w;
WMHideFontPanel(panel);
}
static void setClickedAction(WMWidget * w, void *data)
{
FontPanel *panel = (FontPanel *) data;
/* Parameter not used, but tell the compiler that it is ok */
(void) w;
if (panel->action)
(*panel->action) (panel, panel->data);
}
static void revertClickedAction(WMWidget * w, void *data)
{
/* Parameter not used, but tell the compiler that it is ok */
(void) w;
(void) data;
/*FontPanel *panel = (FontPanel*)data; */
/* XXX TODO */
}
WMFontPanel *WMGetFontPanel(WMScreen * scr)
{
FontPanel *panel;
WMColor *dark, *white;
WMFont *font;
int divThickness;
if (scr->sharedFontPanel)
return scr->sharedFontPanel;
panel = wmalloc(sizeof(FontPanel));
panel->win = WMCreateWindow(scr, "fontPanel");
/* WMSetWidgetBackgroundColor(panel->win, WMWhiteColor(scr)); */
WMSetWindowTitle(panel->win, _("Font Panel"));
WMResizeWidget(panel->win, DEF_WIDTH, DEF_HEIGHT);
WMSetWindowMinSize(panel->win, MIN_WIDTH, MIN_HEIGHT);
WMSetViewNotifySizeChanges(WMWidgetView(panel->win), True);
WMSetWindowCloseAction(panel->win, closeWindow, panel);
panel->split = WMCreateSplitView(panel->win);
WMResizeWidget(panel->split, DEF_WIDTH, DEF_HEIGHT - BUTTON_SPACE_HEIGHT);
WMSetSplitViewConstrainProc(panel->split, splitViewConstrainCallback);
divThickness = WMGetSplitViewDividerThickness(panel->split);
panel->upperF = WMCreateFrame(panel->win);
WMSetFrameRelief(panel->upperF, WRFlat);
WMSetViewNotifySizeChanges(WMWidgetView(panel->upperF), True);
panel->lowerF = WMCreateFrame(panel->win);
/* WMSetWidgetBackgroundColor(panel->lowerF, WMBlackColor(scr)); */
WMSetFrameRelief(panel->lowerF, WRFlat);
WMSetViewNotifySizeChanges(WMWidgetView(panel->lowerF), True);
WMAddSplitViewSubview(panel->split, W_VIEW(panel->upperF));
WMAddSplitViewSubview(panel->split, W_VIEW(panel->lowerF));
WMResizeWidget(panel->upperF, DEF_WIDTH, DEF_UPPER_HEIGHT);
WMResizeWidget(panel->lowerF, DEF_WIDTH, DEF_LOWER_HEIGHT);
WMMoveWidget(panel->lowerF, 0, 60 + divThickness);
white = WMWhiteColor(scr);
dark = WMDarkGrayColor(scr);
panel->sampleT = WMCreateTextField(panel->upperF);
WMResizeWidget(panel->sampleT, DEF_WIDTH - 20, 50);
WMMoveWidget(panel->sampleT, 10, 10);
WMSetTextFieldText(panel->sampleT, _("The quick brown fox jumps over the lazy dog"));
font = WMBoldSystemFontOfSize(scr, 12);
panel->famL = WMCreateLabel(panel->lowerF);
WMSetWidgetBackgroundColor(panel->famL, dark);
WMSetLabelText(panel->famL, _("Family"));
WMSetLabelFont(panel->famL, font);
WMSetLabelTextColor(panel->famL, white);
WMSetLabelRelief(panel->famL, WRSunken);
WMSetLabelTextAlignment(panel->famL, WACenter);
panel->famLs = WMCreateList(panel->lowerF);
WMSetListAction(panel->famLs, familyClick, panel);
panel->typL = WMCreateLabel(panel->lowerF);
WMSetWidgetBackgroundColor(panel->typL, dark);
WMSetLabelText(panel->typL, _("Typeface"));
WMSetLabelFont(panel->typL, font);
WMSetLabelTextColor(panel->typL, white);
WMSetLabelRelief(panel->typL, WRSunken);
WMSetLabelTextAlignment(panel->typL, WACenter);
panel->typLs = WMCreateList(panel->lowerF);
WMSetListAction(panel->typLs, typefaceClick, panel);
panel->sizL = WMCreateLabel(panel->lowerF);
WMSetWidgetBackgroundColor(panel->sizL, dark);
WMSetLabelText(panel->sizL, _("Size"));
WMSetLabelFont(panel->sizL, font);
WMSetLabelTextColor(panel->sizL, white);
WMSetLabelRelief(panel->sizL, WRSunken);
WMSetLabelTextAlignment(panel->sizL, WACenter);
panel->sizT = WMCreateTextField(panel->lowerF);
/* WMSetTextFieldAlignment(panel->sizT, WARight); */
panel->sizLs = WMCreateList(panel->lowerF);
WMSetListAction(panel->sizLs, sizeClick, panel);
WMReleaseFont(font);
WMReleaseColor(white);
WMReleaseColor(dark);
panel->setB = WMCreateCommandButton(panel->win);
WMResizeWidget(panel->setB, 70, 24);
WMMoveWidget(panel->setB, 240, DEF_HEIGHT - (BUTTON_SPACE_HEIGHT - 5));
WMSetButtonText(panel->setB, _("Set"));
WMSetButtonAction(panel->setB, setClickedAction, panel);
panel->revertB = WMCreateCommandButton(panel->win);
WMResizeWidget(panel->revertB, 70, 24);
WMMoveWidget(panel->revertB, 80, DEF_HEIGHT - (BUTTON_SPACE_HEIGHT - 5));
WMSetButtonText(panel->revertB, _("Revert"));
WMSetButtonAction(panel->revertB, revertClickedAction, panel);
WMRealizeWidget(panel->win);
WMMapSubwidgets(panel->upperF);
WMMapSubwidgets(panel->lowerF);
WMMapSubwidgets(panel->split);
WMMapSubwidgets(panel->win);
WMUnmapWidget(panel->revertB);
arrangeLowerFrame(panel);
scr->sharedFontPanel = panel;
/* register notification observers */
WMAddNotificationObserver(notificationObserver, panel,
WMViewSizeDidChangeNotification, WMWidgetView(panel->win));
WMAddNotificationObserver(notificationObserver, panel,
WMViewSizeDidChangeNotification, WMWidgetView(panel->upperF));
WMAddNotificationObserver(notificationObserver, panel,
WMViewSizeDidChangeNotification, WMWidgetView(panel->lowerF));
listFamilies(scr, panel);
return panel;
}
void WMFreeFontPanel(WMFontPanel * panel)
{
if (panel == WMWidgetScreen(panel->win)->sharedFontPanel) {
WMWidgetScreen(panel->win)->sharedFontPanel = NULL;
}
WMRemoveNotificationObserver(panel);
WMUnmapWidget(panel->win);
WMDestroyWidget(panel->win);
wfree(panel);
}
void WMShowFontPanel(WMFontPanel * panel)
{
WMMapWidget(panel->win);
}
void WMHideFontPanel(WMFontPanel * panel)
{
WMUnmapWidget(panel->win);
}
WMFont *WMGetFontPanelFont(WMFontPanel * panel)
{
return WMGetTextFieldFont(panel->sampleT);
}
void WMSetFontPanelFont(WMFontPanel * panel, const char *fontName)
{
int fname_len;
FcPattern *pattern;
FcChar8 *family, *style;
double size;
if (!isXLFD(fontName, &fname_len)) {
/* maybe its proper fontconfig and we can parse it */
pattern = FcNameParse((const FcChar8 *) fontName);
} else {
/* maybe its proper xlfd and we can convert it to an FcPattern */
pattern = XftXlfdParse(fontName, False, False);
/*//FcPatternPrint(pattern); */
}
if (!pattern)
return;
if (FcPatternGetString(pattern, FC_FAMILY, 0, &family) == FcResultMatch)
if (FcPatternGetString(pattern, FC_STYLE, 0, &style) == FcResultMatch)
if (FcPatternGetDouble(pattern, "pixelsize", 0, &size) == FcResultMatch)
setFontPanelFontName(panel, (char *)family, (char *)style, size);
FcPatternDestroy(pattern);
}
void WMSetFontPanelAction(WMFontPanel * panel, WMAction2 * action, void *data)
{
panel->action = action;
panel->data = data;
}
static void arrangeLowerFrame(FontPanel * panel)
{
int width = WMWidgetWidth(panel->lowerF) - 55 - 30;
int height = WMWidgetHeight(panel->split) - WMWidgetHeight(panel->upperF);
int fw, tw, sw;
#define LABEL_HEIGHT 20
height -= WMGetSplitViewDividerThickness(panel->split);
height -= LABEL_HEIGHT + 8;
fw = (125 * width) / 235;
tw = (110 * width) / 235;
sw = 55;
WMMoveWidget(panel->famL, 10, 0);
WMResizeWidget(panel->famL, fw, LABEL_HEIGHT);
WMMoveWidget(panel->famLs, 10, 23);
WMResizeWidget(panel->famLs, fw, height);
WMMoveWidget(panel->typL, 10 + fw + 3, 0);
WMResizeWidget(panel->typL, tw, LABEL_HEIGHT);
WMMoveWidget(panel->typLs, 10 + fw + 3, 23);
WMResizeWidget(panel->typLs, tw, height);
WMMoveWidget(panel->sizL, 10 + fw + 3 + tw + 3, 0);
WMResizeWidget(panel->sizL, sw + 4, LABEL_HEIGHT);
WMMoveWidget(panel->sizT, 10 + fw + 3 + tw + 3, 23);
WMResizeWidget(panel->sizT, sw + 4, 20);
WMMoveWidget(panel->sizLs, 10 + fw + 3 + tw + 3, 46);
WMResizeWidget(panel->sizLs, sw + 4, height - 23);
}
#define NUM_FIELDS 14
static int isXLFD(const char *font, int *length_ret)
{
int c = 0;
*length_ret = 0;
while (*font) {
(*length_ret)++;
if (*font++ == '-')
c++;
}
return c == NUM_FIELDS;
}
typedef struct {
char *typeface;
WMArray *sizes;
} Typeface;
typedef struct {
char *name; /* gotta love simplicity */
WMArray *typefaces;
} Family;
static int compare_int(const void *a, const void *b)
{
int i1 = *(int *)a;
int i2 = *(int *)b;
if (i1 < i2)
return -1;
else if (i1 > i2)
return 1;
else
return 0;
}
static void addSizeToTypeface(Typeface * face, int size)
{
if (size == 0) {
int j;
for (j = 0; j < wlengthof(scalableFontSizes); j++) {
size = scalableFontSizes[j];
if (!WMCountInArray(face->sizes, (void *)(uintptr_t) size)) {
WMAddToArray(face->sizes, (void *)(uintptr_t) size);
}
}
WMSortArray(face->sizes, compare_int);
} else {
if (!WMCountInArray(face->sizes, (void *)(uintptr_t) size)) {
WMAddToArray(face->sizes, (void *)(uintptr_t) size);
WMSortArray(face->sizes, compare_int);
}
}
}
static void addTypefaceToXftFamily(Family * fam, const char *style)
{
Typeface *face;
WMArrayIterator i;
if (fam->typefaces) {
WM_ITERATE_ARRAY(fam->typefaces, face, i) {
if (strcmp(face->typeface, style) != 0)
continue; /* go to next interation */
addSizeToTypeface(face, 0);
return;
}
} else {
fam->typefaces = WMCreateArray(4);
}
face = wmalloc(sizeof(Typeface));
face->typeface = wstrdup(style);
face->sizes = WMCreateArray(4);
addSizeToTypeface(face, 0);
WMAddToArray(fam->typefaces, face);
}
/*
* families (same family name) (Hashtable of family -> array)
* registries (same family but different registries)
*
*/
static void addFontToXftFamily(WMHashTable * families, const char *name, const char *style)
{
WMArrayIterator i;
WMArray *array;
Family *fam;
array = WMHashGet(families, name);
if (array) {
WM_ITERATE_ARRAY(array, fam, i) {
if (strcmp(fam->name, name) == 0)
addTypefaceToXftFamily(fam, style);
return;
}
}
array = WMCreateArray(8);
fam = wmalloc(sizeof(Family));
fam->name = wstrdup(name);
addTypefaceToXftFamily(fam, style);
WMAddToArray(array, fam);
WMHashInsert(families, fam->name, array);
}
static void listFamilies(WMScreen * scr, WMFontPanel * panel)
{
FcObjectSet *os = 0;
FcFontSet *fs;
FcPattern *pat;
WMHashTable *families;
WMHashEnumerator enumer;
WMArray *array;
int i;
pat = FcPatternCreate();
os = FcObjectSetBuild(FC_FAMILY, FC_STYLE, NULL);
fs = FcFontList(0, pat, os);
if (!fs) {
WMRunAlertPanel(scr, panel->win, _("Error"),
_("Could not init font config library\n"), _("OK"), NULL, NULL);
return;
}
if (pat)
FcPatternDestroy(pat);
families = WMCreateStringHashTable();
if (fs) {
for (i = 0; i < fs->nfont; i++) {
FcChar8 *family;
FcChar8 *style;
if (FcPatternGetString(fs->fonts[i], FC_FAMILY, 0, &family) == FcResultMatch)
if (FcPatternGetString(fs->fonts[i], FC_STYLE, 0, &style) == FcResultMatch)
addFontToXftFamily(families, (char *)family, (char *)style);
}
FcFontSetDestroy(fs);
}
enumer = WMEnumerateHashTable(families);
while ((array = WMNextHashEnumeratorItem(&enumer))) {
WMArrayIterator i;
Family *fam;
char buffer[256];
WMListItem *item;
WM_ITERATE_ARRAY(array, fam, i) {
strlcpy(buffer, fam->name, sizeof(buffer));
item = WMAddListItem(panel->famLs, buffer);
item->clientData = fam;
}
WMFreeArray(array);
}
WMSortListItems(panel->famLs);
WMFreeHashTable(families);
}
static void getSelectedFont(FontPanel * panel, char buffer[], int bufsize)
{
WMListItem *item;
Family *family;
Typeface *face;
char *size;
item = WMGetListSelectedItem(panel->famLs);
if (!item)
return;
family = (Family *) item->clientData;
item = WMGetListSelectedItem(panel->typLs);
if (!item)
return;
face = (Typeface *) item->clientData;
size = WMGetTextFieldText(panel->sizT);
snprintf(buffer, bufsize, "%s:style=%s:pixelsize=%s", family->name, face->typeface, size);
wfree(size);
}
static void preview(FontPanel * panel)
{
char buffer[512];
WMFont *font;
getSelectedFont(panel, buffer, sizeof(buffer));
font = WMCreateFont(WMWidgetScreen(panel->win), buffer);
if (font) {
WMSetTextFieldFont(panel->sampleT, font);
WMReleaseFont(font);
}
}
static void familyClick(WMWidget * w, void *data)
{
WMList *lPtr = (WMList *) w;
WMListItem *item;
Family *family;
Typeface *face;
FontPanel *panel = (FontPanel *) data;
WMArrayIterator i;
/* current typeface and size */
char *oface = NULL;
char *osize = NULL;
int facei = -1;
int sizei = -1;
/* must try to keep the same typeface and size for the new family */
item = WMGetListSelectedItem(panel->typLs);
if (item)
oface = wstrdup(item->text);
osize = WMGetTextFieldText(panel->sizT);
item = WMGetListSelectedItem(lPtr);
family = (Family *) item->clientData;
WMClearList(panel->typLs);
WM_ITERATE_ARRAY(family->typefaces, face, i) {
char buffer[256];
int top = 0;
WMListItem *fitem;
strlcpy(buffer, face->typeface, sizeof(buffer));
if (strcasecmp(face->typeface, "Roman") == 0)
top = 1;
if (strcasecmp(face->typeface, "Regular") == 0)
top = 1;
if (top)
fitem = WMInsertListItem(panel->typLs, 0, buffer);
else
fitem = WMAddListItem(panel->typLs, buffer);
fitem->clientData = face;
}
if (oface) {
facei = WMFindRowOfListItemWithTitle(panel->typLs, oface);
wfree(oface);
}
if (facei < 0) {
facei = 0;
}
WMSelectListItem(panel->typLs, facei);
typefaceClick(panel->typLs, panel);
if (osize) {
sizei = WMFindRowOfListItemWithTitle(panel->sizLs, osize);
}
if (sizei >= 0) {
WMSelectListItem(panel->sizLs, sizei);
sizeClick(panel->sizLs, panel);
}
if (osize)
wfree(osize);
preview(panel);
}
static void typefaceClick(WMWidget * w, void *data)
{
FontPanel *panel = (FontPanel *) data;
WMListItem *item;
Typeface *face;
WMArrayIterator i;
char buffer[32];
char *osize = NULL;
int sizei = -1;
void *size;
/* Parameter not used, but tell the compiler that it is ok */
(void) w;
osize = WMGetTextFieldText(panel->sizT);
item = WMGetListSelectedItem(panel->typLs);
face = (Typeface *) item->clientData;
WMClearList(panel->sizLs);
WM_ITERATE_ARRAY(face->sizes, size, i) {
if (size != NULL) {
int size_int = (intptr_t) size;
sprintf(buffer, "%i", size_int);
WMAddListItem(panel->sizLs, buffer);
}
}
if (osize) {
sizei = WMFindRowOfListItemWithTitle(panel->sizLs, osize);
}
if (sizei < 0) {
sizei = WMFindRowOfListItemWithTitle(panel->sizLs, "12");
}
if (sizei < 0) {
sizei = 0;
}
WMSelectListItem(panel->sizLs, sizei);
WMSetListPosition(panel->sizLs, sizei);
sizeClick(panel->sizLs, panel);
if (osize)
wfree(osize);
preview(panel);
}
static void sizeClick(WMWidget * w, void *data)
{
FontPanel *panel = (FontPanel *) data;
WMListItem *item;
/* Parameter not used, but tell the compiler that it is ok */
(void) w;
item = WMGetListSelectedItem(panel->sizLs);
WMSetTextFieldText(panel->sizT, item->text);
WMSelectTextFieldRange(panel->sizT, wmkrange(0, strlen(item->text)));
preview(panel);
}
static void setFontPanelFontName(FontPanel * panel, const char *family, const char *style, double size)
{
int famrow;
int stlrow;
int sz;
char asize[64];
void *vsize;
WMListItem *item;
Family *fam;
Typeface *face;
WMArrayIterator i;
famrow = WMFindRowOfListItemWithTitle(panel->famLs, family);
if (famrow < 0) {
famrow = 0;
return;
}
WMSelectListItem(panel->famLs, famrow);
WMSetListPosition(panel->famLs, famrow);
WMClearList(panel->typLs);
item = WMGetListSelectedItem(panel->famLs);
fam = (Family *) item->clientData;
WM_ITERATE_ARRAY(fam->typefaces, face, i) {
char buffer[256];
int top = 0;
WMListItem *fitem;
strlcpy(buffer, face->typeface, sizeof(buffer));
if (strcasecmp(face->typeface, "Roman") == 0)
top = 1;
if (top)
fitem = WMInsertListItem(panel->typLs, 0, buffer);
else
fitem = WMAddListItem(panel->typLs, buffer);
fitem->clientData = face;
}
stlrow = WMFindRowOfListItemWithTitle(panel->typLs, style);
if (stlrow < 0) {
stlrow = 0;
return;
}
WMSelectListItem(panel->typLs, stlrow);
item = WMGetListSelectedItem(panel->typLs);
face = (Typeface *) item->clientData;
WMClearList(panel->sizLs);
WM_ITERATE_ARRAY(face->sizes, vsize, i) {
char buffer[32];
if (vsize != NULL) {
int size_int = (intptr_t) vsize;
sprintf(buffer, "%i", size_int);
WMAddListItem(panel->sizLs, buffer);
}
}
snprintf(asize, sizeof(asize) - 1, "%d", (int)(size + 0.5));
sz = WMFindRowOfListItemWithTitle(panel->sizLs, asize);
if (sz < 0) {
return;
}
WMSelectListItem(panel->sizLs, sz);
sizeClick(panel->sizLs, panel);
return;
}

View File

@@ -629,7 +629,8 @@ WMScreen *WMCreateScreenWithRContext(Display * display, int screen, RContext * c
scrPtr->rootWin = RootWindow(display, screen);
scrPtr->fontCache = WMCreateStringHashTable();
// Will be initialized lazily in wings-rs/src/screen.rs.
scrPtr->fontCache = NULL;
scrPtr->xftdraw = XftDrawCreate(scrPtr->display, W_DRAWABLE(scrPtr), scrPtr->visual, scrPtr->colormap);
@@ -909,18 +910,6 @@ WMScreen *WMCreateScreenWithRContext(Display * display, int screen, RContext * c
return scrPtr;
}
void WMSetWidgetDefaultFont(WMScreen * scr, WMFont * font)
{
WMReleaseFont(scr->normalFont);
scr->normalFont = WMRetainFont(font);
}
void WMSetWidgetDefaultBoldFont(WMScreen * scr, WMFont * font)
{
WMReleaseFont(scr->boldFont);
scr->boldFont = WMRetainFont(font);
}
void WMHangData(WMWidget * widget, void *data)
{
W_VIEW(widget)->hangedData = data;

993
WINGs/wings-rs-tests/Cargo.lock generated Normal file
View File

@@ -0,0 +1,993 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 4
[[package]]
name = "adler2"
version = "2.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa"
[[package]]
name = "allocator-api2"
version = "0.2.21"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923"
[[package]]
name = "anyhow"
version = "1.0.102"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c"
[[package]]
name = "atomic-write-file"
version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "84790c55b5704b0d35130bf16a4ce22a8e70eb0ea773522557524d9a4852663d"
dependencies = [
"nix",
"rand 0.9.2",
]
[[package]]
name = "bitflags"
version = "2.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "843867be96c8daad0d758b57df9392b6d8d271134fce549de6ce169ff98a92af"
[[package]]
name = "cc"
version = "1.2.56"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "aebf35691d1bfb0ac386a69bac2fde4dd276fb618cf8bf4f5318fe285e821bb2"
dependencies = [
"find-msvc-tools",
"shlex",
]
[[package]]
name = "cfg-expr"
version = "0.20.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "78cef5b5a1a6827c7322ae2a636368a573006b27cfa76c7ebd53e834daeaab6a"
dependencies = [
"smallvec",
"target-lexicon",
]
[[package]]
name = "cfg-if"
version = "1.0.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
[[package]]
name = "cfg_aliases"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "613afe47fcd5fac7ccf1db93babcb082c5994d996f20b8b159f2ad1658eb5724"
[[package]]
name = "console"
version = "0.16.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d64e8af5551369d19cf50138de61f1c42074ab970f74e99be916646777f8fc87"
dependencies = [
"encode_unicode",
"libc",
"windows-sys",
]
[[package]]
name = "crc32fast"
version = "1.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9481c1c90cbf2ac953f07c8d4a58aa3945c425b7185c9154d67a65e4230da511"
dependencies = [
"cfg-if",
]
[[package]]
name = "dlib"
version = "0.5.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ab8ecd87370524b461f8557c119c405552c396ed91fc0a8eec68679eab26f94a"
dependencies = [
"libloading",
]
[[package]]
name = "encode_unicode"
version = "1.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "34aa73646ffb006b8f5147f3dc182bd4bcb190227ce861fc4a4844bf8e3cb2c0"
[[package]]
name = "equivalent"
version = "1.0.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f"
[[package]]
name = "errno"
version = "0.3.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb"
dependencies = [
"libc",
"windows-sys",
]
[[package]]
name = "fastrand"
version = "2.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be"
[[package]]
name = "fdeflate"
version = "0.3.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1e6853b52649d4ac5c0bd02320cddc5ba956bdb407c4b75a2c6b75bf51500f8c"
dependencies = [
"simd-adler32",
]
[[package]]
name = "find-msvc-tools"
version = "0.1.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5baebc0774151f905a1a2cc41989300b1e6fbb29aff0ceffa1064fdd3088d582"
[[package]]
name = "flate2"
version = "1.1.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "843fba2746e448b37e26a819579957415c8cef339bf08564fe8b7ddbd959573c"
dependencies = [
"crc32fast",
"miniz_oxide",
]
[[package]]
name = "foldhash"
version = "0.1.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2"
[[package]]
name = "foldhash"
version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "77ce24cb58228fbb8aa041425bb1050850ac19177686ea6e0f41a70416f56fdb"
[[package]]
name = "fuchsia-cprng"
version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a06f77d526c1a601b7c4cdd98f54b5eaabffc14d5f2f0296febdc7f357c6d3ba"
[[package]]
name = "getrandom"
version = "0.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "899def5c37c4fd7b2664648c28120ecec138e4d395b459e5ca34f9cce2dd77fd"
dependencies = [
"cfg-if",
"libc",
"r-efi",
"wasip2",
]
[[package]]
name = "getrandom"
version = "0.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "139ef39800118c7683f2fd3c98c1b23c09ae076556b435f8e9064ae108aaeeec"
dependencies = [
"cfg-if",
"libc",
"r-efi",
"wasip2",
"wasip3",
]
[[package]]
name = "glib-sys"
version = "0.21.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2d95e1a3a19ae464a7286e14af9a90683c64d70c02532d88d87ce95056af3e6c"
dependencies = [
"libc",
"system-deps",
]
[[package]]
name = "gobject-sys"
version = "0.21.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2dca35da0d19a18f4575f3cb99fe1c9e029a2941af5662f326f738a21edaf294"
dependencies = [
"glib-sys",
"libc",
"system-deps",
]
[[package]]
name = "hashbrown"
version = "0.15.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9229cfe53dfd69f0609a49f65461bd93001ea1ef889cd5529dd176593f5338a1"
dependencies = [
"foldhash 0.1.5",
]
[[package]]
name = "hashbrown"
version = "0.16.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "841d1cc9bed7f9236f321df977030373f4a4163ae1a7dbfe1a51a2c1a51d9100"
dependencies = [
"allocator-api2",
"equivalent",
"foldhash 0.2.0",
]
[[package]]
name = "heck"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
[[package]]
name = "id-arena"
version = "2.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3d3067d79b975e8844ca9eb072e16b31c3c1c36928edf9c6789548c524d0d954"
[[package]]
name = "indexmap"
version = "2.13.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7714e70437a7dc3ac8eb7e6f8df75fd8eb422675fc7678aff7364301092b1017"
dependencies = [
"equivalent",
"hashbrown 0.16.1",
"serde",
"serde_core",
]
[[package]]
name = "insta"
version = "1.47.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6f40e41efb5f592d3a0764f818e2f08e5e21c4f368126f74f37c81bd4af7a0c6"
dependencies = [
"console",
"once_cell",
"similar",
"tempfile",
]
[[package]]
name = "insta-image"
version = "1.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7996488b176249911af0e5d17b2bdfe43e33267f650291cb874c0d4654e1dcb8"
dependencies = [
"insta",
"png",
]
[[package]]
name = "itoa"
version = "1.0.17"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "92ecc6618181def0457392ccd0ee51198e065e016d1d527a7ac1b6dc7c1f09d2"
[[package]]
name = "leb128fmt"
version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "09edd9e8b54e49e587e4f6295a7d29c3ea94d469cb40ab8ca70b288248a81db2"
[[package]]
name = "libc"
version = "0.2.182"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6800badb6cb2082ffd7b6a67e6125bb39f18782f793520caee8cb8846be06112"
[[package]]
name = "libloading"
version = "0.8.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d7c4b02199fee7c5d21a5ae7d8cfa79a6ef5bb2fc834d6e9058e89c825efdc55"
dependencies = [
"cfg-if",
"windows-link",
]
[[package]]
name = "linux-raw-sys"
version = "0.12.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53"
[[package]]
name = "log"
version = "0.4.29"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5e5032e24019045c762d3c0f28f5b6b8bbf38563a65908389bf7978758920897"
[[package]]
name = "memchr"
version = "2.8.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79"
[[package]]
name = "miniz_oxide"
version = "0.8.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1fa76a2c86f704bdb222d66965fb3d63269ce38518b83cb0575fca855ebb6316"
dependencies = [
"adler2",
"simd-adler32",
]
[[package]]
name = "nix"
version = "0.30.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "74523f3a35e05aba87a1d978330aef40f67b0304ac79c1c00b294c9830543db6"
dependencies = [
"bitflags",
"cfg-if",
"cfg_aliases",
"libc",
]
[[package]]
name = "nom"
version = "8.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "df9761775871bdef83bee530e60050f7e54b1105350d6884eb0fb4f46c2f9405"
dependencies = [
"memchr",
]
[[package]]
name = "nom-language"
version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2de2bc5b451bfedaef92c90b8939a8fff5770bdcc1fafd6239d086aab8fa6b29"
dependencies = [
"nom",
]
[[package]]
name = "once_cell"
version = "1.21.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d"
[[package]]
name = "pango-sys"
version = "0.21.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b4f06627d36ed5ff303d2df65211fc2e52ba5b17bf18dd80ff3d9628d6e06cfd"
dependencies = [
"glib-sys",
"gobject-sys",
"libc",
"system-deps",
]
[[package]]
name = "pkg-config"
version = "0.3.32"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7edddbd0b52d732b21ad9a5fab5c704c14cd949e5e9a1ec5929a24fded1b904c"
[[package]]
name = "png"
version = "0.18.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "60769b8b31b2a9f263dae2776c37b1b28ae246943cf719eb6946a1db05128a61"
dependencies = [
"bitflags",
"crc32fast",
"fdeflate",
"flate2",
"miniz_oxide",
]
[[package]]
name = "ppv-lite86"
version = "0.2.21"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9"
dependencies = [
"zerocopy",
]
[[package]]
name = "prettyplease"
version = "0.2.37"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "479ca8adacdd7ce8f1fb39ce9ecccbfe93a3f1344b3d0d97f20bc0196208f62b"
dependencies = [
"proc-macro2",
"syn",
]
[[package]]
name = "proc-macro2"
version = "1.0.106"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
dependencies = [
"unicode-ident",
]
[[package]]
name = "quote"
version = "1.0.44"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "21b2ebcf727b7760c461f091f9f0f539b77b8e87f2fd88131e7f1b433b3cece4"
dependencies = [
"proc-macro2",
]
[[package]]
name = "r-efi"
version = "5.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "69cdb34c158ceb288df11e18b4bd39de994f6657d83847bdffdbd7f346754b0f"
[[package]]
name = "rand"
version = "0.4.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "552840b97013b1a26992c11eac34bdd778e464601a4c2054b5f0bff7c6761293"
dependencies = [
"fuchsia-cprng",
"libc",
"rand_core 0.3.1",
"rdrand",
"winapi",
]
[[package]]
name = "rand"
version = "0.9.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6db2770f06117d490610c7488547d543617b21bfa07796d7a12f6f1bd53850d1"
dependencies = [
"rand_chacha",
"rand_core 0.9.5",
]
[[package]]
name = "rand_chacha"
version = "0.9.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb"
dependencies = [
"ppv-lite86",
"rand_core 0.9.5",
]
[[package]]
name = "rand_core"
version = "0.3.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7a6fdeb83b075e8266dcc8762c22776f6877a63111121f5f8c7411e5be7eed4b"
dependencies = [
"rand_core 0.4.2",
]
[[package]]
name = "rand_core"
version = "0.4.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9c33a3c44ca05fa6f1807d8e6743f3824e8509beca625669633be0acbdf509dc"
[[package]]
name = "rand_core"
version = "0.9.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "76afc826de14238e6e8c374ddcc1fa19e374fd8dd986b0d2af0d02377261d83c"
dependencies = [
"getrandom 0.3.4",
]
[[package]]
name = "rdrand"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "678054eb77286b51581ba43620cc911abf02758c91f93f479767aed0f90458b2"
dependencies = [
"rand_core 0.3.1",
]
[[package]]
name = "remove_dir_all"
version = "0.5.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3acd125665422973a33ac9d3dd2df85edad0f4ae9b00dafb1a05e43a9f5ef8e7"
dependencies = [
"winapi",
]
[[package]]
name = "rustix"
version = "1.1.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b6fe4565b9518b83ef4f91bb47ce29620ca828bd32cb7e408f0062e9930ba190"
dependencies = [
"bitflags",
"errno",
"libc",
"linux-raw-sys",
"windows-sys",
]
[[package]]
name = "semver"
version = "1.0.27"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d767eb0aabc880b29956c35734170f26ed551a859dbd361d140cdbeca61ab1e2"
[[package]]
name = "serde"
version = "1.0.228"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
dependencies = [
"serde_core",
]
[[package]]
name = "serde_core"
version = "1.0.228"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad"
dependencies = [
"serde_derive",
]
[[package]]
name = "serde_derive"
version = "1.0.228"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "serde_json"
version = "1.0.149"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "83fc039473c5595ace860d8c4fafa220ff474b3fc6bfdb4293327f1a37e94d86"
dependencies = [
"itoa",
"memchr",
"serde",
"serde_core",
"zmij",
]
[[package]]
name = "serde_spanned"
version = "1.0.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f8bbf91e5a4d6315eee45e704372590b30e260ee83af6639d64557f51b067776"
dependencies = [
"serde_core",
]
[[package]]
name = "shlex"
version = "1.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
[[package]]
name = "simd-adler32"
version = "0.3.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e320a6c5ad31d271ad523dcf3ad13e2767ad8b1cb8f047f75a8aeaf8da139da2"
[[package]]
name = "similar"
version = "2.7.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bbbb5d9659141646ae647b42fe094daf6c6192d1620870b449d9557f748b2daa"
[[package]]
name = "smallvec"
version = "1.15.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03"
[[package]]
name = "syn"
version = "2.0.117"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
dependencies = [
"proc-macro2",
"quote",
"unicode-ident",
]
[[package]]
name = "system-deps"
version = "7.0.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "48c8f33736f986f16d69b6cb8b03f55ddcad5c41acc4ccc39dd88e84aa805e7f"
dependencies = [
"cfg-expr",
"heck",
"pkg-config",
"toml",
"version-compare",
]
[[package]]
name = "target-lexicon"
version = "0.13.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "df7f62577c25e07834649fc3b39fafdc597c0a3527dc1c60129201ccfcbaa50c"
[[package]]
name = "tempdir"
version = "0.3.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "15f2b5fb00ccdf689e0149d1b1b3c03fead81c2b37735d812fa8bddbbf41b6d8"
dependencies = [
"rand 0.4.6",
"remove_dir_all",
]
[[package]]
name = "tempfile"
version = "3.26.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "82a72c767771b47409d2345987fda8628641887d5466101319899796367354a0"
dependencies = [
"fastrand",
"getrandom 0.4.1",
"once_cell",
"rustix",
"windows-sys",
]
[[package]]
name = "toml"
version = "0.9.12+spec-1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cf92845e79fc2e2def6a5d828f0801e29a2f8acc037becc5ab08595c7d5e9863"
dependencies = [
"indexmap",
"serde_core",
"serde_spanned",
"toml_datetime",
"toml_parser",
"toml_writer",
"winnow",
]
[[package]]
name = "toml_datetime"
version = "0.7.5+spec-1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "92e1cfed4a3038bc5a127e35a2d360f145e1f4b971b551a2ba5fd7aedf7e1347"
dependencies = [
"serde_core",
]
[[package]]
name = "toml_parser"
version = "1.0.9+spec-1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "702d4415e08923e7e1ef96cd5727c0dfed80b4d2fa25db9647fe5eb6f7c5a4c4"
dependencies = [
"winnow",
]
[[package]]
name = "toml_writer"
version = "1.0.6+spec-1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ab16f14aed21ee8bfd8ec22513f7287cd4a91aa92e44edfe2c17ddd004e92607"
[[package]]
name = "unicode-ident"
version = "1.0.24"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
[[package]]
name = "unicode-xid"
version = "0.2.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853"
[[package]]
name = "version-compare"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "03c2856837ef78f57382f06b2b8563a2f512f7185d732608fd9176cb3b8edf0e"
[[package]]
name = "wasip2"
version = "1.0.2+wasi-0.2.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9517f9239f02c069db75e65f174b3da828fe5f5b945c4dd26bd25d89c03ebcf5"
dependencies = [
"wit-bindgen",
]
[[package]]
name = "wasip3"
version = "0.4.0+wasi-0.3.0-rc-2026-01-06"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5428f8bf88ea5ddc08faddef2ac4a67e390b88186c703ce6dbd955e1c145aca5"
dependencies = [
"wit-bindgen",
]
[[package]]
name = "wasm-encoder"
version = "0.244.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "990065f2fe63003fe337b932cfb5e3b80e0b4d0f5ff650e6985b1048f62c8319"
dependencies = [
"leb128fmt",
"wasmparser",
]
[[package]]
name = "wasm-metadata"
version = "0.244.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bb0e353e6a2fbdc176932bbaab493762eb1255a7900fe0fea1a2f96c296cc909"
dependencies = [
"anyhow",
"indexmap",
"wasm-encoder",
"wasmparser",
]
[[package]]
name = "wasmparser"
version = "0.244.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "47b807c72e1bac69382b3a6fb3dbe8ea4c0ed87ff5629b8685ae6b9a611028fe"
dependencies = [
"bitflags",
"hashbrown 0.15.5",
"indexmap",
"semver",
]
[[package]]
name = "winapi"
version = "0.3.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
dependencies = [
"winapi-i686-pc-windows-gnu",
"winapi-x86_64-pc-windows-gnu",
]
[[package]]
name = "winapi-i686-pc-windows-gnu"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
[[package]]
name = "winapi-x86_64-pc-windows-gnu"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
[[package]]
name = "windows-link"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
[[package]]
name = "windows-sys"
version = "0.61.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc"
dependencies = [
"windows-link",
]
[[package]]
name = "wings-rs"
version = "0.1.0"
dependencies = [
"libc",
"pango-sys",
"wutil-rs",
"x11",
"yeslogic-fontconfig-sys",
]
[[package]]
name = "wings-rs-tests"
version = "0.1.0"
dependencies = [
"insta",
"insta-image",
"libc",
"png",
"tempdir",
"wings-rs",
"wutil-rs",
"x11",
]
[[package]]
name = "winnow"
version = "0.7.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5a5364e9d77fcdeeaa6062ced926ee3381faa2ee02d3eb83a5c27a8825540829"
[[package]]
name = "wit-bindgen"
version = "0.51.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d7249219f66ced02969388cf2bb044a09756a083d0fab1e566056b04d9fbcaa5"
dependencies = [
"wit-bindgen-rust-macro",
]
[[package]]
name = "wit-bindgen-core"
version = "0.51.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ea61de684c3ea68cb082b7a88508a8b27fcc8b797d738bfc99a82facf1d752dc"
dependencies = [
"anyhow",
"heck",
"wit-parser",
]
[[package]]
name = "wit-bindgen-rust"
version = "0.51.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b7c566e0f4b284dd6561c786d9cb0142da491f46a9fbed79ea69cdad5db17f21"
dependencies = [
"anyhow",
"heck",
"indexmap",
"prettyplease",
"syn",
"wasm-metadata",
"wit-bindgen-core",
"wit-component",
]
[[package]]
name = "wit-bindgen-rust-macro"
version = "0.51.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0c0f9bfd77e6a48eccf51359e3ae77140a7f50b1e2ebfe62422d8afdaffab17a"
dependencies = [
"anyhow",
"prettyplease",
"proc-macro2",
"quote",
"syn",
"wit-bindgen-core",
"wit-bindgen-rust",
]
[[package]]
name = "wit-component"
version = "0.244.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9d66ea20e9553b30172b5e831994e35fbde2d165325bec84fc43dbf6f4eb9cb2"
dependencies = [
"anyhow",
"bitflags",
"indexmap",
"log",
"serde",
"serde_derive",
"serde_json",
"wasm-encoder",
"wasm-metadata",
"wasmparser",
"wit-parser",
]
[[package]]
name = "wit-parser"
version = "0.244.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ecc8ac4bc1dc3381b7f59c34f00b67e18f910c2c0f50015669dde7def656a736"
dependencies = [
"anyhow",
"id-arena",
"indexmap",
"log",
"semver",
"serde",
"serde_derive",
"serde_json",
"unicode-xid",
"wasmparser",
]
[[package]]
name = "wutil-rs"
version = "0.1.0"
dependencies = [
"atomic-write-file",
"cc",
"hashbrown 0.16.1",
"nom",
"nom-language",
"x11",
]
[[package]]
name = "x11"
version = "2.21.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "502da5464ccd04011667b11c435cb992822c2c0dbde1770c988480d312a0db2e"
dependencies = [
"libc",
"pkg-config",
]
[[package]]
name = "yeslogic-fontconfig-sys"
version = "6.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "503a066b4c037c440169d995b869046827dbc71263f6e8f3be6d77d4f3229dbd"
dependencies = [
"dlib",
"once_cell",
"pkg-config",
]
[[package]]
name = "zerocopy"
version = "0.8.40"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a789c6e490b576db9f7e6b6d661bcc9799f7c0ac8352f56ea20193b2681532e5"
dependencies = [
"zerocopy-derive",
]
[[package]]
name = "zerocopy-derive"
version = "0.8.40"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f65c489a7071a749c849713807783f70672b28094011623e200cb86dcb835953"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "zmij"
version = "1.0.21"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b8848ee67ecc8aedbaf3e4122217aff892639231befc6a1b58d29fff4c2cabaa"

View File

@@ -0,0 +1,18 @@
[package]
name = "wings-rs-tests"
version = "0.1.0"
edition = "2024"
[dependencies]
libc = "0.2"
insta = "1.47"
insta-image = { version = "1.0", features = ["png"] }
png = "0.18"
tempdir = "0.3.7"
wings-rs = { path = "../wings-rs" }
wutil-rs = { path = "../../wutil-rs" }
x11 = "2.21.0"
[profile.dev.package]
insta.opt-level = 3
similar.opt-level = 3

View File

@@ -0,0 +1,45 @@
AUTOMAKE_OPTIONS =
RUST_SOURCES = \
examples/font_panel.rs \
src/headless/mod.rs \
src/headless/snapshots/wings_rs_tests__headless__xvfb__tests__blank_screen.snap \
src/headless/snapshots/wings_rs_tests__headless__xvfb__tests__blank_screen.snap.png \
src/headless/snapshots/wings_rs_tests__headless__xvfb__tests__snowlamp_in_window.snap \
src/headless/snapshots/wings_rs_tests__headless__xvfb__tests__snowlamp_in_window.snap.png \
src/headless/snapshots/wings_rs_tests__headless__xvfb__tests__xeyes.snap \
src/headless/snapshots/wings_rs_tests__headless__xvfb__tests__xeyes.snap.png \
src/headless/snapshots/wings_rs_tests__headless__xwd__tests__snowlamp_encoded.snap \
src/headless/snapshots/wings_rs_tests__headless__xwd__tests__snowlamp_encoded.snap.png \
src/headless/snowlamp.xwd \
src/headless/xvfb.rs \
src/headless/xwd.rs \
src/lib.rs \
tests/font_panel_tests.rs \
tests/snapshots/font_panel_tests__font_panel.snap \
tests/snapshots/font_panel_tests__font_panel.snap.png
RUST_EXTRA = \
Cargo.lock \
Cargo.toml
wutil_c_lib = $(top_builddir)/WINGs/libWUtil.la
wings_c_lib = $(top_builddir)/WINGs/libWINGs.la
wings_rs_lib = $(top_builddir)/WINGs/wings-rs/target/debug/libwings_rs.a
wings_rs_test_lib = target/debug/libwings_rs_tests.rlib
rustlib: $(RUST_SOURCES) $(RUST_EXTRA)
cargo build
check-local: rustlib
clean-local:
$(CARGO) clean
all: rustlib
# Tests run with cargo-nextest because it puts each application test in its own
# process, and WINGs currently assumes that it is running in a single-threaded
# environment.
test: rustlib
LD_LIBRARY_PATH=../.libs $(CARGO) nextest run

View File

@@ -0,0 +1,23 @@
fn main() {
println!("cargo:rustc-link-lib=static=X11");
println!("cargo:rustc-link-lib=static=xcb");
println!("cargo:rustc-link-lib=static=Xau");
println!("cargo:rustc-link-lib=static=Xdmcp");
println!("cargo::rustc-link-search=../.libs");
println!("cargo::rustc-link-arg-tests=-lWUtil");
println!("cargo::rustc-link-arg-tests=-lWINGs");
println!("cargo::rustc-link-arg-tests=-lX11");
println!("cargo::rustc-link-arg-tests=-lXft");
println!("cargo::rustc-link-arg-tests=-lpango-1.0");
println!("cargo::rustc-link-arg-tests=-lpangoxft-1.0");
println!("cargo::rustc-link-arg-tests=-lpangoft2-1.0");
println!("cargo::rustc-link-arg-examples=-lWUtil");
println!("cargo::rustc-link-arg-examples=-lWINGs");
println!("cargo::rustc-link-arg-examples=-lX11");
println!("cargo::rustc-link-arg-examples=-lXft");
println!("cargo::rustc-link-arg-examples=-lpango-1.0");
println!("cargo::rustc-link-arg-examples=-lpangoxft-1.0");
println!("cargo::rustc-link-arg-examples=-lpangoft2-1.0");
}

View File

@@ -0,0 +1,11 @@
use wings_rs::{font_panel::FontPanel, WINGsP::WMScreenMainLoop};
use wings_rs_tests::LiveApplication;
fn main() {
let app = LiveApplication::new("WMFontPanel");
let mut font_panel = FontPanel::new(app.screen.as_ptr()).expect("could not create font panel");
font_panel.show();
unsafe {
WMScreenMainLoop(app.screen.as_ptr());
}
}

View File

@@ -0,0 +1,133 @@
//! Provides utilites for integration tests that render to a headless X11 server.
//!
//! ## X11 `DISPLAY` value allocation
//!
//! When starting headless X servers, some care needs to be taken in selecting
//! display numbers. An X server needs to have a unique display number and will
//! not start if it is assigned a display number that is already in use.
//!
//! Local X servers usually leave a lockfile in `/tmp`, like `/tmp/.X0-lock` for
//! display 0. Avoiding the use of display numbers that have a corresponding
//! lockfile will get you part of the way towards avoiding collisions, but
//! further coordination is provided by the [`Lock`] and
//! [`DisplayNumberRegistry`] structs. These interfaces provide a mechanism for
//! claiming a display number in a way that coordinates across processes and
//! should be more efficient than simply scanning `/tmp` each time a new display
//! number is needed.
use std::{
fs,
io,
path::PathBuf,
sync::atomic::{self, AtomicU16},
};
pub mod xvfb;
pub mod xwd;
/// Represents a lock on a display number, which is released on drop.
pub struct Lock {
display: u16,
path: PathBuf,
}
/// Errors that may occur when trying to lock a display number.
pub enum LockError {
Io(io::Error),
Locked,
}
impl Lock {
pub(crate) fn new(display: u16, path: PathBuf) -> Self {
Lock {
display,
path
}
}
/// Returns the locked `DISPLAY` value.
pub fn display(&self) -> u16 {
self.display
}
}
impl Drop for Lock {
fn drop(&mut self) {
// `file` should be unlinked already, but we explicitly try to delete it
// and unwrap the result so that errors aren't dropped silently.
match fs::remove_file(&self.path) {
Ok(_) => (),
Err(e) if e.kind() == io::ErrorKind::NotFound => (),
Err(e) => panic!("could not unlink lock file: {:?}", e),
}
}
}
// Shared across threads in this process to help keep us from repeatedly asking
// for the same DISPLAY value.
static NEXT_DISPLAY: AtomicU16 = AtomicU16::new(32);
/// Coordinates on the value of `DISPLAY` to use when creating new X11 servers.
///
/// Methods on `DisplayNumberRegistry` may be called across threads or in
/// different processes to ensure that X servers are created with unique
/// display numbers.
pub struct DisplayNumberRegistry;
impl DisplayNumberRegistry {
/// Returns a lock on the first local display number (the `N` in `:N` for
/// the X client `DISPLAY` environment variable) that is not currently in
/// use.
///
/// If no display numbers are available, returns `None`.
///
/// To avoid collisions with other processes, attempts are made to sniff out
/// which display numbers are already in use by looking for lock files
/// matching the pattern `/tmp/.X*-lock`. If such a file exists, its
/// display number will not be used.
///
/// When an available display number is found, an empty lockfile is
/// atomically created (and marking the display number as claimed to other
/// well-behaved processes). When `Xvfb` is run using that display number,
/// it silently overwrites the empty lockfile.
///
/// Any extant lockfile should be deleted by the `Drop` impl for [`Lock`],
/// although tests that panic may leave stale lockfiles behind.
pub fn next_unused_display() -> io::Result<Lock> {
loop {
let prev = NEXT_DISPLAY.fetch_add(1, atomic::Ordering::SeqCst);
if prev == u16::MAX {
return Err(io::Error::other("display numbers exhausted; check /tmp/.X{n}-lock"));
}
let next = prev + 1;
let path = PathBuf::from(format!("/tmp/.X{}-lock", next));
match fs::OpenOptions::new()
.write(true)
.create_new(true)
.open(&path) {
Ok(_) => return Ok(Lock::new(next, path)),
Err(e) if e.kind() == io::ErrorKind::AlreadyExists => continue,
Err(e) => return Err(e),
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn find_unused_display() {
assert!(DisplayNumberRegistry::next_unused_display().is_ok());
assert_ne!(
DisplayNumberRegistry::next_unused_display()
.unwrap()
.display,
DisplayNumberRegistry::next_unused_display()
.unwrap()
.display
);
}
}

View File

@@ -0,0 +1,7 @@
---
source: src/headless/xvfb.rs
assertion_line: 387
expression: xwd.into_png().unwrap()
extension: png
snapshot_kind: binary
---

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 KiB

View File

@@ -0,0 +1,7 @@
---
source: src/headless/xvfb.rs
assertion_line: 416
expression: compressed
extension: png
snapshot_kind: binary
---

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

View File

@@ -0,0 +1,7 @@
---
source: src/headless/xvfb.rs
assertion_line: 402
expression: compressed
extension: png
snapshot_kind: binary
---

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

View File

@@ -0,0 +1,7 @@
---
source: src/headless/xwd.rs
assertion_line: 321
expression: snowlamp_xwd.into_png().unwrap()
extension: png
snapshot_kind: binary
---

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

View File

@@ -0,0 +1,471 @@
//! Provides utilities for headlessly running and taking screenshots of X11
//! programs in unit and integration tests.
//!
//! This uses [Xvfb](https://x.org/releases/X11R7.7/doc/man/man1/Xvfb.1.xhtml).
//!
//! Tests of this module invoke `xeyes` and `xwud` subprocesses. For all tests
//! to pass, you may need to install these X11 utilities and make them available
//! on your `PATH`.
use std::{
ffi::CString,
fs, io,
process::{Child, Command, ExitStatus, Stdio},
thread,
time::{Duration, Instant},
};
use tempdir::TempDir;
use super::xwd;
use super::Lock;
/// Arguments for `Xvfb`. Use `XvfbArgs::default()` for default values.
#[derive(Clone, Copy, Debug)]
pub struct XvfbArgs {
/// Width of the X11 screen.
pub width: u32,
/// Height of the X11 screen.
pub height: u32,
/// Bit depth of the X11 screen.
///
/// This should probably be one of 8, 16, or 24. (And if you don't choose 24
/// bits, you should have a good reason why.)
pub depth: u8,
}
impl Default for XvfbArgs {
fn default() -> Self {
XvfbArgs {
width: 640,
height: 480,
depth: 24,
}
}
}
/// A captive `Xvfb` process, with affordances for running subprocesses that
/// connect to it and taking screenshots.
///
/// When dropped, child processes will be killed automatically.
pub struct XvfbProcess {
lock: Lock,
framebuffer_directory: TempDir,
process: Child,
subprocesses: Vec<(Child, SubprocessMonitor)>,
is_shutdown: bool,
}
impl XvfbProcess {
/// Attempts to start `Xvfb` with default options.
///
/// Returns `None` if an error occurs while starting the `Xvfb` process.
pub fn start_default(lock: Lock) -> SubprocessResult<Self> {
XvfbProcess::start(lock, XvfbArgs::default())
}
/// Starts an `Xvfb` process with options specified by `args`.
///
/// Returns `None` if an error occurs while starting the `Xvfb` process.
///
/// This function connects to the `Xvfb` server briefly to try to ensure
/// that Xvfb is ready for clients to connect to it.
pub fn start(lock: Lock, args: XvfbArgs) -> SubprocessResult<Self> {
let framebuffer_directory = TempDir::new("wings_rs_xvfb").map_err(|e| {
SubprocessError::new("Xvfb temp dir".into(), SubprocessErrorType::Spawn(e))
})?;
#[cfg(target_os = "linux")]
unsafe {
// Kill children if this parent process dies catastrophically (e.g.,
// a test raises SIGABRT).
libc::prctl(libc::PR_SET_PDEATHSIG, libc::SIGKILL);
}
let process = Command::new("Xvfb")
.arg(format!(":{}", lock.display))
.arg("-screen")
.arg("0")
.arg(format!("{}x{}x{}", args.width, args.height, args.depth))
.arg("-fbdir")
.arg(format!("{}", framebuffer_directory.path().display()))
.stderr(Stdio::piped())
.spawn()
.map_err(|e| SubprocessError::new("Xvfb".into(), SubprocessErrorType::Spawn(e)))?;
let process = XvfbProcess {
lock,
framebuffer_directory,
process,
subprocesses: Vec::new(),
is_shutdown: false,
};
let now = Instant::now();
let display_name = CString::new(
format!(":{}", process.lock.display)
).expect("could not construct display name");
while now.elapsed() < Duration::from_secs(1) {
unsafe {
let display = x11::xlib::XOpenDisplay(display_name.as_ptr());
if !display.is_null() {
x11::xlib::XCloseDisplay(display);
break;
}
}
thread::sleep(Duration::from_millis(10));
}
return Ok(process);
}
/// Returns the number in the `DISPLAY` environment variable to connect to
/// this X11 server.
pub fn display(&self) -> u16 {
self.lock.display
}
/// Provides access to the `Xvfb` child process wrapped by `self`.
pub fn process(&mut self) -> &mut Child {
&mut self.process
}
/// Attempts to clean up all child processes. Returns any errors encountered, or `Ok` if none.
///
/// Child processes are cleaned up with the following escalating steps:
///
/// * Call [`SubprocessMonitor::on_xvfb_shutdown`] on each child's monitor.
/// * Kill each of them directly (with [`Child::kill`]).
/// * Kill the `Xvfb` process (which may cause any children still connected to that display server to exit).
pub fn shutdown(&mut self) -> Result<(), Vec<SubprocessError>> {
if self.is_shutdown {
return Ok(());
}
self.is_shutdown = true;
let mut errors = Vec::new();
for (child, monitor) in self.subprocesses.iter_mut() {
if let Err(e) = monitor.on_xvfb_shutdown(child) {
errors.push(e);
}
match child.try_wait() {
Ok(Some(status)) => {
if let Err(e) = monitor.check_subprocess_exit(status) {
errors.push(e);
}
}
Ok(None) => {
if let Err(e) = child.kill() {
errors.push(SubprocessError::new(
monitor.name.clone(),
SubprocessErrorType::Kill(e),
));
}
}
Err(e) => errors.push(SubprocessError::new(
monitor.name.clone(),
SubprocessErrorType::Status(e),
)),
}
}
if let Err(e) = self.process.kill() {
errors.push(SubprocessError::new(
"Xvfb".into(),
SubprocessErrorType::Kill(e),
));
}
if errors.is_empty() {
Ok(())
} else {
Err(errors)
}
}
/// Runs a simple command in this display server. No command line parsing is
/// done, so `run("ls -la")` will probably not do what you expect (because
/// there is no binary on your `PATH` called `ls -la`). Use [`XvfbProcess::run_args`]
/// to provide arguments to `command`.
pub fn run(&mut self, command: impl Into<String>) -> Result<(), SubprocessError> {
let name = command.into();
self.run_args(name.clone(), &name, |_c| {})
}
/// Runs a command that you can provide arguments to in this display
/// server.
///
/// The `f` parameter can be used to modify the `Command` before it is
/// run (e.g., by adding arguments). For example:
///
/// ```
/// # use wings_rs_tests::headless::DisplayNumberRegistry;
/// # use wings_rs_tests::headless::xvfb::XvfbProcess;
/// # fn main() {
/// # let mut xvfb = XvfbProcess::start_default(DisplayNumberRegistry::next_unused_display().unwrap()).unwrap();
/// xvfb.run_args(
/// "demo of xeyes, angel-style",
/// "/usr/bin/xeyes",
/// |cmd| { cmd.arg("-biblicallyAccurate"); },
/// ).unwrap();
/// # }
/// ```
pub fn run_args(
&mut self,
name: impl Into<String>,
command: impl AsRef<std::ffi::OsStr>,
f: impl FnOnce(&mut Command),
) -> Result<(), SubprocessError> {
let mut command = Command::new(command);
command.env("DISPLAY", format!(":{}", self.lock.display));
f(&mut command);
let mut monitor = SubprocessMonitor::new(name.into(), command);
monitor.with_subprocess_exit(SubprocessMonitor::require_clean_exit());
let child = monitor.start()?;
self.subprocesses.push((child, monitor));
Ok(())
}
/// Checks all subprocesses started with the [`XvfbProcess::run`] family of
/// methods and returns errors for any that have an error status, or `Ok` if
/// none do.
pub fn check(&mut self) -> Result<(), Vec<SubprocessError>> {
let errors: Vec<_> = self
.subprocesses
.iter_mut()
.filter_map(|(child, monitor)| match child.try_wait() {
Ok(Some(status)) => monitor.check_subprocess_exit(status).err(),
_ => None,
})
.collect();
if errors.is_empty() {
Ok(())
} else {
Err(errors)
}
}
/// Returns a screenshot of the current framebuffer contents in `xwd(1)`
/// format.
///
/// For the same in a more generally useful format, try [`XvfbProcess::png_screenshot`].
pub fn xwd_screenshot(&self) -> io::Result<xwd::XwdImage> {
let path = self.framebuffer_directory.path().join("Xvfb_screen0");
Ok(xwd::XwdImage::read(&mut fs::read(path)?.into_iter()))
}
/// Returns a screenshot of the current framebuffer contents in PNG format.
///
/// Panics on errors.
pub fn png_screenshot(&self) -> Vec<u8> {
self.xwd_screenshot().unwrap().into_png().unwrap()
}
}
impl Drop for XvfbProcess {
fn drop(&mut self) {
self.shutdown().unwrap();
}
}
pub type SubprocessResult<T> = Result<T, SubprocessError>;
/// Errors that may occur when a subprocess fails to run or exit cleanly.
#[derive(Debug)]
pub struct SubprocessError {
/// Meaningful name that can be used to determine what subprocess failed.
pub name: String,
pub err: SubprocessErrorType,
}
impl SubprocessError {
pub fn new(name: String, err: SubprocessErrorType) -> Self {
SubprocessError { name, err }
}
}
/// Error details for `SubprocessError`.
#[derive(Debug)]
pub enum SubprocessErrorType {
/// Subprocess exited with bad exit code.
BadExit(ExitStatus),
/// Could not spawn child process (with `io::Error` as the reason).
Spawn(io::Error),
/// Could not kill child process (with `io::Error` as the reason).
Kill(io::Error),
/// Could not query child process for exit status (with `io::Error` as the reason).
Status(io::Error),
}
/// Manages spawning a subprocess, monitoring it during execution, and killing it when `Xvfb` shuts down.
pub struct SubprocessMonitor {
name: String,
command: Command,
check_subprocess_exit: Option<Box<dyn FnMut(&str, ExitStatus) -> SubprocessResult<()>>>,
on_xvfb_shutdown: Option<Box<dyn FnMut(&mut Child) -> SubprocessResult<()>>>,
}
impl SubprocessMonitor {
/// Creates a new monitor but does not start any subprocess yet.
///
/// This monitor may be configured further by calling mutators like
/// [`SubprocessMonitor::with_subprocess_exit`]. Once configuration is
/// completely, start the subprocess with [`SubprocessMonitor::start`].
pub fn new(name: impl Into<String>, command: Command) -> Self {
SubprocessMonitor {
name: name.into(),
command,
check_subprocess_exit: None,
on_xvfb_shutdown: None,
}
}
/// Sets the callback to execute when [`SubprocessMonitor::check_subprocess_exit`] is called.
pub fn with_subprocess_exit(
&mut self,
f: Box<dyn FnMut(&str, ExitStatus) -> SubprocessResult<()>>,
) -> &mut Self {
self.check_subprocess_exit = Some(f);
self
}
/// Sets the callback to execute when
/// [`SubprocessMonitor::on_xvfb_shutdown`] is called. It may check process
/// status, clean up, etc.
pub fn with_xvfb_shutdown(
&mut self,
f: Box<dyn FnMut(&mut Child) -> SubprocessResult<()>>,
) -> &mut Self {
self.on_xvfb_shutdown = Some(f);
self
}
/// Attempts to spawn a child process from the `Command` provided to
/// [`SubprocessMonitor::new`].
pub fn start(&mut self) -> SubprocessResult<Child> {
self.command
.spawn()
.map_err(|e| SubprocessError::new(self.name.clone(), SubprocessErrorType::Spawn(e)))
}
/// Called when subprocess exit status is polled. This may be used to signal
/// an error because the exit status is bad.
pub fn check_subprocess_exit(&mut self, status: ExitStatus) -> SubprocessResult<()> {
if let Some(f) = &mut self.check_subprocess_exit {
(f)(&self.name, status)
} else {
Ok(())
}
}
/// Called immediately before the parent display server is being shut
/// down. This may be used to send `SIGINT` or otherwise clean up the child
/// before it is killed more forcibly.
pub fn on_xvfb_shutdown(&mut self, child: &mut Child) -> SubprocessResult<()> {
if let Some(f) = &mut self.on_xvfb_shutdown {
(f)(child)
} else {
Ok(())
}
}
/// Returns a callback suitable for passing to [`SubprocessMonitor::check_subprocess_exit`]
/// which requires that the process has exited cleanly.
pub fn require_clean_exit() -> Box<dyn FnMut(&str, ExitStatus) -> SubprocessResult<()>> {
Box::new(|name: &str, status: ExitStatus| {
if status.success() {
Ok(())
} else {
Err(SubprocessError::new(
String::from(name),
SubprocessErrorType::BadExit(status),
))
}
})
}
}
#[cfg(test)]
mod tests {
use crate::headless::DisplayNumberRegistry;
use super::XvfbProcess;
use insta_image::assert_png_snapshot;
use std::{
thread,
time::Duration,
};
/// Starts Xvfb and returns a managing object, or panics.
fn start_xvfb() -> XvfbProcess {
XvfbProcess::start_default(
DisplayNumberRegistry::next_unused_display().expect("cannot find a value for DISPLAY"),
)
.expect("cannot start Xvfb")
}
/// Reads a single frame of PNG data from the PNG image in `data`. Panics on
/// errors.
fn read_png_metadata(data: &[u8]) -> png::OutputInfo {
let mut reader = png::Decoder::new(std::io::Cursor::new(data))
.read_info()
.unwrap();
let mut buf = vec![0; reader.output_buffer_size().unwrap()];
reader.next_frame(&mut buf).unwrap()
}
/// Launches `xeyes(1)` with colors to make sure we're doing the right thing
/// with our color channels when encoding a screenshot tas PNG.
fn xeyes_color(xvfb: &mut XvfbProcess) {
xvfb.run_args("xeyes", "xeyes", |c| {
c.arg("-outline")
.arg("blue")
.arg("-center")
.arg("red")
.arg("-fg")
.arg("green");
})
.unwrap();
thread::sleep(Duration::from_millis(100));
}
#[test]
fn png_blank_screenshot() {
let xvfb = start_xvfb();
let xwd = xvfb.xwd_screenshot().unwrap();
assert_eq!(
xwd.visual_class(),
crate::headless::xwd::VisualClass::TrueColor
);
let args = crate::headless::xvfb::XvfbArgs::default();
assert_eq!(xwd.header.depth, args.depth as u32);
assert_eq!(xwd.header.width, args.width);
assert_eq!(xwd.header.height, args.height);
assert_png_snapshot!("blank_screen", xwd.into_png().unwrap());
}
#[test]
fn png_xeyes_screenshot() {
let mut xvfb = start_xvfb();
xeyes_color(&mut xvfb);
let compressed = xvfb.png_screenshot();
let image_data = read_png_metadata(&compressed);
let args = crate::headless::xvfb::XvfbArgs::default();
assert_eq!(image_data.width, args.width);
assert_eq!(image_data.height, args.height);
assert_png_snapshot!("xeyes", compressed);
}
#[test]
fn png_lamp_image() {
let mut xvfb = start_xvfb();
xvfb.run_args("xwud", "xwud", |c| {
c.arg("-in").arg("src/headless/snowlamp.xwd");
})
.unwrap();
thread::sleep(Duration::from_millis(100));
let compressed = xvfb.png_screenshot();
assert_png_snapshot!("snowlamp_in_window", compressed);
}
}

View File

@@ -0,0 +1,325 @@
//! Provides basic support for rendering dumps of X11 windows made with [the `xwud` utility](https://gitlab.freedesktop.org/xorg/app/xwud/-/blob/master/xwud.c?ref_type=heads).
use std::{
ffi::CString,
io::Cursor,
mem,
};
const SUPPORTED_XWD_VERSION: u32 = 7;
/// Header for `xwd`-style dumps of X11 windows.
///
/// This is taken from `/usr/include/X11/XWDFile.h` on a Debian system.
#[derive(Clone)]
#[repr(C)]
pub struct XwdHeader {
/// Total header size (including null-terminated window name).
pub size: u32,
/// Version of `xwd` that this dump came from.
pub version: u32,
pub _format: u32,
/// Bit depth of the X11 server.
pub depth: u32,
/// Image width.
pub width: u32,
/// Image height.
pub height: u32,
pub _x_offset: u32,
pub _byte_order: u32,
pub _bitmap_unit: u32,
pub _bitmap_bit_order: u32,
pub _bitmap_pad: u32,
pub bits_per_pixel: u32,
pub _bytes_per_line: u32,
/// X11 visual class for this window. See [`XwdImage::visual_class`] for a
/// more human-interpretable value.
pub visual_class: u32,
/// Bitmask for the red channel in pixel data.
pub red_mask: u32,
/// Bitmask for the green channel in pixel data.
pub green_mask: u32,
/// Bitmask for the blue channel in pixel data.
pub blue_mask: u32,
/// Number of bits per RGB tuple in color data. (E.g., 24-bit color may
/// actually be padded to 4 bytes.)
pub bits_per_rgb: u32,
pub _colormap_entries: u32,
/// Number of colors in the colormap for the window that this dump came from.
///
/// Note that a colormap may exist but be unused (if the visual class is not
/// one that uses a colormap).
pub ncolors: u32,
pub _window_width: u32,
pub _window_height: u32,
pub _window_x: u32,
pub _window_y: u32,
pub _window_border_width: u32,
}
const HEADER_SIZE: u32 = mem::size_of::<XwdHeader>() as u32;
/// Color data for an entry in a colormap.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(C)]
pub struct XwdColor {
pixel: u32,
red: u16,
green: u16,
blue: u16,
flags: u8,
pad: u8,
}
fn next_u32(bytes: &mut impl Iterator<Item = u8>) -> u32 {
let bytes = [
bytes.next().unwrap(),
bytes.next().unwrap(),
bytes.next().unwrap(),
bytes.next().unwrap(),
];
u32::from_be_bytes(bytes)
}
fn next_u16(bytes: &mut impl Iterator<Item = u8>) -> u16 {
let bytes = [bytes.next().unwrap(), bytes.next().unwrap()];
u16::from_be_bytes(bytes)
}
/// Describes how pixel data is represented in an `xwd` dump.
///
/// See descriptions of visual classes at
/// <https://tronche.com/gui/x/xlib/window/visual-types.html> and [the official
/// documentation](https://www.x.org/releases/X11R7.7/doc/xproto/x11protocol.html#visual_information)
/// for more information.
#[derive(Clone, Copy, Eq, Debug, PartialEq)]
pub enum VisualClass {
StaticGray,
GrayScale,
StaticColor,
PseudoColor,
TrueColor,
DirectColor,
}
impl XwdHeader {
/// Decodes an `XwdHeader` from `bytes`, panicking on failure.
///
/// Leaves `bytes` pointing to the start of the window name.
pub fn read(bytes: &mut impl Iterator<Item = u8>) -> XwdHeader {
// This layout might change in the future, but let's just go with it for now.
XwdHeader {
size: next_u32(bytes),
version: next_u32(bytes),
_format: next_u32(bytes),
depth: next_u32(bytes),
width: next_u32(bytes),
height: next_u32(bytes),
_x_offset: next_u32(bytes),
_byte_order: next_u32(bytes),
_bitmap_unit: next_u32(bytes),
_bitmap_bit_order: next_u32(bytes),
_bitmap_pad: next_u32(bytes),
bits_per_pixel: next_u32(bytes),
_bytes_per_line: next_u32(bytes),
visual_class: next_u32(bytes),
red_mask: next_u32(bytes),
green_mask: next_u32(bytes),
blue_mask: next_u32(bytes),
bits_per_rgb: next_u32(bytes),
_colormap_entries: next_u32(bytes),
ncolors: next_u32(bytes),
_window_width: next_u32(bytes),
_window_height: next_u32(bytes),
_window_x: next_u32(bytes),
_window_y: next_u32(bytes),
_window_border_width: next_u32(bytes),
}
}
}
impl XwdColor {
/// Reads an `XwdColor` from `bytes`, panicking on failure.
///
/// Leaves `bytes` pointing to the next byte after the end of the color
/// definition.
pub fn read(bytes: &mut impl Iterator<Item = u8>) -> XwdColor {
XwdColor {
pixel: next_u32(bytes),
red: next_u16(bytes),
green: next_u16(bytes),
blue: next_u16(bytes),
flags: bytes.next().unwrap(),
pad: bytes.next().unwrap(),
}
}
}
/// A decoded `xwd` dump.
pub struct XwdImage {
/// Header with image metadata.
pub header: XwdHeader,
/// Name of the X11 window that the image came from.
pub name: CString,
/// Colormap data for the X11 window that the image came from.
///
/// Note that this may be populated even if it is unused (because the
/// window's visual class is one that does not use a colormap).
pub colors: Vec<XwdColor>,
/// Pixel data for the image.
///
/// This may be indices pointing into `colors`, or it may be actual pixel
/// values.
pub pixels: Vec<u8>,
}
impl XwdImage {
/// Reads an `XwdImage` from `bytes`, panicking on failure.
pub fn read(bytes: &mut impl Iterator<Item = u8>) -> XwdImage {
let header = XwdHeader::read(bytes);
if header.version != SUPPORTED_XWD_VERSION {
panic!(
"header version {} is not supported. only version {} files are supported.",
header.version, SUPPORTED_XWD_VERSION
);
}
let name = Self::read_name(&header, bytes);
let colors = Self::read_colors(&header, bytes);
let pixels = bytes.collect();
XwdImage {
header,
name,
colors,
pixels,
}
}
/// Reads a colormap for the image described by `header` from `bytes`.
///
/// `bytes` must point at the start of the colormap data. Leaves `bytes`
/// pointing at the first byte of the next item in the data stream.
pub fn read_colors(header: &XwdHeader, bytes: &mut impl Iterator<Item = u8>) -> Vec<XwdColor> {
let mut colors = Vec::with_capacity(header.ncolors as usize);
for _ in 0..header.ncolors {
colors.push(XwdColor::read(bytes));
}
colors
}
/// Reads the X11 window name from `bytes`.
///
/// `bytes` must point at the start of the window name. Leaves `bytes`
/// pointing at the first byte of the next item in the data stream.
///
/// Note that the window name is a null-terminated string, but `header.size`
/// (which is supposed to be equal to the size of the header structure plus
/// the window name) may actually be longer than `strlen(name) +
/// sizeof(HeaderType)`. When that is the case, the extra padding after the
/// first null byte in the window name will be passed over silently.
pub fn read_name(header: &XwdHeader, bytes: &mut impl Iterator<Item = u8>) -> CString {
if header.size <= HEADER_SIZE {
panic!(
"Invalid header size {} (smaller than header struct size {})",
header.size, HEADER_SIZE
);
}
let mut buf = Vec::new();
let mut found_nul = false;
for _ in 0..header.size - HEADER_SIZE {
let b = bytes.next().unwrap();
if b == 0 {
if found_nul {
continue;
} else {
buf.push(b);
found_nul = true;
}
} else {
buf.push(b);
}
}
CString::from_vec_with_nul(buf).unwrap()
}
/// Returns the visual class for this window dump.
pub fn visual_class(&self) -> VisualClass {
match self.header.visual_class {
0 => VisualClass::StaticGray,
1 => VisualClass::GrayScale,
2 => VisualClass::StaticColor,
3 => VisualClass::PseudoColor,
4 => VisualClass::TrueColor,
5 => VisualClass::DirectColor,
_ => panic!(
"unrecognized X11 visual class: {}",
self.header.visual_class
),
}
}
/// Encodes this image as a PNG, consumes `self` in the process (because the
/// image data is reused during the encoding process).
///
/// Note that only [`VisualClass::TrueColor`] images with a specific pixel
/// format (24-bit color packed into 32-bit segments with BGR ordering) are
/// supported.
pub fn into_png(self) -> Result<Vec<u8>, png::EncodingError> {
match self.visual_class() {
VisualClass::TrueColor => into_png_true_color(self.header, self.pixels),
_ => todo!("X11 visual classes other than TrueColor are not yet supported"),
}
}
}
fn into_png_true_color(
header: XwdHeader,
mut pixels: Vec<u8>,
) -> Result<Vec<u8>, png::EncodingError> {
if header.depth != 24 {
todo!("pixmap color depths other than 24-bit are not yet supported");
}
if !(header.red_mask == 0xff0000
&& header.green_mask == 0x00ff00
&& header.blue_mask == 0x0000ff)
{
todo!("color orderings other than RGB are not yet supported");
}
if header.bits_per_rgb == 32 {
todo!("bits per rgb triplet other than 32 are not yet supported");
}
let mut out = Cursor::new(Vec::<u8>::new());
let mut encoder = png::Encoder::new(&mut out, header.width, header.height);
encoder.set_color(png::ColorType::Rgba);
encoder.set_depth(png::BitDepth::Eight);
encoder.set_compression(png::Compression::High);
for pixel in pixels.chunks_mut(4) {
let blue = pixel[0];
let green = pixel[1];
let red = pixel[2];
pixel[0] = red;
pixel[1] = green;
pixel[2] = blue;
pixel[3] = 0xFF;
}
let mut writer = encoder.write_header()?;
writer.write_image_data(&pixels)?;
writer.finish()?;
Ok(out.into_inner())
}
#[cfg(test)]
mod tests {
use super::XwdImage;
use insta_image::assert_png_snapshot;
#[test]
fn png_encode() {
let snowlamp_xwd = XwdImage::read(&mut include_bytes!("snowlamp.xwd").into_iter().copied());
assert_png_snapshot!("snowlamp_encoded", snowlamp_xwd.into_png().unwrap());
}
}

View File

@@ -0,0 +1,185 @@
pub mod headless;
use headless::{xvfb::XvfbProcess, DisplayNumberRegistry};
use std::{
env,
ffi::{c_char, c_int, CStr, CString},
ptr::{self, NonNull},
sync::Mutex,
};
use wings_rs::WINGsP::{WMHandleEvent, WMInitializeApplication, WMReleaseApplication, WMScreen};
static APPLICATION_COUNT: Mutex<u32> = Mutex::new(0);
/// Stubbed wrapper for WMApplication.
pub struct HeadlessApplication {
/// The headless X server process.
pub xvfb: XvfbProcess,
/// An open client handle to the headless X server.
pub display: NonNull<x11::xlib::Display>,
/// A fully initialized `WMScreen` for an application running on the
/// headless X server.
pub screen: NonNull<WMScreen>,
}
impl HeadlessApplication {
/// Starts a headless X server and calls `WMInitializeApplication` if no
/// WINGs application is active.
pub fn new() -> Self {
static PROGNAME: &'static CStr = c"Test@eqweq_ewq$eqw";
let xvfb = XvfbProcess::start_default(
DisplayNumberRegistry::next_unused_display()
.expect("cannot allocate a value for DISPLAY"),
)
.expect("cannot start Xvfb");
{
let mut application_count = APPLICATION_COUNT.lock().unwrap();
if *application_count == 0 {
unsafe {
let mut argv: Vec<*mut c_char> =
vec![PROGNAME.as_ptr().cast::<c_char>() as *mut c_char];
let mut argc: c_int = 1;
WMInitializeApplication(
PROGNAME.as_ptr().cast::<c_char>(),
&mut argc as *mut _,
argv.as_mut_ptr(),
);
}
}
*application_count += 1;
}
let display_str = CString::new(format!(":{}", xvfb.display())).unwrap();
let display =
NonNull::new(unsafe { x11::xlib::XOpenDisplay(display_str.as_ptr()) }).unwrap();
let screen = WMScreen::new(&display).unwrap();
HeadlessApplication {
xvfb,
display,
screen,
}
}
/// Pumps the WUtil and X11 event queues, hackily.
///
/// Runs WUtil event handlers that should be run by `now`, pumps the X11
/// event queue, dispatches the next pending event (if any), and runs
/// WUtil idle handlers (if no X11 events are available).
///
/// Returns `true` if more events are pending. (This does not account for
/// WUtils timer events that might need to fire, since the future time when
/// `pump_event_queue` will next be called cannot be known.)
///
/// This is somewhat hacky (because it does not match the WINGs main loop
/// logic exactly), so it should only be used by tests.
pub fn pump_event_queue(&mut self, now: std::time::Instant) -> bool {
let display = self.display.as_ptr();
wutil_rs::handlers::with_global_handlers(|handlers| handlers.check_timer_handlers(now));
unsafe {
x11::xlib::XSync(display, 0);
if x11::xlib::XPending(display) > 0 {
let mut event = x11::xlib::XEvent { type_: 0 };
x11::xlib::XNextEvent(display, &mut event as *mut _);
WMHandleEvent(&mut event as *mut _);
} else {
wutil_rs::handlers::run_global_idle_handlers();
}
x11::xlib::XSync(display, 0);
if x11::xlib::XPending(display) > 0 {
return true;
}
wutil_rs::handlers::with_global_handlers(|handlers| handlers.has_idle_handlers())
}
}
}
impl Drop for HeadlessApplication {
fn drop(&mut self) {
unsafe {
x11::xlib::XCloseDisplay(self.display.as_ptr());
// Leak self.screen, since WINGs doesn't provide a cleanup function.
}
let mut application_count = APPLICATION_COUNT.lock().unwrap();
if *application_count <= 1 {
*application_count = 0;
unsafe {
WMReleaseApplication();
}
} else {
*application_count -= 1;
}
self.xvfb.shutdown().unwrap();
}
}
/// Simple wrapper for demo WINGs applications.
///
/// This handles calling `WMInitializeApplication`, which operates on a
/// singleton behind the scenes and wants to be passed command line arguments.
///
/// When the last instantiated `LiveApplication` is dropped,
/// `WMReleaseApplication` is called automatically.
pub struct LiveApplication {
/// Live X11 `Display` that the application is running on.
pub display: NonNull<x11::xlib::Display>,
/// Fully intialized `WMScreen` for the application.
///
/// This is leaked when the `LiveApplication` is dropped because WINGs does
/// not provide a deletion function.
pub screen: NonNull<WMScreen>,
}
impl LiveApplication {
/// Creates a new application wrapper and initializes the global
/// `WMApplication` if necessary.
pub fn new(name: &str) -> Self {
let mut application_count = APPLICATION_COUNT.lock().unwrap();
if *application_count > 0 {
panic!("application already started!");
}
let name = CString::new(name).expect("invalid program name");
unsafe {
let mut argv: Vec<CString> = vec![name];
let name_ptr = argv[0].as_ptr().cast::<c_char>();
for arg in env::args() {
argv.push(CString::new(arg).expect("invalid argument string"));
}
let mut argv_ptrs: Vec<*mut c_char> = argv
.iter_mut()
.map(|a| a.as_ptr().cast::<c_char>() as *mut c_char)
.collect();
let mut argc: c_int = argv_ptrs.len().try_into().expect("invalid argument count");
WMInitializeApplication(name_ptr, &mut argc as *mut _, argv_ptrs.as_mut_ptr());
}
*application_count = 1;
let display = NonNull::new(unsafe { x11::xlib::XOpenDisplay(ptr::null_mut()) })
.expect("could not connect to X11 display");
let screen = WMScreen::new(&display).unwrap();
LiveApplication { display, screen }
}
}
impl Drop for LiveApplication {
fn drop(&mut self) {
unsafe {
x11::xlib::XCloseDisplay(self.display.as_ptr());
// Leak self.screen, since WINGs doesn't provide a cleanup function.
}
let mut application_count = APPLICATION_COUNT.lock().unwrap();
if *application_count <= 1 {
*application_count = 0;
unsafe {
WMReleaseApplication();
}
} else {
*application_count -= 1;
}
}
}

View File

@@ -0,0 +1,14 @@
use insta_image::assert_png_snapshot;
use std::time::Instant;
use wings_rs::font_panel::FontPanel;
use wings_rs_tests::HeadlessApplication;
#[test]
fn show_font_panel() {
let mut app = HeadlessApplication::new();
let mut font_panel =
FontPanel::new(app.screen.as_ptr()).expect("could not construct font panel");
font_panel.show();
while app.pump_event_queue(Instant::now()) {}
assert_png_snapshot!("font_panel", app.xvfb.png_screenshot());
}

View File

@@ -0,0 +1,7 @@
---
source: tests/font_panel_tests.rs
assertion_line: 16
expression: app.xvfb.png_screenshot()
extension: png
snapshot_kind: binary
---

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

14
WINGs/wings-rs/Cargo.toml Normal file
View File

@@ -0,0 +1,14 @@
[package]
name = "wings-rs"
version = "0.1.0"
edition = "2024"
[lib]
crate-type = ["staticlib", "rlib"]
[dependencies]
libc = "0.2.177"
pango-sys = "0.21.2"
wutil-rs = { path = "../../wutil-rs" }
x11 = "2.21.0"
yeslogic-fontconfig-sys = "6.0"

View File

@@ -0,0 +1,73 @@
AUTOMAKE_OPTIONS =
RUST_SOURCES = \
src/WINGsP.rs \
src/button.rs \
src/configuration.rs \
src/font.rs \
src/font_panel.rs \
src/lib.rs \
src/list.rs \
src/pango_extras.rs \
src/screen.rs \
src/widget.rs
RUST_EXTRA = \
Cargo.lock \
Cargo.toml
src/WINGsP.rs: ../WINGs/WINGsP.h ../../wrlib/wraster.h ../WINGs/WINGs.h ../WINGs/WUtil.h Makefile patch_WINGsP.sh
$(BINDGEN) ../WINGs/WINGsP.h \
--no-recursive-allowlist \
--allowlist-type "^W_.+|^WM(View|Array|DragOperationType|Point|Data|OpenPanel|SavePanel|HashTable|DraggingInfo|SelectionProcs|Rect|EventProc|Widget|Size|Color|Pixmap|FilePanel)|R(Context|ContextAttributes|Image|RenderingMode|ScalingFilter|StdColormapMode|ImageFormat|Color)|_WINGsConfiguration" \
--allowlist-type "^WM(FontPanel|Screen|Button)" \
--allowlist-function "^WMCreateScreen|^WM(Get|Show)FontPanel|^WMCreateCommandButton|^WM(Initialize|Release)Application|^WMScreenMainLoop|^WMHandleEvent" \
--allowlist-function "^WMWidgetScreen|^WM(Initialize|Release)Application|^WM(ScreenMainLoop|HandleEvent)|^WM(((Get|Set)TextFieldFont)|GetTextFieldText|SetTextFieldText|SelectTextFieldRange)" \
--allowlist-type "WMList" \
--allowlist-function "^WM(CreateList|SetListAction|GetListSelectedItem|InsertListItem|ClearList|FindRowOfListItemWithTitle|SelectListItem|SetListPosition|SortListItems)" \
--allowlist-type "^WM(Window|Action)" \
--allowlist-function "^WM(CreateWindow|SetWindowTitle|SetWindowMinSize|SetWindowCloseAction)" \
--allowlist-type "^WMWidget" \
--allowlist-function "^WM(Map|Destroy|Unmap|Resize|Realize|Move)Widget" \
--allowlist-function "^WMWidget(Width|Height)" \
--allowlist-function "^WM(SetWidgetBackgroundColor|SetWidgetBackgroundColor|MapSubwidgets)" \
--allowlist-type "^WM(SplitView|SplitViewConstrainProc)" \
--allowlist-function "^WM(SetViewNotifySizeChanges|CreateSplitView|SetSplitViewConstrainProc|GetSplitViewDividerThickness|AddSplitViewSubview)" \
--allowlist-type "^WMNotification" \
--allowlist-function "^WM(Add|Remove)NotificationObserver|^WMGetNotification(Object|Name)" \
--allowlist-item "^WMNotificationObserverAction" \
--allowlist-item "^WMViewSizeDidChangeNotification" \
--allowlist-type "^WMFrame" \
--allowlist-function "^WM(CreateFrame|SetFrameRelief)" \
--allowlist-function "^WM(White|DarkGray|Release)Color" \
--allowlist-type "^WMTextField" \
--allowlist-function "^WM(CreateTextField)" \
--allowlist-type "^WMLabel" \
--allowlist-function "^WM(CreateLabel|SetLabelText|SetLabelFont|SetLabelTextColor|SetLabelRelief|SetLabelTextAlignment)" \
--allowlist-type "^WM(Button|ButtonBehaviorMask)" \
--allowlist-function "^WM(CreateCustomButton|SetButtonText|SetButtonAction|SetButtonText)" \
--allowlist-function "wmkrange" \
--allowlist-type "^WM(View|Array|DragOperationType|Point|Data|OpenPanel|SavePanel|HashTable|DraggingInfo|SelectionProcs|Rect|EventProc|Widget|Size|Color|Pixmap|FilePanel|Screen|Range|List|ListItem)" \
--allowlist-type "^R(Context|ContextAttributes|Image|RenderingMode|ScalingFilter|StdColormapMode|ImageFormat|Color)" \
--allowlist-type "_WINGsConfiguration" \
--allowlist-item "^WMAlignment" \
--allowlist-item "^WMReliefType" \
-o src/WINGsP.rs -- \
@PANGO_CFLAGS@ \
-I../../wrlib \
-I.. && ./patch_WINGsP.sh src/WINGsP.rs
Cargo.lock:
$(CARGO) build
target/debug/libwings_rs.a: $(RUST_SOURCES) $(RUST_EXTRA)
$(CARGO) build
check-local:
$(CARGO) test
clean-local:
$(CARGO) clean
rm -f src/WINGsP.rs
all: target/debug/libwings_rs.a

22
WINGs/wings-rs/patch_WINGsP.sh Executable file
View File

@@ -0,0 +1,22 @@
#!/bin/sh
# This file provides ad-hoc fixups to the WINGsP provided by bindgen:
# - Import Xlib symbols so that everything compiles.
# - The opaque type names _XftDraw and _XftFont are replaced with void*.
# - Pango bindings aren't yet pulled into our Rust code, so PangoLayout is also demoted to void*.
set -e
if [ "x$1" = "x" ]; then
echo "Usage: $(basename $0) <file to patch>"
exit 1
fi
FILE="$1"
exec sed -i -r \
-e "1s/^/use x11::xlib::*;\nuse crate::font::ffi::WMFont;\n\n/" \
-e "s/_XftDraw/::std::ffi::c_void/g" \
-e "s/_XftFont/::std::ffi::c_void/g" \
-e "s/PangoLayout/::std::ffi::c_void/g" \
"$1"

View File

@@ -0,0 +1,22 @@
#[allow(non_snake_case)]
pub mod ffi {
use crate::WINGsP::*;
/// Creates a button like an "Ok" button to dismiss a dialog.
///
/// ## Rust rewrite notes
///
/// This was originally a macro.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMCreateCommandButton(parent: *mut WMWidget) -> *mut WMButton {
unsafe {
WMCreateCustomButton(
parent,
(WMButtonBehaviorMask_WBBSpringLoadedMask
| WMButtonBehaviorMask_WBBPushInMask
| WMButtonBehaviorMask_WBBPushLightMask
| WMButtonBehaviorMask_WBBPushChangeMask) as i32,
)
}
}
}

View File

@@ -0,0 +1,66 @@
//! Global WINGs configuration.
//!
//! Use [`Configuration::global`] to get a snapshot of current configuration
//! settings.
//!
//! ## Rust rewrite notes
//!
//! This accesses a global that is defined in C code. Once more of WINGs is
//! migrated to Rust, we should use a different approach that is more
//! Rust-friendly. Threading a configuration object down the stack is a likely
//! way to go.
use crate::WINGsP::_WINGsConfiguration;
use std::{ffi::CStr, ptr::NonNull};
unsafe extern "C" {
static WINGsConfiguration: _WINGsConfiguration;
}
#[derive(Clone, Copy, Debug)]
pub struct Configuration {
pub system_font: &'static CStr,
pub bold_system_font: &'static CStr,
pub default_font_size: u16,
pub antialiased_text: bool,
pub floppy_path: &'static CStr,
pub double_click_delay: u32,
pub mouse_wheel_up: u32,
pub mouse_wheel_down: u32,
}
impl Configuration {
/// Returns the current WINGs configuration. Returns `None` if the
/// configuration appears not to have been loaded.
///
/// This should only be called after `W_ReadConfigurations` is called
/// (presumably when initializing WINGs in C code), but it should be safe to
/// call it at any time. (It may just contain nonsense values.)
///
/// ## Rust rewrite notes
///
/// We should migrate away from a static global and thread a configuration
/// object in some other way.
pub fn global() -> Option<Self> {
let c = unsafe { &WINGsConfiguration };
let system_font = unsafe { CStr::from_ptr(NonNull::new(c.systemFont)?.as_ptr()) };
let bold_system_font = unsafe { CStr::from_ptr(NonNull::new(c.boldSystemFont)?.as_ptr()) };
let default_font_size = u16::try_from(c.defaultFontSize).ok()?;
let antialiased_text = c.antialiasedText != 0;
let floppy_path = unsafe { CStr::from_ptr(NonNull::new(c.floppyPath)?.as_ptr()) };
let double_click_delay = u32::try_from(c.doubleClickDelay).ok()?;
let mouse_wheel_up = u32::try_from(c.mouseWheelUp).ok()?;
let mouse_wheel_down = u32::try_from(c.mouseWheelDown).ok()?;
Some(Configuration {
system_font,
bold_system_font,
default_font_size,
antialiased_text,
floppy_path,
double_click_delay,
mouse_wheel_up,
mouse_wheel_down,
})
}
}

586
WINGs/wings-rs/src/font.rs Normal file
View File

@@ -0,0 +1,586 @@
use crate::pango_extras;
use std::{
ffi::{CStr, CString, c_double, c_int, c_uint, c_void},
ptr::NonNull,
rc::Rc,
};
use crate::configuration::Configuration;
pub const DEFAULT_FONT: &'static str = "sans serif:pixelsize=12";
pub const DEFAULT_FONT_CSTR: &'static CStr = c"sans serif:pixelsize=12";
/// A loaded font, with support for basic drawing operations.
///
/// This owns Pango rendering state, and draw operations may mutate it. As a
/// result, this is not at all thread-safe.
///
/// ## Rust rewrite notes
///
/// Unlike the original C API, font caching is handled by methods on
/// [`W_Screen`].
pub struct Font {
name: FontName,
font: NonNull<x11::xft::XftFont>,
height: c_uint,
ascent: c_uint,
layout: NonNull<pango_sys::PangoLayout>,
}
/// Attempts to convert `xlfd` to a Fontconfig pattern. Returns `None` if this
/// cannot be accomplished (e.g., `xlfd` could not be parsed).
fn xlfd_to_fc_pattern(xlfd: &str) -> Option<NonNull<x11::xft::FcPattern>> {
if xlfd.contains('%') {
return NonNull::new(unsafe {
fontconfig_sys::FcNameParse(DEFAULT_FONT_CSTR.as_ptr()).cast::<x11::xft::FcPattern>()
});
}
let name = xlfd.split(',').next().unwrap();
let ignore_scalable = 0;
let complete = 0;
NonNull::new(unsafe {
x11::xft::XftXlfdParse(
name.as_ptr(),
ignore_scalable,
complete,
)
})
.or_else(|| {
// TODO: warn.
NonNull::new(unsafe {
x11::xft::XftXlfdParse(
DEFAULT_FONT_CSTR.as_ptr(),
ignore_scalable,
complete,
)
})
})
}
/// A font name, with support for X logical font descriptions (like
/// `-bitstream-charter-medium-r-normal--12-120-75-75-p-68-iso8859-1`, including
/// `*`-style wildcards but not old-style `%d` tokens) and Fontconfig
/// descriptions (like `sans serif:pixelsize=12`).
///
/// Data is held in a [`std::rc::Rc`], so copies are lightweight, and ownership
/// may be shared between multiple objects (e.g., keying a hashtable and
/// referenced by hashtable values).
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub struct FontName(Rc<CStr>);
impl FontName {
/// Tries to interpret `name` as an XLFD or Fontconfig name. Returns an
/// instantiated `FontName` if this succeeds, or `None`.
pub fn new(name: &str) -> Option<Self> {
let name = if name.starts_with('-') {
let pattern = xlfd_to_fc_pattern(name)?;
let name = unsafe { fontconfig_sys::FcNameUnparse(pattern.as_ptr().cast::<c_void>()) };
let name = NonNull::new(name)?;
let result = unsafe { CStr::from_ptr(name.as_ptr()) }.to_str().ok()?;
unsafe {
libc::free(name.as_ptr().cast::<c_void>());
fontconfig_sys::FcPatternDestroy(pattern.as_ptr().cast::<c_void>());
}
result
} else {
name
};
if !Configuration::global()
.map(|c| c.antialiased_text)
.unwrap_or(false)
&& !name.contains(":antialias=")
{
let mut name = String::from(name);
name += ":antialias=false";
Some(FontName(Rc::from(CString::new(name).ok()?)))
} else {
Some(FontName(Rc::from(CString::new(name).ok()?)))
}
}
/// Returns a C-style string owned by this object that names the font in a
/// way that is suitable for `x11::xft::XftFontOpenName` and other Xft
/// functions.
pub fn as_xft_name(&self) -> *const u8 {
self.0.as_ptr()
}
/// Converts `self` into a shareable name.
pub fn into_name(self) -> Rc<CStr> {
self.0.into()
}
}
impl Font {
/// Tries to load the named font for `screen` on `display`. Returns `None`
/// if `name` can't be handled or font cannot be loaded.
pub fn load(display: &mut x11::xlib::Display, screen: c_int, name: &FontName) -> Option<Self> {
let font = NonNull::new(unsafe {
x11::xft::XftFontOpenName(display, screen, name.as_xft_name())
})?;
let f = unsafe { font.as_ref() };
let height = u32::try_from(f.ascent + f.descent).ok()?;
let fontmap = unsafe { pango_extras::pango_xft_get_font_map(display, screen) };
let context = unsafe { pango_sys::pango_font_map_create_context(fontmap) };
let layout = NonNull::new(unsafe { pango_sys::pango_layout_new(context) })?;
let pattern = unsafe { fontconfig_sys::FcNameParse(name.as_xft_name()) };
let description =
unsafe { pango_extras::pango_fc_font_description_from_pattern(pattern.cast(), 0) };
// Pango examines FC_SIZE but not FC_PIXEL_SIZE of the pattern, but
// font-name has only "pixelsize", so set the size manually here.
let mut size: c_double = 0.0;
unsafe {
if fontconfig_sys::FcPatternGetDouble(
pattern,
fontconfig_sys::constants::FC_PIXEL_SIZE.as_ptr(),
0,
&mut size,
) == fontconfig_sys::FcResultMatch
{
pango_sys::pango_font_description_set_absolute_size(
description,
size * (pango_sys::PANGO_SCALE as c_double),
);
}
pango_sys::pango_layout_set_font_description(layout.as_ptr(), description);
pango_sys::pango_font_description_free(description);
}
Some(Font {
font,
height,
ascent: u32::try_from(f.ascent).ok()?,
name: name.clone(),
layout,
})
}
/// Loads the font `name` at the size `size` (in pixels).
pub fn load_at_size(
display: &mut x11::xlib::Display,
screen: c_int,
name: &FontName,
size: u32,
) -> Option<Self> {
let pattern = unsafe { fontconfig_sys::FcNameParse(name.as_xft_name()) };
unsafe {
fontconfig_sys::FcPatternDel(
pattern,
fontconfig_sys::constants::FC_PIXEL_SIZE.as_ptr(),
);
fontconfig_sys::FcPatternAddDouble(
pattern,
fontconfig_sys::constants::FC_PIXEL_SIZE.as_ptr(),
size as f64,
);
}
let name = unsafe { fontconfig_sys::FcNameUnparse(pattern) };
unsafe {
fontconfig_sys::FcPatternDestroy(pattern);
}
let name = NonNull::new(name)?;
let font_name = FontName(Rc::from(unsafe { CStr::from_ptr(name.as_ptr()) }));
unsafe {
libc::free(name.as_ptr().cast::<c_void>());
}
Font::load(display, screen, &font_name)
}
pub fn name(&self) -> &FontName {
&self.name
}
}
impl Drop for Font {
fn drop(&mut self) {
unsafe {
libc::free(self.font.as_ptr().cast::<c_void>());
}
}
}
pub mod ffi {
use super::{Font, FontName};
use std::ffi::CStr;
use crate::{WINGsP, configuration::Configuration, pango_extras};
use std::{
ffi::{c_char, c_int, c_uint},
ptr,
rc::Rc,
};
pub type WMFont = Rc<Font>;
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMCreateFont(
screen: *mut WINGsP::W_Screen,
font_name: *const c_char,
) -> *mut WMFont {
if screen.is_null() || font_name.is_null() {
return ptr::null_mut();
}
let screen = unsafe { &mut *screen };
if screen.display.is_null() {
return ptr::null_mut();
}
let font_name = unsafe { CStr::from_ptr(font_name) };
let Ok(font_name) = font_name.to_str() else {
return ptr::null_mut();
};
let Some(font_name) = FontName::new(font_name) else {
return ptr::null_mut();
};
let display = unsafe { &mut *screen.display };
let screen_n = screen.screen;
screen
.font_cache_get_or_else(font_name, |font_name| {
Font::load(display, screen_n, font_name)
})
.map(|font| Box::leak(Box::new(font)) as *mut WMFont)
.unwrap_or(ptr::null_mut())
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMRetainFont(font: *mut WMFont) -> *mut WMFont {
if font.is_null() {
return ptr::null_mut();
}
let font = unsafe { (*font).clone() };
Box::leak(Box::new(font))
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMReleaseFont(font: *mut WMFont) {
if font.is_null() {
return;
}
let _ = unsafe { Box::from_raw(font) };
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMGetFontName(font: *const WMFont) -> *const c_char {
if font.is_null() {
return ptr::null_mut();
}
unsafe { (**font).name.as_xft_name() }
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMFontAscent(font: *mut WMFont) -> c_uint {
if font.is_null() {
return 0;
}
return unsafe { (**font).ascent };
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMFontXftFont(font: *mut WMFont) -> *mut x11::xft::XftFont {
if font.is_null() {
return ptr::null_mut();
}
return unsafe { (**font).font.as_ptr() };
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMFontHeight(font: *const WMFont) -> c_uint {
if font.is_null() {
return 0;
}
unsafe { (**font).height }
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMGetScaleBaseFromSystemFont(
screen: *mut WINGsP::W_Screen,
alphabet_width: *mut c_int,
font_height: *mut c_int,
) {
let font = unsafe { WMDefaultSystemFont(screen) };
unsafe {
*alphabet_width = WMWidthOfString(font, c"abcdefghijklmnopqrstuvwxyz".as_ptr(), 26);
}
if let Ok(x) = unsafe { (**font).height.try_into() } {
unsafe {
*font_height = x;
}
}
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMDefaultSystemFont(screen: *mut WINGsP::W_Screen) -> *mut WMFont {
if screen.is_null() {
return ptr::null_mut();
}
unsafe { WMRetainFont((*screen).normalFont) }
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMDefaultBoldSystemFont(screen: *mut WINGsP::W_Screen) -> *mut WMFont {
if screen.is_null() {
return ptr::null_mut();
}
unsafe { WMRetainFont((*screen).boldFont) }
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMSystemFontOfSize(
screen: *mut WINGsP::W_Screen,
size: c_int,
) -> *mut WMFont {
if screen.is_null() {
return ptr::null_mut();
}
let screen = unsafe { &*screen };
if screen.display.is_null() {
return ptr::null_mut();
}
if screen.display.is_null() {
return ptr::null_mut();
}
let display = unsafe { &mut *screen.display };
let size = if size > 0 {
size as u32
} else {
match Configuration::global().map(|c| c.default_font_size as u32) {
Some(x) => x,
None => return ptr::null_mut(),
}
};
let Some(font_name) = Configuration::global()
.and_then(|c| c.system_font.to_str().ok())
.and_then(|name| FontName::new(name))
else {
return ptr::null_mut();
};
if let Some(font) = Font::load_at_size(display, screen.screen, &font_name, size) {
Box::leak(Box::new(Rc::new(font)))
} else {
// TODO: warn.
ptr::null_mut()
}
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMBoldSystemFontOfSize(
screen: *mut WINGsP::W_Screen,
size: c_int,
) -> *mut WMFont {
if screen.is_null() {
return ptr::null_mut();
}
let screen = unsafe { &*screen };
if screen.display.is_null() {
return ptr::null_mut();
}
if screen.display.is_null() {
return ptr::null_mut();
}
let display = unsafe { &mut *screen.display };
let size = if size > 0 {
size as u32
} else {
match Configuration::global().map(|c| c.default_font_size as u32) {
Some(x) => x,
None => return ptr::null_mut(),
}
};
let Some(font_name) = Configuration::global()
.and_then(|c| c.bold_system_font.to_str().ok())
.and_then(|name| FontName::new(name))
else {
return ptr::null_mut();
};
if let Some(font) = Font::load_at_size(display, screen.screen, &font_name, size) {
Box::leak(Box::new(Rc::new(font)))
} else {
// TODO: warn.
ptr::null_mut()
}
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMWidthOfString(
font: *mut WMFont,
text: *const c_char,
length: c_int,
) -> c_int {
if font.is_null() || text.is_null() || length <= 0 {
return 0;
}
let font = unsafe { &*font };
let layout = font.layout.as_ptr();
let previous_text = unsafe { pango_sys::pango_layout_get_text(layout) };
if previous_text.is_null() {
unsafe {
pango_sys::pango_layout_set_text(layout, text, length);
}
} else {
let length = length as usize;
let previous_text = unsafe { CStr::from_ptr(previous_text).to_bytes() };
let text = unsafe { std::slice::from_raw_parts(text, length) };
if previous_text.len() < length || previous_text[0..length] != text[0..length] {
unsafe {
pango_sys::pango_layout_set_text(layout, text.as_ptr(), length as i32);
}
}
}
let mut width = 0;
unsafe {
pango_sys::pango_layout_get_pixel_size(layout, &mut width, ptr::null_mut());
}
width
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMDrawString(
screen: *mut WINGsP::W_Screen,
d: x11::xlib::Drawable,
color: *mut WINGsP::W_Color,
font: *mut WMFont,
x: c_int,
y: c_int,
text: *const c_char,
length: c_int,
) {
if screen.is_null() || color.is_null() || font.is_null() || text.is_null() {
return;
}
let screen = unsafe { &*screen };
let color = unsafe { &*color };
let layout = unsafe { &mut *(**font).layout.as_ptr() };
let mut xftcolor = x11::xft::XftColor {
color: x11::xrender::XRenderColor {
red: color.color.red,
green: color.color.green,
blue: color.color.blue,
alpha: color.alpha,
},
pixel: color.color.pixel,
};
let previous_text = unsafe { pango_sys::pango_layout_get_text(layout) };
if previous_text.is_null() {
unsafe {
pango_sys::pango_layout_set_text(layout, text, length);
}
} else {
let text = unsafe { CStr::from_ptr(text) };
let previous_text = unsafe { CStr::from_ptr(previous_text) };
if previous_text != text {
unsafe {
pango_sys::pango_layout_set_text(layout, text.as_ptr(), length);
}
}
}
unsafe {
x11::xft::XftDrawChange(screen.xftdraw.cast(), d);
pango_extras::pango_xft_render_layout(
screen.xftdraw.cast(),
&mut xftcolor,
layout,
x * pango_sys::PANGO_SCALE,
y * pango_sys::PANGO_SCALE,
);
}
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMDrawImageString(
screen: *mut WINGsP::W_Screen,
d: x11::xlib::Drawable,
color: *mut WINGsP::W_Color,
background: *mut WINGsP::W_Color,
font: *mut WMFont,
x: c_int,
y: c_int,
text: *const c_char,
length: c_int,
) {
if screen.is_null() || color.is_null() || font.is_null() || text.is_null() {
return;
}
let screen = unsafe { &*screen };
let color = unsafe { &*color };
let background = unsafe { &*background };
let layout = unsafe { &mut *(**font).layout.as_ptr() };
let mut text_color = x11::xft::XftColor {
color: x11::xrender::XRenderColor {
red: color.color.red,
green: color.color.green,
blue: color.color.blue,
alpha: color.alpha,
},
pixel: color.color.pixel,
};
let background = x11::xft::XftColor {
color: x11::xrender::XRenderColor {
red: background.color.red,
green: background.color.green,
blue: background.color.blue,
alpha: background.alpha,
},
pixel: color.color.pixel,
};
unsafe {
let Ok(width) = u32::try_from(WMWidthOfString(font, text, length)) else {
// TODO: complain.
return;
};
x11::xft::XftDrawChange(screen.xftdraw.cast(), d);
x11::xft::XftDrawRect(
screen.xftdraw.cast(),
&background,
x,
y,
width,
(**font).height,
);
}
let previous_text = unsafe { pango_sys::pango_layout_get_text(layout) };
if previous_text.is_null() {
unsafe {
pango_sys::pango_layout_set_text(layout, text, length);
}
} else {
let text = unsafe { CStr::from_ptr(text) };
let previous_text = unsafe { CStr::from_ptr(previous_text) };
if text != previous_text {
unsafe {
pango_sys::pango_layout_set_text(layout, text.as_ptr(), length);
}
}
}
unsafe {
pango_extras::pango_xft_render_layout(
screen.xftdraw.cast(),
&mut text_color,
layout,
x * pango_sys::PANGO_SCALE,
y * pango_sys::PANGO_SCALE,
);
}
}
}

File diff suppressed because it is too large Load Diff

13
WINGs/wings-rs/src/lib.rs Normal file
View File

@@ -0,0 +1,13 @@
#[allow(improper_ctypes)]
#[allow(non_camel_case_types)]
#[allow(non_snake_case)]
#[allow(non_upper_case_globals)]
pub mod WINGsP;
pub mod button;
pub mod configuration;
pub mod font;
pub mod font_panel;
pub mod list;
pub(crate) mod pango_extras;
pub mod screen;
pub mod widget;

View File

@@ -0,0 +1,15 @@
#[allow(non_snake_case)]
pub mod ffi {
use crate::WINGsP::*;
use std::ffi::c_char;
/// Appends an item with the label `text` to `list`.
///
/// ## Rust rewrite notes
///
/// This was originally a macro.
pub unsafe fn WMAddListItem(list: *mut WMList, text: *const c_char) -> *mut WMListItem {
unsafe { WMInsertListItem(list, -1, text) }
}
}

View File

@@ -0,0 +1,21 @@
use std::ffi::c_int;
unsafe extern "C" {
pub fn pango_xft_get_font_map(
display: *mut x11::xlib::Display,
screen: c_int,
) -> *mut pango_sys::PangoFontMap;
pub fn pango_fc_font_description_from_pattern(
pattern: *mut x11::xft::FcPattern,
include_size: c_int,
) -> *mut pango_sys::PangoFontDescription;
pub fn pango_xft_render_layout(
draw: *mut x11::xft::XftDraw,
color: *mut x11::xft::XftColor,
layout: *mut pango_sys::PangoLayout,
x: c_int,
y: c_int,
);
}

View File

@@ -0,0 +1,68 @@
use crate::{
WINGsP::{WMScreen, WMCreateScreen},
font::{Font, FontName},
};
use std::{
collections::{HashMap, hash_map::Entry},
ffi::c_void,
ptr::NonNull,
rc::Rc,
};
impl WMScreen {
pub fn new(display: &NonNull<x11::xlib::Display>) -> Option<NonNull<Self>> {
NonNull::new(unsafe { WMCreateScreen(display.as_ptr(), x11::xlib::XDefaultScreen(display.as_ptr())) })
}
fn font_cache_mut(&mut self) -> &mut HashMap<FontName, Rc<Font>> {
if self.fontCache.is_null() {
self.fontCache = (Box::leak(Box::new(HashMap::<FontName, Rc<Font>>::new()))
as *mut HashMap<_, _>)
.cast::<c_void>();
}
unsafe { &mut *self.fontCache.cast::<HashMap<FontName, Rc<Font>>>() }
}
pub fn font_cache_get_or_else(
&mut self,
name: FontName,
f: impl FnOnce(&FontName) -> Option<Font>,
) -> Option<Rc<Font>> {
match self.font_cache_mut().entry(name) {
Entry::Occupied(o) => Some(o.get().clone()),
Entry::Vacant(v) => {
if let Some(font) = f(v.key()) {
let font = Rc::new(font);
v.insert(font.clone());
Some(font)
} else {
None
}
}
}
}
/// Removes `font` from the font cache if it is not in use anywhere else
/// (i.e., the only live references are `font` and an entry in the cache).
pub fn font_cache_flush(&mut self, font: &Rc<Font>) {
if Rc::strong_count(font) > 2 {
return;
}
self.font_cache_mut().remove(&font.name());
}
}
#[cfg(test)]
mod test {
use crate::WINGsP::WMScreen;
use std::mem::MaybeUninit;
#[test]
fn font_cache_init() {
let mut screen: WMScreen = unsafe { MaybeUninit::zeroed().assume_init() };
let cache = screen.font_cache_mut();
assert!(cache.is_empty());
}
}

View File

@@ -0,0 +1,57 @@
//! Common WINGs widget fields.
//!
//! WINGs widgets all have a [`WINGsP::WMView`] object that tracks common attributes
//! like size and location and a [`WINGsP::W_Class`] field that identifies the widget
//! type (button, list, etc.). This module provides access to these fields.
//!
//! ## Rust rewrite notes
//!
//! The original WINGs implementation uses casting and a common layout for
//! "primitive" widget structs, such that the first two fields are always a
//! `W_Class` and a `*mut WMView`. We rely on this convention when implementing
//! [`Widget`] for widgets that are defined in C.
use crate::WINGsP;
use std::{
ptr::NonNull,
};
/// Base WINGs widget type.
///
/// All primitive widgets (like buttons and lists) should implement this.
pub trait Widget {
fn class(&self) -> WINGsP::W_Class;
fn view(&self) -> NonNull<WINGsP::WMView>;
}
/// Common widget header fields. It should be safe to cast opaque WINGs widget
/// structs defined in C to this type to access these fields. Before writing
/// code that casts anything to this, double-check the widget definition!
#[repr(C)]
struct WidgetLike {
class: WINGsP::W_Class,
view: *mut WINGsP::WMView,
}
/// Casts `$widget` to [`WidgetLike`]. Provided for convenience.
///
/// ## Safety
///
/// The caller of this macro is responsible for ensuring that the layout of `$widget` is compatible
/// with `WidgetLike`.
macro_rules! impl_widget {
($widget:ty) => {
impl Widget for $widget {
fn class(&self) -> crate::WINGsP::W_Class {
unsafe { ::std::mem::transmute::<&$widget, &WidgetLike>(self).class }
}
fn view(&self) -> ::std::ptr::NonNull<WINGsP::WMView> {
let widget = unsafe { ::std::mem::transmute::<&$widget, &WidgetLike>(self) };
NonNull::new(widget.view).expect("WMView field of widget struct cannot be null")
}
}
};
}
impl_widget!(WINGsP::WMWindow);
impl_widget!(WINGsP::WMFrame);

View File

@@ -109,7 +109,7 @@ void W_CreateIC(WMView * view)
// this really needs to be changed, but I don't know how yet -Dan
// it used to be like this with fontsets, but no longer applies to xft
preedit_attr = XVaCreateNestedList(0, XNSpotLocation, &spot,
XNArea, &rect, XNFontInfo, scr->normalFont->font, NULL);
XNArea, &rect, XNFontInfo, WMFontXftFont(scr->normalFont), NULL);
}
view->xic = XCreateIC(scr->imctx->xim, XNInputStyle, scr->imctx->ximstyle,

View File

@@ -201,7 +201,7 @@ W_PaintText(W_View * view, Drawable d, WMFont * font, int x, int y,
}
void
W_PaintTextAndImage(W_View * view, int wrap, WMColor * textColor, W_Font * font,
W_PaintTextAndImage(W_View * view, int wrap, WMColor * textColor, WMFont * font,
WMReliefType relief, const char *text,
WMAlignment alignment, W_Pixmap * image,
WMImagePosition position, WMColor * backColor, int ofs)

View File

@@ -718,8 +718,8 @@ static void paintText(Text * tPtr)
if (!tPtr->flags.monoFont && tb->underlined) {
XDrawLine(dpy, tPtr->db, WMColorGC(color),
tb->sections[s].x - tPtr->hpos,
y + font->y + 1,
tb->sections[s].x + tb->sections[s].w - tPtr->hpos, y + font->y + 1);
y + WMFontAscent(font) + 1,
tb->sections[s].x + tb->sections[s].w - tPtr->hpos, y + WMFontAscent(font) + 1);
}
}
tb = (!done ? tb->next : NULL);
@@ -897,7 +897,7 @@ static void updateCursorPosition(Text * tPtr)
if (!(tb = tPtr->firstTextBlock)) {
WMFont *font = tPtr->dFont;
tPtr->tpos = 0;
tPtr->cursor.h = font->height + abs(font->height - font->y);
tPtr->cursor.h = WMFontHeight(font) + abs(WMFontHeight(font) - WMFontAscent(font));
tPtr->cursor.y = 2;
tPtr->cursor.x = 2;
@@ -979,7 +979,7 @@ static void cursorToTextPosition(Text * tPtr, int x, int y)
if (!(tb = tPtr->firstTextBlock)) {
WMFont *font = tPtr->dFont;
tPtr->tpos = 0;
tPtr->cursor.h = font->height + abs(font->height - font->y);
tPtr->cursor.h = WMFontHeight(font) + abs(WMFontHeight(font) - WMFontAscent(font));
tPtr->cursor.y = 2;
tPtr->cursor.x = 2;
return;
@@ -1378,9 +1378,9 @@ static int layOutLine(Text * tPtr, myLineItems * items, int nitems, int x, int y
} else {
font = (tPtr->flags.monoFont) ? tPtr->dFont : tb->d.font;
/*max_d = WMAX(max_d, abs(font->height-font->y)); */
/*max_d = WMAX(max_d, abs(WMFontHeight(font)-WMFontAscent(font))); */
max_d = 2;
line_height = WMAX(line_height, font->height + max_d);
line_height = WMAX(line_height, WMFontHeight(font) + max_d);
text = &(tb->text[items[i].begin]);
len = items[i].end - items[i].begin;
if (tPtr->flags.alignment != WALeft)
@@ -1430,7 +1430,7 @@ static int layOutLine(Text * tPtr, myLineItems * items, int nitems, int x, int y
len = items[i].end - items[i].begin;
text = &(tb->text[items[i].begin]);
tb->sections[n].y = y + line_height - font->y;
tb->sections[n].y = y + line_height - WMFontAscent(font);
tb->sections[n].w =
WMWidthOfString(font,
&(tb->text[tb->sections[n].begin]),

View File

@@ -1,24 +0,0 @@
/*
* Handle events for non-GUI based applications
*/
#include "WINGsP.h"
void WHandleEvents(void)
{
/* Check any expired timers */
W_CheckTimerHandlers();
/* Do idle and timer stuff while there are no input events */
/* Do not wait for input here. just peek to see if input is available */
while (!W_HandleInputEvents(False, -1) && W_CheckIdleHandlers()) {
/* dispatch timer events */
W_CheckTimerHandlers();
}
W_HandleInputEvents(True, -1);
/* Check any expired timers */
W_CheckTimerHandlers();
}

View File

@@ -68,8 +68,10 @@ WPrefs_DEPENDENCIES = $(top_builddir)/WINGs/libWINGs.la
WPrefs_LDADD = \
$(top_builddir)/wutil-rs/target/debug/libwutil_rs.a\
$(top_builddir)/WINGs/libWINGs.la\
$(top_builddir)/WINGs/wings-rs/target/debug/libwings_rs.a\
$(top_builddir)/WINGs/libWUtil.la\
$(top_builddir)/wrlib/libwraster.la \
@PANGO_LIBS@ \
@XLFLAGS@ @XLIBS@ \
@LIBM@ \
@FCLIBS@ \

View File

@@ -94,7 +94,7 @@ static void paintDoubleTest(_DoubleTest * dPtr)
if (dPtr->text) {
int y;
y = (dPtr->view->size.height - scr->normalFont->height) / 2;
y = (dPtr->view->size.height - WMFontHeight(scr->normalFont)) / 2;
W_PaintText(dPtr->view, dPtr->view->window, scr->normalFont,
dPtr->on, dPtr->on + y, dPtr->view->size.width, WACenter,
scr->black, False, dPtr->text, strlen(dPtr->text));

View File

@@ -60,6 +60,11 @@ AS_IF(test x$RUSTC = xno,
AC_MSG_ERROR([rustc is required. Please set the RUSTC environment variable or install the Rust toolchain from https://www.rust-lang.org/])
)
AC_SUBST(RUSTC, [rustc])
AC_CHECK_PROG(BINDGEN, [bindgen], [yes], [no])
AS_IF(test x$BINDGEN = xno,
AC_MSG_ERROR([bindgen is required. Please set the BINDGEN environment variable or install bindgen (maybe with `cargo install bindgen-cli`)])
)
AC_SUBST(BINDGEN, [bindgen])
dnl libtool library versioning
dnl ==========================
@@ -924,13 +929,13 @@ AC_CONFIG_FILES(
wrlib/Makefile wrlib/po/Makefile
wrlib/tests/Makefile
dnl Rust implementation of WINGs libraries
dnl Rust implementation of WINGs utilities
wutil-rs/Makefile
dnl WINGs toolkit
WINGs/Makefile WINGs/WINGs/Makefile WINGs/po/Makefile
WINGs/Documentation/Makefile WINGs/Resources/Makefile WINGs/Extras/Makefile
WINGs/Examples/Makefile WINGs/Tests/Makefile
WINGs/Makefile WINGs/wings-rs/Makefile WINGs/WINGs/Makefile WINGs/wings-rs-tests/Makefile
WINGs/po/Makefile WINGs/Documentation/Makefile WINGs/Resources/Makefile
WINGs/Extras/Makefile WINGs/Examples/Makefile WINGs/Tests/Makefile
dnl Rust implementation of Window Maker core
wmaker-rs/Makefile

View File

@@ -161,7 +161,10 @@ wmaker_LDADD = \
$(top_builddir)/WINGs/libWUtil.la\
$(top_builddir)/wrlib/libwraster.la\
$(top_builddir)/wutil-rs/target/debug/libwutil_rs.a\
$(top_builddir)/WINGs/wings-rs/target/debug/libwings_rs.a\
$(top_builddir)/wmaker-rs/target/debug/libwmaker_rs.a\
@PANGO_LIBS@ \
@FCLIBS@ \
@XLFLAGS@ \
@LIBXRANDR@ \
@LIBXINERAMA@ \

View File

@@ -1608,7 +1608,7 @@ void wMenuScroll(WMenu *menu)
XEvent ev;
if (omenu->jump_back)
WMDeleteTimerWithClientData(omenu->jump_back);
WMDeleteTimerHandler(omenu->jump_back_timer);
if (( /*omenu->flags.buttoned && */ !wPreferences.wrap_menus)
|| omenu->flags.app_menu) {
@@ -1709,7 +1709,7 @@ void wMenuScroll(WMenu *menu)
scr->flags.jump_back_pending = 1;
} else
delayer = omenu->jump_back;
WMAddTimerHandler(MENU_JUMP_BACK_DELAY, callback_leaving, delayer);
omenu->jump_back_timer = WMAddTimerHandler(MENU_JUMP_BACK_DELAY, callback_leaving, delayer);
}
}

View File

@@ -91,6 +91,7 @@ typedef struct WMenu {
WMHandlerID timer; /* timer for the autoscroll */
void *jump_back; /* jump back data */
WMHandlerID jump_back_timer; /* set when jump_back is being used */
/* to be called when some entry is edited */
void (*on_edit)(struct WMenu *menu, struct WMenuEntry *entry);

View File

@@ -1648,9 +1648,9 @@ void wUnmanageWindow(WWindow *wwin, Bool restore, Bool destroyed)
wSelectWindow(wwin, False);
/* remove all pending events on window */
/* I think this only matters for autoraise */
/* I think this only matters for autoraise. see event.c:1197. */
if (wPreferences.raise_delay)
WMDeleteTimerWithClientData(wwin->frame->core);
WMDeleteTimerHandler(wwin->frame->core->screen_ptr->autoRaiseTimer);
XFlush(dpy);

View File

@@ -89,6 +89,8 @@ Xephyr -screen 640x480 "$xephyr_display" &
xephyr_pid=$!
DISPLAY="$xephyr_display" gdb \
--directory "$project_base" \
--directory "$HOME/src/libX11-1.5.0/build/src" \
--quiet \
--fullname \
--args "$WindowMaker" -display "$xephyr_display" --for-real "$@"
kill $xephyr_pid

View File

@@ -67,15 +67,17 @@ geticonset_LDADD= \
wmagnify_LDADD = \
$(top_builddir)/WINGs/libWINGs.la \
$(top_builddir)/WINGs/libWUtil.la \
$(top_builddir)/WINGs/wings-rs/target/debug/libwings_rs.a \
$(top_builddir)/wrlib/libwraster.la \
@XLFLAGS@ @XLIBS@ @INTLIBS@
@XLFLAGS@ @XLIBS@ @INTLIBS@ @FCLIBS@ @PANGO_LIBS@
wmsetbg_LDADD = \
$(top_builddir)/WINGs/libWINGs.la \
$(top_builddir)/wutil-rs/target/debug/libwutil_rs.a \
$(top_builddir)/WINGs/wings-rs/target/debug/libwings_rs.a \
$(top_builddir)/WINGs/libWUtil.la \
$(top_builddir)/wrlib/libwraster.la \
@XLFLAGS@ @LIBXINERAMA@ @XLIBS@ @INTLIBS@
@XLFLAGS@ @LIBXINERAMA@ @XLIBS@ @INTLIBS@ @FCLIBS@ @PANGO_LIBS@
wmgenmenu_LDADD = \
$(top_builddir)/WINGs/libWUtil.la \
@@ -100,6 +102,7 @@ wmiv_LDADD = \
$(top_builddir)/WINGs/libWINGs.la \
$(top_builddir)/WINGs/libWUtil.la \
$(top_builddir)/wutil-rs/target/debug/libwutil_rs.a \
$(top_builddir)/WINGs/wings-rs/target/debug/libwings_rs.a \
@XLFLAGS@ @XLIBS@ @GFXLIBS@ \
@PANGO_LIBS@ @PTHREAD_LIBS@ @LIBEXIF@

View File

@@ -4,7 +4,7 @@ version = "0.1.0"
edition = "2024"
[lib]
crate-type = ["staticlib"]
crate-type = ["staticlib","rlib"]
[build-dependencies]
cc = "1.0"

View File

@@ -8,17 +8,22 @@ RUST_SOURCES = \
src/defines.rs \
src/find_file.rs \
src/hash_table.rs \
src/handlers.rs \
src/lib.rs \
src/memory.rs \
src/notification.rs \
src/prop_list.rs \
src/string.rs
src/sendable.rs \
src/string.rs \
src/tree.rs
RUST_EXTRA = \
Cargo.lock \
Cargo.toml
Cargo.lock:
$(CARGO) build
target/debug/libwutil_rs.a: $(RUST_SOURCES) $(RUST_EXTRA)
$(CARGO) build

View File

@@ -1,7 +1,7 @@
use std::{ffi::c_void, ptr::NonNull};
use std::ffi::c_void;
pub struct Array {
items: Vec<NonNull<c_void>>,
items: Vec<usize>,
destructor: Option<unsafe extern "C" fn(x: *mut c_void)>,
}
@@ -10,7 +10,7 @@ pub mod ffi {
use std::{
ffi::{c_int, c_void},
ptr::{self, NonNull},
ptr,
};
pub const NOT_FOUND: c_int = -1;
@@ -64,7 +64,7 @@ pub mod ffi {
let array = unsafe { &mut *array };
if let Some(f) = array.destructor {
for item in &mut array.items {
unsafe { (f)(item.as_ptr()) }
unsafe { (f)(*item as *mut c_void) }
}
}
array.items.clear();
@@ -94,10 +94,8 @@ pub mod ffi {
if array.is_null() {
return;
}
if let Some(item) = NonNull::new(item) {
unsafe {
(*array).items.push(item);
}
unsafe {
(*array).items.push(item.addr());
}
}
@@ -114,9 +112,7 @@ pub mod ffi {
if index >= array.len() {
return;
}
if let Some(item) = NonNull::new(item) {
array.insert(index, item);
}
array.insert(index, item.addr());
}
#[unsafe(no_mangle)]
@@ -141,15 +137,11 @@ pub mod ffi {
return ptr::null_mut();
}
let item = match NonNull::new(item) {
Some(x) => x,
None => return ptr::null_mut(),
};
let array = unsafe { &mut (*array).items };
let old = array[index];
array[index] = item;
old.as_ptr()
array[index] = item.addr();
old as *mut c_void
}
#[unsafe(no_mangle)]
@@ -168,7 +160,7 @@ pub mod ffi {
let old = array.items.remove(index);
if let Some(f) = array.destructor {
unsafe {
(f)(old.as_ptr());
(f)(old as *mut c_void);
}
}
1
@@ -192,8 +184,8 @@ pub mod ffi {
let array = unsafe { &mut *array };
let original_len = array.items.len();
match pred {
Some(f) => array.items.retain(|x| unsafe { f(x.as_ptr(), cdata) != 0 }),
None => array.items.retain(|x| ptr::eq(x.as_ptr(), cdata)),
Some(f) => array.items.retain(|x| unsafe { f(*x as *const c_void, cdata) != 0 }),
None => array.items.retain(|x| ptr::eq(*x as *mut c_void, cdata)),
}
(original_len - array.items.len()) as c_int
}
@@ -207,7 +199,7 @@ pub mod ffi {
(&(*array))
.items
.get(index as usize)
.map(|p| p.as_ptr())
.map(|p| *p as *mut c_void)
.unwrap_or(ptr::null_mut())
}
}
@@ -226,7 +218,7 @@ pub mod ffi {
(*array)
.items
.pop()
.map(|p| p.as_ptr())
.map(|p| p as *mut c_void)
.unwrap_or(ptr::null_mut())
}
}
@@ -246,7 +238,7 @@ pub mod ffi {
.items
.iter()
.enumerate()
.find(|(_, item)| unsafe { f(item.as_ptr(), cdata) != 0 })
.find(|(_, item)| unsafe { f(**item as *const c_void, cdata) != 0 })
.map(|(i, _)| i as c_int)
.unwrap_or(NOT_FOUND)
} else {
@@ -254,7 +246,7 @@ pub mod ffi {
.items
.iter()
.enumerate()
.find(|(_, item)| ptr::eq(item.as_ptr(), cdata))
.find(|(_, item)| ptr::eq(**item as *const c_void, cdata))
.map(|(i, _)| i as c_int)
.unwrap_or(NOT_FOUND)
}
@@ -269,7 +261,7 @@ pub mod ffi {
array
.items
.iter()
.filter(|x| ptr::eq(x.as_ptr(), item))
.filter(|x| ptr::eq(**x as *const c_void, item))
.count() as c_int
}
@@ -284,13 +276,17 @@ pub mod ffi {
unsafe {
(*array)
.items
.sort_by(|&a, &b| match comparator(a.as_ptr(), b.as_ptr()).signum() {
-1 => std::cmp::Ordering::Less,
0 => std::cmp::Ordering::Equal,
1 => std::cmp::Ordering::Greater,
_ => unreachable!(),
.sort_by(|a, b| {
let a = a as *const _ as *const c_void;
let b = b as *const _ as *const c_void;
match comparator(a, b).signum() {
-1 => std::cmp::Ordering::Less,
0 => std::cmp::Ordering::Equal,
1 => std::cmp::Ordering::Greater,
_ => unreachable!(),
}
})
}
}
}
#[unsafe(no_mangle)]
@@ -304,7 +300,7 @@ pub mod ffi {
}
unsafe {
for a in &mut (*array).items {
(f)(a.as_ptr(), data);
(f)(*a as *mut c_void, data);
}
}
}
@@ -326,7 +322,7 @@ pub mod ffi {
unsafe {
*iter = 0;
}
x.as_ptr()
*x as *mut c_void
}
}
}
@@ -348,7 +344,7 @@ pub mod ffi {
unsafe {
*iter = (array.items.len() - 1) as c_int;
}
x.as_ptr()
*x as *mut c_void
}
}
}
@@ -363,12 +359,12 @@ pub mod ffi {
if index < 0 {
return ptr::null_mut();
}
match array.items.get(index as usize) {
match array.items.get(index as usize + 1) {
Some(i) => {
unsafe {
*iter += 1;
}
i.as_ptr()
*i as *mut c_void
}
None => {
unsafe {
@@ -386,15 +382,15 @@ pub mod ffi {
}
let array = unsafe { &*array };
let index = unsafe { *iter };
if index < 0 {
if index < 1 {
return ptr::null_mut();
}
match array.items.get(index as usize) {
match array.items.get(index as usize - 1) {
Some(i) => {
unsafe {
*iter -= 1;
}
i.as_ptr()
*i as *mut c_void
}
None => {
unsafe {

446
wutil-rs/src/handlers.rs Normal file
View File

@@ -0,0 +1,446 @@
use std::{
mem,
num::NonZero,
sync::Mutex,
time::{Duration, Instant},
};
/// Tracks callbacks that are registered to run.
///
/// Callbacks may be scheduled to run after a duration of time or when there is
/// spare time to run them.
pub struct HandlerQueues {
timer_handlers: Vec<Box<TimerHandler>>,
idle_handlers: Vec<Box<IdleHandler>>,
}
/// Refers to a scheduled handler.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(transparent)]
pub struct HandlerId(Option<NonZero<usize>>);
/// Returned by handler queue predicate(s) to describe if there are pending
/// callbacks.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum QueueStatus {
Empty,
Pending,
}
impl<'a> From<&'a Box<TimerHandler>> for HandlerId {
fn from(handler: &'a Box<TimerHandler>) -> HandlerId {
HandlerId(NonZero::new(
(handler.as_ref() as *const TimerHandler).addr(),
))
}
}
impl<'a> From<&'a Box<IdleHandler>> for HandlerId {
fn from(handler: &'a Box<IdleHandler>) -> HandlerId {
HandlerId(NonZero::new(
(handler.as_ref() as *const IdleHandler).addr(),
))
}
}
impl HandlerQueues {
/// Creates a new `HandlerQueues` with no pending tasks.
pub const fn new() -> Self {
HandlerQueues {
timer_handlers: Vec::new(),
idle_handlers: Vec::new(),
}
}
/// Enqueues `handler` and returns its id.
fn enqueue_timer(&mut self, handler: Box<TimerHandler>) -> HandlerId {
let id = HandlerId::from(&handler);
let insert_at = match self
.timer_handlers
.binary_search_by(|t| handler.when.cmp(&t.when))
{
Ok(i) => i,
Err(i) => i,
};
self.timer_handlers.insert(insert_at, handler);
id
}
/// Enqueues `callback` to be called once, at `when`, and
/// returns an id to refer to the scheduled task.
pub fn enqueue_once_timer(
&mut self,
callback: Box<dyn FnMut() + Send>,
when: Instant,
) -> HandlerId {
self.enqueue_timer(Box::new(TimerHandler {
callback,
when,
delay: Duration::ZERO,
}))
}
/// Enqueues `callback` to be called repeatedly, first at `when` and
/// subsequently every `delay` time units. Returns an id to refer to the
/// schedule task.
pub fn enqueue_persistent_timer(
&mut self,
callback: Box<dyn FnMut() + Send>,
when: Instant,
delay: Duration,
) -> HandlerId {
self.enqueue_timer(Box::new(TimerHandler {
callback,
when,
delay,
}))
}
/// Runs all queued timer handlers which should have run before `now`.
///
/// If a timer handler that is run should repeat, it will be scheduled
/// again.
pub fn check_timer_handlers(&mut self, now: Instant) {
let reschedule = run_timer_handlers(mem::take(&mut self.timer_handlers), now);
for t in reschedule.into_iter() {
self.enqueue_timer(t);
}
}
/// Drops `handler` if it is scheduled. Passing a `handler` that is not
/// scheduled is safe and will no-op.
pub fn delete_timer_handler(&mut self, handler: HandlerId) {
self.timer_handlers
.retain(|t| HandlerId::from(t) != handler);
}
/// Returns the time when the next timer handler would be run, or `None` if
/// no timer handlers are scheduled.
pub fn next_timer_handler_time(&self) -> Option<Instant> {
self.timer_handlers.first().map(|t| t.when)
}
/// Schedules `callback` to be called once, when the event loop is idle, and
/// returns an id for the scheduled handler.
pub fn add_idle_handler(&mut self, callback: Box<dyn FnMut() + Send>) -> HandlerId {
let handler = Box::new(IdleHandler { callback });
let id = HandlerId::from(&handler);
self.idle_handlers.push(handler);
id
}
/// Deletes `handler` if it is scheduled. Passing a `handler` that is not
/// scheduled is safe and will no-op.
pub fn delete_idle_handler(&mut self, handler: HandlerId) {
self.idle_handlers.retain(|h| HandlerId::from(h) != handler);
}
/// Runs any idle handlers that are pending when this function is called and
/// returns the status of the idle handler queue.
///
/// (Idle handlers may schedule new idle handlers, so the queue may be
/// non-empty after pending handlers are run.)
pub fn check_idle_handlers(&mut self) -> QueueStatus {
if self.idle_handlers.is_empty() {
return QueueStatus::Empty;
}
let mut pending = Vec::new();
mem::swap(&mut pending, &mut self.idle_handlers);
for mut h in pending.into_iter() {
(h.callback)();
}
if self.idle_handlers.is_empty() {
QueueStatus::Empty
} else {
QueueStatus::Pending
}
}
/// Returns `true` if any idle handlers need to be run.
pub fn has_idle_handlers(&self) -> bool {
!self.idle_handlers.is_empty()
}
}
/// Runs each of `handlers` that should run before `now` and returns those that
/// need to be rescheduled, plus any that weren't run, in arbitrary order.
fn run_timer_handlers(
mut handlers: Vec<Box<TimerHandler>>,
now: Instant,
) -> Vec<Box<TimerHandler>> {
let mut reschedule = Vec::new();
loop {
let Some(mut t) = handlers.pop() else {
break;
};
if t.when < now {
(t.callback)();
if !t.delay.is_zero() {
t.when = now + t.delay;
reschedule.push(t);
}
} else {
reschedule.push(t);
break;
}
}
reschedule.extend(handlers);
reschedule
}
/// Tracks a callback, a time when it should be called, and an interval for
/// optionally repeating the callback.
///
/// See [`HandlerQueues::enqueue_timer`] and
/// [`HandlerQueues::enqueue_persistent_timer`] for creation of `TimerHandler`s.
struct TimerHandler {
/// Called after `when` has been reached.
callback: Box<dyn FnMut() + Send>,
/// The next time that the handler should be called.
when: Instant,
/// If non-zero indicates that this handler should repeat every `delay` time
/// units. This delay is best-effort only.
delay: Duration,
}
/// Tracks a callback which should be called when the Window Maker event loop is
/// otherwise idle.
struct IdleHandler {
callback: Box<dyn FnMut() + Send>,
}
static DEFAULT_HANDLERS: Mutex<HandlerQueues> = Mutex::new(HandlerQueues::new());
pub fn with_global_handlers<R>(f: impl FnOnce(&mut HandlerQueues) -> R) -> R {
f(&mut DEFAULT_HANDLERS.try_lock().unwrap())
}
pub fn run_global_idle_handlers() -> QueueStatus {
// Move handlers out of the global queue because it is locked while
// with_global_handlers is running, and a callback may try to schedule
// another callback or perform some other operation on the global queue.
let handlers = with_global_handlers(|handlers| {
let mut idle_handlers = Vec::new();
mem::swap(&mut idle_handlers, &mut handlers.idle_handlers);
idle_handlers
});
for mut h in handlers.into_iter() {
(h.callback)();
}
with_global_handlers(|handlers| {
if handlers.has_idle_handlers() {
QueueStatus::Pending
} else {
QueueStatus::Empty
}
})
}
#[cfg(test)]
mod tests {
use super::*;
use std::sync::atomic;
#[test]
fn timers_enqueued_in_order() {
let mut handlers = HandlerQueues::new();
assert!(handlers.timer_handlers.is_empty());
let now = Instant::now();
handlers.enqueue_once_timer(Box::new(|| {}), now);
handlers.enqueue_once_timer(Box::new(|| {}), now + Duration::from_millis(2));
handlers.enqueue_once_timer(Box::new(|| {}), now + Duration::from_millis(1));
assert_eq!(handlers.timer_handlers.len(), 3);
// Timers are popped off the end, so we want things to be in descending order.
assert_eq!(handlers.timer_handlers[2].when, now);
assert_eq!(
handlers.timer_handlers[1].when,
now + Duration::from_millis(1)
);
assert_eq!(
handlers.timer_handlers[0].when,
now + Duration::from_millis(2)
);
}
#[test]
fn run_timer_handlers_remembers_unexpired() {
let mut handlers = HandlerQueues::new();
static COUNTER_A: atomic::AtomicI32 = atomic::AtomicI32::new(0);
static COUNTER_B: atomic::AtomicI32 = atomic::AtomicI32::new(0);
let now = Instant::now();
handlers.enqueue_persistent_timer(
Box::new(|| {
COUNTER_A.fetch_add(1, atomic::Ordering::SeqCst);
}),
now,
Duration::from_millis(10),
);
handlers.enqueue_persistent_timer(
Box::new(|| {
COUNTER_B.fetch_add(1, atomic::Ordering::SeqCst);
}),
now + Duration::from_millis(10),
Duration::from_millis(10),
);
// No timer handlers have run.
assert_eq!(COUNTER_A.load(atomic::Ordering::SeqCst), 0);
assert_eq!(COUNTER_B.load(atomic::Ordering::SeqCst), 0);
handlers.check_timer_handlers(now + Duration::from_millis(1));
// Only the timer that goes off immediately after `now` should have run.
assert_eq!(COUNTER_A.load(atomic::Ordering::SeqCst), 1);
assert_eq!(COUNTER_B.load(atomic::Ordering::SeqCst), 0);
// Both timers are still in queue.
assert_eq!(handlers.timer_handlers.len(), 2);
for mut t in handlers.timer_handlers.into_iter() {
(t.callback)();
}
// Both values should have been incremented.
assert_eq!(COUNTER_A.load(atomic::Ordering::SeqCst), 2);
assert_eq!(COUNTER_B.load(atomic::Ordering::SeqCst), 1);
}
#[test]
fn repeating_timer_debounce() {
let mut handlers = HandlerQueues::new();
static COUNTER: atomic::AtomicI32 = atomic::AtomicI32::new(0);
let now = Instant::now();
handlers.enqueue_persistent_timer(
Box::new(|| {
COUNTER.fetch_add(1, atomic::Ordering::SeqCst);
}),
now,
Duration::from_millis(2),
);
// Timer handler hasn't run.
assert_eq!(COUNTER.load(atomic::Ordering::SeqCst), 0);
// Timer should run every 2 ms, but 10 ms have passed.
handlers.check_timer_handlers(now + Duration::from_millis(10));
// Timer should only have run once.
assert_eq!(COUNTER.load(atomic::Ordering::SeqCst), 1);
// Timer has been rescheduled for an appropriate time.
assert_eq!(handlers.timer_handlers.len(), 1);
assert_eq!(
handlers.timer_handlers[0].when,
now + Duration::from_millis(12)
);
}
}
pub mod ffi {
use super::*;
use crate::sendable::Sendable;
use std::{
ffi::{c_int, c_uint, c_void},
mem,
time::Instant,
};
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMAddTimerHandler(
milliseconds: c_uint,
callback: Option<unsafe extern "C" fn(data: *mut c_void)>,
cdata: *mut c_void,
) -> HandlerId {
let cdata = unsafe { Sendable::from_nullable(cdata) };
let callback = match callback {
None => return HandlerId(None),
Some(f) => Box::new(move || unsafe { f(Sendable::as_ptr(cdata)) }),
};
with_global_handlers(|handlers| {
handlers.enqueue_once_timer(
callback,
Instant::now() + Duration::from_millis(milliseconds as u64),
)
})
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMAddPersistentTimerHandler(
milliseconds: c_uint,
callback: Option<unsafe extern "C" fn(data: *mut c_void)>,
cdata: *mut c_void,
) -> HandlerId {
let cdata = unsafe { Sendable::from_nullable(cdata) };
let callback = match callback {
None => return HandlerId(None),
Some(f) => Box::new(move || unsafe { f(Sendable::as_ptr(cdata)) }),
};
let delay = Duration::from_millis(milliseconds as u64);
with_global_handlers(move |handlers| {
handlers.enqueue_persistent_timer(callback, Instant::now() + delay, delay)
})
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMDeleteTimerHandler(handler_id: HandlerId) {
with_global_handlers(|handlers| handlers.delete_timer_handler(handler_id));
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMAddIdleHandler(
callback: Option<unsafe extern "C" fn(data: *mut c_void)>,
cdata: *mut c_void,
) -> HandlerId {
let cdata = unsafe { Sendable::from_nullable(cdata) };
let callback = match callback {
None => return HandlerId(None),
Some(f) => Box::new(move || unsafe { (f)(Sendable::as_ptr(cdata)) }),
};
with_global_handlers(|handlers| handlers.add_idle_handler(callback))
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn WMDeleteIdleHandler(handler_id: HandlerId) {
with_global_handlers(|handlers| handlers.delete_idle_handler(handler_id));
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn W_CheckIdleHandlers() -> c_int {
c_int::from(run_global_idle_handlers() == QueueStatus::Pending)
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn W_CheckTimerHandlers() {
let reschedule = run_timer_handlers(
with_global_handlers(|handlers| mem::take(&mut handlers.timer_handlers)),
Instant::now(),
);
with_global_handlers(|handlers| {
for t in reschedule.into_iter() {
handlers.enqueue_timer(t);
}
});
}
#[unsafe(no_mangle)]
pub unsafe extern "C" fn W_DelayUntilNextTimerEvent_millis() -> c_int {
with_global_handlers(|handlers| {
let now = Instant::now();
match handlers.next_timer_handler_time() {
Some(when) if when > now => {
c_int::try_from((when - now).as_millis()).unwrap_or(c_int::MAX)
}
Some(_) => 0,
None => -1,
}
})
}
}

View File

@@ -69,7 +69,6 @@ impl HashTable {
}
}
#[derive(Debug)]
#[repr(transparent)]
pub struct StringKey(*const u8);
@@ -85,6 +84,12 @@ impl PartialEq for StringKey {
impl Eq for StringKey {}
impl std::fmt::Debug for StringKey {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "StringKey({:?})", unsafe { std::ffi::CStr::from_ptr(self.0) })
}
}
impl Hash for StringKey {
fn hash<H: Hasher>(&self, h: &mut H) {
if self.0.is_null() {
@@ -291,4 +296,43 @@ pub mod ffi {
},
}
}
#[cfg(test)]
mod test {
use super::*;
use std::{ffi::CString, ptr};
#[test]
fn enumerate_nonempty() {
unsafe {
let table = WMCreateStringHashTable();
let k1 = CString::new("hello").unwrap().into_raw();
let v1 = CString::new("world").unwrap().into_raw();
let k2 = CString::new("foo").unwrap().into_raw();
let v2 = CString::new("bar").unwrap().into_raw();
WMHashInsert(table, k1.cast(), v1.cast());
WMHashInsert(table, k2.cast(), v2.cast());
let i = WMEnumerateHashTable(table);
let v = WMNextHashEnumeratorItem(i);
assert_ne!(v, ptr::null_mut());
assert!(v == v1.cast() || v == v2.cast());
let v = WMNextHashEnumeratorItem(i);
assert_ne!(v, ptr::null_mut());
assert!(v == v1.cast() || v == v2.cast());
let v = WMNextHashEnumeratorItem(i);
assert_eq!(v, ptr::null_mut());
WMFreeHashEnumerator(i);
let _ = CString::from_raw(k1);
let _ = CString::from_raw(v1);
let _ = CString::from_raw(k2);
let _ = CString::from_raw(v2);
}
}
}
}

View File

@@ -3,9 +3,11 @@ pub mod bag;
pub mod data;
pub mod defines;
pub mod find_file;
pub mod handlers;
pub mod hash_table;
pub mod memory;
pub mod notification;
pub mod prop_list;
pub mod sendable;
pub mod string;
pub mod tree;

View File

@@ -1,7 +1,7 @@
use crate::sendable::Sendable;
use std::{
collections::{btree_map::Entry, BTreeMap},
ffi::{c_void, CStr},
ptr::{self, NonNull},
sync::Mutex,
};
@@ -63,29 +63,6 @@ pub struct Notification {
/// Callback that notifies `observer` (which may be null) of `notification` (which won't be).
pub type Action = unsafe extern "C" fn(observer: *mut c_void, notification: *const Notification);
/// Wraps a type-erased pointer (which it does not own) and marks it as `Send`.
///
/// The `Send`-ability of the wrapped pointer must be guaranteed by code that
/// instantiates a `Sendable`.
#[derive(Clone, Copy, Eq, Ord, PartialEq, PartialOrd)]
pub struct Sendable {
ptr: NonNull<c_void>,
}
impl Sendable {
/// Creates a `Sendable` wrapping `ptr`.
///
/// ## Safety
///
/// `ptr` must be safe to send across threads.
pub unsafe fn new(ptr: NonNull<c_void>) -> Self {
Sendable { ptr }
}
}
// Guaranteed by `Sendable::new`.
unsafe impl Send for Sendable {}
pub struct NotificationCenter {
/// Notification subscriptions that match on name and source.
exact: BTreeMap<(&'static CStr, Sendable), Vec<(Option<Sendable>, Action)>>,
@@ -112,15 +89,21 @@ impl NotificationCenter {
}
}
/// Provides access to the default, process-wide notification center. The
/// FFI C API uses this notification center. This is protected behind a
/// mutex that is held while `f` is run, so panicking inside of `f` should
/// be avoided.
/// Provides access to the default, process-wide notification center.
///
/// The FFI C API uses this notification center. This is protected behind a
/// mutex that is held while `f` is run, so:
///
/// * Panicking inside of `f` should be avoided.
/// * Triggering notification dispatch recursively (as when a notification
/// callback dispatches another notification) must be done with care. This
/// is handled correctly by [`ffi::WMPostNotificationName`], which does not
/// hold the mutex during callback execution.
pub fn with_global_default<R>(f: impl FnOnce(&mut Self) -> R) -> R {
static INSTANCE: Mutex<NotificationCenter> = Mutex::new(NotificationCenter::new());
f(&mut INSTANCE
.try_lock()
.unwrap())
.expect("cannot unlock notification center (recursive notification dispatch?)"))
}
/// Registers `action` to be invoked and invoked on `observer` when
@@ -167,7 +150,7 @@ impl NotificationCenter {
pub fn dispatch(&mut self, notification: Notification) {
if let Some(observers) = self.by_name.get_mut(notification.name) {
for (observer, action) in observers {
let observer = observer.map(|x| x.ptr.as_ptr()).unwrap_or(ptr::null_mut());
let observer = Sendable::as_ptr(*observer);
unsafe {
(action)(observer, &notification);
}
@@ -177,7 +160,7 @@ impl NotificationCenter {
if let Some(source) = notification.source {
if let Some(observers) = self.exact.get_mut(&(notification.name, source)) {
for (observer, action) in observers {
let observer = observer.map(|x| x.ptr.as_ptr()).unwrap_or(ptr::null_mut());
let observer = Sendable::as_ptr(*observer);
unsafe {
(action)(observer, &notification);
}
@@ -185,7 +168,7 @@ impl NotificationCenter {
}
if let Some(observers) = self.by_source.get_mut(&source) {
for (observer, action) in observers {
let observer = observer.map(|x| x.ptr.as_ptr()).unwrap_or(ptr::null_mut());
let observer = Sendable::as_ptr(*observer);
unsafe {
(action)(observer, &notification);
}
@@ -194,13 +177,57 @@ impl NotificationCenter {
}
for (observer, action) in &mut self.universal {
let observer = observer.map(|x| x.ptr.as_ptr()).unwrap_or(ptr::null_mut());
let observer = Sendable::as_ptr(*observer);
unsafe {
(action)(observer, &notification);
}
}
}
/// Returns an independent callback that dispatches `notification` when
/// invoked.
///
/// This should be used when `self` is under a non-reentrant lock (such as a
/// mutex) which renders it inaccessible when dispatching
/// `notification`. Callback pointers are copied into the return value,
/// after which the lock on `self` may be relinquished, and then the return
/// value may be invoked, and notification dispatch will actually happen.
fn dispatch_actions(&self, notification: Notification) -> Box<dyn FnOnce()> {
let mut actions: Vec<(Option<Sendable>, Action)> = Vec::new();
if let Some(observers) = self.by_name.get(notification.name) {
for x in observers.iter().copied() {
actions.push(x);
}
}
if let Some(source) = notification.source {
if let Some(observers) = self.exact.get(&(notification.name, source)) {
for x in observers.iter().copied() {
actions.push(x);
}
}
if let Some(observers) = self.by_source.get(&source) {
for x in observers.iter().copied() {
actions.push(x);
}
}
}
for x in self.universal.iter().copied() {
actions.push(x);
}
Box::new(move || {
for (observer, action) in actions.into_iter() {
let observer = Sendable::as_ptr(observer);
unsafe {
(action)(observer, &notification);
}
}
})
}
/// Removes all notification subscriptions that would notify `observer` if they fired.
pub fn remove_observer(&mut self, observer: Sendable) {
self.exact.retain(|_, values| {
@@ -283,7 +310,7 @@ pub mod ffi {
let Some(action) = action else {
return;
};
let observer = NonNull::new(observer).map(|x| unsafe { Sendable::new(x) });
let observer = unsafe { Sendable::from_nullable(observer) };
let source = NonNull::new(object);
NotificationCenter::with_global_default(|c| {
if name.is_null() {
@@ -340,15 +367,17 @@ pub mod ffi {
return;
}
let name = unsafe { CStr::from_ptr(name) };
let source = NonNull::new(object).map(|x| unsafe { Sendable::new(x) });
let client_data = NonNull::new(client_data).map(|x| unsafe { Sendable::new(x) });
NotificationCenter::with_global_default(|c| {
c.dispatch(Notification {
let source = unsafe { Sendable::from_nullable(object) };
let client_data = unsafe { Sendable::from_nullable(client_data) };
let todo = NotificationCenter::with_global_default(|c| {
c.dispatch_actions(Notification {
name,
source,
client_data,
})
});
(todo)();
}
/// Resets all notifications for the global notification center. Used by
@@ -358,3 +387,67 @@ pub mod ffi {
NotificationCenter::with_global_default(|c| c.clear());
}
}
#[cfg(test)]
mod tests {
use super::ffi::*;
use super::*;
use std::ffi::CStr;
use std::ptr;
use std::sync::atomic;
#[test]
fn reentrant_global_notification() {
static NOTIFICATION_A_NAME: &'static CStr = c"MyNotificationA";
static NOTIFICATION_B_NAME: &'static CStr = c"MyNotificationB";
static DATA_A: atomic::AtomicU16 = atomic::AtomicU16::new(0);
static DATA_B: atomic::AtomicU16 = atomic::AtomicU16::new(0);
unsafe extern "C" fn action_a(observer: *mut c_void, notification: *const Notification) {
assert!(observer.is_null());
assert!(!notification.is_null());
assert_eq!(DATA_A.fetch_add(1, atomic::Ordering::SeqCst), 0);
unsafe {
// Trigger action_b.
WMPostNotificationName(
NOTIFICATION_B_NAME.as_ptr(),
ptr::null_mut(),
ptr::null_mut(),
);
}
}
unsafe extern "C" fn action_b(observer: *mut c_void, notification: *const Notification) {
assert!(observer.is_null());
assert!(!notification.is_null());
assert_eq!(DATA_A.load(atomic::Ordering::SeqCst), 1);
assert_eq!(DATA_B.fetch_add(1, atomic::Ordering::SeqCst), 0);
}
assert_eq!(DATA_A.load(atomic::Ordering::SeqCst), 0);
assert_eq!(DATA_B.load(atomic::Ordering::SeqCst), 0);
unsafe {
WMAddNotificationObserver(
Some(action_a),
ptr::null_mut(),
NOTIFICATION_A_NAME.as_ptr(),
ptr::null_mut(),
);
WMAddNotificationObserver(
Some(action_b),
ptr::null_mut(),
NOTIFICATION_B_NAME.as_ptr(),
ptr::null_mut(),
);
WMPostNotificationName(
NOTIFICATION_A_NAME.as_ptr(),
ptr::null_mut(),
ptr::null_mut(),
);
}
assert_eq!(DATA_A.load(atomic::Ordering::SeqCst), 1);
assert_eq!(DATA_B.load(atomic::Ordering::SeqCst), 1);
}
}

41
wutil-rs/src/sendable.rs Normal file
View File

@@ -0,0 +1,41 @@
use std::{ffi::c_void, ptr::{NonNull, self}};
/// Wraps a type-erased pointer (which it does not own) and marks it as `Send`.
///
/// The `Send`-ability of the wrapped pointer must be guaranteed by code that
/// instantiates a `Sendable`.
#[derive(Clone, Copy, Eq, Ord, PartialEq, PartialOrd)]
pub struct Sendable {
pub(crate) ptr: NonNull<c_void>,
}
impl Sendable {
/// Creates a `Sendable` wrapping `ptr`.
///
/// ## Safety
///
/// `ptr` must be safe to send across threads.
pub const unsafe fn new(ptr: NonNull<c_void>) -> Self {
Sendable { ptr }
}
/// Creates a `Sendable` if `ptr` is not null, returning `None` if it is.
/// ## Safety
///
/// `ptr` must be safe to send across threads.
pub unsafe fn from_nullable(ptr: *mut c_void) -> Option<Self> {
unsafe {
NonNull::new(ptr)
.map(|p| Sendable::new(p))
}
}
/// Retrieves the pointer wrapped by `s`, or a null pointer if `s` is
/// `None`.
pub fn as_ptr(s: Option<Sendable>) -> *mut c_void {
s.map(|s| s.ptr.as_ptr()).unwrap_or(ptr::null_mut())
}
}
// Guaranteed by `Sendable::new`.
unsafe impl Send for Sendable {}

View File

@@ -7,7 +7,7 @@
use std::{
ffi::{c_char, c_int, CStr},
iter, mem, ptr, slice,
mem, ptr, slice,
};
use crate::memory::{alloc_bytes, alloc_string, ffi::wrealloc, free_bytes};