tiny code-style and typo-fix in comment
[st.git] / x.c
diff --git a/x.c b/x.c
index 2cd76d0..7bfc36f 100644 (file)
--- a/x.c
+++ b/x.c
@@ -15,7 +15,7 @@
 #include <X11/Xft/Xft.h>
 #include <X11/XKBlib.h>
 
-static char *argv0;
+char *argv0;
 #include "arg.h"
 #include "st.h"
 #include "win.h"
@@ -29,9 +29,11 @@ typedef struct {
 } Shortcut;
 
 typedef struct {
-       uint b;
-       uint mask;
-       char *s;
+       uint mod;
+       uint button;
+       void (*func)(const Arg *);
+       const Arg arg;
+       uint  release;
 } MouseShortcut;
 
 typedef struct {
@@ -56,6 +58,7 @@ static void selpaste(const Arg *);
 static void zoom(const Arg *);
 static void zoomabs(const Arg *);
 static void zoomreset(const Arg *);
+static void ttysend(const Arg *);
 
 /* config.h for applying patches and the configuration. */
 #include "config.h"
@@ -91,8 +94,12 @@ typedef struct {
        Drawable buf;
        GlyphFontSpec *specbuf; /* font spec buffer used for rendering */
        Atom xembed, wmdeletewin, netwmname, netwmpid;
-       XIM xim;
-       XIC xic;
+       struct {
+               XIM xim;
+               XIC xic;
+               XPoint spot;
+               XVaNestedList spotlist;
+       } ime;
        Draw draw;
        Visual *vis;
        XSetWindowAttributes attrs;
@@ -139,9 +146,10 @@ static void xdrawglyphfontspecs(const XftGlyphFontSpec *, Glyph, int, int, int);
 static void xdrawglyph(Glyph, int, int);
 static void xclear(int, int, int, int);
 static int xgeommasktogravity(int);
-static void ximopen(Display *);
+static int ximopen(Display *);
 static void ximinstantiate(Display *, XPointer, XPointer);
 static void ximdestroy(XIM, XPointer, XPointer);
+static int xicdestroy(XIC, XPointer, XPointer);
 static void xinit(int, int);
 static void cresize(int, int);
 static void xresize(int, int);
@@ -163,6 +171,8 @@ static void kpress(XEvent *);
 static void cmessage(XEvent *);
 static void resize(XEvent *);
 static void focus(XEvent *);
+static uint buttonmask(uint);
+static int mouseaction(XEvent *, uint);
 static void brelease(XEvent *);
 static void bpress(XEvent *);
 static void bmotion(XEvent *);
@@ -312,6 +322,12 @@ zoomreset(const Arg *arg)
        }
 }
 
