In Selection' grayed out in the find/replace box in Column Alt+shift select

mrg9999 · Nov 25, 2021, 1:31 AM

Re: ‘In Selection’ grayed out in the find/replace box
In Selection’ grayed out in the find/replace box
Works fine for Select all BUT not for ALt+shift column selection

Is this by design?

Alan Kilborn · Nov 25, 2021, 2:06 AM

@mrg9999 said in In Selection' grayed out in the find/replace box in Column Alt+shift select:

Is this by design?

Yes, you can’t do these operations on a column block.

Alan Kilborn · Nov 28, 2021, 1:14 PM

This post is deleted!

Alan Kilborn · Nov 29, 2021, 1:15 PM

NOTE: I posted earlier in this thread, but unfortunately the code listing in that posting was affected by the forum bug whereby a backslash followed by a bracket ([ or ]) is not rendered correctly. Because I can’t edit that posting to correct the problem, I deleted the posting in its entirety and am reposting it below, hopefully with the problem corrected…

Alan Kilborn · Nov 29, 2021, 1:16 PM

So this critical shortcoming in Notepad++ has come up many times before, and probably even more times than I list here:

A few times before when I’ve seen such postings, I’ve thought about sharing my PythonScript method for solving it, but, well, sometimes you have something nice that works for you, but to share it you have to put more “shine” on it. This time I’ve attempted to do that, and I’ve shared the cleaned-up script below.

Aside: In my response to one of the Community threads above, I see that I promised to post something “soon”. Well, that was back in January of 2021, so “soon” is relative. :-)

The script works on multiple selection types:

