workbench/c/ConClip.c

   1 /*
   2     Copyright © 1995-2018, 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.2 (27.5.2018)\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                             memset( &replyport, 0, sizeof( replyport ) );
 219                             replyport.mp_Node.ln_Type   = NT_MSGPORT;
 220                             replyport.mp_Flags          = PA_SIGNAL;
 221                             replyport.mp_SigBit         = SIGB_SINGLE;
 222                             replyport.mp_SigTask        = FindTask(NULL);
 223                             NewList(&replyport.mp_MsgList);
 224
 225                             msg.msg.mn_Node.ln_Type     = NT_MESSAGE;
 226                             msg.msg.mn_ReplyPort        = &replyport;
 227                             msg.msg.mn_Length           = sizeof(msg);
 228
 229                             msg.code = ToUpper(sgw->Code);
 230                             msg.sgw  = sgw;
 231
 232                             if ((msg.code == CODE_COPY) || (sgw->NumChars < sgw->StringInfo->MaxChars - 1))
 233                             {
 234                                 SetSignal(0, SIGF_SINGLE);
 235                                 PutMsg(port, &msg.msg);
 236                                 WaitPort(&replyport);
 237                             }
 238
 239                             if (msg.code == CODE_PASTE)
 240                             {
 241                                 WORD len = strlen(sgw->WorkBuffer);
 242
 243                                 if (len != sgw->NumChars)
 244                                 {
 245                                     sgw->NumChars = len;
 246                                     sgw->EditOp   = EO_BIGCHANGE;
 247                                     sgw->Actions  = SGA_USE | SGA_REDISPLAY;
 248
 249                                     retcode = 1;
 250                                 }
 251
 252                             } /* if (msg.code == CODE_COPY) */
 253
 254                         } /* if ((port = FindPort(CONCLIP_PORTNAME))) */
 255
 256                         break;
 257
 258                 } /* switch(ToUpper(sgw->Code)) */
 259
 260             } /* if (sgw->IEvent->ie_Qualifier & IEQUALIFIER_RCOMMAND) */
 261             break;
 262
 263     } /* switch (*command) */
 264
 265     if (calloldhook) retcode = CallHookPkt(oldedithook, sgw, command);
 266
 267     return retcode;
 268
 269     AROS_USERFUNC_EXIT
 270 }
 271
 272 /*****************************************************************************************/
 273
 274 static void installedithook(void)
 275 {
 276     edithook.h_Entry = (HOOKFUNC)AROS_ASMSYMNAME(conclipeditfunc);
 277     edithook.h_SubEntry = NULL;
 278     edithook.h_Data = NULL;
 279
 280     oldedithook = SetEditHook(&edithook);
 281 }
 282
 283 /*****************************************************************************************/
 284 /*****************************************************************************************/
 285 /*****************************************************************************************/
 286
 287 static void savetoclipboard(struct SGWork *sgw)
 288 {
 289     struct IFFHandle *iff;
 290
 291     if((iff = AllocIFF()))
 292     {
 293         if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit)))
 294         {
 295             InitIFFasClip(iff);
 296             if(!OpenIFF(iff,IFFF_WRITE))
 297             {
 298                 if(!PushChunk(iff, ID_FTXT, ID_FORM, IFFSIZE_UNKNOWN))
 299                 {
 300                     if(!PushChunk(iff, ID_FTXT, ID_CHRS, IFFSIZE_UNKNOWN))
 301                     {
 302                         WriteChunkBytes(iff, sgw->WorkBuffer, sgw->NumChars);
 303
 304                         PopChunk(iff);
 305
 306                     } /* if(!PushChunk(iff, ID_FTXT, ID_CHRS, IFFSIZE_UNKNOWN)) */
 307                     PopChunk(iff);
 308
 309                 } /* if(!PushChunk(iff, ID_FTXT, ID_FORM, IFFSIZE_UNKNOWN)) */
 310                 CloseIFF(iff);
 311
 312             } /* if(!OpenIFF(iff,IFFF_WRITE)) */
 313             CloseClipboard((struct ClipboardHandle*)iff->iff_Stream);
 314
 315         } /* if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit))) */
 316         FreeIFF(iff);
 317
 318     } /* if((iff = AllocIFF()))) */
 319 }
 320
 321 /*****************************************************************************************/
 322
 323 static void readfromclipboard(struct SGWork *sgw)
 324 {
 325     struct IFFHandle    *iff;
 326     struct ContextNode  *cn;
 327
 328     if((iff = AllocIFF()))
 329     {
 330         D(bug("ConClip/conclipeditfunc: AllocIFF okay\n"));
 331
 332         if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit)))
 333         {
 334             D(bug("ConClip/conclipeditfunc: OpenClipboard okay\n"));
 335
 336             InitIFFasClip(iff);
 337             if(!OpenIFF(iff, IFFF_READ))
 338             {
 339                 D(bug("ConClip/conclipeditfunc: OpenIff okay\n"));
 340
 341                 if (!(StopChunk(iff, ID_FTXT, ID_CHRS)))
 342                 {
 343                     D(bug("ConClip/conclipeditfunc: StopChunk okay\n"));
 344
 345                     if (!ParseIFF(iff, IFFPARSE_SCAN))
 346                     {
 347                         D(bug("ConClip/conclipeditfunc: ParseIFF okay\n"));
 348
 349                         cn = CurrentChunk(iff);
 350                         if ((cn->cn_Type == ID_FTXT) && (cn->cn_ID == ID_CHRS) && (cn->cn_Size > 0))
 351                         {
 352                             WORD readsize;
 353
 354                             D(bug("ConClip: readfromclipboard: Found FTXT CHRS Chunk\n"));
 355                             D(bug("ConClip: readfromclipboard: Old text = \"%s\"\n", sgw->WorkBuffer));
 356
 357                             readsize = sgw->StringInfo->MaxChars - 1 - sgw->BufferPos;
 358                             if (cn->cn_Size < readsize) readsize = cn->cn_Size;
 359                             if (readsize > 0)
 360                             {
 361                                 memmove(sgw->WorkBuffer + sgw->BufferPos + readsize,
 362                                         sgw->WorkBuffer + sgw->BufferPos,
 363                                         sgw->StringInfo->MaxChars - sgw->BufferPos - readsize);
 364                                 ReadChunkBytes(iff, sgw->WorkBuffer + sgw->BufferPos, readsize);
 365
 366                                 D(bug("ConClip: readfromclipboard: New text = \"%s\"\n", sgw->WorkBuffer));
 367
 368                                 sgw->BufferPos += readsize;
 369                             }
 370
 371                         } /* if ((cn->cn_Type == ID_FTXT) && (cn->cn_ID == ID_CHRS) && (cn->cn_Size > 0)) */
 372
 373                     } /* if (!ParseIFF(iff, IFFPARSE_SCAN)) */
 374
 375                 } /* if (!(StopChunk(iff, ID_FTXT, ID_CHRS))) */
 376
 377                 CloseIFF(iff);
 378
 379             } /* if(!OpenIFF(iff, IFFF_READ)) */
 380             CloseClipboard((struct ClipboardHandle*)iff->iff_Stream);
 381
 382         } /* if((iff->iff_Stream = (IPTR)OpenClipboard(clipunit))) */
 383         FreeIFF(iff);
 384
 385     } /* if((iff = AllocIFF()))) */
 386 }
 387
 388 /*****************************************************************************************/
 389
 390 static void handleall(void)
 391 {
 392     BOOL quitme = FALSE;
 393     ULONG sigs;
 394
 395     while(!quitme)
 396     {
 397         sigs = Wait(SIGBREAKF_CTRL_C | portmask);
 398
 399         if (sigs & portmask)
 400         {
 401             struct MyEditHookMsg *msg;
 402
 403             while((msg = (struct MyEditHookMsg *)GetMsg(progport)))
 404             {
 405                 switch(msg->code)
 406                 {
 407                     case CODE_COPY:
 408                         D(bug("ConClip: Received CODE_COPY message\n"));
 409                         savetoclipboard(msg->sgw);
 410                         break;
 411
 412                     case CODE_PASTE:
 413                         D(bug("ConClip: Received CODE_PASTE message\n"));
 414                         readfromclipboard(msg->sgw);
 415                         break;
 416
 417                 } /* switch(msg->code) */
 418
 419                 ReplyMsg(&msg->msg);
 420
 421             } /* while((msg = (struct MyEditHookMsg *)GetMsg(progport))) */
 422
 423         } /* if (sigs & portmask) */
 424
 425         if (sigs & SIGBREAKF_CTRL_C) quitme = TRUE;
 426
 427     } /* while(!quitme) */
 428 }
 429
 430 /*****************************************************************************************/
 431
 432 int main(void)
 433 {
 434     init();
 435
 436     if (!getarguments())
 437         return 0;
 438     if (!checkport())
 439         return 0;
 440
 441     installedithook();
 442     handleall();
 443
 444     cleanup(NULL);
 445     return 0;
 446 }
 447
 448 /*****************************************************************************************/