1 /*****************************************************************************
2 * zsh.cpp: create zsh completion rule for vlc
3 *****************************************************************************
4 * Copyright © 2005-2008 the VideoLAN team
7 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
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.
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.
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 *****************************************************************************/
30 typedef std::multimap<std::string, std::string> mumap;
31 typedef std::multimap<int, std::string> mcmap;
33 typedef std::pair<std::string, std::string> mpair;
34 typedef std::pair<int, std::string> mcpair;
40 #include <vlc_common.h>
46 #include <../src/modules/modules.h>
48 void ParseModules( mumap &mods, mcmap &mods2 );
49 void PrintModuleList( mumap &mods, mcmap &mods2 );
50 void ParseOption( module_config_t *p_item, mumap &mods, mcmap &mods2 );
51 void PrintOption( char *psz_option, char i_short, char *psz_exlusive,
52 char *psz_text, char *psz_longtext, char *psz_args );
54 int main( int i_argc, const char **ppsz_argv )
58 /* Create a libvlc structure */
60 libvlc_exception_t ex;
61 libvlc_exception_init(&ex);
63 const char *argv[i_argc + 1];
65 for( int i = 0; i < i_argc; i++ )
66 argv[i+1] = ppsz_argv[i];
67 libvlc_instance_t *p_libvlc_instance = libvlc_new(i_argc+1, argv, &ex);
69 if( !p_libvlc_instance || libvlc_exception_raised(&ex) )
71 libvlc_exception_clear(&ex);
75 printf("#compdef vlc cvlc rvlc svlc mvlc qvlc nvlc\n\n"
77 "#This file is autogenerated by zsh.cpp\n"
78 "typeset -A opt_args\n"
79 "local context state line ret=1\n"
80 "local modules\n\n" );
82 PrintModuleList( mods, mods2 );
84 printf( "_arguments -S -s \\\n" );
85 ParseModules( mods, mods2 );
86 printf( " \"(--module)-p[print help on module]:print help on module:($modules)\"\\\n" );
87 printf( " \"(-p)--module[print help on module]:print help on module:($modules)\"\\\n" );
88 printf( " \"(--help)-h[print help]\"\\\n" );
89 printf( " \"(-h)--help[print help]\"\\\n" );
90 printf( " \"(--longhelp)-H[print detailed help]\"\\\n" );
91 printf( " \"(-H)--longhelp[print detailed help]\"\\\n" );
92 printf( " \"(--list)-l[print a list of available modules]\"\\\n" );
93 printf( " \"(-l)--list[print a list of available modules]\"\\\n" );
94 printf( " \"--reset-config[reset the current config to the default values]\"\\\n" );
95 printf( " \"--config[use alternate config file]\"\\\n" );
96 printf( " \"--reset-plugins-cache[resets the current plugins cache]\"\\\n" );
97 printf( " \"--version[print version information]\"\\\n" );
98 printf( " \"*:Playlist item:->mrl\" && ret=0\n\n" );
100 printf( "case $state in\n" );
102 printf( " _alternative 'files:file:_files' 'urls:URL:_urls' && ret=0\n" );
104 printf( "esac\n\n" );
106 printf( "return ret\n" );
108 libvlc_release( p_libvlc_instance );
113 void ParseModules( mumap &mods, mcmap &mods2 )
117 module_config_t *p_item;
122 /* List the plugins */
123 p_list = module_list_get(&i_modules);
124 if( !p_list ) return;
125 for( i_index = 0; i_index < i_modules; i_index++ )
127 p_module = p_list[i_index];
129 /* Exclude empty plugins (submodules don't have config options, they
130 * are stored in the parent module) */
131 if( p_module->b_submodule )
133 // p_item = ((module_t *)p_module->p_parent)->p_config;
135 p_item = p_module->p_config;
137 // printf( " #%s\n", p_module->psz_longname );
138 if( !p_item ) continue;
142 if( p_item->i_type == CONFIG_CATEGORY )
144 // printf( " #Category %d\n", p_item->i_value );
146 else if( p_item->i_type == CONFIG_SUBCATEGORY )
148 // printf( " #Subcategory %d\n", p_item->i_value );
150 if( p_item->i_type & CONFIG_ITEM )
151 ParseOption( p_item, mods, mods2 );
153 while( i_items++ < p_module->i_config_items && p_item++ );
156 module_list_free( p_list );
159 void PrintModuleList( mumap &mods, mcmap &mods2 )
161 module_t **p_list = NULL;
167 /* List the plugins */
168 p_list = module_list_get(&i_modules);
169 if( !p_list ) return;
171 printf( "modules=\"" );
172 for( i_index = 0; i_index < i_modules; i_index++ )
174 p_module = p_list[i_index];
176 /* Exclude empty plugins (submodules don't have config options, they
177 * are stored in the parent module) */
179 if( strcmp( p_module->psz_object_name, "main" ) )
181 mods.insert( mpair( p_module->psz_capability,
182 p_module->psz_object_name ) );
183 module_config_t *p_config = p_module->p_config;
187 /* Hack: required subcategory is stored in i_min */
188 if( p_config->i_type == CONFIG_SUBCATEGORY )
190 mods2.insert( mcpair( p_config->value.i,
191 p_module->psz_object_name ) );
193 } while( i_items++ < p_module->i_config_items && p_config++ );
194 if( p_module->b_submodule )
196 printf( "%s ", p_module->psz_object_name );
201 module_list_free( p_list );
205 void ParseOption( module_config_t *p_item, mumap &mods, mcmap &mods2 )
207 char *psz_arguments = NULL;
214 #define DUP( x ) strdup( x ? x : "" )
216 //Skip deprecated options
217 if( p_item->b_removed )
220 switch( p_item->i_type )
222 case CONFIG_ITEM_MODULE:
224 std::pair<mumap::iterator, mumap::iterator> range = mods.equal_range( p_item->psz_type );
225 std::string list = (*range.first).second;
226 if( range.first != range.second )
228 while( range.first++ != range.second )
230 list = list.append( " " );
231 list = list.append( range.first->second );
233 asprintf( &psz_arguments, "(%s)", list.c_str() );
237 case CONFIG_ITEM_MODULE_CAT:
239 std::pair<mcmap::iterator, mcmap::iterator> range =
240 mods2.equal_range( p_item->min.i );
241 std::string list = (*range.first).second;
242 if( range.first != range.second )
244 while( range.first++ != range.second )
246 list = list.append( " " );
247 list = list.append( range.first->second );
249 asprintf( &psz_arguments, "(%s)", list.c_str() );
253 case CONFIG_ITEM_MODULE_LIST_CAT:
255 std::pair<mcmap::iterator, mcmap::iterator> range =
256 mods2.equal_range( p_item->min.i );
257 std::string list = "_values -s , ";
258 list = list.append( p_item->psz_name );
259 while( range.first != range.second )
261 list = list.append( " '*" );
262 list = list.append( range.first->second );
263 list = list.append( "'" );
266 psz_arguments = strdup( list.c_str() );
270 case CONFIG_ITEM_STRING:
273 int i = p_item->i_list -1;
275 if( p_item->ppsz_list_text )
276 asprintf( &psz_list, "%s\\:%s", p_item->ppsz_list[i],
277 p_item->ppsz_list_text[i] );
279 psz_list = strdup(p_item->ppsz_list[i]);
283 if( p_item->ppsz_list_text )
284 asprintf( &psz_list2, "%s\\:%s %s", p_item->ppsz_list[i-1],
285 p_item->ppsz_list_text[i-1], psz_list );
287 asprintf( &psz_list2, "%s %s", p_item->ppsz_list[i-1],
291 psz_list = psz_list2;
294 if( p_item->ppsz_list_text )
295 asprintf( &psz_arguments, "((%s))", psz_list );
297 asprintf( &psz_arguments, "(%s)", psz_list );
303 case CONFIG_ITEM_FILE:
304 psz_arguments = strdup( "_files" );
306 case CONFIG_ITEM_DIRECTORY:
307 psz_arguments = strdup( "_files -/" );
310 case CONFIG_ITEM_INTEGER:
313 int i = p_item->i_list -1;
315 if( p_item->ppsz_list_text )
316 asprintf( &psz_list, "%d\\:%s", p_item->pi_list[i],
317 p_item->ppsz_list_text[i] );
319 psz_list = strdup(p_item->ppsz_list[i]);
323 if( p_item->ppsz_list_text )
324 asprintf( &psz_list2, "%d\\:%s %s", p_item->pi_list[i-1],
325 p_item->ppsz_list_text[i-1], psz_list );
327 asprintf( &psz_list2, "%s %s", p_item->ppsz_list[i-1],
331 psz_list = psz_list2;
334 if( p_item->ppsz_list_text )
335 asprintf( &psz_arguments, "((%s))", psz_list );
337 asprintf( &psz_arguments, "(%s)", psz_list );
341 else if( p_item->min.i != 0 || p_item->max.i != 0 )
343 // p_control = new RangedIntConfigControl( p_this, p_item, parent );
347 // p_control = new IntegerConfigControl( p_this, p_item, parent );
351 case CONFIG_ITEM_KEY:
352 // p_control = new KeyConfigControl( p_this, p_item, parent );
355 case CONFIG_ITEM_FLOAT:
356 // p_control = new FloatConfigControl( p_this, p_item, parent );
359 case CONFIG_ITEM_BOOL:
360 // p_control = new BoolConfigControl( p_this, p_item, parent );
361 asprintf( &psz_exclusive, "--no%s --no-%s", p_item->psz_name,
363 psz_name = DUP( p_item->psz_name );
364 psz_text = DUP( p_item->psz_text );
365 psz_longtext = DUP( p_item->psz_longtext );
366 PrintOption( psz_name, p_item->i_short, psz_exclusive,
367 psz_text, psz_longtext, psz_arguments );
370 free( psz_longtext );
371 free( psz_exclusive );
372 asprintf( &psz_exclusive, "--no%s --%s", p_item->psz_name,
374 asprintf( &psz_option, "no-%s", p_item->psz_name );
375 psz_text = DUP( p_item->psz_text );
376 psz_longtext = DUP( p_item->psz_longtext );
377 PrintOption( psz_option, p_item->i_short, psz_exclusive,
378 psz_text, psz_longtext, psz_arguments );
380 free( psz_longtext );
381 free( psz_exclusive );
383 asprintf( &psz_exclusive, "--no-%s --%s", p_item->psz_name,
385 asprintf( &psz_option, "no%s", p_item->psz_name );
386 psz_text = DUP( p_item->psz_text );
387 psz_longtext = DUP( p_item->psz_longtext );
388 PrintOption( psz_option, p_item->i_short, psz_exclusive,
389 psz_text, psz_longtext, psz_arguments );
391 free( psz_longtext );
392 free( psz_exclusive );
397 // p_control = new SectionConfigControl( p_this, p_item, parent );
403 psz_name = DUP( p_item->psz_name );
404 psz_text = DUP( p_item->psz_text );
405 psz_longtext = DUP( p_item->psz_longtext );
406 PrintOption( psz_name, p_item->i_short, NULL,
407 psz_text, psz_longtext, psz_arguments );
410 free( psz_longtext );
411 free( psz_arguments );
414 void PrintOption( char *psz_option, char i_short, char *psz_exclusive,
415 char *psz_text, char *psz_longtext, char *psz_args )
420 while( (foo = strchr( psz_text, ':' ))) *foo=';';
421 while( (foo = strchr( psz_text, '"' ))) *foo='\'';
425 while( (foo = strchr( psz_longtext, ':' ))) *foo=';';
426 while( (foo = strchr( psz_longtext, '"' ))) *foo='\'';
429 strchr( psz_longtext, '\n' ) ||
430 strchr( psz_longtext, '(' ) ) psz_longtext = psz_text;
434 printf( " \"(-%c)--%s%s[%s]", i_short,
435 psz_option, psz_args?"=":"", psz_text );
437 printf( " \"(-%c%s)--%s%s[%s]", i_short, psz_exclusive,
438 psz_option, psz_args?"=":"", psz_text );
440 printf( ":%s:%s\"\\\n", psz_longtext, psz_args );
444 printf( " \"(--%s%s)-%c[%s]", psz_option, psz_exclusive ? psz_exclusive : "",
447 printf( ":%s:%s\"\\\n", psz_longtext, psz_args );
455 printf( " \"(%s)--%s%s[%s]", psz_exclusive, psz_option,
456 psz_args?"=":"", psz_text );
458 printf( " \"--%s[%s]", psz_option, psz_text );
461 printf( ":%s:%s\"\\\n", psz_longtext, psz_args );