compiler/alib/invertstring.c

   1 /*
   2     Copyright © 1995-2012, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include <libraries/commodities.h>
   7 #include <proto/commodities.h>
   8 #include <proto/exec.h>
   9 #include <proto/alib.h>
  10 #include <exec/memory.h>
  11 #include <devices/keymap.h>
  12 #include <devices/inputevent.h>
  13
  14 extern struct Library *CxBase;
  15
  16 /*****************************************************************************
  17
  18     NAME */
  19
  20     struct InputEvent *InvertString(
  21
  22 /*  SYNOPSIS */
  23
  24         STRPTR str,
  25         struct KeyMap *km
  26                      )
  27 /*  FUNCTION
  28         Return a linked list of input events which would produce the string
  29         'str' in the reverse order, with the keymap 'km'. To get a list of
  30         events in the right order, just use InvertStringForwd(). InverString()
  31         is only there to provide compatibility with the original function,
  32         which indeed reversed the order of the supplied string.
  33
  34     INPUTS
  35         str  --  pointer to a (NULL-terminated) string that may contain
  36                  * ANSI character codes
  37                  * backslash-escaped characters:
  38                    \n    --  carriage return
  39                    \r    --  carriage return
  40                    \t    --  tab
  41                    \\    --  backslash
  42                  * a description of an input event a la ParseIX() surrounded
  43                    by angle brackets
  44
  45         km   --  keymap to use for the conversion or NULL to use the default
  46                  keymap
  47
  48     RESULT
  49         A linked list of input events or NULL if something went wrong.
  50
  51     NOTES
  52
  53     EXAMPLE
  54         An example string: "\n<shift alt a> olleH"
  55
  56     BUGS
  57
  58     SEE ALSO
  59         commodities.library/ParseIX(), InvertStringForwd(), FreeIEvents()
  60
  61     INTERNALS
  62         Ought to have an extra \< for < not starting an IX expression.
  63
  64     HISTORY
  65
  66 ******************************************************************************/
  67 {
  68     struct InputEvent *first, *second, *third, *fourth;
  69     if ((first = InvertStringForwd(str, km)))
  70     {
  71         fourth = first;
  72         third = first->ie_NextEvent;
  73         while (third)
  74         {
  75             second = first;
  76             first = third;
  77             third = first->ie_NextEvent;
  78             first->ie_NextEvent = second;
  79         }
  80         fourth->ie_NextEvent = NULL;
  81     }
  82     return first;
  83 } /* InvertString */
  84