Fix compiler warnings from OS X Lion: a missing #include and some
[sgt/utils] / xcopy / xcopy.c
index a89a6cc..bc5e329 100644 (file)
 #include <math.h>
 #include <errno.h>
 #include <assert.h>
+#include <ctype.h>
+
+#include <unistd.h>
 
 #include <X11/X.h>
+#include <X11/Intrinsic.h>
 #include <X11/Xlib.h>
 #include <X11/Xutil.h>
 #include <X11/Xatom.h>
@@ -32,11 +36,24 @@ enum { STRING, CTEXT, UTF8, TARGETS, TIMESTAMP, CUSTOM } mode = STRING;
 int use_clipboard = False;
 char *custom_seltype = NULL;
 int fork_when_writing = True;
+int use_cutbuffers = True;
+int use_outgoing_incr = True;
+int sel_delta = 16384;
 
 /* selection data */
 char *seltext;
 int sellen, selsize;
-#define SELDELTA 16384
+
+/* incremental transfers still pending when we return to the event loop */
+struct incr {
+    Window window;
+    Atom property;
+    Atom type;
+    int format;
+    unsigned char *data;
+    size_t size;
+} *incrs = NULL;
+int nincrs = 0, incrsize = 0;
 
 /* functional parameters */
 int reading;                           /* read instead of writing? */
@@ -45,17 +62,20 @@ int verbose;
 
 const char usagemsg[] =
     "usage: xcopy [ -r ] [ -u | -c ] [ -C ]\n"
-    "where: -r       read X selection and print on stdout\n"
-    "       no -r    read stdin and store in X selection\n"
-    "       -u       work with UTF8_STRING type selections\n"
-    "       -c       work with COMPOUND_TEXT type selections\n"
-    "       -C       suppress automatic conversion to COMPOUND_TEXT\n"
-    "       -b       read the CLIPBOARD rather than the PRIMARY selection\n"
-    "       -t       get the list of targets available to retrieve\n"
+    "modes: -r       read X selection and print on stdout\n"
+    "       no -r    write to X selection from stdin\n"
+    " read: -t       get the list of targets available to retrieve\n"
     "       -T       get the time stamp of the selection contents\n"
     "       -a atom  get an arbitrary form of the selection data\n"
-    "       -F       do not fork in write mode\n"
-    "       -v       proceed verbosely when reading selection\n"
+    "       -v       verbosely report progress in reading selection\n"
+    "write: -F       remain in foreground until selection reclaimed\n"
+    "       -I       do not attempt incremental transfers (INCR)\n"
+    " both: -u       work with UTF8_STRING type selections\n"
+    "       -c       work with COMPOUND_TEXT type selections\n"
+    "       -C       suppress automatic conversion to COMPOUND_TEXT\n"
+    "       -b       use the CLIPBOARD rather than the PRIMARY selection\n"
+    "       -d size  transfer data in chunks of at most <size> (default 16384)\n"
+    "       -B       do not use root window cut buffers\n"
     " also: xcopy --version              report version number\n"
     "       xcopy --help                 display this help text\n"
     "       xcopy --licence              display the (MIT) licence text\n"
