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
|
'''Classes for including functions in the generation process.'''
from . import cli
from . import shell
from . import preprocessor
from .str_utils import indent
# pylint: disable=too-few-public-methods
class FunctionBase:
'''Base class for functions.'''
def __init__(self, funcname, code):
self.funcname = funcname
self.code = code.strip()
def get_code(self):
'''Return the whole function.'''
raise NotImplementedError
class ShellFunction(FunctionBase):
'''Class for generating Bash and Zsh functions.'''
def get_code(self, funcname=None, defines=frozenset()):
if funcname is None:
funcname = self.funcname
code = self.code.replace('%FUNCNAME%', funcname)
code = preprocessor.preprocess(code, defines)
code = preprocessor.strip_double_empty_lines(code)
r = '%s() {\n' % funcname
r += '%s\n' % indent(code, 2).rstrip()
r += '}'
return r
class FishFunction(FunctionBase):
'''Class for generating Fish functions.'''
def get_code(self, funcname=None, defines=frozenset()):
if funcname is None:
funcname = self.funcname
code = self.code.replace('%FUNCNAME%', funcname)
code = preprocessor.preprocess(code, defines)
code = preprocessor.strip_double_empty_lines(code)
r = 'function %s\n' % funcname
r += '%s\n' % indent(code, 2).rstrip()
r += 'end'
return r
def make_completion_funcname_for_context(ctxt):
'''TODO.'''
commandlines = ctxt.commandline.get_parents(include_self=True)
del commandlines[0]
funcname = shell.make_identifier('_'.join(p.prog for p in commandlines))
if isinstance(ctxt.option, cli.Option):
return '%s_%s' % (funcname, ctxt.option.option_strings[0])
if isinstance(ctxt.option, cli.Positional):
return '%s_%s' % (funcname, shell.make_identifier(ctxt.option.metavar))
raise AssertionError('make_completion_funcname_for_context: Should not be reached')
class GeneralHelpers:
'''Class for including functions in the generation process.'''
def __init__(self, function_prefix, function_class):
self.function_prefix = function_prefix
self.function_class = function_class
# Dynamic functions
self.dynamic_functions_code_to_funcname = {}
# Builtin functins
self.functions = {}
self.used_functions = {} # funcname:set(defines)
self.global_defines = set()
# =========================================================================
# Dynamic functions
# =========================================================================
def add_dynamic_func(self, ctxt, code):
'''Add dynamically generated function.'''
try:
return self.dynamic_functions_code_to_funcname[code]
except KeyError:
funcname = self.get_dynamic_funcname(ctxt)
self.dynamic_functions_code_to_funcname[code] = funcname
return funcname
def get_dynamic_funcname(self, ctxt):
'''Return a unique function name for `ctxt`.'''
funcname = make_completion_funcname_for_context(ctxt)
funcname = '_%s__%s' % (self.function_prefix, funcname)
num = 0
funcname_plus_num = funcname
while funcname_plus_num in self.dynamic_functions_code_to_funcname.values():
funcname_plus_num = '%s%d' % (funcname, num)
num += 1
return funcname_plus_num
def get_all_dynamic_functions(self):
'''Return a list of code for all dynamically defined functions.'''
r = []
for code, funcname in self.dynamic_functions_code_to_funcname.items():
r.append(self.function_class(funcname, code).get_code())
return r
# =========================================================================
# Builtin functions
# =========================================================================
def add_function(self, function):
'''Add a function to the function repository.'''
assert isinstance(function, FunctionBase), \
"GeneralHelpers.add_function: function: expected FunctionBase, got %r" % function
self.functions[function.funcname] = function
def define(self, name):
'''Define a macro on global scope.'''
self.global_defines.add(name)
def use_function(self, function_name, *defines):
'''Use a function from the function repository.'''
if function_name not in self.functions:
raise KeyError('No such function: %r' % function_name)
if function_name not in self.used_functions:
self.used_functions[function_name] = set(defines)
else:
self.used_functions[function_name].update(defines)
return self.get_real_function_name(function_name)
def get_real_function_name(self, function_name):
'''Return the function name with its prefix.'''
return '_%s__%s' % (self.function_prefix, function_name)
def is_used(self, function_name):
'''Check if a function is used.'''
return function_name in self.used_functions
def get_used_functions_code(self):
'''Return a list of code for all used functions.'''
r = []
for funcname, defines in self.used_functions.items():
r.append(self.functions[funcname].get_code(
self.get_real_function_name(funcname), self.global_defines | defines))
r.extend(self.get_all_dynamic_functions())
return r
|