workbench/c/ConClip.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Conclip CLI command
   6     Lang: English
   7 */
   8 /******************************************************************************
   9
  10     NAME
  11
  12         Conclip
  13
  14 USAGE
  15
  16         CONCLIP [ [UNIT | CLIPUNIT] <unitnumber>] [OFF]
  17
  18     SYNOPSIS
  19
  20         CLIPUNIT=UNIT/N, ON/S, OFF/S
  21
  22     LOCATION
  23
  24         Sys:C
  25
  26     FUNCTION
  27
  28           Enable clipboard cut/copy/paste functionality in console windows
  29       and string gadgets. This enables the use of a system global clipboard.
  30
  31     INPUTS
  32
  33         CLIPUNIT=UNIT -- the number associated to the clipboard exchange unit
  34         ON/S    --  Activates conclip (default unit will be set to 1)
  35         OFF/S   --  Deactivates Conclip
  36
  37     RESULT
  38
  39     NOTES
  40
  41     EXAMPLE
  42
  43         Conclip CLIPUNIT=1
  44
  45         This will set the global clipboard unit to 1. The available clipboards
  46         can be checked in clips: dirDir Clips:
  47
  48     BUGS
  49
  50     SEE ALSO
  51
  52     INTERNALS
  53
  54     HISTORY
  55
  56 ******************************************************************************//*****************************************************************************************/
  57
  58 #include <aros/asmcall.h>
  59 #include <dos/dos.h>
  60 #include <intuition/intuition.h>
  61 #include <intuition/sghooks.h>
  62 #include <intuition/classusr.h>
  63 #include <libraries/iffparse.h>
  64 #include <devices/inputevent.h>
  65 #include <datatypes/textclass.h>
  66 #include <utility/hooks.h>
  67 #include <proto/exec.h>
  68 #include <proto/dos.h>
  69 #include <proto/intuition.h>
  70 #include <proto/iffparse.h>
  71 #include <proto/alib.h>
  72 #include <proto/utility.h>
  73
  74 #include <string.h>
  75 #include <stdlib.h>
  76
  77
  78 #undef DEBUG
  79 #define DEBUG 0
  80 #include <aros/debug.h>
  81
  82 /*****************************************************************************************/
  83
  84 #define ARG_TEMPLATE    "CLIPUNIT=UNIT/N,OFF/S"
  85 #define ARG_CLIPUNIT    0
  86 #define ARG_OFF         1
  87 #define NUM_ARGS        2
  88
  89 /*****************************************************************************************/
  90
  91 #define CODE_COPY       'C'
  92 #define CODE_PASTE      'V'
  93
  94 struct MyEditHookMsg
  95 {
  96     struct Message      msg;
  97     struct SGWork       *sgw;
  98     WORD                code;
  99 };
 100
 101 /*****************************************************************************************/
 102
 103 const STRPTR CONCLIP_TASKNAME = "« ConClip »";
 104 const STRPTR CONCLIP_PORTNAME = "ConClip.rendezvous";
 105
 106 /*****************************************************************************************/
 107
 108 static struct MsgPort   *progport;
 109 static struct Hook      edithook, *oldedithook;
 110 static struct Task      *progtask;
 111 static ULONG            clipunit, portmask;
 112 static BOOL             off;
 113 static UBYTE            s[256];
 114
 115 /*****************************************************************************************/
 116
 117 static void cleanup(STRPTR msg)
 118 {
 119     if (msg) Printf("ConClip: %s\n", msg);
 120
 121     if (oldedithook) SetEditHook(oldedithook);
 122     if (progport) DeletePort(progport);
 123
 124     exit(0);
 125 }
 126
 127 /*****************************************************************************************/
 128
 129 static void init(void)
 130 {
 131     progtask = FindTask(NULL);
 132     ((struct Process *)progtask)->pr_WindowPtr = (APTR)-1;
 133 }
 134
 135 /*****************************************************************************************/
 136
 137 static void getarguments(void)
 138 {
 139     struct RDArgs       *myargs;
 140     IPTR                args[NUM_ARGS] = {0, 0};
 141
 142     if (!(myargs = ReadArgs(ARG_TEMPLATE, args, NULL)))
 143     {
 144         Fault(IoErr(), 0, s, 255);
 145         cleanup(s);
 146     }
 147
 148     if (args[ARG_CLIPUNIT]) clipunit = (ULONG)(*(IPTR *)args[ARG_CLIPUNIT]);
 149     if (args[ARG_OFF]) off = args[ARG_OFF] ? TRUE : FALSE;
 150
 151     FreeArgs(myargs);
 152 }
 153
 154 /*****************************************************************************************/
 155
 156 static void checkport(void)
 157 {
 158     Forbid();
 159     progport = FindPort(CONCLIP_PORTNAME);
 160     if (progport)
 161     {
 162         if (off) Signal(progport->mp_SigTask, SIGBREAKF_CTRL_C);
 163         Permit();
 164         progport = NULL;
 165         cleanup(NULL);
 166     }
 167     progport = CreatePort(CONCLIP_PORTNAME, 1);
 168     Permit();
 169
 170     if (!progport) cleanup("Could not create MsgPort!");
 171
 172     portmask = 1L << progport->mp_SigBit;
 173 }
 174
 175 /*****************************************************************************************/
 176
 177 AROS_UFH3(ULONG, conclipeditfunc,
 178     AROS_UFHA(struct Hook *,            hook,           A0),
 179     AROS_UFHA(struct SGWork *,          sgw,            A2),
 180     AROS_UFHA(ULONG *,                  command,        A1)
 181 )
 182 {
 183     AROS_USERFUNC_INIT
 184
 185     struct MsgPort       *port, replyport;
 186     struct MyEditHookMsg msg;
 187     BOOL                 calloldhook = TRUE;
 188     ULONG                retcode = 0;
 189
 190     switch (*command)
 191     {
 192         case SGH_KEY:
 193             D(bug("ConClip/conclipeditfunc: is SGH_KEY\n"));
 194
 195             if (sgw->IEvent->ie_Qualifier & IEQUALIFIER_RCOMMAND)
 196             {
 197                 D(bug("ConClip/conclipeditfunc: qualifier RCOMMAND okay\n"));
 198
 199                 switch(ToUpper(sgw->Code))
 200                 {
 201                     case 'C':
 202                         if (!sgw->NumChars) break;
 203                         /* fall through */
 204
 205                     case 'V':
 206                         D(bug("ConClip/conclipeditfunc: key = %c\n", toupper(sgw->Code)));
 207
 208                         if ((port = FindPort(CONCLIP_PORTNAME)))
 209                         {
 210                             calloldhook = FALSE;
 211
 212                             replyport.mp_Node.ln_Type   = NT_MSGPORT;
 213                             replyport.mp_Node.ln_Name   = NULL;
 214                             replyport.mp_Node.ln_Pri    = 0;
 215                             replyport.mp_Flags          = PA_SIGNAL;
 216                             replyport.mp_SigBit         = SIGB_SINGLE;
 217                             replyport.mp_SigTask        = FindTask(NULL);
 218                             NewList(&replyport.mp_MsgList);
 219
 220                             msg.msg.mn_Node.ln_Type     = NT_MESSAGE;
 221                             msg.msg.mn_ReplyPort        = &replyport;
 222                             msg.msg.mn_Length           = sizeof(msg);
 223
 224                             msg.code = ToUpper(sgw->Code);
 225                             msg.sgw  = sgw;
 226
 227                             if ((msg.code == CODE_COPY) || (sgw->NumChars < sgw->StringInfo->MaxChars - 1))
 228                             {
 229                                 SetSignal(0, SIGF_SINGLE);
 230                                 PutMsg(port, &msg.msg);
 231                                 WaitPort(&replyport);
 232                             }
 233
 234                             if (msg.code == CODE_PASTE)
 235                             {
 236                                 WORD len = strlen(sgw->WorkBuffer);
 237
 238                                 if (len != sgw->NumChars)
 239                                 {
 240                                     sgw->NumChars = len;
 241                                     sgw->EditOp   = EO_BIGCHANGE;
 242                                     sgw->Actions  = SGA_USE | SGA_REDISPLAY;
 243
 244                                     retcode = 1;
 245                                 }
 246
 247                             } /* if (msg.code == CODE_COPY) */
 248
 249                         } /* if ((port = FindPort(CONCLIP_PORTNAME))) */
 250
 251                         break;
 252
 253                 } /* switch(ToUpper(sgw->Code)) */
 254
 255             } /* if (sgw->IEvent->ie_Qualifier & IEQUALIFIER_RCOMMAND) */
 256             break;
 257
 258     } /* switch (*command) */
 259
 260     if (calloldhook) retcode = CallHookPkt(oldedithook, sgw, command);
 261
 262     return retcode;
 263
 264     AROS_USERFUNC_EXIT
 265 }
 266
 267 /*****************************************************************************************/
 268
 269 static void installedithook(void)
 270 {
 271     edithook.h_Entry = (HOOKFUNC)AROS_ASMSYMNAME(conclipeditfunc);
 272     edithook.h_SubEntry = NULL;
 273     edithook.h_Data = NULL;
 274
 275     oldedithook = SetEditHook(&edithook);
 276 }
 277
 278 /*****************************************************************************************/
 279 /*****************************************************************************************/
 280 /*****************************************************************************************/
 281
 282 static void savetoclipboard(struct SGWork *sgw)
 283 {
 284     struct IFFHandle *iff;
 285
 286     if((iff = AllocIFF()))
 287     {
 288         if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit)))
 289         {
 290             InitIFFasClip(iff);
 291             if(!OpenIFF(iff,IFFF_WRITE))
 292             {
 293                 if(!PushChunk(iff, ID_FTXT, ID_FORM, IFFSIZE_UNKNOWN))
 294                 {
 295                     if(!PushChunk(iff, ID_FTXT, ID_CHRS, IFFSIZE_UNKNOWN))
 296                     {
 297                         WriteChunkBytes(iff, sgw->WorkBuffer, sgw->NumChars);
 298
 299                         PopChunk(iff);
 300
 301                     } /* if(!PushChunk(iff, ID_FTXT, ID_CHRS, IFFSIZE_UNKNOWN)) */
 302                     PopChunk(iff);
 303
 304                 } /* if(!PushChunk(iff, ID_FTXT, ID_FORM, IFFSIZE_UNKNOWN)) */
 305                 CloseIFF(iff);
 306
 307             } /* if(!OpenIFF(iff,IFFF_WRITE)) */
 308             CloseClipboard((struct ClipboardHandle*)iff->iff_Stream);
 309
 310         } /* if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit))) */
 311         FreeIFF(iff);
 312
 313     } /* if((iff = AllocIFF()))) */
 314 }
 315
 316 /*****************************************************************************************/
 317
 318 static void readfromclipboard(struct SGWork *sgw)
 319 {
 320     struct IFFHandle    *iff;
 321     struct ContextNode  *cn;
 322
 323     if((iff = AllocIFF()))
 324     {
 325         D(bug("ConClip/conclipeditfunc: AllocIFF okay\n"));
 326
 327         if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit)))
 328         {
 329             D(bug("ConClip/conclipeditfunc: OpenClipboard okay\n"));
 330
 331             InitIFFasClip(iff);
 332             if(!OpenIFF(iff, IFFF_READ))
 333             {
 334                 D(bug("ConClip/conclipeditfunc: OpenIff okay\n"));
 335
 336                 if (!(StopChunk(iff, ID_FTXT, ID_CHRS)))
 337                 {
 338                     D(bug("ConClip/conclipeditfunc: StopChunk okay\n"));
 339
 340                     if (!ParseIFF(iff, IFFPARSE_SCAN))
 341                     {
 342                         D(bug("ConClip/conclipeditfunc: ParseIFF okay\n"));
 343
 344                         cn = CurrentChunk(iff);
 345                         if ((cn->cn_Type == ID_FTXT) && (cn->cn_ID == ID_CHRS) && (cn->cn_Size > 0))
 346                         {
 347                             WORD readsize;
 348
 349                             D(bug("ConClip: readfromclipboard: Found FTXT CHRS Chunk\n"));
 350                             D(bug("ConClip: readfromclipboard: Old text = \"%s\"\n", sgw->WorkBuffer));
 351
 352                             readsize = sgw->StringInfo->MaxChars - 1 - sgw->BufferPos;
 353                             if (cn->cn_Size < readsize) readsize = cn->cn_Size;
 354                             if (readsize > 0)
 355                             {
 356                                 memmove(sgw->WorkBuffer + sgw->BufferPos + readsize,
 357                                         sgw->WorkBuffer + sgw->BufferPos,
 358                                         sgw->StringInfo->MaxChars - sgw->BufferPos - readsize);
 359                                 ReadChunkBytes(iff, sgw->WorkBuffer + sgw->BufferPos, readsize);
 360
 361                                 D(bug("ConClip: readfromclipboard: New text = \"%s\"\n", sgw->WorkBuffer));
 362
 363                                 sgw->BufferPos += readsize;
 364                             }
 365
 366                         } /* if ((cn->cn_Type == ID_FTXT) && (cn->cn_ID == ID_CHRS) && (cn->cn_Size > 0)) */
 367
 368                     } /* if (!ParseIFF(iff, IFFPARSE_SCAN)) */
 369
 370                 } /* if (!(StopChunk(iff, ID_FTXT, ID_CHRS))) */
 371
 372                 CloseIFF(iff);
 373
 374             } /* if(!OpenIFF(iff, IFFF_READ)) */
 375             CloseClipboard((struct ClipboardHandle*)iff->iff_Stream);
 376
 377         } /* if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit))) */
 378         FreeIFF(iff);
 379
 380     } /* if((iff = AllocIFF()))) */
 381 }
 382
 383 /*****************************************************************************************/
 384
 385 static void handleall(void)
 386 {
 387     BOOL quitme = FALSE;
 388     ULONG sigs;
 389
 390     while(!quitme)
 391     {
 392         sigs = Wait(SIGBREAKF_CTRL_C | portmask);
 393
 394         if (sigs & portmask)
 395         {
 396             struct MyEditHookMsg *msg;
 397
 398             while((msg = (struct MyEditHookMsg *)GetMsg(progport)))
 399             {
 400                 switch(msg->code)
 401                 {
 402                     case CODE_COPY:
 403                         D(bug("ConClip: Received CODE_COPY message\n"));
 404                         savetoclipboard(msg->sgw);
 405                         break;
 406
 407                     case CODE_PASTE:
 408                         D(bug("ConClip: Received CODE_PASTE message\n"));
 409                         readfromclipboard(msg->sgw);
 410                         break;
 411
 412                 } /* switch(msg->code) */
 413
 414                 ReplyMsg(&msg->msg);
 415
 416             } /* while((msg = (struct MyEditHookMsg *)GetMsg(progport))) */
 417
 418         } /* if (sigs & portmask) */
 419
 420         if (sigs & SIGBREAKF_CTRL_C) quitme = TRUE;
 421
 422     } /* while(!quitme) */
 423 }
 424
 425 /*****************************************************************************************/
 426
 427 int main(void)
 428 {
 429     init();
 430     getarguments();
 431     checkport();
 432     installedithook();
 433     handleall();
 434     cleanup(NULL);
 435     return 0;
 436 }
 437
 438 /*****************************************************************************************/