workbench/c/ConClip.c

   1 /*
   2     Copyright © 1995-2011, 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     FORMAT
  15
  16         CONCLIP [ [UNIT | CLIPUNIT] <unitnumber>] [OFF]
  17
  18     SYNOPSIS
  19
  20         CLIPUNIT=UNIT/N, ON/S, OFF/S
  21
  22     LOCATION
  23
  24         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
  76 #undef DEBUG
  77 #define DEBUG 0
  78 #include <aros/debug.h>
  79
  80 /*****************************************************************************************/
  81
  82 #define ARG_TEMPLATE    "CLIPUNIT=UNIT/N,OFF/S"
  83 #define ARG_CLIPUNIT    0
  84 #define ARG_OFF         1
  85 #define NUM_ARGS        2
  86
  87 /*****************************************************************************************/
  88
  89 #define CODE_COPY       'C'
  90 #define CODE_PASTE      'V'
  91
  92 const TEXT version[] = "$VER: Conclip 42.1 (19.2.2015)\n";
  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
 125 /*****************************************************************************************/
 126
 127 static void init(void)
 128 {
 129     progtask = FindTask(NULL);
 130     ((struct Process *)progtask)->pr_WindowPtr = (APTR)-1;
 131 }
 132
 133 /*****************************************************************************************/
 134
 135 static BOOL getarguments(void)
 136 {
 137     struct RDArgs       *myargs;
 138     IPTR                args[NUM_ARGS] = {0, 0};
 139
 140     if (!(myargs = ReadArgs(ARG_TEMPLATE, args, NULL)))
 141     {
 142         Fault(IoErr(), 0, s, 255);
 143         cleanup(s);
 144         return FALSE;
 145     }
 146
 147     if (args[ARG_CLIPUNIT]) clipunit = (ULONG)(*(IPTR *)args[ARG_CLIPUNIT]);
 148     if (args[ARG_OFF]) off = args[ARG_OFF] ? TRUE : FALSE;
 149
 150     FreeArgs(myargs);
 151     return TRUE;
 152 }
 153
 154 /*****************************************************************************************/
 155
 156 static BOOL 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         return FALSE;
 167     }
 168     progport = CreatePort(CONCLIP_PORTNAME, 1);
 169     Permit();
 170
 171     if (!progport)
 172     {
 173         cleanup("Could not create MsgPort!");
 174         return FALSE;
 175     }
 176
 177     portmask = 1L << progport->mp_SigBit;
 178     return TRUE;
 179 }
 180
 181 /*****************************************************************************************/
 182
 183 AROS_UFH3(ULONG, conclipeditfunc,
 184     AROS_UFHA(struct Hook *,            hook,           A0),
 185     AROS_UFHA(struct SGWork *,          sgw,            A2),
 186     AROS_UFHA(ULONG *,                  command,        A1)
 187 )
 188 {
 189     AROS_USERFUNC_INIT
 190
 191     struct MsgPort       *port, replyport;
 192     struct MyEditHookMsg msg;
 193     BOOL                 calloldhook = TRUE;
 194     ULONG                retcode = 0;
 195
 196     switch (*command)
 197     {
 198         case SGH_KEY:
 199             D(bug("ConClip/conclipeditfunc: is SGH_KEY\n"));
 200
 201             if (sgw->IEvent->ie_Qualifier & IEQUALIFIER_RCOMMAND)
 202             {
 203                 D(bug("ConClip/conclipeditfunc: qualifier RCOMMAND okay\n"));
 204
 205                 switch(ToUpper(sgw->Code))
 206                 {
 207                     case 'C':
 208                         if (!sgw->NumChars) break;
 209                         /* fall through */
 210
 211                     case 'V':
 212                         D(bug("ConClip/conclipeditfunc: key = %c\n", toupper(sgw->Code)));
 213
 214                         if ((port = FindPort(CONCLIP_PORTNAME)))
 215                         {
 216                             calloldhook = FALSE;
 217
 218                             replyport.mp_Node.ln_Type   = NT_MSGPORT;
 219                             replyport.mp_Node.ln_Name   = NULL;
 220                             replyport.mp_Node.ln_Pri    = 0;
 221                             replyport.mp_Flags          = PA_SIGNAL;
 222                             replyport.mp_SigBit         = SIGB_SINGLE;
 223                             replyport.mp_SigTask        = FindTask(NULL);
 224                             NewList(&replyport.mp_MsgList);
 225
 226                             msg.msg.mn_Node.ln_Type     = NT_MESSAGE;
 227                             msg.msg.mn_ReplyPort        = &replyport;
 228                             msg.msg.mn_Length           = sizeof(msg);
 229
 230                             msg.code = ToUpper(sgw->Code);
 231                             msg.sgw  = sgw;
 232
 233                             if ((msg.code == CODE_COPY) || (sgw->NumChars < sgw->StringInfo->MaxChars - 1))
 234                             {
 235                                 SetSignal(0, SIGF_SINGLE);
 236                                 PutMsg(port, &msg.msg);
 237                                 WaitPort(&replyport);
 238                             }
 239
 240                             if (msg.code == CODE_PASTE)
 241                             {
 242                                 WORD len = strlen(sgw->WorkBuffer);
 243
 244                                 if (len != sgw->NumChars)
 245                                 {
 246                                     sgw->NumChars = len;
 247                                     sgw->EditOp   = EO_BIGCHANGE;
 248                                     sgw->Actions  = SGA_USE | SGA_REDISPLAY;
 249
 250                                     retcode = 1;
 251                                 }
 252
 253                             } /* if (msg.code == CODE_COPY) */
 254
 255                         } /* if ((port = FindPort(CONCLIP_PORTNAME))) */
 256
 257                         break;
 258
 259                 } /* switch(ToUpper(sgw->Code)) */
 260
 261             } /* if (sgw->IEvent->ie_Qualifier & IEQUALIFIER_RCOMMAND) */
 262             break;
 263
 264     } /* switch (*command) */
 265
 266     if (calloldhook) retcode = CallHookPkt(oldedithook, sgw, command);
 267
 268     return retcode;
 269
 270     AROS_USERFUNC_EXIT
 271 }
 272
 273 /*****************************************************************************************/
 274
 275 static void installedithook(void)
 276 {
 277     edithook.h_Entry = (HOOKFUNC)AROS_ASMSYMNAME(conclipeditfunc);
 278     edithook.h_SubEntry = NULL;
 279     edithook.h_Data = NULL;
 280
 281     oldedithook = SetEditHook(&edithook);
 282 }
 283
 284 /*****************************************************************************************/
 285 /*****************************************************************************************/
 286 /*****************************************************************************************/
 287
 288 static void savetoclipboard(struct SGWork *sgw)
 289 {
 290     struct IFFHandle *iff;
 291
 292     if((iff = AllocIFF()))
 293     {
 294         if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit)))
 295         {
 296             InitIFFasClip(iff);
 297             if(!OpenIFF(iff,IFFF_WRITE))
 298             {
 299                 if(!PushChunk(iff, ID_FTXT, ID_FORM, IFFSIZE_UNKNOWN))
 300                 {
 301                     if(!PushChunk(iff, ID_FTXT, ID_CHRS, IFFSIZE_UNKNOWN))
 302                     {
 303                         WriteChunkBytes(iff, sgw->WorkBuffer, sgw->NumChars);
 304
 305                         PopChunk(iff);
 306
 307                     } /* if(!PushChunk(iff, ID_FTXT, ID_CHRS, IFFSIZE_UNKNOWN)) */
 308                     PopChunk(iff);
 309
 310                 } /* if(!PushChunk(iff, ID_FTXT, ID_FORM, IFFSIZE_UNKNOWN)) */
 311                 CloseIFF(iff);
 312
 313             } /* if(!OpenIFF(iff,IFFF_WRITE)) */
 314             CloseClipboard((struct ClipboardHandle*)iff->iff_Stream);
 315
 316         } /* if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit))) */
 317         FreeIFF(iff);
 318
 319     } /* if((iff = AllocIFF()))) */
 320 }
 321
 322 /*****************************************************************************************/
 323
 324 static void readfromclipboard(struct SGWork *sgw)
 325 {
 326     struct IFFHandle    *iff;
 327     struct ContextNode  *cn;
 328
 329     if((iff = AllocIFF()))
 330     {
 331         D(bug("ConClip/conclipeditfunc: AllocIFF okay\n"));
 332
 333         if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit)))
 334         {
 335             D(bug("ConClip/conclipeditfunc: OpenClipboard okay\n"));
 336
 337             InitIFFasClip(iff);
 338             if(!OpenIFF(iff, IFFF_READ))
 339             {
 340                 D(bug("ConClip/conclipeditfunc: OpenIff okay\n"));
 341
 342                 if (!(StopChunk(iff, ID_FTXT, ID_CHRS)))
 343                 {
 344                     D(bug("ConClip/conclipeditfunc: StopChunk okay\n"));
 345
 346                     if (!ParseIFF(iff, IFFPARSE_SCAN))
 347                     {
 348                         D(bug("ConClip/conclipeditfunc: ParseIFF okay\n"));
 349
 350                         cn = CurrentChunk(iff);
 351                         if ((cn->cn_Type == ID_FTXT) && (cn->cn_ID == ID_CHRS) && (cn->cn_Size > 0))
 352                         {
 353                             WORD readsize;
 354
 355                             D(bug("ConClip: readfromclipboard: Found FTXT CHRS Chunk\n"));
 356                             D(bug("ConClip: readfromclipboard: Old text = \"%s\"\n", sgw->WorkBuffer));
 357
 358                             readsize = sgw->StringInfo->MaxChars - 1 - sgw->BufferPos;
 359                             if (cn->cn_Size < readsize) readsize = cn->cn_Size;
 360                             if (readsize > 0)
 361                             {
 362                                 memmove(sgw->WorkBuffer + sgw->BufferPos + readsize,
 363                                         sgw->WorkBuffer + sgw->BufferPos,
 364                                         sgw->StringInfo->MaxChars - sgw->BufferPos - readsize);
 365                                 ReadChunkBytes(iff, sgw->WorkBuffer + sgw->BufferPos, readsize);
 366
 367                                 D(bug("ConClip: readfromclipboard: New text = \"%s\"\n", sgw->WorkBuffer));
 368
 369                                 sgw->BufferPos += readsize;
 370                             }
 371
 372                         } /* if ((cn->cn_Type == ID_FTXT) && (cn->cn_ID == ID_CHRS) && (cn->cn_Size > 0)) */
 373
 374                     } /* if (!ParseIFF(iff, IFFPARSE_SCAN)) */
 375
 376                 } /* if (!(StopChunk(iff, ID_FTXT, ID_CHRS))) */
 377
 378                 CloseIFF(iff);
 379
 380             } /* if(!OpenIFF(iff, IFFF_READ)) */
 381             CloseClipboard((struct ClipboardHandle*)iff->iff_Stream);
 382
 383         } /* if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit))) */
 384         FreeIFF(iff);
 385
 386     } /* if((iff = AllocIFF()))) */
 387 }
 388
 389 /*****************************************************************************************/
 390
 391 static void handleall(void)
 392 {
 393     BOOL quitme = FALSE;
 394     ULONG sigs;
 395
 396     while(!quitme)
 397     {
 398         sigs = Wait(SIGBREAKF_CTRL_C | portmask);
 399
 400         if (sigs & portmask)
 401         {
 402             struct MyEditHookMsg *msg;
 403
 404             while((msg = (struct MyEditHookMsg *)GetMsg(progport)))
 405             {
 406                 switch(msg->code)
 407                 {
 408                     case CODE_COPY:
 409                         D(bug("ConClip: Received CODE_COPY message\n"));
 410                         savetoclipboard(msg->sgw);
 411                         break;
 412
 413                     case CODE_PASTE:
 414                         D(bug("ConClip: Received CODE_PASTE message\n"));
 415                         readfromclipboard(msg->sgw);
 416                         break;
 417
 418                 } /* switch(msg->code) */
 419
 420                 ReplyMsg(&msg->msg);
 421
 422             } /* while((msg = (struct MyEditHookMsg *)GetMsg(progport))) */
 423
 424         } /* if (sigs & portmask) */
 425
 426         if (sigs & SIGBREAKF_CTRL_C) quitme = TRUE;
 427
 428     } /* while(!quitme) */
 429 }
 430
 431 /*****************************************************************************************/
 432
 433 int main(void)
 434 {
 435     init();
 436
 437     if (!getarguments())
 438         return 0;
 439     if (!checkport())
 440         return 0;
 441
 442     installedithook();
 443     handleall();
 444
 445     cleanup(NULL);
 446     return 0;
 447 }
 448
 449 /*****************************************************************************************/