@@ -140,12 +160,21 @@ int main(int ac, char **av) {
             mode = TARGETS;
         } else if (!strcmp(p, "-T")) {
             mode = TIMESTAMP;
+        } else if (!strcmp(p, "-I")) {
+            use_outgoing_incr = False;
+        } else if (!strcmp(p, "-B")) {
+            use_cutbuffers = False;
         } else if (!strcmp(p, "-a")) {
            if (--ac > 0)
                custom_seltype = *++av;
            else
                error ("expected an argument to `-a'");
             mode = CUSTOM;
+        } else if (!strcmp(p, "-d")) {
+           if (--ac > 0)
+               sel_delta = atoi(*++av);
+           else
+               error ("expected an argument to `-d'");
        } else if (!strcmp(p, "-F")) {
            fork_when_writing = False;
        } else if (!strcmp(p, "-v")) {
@@ -176,22 +205,22 @@ int main(int ac, char **av) {
     }
 
     if (!reading) {
-        seltext = malloc(SELDELTA);
+        seltext = malloc(sel_delta);
         if (!seltext)
             error ("out of memory");
-        selsize = SELDELTA;
+        selsize = sel_delta;
         sellen = 0;
         do {
             n = fread(seltext+sellen, 1, selsize-sellen, stdin);
             sellen += n;
             if (sellen >= selsize) {
-                seltext = realloc(seltext, selsize += SELDELTA);
+                seltext = realloc(seltext, selsize += sel_delta);
                 if (!seltext)
                     error ("out of memory");
             }
         } while (n > 0);
         if (sellen == selsize) {
-            seltext = realloc(seltext, selsize += SELDELTA);
+            seltext = realloc(seltext, selsize += sel_delta);
             if (!seltext)
                 error ("out of memory");
         }
@@ -343,14 +372,7 @@ int init_X(void) {
         * property on the root window.
          */
         XSelectInput(disp, ourwin, PropertyChangeMask);
-        if (XGetSelectionOwner(disp, sel_atom) == None) {
-            /* No primary selection, so use the cut buffer. */
-           if (verbose)
-               fprintf(stderr, "no selection owner: trying cut buffer\n");
-            if (strtype == XA_STRING)
-               do_paste(DefaultRootWindow(disp), XA_CUT_BUFFER0, True);
-            return False;
-        } else {
+        if (XGetSelectionOwner(disp, sel_atom) != None) {
             Atom sel_property = XInternAtom(disp, "VT_SELECTION", False);
            if (verbose)
                fprintf(stderr, "calling XConvertSelection: selection=%s"
@@ -362,38 +384,51 @@ int init_X(void) {
             XConvertSelection(disp, sel_atom, strtype,
                               sel_property, ourwin, CurrentTime);
             return True;
+        } else if (use_cutbuffers) {
+            /* No primary selection, so use the cut buffer. */
+           if (verbose)
+               fprintf(stderr, "no selection owner: trying cut buffer\n");
+            if (strtype == XA_STRING)
+               do_paste(DefaultRootWindow(disp), XA_CUT_BUFFER0, True);
+            return False;
+        } else {
+            /* Last fallback: do nothing. */
+            return False;
         }
     } else {
         /*
-         * We are writing to the selection, so we establish
-         * ourselves as selection owner. Also place the data in
-         * CUT_BUFFER0, if it isn't of an exotic type (cut buffers
-         * can only take ordinary string data, it turns out).
+         * We are writing to the selection, so we establish ourselves
+         * as selection owner.
+         *
+         * Also place the data in CUT_BUFFER0, if it isn't of an
+         * exotic type (cut buffers can only take ordinary string
+         * data, it turns out) or bigger than our maximum chunk size.
          */
         XSetSelectionOwner (disp, sel_atom, ourwin, CurrentTime);
         if (XGetSelectionOwner (disp, sel_atom) != ourwin)
             error ("unable to obtain primary X selection");
         compound_text_atom = XInternAtom(disp, "COMPOUND_TEXT", False);
-       if (strtype == XA_STRING) {
+       if (strtype == XA_STRING && sellen <= sel_delta && use_cutbuffers) {
            /*
             * ICCCM-required cut buffer initialisation.
             */
+           static const unsigned char emptystring[] = {0};
            XChangeProperty(disp, root, XA_CUT_BUFFER0,
-                           XA_STRING, 8, PropModeAppend, "", 0);
+                           XA_STRING, 8, PropModeAppend, emptystring, 0);
            XChangeProperty(disp, root, XA_CUT_BUFFER1,
-                           XA_STRING, 8, PropModeAppend, "", 0);
+                           XA_STRING, 8, PropModeAppend, emptystring, 0);
            XChangeProperty(disp, root, XA_CUT_BUFFER2,
-                           XA_STRING, 8, PropModeAppend, "", 0);
+                           XA_STRING, 8, PropModeAppend, emptystring, 0);
            XChangeProperty(disp, root, XA_CUT_BUFFER3,
-                           XA_STRING, 8, PropModeAppend, "", 0);
+                           XA_STRING, 8, PropModeAppend, emptystring, 0);
            XChangeProperty(disp, root, XA_CUT_BUFFER4,
-                           XA_STRING, 8, PropModeAppend, "", 0);
+                           XA_STRING, 8, PropModeAppend, emptystring, 0);
            XChangeProperty(disp, root, XA_CUT_BUFFER5,
-                           XA_STRING, 8, PropModeAppend, "", 0);
+                           XA_STRING, 8, PropModeAppend, emptystring, 0);
            XChangeProperty(disp, root, XA_CUT_BUFFER6,
-                           XA_STRING, 8, PropModeAppend, "", 0);
+                           XA_STRING, 8, PropModeAppend, emptystring, 0);
            XChangeProperty(disp, root, XA_CUT_BUFFER7,
-                           XA_STRING, 8, PropModeAppend, "", 0);
+                           XA_STRING, 8, PropModeAppend, emptystring, 0);
            /*
             * Rotate the cut buffers and add our text in CUT_BUFFER0.
             */