+void
+ttysend(const Arg *arg)
+{
+       ttywrite(arg->s, strlen(arg->s), 1);
+}
+
 int
 evcol(XEvent *e)
 {
@@ -332,7 +348,7 @@ void
 mousesel(XEvent *e, int done)
 {
        int type, seltype = SEL_REGULAR;
-       uint state = e->xbutton.state & ~(Button1Mask | forceselmod);
+       uint state = e->xbutton.state & ~(Button1Mask | forcemousemod);
 
        for (type = 1; type < LEN(selmasks); ++type) {
                if (match(selmasks[type], state)) {
@@ -408,25 +424,51 @@ mousereport(XEvent *e)
        ttywrite(buf, len, 0);
 }
 
+uint
+buttonmask(uint button)
+{
+       return button == Button1 ? Button1Mask
+            : button == Button2 ? Button2Mask
+            : button == Button3 ? Button3Mask
+            : button == Button4 ? Button4Mask
+            : button == Button5 ? Button5Mask
+            : 0;
+}
+
+int
+mouseaction(XEvent *e, uint release)
+{
+       MouseShortcut *ms;
+
+       /* ignore Button<N>mask for Button<N> - it's set on release */
+       uint state = e->xbutton.state & ~buttonmask(e->xbutton.button);
+
+       for (ms = mshortcuts; ms < mshortcuts + LEN(mshortcuts); ms++) {
+               if (ms->release == release &&
+                   ms->button == e->xbutton.button &&
+                   (match(ms->mod, state) ||  /* exact or forced */
+                    match(ms->mod, state & ~forcemousemod))) {
+                       ms->func(&(ms->arg));
+                       return 1;
+               }
+       }
+
+       return 0;
+}
+
 void
 bpress(XEvent *e)
 {
        struct timespec now;
-       MouseShortcut *ms;
        int snap;
 
-       if (IS_SET(MODE_MOUSE) && !(e->xbutton.state & forceselmod)) {
+       if (IS_SET(MODE_MOUSE) && !(e->xbutton.state & forcemousemod)) {
                mousereport(e);
                return;
        }
 
-       for (ms = mshortcuts; ms < mshortcuts + LEN(mshortcuts); ms++) {
-               if (e->xbutton.button == ms->b
-                               && match(ms->mask, e->xbutton.state)) {
-                       ttywrite(ms->s, strlen(ms->s), 1);
-                       return;
-               }
-       }
+       if (mouseaction(e, 0))
+               return;
 
        if (e->xbutton.button == Button1) {
                /*
@@ -642,21 +684,21 @@ xsetsel(char *str)
 void
 brelease(XEvent *e)
 {
-       if (IS_SET(MODE_MOUSE) && !(e->xbutton.state & forceselmod)) {
+       if (IS_SET(MODE_MOUSE) && !(e->xbutton.state & forcemousemod)) {
                mousereport(e);
                return;
        }
 
-       if (e->xbutton.button == Button2)
-               selpaste(NULL);
-       else if (e->xbutton.button == Button1)
+       if (mouseaction(e, 1))
+               return;
+       if (e->xbutton.button == Button1)
                mousesel(e, 1);
 }
 
 void
 bmotion(XEvent *e)
 {
-       if (IS_SET(MODE_MOUSE) && !(e->xbutton.state & forceselmod)) {
+       if (IS_SET(MODE_MOUSE) && !(e->xbutton.state & forcemousemod)) {
                mousereport(e);
                return;
        }
@@ -763,7 +805,6 @@ xsetcolorname(int x, const char *name)
        if (!BETWEEN(x, 0, dc.collen))
                return 1;
 
-
        if (!xloadcolor(x, name, &ncolor))
                return 1;
 
@@ -1000,41 +1041,58 @@ xunloadfonts(void)
        xunloadfont(&dc.ibfont);
 }
 
-void
+int
 ximopen(Display *dpy)
 {
-       XIMCallback destroy = { .client_data = NULL, .callback = ximdestroy };
+       XIMCallback imdestroy = { .client_data = NULL, .callback = ximdestroy };
+       XICCallback icdestroy = { .client_data = NULL, .callback = xicdestroy };
 
-       if ((xw.xim = XOpenIM(xw.dpy, NULL, NULL, NULL)) == NULL) {
-               XSetLocaleModifiers("@im=local");
-               if ((xw.xim = XOpenIM(xw.dpy, NULL, NULL, NULL)) == NULL) {
-                       XSetLocaleModifiers("@im=");
-                       if ((xw.xim = XOpenIM(xw.dpy, NULL, NULL, NULL)) == NULL)
-                               die("XOpenIM failed. Could not open input device.\n");
-               }
+       xw.ime.xim = XOpenIM(xw.dpy, NULL, NULL, NULL);
+       if (xw.ime.xim == NULL)
+               return 0;
+
+       if (XSetIMValues(xw.ime.xim, XNDestroyCallback, &imdestroy, NULL))
+               fprintf(stderr, "XSetIMValues: "
+                               "Could not set XNDestroyCallback.\n");
+
+       xw.ime.spotlist = XVaCreateNestedList(0, XNSpotLocation, &xw.ime.spot,
+                                             NULL);
+
+       if (xw.ime.xic == NULL) {
+               xw.ime.xic = XCreateIC(xw.ime.xim, XNInputStyle,
+                                      XIMPreeditNothing | XIMStatusNothing,
+                                      XNClientWindow, xw.win,
+                                      XNDestroyCallback, &icdestroy,
+                                      NULL);
        }
-       if (XSetIMValues(xw.xim, XNDestroyCallback, &destroy, NULL) != NULL)
-               die("XSetIMValues failed. Could not set input method value.\n");
-       xw.xic = XCreateIC(xw.xim, XNInputStyle, XIMPreeditNothing | XIMStatusNothing,
-                               XNClientWindow, xw.win, XNFocusWindow, xw.win, NULL);
-       if (xw.xic == NULL)
-               die("XCreateIC failed. Could not obtain input method.\n");
+       if (xw.ime.xic == NULL)
+               fprintf(stderr, "XCreateIC: Could not create input context.\n");
+
+       return 1;
 }
 
 void
 ximinstantiate(Display *dpy, XPointer client, XPointer call)
 {
-       ximopen(dpy);
-       XUnregisterIMInstantiateCallback(xw.dpy, NULL, NULL, NULL,
-                                       ximinstantiate, NULL);
+       if (ximopen(dpy))
+               XUnregisterIMInstantiateCallback(xw.dpy, NULL, NULL, NULL,
+                                                ximinstantiate, NULL);
 }
 
 void
 ximdestroy(XIM xim, XPointer client, XPointer call)
 {
-       xw.xim = NULL;
+       xw.ime.xim = NULL;
        XRegisterIMInstantiateCallback(xw.dpy, NULL, NULL, NULL,
-                                       ximinstantiate, NULL);
+                                      ximinstantiate, NULL);
+       XFree(xw.ime.spotlist);
+}
+
+int
+xicdestroy(XIC xim, XPointer client, XPointer call)
+{
+       xw.ime.xic = NULL;
+       return 1;
 }
 
 void
@@ -1102,7 +1160,10 @@ xinit(int cols, int rows)
        xw.draw = XftDrawCreate(xw.dpy, xw.buf, xw.vis, xw.cmap);
 
        /* input methods */
-       ximopen(xw.dpy);
+       if (!ximopen(xw.dpy)) {
+               XRegisterIMInstantiateCallback(xw.dpy, NULL, NULL, NULL,
+                                              ximinstantiate, NULL);
+       }
 
        /* white cursor, black outline */
        cursor = XCreateFontCursor(xw.dpy, mouseshape);
@@ -1133,8 +1194,8 @@ xinit(int cols, int rows)
 
        win.mode = MODE_NUMLOCK;
        resettitle();
-       XMapWindow(xw.dpy, xw.win);
        xhints();
+       XMapWindow(xw.dpy, xw.win);
        XSync(xw.dpy, False);
 
        clock_gettime(CLOCK_MONOTONIC, &xsel.tclick1);
@@ -1244,15 +1305,10 @@ xmakeglyphfontspecs(XftGlyphFontSpec *specs, const Glyph *glyphs, int len, int x
                        fontpattern = FcFontSetMatch(0, fcsets, 1,
                                        fcpattern, &fcres);
 
-                       /*
-                        * Allocate memory for the new cache entry.
-                        */
+                       /* Allocate memory for the new cache entry. */
                        if (frclen >= frccap) {
                                frccap += 16;
-                               if (!frc)
-                                       frc = xmalloc(frccap * sizeof(Fontcache));
-                               else
-                                       frc = xrealloc(frc, frccap * sizeof(Fontcache));
+                               frc = xrealloc(frc, frccap * sizeof(Fontcache));
                        }
 
                        frc[frclen].font = XftFontOpenPattern(xw.dpy,
@@ -1585,11 +1641,13 @@ xfinishdraw(void)
 void
 xximspot(int x, int y)
 {
-       XPoint spot = { borderpx + x * win.cw, borderpx + (y + 1) * win.ch };
-       XVaNestedList attr = XVaCreateNestedList(0, XNSpotLocation, &spot, NULL);
+       if (xw.ime.xic == NULL)
+               return;
 
-       XSetICValues(xw.xic, XNPreeditAttributes, attr, NULL);
-       XFree(attr);
+       xw.ime.spot.x = borderpx + x * win.cw;
+       xw.ime.spot.y = borderpx + (y + 1) * win.ch;
+
+       XSetICValues(xw.ime.xic, XNPreeditAttributes, xw.ime.spotlist, NULL);
 }
 
 void
@@ -1666,13 +1724,15 @@ focus(XEvent *ev)
                return;
 
        if (ev->type == FocusIn) {
-               XSetICFocus(xw.xic);
+               if (xw.ime.xic)
+                       XSetICFocus(xw.ime.xic);
                win.mode |= MODE_FOCUSED;
                xseturgency(0);
                if (IS_SET(MODE_FOCUS))
                        ttywrite("\033[I", 3, 0);
        } else {
-               XUnsetICFocus(xw.xic);
+               if (xw.ime.xic)
+                       XUnsetICFocus(xw.ime.xic);
                win.mode &= ~MODE_FOCUSED;
                if (IS_SET(MODE_FOCUS))
                        ttywrite("\033[O", 3, 0);
@@ -1727,7 +1787,7 @@ kpress(XEvent *ev)
 {
        XKeyEvent *e = &ev->xkey;
        KeySym ksym;
-       char buf[32], *customkey;
+       char buf[64], *customkey;
        int len;
        Rune c;
        Status status;
@@ -1736,7 +1796,10 @@ kpress(XEvent *ev)
        if (IS_SET(MODE_KBDLOCK))
                return;
 
-       len = XmbLookupString(xw.xic, e, buf, sizeof buf, &ksym, &status);
+       if (xw.ime.xic)
+               len = XmbLookupString(xw.ime.xic, e, buf, sizeof buf, &ksym, &status);
+       else
+               len = XLookupString(e, buf, sizeof buf, &ksym, NULL);
        /* 1. shortcuts */
        for (bp = shortcuts; bp < shortcuts + LEN(shortcuts); bp++) {
                if (ksym == bp->keysym && match(bp->mod, e->state)) {
@@ -1769,7 +1832,6 @@ kpress(XEvent *ev)
        ttywrite(buf, len, 1);
 }
 
-
 void
 cmessage(XEvent *e)
 {
@@ -1805,10 +1867,9 @@ run(void)
        XEvent ev;
        int w = win.w, h = win.h;
        fd_set rfd;
-       int xfd = XConnectionNumber(xw.dpy), xev, blinkset = 0, dodraw = 0;
-       int ttyfd;
-       struct timespec drawtimeout, *tv = NULL, now, last, lastblink;
-       long deltatime;
+       int xfd = XConnectionNumber(xw.dpy), ttyfd, xev, drawing;
+       struct timespec seltv, *tv, now, lastblink, trigger;
+       double timeout;
 
        /* Waiting for window mapping */
        do {
@@ -1829,82 +1890,77 @@ run(void)
        ttyfd = ttynew(opt_line, shell, opt_io, opt_cmd);
        cresize(w, h);
 
-       clock_gettime(CLOCK_MONOTONIC, &last);
-       lastblink = last;
-
-       for (xev = actionfps;;) {
+       for (timeout = -1, drawing = 0, lastblink = (struct timespec){0};;) {
                FD_ZERO(&rfd);
                FD_SET(ttyfd, &rfd);
                FD_SET(xfd, &rfd);
 
+               if (XPending(xw.dpy))
+                       timeout = 0;  /* existing events might not set xfd */
+
+               seltv.tv_sec = timeout / 1E3;
+               seltv.tv_nsec = 1E6 * (timeout - 1E3 * seltv.tv_sec);
+               tv = timeout >= 0 ? &seltv : NULL;
+
                if (pselect(MAX(xfd, ttyfd)+1, &rfd, NULL, NULL, tv, NULL) < 0) {
                        if (errno == EINTR)
                                continue;
                        die("select failed: %s\n", strerror(errno));
                }
-               if (FD_ISSET(ttyfd, &rfd)) {
-                       ttyread();
-                       if (blinktimeout) {
-                               blinkset = tattrset(ATTR_BLINK);
-                               if (!blinkset)
-                                       MODBIT(win.mode, 0, MODE_BLINK);
-                       }
-               }
+               clock_gettime(CLOCK_MONOTONIC, &now);
 
-               if (FD_ISSET(xfd, &rfd))
-                       xev = actionfps;
+               if (FD_ISSET(ttyfd, &rfd))
+                       ttyread();
 
-               clock_gettime(CLOCK_MONOTONIC, &now);
-               drawtimeout.tv_sec = 0;
-               drawtimeout.tv_nsec =  (1000 * 1E6)/ xfps;
-               tv = &drawtimeout;
-
-               dodraw = 0;
-               if (blinktimeout && TIMEDIFF(now, lastblink) > blinktimeout) {
-                       tsetdirtattr(ATTR_BLINK);
-                       win.mode ^= MODE_BLINK;
-                       lastblink = now;
-                       dodraw = 1;
-               }
-               deltatime = TIMEDIFF(now, last);
-               if (deltatime > 1000 / (xev ? xfps : actionfps)) {
-                       dodraw = 1;
-                       last = now;
+               xev = 0;
+               while (XPending(xw.dpy)) {
+                       xev = 1;
+                       XNextEvent(xw.dpy, &ev);
+                       if (XFilterEvent(&ev, None))
+                               continue;
+                       if (handler[ev.type])
+                               (handler[ev.type])(&ev);
                }
 
-               if (dodraw) {
-                       while (XPending(xw.dpy)) {
-                               XNextEvent(xw.dpy, &ev);
-                               if (XFilterEvent(&ev, None))
-                                       continue;
-                               if (handler[ev.type])
-                                       (handler[ev.type])(&ev);
+               /*
+                * To reduce flicker and tearing, when new content or event
+                * triggers drawing, we first wait a bit to ensure we got
+                * everything, and if nothing new arrives - we draw.
+                * We start with trying to wait minlatency ms. If more content
+                * arrives sooner, we retry with shorter and shorter periods,
+                * and eventually draw even without idle after maxlatency ms.
+                * Typically this results in low latency while interacting,
+                * maximum latency intervals during `cat huge.txt`, and perfect
+                * sync with periodic updates from animations/key-repeats/etc.
+                */
+               if (FD_ISSET(ttyfd, &rfd) || xev) {
+                       if (!drawing) {
+                               trigger = now;
+                               drawing = 1;
                        }
+                       timeout = (maxlatency - TIMEDIFF(now, trigger)) \
+                                 / maxlatency * minlatency;
+                       if (timeout > 0)
+                               continue;  /* we have time, try to find idle */
+               }
 
-                       draw();
-                       XFlush(xw.dpy);
-
-                       if (xev && !FD_ISSET(xfd, &rfd))
-                               xev--;
-                       if (!FD_ISSET(ttyfd, &rfd) && !FD_ISSET(xfd, &rfd)) {
-                               if (blinkset) {
-                                       if (TIMEDIFF(now, lastblink) \
-                                                       > blinktimeout) {
-                                               drawtimeout.tv_nsec = 1000;
-                                       } else {
-                                               drawtimeout.tv_nsec = (1E6 * \
-                                                       (blinktimeout - \
-                                                       TIMEDIFF(now,
-                                                               lastblink)));
-                                       }
-                                       drawtimeout.tv_sec = \
-                                           drawtimeout.tv_nsec / 1E9;
-                                       drawtimeout.tv_nsec %= (long)1E9;
-                               } else {
-                                       tv = NULL;
-                               }
+               /* idle detected or maxlatency exhausted -> draw */
+               timeout = -1;
+               if (blinktimeout && tattrset(ATTR_BLINK)) {
+                       timeout = blinktimeout - TIMEDIFF(now, lastblink);
+                       if (timeout <= 0) {
+                               if (-timeout > blinktimeout) /* start visible */
+                                       win.mode |= MODE_BLINK;
+                               win.mode ^= MODE_BLINK;
+                               tsetdirtattr(ATTR_BLINK);
+                               lastblink = now;
+                               timeout = blinktimeout;
                        }
                }
+
+               draw();
+               XFlush(xw.dpy);
+               drawing = 0;
        }
 }