def act(context, default=None, undo_name=None, **syntaxes):
'''
Required action method
default parameter is not a snippet, but should contain the
$SELECTED_TEXT placeholder
'''
# Get the selected ranges
ranges = tea.get_ranges(context)
if len(ranges) is 1:
# Since we've only got one selection we can use a snippet
range = ranges[0]
insertion = tea.select_from_zones(context, range, default, **syntaxes)
# Make sure the range is actually a selection
if range.length > 0:
text = tea.get_selection(context, range)
snippet = '${1:' + insertion.replace('$SELECTED_TEXT',
'${2:$SELECTED_TEXT}') + '}$0'
else:
# Not a selection, just wrap the cursor
text = ''
snippet = insertion.replace('$SELECTED_TEXT', '$1') + '$0'
snippet = tea.construct_snippet(text, snippet)
return tea.insert_snippet_over_range(context, snippet, range,
undo_name)
# Since we're here, it must not have been a single selection
insertions = tea.new_recipe()
for range in ranges:
insertion = tea.select_from_zones(context, range, default, **syntaxes)
text = tea.get_selection(context, range)
text = insertion.replace('$SELECTED_TEXT', text)
insertions.addReplacementString_forRange_(text, range)
if undo_name is not None:
insertions.setUndoActionName_(undo_name)
return context.applyTextRecipe_(insertions)
def act(context, default=None, fallback_url="", undo_name=None, **syntaxes):
"""
Required action method
A flexible link generator which uses the clipboard text (if there's
a recognizable link there) and formats the snippet based on the
active syntax of the context
"""
if default is None:
return False
# Get the text and range
text, range = tea.get_single_selection(context, True)
if text == None:
return False
# Get the clipboard contents, parse for a URL
process = subprocess.Popen(["pbpaste"], stdout=subprocess.PIPE)
clipboard, error = process.communicate(None)
# Construct the default link
url = format_hyperlink(clipboard, fallback_url)
# Get the snippet based on the root zone
snippet = tea.select_from_zones(context, range, default, **syntaxes)
snippet = tea.construct_snippet(text, snippet)
snippet = snippet.replace("$URL", tea.sanitize_for_snippet(url))
return tea.insert_snippet(context, snippet)
def act(context, first_snippet='', following_snippet='',
final_append='', undo_name=None):
'''
Required action method
This only allows a single selection (enforced through the utility
functions) then parses over the lines and inserts a snippet
Theoretically we could allow discontiguous selections; have to consider
it if recipes get snippet capabilities
'''
text, range = tea.get_single_selection(context, True)
if text == None:
return False
# Split the text into lines, maintaining the linebreaks
lines = text.splitlines(True)
# Compile the regex for quicker action on lots of lines
parser = re.compile(r'(\s*)(.*?)(\s*(\r?\n)|$)')
# Indent the snippets
first = tea.indent_snippet(context, first_snippet, range)
following = tea.indent_snippet(context, following_snippet, range)
# Loop over lines and construct the snippet
snippet = ''
# This is the number of snippets processed, not lines
count = 1
for line in lines:
content = parser.search(line)
# Only wrap the line if there's some content
if content.group(2) != '':
if count == 1:
segment = tea.construct_snippet(content.group(2), first)
else:
segment = tea.construct_snippet(content.group(2), following)
snippet += content.group(1) + segment + content.group(3)
count += 1
else:
snippet += line
snippet += final_append
return tea.insert_snippet_over_range(context, snippet, range, undo_name)
def act(context, first_snippet='', following_snippet='',
final_append='', undo_name=None):
'''
Required action method
Wraps the selected text in a snippet
Support for discontiguous selections will be implemented when recipes
can support snippets; until then only first_snippet will be used
'''
# TODO: change to a loop once snippets in recipes are supported
# This function will handle the logic of when to use open vs. multi
text, range = tea.get_single_selection(context)
if text == None:
text = ''
# Indent the snippet
snippet = tea.indent_snippet(context, first_snippet + final_append, range)
snippet = tea.construct_snippet(text, snippet)
return tea.insert_snippet_over_range(context, snippet, range, undo_name)
def act(context, default=None, undo_name=None, **syntaxes):
'''
Required action method
Inserts an arbitrary text snippet after the cursor with provisions for
syntax-specific alternatives
Accepts $EDITOR_SELECTION placeholder
This method requires at least the snippet default to be defined in the XML
'''
if default is None:
return False
# Get the cursor position
text, range = tea.get_single_selection(context)
# Check for root-zone specific override
snippet = tea.select_from_zones(context, range, default, **syntaxes)
# Construct the snippet
snippet = tea.construct_snippet(text, snippet)
# Insert that snippet!
return tea.insert_snippet(context, snippet)
def act(context, first_snippet='', following_snippet='',
final_append='', undo_name=None):
'''
Required action method
Wraps the selected text in a snippet
Support for discontiguous selections will be implemented when recipes
can support snippets; until then only first_snippet will be used
'''
# TODO: change to a loop once snippets in recipes are supported
# This function will handle the logic of when to use open vs. multi
text, range = tea.get_single_selection(context)
if text == None:
text = ''
# Only indent the snippet if there aren't multiple lines in the selected text
if len(text.splitlines()) > 1:
indent = False
else:
indent = True
snippet = tea.construct_snippet(text, first_snippet + final_append)
return tea.insert_snippet(context, snippet, indent)
def act(context, default=None, alpha_numeric=True, extra_characters='',
bidirectional=True, mode=None, close_string='', undo_name=None,
**syntaxes):
'''
Required action method
Transforms the word under the cursor (or the word immediately previous
to the cursor) into a snippet (or processes it using zen-coding)
The snippet offers two placeholders:
$EDITOR_SELECTION: replaced with the word, or any selected text
$WORD: if text is selected, replaced just with the first word
'''
if default is None:
return False
range = tea.get_single_range(context, True)
if range == None:
return False
# Check for specific zone override
snippet = tea.select_from_zones(context, range, default, **syntaxes)
# Fetch the word
word, new_range = tea.get_word_or_selection(context, range, alpha_numeric,
extra_characters, bidirectional)
if word == '':
# No word, so nothing further to do
return False
# If we're using $WORD, make sure the word is just a word
if snippet.find('$WORD') >= 0:
fullword = word
word = tea.parse_word(word)
if word is None:
word = ''
else:
fullword = word
# We've got some extra work if the mode is HTML or zen
# This is a really hacky solution, but I can't think of a concise way to
# represent this functionality via XML
# TODO remove it
if mode == 'zen' and fullword.find(' ') < 0:
# Explicitly load zen settings
zen_settings = settings_loader.load_settings()
zen_core.update_settings(zen_settings)
# Set up the config variables
zen_core.newline = tea.get_line_ending(context)
zen_settings['variables']['indentation'] = tea.get_indentation_string(context)
# This allows us to use smart incrementing tab stops in zen snippets
point_ix = [0]
def place_ins_point(text):
point_ix[0] += 1
return '$%s' % point_ix[0]
zen_core.insertion_point = place_ins_point
# Detect the type of document we're working with
zones = {
'css, css *': 'css',
'xsl, xsl *': 'xsl',
'xml, xml *': 'xml'
}
doc_type = tea.select_from_zones(context, range, 'html', **zones)
# Setup the zen profile based on doc_type and XHTML status
profile = {}
if doc_type == 'html':
close_string = tea.get_tag_closestring(context)
if close_string == '/':
profile['self_closing_tag'] = True
elif close_string != ' /':
profile['self_closing_tag'] = False
elif doc_type == 'xml':
profile = {'self_closing_tag': True, 'tag_nl': True}
zen_core.setup_profile('tea_profile', profile)
# Prepare the snippet
snippet = zen_core.expand_abbreviation(fullword, doc_type, 'tea_profile')
elif (mode == 'zen' or mode == 'html') and tea.is_selfclosing(word):
# Self-closing, so construct the snippet from scratch
snippet = '<' + fullword
if fullword == word and not fullword in ['br', 'hr']:
snippet += ' $1'
snippet += '$E_XHTML>$0'
# Special replacement in case we're using $WORD
snippet = snippet.replace('$WORD', word)
# Construct the snippet
snippet = tea.construct_snippet(fullword, snippet)
return tea.insert_snippet_over_range(context, snippet, new_range, undo_name)
def act(
context,
default=None,
alpha_numeric=True,
extra_characters="",
bidirectional=True,
mode=None,
close_string="",
undo_name=None,
**syntaxes
):
"""
Required action method
Transforms the word under the cursor (or the word immediately previous
to the cursor) into a snippet (or processes it using zen-coding)
The snippet offers two placeholders:
$SELECTED_TEXT: replaced with the word, or any selected text
$WORD: if text is selected, replaced just with the first word
"""
if default is None:
return False
range = tea.get_single_range(context, True)
if range == None:
return False
# Check for specific zone override
snippet = tea.select_from_zones(context, range, default, **syntaxes)
# Fetch the word
word, new_range = tea.get_word_or_selection(context, range, alpha_numeric, extra_characters, bidirectional)
if word == "":
# No word, so nothing further to do
return False
# If we're using $WORD, make sure the word is just a word
if snippet.find("$WORD") >= 0:
fullword = word
word = tea.parse_word(word)
if word is None:
word = ""
else:
fullword = word
# We've got some extra work if the mode is HTML or zen
# This is a really hacky solution, but I can't think of a concise way to
# represent this functionality via XML
if mode == "zen" and fullword.find(" ") < 0:
# Set up the config variables
zen_core.newline = tea.get_line_ending(context)
# This allows us to use smart incrementing tab stops in zen snippets
global point_ix
point_ix = 0
def place_ins_point(text):
globals()["point_ix"] += 1
return "$%s" % point_ix
zen_core.insertion_point = place_ins_point
zen_core.sub_insertion_point = place_ins_point
zen_core.selfclosing_string = tea.get_tag_closestring(context)
zen_settings["indentation"] = tea.get_indentation_string(context)
# Detect the type of document we're working with
zones = {"css, css *": "css", "xsl, xsl *": "xsl", "xml, xml *": "xml"}
doc_type = tea.select_from_zones(context, range, "html", **zones)
# Prepare the snippet
snippet = zen_core.expand_abbr(fullword, doc_type)
elif (mode == "zen" or mode == "html") and tea.is_selfclosing(word):
# Self-closing, so construct the snippet from scratch
snippet = "<" + fullword
if fullword == word and not fullword in ["br", "hr"]:
snippet += " $1"
snippet += "$E_XHTML>$0"
# Indent the snippet
snippet = tea.indent_snippet(context, snippet, new_range)
# Special replacement in case we're using $WORD
snippet = snippet.replace("$WORD", word)
# Construct the snippet
snippet = tea.construct_snippet(fullword, snippet)
return tea.insert_snippet_over_range(context, snippet, new_range, undo_name)
