workbench/c/RequestChoice.c

   1 /*
   2     Copyright © 1995-2011, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: RequestChoice CLI command
   6     Lang: English
   7 */
   8
   9 /*****************************************************************************
  10
  11     NAME
  12
  13         RequestChoice
  14
  15     SYNOPSIS
  16
  17         TITLE/A,BODY/A,GADGETS/A/M,PUBSCREEN/K
  18
  19     LOCATION
  20
  21         C:
  22
  23     FUNCTION
  24
  25         Allows AmigaDOS scripts to have access to the EasyRequest() function
  26         for input.
  27
  28     INPUTS
  29
  30         TITLE       - The text to display in the title bar of the requester.
  31
  32         BODY        - The text to display in the body of the requester.
  33
  34         GADGETS     - The text for each of the buttons.
  35
  36         PUBSCREEN   - The name of the public screen to open the requester
  37                       upon.
  38
  39     RESULT
  40
  41         Standard DOS return codes.
  42
  43     NOTES
  44
  45         To place a newline into the body of the requester use *n or *N.
  46
  47         To place a quotation mark in the body of the requester use *".
  48
  49         The CLI template gives the GADGETS option as ALWAYS given; this
  50         is different from the original program. This way, we do not have
  51         to check to see if the gadgets have been given.
  52
  53     EXAMPLE
  54
  55         RequestChoice "This is a title" "This is*Na body" Okay|Cancel
  56
  57             This is self-explanitory, except for the "*N". This is the
  58             equivalent of using a '\n' in C to get a newline in the body
  59             of the requester. This requester will open on the Workbench
  60             screen.
  61
  62         RequestChoice Title="This is a title" Body="This is*Na body"
  63                       Gadgets=Okay|Cancel PubScreen=DOPUS.1
  64
  65             This will do exactly the same as before except that it will
  66             open on the Directory Opus public screen.
  67
  68     BUGS
  69
  70     SEE ALSO
  71
  72         intuition.library/EasyRequestArgs()
  73
  74     INTERNALS
  75
  76     HISTORY
  77
  78 ******************************************************************************/
  79
  80 #include <proto/dos.h>
  81 #include <proto/exec.h>
  82 #include <proto/intuition.h>
  83
  84 #include <dos/dos.h>
  85 #include <dos/rdargs.h>
  86 #include <exec/libraries.h>
  87 #include <exec/memory.h>
  88 #include <exec/types.h>
  89 #include <intuition/intuition.h>
  90 #include <intuition/screens.h>
  91
  92 #include <string.h>
  93
  94 #define ARG_TEMPLATE    "TITLE/A,BODY/A,GADGETS/A/M,PUBSCREEN/K"
  95 #define ARG_TITLE       0
  96 #define ARG_BODY        1
  97 #define ARG_GADGETS     2
  98 #define ARG_PUBSCREEN   3
  99 #define TOTAL_ARGS      4
 100
 101 const TEXT version[] = "$VER: RequestChoice 41.2 (01.05.2011)\n";
 102
 103 static char ERROR_HEADER[] = "RequestChoice";
 104
 105 static int Do_RequestChoice(STRPTR, STRPTR, STRPTR *, STRPTR);
 106 static STRPTR FilterBodyText(STRPTR Body);
 107 static STRPTR ComposeGadgetText(STRPTR * Gadgets);
 108
 109 int __nocommandline;
 110
 111 int main(void)
 112 {
 113     struct RDArgs * rda;
 114     IPTR          * args[TOTAL_ARGS] = { NULL, NULL, NULL, NULL };
 115     int             Return_Value;
 116
 117     Return_Value = RETURN_OK;
 118
 119     rda = ReadArgs(ARG_TEMPLATE, (IPTR *)args, NULL);
 120     if (rda)
 121     {
 122         Return_Value = Do_RequestChoice((STRPTR)args[ARG_TITLE],
 123                                         (STRPTR)args[ARG_BODY],
 124                                         (STRPTR *)args[ARG_GADGETS],
 125                                         (STRPTR)args[ARG_PUBSCREEN]);
 126         FreeArgs(rda);
 127     }
 128     else
 129     {
 130         PrintFault(IoErr(), ERROR_HEADER);
 131         Return_Value = RETURN_FAIL;
 132     }
 133
 134     return (Return_Value);
 135 } /* main */
 136
 137
 138 STRPTR ComposeGadgetText(STRPTR *);
 139
 140 int Do_RequestChoice(STRPTR   Title,
 141                      STRPTR   Body,
 142                      STRPTR * Gadgets,
 143                      STRPTR   PubScreen)
 144 {
 145     struct Screen     * Scr;
 146     struct EasyStruct   ChoiceES;
 147     STRPTR              GadgetText;
 148     STRPTR              BodyText;
 149     LONG                Result;
 150     IPTR                args[1];
 151     int                 Return_Value;
 152
 153     Return_Value     = RETURN_OK;
 154     Result           = 0L;
 155
 156     GadgetText = ComposeGadgetText(Gadgets);
 157     if (!GadgetText)
 158         return RETURN_FAIL;
 159
 160     BodyText = FilterBodyText(Body);
 161     if (!BodyText)
 162         return RETURN_FAIL;
 163
 164     /* Make sure we can open the requester on the specified screen.
 165      *
 166      * If the PubScreen argument is not specified it will contain
 167      * NULL, and hence open on the Workbench screen.
 168      */
 169     Scr = (struct Screen *)LockPubScreen((UBYTE *)PubScreen);
 170     if (Scr != NULL)
 171     {
 172         ChoiceES.es_StructSize   = sizeof(struct EasyStruct);
 173         ChoiceES.es_Flags        = 0L;
 174         ChoiceES.es_Title        = Title;
 175         ChoiceES.es_TextFormat   = BodyText;
 176         ChoiceES.es_GadgetFormat = GadgetText;
 177
 178         /* Open the requester.
 179          */
 180         Result = EasyRequestArgs(Scr->FirstWindow, &ChoiceES, NULL, NULL);
 181         if (Result != -1)
 182         {
 183             args[0] = (IPTR)Result;
 184
 185             VPrintf("%ld\n", args);
 186         }
 187         else
 188         {
 189             Return_Value = RETURN_FAIL;
 190             SetIoErr(ERROR_NO_FREE_STORE);
 191             PrintFault(IoErr(), ERROR_HEADER);
 192         }
 193         UnlockPubScreen(NULL, Scr);
 194     }
 195     else
 196     {
 197         Return_Value = RETURN_FAIL;
 198         SetIoErr(ERROR_NO_FREE_STORE);
 199         PrintFault(IoErr(), ERROR_HEADER);
 200     }
 201
 202     FreeVec(GadgetText);
 203     FreeVec(BodyText);
 204
 205     return Return_Value;
 206
 207 } /* Do_RequestChoice */
 208
 209
 210 // Combine gadget strings and separate them by "|".
 211 // Replace all "%" by "%%" because EasyRequest
 212 // uses printf-like formatting.
 213 static STRPTR ComposeGadgetText(STRPTR * Gadgets)
 214 {
 215     STRPTR GadgetText, BufferPos;
 216     int    GadgetLength = 0;
 217     int    CurrentGadget;
 218     int    PercentCnt = 0;
 219     int    StrLen;
 220     int    i;
 221
 222     for (CurrentGadget = 0; Gadgets[CurrentGadget]; CurrentGadget++)
 223     {
 224         StrLen = strlen(Gadgets[CurrentGadget]);
 225         GadgetLength +=  StrLen + 1;
 226
 227         // Count "%"
 228         for (i = 0; i < StrLen; i++)
 229         {
 230             if (Gadgets[CurrentGadget][i] == '%')
 231             {
 232                 PercentCnt++;
 233             }
 234         }
 235     }
 236
 237     GadgetLength += PercentCnt;
 238
 239     GadgetText = AllocVec(GadgetLength, MEMF_ANY);
 240     if (!GadgetText)
 241     {
 242         SetIoErr(ERROR_NO_FREE_STORE);
 243         PrintFault(IoErr(), ERROR_HEADER);
 244         return NULL;
 245     }
 246
 247     BufferPos = GadgetText;
 248     for (CurrentGadget = 0; Gadgets[CurrentGadget]; CurrentGadget++)
 249     {
 250         int LabelLength = strlen(Gadgets[CurrentGadget]);
 251
 252         for (i = 0; i < LabelLength; i++)
 253         {
 254             if (Gadgets[CurrentGadget][i] == '%')
 255             {
 256                 *BufferPos = '%';
 257                 BufferPos++;
 258                 *BufferPos = '%';
 259                 BufferPos++;
 260             }
 261             else
 262             {
 263                 *BufferPos = Gadgets[CurrentGadget][i];
 264                 BufferPos++;
 265             }
 266         }
 267         if (Gadgets[CurrentGadget + 1])
 268         {
 269             *BufferPos = '|';
 270             BufferPos++;
 271         }
 272         else
 273             *BufferPos = '\0';
 274     }
 275
 276     return GadgetText;
 277
 278 } /* ComposeGadgetText */
 279
 280
 281 // Replace % by %% because EasyRequest uses
 282 // printf-like formatting characters.
 283 // Result string must be freed with FreeVec().
 284 static STRPTR FilterBodyText(STRPTR Body)
 285 {
 286     STRPTR GadgetText;
 287     int    GadgetLength = 0;
 288     int    StrLen;
 289     int    PercentCnt = 0;
 290     int    i, j;
 291
 292     if (!Body)
 293         return NULL;
 294
 295     // Count % characters
 296     StrLen = strlen(Body);
 297     for (i = 0; i < StrLen; i++)
 298     {
 299         if (Body[i] == '%')
 300         {
 301             PercentCnt++;
 302         }
 303     }
 304
 305     GadgetLength = StrLen + PercentCnt + 1;
 306
 307     GadgetText = AllocVec(GadgetLength, MEMF_ANY);
 308     if (!GadgetText)
 309     {
 310         SetIoErr(ERROR_NO_FREE_STORE);
 311         PrintFault(IoErr(), ERROR_HEADER);
 312         return NULL;
 313     }
 314
 315     for (i = 0, j = 0; i < StrLen; i++)
 316     {
 317         if (Body[i] == '%')
 318         {
 319             GadgetText[j++] = '%';
 320             GadgetText[j++] = '%';
 321         }
 322         else
 323         {
 324             GadgetText[j++] = Body[i];
 325         }
 326     }
 327
 328     GadgetText[j] = '\0';
 329
 330     return GadgetText;
 331
 332 } /* FilterBodyText */