File: generate_bash_completion.py

package info (click to toggle)
mrtrix3 3.0~rc3+git135-g2b8e7d0c2-3
  • links: PTS, VCS
  • area: main
  • in suites: buster, sid
  • size: 34,248 kB
  • sloc: cpp: 117,101; python: 6,472; sh: 638; makefile: 226; xml: 39; ansic: 20
file content (265 lines) | stat: -rwxr-xr-x 8,518 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
#!/usr/bin/env python
#
# Generates bash completion file for MRtrix commands
# MRtrix needs to be built prior to running this
#
# Author: Rami Tabbara
#


from __future__ import print_function
import getopt, sys, os, re, subprocess, locale

def usage():
  print ('''
Usage:	%s -m [dir_path] -c [file_path]\n
	-m, --mrtrix_commands_dir [dir path]: The directory where the mrtrix executable commands reside.
	-c, --completion_path [file path]: The generated bash completion file path.
''' % (sys.argv[0]))


def main(argv):
	try:
		opts, args = getopt.getopt(argv, "m:c:", ["mrtrix_commands_dir=", "completion_path="])
		if not opts or len(opts) != 2:
			raise getopt.GetoptError('Incorrect number of arguments') 
	except getopt.GetoptError:
		usage()
		sys.exit(2)
	
	commands_dir = ""
	completion_path = ""
	commands = []

	for opt, arg in opts:
		if opt in ("-m", "--mrtrix_commands_dir"):
			commands_dir = arg
		elif opt in ("-c", "--completion_path"):
			completion_path = arg
	
	if not commands_dir or not os.path.isdir (commands_dir) or not completion_path:
		usage()
		sys.exit (2)
	
	# Filter out any non executable files or debug commands
	commands = [comm for comm in os.listdir (commands_dir) if os.access ( os.path.join( commands_dir, comm ), os.X_OK) and not re.match (r'^\w+__debug', comm)]

	if not commands:
		sys.exit (0)
	
	parse_commands (commands_dir, completion_path, commands)




###########################################################################
#                         PARSE FUNCTION
###########################################################################


def parse_commands (commands_dir, completion_path, commands):
		
	completion_file = open (completion_path, 'w+')
		
###########################################################################
#                         INNER PARSE FUNCTIONS
###########################################################################

	def flush_option_num_args ():
		if not current_option:
			print ('\t_%s_max_num_args() { echo %s; }\n' % (command, current_num_of_option_args), file = completion_file)
		else:					
			print ('\t_%s_%s_max_num_args() { echo %s; }\n' % (command, current_option, current_num_of_option_args), file = completion_file)
	
	def flush_option_arg ():
		if not current_option:		
			print ('\t_%s_arg_%s()' % (command, current_num_of_option_args), file = completion_file)
		else:
			print ('\t_%s_%s_arg_%s()' % (command, current_option, current_num_of_option_args), file = completion_file)

		print ('\t{ echo "%s"; }\n' % (current_arg_choices) , file = completion_file)

	def	flush_option_arg_allows_multiple ():
		if not current_option:	
			print ('\t_%s_arg_%s_allows_multiple()' %  (command, current_num_of_option_args), file = completion_file)
		else:
			print ('\t_%s_%s_arg_%s_allows_multiple()' % (command, current_option, current_num_of_option_args), file = completion_file)
		
		print ('\t{ echo %s; }\n' % (current_arg_allows_multiple), file = completion_file)
	
	def parse_option_arg_choices (arg_type, choices = []):
		arg_choices = ""

		if arg_type == 'CHOICE':
			for choice in choices:
				choice = choice.rstrip ()
				# End of choice lists are generally delimited by -1
				# however tckgen choices are delimited by 2 (?)
				if choice in ['-1', '2']:
					break;
				else:
					arg_choices +=  " " + choice
		elif arg_type == 'IMAGEIN':
			arg_choices ='`eval ls $1*.{mih,mif,nii,dcm,msf,hdr,mgh,nii.gz,mif.gz} 2> /dev/null | tr "\n" " "``eval ls -d $1*/ 2> /dev/null | tr "\n" " "`'
		elif arg_type == 'FILEIN':
			arg_choices ='`eval ls "$1*" 2> /dev/null | grep -E "$1*\.[^[:space:]]+"``eval ls -d $1*/ 2> /dev/null | tr "\n" " "`'
		elif arg_type == 'TRACKSIN':
			arg_choices ='`eval ls $1*.tck 2> /dev/null | tr "\n" " "``eval ls -d $1*/ 2> /dev/null | tr "\n" " "`'
		#elif arg_type in ['FLOAT', 'INT']:
		else:
			arg_choices = "__empty__"
		

		return arg_choices


