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