workbench/tools/commodities/AutoPoint.c

   1 /*
   2     Copyright © 1995-2003, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     AutoPoint commodity -- activates the window under the mouse pointer.
   6 */
   7
   8 /******************************************************************************
   9
  10     NAME
  11
  12         AutoPoint
  13
  14     SYNOPSIS
  15
  16         CX_PRIORITY/N/K, LAG/S
  17
  18     LOCATION
  19
  20         SYS:Tools/Commodities
  21
  22     FUNCTION
  23
  24         Automatically activates the window under the mouse pointer.
  25
  26     INPUTS
  27
  28         CX_PRIORITY  --  The priority of the commodity
  29
  30         LAG  --  Wait for the next timer event to activate the window
  31
  32         MIDMOUSEPREVENTSACTIVATION  --  Don't activate the window under the
  33                                         mouse if middle mouse button is pressed
  34
  35     RESULT
  36
  37     NOTES
  38
  39     EXAMPLE
  40
  41     BUGS
  42
  43     SEE ALSO
  44
  45     INTERNALS
  46
  47     HISTORY
  48
  49     05.03.2000  SDuvan   implemented
  50
  51 ******************************************************************************/
  52
  53 #include <aros/symbolsets.h>
  54 #include <intuition/intuition.h>
  55 #include <intuition/intuitionbase.h>
  56 #include <libraries/commodities.h>
  57 #include <libraries/locale.h>
  58 #include <proto/exec.h>
  59 #include <proto/dos.h>
  60 #include <proto/intuition.h>
  61 #include <proto/layers.h>
  62 #include <proto/commodities.h>
  63 #include <proto/locale.h>
  64 #include <proto/alib.h>
  65
  66 #include <stdio.h>
  67 #include <string.h>
  68
  69 #define  DEBUG 0
  70 #include <aros/debug.h>
  71
  72 #define CATCOMP_ARRAY
  73 #include "strings.h"
  74
  75 #define CATALOG_NAME     "System/Tools/Commodities.catalog"
  76 #define CATALOG_VERSION  3
  77
  78
  79 /***************************************************************************/
  80
  81 UBYTE version[] = "\0$VER: AutoPoint 0.4 (17.10.2012)";
  82
  83 #define ARG_TEMPLATE "CX_PRIORITY=PRI/N/K,LAG/S,MIDMOUSEPREVENTSACTIVATION=MMPA/S"
  84
  85 #define ARG_PRI   0
  86 #define ARG_LAG   1
  87 #define ARG_MMPA  2
  88 #define NUM_ARGS  3
  89
  90
  91 static struct NewBroker nb =
  92 {
  93     NB_VERSION,
  94     NULL,
  95     NULL,
  96     NULL,
  97     NBU_NOTIFY | NBU_UNIQUE,
  98     0,
  99     0,
 100     NULL,
 101     0
 102 };
 103
 104
 105 typedef struct _APState
 106 {
 107     CxObj          *as_broker;
 108     struct MsgPort *as_msgPort;
 109 } APState;
 110
 111
 112 typedef struct AP
 113 {
 114     struct Window *ai_thisWindow;
 115     struct Window *ai_lastActivatedWindow;
 116     BOOL           ai_mouseHasMoved;
 117     BOOL           ai_leftButtonDown;
 118     BOOL           ai_rightButtonDown;
 119     BOOL           ai_middleButtonDown;
 120     BOOL           ai_midMousePreventsActivation;
 121 } AP;
 122
 123 static AP apInfo =
 124 {
 125     NULL,
 126     NULL,
 127     FALSE,
 128     FALSE,
 129     FALSE,
 130     FALSE,
 131     FALSE
 132 };
 133
 134
 135 static struct Catalog *catalog;
 136
 137 /************************************************************************************/
 138
 139 static void freeResources(APState *as);
 140 static BOOL initiate(int argc, char **argv, APState *as);
 141 static void autoActivateLag(CxMsg *msg, CxObj *co);
 142 static void autoActivate(CxMsg *msg, CxObj *co);
 143 static CONST_STRPTR _(ULONG id);
 144 static BOOL Locale_Initialize(VOID);
 145 static VOID Locale_Deinitialize(VOID);
 146 static void showSimpleMessage(CONST_STRPTR msgString);
 147
 148 /************************************************************************************/
 149
 150 static CONST_STRPTR _(ULONG id)
 151 {
 152     if (LocaleBase != NULL && catalog != NULL)
 153     {
 154         return GetCatalogStr(catalog, id, CatCompArray[id].cca_Str);
 155     }
 156     else
 157     {
 158         return CatCompArray[id].cca_Str;
 159     }
 160 }
 161
 162 /************************************************************************************/
 163
 164 static BOOL Locale_Initialize(VOID)
 165 {
 166     if (LocaleBase != NULL)
 167     {
 168         catalog = OpenCatalog
 169             (
 170              NULL, CATALOG_NAME, OC_Version, CATALOG_VERSION, TAG_DONE
 171             );
 172     }
 173     else
 174     {
 175         catalog = NULL;
 176     }
 177
 178     return TRUE;
 179 }
 180
 181 /************************************************************************************/
 182
 183 static VOID Locale_Deinitialize(VOID)
 184 {
 185     if(LocaleBase != NULL && catalog != NULL) CloseCatalog(catalog);
 186 }
 187
 188 /************************************************************************************/
 189
 190 static void showSimpleMessage(CONST_STRPTR msgString)
 191 {
 192     struct EasyStruct easyStruct;
 193
 194     easyStruct.es_StructSize    = sizeof(easyStruct);
 195     easyStruct.es_Flags         = 0;
 196     easyStruct.es_Title         = _(MSG_AUTOPOINT_CXNAME);
 197     easyStruct.es_TextFormat    = msgString;
 198     easyStruct.es_GadgetFormat  = _(MSG_OK);
 199
 200     if (IntuitionBase != NULL && !Cli() )
 201     {
 202         EasyRequestArgs(NULL, &easyStruct, NULL, NULL);
 203     }
 204     else
 205     {
 206         PutStr(msgString);
 207     }
 208 }
 209
 210 /************************************************************************************/
 211
 212 static BOOL initiate(int argc, char **argv, APState *as)
 213 {
 214     CxObj *customObj;
 215     void (*activateFunc)(CxMsg *msg, CxObj *co);
 216
 217     memset(as, 0, sizeof(APState));
 218
 219     activateFunc = autoActivate;
 220
 221     if (Cli() != NULL)
 222     {
 223         struct RDArgs *rda;
 224         IPTR          *args[] = { NULL, (IPTR)FALSE, (IPTR)FALSE };
 225
 226         rda = ReadArgs(ARG_TEMPLATE, (IPTR *)args, NULL);
 227
 228         if (rda != NULL)
 229         {
 230             if (args[ARG_PRI] != NULL)
 231             {
 232                 nb.nb_Pri = *args[ARG_PRI];
 233             }
 234             if (args[ARG_LAG])
 235             {
 236                 activateFunc = autoActivateLag;
 237             }
 238             if (args[ARG_MMPA])
 239             {
 240                 apInfo.ai_midMousePreventsActivation = TRUE;
 241             }
 242         }
 243         FreeArgs(rda);
 244     }
 245     else
 246     {
 247         UBYTE **array = ArgArrayInit(argc, (UBYTE **)argv);
 248
 249         nb.nb_Pri = ArgInt(array, "CX_PRIORITY", 0);
 250
 251         if (ArgString(array, "LAG", 0))
 252         {
 253             activateFunc = autoActivateLag;
 254         }
 255         if (ArgString(array, "MIDMOUSEPREVENTSACTIVATION", 0))
 256         {
 257             apInfo.ai_midMousePreventsActivation = TRUE;
 258         }
 259
 260         ArgArrayDone();
 261     }
 262
 263     nb.nb_Name = _(MSG_AUTOPOINT_CXNAME);
 264     nb.nb_Title = _(MSG_AUTOPOINT_CXTITLE);
 265     nb.nb_Descr = _(MSG_AUTOPOINT_CXDESCR);
 266
 267     as->as_msgPort = CreateMsgPort();
 268
 269     if (as->as_msgPort == NULL)
 270     {
 271         showSimpleMessage(_(MSG_CANT_CREATE_MSGPORT));
 272
 273         return FALSE;
 274     }
 275
 276     nb.nb_Port = as->as_msgPort;
 277
 278     as->as_broker = CxBroker(&nb, 0);
 279
 280     if (as->as_broker == NULL)
 281     {
 282         return FALSE;
 283     }
 284
 285     customObj = CxCustom(activateFunc, 0);
 286
 287     if (customObj == NULL)
 288     {
 289         showSimpleMessage(_(MSG_CANT_CREATE_CUSTOM));
 290
 291         return FALSE;
 292     }
 293
 294     AttachCxObj(as->as_broker, customObj);
 295     ActivateCxObj(as->as_broker, TRUE);
 296
 297     apInfo.ai_thisWindow = IntuitionBase->ActiveWindow;
 298
 299     return TRUE;
 300 }
 301
 302 /************************************************************************************/
 303
 304 static void freeResources(APState *as)
 305 {
 306     struct Message  *cxm;
 307
 308     if (CxBase != NULL)
 309     {
 310         if (as->as_broker != NULL)
 311         {
 312             DeleteCxObjAll(as->as_broker);
 313         }
 314     }
 315
 316     if (as->as_msgPort != NULL)
 317     {
 318         while ((cxm = GetMsg(as->as_msgPort)))
 319         {
 320             ReplyMsg(cxm);
 321         }
 322
 323         DeleteMsgPort(as->as_msgPort);
 324     }
 325 }
 326
 327 /************************************************************************************/
 328
 329 /* Our CxCustom() function that is invoked everytime an imputevent is
 330    routed to our broker */
 331 static void autoActivateLag(CxMsg *msg, CxObj *co)
 332 {
 333     struct InputEvent *ie = (struct InputEvent *)CxMsgData(msg);
 334
 335     if (ie->ie_Class == IECLASS_TIMER)
 336     {
 337         struct Screen *screen;
 338         struct Layer  *layer;
 339
 340         if (apInfo.ai_leftButtonDown  ||
 341             apInfo.ai_rightButtonDown ||
 342             apInfo.ai_middleButtonDown  )
 343             return;
 344
 345         if (IntuitionBase->ActiveWindow != NULL)
 346         {
 347             screen = IntuitionBase->ActiveWindow->WScreen;
 348         }
 349         else
 350         {
 351             screen = IntuitionBase->ActiveScreen;
 352         }
 353
 354         if (!screen)
 355             layer = NULL;
 356         else
 357         {
 358             LockLayerInfo(&screen->LayerInfo);
 359             layer = WhichLayer(&screen->LayerInfo, screen->MouseX, screen->MouseY);
 360             UnlockLayerInfo(&screen->LayerInfo);
 361         }
 362
 363         apInfo.ai_thisWindow = (layer != NULL) ?
 364             (struct Window *)layer->Window : NULL;
 365
 366         if (apInfo.ai_mouseHasMoved ||
 367                 (IntuitionBase->ActiveWindow == apInfo.ai_thisWindow) ||
 368                 (apInfo.ai_lastActivatedWindow == apInfo.ai_thisWindow))
 369         {
 370             apInfo.ai_mouseHasMoved = FALSE;
 371             return;
 372         }
 373
 374         /* Two timer events and mouse hasn't moved in between. */
 375
 376         apInfo.ai_mouseHasMoved = FALSE;
 377
 378         /* Should be possible to use ActivateWindow(NULL)? Else, we must
 379            hack... */
 380         if (apInfo.ai_thisWindow != NULL)
 381         {
 382             apInfo.ai_lastActivatedWindow = apInfo.ai_thisWindow;
 383             ActivateWindow(apInfo.ai_thisWindow);
 384         }
 385
 386         if (apInfo.ai_thisWindow != NULL)
 387         {
 388             D(bug("Activated window %s\n", apInfo.ai_thisWindow->Title));
 389         }
 390         else
 391         {
 392             D(bug("No window active. %s\n",
 393                         IntuitionBase->ActiveWindow->Title));
 394         }
 395
 396         return;
 397     }
 398
 399     if (ie->ie_Class == IECLASS_RAWMOUSE)
 400     {
 401         apInfo.ai_mouseHasMoved = FALSE;
 402         switch (ie->ie_Code)
 403         {
 404             case IECODE_NOBUTTON:
 405                 apInfo.ai_mouseHasMoved = TRUE;
 406                 break;
 407             case MIDDLEDOWN:
 408                 if (apInfo.ai_midMousePreventsActivation)
 409                     apInfo.ai_middleButtonDown = TRUE;
 410                 break;
 411             case SELECTDOWN:
 412                 apInfo.ai_leftButtonDown = TRUE;
 413                 break;
 414             case MENUDOWN:
 415                 apInfo.ai_rightButtonDown = TRUE;
 416                 break;
 417             case MIDDLEUP:
 418                 apInfo.ai_middleButtonDown = FALSE;
 419                 break;
 420             case SELECTUP:
 421                 apInfo.ai_leftButtonDown = FALSE;
 422                 break;
 423             case MENUUP:
 424                 apInfo.ai_rightButtonDown = FALSE;
 425                 break;
 426         }
 427     }
 428 }
 429
 430 /************************************************************************************/
 431
 432 static void autoActivate(CxMsg *msg, CxObj *co)
 433 {
 434     struct InputEvent *ie = (struct InputEvent *)CxMsgData(msg);
 435
 436     if (ie->ie_Class == IECLASS_RAWMOUSE)
 437     {
 438         struct Screen *screen;
 439         struct Layer  *layer;
 440
 441         if (ie->ie_Code != IECODE_NOBUTTON)
 442         {
 443             switch (ie->ie_Code)
 444             {
 445                 case MIDDLEDOWN:
 446                     if (apInfo.ai_midMousePreventsActivation)
 447                         apInfo.ai_middleButtonDown = TRUE;
 448                     break;
 449                 case SELECTDOWN:
 450                     apInfo.ai_leftButtonDown = TRUE;
 451                     break;
 452                 case MENUDOWN:
 453                     apInfo.ai_rightButtonDown = TRUE;
 454                     break;
 455                 case MIDDLEUP:
 456                     apInfo.ai_middleButtonDown = FALSE;
 457                     break;
 458                 case SELECTUP:
 459                     apInfo.ai_leftButtonDown = FALSE;
 460                     break;
 461                 case MENUUP:
 462                     apInfo.ai_rightButtonDown = FALSE;
 463                     break;
 464             }
 465             return;
 466         }
 467
 468         if (apInfo.ai_leftButtonDown  ||
 469             apInfo.ai_rightButtonDown ||
 470             apInfo.ai_middleButtonDown  )
 471             return;
 472
 473         if (IntuitionBase->ActiveWindow != NULL)
 474         {
 475             screen = IntuitionBase->ActiveWindow->WScreen;
 476         }
 477         else
 478         {
 479             screen = IntuitionBase->ActiveScreen;
 480         }
 481
 482         if (!screen)
 483             layer = NULL;
 484         else
 485         {
 486             LockLayerInfo(&screen->LayerInfo);
 487             layer = WhichLayer(&screen->LayerInfo, screen->MouseX, screen->MouseY);
 488             UnlockLayerInfo(&screen->LayerInfo);
 489         }
 490
 491         apInfo.ai_thisWindow = (layer != NULL) ?
 492             (struct Window *)layer->Window : NULL;
 493
 494         if (apInfo.ai_thisWindow != NULL &&
 495                 apInfo.ai_thisWindow != IntuitionBase->ActiveWindow)
 496         {
 497             ActivateWindow(apInfo.ai_thisWindow);
 498             D(bug("Activated window %s\n", apInfo.ai_thisWindow->Title));
 499         }
 500
 501         return;
 502     }
 503 }
 504
 505 /************************************************************************************/
 506
 507 /* React on command messages sent by commodities.library */
 508 static void handleCx(APState *as)
 509 {
 510     CxMsg *msg;
 511     BOOL   quit = FALSE;
 512     LONG   signals;
 513
 514     while (!quit)
 515     {
 516         signals = Wait((1 << nb.nb_Port->mp_SigBit) | SIGBREAKF_CTRL_C);
 517
 518         if (signals & (1 << nb.nb_Port->mp_SigBit))
 519         {
 520             while ((msg = (CxMsg *)GetMsg(as->as_msgPort)))
 521             {
 522                 switch (CxMsgType(msg))
 523                 {
 524                     case CXM_COMMAND:
 525                         switch (CxMsgID(msg))
 526                         {
 527                             case CXCMD_DISABLE:
 528                                 ActivateCxObj(as->as_broker, FALSE);
 529                                 break;
 530
 531                             case CXCMD_ENABLE:
 532                                 ActivateCxObj(as->as_broker, TRUE);
 533                                 break;
 534
 535                             case CXCMD_UNIQUE:
 536                                 /* Running the program twice <=> quit */
 537                                 /* Fall through */
 538
 539                             case CXCMD_KILL:
 540                                 quit = TRUE;
 541                                 break;
 542
 543                         } /* switch(CxMsgID(msg)) */
 544
 545                         break;
 546                 } /* switch (CxMsgType(msg))*/
 547
 548                 ReplyMsg((struct Message *)msg);
 549
 550             } /* while((msg = (CxMsg *)GetMsg(cs->cs_msgPort))) */
 551         }
 552
 553         if (signals & SIGBREAKF_CTRL_C)
 554         {
 555             quit = TRUE;
 556         }
 557
 558     } /* while (!quit) */
 559 }
 560
 561 /************************************************************************************/
 562
 563 int main(int argc, char **argv)
 564 {
 565     APState aState;
 566     int     error = RETURN_OK;
 567
 568     if (initiate(argc, argv, &aState))
 569     {
 570         handleCx(&aState);
 571     }
 572     else
 573     {
 574         error = RETURN_FAIL;
 575     }
 576
 577     freeResources(&aState);
 578
 579     return error;
 580 }
 581
 582 /************************************************************************************/
 583
 584 ADD2INIT(Locale_Initialize,   90);
 585 ADD2EXIT(Locale_Deinitialize, 90);
 586