a normal single stream selection (but why? Just use Notepad++'s own Replace All)
column-block selection (the issue posed by the OP to this thread)
multiple stream selections (that have been selected with the “Multi-editing” feature of Notepad++ turned on):

The script is fairly simple to use. Make your selection(s) and then run the script. You will be prompted through a series of dialog boxes to provide your parameters for the replacement operation:

specifying what you want to find:
specifying what you want to replace the found matches with:
specifying other options, like case sensitivity, regular expression mode, etc.:

To use the options, you put an x inside the brackets in front of an option you want to select; example to select case sensitivity:

After everything has been specified, press OK and the replacement(s) will be made in the active selection(s).

If you have chosen the “pre-replace-count-preview” option, you will get a prompt like this before the document text is changed:

Choosing Yes from there will do the replacing without further prompt.
Choosing No will result in an additional prompt:

If you have selected the “post-replacement-summary” option, after replacements have been made, you will see a box like this appear:

That’s it; here’s the listing for the script, ReplaceAllInSelections.py:

# -*- coding: utf-8 -*-

from Npp import *
import re
import inspect

class RAIS(object):

    def __init__(self):
        self.script_name = inspect.getframeinfo(inspect.currentframe()).filename.split('\\')[-1]
        self.remembered_find_regex_str = ''
        self.remembered_repl_regex_str = ''
        self.remembered_case_sens_setting = False
        self.remembered_whole_word_setting = False
        self.remembered_regex_setting = False
        self.remembered_pre_repl_preview_setting = False
        self.remembered_post_repl_summary_setting = False
        self.help_str = '''
        HELP

        pre-replace-preview : pops up a box BEFORE replacements are
        made, telling how many there will be; at that point there
        will be a way to cancel so that the replacements aren't
        made; and a way to leave the matches selected

        post-replace-summary : pops up a box after replacements are
        made, telling how many were made
        '''

    def mb(self, msg, flags=0, title=''):
        if len(title) == 0: title = self.script_name
        return notepad.messageBox(msg, title, flags)

    def custom_rereplace(self, find_what, replace_with, ignore_case_flag=0, max_num_of_replacements=0, start_end_pos_tup=None):
        # if start_end_pos_tup is None, replace will be done in all active selections
        leave_caret_here = None
        start_end_pos_tup_list = []
        if start_end_pos_tup == None:
            if editor.getSelectionEmpty():
                start_end_pos_tup_list.append((0, editor.getTextLength()))
                leave_caret_here = editor.getCurrentPos()
            else:
                for n in range(editor.getSelections()):
                    (s, e) = (editor.getSelectionNStart(n), editor.getSelectionNEnd(n))
                    append_it = True
                    if 1:
                        # prevent, e.g., a regex search for ^ from replacing "outside" a column-block's visual region
                        #  (could happen on empty lines inside the block)
                        if editor.getSelectionNAnchor(n) <= editor.getSelectionNCaret(n):
                            if editor.getSelectionNAnchorVirtualSpace(n) > 0: append_it = False
                        else:
                            if editor.getSelectionNCaretVirtualSpace(n) > 0: append_it = False
                    if append_it: start_end_pos_tup_list.append((s, e))
                start_end_pos_tup_list.sort()
        else:
            start_end_pos_tup_list.append(start_end_pos_tup)
        running_offset = 0
        first = True
        if editor.selectionIsRectangle():
            # get out of column selection mode as it messes up trying to correctly set selections later
            editor.setEmptySelection(editor.getCurrentPos())
        for (s, e) in start_end_pos_tup_list:
            s_plus_ro = s + running_offset
            e_plus_ro = e + running_offset
            old_len = editor.getLength()
            editor.rereplace(find_what, replace_with, ignore_case_flag, s_plus_ro, e_plus_ro, max_num_of_replacements)
            new_len = editor.getLength()
            if leave_caret_here == None:
                new_sel_end = e_plus_ro + new_len - old_len
                if first:
                    editor.setSelection(new_sel_end, s_plus_ro)
                else:
                    editor.addSelection(new_sel_end, s_plus_ro)
            running_offset += new_len - old_len
            first = False
        if leave_caret_here != None: editor.setEmptySelection(leave_caret_here)

    def run(self):

        editor.setMultipleSelection(True)
        line_ending = ['\r\n', '\r', '\n'][editor.getEOLMode()]
        num_selections = editor.getSelections()
        # editor.getSelText() returns...:
        #  skinny caret rect block always returns ''
        #  non-skinny rect block returns line data separated by line-endings
        #  non-skinny rect block totally in virtual space returns only line-endings
        #   example: 3-line rect block in virtual space in windows file returns '\r\n\r\n\r\n'
        #  non-rect multiple-selection text is returned contiguously with no delimiters of any type between!
        if editor.selectionIsRectangle():
            if len(editor.getSelText()) <= num_selections * len(line_ending):
                self.mb('No text in rectangular selection; nothing to do!')
                return
        else:
            if len(editor.getSelText()) == 0:
                if num_selections > 1:
                    self.mb('No text in stream selections; nothing to do!')
                else:
                    self.mb('No selected text; nothing to do!')
                return

        find_regex_str = self.remembered_find_regex_str
        repl_regex_str = self.remembered_repl_regex_str
        opt_case_sens = 'x' if self.remembered_case_sens_setting else ' '
        opt_whole_word = 'x' if self.remembered_whole_word_setting else ' '
        opt_regex = 'x' if self.remembered_regex_setting else ' '
        opt_pre = 'x' if self.remembered_pre_repl_preview_setting else ' '
        opt_post = 'x' if self.remembered_post_repl_summary_setting else ' '

        input_stage = 'find'

        while True:  # loop to validate user input

            if input_stage == 'find':
                user_reply_to_find_query = notepad.prompt(
                    ' ' * 10 + 'Enter ? alone for help\r\nEnter FIND string:',
                    self.script_name, find_regex_str)
                if user_reply_to_find_query == None: return  # user cancel
                if len(user_reply_to_find_query) == 0: continue
                if user_reply_to_find_query == '?':
                    self.mb(self.help_str)
                    continue
                find_regex_str = user_reply_to_find_query
                input_stage = 'replace'

            if input_stage == 'replace':
                f = find_regex_str[:20]
                if f != find_regex_str: f += '...'
                user_reply_to_replace_query = notepad.prompt(
                    ' ' * 5 + 'FIND string = {}\r\nEnter REPLACE string:'.format(f),
                    self.script_name, repl_regex_str)
                if user_reply_to_replace_query == None:
                    input_stage = 'find'; continue  # go back to previous step
                if len(user_reply_to_replace_query) == 0:
                    ync = self.mb('Replace matches with nothing, effectively deleting them?\r\n\r\n'
                        'YES = yes, delete matches\r\nNO = prompt again for what to replace with\r\n'
                        'CANCEL = go back a step (to prompt for find expression)',
                        MESSAGEBOXFLAGS.YESNOCANCEL)
                    if ync == MESSAGEBOXFLAGS.RESULTCANCEL:
                        input_stage = 'find'; continue  # go back to previous step
                    elif ync == MESSAGEBOXFLAGS.RESULTNO:
                        continue  # repeat current step
                repl_regex_str = user_reply_to_replace_query
                input_stage = 'options'

            if input_stage == 'options':
                f = find_regex_str[:10]
                if f != find_regex_str: f += '...'
                r = repl_regex_str[:10]
                if r != repl_regex_str: r += '...'
                options_prompt = '[  {c}  ]match-case        ' + \
                    '[  {w}  ]whole-word        ' + \
                    '[  {re}  ]regular-expression' + \
                    '\r\n' + \
                    '[  {pre}  ]pre-replace-count-preview            ' + \
                    '[  {post}  ]post-replace-summary'
                options_prompt = options_prompt.format(
                    c=opt_case_sens, w=opt_whole_word, re=opt_regex, pre=opt_pre, post=opt_post)
                user_reply_to_options_query = notepad.prompt(
                        ' ' * 5 + \
                        'FIND string = {}     ' + \
                        'REPLACE string = {}' + \
                        '\r\n' + \
                        'Select OPTIONS:               ' + \
                        'Put any character inside the [ ] to select'.format(
                        f, r if len(r) > 0 else 'NOTHING!'), self.script_name, options_prompt)
                if user_reply_to_options_query == None or len(user_reply_to_options_query) == 0:
                    # go back to previous step
                    input_stage = 'replace'
                    continue
                if re.sub(r'\\[[^]]+\\]', r'[]', options_prompt) != \
                        re.sub(r'\\[[^]]+\\]', r'[]', user_reply_to_options_query):
                    self.mb('Trouble parsing the options; please try again')
                    continue
                options_str = user_reply_to_options_query

            def check_option(opt):  # look in the [ ] boxes; return True if any non-space there
                m = re.search(r'\\[([^]]+)\\]' + opt, options_str)
                return True if m and m.group(1) != ' ' * len(m.group(1)) else False
            doing_case_sensitive = check_option('match-case')
            doing_whole_word = check_option('whole-word')
            doing_regex = check_option('regular-expression')
            doing_pre_replace_preview = check_option('pre-replace-count-preview')
            doing_post_replace_summary = check_option('post-replace-summary')

            self.remembered_find_regex_str = find_regex_str
            self.remembered_repl_regex_str = repl_regex_str
            self.remembered_case_sens_setting = doing_case_sensitive
            self.remembered_whole_word_setting = doing_whole_word
            self.remembered_regex_setting = doing_regex
            self.remembered_pre_repl_preview_setting = doing_pre_replace_preview
            self.remembered_post_repl_summary_setting = doing_post_replace_summary

            if doing_regex:
                try:
                    editor.research(find_regex_str, lambda _: None)  # test regex for validity
                except RuntimeError as r:
                    self.mb('Error in search regular expression:\r\n\r\n'
                        '{0}\r\n\r\n'
                        '{1}\r\n\r\n\r\n'
                        'Click OK to try entering your find expression again'.format(find_regex_str, str(r)))
                    input_stage = 'find'
                    continue

            break

        total_number_of_matches = 0

        if not doing_regex:
            find_regex_str = r'\Q' + find_regex_str + r'\E'
            # prevent problems with use of literal parenthesis characters in replace expression:
            repl_regex_str = re.sub(r'(?<!\\)([()])', r'\\\1', repl_regex_str)  # replace parens with backslash-parens
        if doing_whole_word: find_regex_str = r'\b' + find_regex_str + r'\b'
        find_regex_str = '(?{}i)'.format('-' if doing_case_sensitive else '') + find_regex_str

        match_pos_span_tup_list = []
        def match_found_func(m): match_pos_span_tup_list.append(m.span(0))
        for n in range(editor.getSelections()):
            editor.research(find_regex_str, match_found_func, 0, editor.getSelectionNStart(n), editor.getSelectionNEnd(n))
        total_number_of_matches = len(match_pos_span_tup_list)
        if total_number_of_matches == 0:
            self.mb('No matches found for :\r\n\r\n{}'.format(self.remembered_find_regex_str))
            return

        if doing_pre_replace_preview:
            if self.mb('Make {tnom} replacement{s}?\r\n\r\n'
                    'Choose NO to not make the replacement{s} and see additional choices'.format(
                    tnom=total_number_of_matches, s='s' if total_number_of_matches > 1 else ''),
                    MESSAGEBOXFLAGS.YESNO) == MESSAGEBOXFLAGS.RESULTNO:
                if self.mb('End script and leave the {tnom} match{es} {ms}selected?\r\n\r\n'
                        'Choosing NO will end and leave the original search range selected'.format(
                        tnom=total_number_of_matches,
                        es='es' if total_number_of_matches > 1 else '',
                        ms='multi-' if total_number_of_matches > 1 else ''),
                        MESSAGEBOXFLAGS.YESNO) == MESSAGEBOXFLAGS.RESULTYES:
                    first = True
                    # get out of column selection mode as it messes up trying to correctly set selections later
                    editor.setEmptySelection(match_pos_span_tup_list[0][0])
                    for (s, e) in match_pos_span_tup_list:
                        editor.setSelection(e, s) if first else editor.addSelection(e, s)
                        first = False
                return

        editor.beginUndoAction()
        self.custom_rereplace(find_regex_str, repl_regex_str)
        editor.endUndoAction()

        if not doing_pre_replace_preview and doing_post_replace_summary:
            self.mb('Replacements made: {}'.format(total_number_of_matches))

if __name__ == '__main__':
    try:
        rais
    except NameError:
        rais = RAIS()
    rais.run()