6c411f23ed9308c07c889b69aac826845a45c6b9
[vlc.git] / src / config / file.c
1 /*****************************************************************************
2  * file.c: configuration file handling
3  *****************************************************************************
4  * Copyright (C) 2001-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <vlc_common.h>
29 #include "../libvlc.h"
30 #include "vlc_charset.h"
31 #include "vlc_keys.h"
32
33 #include <errno.h>                                                  /* errno */
34 #include <assert.h>
35 #include <limits.h>
36 #include <fcntl.h>
37 #include <sys/stat.h>
38 #ifdef __APPLE__
39 #   include <xlocale.h>
40 #else
41 #include <locale.h>
42 #endif
43
44 #include "configuration.h"
45 #include "modules/modules.h"
46
47 static char *ConfigKeyToString( int );
48
49 static inline char *strdupnull (const char *src)
50 {
51     return src ? strdup (src) : NULL;
52 }
53
54 /**
55  * Get the user's configuration file
56  */
57 static char *config_GetConfigFile( vlc_object_t *obj )
58 {
59     char *psz_file = config_GetPsz( obj, "config" );
60     if( psz_file == NULL )
61     {
62         char *psz_dir = config_GetUserConfDir();
63
64         if( asprintf( &psz_file, "%s" DIR_SEP CONFIG_FILE, psz_dir ) == -1 )
65             psz_file = NULL;
66         free( psz_dir );
67     }
68     return psz_file;
69 }
70
71 static FILE *config_OpenConfigFile( vlc_object_t *p_obj )
72 {
73     char *psz_filename = config_GetConfigFile( p_obj );
74     if( psz_filename == NULL )
75         return NULL;
76
77     msg_Dbg( p_obj, "opening config file (%s)", psz_filename );
78
79     FILE *p_stream = utf8_fopen( psz_filename, "rt" );
80     if( p_stream == NULL && errno != ENOENT )
81     {
82         msg_Err( p_obj, "cannot open config file (%s): %m",
83                  psz_filename );
84
85     }
86 #if !( defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS) )
87     else if( p_stream == NULL && errno == ENOENT )
88     {
89         /* This is the fallback for pre XDG Base Directory
90          * Specification configs */
91         char *psz_old;
92         if( asprintf( &psz_old, "%s" DIR_SEP CONFIG_DIR DIR_SEP CONFIG_FILE,
93                       config_GetHomeDir() ) != -1 )
94         {
95             p_stream = utf8_fopen( psz_old, "rt" );
96             if( p_stream )
97             {
98                 /* Old config file found. We want to write it at the
99                  * new location now. */
100                 msg_Info( p_obj->p_libvlc, "Found old config file at %s. "
101                           "VLC will now use %s.", psz_old, psz_filename );
102                 char *psz_readme;
103                 if( asprintf(&psz_readme,"%s"DIR_SEP CONFIG_DIR DIR_SEP"README",
104                               config_GetHomeDir() ) != -1 )
105                 {
106                     FILE *p_readme = utf8_fopen( psz_readme, "wt" );
107                     if( p_readme )
108                     {
109                         fprintf( p_readme, "The VLC media player "
110                                  "configuration folder has moved to comply\n"
111                                  "with the XDG Base Directory Specification "
112                                  "version 0.6. Your\nconfiguration has been "
113                                  "copied to the new location:\n%s\nYou can "
114                                  "delete this directory and all its contents.",
115                                   psz_filename);
116                         fclose( p_readme );
117                     }
118                     free( psz_readme );
119                 }
120             }
121             free( psz_old );
122         }
123     }
124 #endif
125     free( psz_filename );
126     return p_stream;
127 }
128
129
130 static int strtoi (const char *str)
131 {
132     char *end;
133     long l;
134
135     errno = 0;
136     l = strtol (str, &end, 0);
137
138     if (!errno)
139     {
140         if ((l > INT_MAX) || (l < INT_MIN))
141             errno = ERANGE;
142         if (*end)
143             errno = EINVAL;
144     }
145     return (int)l;
146 }
147
148
149 /*****************************************************************************
150  * config_LoadConfigFile: loads the configuration file.
151  *****************************************************************************
152  * This function is called to load the config options stored in the config
153  * file.
154  *****************************************************************************/
155 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
156 {
157     FILE *file;
158
159     file = config_OpenConfigFile (p_this);
160     if (file == NULL)
161         return VLC_EGENERIC;
162
163     /* Look for the selected module, if NULL then save everything */
164     module_t **list = module_list_get (NULL);
165
166     /* Look for UTF-8 Byte Order Mark */
167     char * (*convert) (const char *) = strdupnull;
168     char bom[3];
169
170     if ((fread (bom, 1, 3, file) != 3)
171      || memcmp (bom, "\xEF\xBB\xBF", 3))
172     {
173         convert = FromLocaleDup;
174         rewind (file); /* no BOM, rewind */
175     }
176
177     module_t *module = NULL;
178     char line[1024], section[1022];
179     section[0] = '\0';
180
181     /* Ensure consistent number formatting... */
182     locale_t loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
183     locale_t baseloc = uselocale (loc);
184
185     while (fgets (line, 1024, file) != NULL)
186     {
187         /* Ignore comments and empty lines */
188         switch (line[0])
189         {
190             case '#':
191             case '\n':
192             case '\0':
193                 continue;
194         }
195
196         if (line[0] == '[')
197         {
198             char *ptr = strchr (line, ']');
199             if (ptr == NULL)
200                 continue; /* syntax error; */
201             *ptr = '\0';
202
203             /* New section ( = a given module) */
204             strcpy (section, line + 1);
205             module = NULL;
206
207             if ((psz_module_name == NULL)
208              || (strcmp (psz_module_name, section) == 0))
209             {
210                 for (int i = 0; list[i]; i++)
211                 {
212                     module_t *m = list[i];
213
214                     if ((strcmp (section, m->psz_object_name) == 0)
215                      && (m->i_config_items > 0)) /* ignore config-less modules */
216                     {
217                         module = m;
218                         if (psz_module_name != NULL)
219                             msg_Dbg (p_this,
220                                      "loading config for module \"%s\"",
221                                      section);
222                         break;
223                     }
224                 }
225             }
226
227             continue;
228         }
229
230         if (module == NULL)
231             continue; /* no need to parse if there is no matching module */
232
233         char *ptr = strchr (line, '\n');
234         if (ptr != NULL)
235             *ptr = '\0';
236
237         /* look for option name */
238         const char *psz_option_name = line;
239
240         ptr = strchr (line, '=');
241         if (ptr == NULL)
242             continue; /* syntax error */
243
244         *ptr = '\0';
245         const char *psz_option_value = ptr + 1;
246
247         /* try to match this option with one of the module's options */
248         for (size_t i = 0; i < module->confsize; i++)
249         {
250             module_config_t *p_item = module->p_config + i;
251
252             if ((p_item->i_type & CONFIG_HINT)
253              || strcmp (p_item->psz_name, psz_option_name))
254                 continue;
255
256             /* We found it */
257             errno = 0;
258
259             vlc_mutex_lock( p_item->p_lock );
260             switch( p_item->i_type )
261             {
262                 case CONFIG_ITEM_BOOL:
263                 case CONFIG_ITEM_INTEGER:
264                 {
265                     long l = strtoi (psz_option_value);
266                     if (errno)
267                         msg_Warn (p_this, "Integer value (%s) for %s: %m",
268                                   psz_option_value, psz_option_name);
269                     else
270                         p_item->saved.i = p_item->value.i = (int)l;
271                     break;
272                 }
273
274                 case CONFIG_ITEM_FLOAT:
275                     if( !*psz_option_value )
276                         break;                    /* ignore empty option */
277                     p_item->value.f = (float)atof (psz_option_value);
278                     p_item->saved.f = p_item->value.f;
279                     break;
280
281                 case CONFIG_ITEM_KEY:
282                     if( !*psz_option_value )
283                         break;                    /* ignore empty option */
284                     p_item->value.i = ConfigStringToKey(psz_option_value);
285                     p_item->saved.i = p_item->value.i;
286                     break;
287
288                 default:
289                     /* free old string */
290                     free( (char*) p_item->value.psz );
291                     free( (char*) p_item->saved.psz );
292
293                     p_item->value.psz = convert (psz_option_value);
294                     p_item->saved.psz = strdupnull (p_item->value.psz);
295                     break;
296             }
297             vlc_mutex_unlock( p_item->p_lock );
298             break;
299         }
300     }
301
302     if (ferror (file))
303     {
304         msg_Err (p_this, "error reading configuration: %m");
305         clearerr (file);
306     }
307     fclose (file);
308
309     module_list_free (list);
310     if (loc != (locale_t)0)
311     {
312         uselocale (baseloc);
313         freelocale (loc);
314     }
315     return 0;
316 }
317
318 /*****************************************************************************
319  * config_CreateDir: Create configuration directory if it doesn't exist.
320  *****************************************************************************/
321 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
322 {
323     if( !psz_dirname || !*psz_dirname ) return -1;
324
325     if( utf8_mkdir( psz_dirname, 0700 ) == 0 )
326         return 0;
327
328     switch( errno )
329     {
330         case EEXIST:
331             return 0;
332
333         case ENOENT:
334         {
335             /* Let's try to create the parent directory */
336             char psz_parent[strlen( psz_dirname ) + 1], *psz_end;
337             strcpy( psz_parent, psz_dirname );
338
339             psz_end = strrchr( psz_parent, DIR_SEP_CHAR );
340             if( psz_end && psz_end != psz_parent )
341             {
342                 *psz_end = '\0';
343                 if( config_CreateDir( p_this, psz_parent ) == 0 )
344                 {
345                     if( !utf8_mkdir( psz_dirname, 0700 ) )
346                         return 0;
347                 }
348             }
349         }
350     }
351
352     msg_Err( p_this, "could not create %s: %m", psz_dirname );
353     return -1;
354 }
355
356 static int
357 config_Write (FILE *file, const char *type, const char *desc,
358               bool comment, const char *name, const char *fmt, ...)
359 {
360     va_list ap;
361     int ret;
362
363     if (desc == NULL)
364         desc = "?";
365
366     if (fprintf (file, "# %s (%s)\n%s%s=", desc, vlc_gettext (type),
367                  comment ? "#" : "", name) < 0)
368         return -1;
369
370     va_start (ap, fmt);
371     ret = vfprintf (file, fmt, ap);
372     va_end (ap);
373     if (ret < 0)
374         return -1;
375
376     if (fputs ("\n\n", file) == EOF)
377         return -1;
378     return 0;
379 }
380
381
382 static int config_PrepareDir (vlc_object_t *obj)
383 {
384     char *psz_configdir = config_GetUserConfDir ();
385     if (psz_configdir == NULL) /* XXX: This should never happen */
386         return -1;
387
388     int ret = config_CreateDir (obj, psz_configdir);
389     free (psz_configdir);
390     return ret;
391 }
392
393 /*****************************************************************************
394  * config_SaveConfigFile: Save a module's config options.
395  *****************************************************************************
396  * This will save the specified module's config options to the config file.
397  * If psz_module_name is NULL then we save all the modules config options.
398  * It's no use to save the config options that kept their default values, so
399  * we'll try to be a bit clever here.
400  *
401  * When we save we mustn't delete the config options of the modules that
402  * haven't been loaded. So we cannot just create a new config file with the
403  * config structures we've got in memory.
404  * I don't really know how to deal with this nicely, so I will use a completly
405  * dumb method ;-)
406  * I will load the config file in memory, but skipping all the sections of the
407  * modules we want to save. Then I will create a brand new file, dump the file
408  * loaded in memory and then append the sections of the modules we want to
409  * save.
410  * Really stupid no ?
411  *****************************************************************************/
412 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
413                            bool b_autosave )
414 {
415     module_t *p_parser;
416     FILE *file = NULL;
417     char *permanent = NULL, *temporary = NULL;
418     char p_line[1024], *p_index2;
419     unsigned long i_sizebuf = 0;
420     char *p_bigbuffer = NULL, *p_index;
421     bool b_backup;
422     int i_index;
423
424     if( config_PrepareDir( p_this ) )
425     {
426         msg_Err( p_this, "no configuration directory" );
427         goto error;
428     }
429
430     file = config_OpenConfigFile( p_this );
431     if( file != NULL )
432     {
433         /* look for file size */
434         fseek( file, 0L, SEEK_END );
435         i_sizebuf = ftell( file );
436         fseek( file, 0L, SEEK_SET );
437         if( i_sizebuf >= LONG_MAX )
438             i_sizebuf = 0;
439     }
440
441     p_bigbuffer = p_index = malloc( i_sizebuf+1 );
442     if( !p_bigbuffer )
443         goto error;
444     p_bigbuffer[0] = 0;
445
446     /* List all available modules */
447     module_t **list = module_list_get (NULL);
448
449     /* backup file into memory, we only need to backup the sections we won't
450      * save later on */
451     b_backup = false;
452     while( file && fgets( p_line, 1024, file ) )
453     {
454         if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
455         {
456
457             /* we found a section, check if we need to do a backup */
458             for( i_index = 0; (p_parser = list[i_index]) != NULL; i_index++ )
459             {
460                 if( ((p_index2 - &p_line[1])
461                        == (int)strlen(p_parser->psz_object_name) )
462                     && !memcmp( &p_line[1], p_parser->psz_object_name,
463                                 strlen(p_parser->psz_object_name) ) )
464                 {
465                     if( !psz_module_name )
466                         break;
467                     else if( !strcmp( psz_module_name,
468                                       p_parser->psz_object_name ) )
469                         break;
470                 }
471             }
472
473             if( list[i_index] == NULL )
474             {
475                 /* we don't have this section in our list so we need to back
476                  * it up */
477                 *p_index2 = 0;
478 #if 0
479                 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
480                                  &p_line[1] );
481 #endif
482                 *p_index2 = ']';
483
484                 b_backup = true;
485             }
486             else
487             {
488                 b_backup = false;
489             }
490         }
491
492         /* save line if requested and line is valid (doesn't begin with a
493          * space, tab, or eol) */
494         if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
495             && (p_line[0] != '\t') )
496         {
497             strcpy( p_index, p_line );
498             p_index += strlen( p_line );
499         }
500     }
501     if( file )
502         fclose( file );
503     file = NULL;
504
505     /*
506      * Save module config in file
507      */
508     permanent = config_GetConfigFile (p_this);
509     if (!permanent)
510     {
511         module_list_free (list);
512         goto error;
513     }
514
515     if (asprintf (&temporary, "%s.%u", permanent,
516 #ifdef UNDER_CE
517                   GetCurrentProcessId ()
518 #else
519                   getpid ()
520 #endif
521                  ) == -1)
522     {
523         temporary = NULL;
524         module_list_free (list);
525         goto error;
526     }
527
528     /* The temporary configuration file is per-PID. Therefore SaveConfigFile()
529      * should be serialized against itself within a given process. */
530     static vlc_mutex_t lock = VLC_STATIC_MUTEX;
531     vlc_mutex_lock (&lock);
532
533     int fd = utf8_open (temporary, O_CREAT|O_WRONLY|O_TRUNC, S_IRUSR|S_IWUSR);
534     if (fd == -1)
535     {
536         vlc_mutex_unlock (&lock);
537         module_list_free (list);
538         goto error;
539     }
540     file = fdopen (fd, "wt");
541     if (file == NULL)
542     {
543         close (fd);
544         vlc_mutex_unlock (&lock);
545         module_list_free (list);
546         goto error;
547     }
548
549     fprintf( file, "\xEF\xBB\xBF###\n###  " COPYRIGHT_MESSAGE "\n###\n\n"
550        "###\n### lines beginning with a '#' character are comments\n###\n\n" );
551
552     /* Ensure consistent number formatting... */
553     locale_t loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
554     locale_t baseloc = uselocale (loc);
555
556     /* Look for the selected module, if NULL then save everything */
557     for( i_index = 0; (p_parser = list[i_index]) != NULL; i_index++ )
558     {
559         module_config_t *p_item, *p_end;
560
561         if( psz_module_name && strcmp( psz_module_name,
562                                        p_parser->psz_object_name ) )
563             continue;
564
565         if( !p_parser->i_config_items )
566             continue;
567
568         if( psz_module_name )
569             msg_Dbg( p_this, "saving config for module \"%s\"",
570                      p_parser->psz_object_name );
571
572         fprintf( file, "[%s]", p_parser->psz_object_name );
573         if( p_parser->psz_longname )
574             fprintf( file, " # %s\n\n", p_parser->psz_longname );
575         else
576             fprintf( file, "\n\n" );
577
578         for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
579              p_item < p_end;
580              p_item++ )
581         {
582             if ((p_item->i_type & CONFIG_HINT) /* ignore hint */
583              || p_item->b_removed              /* ignore deprecated option */
584              || p_item->b_unsaveable)          /* ignore volatile option */
585                 continue;
586
587             vlc_mutex_lock (p_item->p_lock);
588
589             /* Do not save the new value in the configuration file
590              * if doing an autosave, and the item is not an "autosaved" one. */
591             bool b_retain = b_autosave && !p_item->b_autosave;
592
593             if (IsConfigIntegerType (p_item->i_type))
594             {
595                 int val = b_retain ? p_item->saved.i : p_item->value.i;
596                 if (p_item->i_type == CONFIG_ITEM_KEY)
597                 {
598                     char *psz_key = ConfigKeyToString (val);
599                     config_Write (file, p_item->psz_text, N_("key"),
600                                   val == p_item->orig.i,
601                                   p_item->psz_name, "%s",
602                                   psz_key ? psz_key : "");
603                     free (psz_key);
604                 }
605                 else
606                     config_Write (file, p_item->psz_text,
607                                   (p_item->i_type == CONFIG_ITEM_BOOL)
608                                       ? N_("boolean") : N_("integer"),
609                                   val == p_item->orig.i,
610                                   p_item->psz_name, "%d", val);
611                 p_item->saved.i = val;
612             }
613             else
614             if (IsConfigFloatType (p_item->i_type))
615             {
616                 float val = b_retain ? p_item->saved.f : p_item->value.f;
617                 config_Write (file, p_item->psz_text, N_("float"),
618                               val == p_item->orig.f,
619                               p_item->psz_name, "%f", val);
620                 p_item->saved.f = val;
621             }
622             else
623             {
624                 const char *psz_value = b_retain ? p_item->saved.psz
625                                                  : p_item->value.psz;
626                 bool modified;
627
628                 assert (IsConfigStringType (p_item->i_type));
629
630                 if (b_retain && (psz_value == NULL)) /* FIXME: hack */
631                     psz_value = p_item->orig.psz;
632
633                 modified =
634                     (psz_value != NULL)
635                         ? ((p_item->orig.psz != NULL)
636                             ? (strcmp (psz_value, p_item->orig.psz) != 0)
637                             : true)
638                         : (p_item->orig.psz != NULL);
639
640                 config_Write (file, p_item->psz_text, N_("string"),
641                               !modified, p_item->psz_name, "%s",
642                               psz_value ? psz_value : "");
643
644                 if ( !b_retain )
645                 {
646
647                     free ((char *)p_item->saved.psz);
648                     if( (psz_value && p_item->orig.psz &&
649                          strcmp( psz_value, p_item->orig.psz )) ||
650                         !psz_value || !p_item->orig.psz)
651                         p_item->saved.psz = strdupnull (psz_value);
652                     else
653                         p_item->saved.psz = NULL;
654                 }
655             }
656
657             if (!b_retain)
658                 p_item->b_dirty = false;
659             vlc_mutex_unlock (p_item->p_lock);
660         }
661     }
662
663     module_list_free (list);
664     if (loc != (locale_t)0)
665     {
666         uselocale (baseloc);
667         freelocale (loc);
668     }
669
670     /*
671      * Restore old settings from the config in file
672      */
673     fputs( p_bigbuffer, file );
674     free( p_bigbuffer );
675
676     /*
677      * Flush to disk and replace atomically
678      */
679     fflush (file); /* Flush from run-time */
680 #ifndef WIN32
681     fdatasync (fd); /* Flush from OS */
682     /* Atomically replace the file... */
683     utf8_rename (temporary, permanent);
684     /* (...then synchronize the directory, err, TODO...) */
685     /* ...and finally close the file */
686     vlc_mutex_unlock (&lock);
687 #endif
688     fclose (file);
689 #ifdef WIN32
690     /* Windows cannot remove open files nor overwrite existing ones */
691     utf8_unlink (permanent);
692     utf8_rename (temporary, permanent);
693     vlc_mutex_unlock (&lock);
694 #endif
695
696     free (temporary);
697     free (permanent);
698     return 0;
699
700 error:
701     if( file )
702         fclose( file );
703     free (temporary);
704     free (permanent);
705     free( p_bigbuffer );
706     return -1;
707 }
708
709 int config_AutoSaveConfigFile( vlc_object_t *p_this )
710 {
711     size_t i_index;
712     bool save = false;
713
714     assert( p_this );
715
716     /* Check if there's anything to save */
717     module_t **list = module_list_get (NULL);
718     for( i_index = 0; list[i_index] && !save; i_index++ )
719     {
720         module_t *p_parser = list[i_index];
721         module_config_t *p_item, *p_end;
722
723         if( !p_parser->i_config_items ) continue;
724
725         for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
726              p_item < p_end && !save;
727              p_item++ )
728         {
729             vlc_mutex_lock (p_item->p_lock);
730             save = p_item->b_autosave && p_item->b_dirty;
731             vlc_mutex_unlock (p_item->p_lock);
732         }
733     }
734     module_list_free (list);
735
736     return save ? VLC_SUCCESS : SaveConfigFile( p_this, NULL, true );
737 }
738
739 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
740 {
741     return SaveConfigFile( p_this, psz_module_name, false );
742 }
743
744 int ConfigStringToKey( const char *psz_key )
745 {
746     int i_key = 0;
747     unsigned int i;
748     const char *psz_parser = strchr( psz_key, '-' );
749     while( psz_parser && psz_parser != psz_key )
750     {
751         for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
752         {
753             if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
754                               strlen( vlc_modifiers[i].psz_key_string ) ) )
755             {
756                 i_key |= vlc_modifiers[i].i_key_code;
757             }
758         }
759         psz_key = psz_parser + 1;
760         psz_parser = strchr( psz_key, '-' );
761     }
762     for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
763     {
764         if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
765         {
766             i_key |= vlc_keys[i].i_key_code;
767             break;
768         }
769     }
770     return i_key;
771 }
772
773 char *ConfigKeyToString( int i_key )
774 {
775     char *psz_key = malloc( 100 );
776     char *p;
777     size_t index;
778
779     if ( !psz_key )
780     {
781         return NULL;
782     }
783     *psz_key = '\0';
784     p = psz_key;
785
786     for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
787          index++ )
788     {
789         if( i_key & vlc_modifiers[index].i_key_code )
790         {
791             p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
792         }
793     }
794     for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
795          index++)
796     {
797         if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
798         {
799             p += sprintf( p, "%s", vlc_keys[index].psz_key_string );
800             break;
801         }
802     }
803     return psz_key;
804 }
805