linux/drivers/staging/speakup/i18n.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0
   2/* Internationalization implementation.  Includes definitions of English
   3 * string arrays, and the i18n pointer.
   4 */
   5
   6#include <linux/slab.h>         /* For kmalloc. */
   7#include <linux/ctype.h>
   8#include <linux/module.h>
   9#include <linux/string.h>
  10#include "speakup.h"
  11#include "spk_priv.h"
  12
  13static char *speakup_msgs[MSG_LAST_INDEX];
  14static char *speakup_default_msgs[MSG_LAST_INDEX] = {
  15        [MSG_BLANK] = "blank",
  16        [MSG_IAM_ALIVE] = "I'm aLive!",
  17        [MSG_YOU_KILLED_SPEAKUP] = "You killed speakup!",
  18        [MSG_HEY_THATS_BETTER] = "hey. That's better!",
  19        [MSG_YOU_TURNED_ME_OFF] = "You turned me off!",
  20        [MSG_PARKED] = "parked!",
  21        [MSG_UNPARKED] = "unparked!",
  22        [MSG_MARK] = "mark",
  23        [MSG_CUT] = "cut",
  24        [MSG_MARK_CLEARED] = "mark, cleared",
  25        [MSG_PASTE] = "paste",
  26        [MSG_BRIGHT] = "bright",
  27        [MSG_ON_BLINKING] = "on blinking",
  28        [MSG_OFF] = "off",
  29        [MSG_ON] = "on",
  30        [MSG_NO_WINDOW] = "no window",
  31        [MSG_CURSORING_OFF] = "cursoring off",
  32        [MSG_CURSORING_ON] = "cursoring on",
  33        [MSG_HIGHLIGHT_TRACKING] = "highlight tracking",
  34        [MSG_READ_WINDOW] = "read windo",
  35        [MSG_READ_ALL] = "read all",
  36        [MSG_EDIT_DONE] = "edit done",
  37        [MSG_WINDOW_ALREADY_SET] = "window already set, clear then reset",
  38        [MSG_END_BEFORE_START] = "error end before start",
  39        [MSG_WINDOW_CLEARED] = "window cleared",
  40        [MSG_WINDOW_SILENCED] = "window silenced",
  41        [MSG_WINDOW_SILENCE_DISABLED] = "window silence disabled",
  42        [MSG_ERROR] = "error",
  43        [MSG_GOTO_CANCELED] = "goto canceled",
  44        [MSG_GOTO] = "go to?",
  45        [MSG_LEAVING_HELP] = "leaving help",
  46        [MSG_IS_UNASSIGNED] = "is unassigned",
  47        [MSG_HELP_INFO] =
  48        "press space to exit, up or down to scroll, or a letter to go to a command",
  49        [MSG_EDGE_TOP] = "top,",
  50        [MSG_EDGE_BOTTOM] = "bottom,",
  51        [MSG_EDGE_LEFT] = "left,",
  52        [MSG_EDGE_RIGHT] = "right,",
  53        [MSG_NUMBER] = "number",
  54        [MSG_SPACE] = "space",
  55        [MSG_START] = "start",
  56        [MSG_END] = "end",
  57        [MSG_CTRL] = "control-",
  58        [MSG_DISJUNCTION] = "or",
  59
  60/* Messages with embedded format specifiers. */
  61        [MSG_POS_INFO] = "line %ld, col %ld, t t y %d",
  62        [MSG_CHAR_INFO] = "hex %02x, decimal %d",
  63        [MSG_REPEAT_DESC] = "times %d .",
  64        [MSG_REPEAT_DESC2] = "repeated %d .",
  65        [MSG_WINDOW_LINE] = "window is line %d",
  66        [MSG_WINDOW_BOUNDARY] = "%s at line %d, column %d",
  67        [MSG_EDIT_PROMPT] = "edit  %s, press space when done",
  68        [MSG_NO_COMMAND] = "no commands for %c",
  69        [MSG_KEYDESC] = "is %s",
  70
  71        /* Control keys. */
  72        /* Most of these duplicate the entries in state names. */
  73        [MSG_CTL_SHIFT] = "shift",
  74        [MSG_CTL_ALTGR] = "altgr",
  75        [MSG_CTL_CONTROL] = "control",
  76        [MSG_CTL_ALT] = "alt",
  77        [MSG_CTL_LSHIFT] = "l shift",
  78        [MSG_CTL_SPEAKUP] = "speakup",
  79        [MSG_CTL_LCONTROL] = "l control",
  80        [MSG_CTL_RCONTROL] = "r control",
  81        [MSG_CTL_CAPSSHIFT] = "caps shift",
  82
  83        /* Color names. */
  84        [MSG_COLOR_BLACK] = "black",
  85        [MSG_COLOR_BLUE] = "blue",
  86        [MSG_COLOR_GREEN] = "green",
  87        [MSG_COLOR_CYAN] = "cyan",
  88        [MSG_COLOR_RED] = "red",
  89        [MSG_COLOR_MAGENTA] = "magenta",
  90        [MSG_COLOR_YELLOW] = "yellow",
  91        [MSG_COLOR_WHITE] = "white",
  92        [MSG_COLOR_GREY] = "grey",
  93
  94        /* Names of key states. */
  95        [MSG_STATE_DOUBLE] = "double",
  96        [MSG_STATE_SPEAKUP] = "speakup",
  97        [MSG_STATE_ALT] = "alt",
  98        [MSG_STATE_CONTROL] = "ctrl",
  99        [MSG_STATE_ALTGR] = "altgr",
 100        [MSG_STATE_SHIFT] = "shift",
 101
 102        /* Key names. */
 103        [MSG_KEYNAME_ESC] = "escape",
 104        [MSG_KEYNAME_1] = "1",
 105        [MSG_KEYNAME_2] = "2",
 106        [MSG_KEYNAME_3] = "3",
 107        [MSG_KEYNAME_4] = "4",
 108        [MSG_KEYNAME_5] = "5",
 109        [MSG_KEYNAME_6] = "6",
 110        [MSG_KEYNAME_7] = "7",
 111        [MSG_KEYNAME_8] = "8",
 112        [MSG_KEYNAME_9] = "9",
 113        [MSG_KEYNAME_0] = "0",
 114        [MSG_KEYNAME_DASH] = "minus",
 115        [MSG_KEYNAME_EQUAL] = "equal",
 116        [MSG_KEYNAME_BS] = "back space",
 117        [MSG_KEYNAME_TAB] = "tab",
 118        [MSG_KEYNAME_Q] = "q",
 119        [MSG_KEYNAME_W] = "w",
 120        [MSG_KEYNAME_E] = "e",
 121        [MSG_KEYNAME_R] = "r",
 122        [MSG_KEYNAME_T] = "t",
 123        [MSG_KEYNAME_Y] = "y",
 124        [MSG_KEYNAME_U] = "u",
 125        [MSG_KEYNAME_I] = "i",
 126        [MSG_KEYNAME_O] = "o",
 127        [MSG_KEYNAME_P] = "p",
 128        [MSG_KEYNAME_LEFTBRACE] = "left brace",
 129        [MSG_KEYNAME_RIGHTBRACE] = "right brace",
 130        [MSG_KEYNAME_ENTER] = "enter",
 131        [MSG_KEYNAME_LEFTCTRL] = "left control",
 132        [MSG_KEYNAME_A] = "a",
 133        [MSG_KEYNAME_S] = "s",
 134        [MSG_KEYNAME_D] = "d",
 135        [MSG_KEYNAME_F] = "f",
 136        [MSG_KEYNAME_G] = "g",
 137        [MSG_KEYNAME_H] = "h",
 138        [MSG_KEYNAME_J] = "j",
 139        [MSG_KEYNAME_K] = "k",
 140        [MSG_KEYNAME_L] = "l",
 141        [MSG_KEYNAME_SEMICOLON] = "semicolon",
 142        [MSG_KEYNAME_SINGLEQUOTE] = "apostrophe",
 143        [MSG_KEYNAME_GRAVE] = "accent",
 144        [MSG_KEYNAME_LEFTSHFT] = "left shift",
 145        [MSG_KEYNAME_BACKSLASH] = "back slash",
 146        [MSG_KEYNAME_Z] = "z",
 147        [MSG_KEYNAME_X] = "x",
 148        [MSG_KEYNAME_C] = "c",
 149        [MSG_KEYNAME_V] = "v",
 150        [MSG_KEYNAME_B] = "b",
 151        [MSG_KEYNAME_N] = "n",
 152        [MSG_KEYNAME_M] = "m",
 153        [MSG_KEYNAME_COMMA] = "comma",
 154        [MSG_KEYNAME_DOT] = "dot",
 155        [MSG_KEYNAME_SLASH] = "slash",
 156        [MSG_KEYNAME_RIGHTSHFT] = "right shift",
 157        [MSG_KEYNAME_KPSTAR] = "keypad asterisk",
 158        [MSG_KEYNAME_LEFTALT] = "left alt",
 159        [MSG_KEYNAME_SPACE] = "space",
 160        [MSG_KEYNAME_CAPSLOCK] = "caps lock",
 161        [MSG_KEYNAME_F1] = "f1",
 162        [MSG_KEYNAME_F2] = "f2",
 163        [MSG_KEYNAME_F3] = "f3",
 164        [MSG_KEYNAME_F4] = "f4",
 165        [MSG_KEYNAME_F5] = "f5",
 166        [MSG_KEYNAME_F6] = "f6",
 167        [MSG_KEYNAME_F7] = "f7",
 168        [MSG_KEYNAME_F8] = "f8",
 169        [MSG_KEYNAME_F9] = "f9",
 170        [MSG_KEYNAME_F10] = "f10",
 171        [MSG_KEYNAME_NUMLOCK] = "num lock",
 172        [MSG_KEYNAME_SCROLLLOCK] = "scroll lock",
 173        [MSG_KEYNAME_KP7] = "keypad 7",
 174        [MSG_KEYNAME_KP8] = "keypad 8",
 175        [MSG_KEYNAME_KP9] = "keypad 9",
 176        [MSG_KEYNAME_KPMINUS] = "keypad minus",
 177        [MSG_KEYNAME_KP4] = "keypad 4",
 178        [MSG_KEYNAME_KP5] = "keypad 5",
 179        [MSG_KEYNAME_KP6] = "keypad 6",
 180        [MSG_KEYNAME_KPPLUS] = "keypad plus",
 181        [MSG_KEYNAME_KP1] = "keypad 1",
 182        [MSG_KEYNAME_KP2] = "keypad 2",
 183        [MSG_KEYNAME_KP3] = "keypad 3",
 184        [MSG_KEYNAME_KP0] = "keypad 0",
 185        [MSG_KEYNAME_KPDOT] = "keypad dot",
 186        [MSG_KEYNAME_103RD] = "103rd",
 187        [MSG_KEYNAME_F13] = "f13",
 188        [MSG_KEYNAME_102ND] = "102nd",
 189        [MSG_KEYNAME_F11] = "f11",
 190        [MSG_KEYNAME_F12] = "f12",
 191        [MSG_KEYNAME_F14] = "f14",
 192        [MSG_KEYNAME_F15] = "f15",
 193        [MSG_KEYNAME_F16] = "f16",
 194        [MSG_KEYNAME_F17] = "f17",
 195        [MSG_KEYNAME_F18] = "f18",
 196        [MSG_KEYNAME_F19] = "f19",
 197        [MSG_KEYNAME_F20] = "f20",
 198        [MSG_KEYNAME_KPENTER] = "keypad enter",
 199        [MSG_KEYNAME_RIGHTCTRL] = "right control",
 200        [MSG_KEYNAME_KPSLASH] = "keypad slash",
 201        [MSG_KEYNAME_SYSRQ] = "sysrq",
 202        [MSG_KEYNAME_RIGHTALT] = "right alt",
 203        [MSG_KEYNAME_LF] = "line feed",
 204        [MSG_KEYNAME_HOME] = "home",
 205        [MSG_KEYNAME_UP] = "up",
 206        [MSG_KEYNAME_PGUP] = "page up",
 207        [MSG_KEYNAME_LEFT] = "left",
 208        [MSG_KEYNAME_RIGHT] = "right",
 209        [MSG_KEYNAME_END] = "end",
 210        [MSG_KEYNAME_DOWN] = "down",
 211        [MSG_KEYNAME_PGDN] = "page down",
 212        [MSG_KEYNAME_INS] = "insert",
 213        [MSG_KEYNAME_DEL] = "delete",
 214        [MSG_KEYNAME_MACRO] = "macro",
 215        [MSG_KEYNAME_MUTE] = "mute",
 216        [MSG_KEYNAME_VOLDOWN] = "volume down",
 217        [MSG_KEYNAME_VOLUP] = "volume up",
 218        [MSG_KEYNAME_POWER] = "power",
 219        [MSG_KEYNAME_KPEQUAL] = "keypad equal",
 220        [MSG_KEYNAME_KPPLUSDASH] = "keypad plusminus",
 221        [MSG_KEYNAME_PAUSE] = "pause",
 222        [MSG_KEYNAME_F21] = "f21",
 223        [MSG_KEYNAME_F22] = "f22",
 224        [MSG_KEYNAME_F23] = "f23",
 225        [MSG_KEYNAME_F24] = "f24",
 226        [MSG_KEYNAME_KPCOMMA] = "keypad comma",
 227        [MSG_KEYNAME_LEFTMETA] = "left meta",
 228        [MSG_KEYNAME_RIGHTMETA] = "right meta",
 229        [MSG_KEYNAME_COMPOSE] = "compose",
 230        [MSG_KEYNAME_STOP] = "stop",
 231        [MSG_KEYNAME_AGAIN] = "again",
 232        [MSG_KEYNAME_PROPS] = "props",
 233        [MSG_KEYNAME_UNDO] = "undo",
 234        [MSG_KEYNAME_FRONT] = "front",
 235        [MSG_KEYNAME_COPY] = "copy",
 236        [MSG_KEYNAME_OPEN] = "open",
 237        [MSG_KEYNAME_PASTE] = "paste",
 238        [MSG_KEYNAME_FIND] = "find",
 239        [MSG_KEYNAME_CUT] = "cut",
 240        [MSG_KEYNAME_HELP] = "help",
 241        [MSG_KEYNAME_MENU] = "menu",
 242        [MSG_KEYNAME_CALC] = "calc",
 243        [MSG_KEYNAME_SETUP] = "setup",
 244        [MSG_KEYNAME_SLEEP] = "sleep",
 245        [MSG_KEYNAME_WAKEUP] = "wakeup",
 246        [MSG_KEYNAME_FILE] = "file",
 247        [MSG_KEYNAME_SENDFILE] = "send file",
 248        [MSG_KEYNAME_DELFILE] = "delete file",
 249        [MSG_KEYNAME_XFER] = "transfer",
 250        [MSG_KEYNAME_PROG1] = "prog1",
 251        [MSG_KEYNAME_PROG2] = "prog2",
 252        [MSG_KEYNAME_WWW] = "www",
 253        [MSG_KEYNAME_MSDOS] = "msdos",
 254        [MSG_KEYNAME_COFFEE] = "coffee",
 255        [MSG_KEYNAME_DIRECTION] = "direction",
 256        [MSG_KEYNAME_CYCLEWINDOWS] = "cycle windows",
 257        [MSG_KEYNAME_MAIL] = "mail",
 258        [MSG_KEYNAME_BOOKMARKS] = "bookmarks",
 259        [MSG_KEYNAME_COMPUTER] = "computer",
 260        [MSG_KEYNAME_BACK] = "back",
 261        [MSG_KEYNAME_FORWARD] = "forward",
 262        [MSG_KEYNAME_CLOSECD] = "close cd",
 263        [MSG_KEYNAME_EJECTCD] = "eject cd",
 264        [MSG_KEYNAME_EJECTCLOSE] = "eject close cd",
 265        [MSG_KEYNAME_NEXTSONG] = "next song",
 266        [MSG_KEYNAME_PLAYPAUSE] = "play pause",
 267        [MSG_KEYNAME_PREVSONG] = "previous song",
 268        [MSG_KEYNAME_STOPCD] = "stop cd",
 269        [MSG_KEYNAME_RECORD] = "record",
 270        [MSG_KEYNAME_REWIND] = "rewind",
 271        [MSG_KEYNAME_PHONE] = "phone",
 272        [MSG_KEYNAME_ISO] = "iso",
 273        [MSG_KEYNAME_CONFIG] = "config",
 274        [MSG_KEYNAME_HOMEPG] = "home page",
 275        [MSG_KEYNAME_REFRESH] = "refresh",
 276        [MSG_KEYNAME_EXIT] = "exit",
 277        [MSG_KEYNAME_MOVE] = "move",
 278        [MSG_KEYNAME_EDIT] = "edit",
 279        [MSG_KEYNAME_SCROLLUP] = "scroll up",
 280        [MSG_KEYNAME_SCROLLDN] = "scroll down",
 281        [MSG_KEYNAME_KPLEFTPAR] = "keypad left paren",
 282        [MSG_KEYNAME_KPRIGHTPAR] = "keypad right paren",
 283
 284        /* Function names. */
 285        [MSG_FUNCNAME_ATTRIB_BLEEP_DEC] = "attribute bleep decrement",
 286        [MSG_FUNCNAME_ATTRIB_BLEEP_INC] = "attribute bleep increment",
 287        [MSG_FUNCNAME_BLEEPS_DEC] = "bleeps decrement",
 288        [MSG_FUNCNAME_BLEEPS_INC] = "bleeps increment",
 289        [MSG_FUNCNAME_CHAR_FIRST] = "character, first",
 290        [MSG_FUNCNAME_CHAR_LAST] = "character, last",
 291        [MSG_FUNCNAME_CHAR_CURRENT] = "character, say current",
 292        [MSG_FUNCNAME_CHAR_HEX_AND_DEC] = "character, say hex and decimal",
 293        [MSG_FUNCNAME_CHAR_NEXT] = "character, say next",
 294        [MSG_FUNCNAME_CHAR_PHONETIC] = "character, say phonetic",
 295        [MSG_FUNCNAME_CHAR_PREVIOUS] = "character, say previous",
 296        [MSG_FUNCNAME_CURSOR_PARK] = "cursor park",
 297        [MSG_FUNCNAME_CUT] = "cut",
 298        [MSG_FUNCNAME_EDIT_DELIM] = "edit delimiters",
 299        [MSG_FUNCNAME_EDIT_EXNUM] = "edit exnum",
 300        [MSG_FUNCNAME_EDIT_MOST] = "edit most",
 301        [MSG_FUNCNAME_EDIT_REPEATS] = "edit repeats",
 302        [MSG_FUNCNAME_EDIT_SOME] = "edit some",
 303        [MSG_FUNCNAME_GOTO] = "go to",
 304        [MSG_FUNCNAME_GOTO_BOTTOM] = "go to bottom edge",
 305        [MSG_FUNCNAME_GOTO_LEFT] = "go to left edge",
 306        [MSG_FUNCNAME_GOTO_RIGHT] = "go to right edge",
 307        [MSG_FUNCNAME_GOTO_TOP] = "go to top edge",
 308        [MSG_FUNCNAME_HELP] = "help",
 309        [MSG_FUNCNAME_LINE_SAY_CURRENT] = "line, say current",
 310        [MSG_FUNCNAME_LINE_SAY_NEXT] = "line, say next",
 311        [MSG_FUNCNAME_LINE_SAY_PREVIOUS] = "line, say previous",
 312        [MSG_FUNCNAME_LINE_SAY_WITH_INDENT] = "line, say with indent",
 313        [MSG_FUNCNAME_PASTE] = "paste",
 314        [MSG_FUNCNAME_PITCH_DEC] = "pitch decrement",
 315        [MSG_FUNCNAME_PITCH_INC] = "pitch increment",
 316        [MSG_FUNCNAME_PUNC_DEC] = "punctuation decrement",
 317        [MSG_FUNCNAME_PUNC_INC] = "punctuation increment",
 318        [MSG_FUNCNAME_PUNC_LEVEL_DEC] = "punc level decrement",
 319        [MSG_FUNCNAME_PUNC_LEVEL_INC] = "punc level increment",
 320        [MSG_FUNCNAME_QUIET] = "quiet",
 321        [MSG_FUNCNAME_RATE_DEC] = "rate decrement",
 322        [MSG_FUNCNAME_RATE_INC] = "rate increment",
 323        [MSG_FUNCNAME_READING_PUNC_DEC] = "reading punctuation decrement",
 324        [MSG_FUNCNAME_READING_PUNC_INC] = "reading punctuation increment",
 325        [MSG_FUNCNAME_SAY_ATTRIBUTES] = "say attributes",
 326        [MSG_FUNCNAME_SAY_FROM_LEFT] = "say from left",
 327        [MSG_FUNCNAME_SAY_FROM_TOP] = "say from top",
 328        [MSG_FUNCNAME_SAY_POSITION] = "say position",
 329        [MSG_FUNCNAME_SAY_SCREEN] = "say screen",
 330        [MSG_FUNCNAME_SAY_TO_BOTTOM] = "say to bottom",
 331        [MSG_FUNCNAME_SAY_TO_RIGHT] = "say to right",
 332        [MSG_FUNCNAME_SPEAKUP] = "speakup",
 333        [MSG_FUNCNAME_SPEAKUP_LOCK] = "speakup lock",
 334        [MSG_FUNCNAME_SPEAKUP_OFF] = "speakup off",
 335        [MSG_FUNCNAME_SPEECH_KILL] = "speech kill",
 336        [MSG_FUNCNAME_SPELL_DELAY_DEC] = "spell delay decrement",
 337        [MSG_FUNCNAME_SPELL_DELAY_INC] = "spell delay increment",
 338        [MSG_FUNCNAME_SPELL_WORD] = "spell word",
 339        [MSG_FUNCNAME_SPELL_WORD_PHONETICALLY] = "spell word phoneticly",
 340        [MSG_FUNCNAME_TONE_DEC] = "tone decrement",
 341        [MSG_FUNCNAME_TONE_INC] = "tone increment",
 342        [MSG_FUNCNAME_VOICE_DEC] = "voice decrement",
 343        [MSG_FUNCNAME_VOICE_INC] = "voice increment",
 344        [MSG_FUNCNAME_VOLUME_DEC] = "volume decrement",
 345        [MSG_FUNCNAME_VOLUME_INC] = "volume increment",
 346        [MSG_FUNCNAME_WINDOW_CLEAR] = "window, clear",
 347        [MSG_FUNCNAME_WINDOW_SAY] = "window, say",
 348        [MSG_FUNCNAME_WINDOW_SET] = "window, set",
 349        [MSG_FUNCNAME_WINDOW_SILENCE] = "window, silence",
 350        [MSG_FUNCNAME_WORD_SAY_CURRENT] = "word, say current",
 351        [MSG_FUNCNAME_WORD_SAY_NEXT] = "word, say next",
 352        [MSG_FUNCNAME_WORD_SAY_PREVIOUS] = "word, say previous",
 353};
 354
 355static struct msg_group_t all_groups[] = {
 356        {
 357                .name = "ctl_keys",
 358                .start = MSG_CTL_START,
 359                .end = MSG_CTL_END,
 360        },
 361        {
 362                .name = "colors",
 363                .start = MSG_COLORS_START,
 364                .end = MSG_COLORS_END,
 365        },
 366        {
 367                .name = "formatted",
 368                .start = MSG_FORMATTED_START,
 369                .end = MSG_FORMATTED_END,
 370        },
 371        {
 372                .name = "function_names",
 373                .start = MSG_FUNCNAMES_START,
 374                .end = MSG_FUNCNAMES_END,
 375        },
 376        {
 377                .name = "key_names",
 378                .start = MSG_KEYNAMES_START,
 379                .end = MSG_KEYNAMES_END,
 380        },
 381        {
 382                .name = "announcements",
 383                .start = MSG_ANNOUNCEMENTS_START,
 384                .end = MSG_ANNOUNCEMENTS_END,
 385        },
 386        {
 387                .name = "states",
 388                .start = MSG_STATES_START,
 389                .end = MSG_STATES_END,
 390        },
 391};
 392
 393static const  int num_groups = ARRAY_SIZE(all_groups);
 394
 395char *spk_msg_get(enum msg_index_t index)
 396{
 397        return speakup_msgs[index];
 398}
 399
 400/*
 401 * Function: next_specifier
 402 * Finds the start of the next format specifier in the argument string.
 403 * Return value: pointer to start of format
 404 * specifier, or NULL if no specifier exists.
 405 */
 406static char *next_specifier(char *input)
 407{
 408        int found = 0;
 409        char *next_percent = input;
 410
 411        while (next_percent && !found) {
 412                next_percent = strchr(next_percent, '%');
 413                if (next_percent) {
 414                        /* skip over doubled percent signs */
 415                        while (next_percent[0] == '%' &&
 416                               next_percent[1] == '%')
 417                                next_percent += 2;
 418                        if (*next_percent == '%')
 419                                found = 1;
 420                        else if (*next_percent == '\0')
 421                                next_percent = NULL;
 422                }
 423        }
 424
 425        return next_percent;
 426}
 427
 428/* Skip over 0 or more flags. */
 429static char *skip_flags(char *input)
 430{
 431        while ((*input != '\0') && strchr(" 0+-#", *input))
 432                input++;
 433        return input;
 434}
 435
 436/* Skip over width.precision, if it exists. */
 437static char *skip_width(char *input)
 438{
 439        while (isdigit(*input))
 440                input++;
 441        if (*input == '.') {
 442                input++;
 443                while (isdigit(*input))
 444                        input++;
 445        }
 446        return input;
 447}
 448
 449/*
 450 * Skip past the end of the conversion part.
 451 * Note that this code only accepts a handful of conversion specifiers:
 452 * c d s x and ld.  Not accidental; these are exactly the ones used in
 453 * the default group of formatted messages.
 454 */
 455static char *skip_conversion(char *input)
 456{
 457        if ((input[0] == 'l') && (input[1] == 'd'))
 458                input += 2;
 459        else if ((*input != '\0') && strchr("cdsx", *input))
 460                input++;
 461        return input;
 462}
 463
 464/*
 465 * Function: find_specifier_end
 466 * Return a pointer to the end of the format specifier.
 467 */
 468static char *find_specifier_end(char *input)
 469{
 470        input++;                /* Advance over %. */
 471        input = skip_flags(input);
 472        input = skip_width(input);
 473        input = skip_conversion(input);
 474        return input;
 475}
 476
 477/*
 478 * Function: compare_specifiers
 479 * Compare the format specifiers pointed to by *input1 and *input2.
 480 * Return true if they are the same, false otherwise.
 481 * Advance *input1 and *input2 so that they point to the character following
 482 * the end of the specifier.
 483 */
 484static bool compare_specifiers(char **input1, char **input2)
 485{
 486        bool same = false;
 487        char *end1 = find_specifier_end(*input1);
 488        char *end2 = find_specifier_end(*input2);
 489        size_t length1 = end1 - *input1;
 490        size_t length2 = end2 - *input2;
 491
 492        if ((length1 == length2) && !memcmp(*input1, *input2, length1))
 493                same = true;
 494
 495        *input1 = end1;
 496        *input2 = end2;
 497        return same;
 498}
 499
 500/*
 501 * Function: fmt_validate
 502 * Check that two format strings contain the same number of format specifiers,
 503 * and that the order of specifiers is the same in both strings.
 504 * Return true if the condition holds, false if it doesn't.
 505 */
 506static bool fmt_validate(char *template, char *user)
 507{
 508        bool valid = true;
 509        bool still_comparing = true;
 510        char *template_ptr = template;
 511        char *user_ptr = user;
 512
 513        while (still_comparing && valid) {
 514                template_ptr = next_specifier(template_ptr);
 515                user_ptr = next_specifier(user_ptr);
 516                if (template_ptr && user_ptr) {
 517                        /* Both have at least one more specifier. */
 518                        valid = compare_specifiers(&template_ptr, &user_ptr);
 519                } else {
 520                        /* No more format specifiers in one or both strings. */
 521                        still_comparing = false;
 522                        /* See if one has more specifiers than the other. */
 523                        if (template_ptr || user_ptr)
 524                                valid = false;
 525                }
 526        }
 527        return valid;
 528}
 529
 530/*
 531 * Function: msg_set
 532 * Description: Add a user-supplied message to the user_messages array.
 533 * The message text is copied to a memory area allocated with kmalloc.
 534 * If the function fails, then user_messages is untouched.
 535 * Arguments:
 536 * - index: a message number, as found in i18n.h.
 537 * - text:  text of message.  Not NUL-terminated.
 538 * - length: number of bytes in text.
 539 * Failure conditions:
 540 * -EINVAL -  Invalid format specifiers in formatted message or illegal index.
 541 * -ENOMEM -  Unable to allocate memory.
 542 */
 543ssize_t spk_msg_set(enum msg_index_t index, char *text, size_t length)
 544{
 545        char *newstr = NULL;
 546        unsigned long flags;
 547
 548        if ((index < MSG_FIRST_INDEX) || (index >= MSG_LAST_INDEX))
 549                return -EINVAL;
 550
 551        newstr = kmalloc(length + 1, GFP_KERNEL);
 552        if (!newstr)
 553                return -ENOMEM;
 554
 555        memcpy(newstr, text, length);
 556        newstr[length] = '\0';
 557        if (index >= MSG_FORMATTED_START &&
 558            index <= MSG_FORMATTED_END &&
 559            !fmt_validate(speakup_default_msgs[index], newstr)) {
 560                kfree(newstr);
 561                return -EINVAL;
 562        }
 563        spin_lock_irqsave(&speakup_info.spinlock, flags);
 564        if (speakup_msgs[index] != speakup_default_msgs[index])
 565                kfree(speakup_msgs[index]);
 566        speakup_msgs[index] = newstr;
 567        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 568        return 0;
 569}
 570
 571/*
 572 * Find a message group, given its name.  Return a pointer to the structure
 573 * if found, or NULL otherwise.
 574 */
 575struct msg_group_t *spk_find_msg_group(const char *group_name)
 576{
 577        struct msg_group_t *group = NULL;
 578        int i;
 579
 580        for (i = 0; i < num_groups; i++) {
 581                if (!strcmp(all_groups[i].name, group_name)) {
 582                        group = &all_groups[i];
 583                        break;
 584                }
 585        }
 586        return group;
 587}
 588
 589void spk_reset_msg_group(struct msg_group_t *group)
 590{
 591        unsigned long flags;
 592        enum msg_index_t i;
 593
 594        spin_lock_irqsave(&speakup_info.spinlock, flags);
 595
 596        for (i = group->start; i <= group->end; i++) {
 597                if (speakup_msgs[i] != speakup_default_msgs[i])
 598                        kfree(speakup_msgs[i]);
 599                speakup_msgs[i] = speakup_default_msgs[i];
 600        }
 601        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 602}
 603
 604/* Called at initialization time, to establish default messages. */
 605void spk_initialize_msgs(void)
 606{
 607        memcpy(speakup_msgs, speakup_default_msgs,
 608               sizeof(speakup_default_msgs));
 609}
 610
 611/* Free user-supplied strings when module is unloaded: */
 612void spk_free_user_msgs(void)
 613{
 614        enum msg_index_t index;
 615        unsigned long flags;
 616
 617        spin_lock_irqsave(&speakup_info.spinlock, flags);
 618        for (index = MSG_FIRST_INDEX; index < MSG_LAST_INDEX; index++) {
 619                if (speakup_msgs[index] != speakup_default_msgs[index]) {
 620                        kfree(speakup_msgs[index]);
 621                        speakup_msgs[index] = speakup_default_msgs[index];
 622                }
 623        }
 624        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 625}
 626