workbench/tools/commodities/NoCapsLock.c

   1 /*
   2     Copyright © 1995-2006, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     NoCapsLock commodity -- Renders the CAPS LOCK key ineffective
   6 */
   7
   8 /******************************************************************************
   9
  10     NAME
  11
  12         NoCapsLock
  13
  14     SYNOPSIS
  15
  16         CX_PRIORITY/N/K
  17
  18     LOCATION
  19
  20         SYS:Tools/Commodities
  21
  22     FUNCTION
  23
  24         Renders the CAPS LOCK key ineffective.
  25
  26     INPUTS
  27
  28         CX_PRIORITY  --  The priority of the commodity
  29
  30     RESULT
  31
  32     NOTES
  33
  34     EXAMPLE
  35
  36     BUGS
  37
  38     SEE ALSO
  39
  40     INTERNALS
  41
  42     HISTORY
  43
  44     05.03.2000  SDuvan   implemented
  45
  46 ******************************************************************************/
  47
  48 #include <aros/symbolsets.h>
  49 #include <intuition/intuition.h>
  50 #include <intuition/intuitionbase.h>
  51 #include <libraries/commodities.h>
  52 #include <libraries/locale.h>
  53 #include <proto/exec.h>
  54 #include <proto/dos.h>
  55 #include <proto/intuition.h>
  56 #include <proto/layers.h>
  57 #include <proto/commodities.h>
  58 #include <proto/locale.h>
  59 #include <proto/alib.h>
  60
  61 #include <stdio.h>
  62 #include <string.h>
  63
  64 #define  DEBUG 0
  65 #include <aros/debug.h>
  66
  67 #define CATCOMP_ARRAY
  68 #include "strings.h"
  69
  70 #define CATALOG_NAME     "System/Tools/Commodities.catalog"
  71 #define CATALOG_VERSION  3
  72
  73
  74 /***************************************************************************/
  75
  76 UBYTE version[] = "$VER: NoCapsLock 1.1 (15.04.2006)";
  77
  78 #define ARG_TEMPLATE "CX_PRIORITY=PRI/N/K"
  79
  80 #define ARG_PRI   0
  81 #define NUM_ARGS  1
  82
  83
  84 static struct NewBroker nb =
  85 {
  86     NB_VERSION,
  87     NULL,
  88     NULL,
  89     NULL,
  90     NBU_NOTIFY | NBU_UNIQUE,
  91     0,
  92     0,
  93     NULL,
  94     0
  95 };
  96
  97
  98 typedef struct _APState
  99 {
 100     CxObj          *as_broker;
 101     struct MsgPort *as_msgPort;
 102 } APState;
 103
 104
 105 static struct Catalog       *catalog;
 106
 107 /***************************************************************************/
 108
 109 static void freeResources(APState *as);
 110 static BOOL initiate(int argc, char **argv, APState *as);
 111 static void killCapsLockCustomFunc(CxMsg *msg, CxObj *co);
 112 static CONST_STRPTR _(ULONG id);
 113 static BOOL Locale_Initialize(VOID);
 114 static VOID Locale_Deinitialize(VOID);
 115 static void showSimpleMessage(CONST_STRPTR msgString);
 116
 117 /***************************************************************************/
 118
 119 static CONST_STRPTR _(ULONG id)
 120 {
 121     if (LocaleBase != NULL && catalog != NULL)
 122     {
 123         return GetCatalogStr(catalog, id, CatCompArray[id].cca_Str);
 124     }
 125     else
 126     {
 127         return CatCompArray[id].cca_Str;
 128     }
 129 }
 130
 131 /***************************************************************************/
 132
 133 static BOOL Locale_Initialize(VOID)
 134 {
 135     if (LocaleBase != NULL)
 136     {
 137         catalog = OpenCatalog
 138             (
 139              NULL, CATALOG_NAME, OC_Version, CATALOG_VERSION, TAG_DONE
 140             );
 141     }
 142     else
 143     {
 144         catalog = NULL;
 145     }
 146
 147     return TRUE;
 148 }
 149
 150 /************************************************************************************/
 151
 152 static VOID Locale_Deinitialize(VOID)
 153 {
 154     if(LocaleBase != NULL && catalog != NULL) CloseCatalog(catalog);
 155 }
 156
 157 /************************************************************************************/
 158
 159 static void showSimpleMessage(CONST_STRPTR msgString)
 160 {
 161     struct EasyStruct easyStruct;
 162
 163     easyStruct.es_StructSize    = sizeof(easyStruct);
 164     easyStruct.es_Flags         = 0;
 165     easyStruct.es_Title         = _(MSG_NOCAPSLOCK_CXNAME);
 166     easyStruct.es_TextFormat    = msgString;
 167     easyStruct.es_GadgetFormat  = _(MSG_OK);
 168
 169     if (IntuitionBase != NULL && !Cli() )
 170     {
 171         EasyRequestArgs(NULL, &easyStruct, NULL, NULL);
 172     }
 173     else
 174     {
 175         PutStr(msgString);
 176     }
 177 }
 178
 179 /***************************************************************************/
 180
 181 static BOOL initiate(int argc, char **argv, APState *as)
 182 {
 183     CxObj *customObj, *filterObj;
 184
 185     memset(as, 0, sizeof(APState));
 186
 187     if (Cli() != NULL)
 188     {
 189         struct RDArgs *rda;
 190         IPTR          *args[] = { NULL };
 191
 192         rda = ReadArgs(ARG_TEMPLATE, (IPTR *)args, NULL);
 193
 194         if (rda != NULL)
 195         {
 196             if (args[ARG_PRI] != NULL)
 197             {
 198                 nb.nb_Pri = (BYTE)(*args[ARG_PRI]);
 199             }
 200         }
 201
 202         FreeArgs(rda);
 203     }
 204     else
 205     {
 206         UBYTE **array = ArgArrayInit(argc, (UBYTE **)argv);
 207
 208         nb.nb_Pri = ArgInt(array, "CX_PRIORITY", 0);
 209         ArgArrayDone();
 210     }
 211
 212     nb.nb_Name = _(MSG_NOCAPSLOCK_CXNAME);
 213     nb.nb_Title = _(MSG_NOCAPSLOCK_CXTITLE);
 214     nb.nb_Descr = _(MSG_NOCAPSLOCK_CXDESCR);
 215
 216     as->as_msgPort = CreateMsgPort();
 217
 218     if (as->as_msgPort == NULL)
 219     {
 220         showSimpleMessage(_(MSG_CANT_CREATE_MSGPORT));
 221
 222         return FALSE;
 223     }
 224
 225     nb.nb_Port = as->as_msgPort;
 226
 227     as->as_broker = CxBroker(&nb, 0);
 228
 229     if (as->as_broker == NULL)
 230     {
 231         return FALSE;
 232     }
 233
 234     filterObj = CxFilter(NULL);
 235     if (filterObj == NULL)
 236     {
 237         showSimpleMessage(_(MSG_CANT_CREATE_CUSTOM));
 238
 239         return FALSE;
 240     }
 241     else
 242     {
 243         static IX ix =
 244         {
 245             IX_VERSION,
 246             IECLASS_RAWKEY,
 247             0,
 248             0,
 249             IEQUALIFIER_CAPSLOCK,
 250             IEQUALIFIER_CAPSLOCK,
 251             0
 252         };
 253
 254         SetFilterIX(filterObj, &ix);
 255         AttachCxObj(as->as_broker, filterObj);
 256     }
 257
 258
 259     customObj = CxCustom(killCapsLockCustomFunc, 0);
 260
 261     if (customObj == NULL)
 262     {
 263         showSimpleMessage(_(MSG_CANT_CREATE_CUSTOM));
 264
 265         return FALSE;
 266     }
 267
 268     AttachCxObj(filterObj, customObj);
 269     ActivateCxObj(as->as_broker, TRUE);
 270
 271     return TRUE;
 272 }
 273
 274 /***************************************************************************/
 275
 276 static void freeResources(APState *as)
 277 {
 278     struct Message  *cxm;
 279
 280     if (CxBase != NULL)
 281     {
 282         if (as->as_broker != NULL)
 283         {
 284             DeleteCxObjAll(as->as_broker);
 285         }
 286     }
 287
 288     if (as->as_msgPort != NULL)
 289     {
 290         while ((cxm = GetMsg(as->as_msgPort)))
 291         {
 292             ReplyMsg(cxm);
 293         }
 294
 295         DeleteMsgPort(as->as_msgPort);
 296     }
 297 }
 298
 299 /***************************************************************************/
 300
 301 /* Our CxCustom() function that is invoked everytime an imputevent is
 302    routed to our broker */
 303 static void killCapsLockCustomFunc(CxMsg *msg, CxObj *co)
 304 {
 305     struct InputEvent *ie = (struct InputEvent *)CxMsgData(msg);
 306
 307     ie->ie_Qualifier &= ~IEQUALIFIER_CAPSLOCK;
 308 }
 309
 310 /***************************************************************************/
 311
 312 /* React on command messages sent by commodities.library */
 313 static void handleCx(APState *as)
 314 {
 315     CxMsg *msg;
 316     BOOL   quit = FALSE;
 317     LONG   signals;
 318
 319     while (!quit)
 320     {
 321         signals = Wait((1 << nb.nb_Port->mp_SigBit) | SIGBREAKF_CTRL_C);
 322
 323         if (signals & (1 << nb.nb_Port->mp_SigBit))
 324         {
 325             while ((msg = (CxMsg *)GetMsg(as->as_msgPort)))
 326             {
 327                 switch (CxMsgType(msg))
 328                 {
 329                     case CXM_COMMAND:
 330                         switch (CxMsgID(msg))
 331                         {
 332                             case CXCMD_DISABLE:
 333                                 ActivateCxObj(as->as_broker, FALSE);
 334                                 break;
 335
 336                             case CXCMD_ENABLE:
 337                                 ActivateCxObj(as->as_broker, TRUE);
 338                                 break;
 339
 340                             case CXCMD_UNIQUE:
 341                                 /* Running the program twice <=> quit */
 342                                 /* Fall through */
 343
 344                             case CXCMD_KILL:
 345                                 quit = TRUE;
 346                                 break;
 347
 348                         } /* switch(CxMsgID(msg)) */
 349
 350                         break;
 351                 } /* switch (CxMsgType(msg))*/
 352
 353                 ReplyMsg((struct Message *)msg);
 354
 355             } /* while((msg = (CxMsg *)GetMsg(cs->cs_msgPort))) */
 356         }
 357
 358         if (signals & SIGBREAKF_CTRL_C)
 359         {
 360             quit = TRUE;
 361         }
 362
 363     } /* while (!quit) */
 364 }
 365
 366 /***************************************************************************/
 367
 368 int main(int argc, char **argv)
 369 {
 370     APState aState;
 371     int     error = RETURN_OK;
 372
 373     if (initiate(argc, argv, &aState))
 374     {
 375         handleCx(&aState);
 376     }
 377     else
 378     {
 379         error = RETURN_FAIL;
 380     }
 381
 382     freeResources(&aState);
 383
 384     return error;
 385 }
 386
 387 /***************************************************************************/
 388
 389 ADD2INIT(Locale_Initialize,   90);
 390 ADD2EXIT(Locale_Deinitialize, 90);
 391