workbench/c/RequestChoice.c

   1 /*
   2     Copyright © 1995-2014, 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.3 (3.4.2014)\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             PrintFault(ERROR_NO_FREE_STORE, ERROR_HEADER);
 191         }
 192         UnlockPubScreen(NULL, Scr);
 193     }
 194     else
 195     {
 196         Return_Value = RETURN_FAIL;
 197         PrintFault(ERROR_NO_FREE_STORE, ERROR_HEADER);
 198     }
 199
 200     FreeVec(GadgetText);
 201     FreeVec(BodyText);
 202
 203     return Return_Value;
 204
 205 } /* Do_RequestChoice */
 206
 207
 208 // Combine gadget strings and separate them by "|".
 209 // Replace all "%" by "%%" because EasyRequest
 210 // uses printf-like formatting.
 211 static STRPTR ComposeGadgetText(STRPTR * Gadgets)
 212 {
 213     STRPTR GadgetText, BufferPos;
 214     int    GadgetLength = 0;
 215     int    CurrentGadget;
 216     int    PercentCnt = 0;
 217     int    StrLen;
 218     int    i;
 219
 220     for (CurrentGadget = 0; Gadgets[CurrentGadget]; CurrentGadget++)
 221     {
 222         StrLen = strlen(Gadgets[CurrentGadget]);
 223         GadgetLength +=  StrLen + 1;
 224
 225         // Count "%"
 226         for (i = 0; i < StrLen; i++)
 227         {
 228             if (Gadgets[CurrentGadget][i] == '%')
 229             {
 230                 PercentCnt++;
 231             }
 232         }
 233     }
 234
 235     GadgetLength += PercentCnt;
 236
 237     GadgetText = AllocVec(GadgetLength, MEMF_ANY);
 238     if (!GadgetText)
 239     {
 240         PrintFault(ERROR_NO_FREE_STORE, ERROR_HEADER);
 241         return NULL;
 242     }
 243
 244     BufferPos = GadgetText;
 245     for (CurrentGadget = 0; Gadgets[CurrentGadget]; CurrentGadget++)
 246     {
 247         int LabelLength = strlen(Gadgets[CurrentGadget]);
 248
 249         for (i = 0; i < LabelLength; i++)
 250         {
 251             if (Gadgets[CurrentGadget][i] == '%')
 252             {
 253                 *BufferPos = '%';
 254                 BufferPos++;
 255                 *BufferPos = '%';
 256                 BufferPos++;
 257             }
 258             else
 259             {
 260                 *BufferPos = Gadgets[CurrentGadget][i];
 261                 BufferPos++;
 262             }
 263         }
 264         if (Gadgets[CurrentGadget + 1])
 265         {
 266             *BufferPos = '|';
 267             BufferPos++;
 268         }
 269         else
 270             *BufferPos = '\0';
 271     }
 272
 273     return GadgetText;
 274
 275 } /* ComposeGadgetText */
 276
 277
 278 // Replace % by %% because EasyRequest uses
 279 // printf-like formatting characters.
 280 // Result string must be freed with FreeVec().
 281 static STRPTR FilterBodyText(STRPTR Body)
 282 {
 283     STRPTR GadgetText;
 284     int    GadgetLength = 0;
 285     int    StrLen;
 286     int    PercentCnt = 0;
 287     int    i, j;
 288
 289     if (!Body)
 290         return NULL;
 291
 292     // Count % characters
 293     StrLen = strlen(Body);
 294     for (i = 0; i < StrLen; i++)
 295     {
 296         if (Body[i] == '%')
 297         {
 298             PercentCnt++;
 299         }
 300     }
 301
 302     GadgetLength = StrLen + PercentCnt + 1;
 303
 304     GadgetText = AllocVec(GadgetLength, MEMF_ANY);
 305     if (!GadgetText)
 306     {
 307         PrintFault(IoErr(), ERROR_HEADER);
 308         return NULL;
 309     }
 310
 311     for (i = 0, j = 0; i < StrLen; i++)
 312     {
 313         if (Body[i] == '%')
 314         {
 315             GadgetText[j++] = '%';
 316             GadgetText[j++] = '%';
 317         }
 318         else
 319         {
 320             GadgetText[j++] = Body[i];
 321         }
 322     }
 323
 324     GadgetText[j] = '\0';
 325
 326     return GadgetText;
 327
 328 } /* FilterBodyText */