diff --git a/.gitignore b/.gitignore index 8991d99b2e..72a7f60a4d 100644 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,7 @@ resources/ebook-convert-complete.pickle resources/builtin_recipes.xml resources/builtin_recipes.zip resources/template-functions.json +resources/editor-functions.json icons/icns/*.iconset setup/installer/windows/calibre/build.log tags diff --git a/setup/resources.py b/setup/resources.py index ac1d5990af..ce9e8f592b 100644 --- a/setup/resources.py +++ b/setup/resources.py @@ -313,6 +313,21 @@ class Resources(Command): # {{{ import json json.dump(function_dict, open(dest, 'wb'), indent=4) + self.info('\tCreating editor-functions.json') + dest = self.j(self.RESOURCES, 'editor-functions.json') + function_dict = {} + from calibre.gui2.tweak_book.function_replace import builtin_functions + for func in builtin_functions(): + try: + src = u''.join(inspect.getsourcelines(func)[0]) + except Exception: + continue + src = src.replace('def ' + func.func_name, 'def replace') + if 'apply_func_to_match_groups' in src: + src = 'from calibre.ebooks.oeb.polish.utils import apply_func_to_match_groups\n\n' + src + function_dict[func.name] = src + json.dump(function_dict, open(dest, 'wb'), indent=4) + def clean(self): for x in ('scripts', 'ebook-convert-complete'): x = self.j(self.RESOURCES, x+'.pickle') diff --git a/src/calibre/ebooks/oeb/polish/utils.py b/src/calibre/ebooks/oeb/polish/utils.py index c2c95efbc2..b196d7341f 100644 --- a/src/calibre/ebooks/oeb/polish/utils.py +++ b/src/calibre/ebooks/oeb/polish/utils.py @@ -172,3 +172,25 @@ def parse_css(data, fname='', is_declaration=False, decode=None, log_lev data = parser.parseString(data, href=fname, validate=False) return data +def apply_func_to_match_groups(match, func): + '''Apply the specified function to individual groups in the match object (the result of re.search() or + the whole match if no groups were defined. Returns the replaced string.''' + found_groups = False + i = 0 + parts, pos = [], 0 + while True: + i += 1 + try: + start, end = match.span(i) + except IndexError: + break + found_groups = True + if start > -1: + parts.append(match.string[pos:start]) + parts.append(func(match.string[start:end])) + pos = end + if not found_groups: + return func(match.group()) + parts.append(match.string[pos:]) + return ''.join(parts) + diff --git a/src/calibre/gui2/tweak_book/editor/text.py b/src/calibre/gui2/tweak_book/editor/text.py index 56a4db9f1f..7f922cc8ca 100644 --- a/src/calibre/gui2/tweak_book/editor/text.py +++ b/src/calibre/gui2/tweak_book/editor/text.py @@ -456,7 +456,10 @@ class TextEdit(PlainTextEdit): m = saved if m is None: return False - text = m.expand(template) + if callable(template): + text = template(m) + else: + text = m.expand(template) c.insertText(text) return True diff --git a/src/calibre/gui2/tweak_book/function_replace.py b/src/calibre/gui2/tweak_book/function_replace.py new file mode 100644 index 0000000000..4182502839 --- /dev/null +++ b/src/calibre/gui2/tweak_book/function_replace.py @@ -0,0 +1,121 @@ +#!/usr/bin/env python +# vim:fileencoding=utf-8 +from __future__ import (unicode_literals, division, absolute_import, + print_function) + +__license__ = 'GPL v3' +__copyright__ = '2014, Kovid Goyal ' + +import re, io + +from calibre.gui2.complete2 import EditWithComplete +from calibre.gui2.tweak_book import dictionaries +from calibre.utils.config import JSONConfig + +user_functions = JSONConfig('editor-search-replace-functions') + +def compile_code(src): + if not isinstance(src, unicode): + match = re.search(r'coding[:=]\s*([-\w.]+)', src[:200]) + enc = match.group(1) if match else 'utf-8' + src = src.decode(enc) + # Python complains if there is a coding declaration in a unicode string + src = re.sub(r'^#.*coding\s*[:=]\s*([-\w.]+)', '#', src, flags=re.MULTILINE) + # Translate newlines to \n + src = io.StringIO(src, newline=None).getvalue() + + namespace = {} + exec src in namespace + return namespace + +class Function(object): + + def __init__(self, name, source=None, func=None): + self._source = source + self.is_builtin = source is None + self.name = name + if func is None: + self.mod = compile_code(source) + self.func = self.mod['replace'] + else: + self.func = func + self.mod = None + if not callable(self.func): + raise ValueError('%r is not a function' % self.func) + + def init_env(self, name=''): + from calibre.gui2.tweak_book.boss import get_boss + self.context_name = name or '' + self.match_index = 0 + self.boss = get_boss() + + def __hash__(self): + return hash(self.name) + + def __eq__(self, other): + return self.name == getattr(other, 'name', None) + + def __ne__(self, other): + return not self.__eq__(other) + + def __call__(self, match): + self.match_index += 1 + return self.func(match, self.match_index, self.context_name, self.boss.current_metadata, dictionaries, functions()) + + @property + def source(self): + if self.is_builtin: + import json + return json.loads(P('editor-functions.json', data=True, allow_user_override=False))[self.name] + return self._source + +def builtin_functions(): + for name, obj in globals().iteritems(): + if name.startswith('replace_') and callable(obj): + yield obj + +_functions = None +def functions(refresh=False): + global _functions + if _functions is None or refresh: + ans = _functions = {} + for func in builtin_functions(): + ans[func.name] = Function(func.name, func=func) + if refresh: + user_functions.refresh() + for name, source in user_functions.iteritems(): + try: + f = Function(name, source=source) + except Exception: + continue + ans[f.name] = f + return _functions + +class FunctionBox(EditWithComplete): + + def __init__(self, parent=None): + EditWithComplete.__init__(self, parent) + self.set_separator(None) + self.refresh() + + def refresh(self): + self.update_items_cache(set(functions())) + +# Builtin functions ########################################################## + +from calibre.ebooks.oeb.polish.utils import apply_func_to_match_groups + +def replace_uppercase(match, number, file_name, metadata, dictionaries, functions, *args, **kwargs): + '''Make matched text upper case. If the regular expression contains groups, + only the text in the groups will be changed, otherwise the entire text is + changed.''' + return apply_func_to_match_groups(match, icu_upper) +replace_uppercase.name = 'Upper-case text' + +def replace_lowercase(match, number, file_name, metadata, dictionaries, functions, *args, **kwargs): + '''Make matched text lower case. If the regular expression contains groups, + only the text in the groups will be changed, otherwise the entire text is + changed.''' + return apply_func_to_match_groups(match, icu_lower) +replace_lowercase.name = 'Lower-case text' + diff --git a/src/calibre/gui2/tweak_book/search.py b/src/calibre/gui2/tweak_book/search.py index c06327420c..bb13e8f69b 100644 --- a/src/calibre/gui2/tweak_book/search.py +++ b/src/calibre/gui2/tweak_book/search.py @@ -23,6 +23,7 @@ from calibre.gui2 import error_dialog, info_dialog, choose_files, choose_save_fi from calibre.gui2.dialogs.message_box import MessageBox from calibre.gui2.widgets2 import HistoryComboBox from calibre.gui2.tweak_book import tprefs, editors, current_container +from calibre.gui2.tweak_book.function_replace import FunctionBox, functions as replace_functions from calibre.gui2.tweak_book.widgets import BusyCursor from calibre.utils.icu import primary_contains @@ -155,7 +156,7 @@ class ModeBox(QComboBox): def __init__(self, parent): QComboBox.__init__(self, parent) - self.addItems([_('Normal'), _('Regex')]) + self.addItems([_('Normal'), _('Regex'), _('Regex-Function')]) self.setToolTip('' + _( '''Select how the search expression is interpreted
@@ -163,14 +164,16 @@ class ModeBox(QComboBox):
The search expression is treated as normal text, calibre will look for the exact text.
Regex
The search expression is interpreted as a regular expression. See the User Manual for more help on using regular expressions.
+
Regex-Function
+
The search expression is interpreted as a regular expression. The replace expression is an arbitrarily powerful python function.
''')) @dynamic_property def mode(self): def fget(self): - return 'normal' if self.currentIndex() == 0 else 'regex' + return ('normal', 'regex', 'function')[self.currentIndex()] def fset(self, val): - self.setCurrentIndex({'regex':1}.get(val, 0)) + self.setCurrentIndex({'regex':1, 'function':2}.get(val, 0)) return property(fget=fget, fset=fset) @@ -193,7 +196,6 @@ class SearchWidget(QWidget): QWidget.__init__(self, parent) self.l = l = QGridLayout(self) l.setContentsMargins(0, 0, 0, 0) - self.setLayout(l) self.fl = fl = QLabel(_('&Find:')) fl.setAlignment(Qt.AlignRight | Qt.AlignCenter) @@ -205,6 +207,7 @@ class SearchWidget(QWidget): fl.setBuddy(ft) l.addWidget(fl, 0, 0) l.addWidget(ft, 0, 1) + l.setColumnStretch(1, 10) self.rl = rl = QLabel(_('&Replace:')) rl.setAlignment(Qt.AlignRight | Qt.AlignCenter) @@ -213,9 +216,22 @@ class SearchWidget(QWidget): rt.show_saved_searches.connect(self.show_saved_searches) rt.initialize('tweak_book_replace_edit') rl.setBuddy(rt) - l.addWidget(rl, 1, 0) - l.addWidget(rt, 1, 1) - l.setColumnStretch(1, 10) + self.replace_stack1 = rs1 = QVBoxLayout() + self.replace_stack2 = rs2 = QVBoxLayout() + rs1.addWidget(rl), rs2.addWidget(rt) + l.addLayout(rs1, 1, 0) + l.addLayout(rs2, 1, 1) + + self.rl2 = rl2 = QLabel(_('F&unction:')) + rl2.setAlignment(Qt.AlignRight | Qt.AlignCenter) + self.functions = fb = FunctionBox(self) + rl2.setBuddy(fb) + rs1.addWidget(rl2) + self.functions_container = w = QWidget(self) + rs2.addWidget(w) + self.fhl = fhl = QHBoxLayout(w) + fhl.setContentsMargins(0, 0, 0, 0) + fhl.addWidget(fb, stretch=10, alignment=Qt.AlignVCenter) self.fb = fb = PushButton(_('&Find'), 'find', self) self.rfb = rfb = PushButton(_('Replace a&nd Find'), 'replace-find', self) @@ -258,17 +274,26 @@ class SearchWidget(QWidget): da.setSizePolicy(QSizePolicy.Maximum, QSizePolicy.Maximum) ol.addWidget(da) - self.mode_box.currentIndexChanged[int].connect(self.da.setVisible) + self.mode_box.currentIndexChanged[int].connect(self.mode_changed) + self.mode_changed(self.mode_box.currentIndex()) ol.addStretch(10) + def mode_changed(self, idx): + self.da.setVisible(idx > 0) + function_mode = idx == 2 + self.rl.setVisible(not function_mode) + self.rl2.setVisible(function_mode) + self.replace_text.setVisible(not function_mode) + self.functions_container.setVisible(function_mode) + @dynamic_property def mode(self): def fget(self): return self.mode_box.mode def fset(self, val): self.mode_box.mode = val - self.da.setVisible(self.mode == 'regex') + self.da.setVisible(self.mode in ('regex', 'function')) return property(fget=fget, fset=fset) @dynamic_property @@ -282,6 +307,8 @@ class SearchWidget(QWidget): @dynamic_property def replace(self): def fget(self): + if self.mode == 'function': + return self.functions.text() return unicode(self.replace_text.text()) def fset(self, val): self.replace_text.setText(val) @@ -346,7 +373,7 @@ class SearchWidget(QWidget): tprefs.set('find-widget-state', self.state) def pre_fill(self, text): - if self.mode == 'regex': + if self.mode in ('regex', 'function'): text = regex.escape(text, special_only=True) self.find = text self.find_text.lineEdit().setSelection(0, len(text)+10) @@ -928,7 +955,7 @@ class SavedSearches(QWidget): search_index, search = i.data(Qt.UserRole) cs = '✓' if search.get('case_sensitive', SearchWidget.DEFAULT_STATE['case_sensitive']) else '✗' da = '✓' if search.get('dot_all', SearchWidget.DEFAULT_STATE['dot_all']) else '✗' - if search.get('mode', SearchWidget.DEFAULT_STATE['mode']) == 'regex': + if search.get('mode', SearchWidget.DEFAULT_STATE['mode']) in ('regex', 'function'): ts = _('(Case sensitive: {0} Dot All: {1})').format(cs, da) else: ts = _('(Case sensitive: {0} [Normal search])').format(cs) @@ -1011,12 +1038,13 @@ class InvalidRegex(regex.error): def get_search_regex(state): raw = state['find'] - if state['mode'] != 'regex': + is_regex = state['mode'] != 'normal' + if not is_regex: raw = regex.escape(raw, special_only=True) flags = REGEX_FLAGS if not state['case_sensitive']: flags |= regex.IGNORECASE - if state['mode'] == 'regex' and state['dot_all']: + if is_regex and state['dot_all']: flags |= regex.DOTALL if state['direction'] == 'up': flags |= regex.REVERSE @@ -1064,6 +1092,18 @@ def initialize_search_request(state, action, current_editor, current_editor_name return editor, where, files, do_all, marked +class NoSuchFunction(ValueError): + pass + +def get_search_function(search): + ans = search['replace'] + if search['mode'] == 'function': + try: + return replace_functions()[ans] + except KeyError: + raise NoSuchFunction(ans) + return ans + def run_search( searches, action, current_editor, current_editor_name, searchable_names, gui_parent, show_editor, edit_file, show_current_diff, add_savepoint, rewind_savepoint, set_modified): @@ -1079,11 +1119,14 @@ def run_search( errfind = _('the selected searches') try: - searches = [(get_search_regex(search), search['replace']) for search in searches] + searches = [(get_search_regex(search), get_search_function(search)) for search in searches] except InvalidRegex as e: return error_dialog(gui_parent, _('Invalid regex'), '

' + _( 'The regular expression you entered is invalid: 

{0}
With error: {1}').format( prepare_string_for_xml(e.regex), e.message), show=True) + except NoSuchFunction as e: + return error_dialog(gui_parent, _('No such function'), '

' + _( + 'No replace function with the name: %s exists') % prepare_string_for_xml(e.message), show=True) def no_match(): QApplication.restoreOverrideCursor() @@ -1131,6 +1174,8 @@ def run_search( if editor is None: return no_replace() for p, repl in searches: + if callable(repl): + repl.init_env(current_editor_name) if editor.replace(p, repl, saved_match='gui'): return True return no_replace(_( @@ -1162,9 +1207,13 @@ def run_search( raw_data[n] = raw for p, repl in searches: + if callable(repl): + repl.init_env() for n, syntax in lfiles.iteritems(): raw = raw_data[n] if replace: + if callable(repl): + repl.context_name = n raw, num = p.subn(repl, raw) if num > 0: updates.add(n)