###########################################################################
#                          IS_SCRIPT FUNCTION
###########################################################################
	def is_script (command):
		textchars = bytearray({7,8,9,10,12,13,27} | set(range(0x20, 0x100)) - {0x7f})
		with open(os.path.join(commands_dir, command), "rb") as f:
			bytes = f.read(1024)
		return not bytes.translate(None, textchars)

	
###########################################################################
#                         END INTERNAL FUNCTIONS
###########################################################################

	encoding = locale.getdefaultlocale()[1]

	for command in sorted(commands):

		if is_script(command):
			continue

		single_dash_options = ""
		double_dash_options = ""
		current_option = ""
		current_num_of_option_args = 0
		current_arg = ""
		current_arg_optional = -1
		current_arg_allows_multiple = -1
		current_arg_type = ""
		current_arg_choices = ""			

		try:
			process = subprocess.Popen ([ os.path.join( commands_dir, command ), '__print_full_usage__'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)

			print ('''
_%s()
{ 
''' % (command), file = completion_file)

			for line in process.stdout:
				words = line.decode(encoding).split (' ')
				
				if not words:
					continue				
				
				if words[0] == 'OPTION':
					flush_option_num_args ()
					current_arg = ""
					current_arg_type = ""
					current_option = words[1]
					single_dash_options += ' -' + current_option
					double_dash_options += ' --' + current_option
					current_num_of_option_args = 0
				elif words[0] == 'ARGUMENT':
					current_arg = words[1]
					current_arg_optional = words[2] 
					current_arg_allows_multiple = words[3]
					current_arg_type = words[4].rstrip ()
					current_arg_choices = parse_option_arg_choices (current_arg_type, words[5:])
					flush_option_arg_allows_multiple ()
					flush_option_arg ()
					current_num_of_option_args += 1

			flush_option_num_args ()

			print ('''
	current_option=""
	current_max_args=0
	current_arg_index=0;
	consumed_option_tokens=0;
	current_num_consumed_option_args=0;
	first_option_consumed=0;

	COMPREPLY=();
	cur="${COMP_WORDS[COMP_CWORD]}";
	cur_filtered=`echo "${COMP_WORDS[COMP_CWORD]}" | sed 's/\..*$//g'`;

	if [[ "$cur" == --* ]]; then
		COMPREPLY=( $( compgen -W "%s" -- "$cur" ) );
	elif [[ "$cur" == -* ]]; then
		COMPREPLY=( $( compgen -W "%s" -- "$cur" ) );
	else
		current_option=""
		word=""	
		array=""	

		for ((i=${#COMP_WORDS[@]}-2; i>=0; i--)); do
  			word="${COMP_WORDS[$i]}"
			if [[ "$word" == -* ]]; then
				option=$(echo $word | sed -E "s/-//g");
				if [[ ${#option} == 0 ]]; then
					continue; 
				fi
				arg_index=$(( $COMP_CWORD - $i - 1));
				max_args=$(_%s_${option}_max_num_args);
				
				current_num_consumed_option_args=$((current_num_consumed_option_args > max_args ? max_args : current_num_consumed_option_args))
				consumed_option_tokens=$(($current_consumed_option_tokens + $current_num_consumed_option_args + 1))
				current_num_consumed_option_args=0;
				
				if (( first_option_consumed == 0 )); then
					current_option="$option";
					current_arg_index=$arg_index;
					current_max_args=$max_args;
					first_option_consumed=1;
				fi
				
			else
				current_num_consumed_option_args=$(($current_num_option_args + 1));
			fi
		done

		if [[ "$current_option" != "" ]] && (( $current_arg_index >= 0 && $current_arg_index < $current_max_args )); then
			array=`_%s_${current_option}_arg_${current_arg_index} $cur_filtered`
		else
			current_arg_index=$(($COMP_CWORD - $consumed_option_tokens - 1));		
			current_max_args=$(_%s_max_num_args);

			# Check whether any of our arguments accepts multiple inputs
			# If so, adjust the argument index to be the min. of these
			for ((i=${current_max_args} - 1; i>=0; i--)); do
				if (( $(_%s_arg_${i}_allows_multiple) == 1 )); then
					current_arg_index=$((current_arg_index > i ? i : current_arg_index))
				fi
			done

			if (( $current_arg_index >= 0 && $current_arg_index < $current_max_args )); then
				array=`_%s_arg_${current_arg_index} $cur_filtered`;
			fi
		fi

		if [[ "$array" == "__empty__" ]]; then
			COMPREPLY=()
			compopt +o default %s;
		else
			mapfile -t COMPREPLY < <( compgen -W "$array" -- "$cur" )
			compopt -o default %s;
		fi
	fi
}
complete -F _%s %s \n''' % (double_dash_options, single_dash_options, command, command, command, command, command, command, command, command, command), file = completion_file)

		except:
			pass

	completion_file.close ()


if __name__ == "__main__":
	main(sys.argv[1:])