@@ -404,18 +439,68 @@ int init_X(void) {
     }
 }
 
+void write_data(Window requestor, Atom property, Atom type, int format,
+                void *vdata, size_t size)
+{
+    int bformat = format / 8;          /* bytes per element */
+    unsigned char *data = (unsigned char *)vdata;
+    XEvent ev;
+
+    if (!use_outgoing_incr || size * bformat <= sel_delta) {
+       XChangeProperty(disp, requestor, property, type, format,
+                        PropModeReplace, data, size);
+    } else {
+        /*
+         * For large data, an incremental transfer as per ICCCM 2.7.2.
+         */
+        Cardinal totalsize = size * bformat;
+        Cardinal sent, thissize;
+
+        /*
+         * We're going to need PropertyNotify events on the target
+         * window to tell us when to send the next chunk.
+         */
+        XSelectInput(disp, requestor, PropertyChangeMask);
+
+        /*
+         * Start by sending a single 32-bit word with type INCR giving
+         * the total size in bytes.
+         */
+       XChangeProperty(disp, requestor, property, incr_atom, 32,
+                        PropModeReplace, (unsigned char *)&totalsize, 1);
+
+        /*
+         * Now set up an entry in our list of ongoing incremental
+         * transfers, so that whenever that property is deleted, we'll
+         * send the next batch.
+         */
+        if (nincrs >= incrsize) {
+            incrsize = nincrs * 9 / 8 + 16;
+            incrs = realloc(incrs, incrsize * sizeof(*incrs));
+            if (!incrs)
+                error ("out of memory");
+        }
+        incrs[nincrs].window = requestor;
+        incrs[nincrs].property = property;
+        incrs[nincrs].type = type;
+        incrs[nincrs].format = format;
+        incrs[nincrs].size = totalsize;
+        incrs[nincrs].data = malloc(totalsize);
+        if (!incrs[nincrs].data)
+            error("out of memory");
+        memcpy(incrs[nincrs].data, data, size);
+        nincrs++;
+    }
+}
+
 Atom convert_sel_inner(Window requestor, Atom target, Atom property) {
     if (target == strtype) {
-       XChangeProperty (disp, requestor, property, strtype,
-                        8, PropModeReplace, seltext, sellen);
+       write_data(requestor, property, strtype, 8, seltext, sellen);
        return property;
     } else if (target == compound_text_atom && convert_to_ctext) {
        XTextProperty tp;
-       XmbTextListToTextProperty (disp, &seltext, 1,
-                                  XCompoundTextStyle, &tp);
-       XChangeProperty (disp, requestor, property, target,
-                        tp.format, PropModeReplace,
-                        tp.value, tp.nitems);
+       XmbTextListToTextProperty(disp, &seltext, 1, XCompoundTextStyle, &tp);
+       write_data(requestor, property, target, tp.format, tp.value,tp.nitems);
        return property;
     } else if (target == targets_atom) {
        Atom targets[16];
@@ -426,15 +511,11 @@ Atom convert_sel_inner(Window requestor, Atom target, Atom property) {
        targets[len++] = strtype;
        if (strtype != compound_text_atom && convert_to_ctext)
            targets[len++] = compound_text_atom;
-       XChangeProperty (disp, requestor, property,
-                        atom_atom, 32, PropModeReplace,
-                        (unsigned char *)targets, len);
+       write_data(requestor, property, atom_atom, 32, targets, len);
        return property;
     } else if (target == timestamp_atom) {
        Time rettime = CurrentTime;
-       XChangeProperty (disp, requestor, property,
-                        integer_atom, 32, PropModeReplace,
-                        (unsigned char *)&rettime, 1);
+       write_data(requestor, property, integer_atom, 32, &rettime, 1);
        return property;
     } else {
        return None;
@@ -442,6 +523,16 @@ Atom convert_sel_inner(Window requestor, Atom target, Atom property) {
 }
 
 Atom convert_sel_outer(Window requestor, Atom target, Atom property) {
+    /*
+     * ICCCM 2.2 says that obsolete clients requesting the selection
+     * request may not specify a property name under which they want
+     * the data written to their window; selection owners are
+     * encouraged to support such clients by reusing the selection
+     * target name as the property.
+     */
+    if (property == None)
+        property = target;
+
     if (target == multiple_atom) {
        /*
         * Support for the MULTIPLE selection type, since it's
@@ -450,10 +541,10 @@ Atom convert_sel_outer(Window requestor, Atom target, Atom property) {
         * application might implement it for me to test against.
         */
 
-       int size = SELDELTA;
+       int size = sel_delta;
        Atom actual_type;
        int actual_format, i;
-       long nitems, bytes_after, nread;
+       unsigned long nitems, bytes_after, nread;
        unsigned char *data;
        Atom *adata;
 
@@ -480,7 +571,7 @@ Atom convert_sel_outer(Window requestor, Atom target, Atom property) {
 
        adata = (Atom *)data;
 
-       for (i = 0; i+1 < nitems; i += 2) {
+       for (i = 0; i+1 < (long)nitems; i += 2) {
             if (adata[i+1] != (Atom)None)   /* ICCCM says this isn't allowed */
                 adata[i+1] = convert_sel_inner(requestor, adata[i],
                                                adata[i+1]);
@@ -502,6 +593,7 @@ Atom convert_sel_outer(Window requestor, Atom target, Atom property) {
 
 void run_X(void) {
     XEvent ev, e2;
+    int i, j;
 
     while (1) {
        XNextEvent (disp, &ev);
@@ -522,23 +614,67 @@ void run_X(void) {
                 return;
             }
         } else {
+            int have_ownership = True;
+
             switch (ev.type) {
               case SelectionClear:
                 /* Selection has been cleared by another app. */
-                return;
+                have_ownership = False;
+                break;
               case SelectionRequest:
-                e2.xselection.type = SelectionNotify;
-                e2.xselection.requestor = ev.xselectionrequest.requestor;
-                e2.xselection.selection = ev.xselectionrequest.selection;
-                e2.xselection.target = ev.xselectionrequest.target;
-                e2.xselection.time = ev.xselectionrequest.time;
-                e2.xselection.property =
-                   convert_sel_outer(ev.xselectionrequest.requestor,
-                                     ev.xselectionrequest.target,
-                                     ev.xselectionrequest.property);
-                XSendEvent (disp, ev.xselectionrequest.requestor,
-                           False, 0, &e2);
+                if (have_ownership) {
+                    e2.xselection.type = SelectionNotify;
+                    e2.xselection.requestor = ev.xselectionrequest.requestor;
+                    e2.xselection.selection = ev.xselectionrequest.selection;
+                    e2.xselection.target = ev.xselectionrequest.target;
+                    e2.xselection.time = ev.xselectionrequest.time;
+                    e2.xselection.property =
+                        convert_sel_outer(ev.xselectionrequest.requestor,
+                                          ev.xselectionrequest.target,
+                                          ev.xselectionrequest.property);
+                    XSendEvent (disp, ev.xselectionrequest.requestor,
+                                False, 0, &e2);
+                }
+                break;
+              case PropertyNotify:
+                for (i = j = 0; i < nincrs; i++) {
+                    int keep = True;
+                    if (incrs[i].window == ev.xproperty.window &&
+                        incrs[i].property == ev.xproperty.atom &&
+                        ev.xproperty.state == PropertyDelete) {
+                        size_t thissize = incrs[i].size;
+                        if (thissize > sel_delta)
+                            thissize = sel_delta;
+
+                        XChangeProperty(disp,
+                                        incrs[i].window, incrs[i].property,
+                                        incrs[i].type, incrs[i].format,
+                                        PropModeReplace, incrs[i].data,
+                                        thissize / (incrs[i].format/8));
+
+                        if (thissize == 0) {
+                            /*
+                             * If we've just sent a zero-length block,
+                             * the incremental transfer is over and we
+                             * should delete this entry.
+                             */
+                            keep = False;
+                        }
+
+                        incrs[i].data += thissize;
+                        incrs[i].size -= thissize;
+                    }
+                    if (keep) {
+                        if (j != i)
+                            incrs[j] = incrs[i];
+                        j++;
+                    }
+                }
+                nincrs = j;
+                break;
             }
+            if (nincrs == 0 && !have_ownership)
+                return;
         }
     }
 }
@@ -555,13 +691,13 @@ void done_X(void) {
 void do_paste(Window window, Atom property, int cutbuffer) {
     Atom actual_type;
     int actual_format, i;
-    long nitems, bytes_after, nread;
+    unsigned long nitems, bytes_after, nread;
     unsigned char *data;
     int incremental = False;
     XEvent ev;
 
     nread = 0;
-    while (XGetWindowProperty(disp, window, property, nread / 4, SELDELTA,
+    while (XGetWindowProperty(disp, window, property, nread / 4, sel_delta / 4,
                               !cutbuffer, AnyPropertyType, &actual_type,
                               &actual_format, &nitems, &bytes_after,
                               (unsigned char **) &data) == Success) {