#@PydevCodeAnalysisIgnore
from org.python.pydev.editor.templates import PyTemplateVariableResolver

#===================================================================================================
# CallableTemplateVariableResolver
#===================================================================================================
class CallableTemplateVariableResolver(PyTemplateVariableResolver):
    
    
    def __init__(self, variable, description, callable):
        PyTemplateVariableResolver.__init__(self, variable, description)
        self._callable = callable
        
    def asList(self, v):
        if type(v) != type([]):
            v = [v]
        return v
    
    def resolveAll(self, context):
        ret = self._callable(context)
        
        if ret is None:
            ret = '' #This is a safeguard.
        
        return self.asList(ret)


#===================================================================================================
# AddTemplateVariable
#===================================================================================================
def AddTemplateVariable(py_context_type, variable, description, evaluate_callback):
    '''
    @param py_context_type: org.python.pydev.editor.templates.PyContextType
        This is the context type where the variable should be added.
    
    @param variable: str
        The variable we're adding so that when the user uses ${variable} it will resolve it.
    
    @param description: str
        Description for the variable
    
    @param evaluate_callback: callable(context, editor)->str
        Where context is org.python.pydev.editor.codecompletion.templates.PyDocumentTemplateContext,
        editor is org.python.pydev.editor.PyEdit
        and it should return a string that will be put in the document.
    '''
    py_context_type.addResolver(
        CallableTemplateVariableResolver(variable, description, evaluate_callback))