Replace 1 + lines?

Alan Kilborn

Once again you are amazing! I haven’t tried what you propose yet but I have no doubt it will be awesome.

Alan Kilborn

I started working with and extending your script to do some other things on the Find dialog. I can get and set the state of radio buttons and checkboxes–yay! Some final things that I need to do are to get and/or set the text of the Find-what and Replace-with edit boxes (or comboboxes?). Is there a best way to do this? It isn’t as easy as with the other controls because these don’t have a caption. Can you post a short example of how to get text and set text to these edit controls on the Find dialog?

Claudia Frank

@Alan-Kilborn

Hi Alan,

you right, edit box aren’t easy to identify but, as far as I remember, you can rely on the order (z-order) how the controls get identified/returned.

So in this case you could check when the static box (aka label) returns with &Find what and set a
flag and when the edit control appears, check if flag is set and treat it. To retrieve or set the text
you can use the api functions GetWindowText and SetWindowText.

A simple example like this (only the callback part and the definitions of the code)

GetWindowText = ctypes.windll.user32.GetWindowTextW
GetWindowTextLength = ctypes.windll.user32.GetWindowTextLengthW
SetWindowText = ctypes.windll.user32.SetWindowTextW

STATUSBAR_HANDLE = None
FIND_WHAT = None
REPLACE_WITH = None


def EnumCallback(hwnd, lparam):
    global STATUSBAR_HANDLE
    global FIND_WHAT
    global REPLACE_WITH
    
    curr_class = ctypes.create_unicode_buffer(256)
    GetClassName(hwnd, curr_class, 256)
    
    length = GetWindowTextLength(hwnd)
    buff = ctypes.create_unicode_buffer(length + 1)
    GetWindowText(hwnd, buff, length + 1)
    
    if curr_class.value.lower() == 'msctls_statusbar32':
        STATUSBAR_HANDLE = hwnd
        # return False
    elif curr_class.value.lower() == 'static':
        if buff.value == '&Find what :':
            FIND_WHAT = True
        elif buff.value == 'Rep&lace with :':
            REPLACE_WITH = True
    elif curr_class.value.lower() == 'edit':
        if FIND_WHAT:
            SetWindowText(hwnd, u'xyz789')
            FIND_WHAT = False
        elif REPLACE_WITH:
            REPLACE_WITH = False
            SetWindowText(hwnd, u'123abc')
    else:
        console.write('{}({:^7}) : {}'.format(curr_class.value,hwnd, buff.value) + '\n' )
    return True

Cheers
Claudia

Scott Sumner

So the ideas presented here by @Claudia-Frank I think will allow me to stop using AutoIt in favor of Pythonscript for controlling the Find dialog functions. It seems very nice. To bring this thread back to where it began, here’s a P.S. based upon Claudia’s work that puts the current selection (which can include multiple lines) into the Find dialog’s Replace-with box. The part of it I question for general usage is the .decode('utf-8') – it seems to work for me, but I’m not an encoding expert by any means.

Here’s ReplaceWithBoxFromSelection.py :

import ctypes
from ctypes.wintypes import BOOL, HWND, LPARAM

WNDENUMPROC = ctypes.WINFUNCTYPE(BOOL, HWND, LPARAM)

FindWindow = ctypes.windll.user32.FindWindowW
FindWindowEx = ctypes.windll.user32.FindWindowExW
SendMessage = ctypes.windll.user32.SendMessageW
EnumChildWindows = ctypes.windll.user32.EnumChildWindows
GetClassName = ctypes.windll.user32.GetClassNameW
GetWindowText = ctypes.windll.user32.GetWindowTextW
GetWindowTextLength = ctypes.windll.user32.GetWindowTextLengthW
SetWindowText = ctypes.windll.user32.SetWindowTextW
create_unicode_buffer = ctypes.create_unicode_buffer

replace_tab_caption  = u'Replace'
replacewith_caption = u'Rep&lace with :'
replacewith_is_next_ctrl = False
replacewith_handle = None

def EnumCallback(hwnd, lparam):
    global replacewith_is_next_ctrl
    global replacewith_handle
    curr_class = create_unicode_buffer(256)
    GetClassName(hwnd, curr_class, 256)
    length = GetWindowTextLength(hwnd)
    buff = ctypes.create_unicode_buffer(length + 1)
    GetWindowText(hwnd, buff, length + 1)
    if curr_class.value.lower() == 'static':
        if buff.value == replacewith_caption:
            replacewith_is_next_ctrl = True
    elif curr_class.value.lower() == 'edit':
        if replacewith_is_next_ctrl:
            replacewith_handle = hwnd
            return False  # stop enumeration
    return True  # let enumeration continue

def main():
    msg = ''
    if editor.getSelections() == 1 and not editor.getSelectionEmpty():
        sel = editor.getSelText()
        if len(sel) > 2046:
            sel = sel[:2046]
            msg += 'Warning:  Selected text too long for replace-with box; truncating to 2046 characters.  '
        notepad.menuCommand(MENUCOMMAND.SEARCH_REPLACE)
        find_dialog_hwnd = FindWindow(None, replace_tab_caption)
        if find_dialog_hwnd:
            EnumChildWindows(find_dialog_hwnd, WNDENUMPROC(EnumCallback), 0)
            if replacewith_handle:
                if SetWindowText(replacewith_handle, sel.decode('utf-8')) == 0:
                    msg += 'Error:  Problem setting window text'
            else:
                msg += 'Error:  Bad value for replacewith_handle'
        else:
            msg += 'Error:  Bad value for find_dialog_hwnd'
    else:
        msg += 'Warning:  Nothing to copy into replace-with field'
    if len(msg) > 0: notepad.messageBox(msg)

main()

Claudia Frank

@Scott-Sumner

The part of it I question for general usage is the .decode(‘utf-8’)

I assume your way should work, regardless of the encoding used by the user,
if I understand scintilla and pythonscript plugin correctly.
editor.getSelText() always returns a byte string (python str) but, because we defined
unicode version of SetWindowText, this string needs to be converted as you did.
Maybe I’m wrong.

Cheers
Claudia

Scott Sumner

@Claudia-Frank

I did notice something else that was a bit odd (and drove me a little nuts until I figured out what was going on) when I was working on that script. Let’s see if I can describe it. Usually I work with English_customizable.xml loaded, and everything is consistent and as-expected. When working on that script, I switched back to English.xml, thinking that if I share the script here, it should not use my specific and custom Find dialog captions, but rather the generic English ones.

With English configured, I noticed that when Notepad++ starts up, it doesn’t exactly have English.xml set up, it has something close to it, but not exactly! I found that if I go back into the Preferences, and again select English from the dropdown (even though it is already selected), and have the Find dialog up at the same time, I can watch subtle changes occur in the Find dialog’s label/caption fields. For example, and I can watch a space be inserted (or removed) between “Find what” and the colon that follows (same for “Replace with”. I really have no idea why this is happening. Again, this only happens with English.xml, not English_customizable.xml.

The reason it was making me crazy was that I’d work on the script, have it working fine, then later I would notice it was breaking because it couldn’t find the controls. I kept changing the text strings to make it work and then later it would break again.

guy038

Hello, @scott-sumner and @claudia-frank,

Claudia, your automatic counting of any normal selection, multi-lines or not, works fine !

Scott, your ReplaceWithBoxFromSelection.py script is working nice, too !. I’ve just noticed that your script, automatically, copies the current normal and unique selection, BOTH, in the Find what : and in the Replace with: boxes. Is it the normal behaviour or am I wrong about it ?

This topic makes me think about an other possibility ! Let’s suppose that the option Settings > Preferences…> Editing > Multi-Editing Settings is enabled

Now, the goal would be :

To define TWO selected blocks of text, which could, independently, include multiple lines
To Write a Python script which :
- Opens the Find/Replace dialog
- Writes the first user selection, in the Find what: box
- Writes the second user selection, in the Replace with: box

Scott and Claudia, what is your feeling about it ?

Best Regards,

guy038

Claudia Frank

@Scott-Sumner and @guy038

Scott, I discovered something similar but thought it was related to using npp with wine.
If I open the find dialog and then switch from english to english_customizable and back
to english I loose the >> from “find next” button and the underscores (ampersands in text)
for the “count” and “find all in all opened documents” buttons.
I don’t see it as an issue as you normally set this once and done, but I see why it bothered you. ;-)
I have a shortcut to “Run Previous Script” which I use quite often.
What happens from time to time is that I execute another script while editing
the “current” script and then when I use the shortcut I assume that the current script
should be executed, which isn’t the case as another script was executed in between.
First thought I have in such a case is always, damn - what did I miss why isn’t it working anymore? What did I broke?
Checking the source again and again just to find out that haven’t executed the script. :-)
You see - seems to be “normal” programmer behavior ;-)

Guy, haven’t check it yet but I guess it should be easy to implement, yes.
If Scott, or anyone else hasn’t proposed a solution, I will give it a try in 10-12 hours.
Need to leave now.

Cheers
Claudia

Scott Sumner

@guy038 said:

copies the current normal and unique selection, BOTH, in the Find what : and in the Replace with: boxes

Hmmm. Yes, that is what it does but that was actually UNINTENTIONAL! I guess I didn’t notice because for years I have had an AutoIt script which does just that behavior. A lot of the time when doing replacements, I’m just doing a minor adjustment to the text I am finding, so it saves time to have both the Find-what and Replace-with fields initally set to the same data. I just make my minor tweak to the replace-with part and I am off to the races.

In this thread’s script (ReplaceWithBoxFromSelection.py), however, I believe this happens due to the normal invocation of the Replace command (with notepad.menuCommand(MENUCOMMAND.SEARCH_REPLACE))–when a selection is active, Notepad++ on its own puts the selected text in the Find-what box. Perhaps that is less than desirable here in this script. :(

Scott Sumner

@guy038 said:

This topic makes me think about an other possibility

I like your idea and it should be easy, but I will defer to Claudia as I am extremely busy at the moment. :-D

guy038

Hi, @scott-sumner and @claudia-frank

Many thanks, in advance, for this future script ! This short post give me the opportunity to express, once again, all my gratitude towards you, Claudia and Scott, for your numerous scripts, on various topics, which helped us, significantly, so many times :-D

Cheers,

guy038

Claudia Frank

@guy038, @scott-sumner

Hi Guy,

sorry, family celebration was a bit longer than expected.
Just did the script and some basic tests and discovered that encoding
is an issue like Scott already mentioned.
Will try to find a way to make it work regardless which encoding is used.

Cheers
Claudia

guy038

Hi, @claudia-frank,

Don’t worry, Claudia and just enjoy these family’s moments ! Luckily, we, all, own more valuable things than Notepad++ and some Python scripts :-D

…I’m just thinking about actualities and the death’s celebration of Helmut Kohl. Thanks to him and some important European women and men, we all enjoy, in Europe, a peace period, of near 75 years ! and THIS, it’s a basic point !!

Best Regards,

guy038

Claudia Frank

From my basic tests it looks like it should do the trick.
Tested utf-8, ansi, winows-1250, winows-1251 and winows-1252.
It works only with normal selection - not with column mode selection.

import ctypes
from ctypes.wintypes import BOOL, HWND, LPARAM

WNDENUMPROC = ctypes.WINFUNCTYPE(BOOL, HWND, LPARAM)

FindWindow = ctypes.windll.user32.FindWindowW
FindWindowEx = ctypes.windll.user32.FindWindowExW
SendMessage = ctypes.windll.user32.SendMessageW
EnumChildWindows = ctypes.windll.user32.EnumChildWindows
GetClassName = ctypes.windll.user32.GetClassNameW
GetWindowText = ctypes.windll.user32.GetWindowTextW
GetWindowTextLength = ctypes.windll.user32.GetWindowTextLengthW
SetWindowText = ctypes.windll.user32.SetWindowTextW
GetACP = ctypes.windll.kernel32.GetACP
create_unicode_buffer = ctypes.create_unicode_buffer

replace_tab_caption  = u'Replace'
replacewith_caption = u'Rep&lace with :'
replacewith_is_next_ctrl = False
replacewith_handle = None
replacewith_text = None
findwhat_caption = u'&Find what :'
findwhat_is_next_ctrl = False
findwhat_handle = None
findwhat_text = None


def EnumCallback(hwnd, lparam):
    global replacewith_is_next_ctrl
    global findwhat_is_next_ctrl
    global replacewith_handle
    global findwhat_handle
    curr_class = create_unicode_buffer(256)
    GetClassName(hwnd, curr_class, 256)
    length = GetWindowTextLength(hwnd)
    buff = ctypes.create_unicode_buffer(length + 1)
    GetWindowText(hwnd, buff, length + 1)
    if curr_class.value.lower() == 'static':
        if buff.value == replacewith_caption:
            replacewith_is_next_ctrl = True
        elif buff.value == findwhat_caption:
            findwhat_is_next_ctrl = True
    elif curr_class.value.lower() == 'edit':
        if findwhat_is_next_ctrl:
            findwhat_handle = hwnd
            findwhat_is_next_ctrl = False
        elif replacewith_is_next_ctrl:
            replacewith_handle = hwnd
            replacewith_is_next_ctrl = False
            return False  # stop enumeration
    return True  # let enumeration continue

def return_proper_string(selected_text):
    if notepad.getEncoding() == BUFFERENCODING.ENC8BIT:
        _selected_text = unicode(selected_text, '{}'.format(GetACP()))
    else:
        _selected_text = unicode(selected_text, 'utf-8')
    return _selected_text

def main():
    msg = ''
    if editor.getSelections() == 2:
        if editor.getSelectionMode() == 0 and not editor.getSelectionEmpty():
            _find_what = editor.getTextRange(editor.getSelectionNStart(0), editor.getSelectionNEnd(0))
            _replace_with = editor.getTextRange(editor.getSelectionNStart(1), editor.getSelectionNEnd(1))

            if len(_find_what) > 2046:
                _find_what = _find_what[:2046]
                msg += 'Warning:  Selected text too long for find-what box; truncating to 2046 characters.  '
                    
            if len(_replace_with) > 2046:
                _replace_with = _replace_with[:2046]
                msg += 'Warning:  Selected text too long for replace-with box; truncating to 2046 characters.  '
                                        
            notepad.menuCommand(MENUCOMMAND.SEARCH_REPLACE)
            find_dialog_hwnd = FindWindow(None, replace_tab_caption)
            
            if find_dialog_hwnd:
                EnumChildWindows(find_dialog_hwnd, WNDENUMPROC(EnumCallback), 0)
                if findwhat_handle and replacewith_handle:
                    if SetWindowText(findwhat_handle, return_proper_string(_find_what)) == 0:
                        msg += 'Error:  Problem setting find-what text'
                    if SetWindowText(replacewith_handle, return_proper_string(_replace_with)) == 0:
                        msg += 'Error:  Problem setting replace-with text'
                else:
                    msg += 'Error:  Bad value for replacewith_handle'
            else:
                msg += 'Error:  Bad value for find_dialog_hwnd'
        else:
            msg += 'Error:  Either empty selection or unsupported selection mode detected'
    else:
        msg += 'Warning:  Only two selections are possible. Received:{}'.format(editor.getSelections())
    if len(msg) > 0: notepad.messageBox(msg)

main()

Cheers
Claudia

guy038

Hello, @claudia-frank,

What to say else ? Just wonderful and awesome, indeed !!!

I already tested the case of rectangular selection(s) and the upper limit of 2046 characters => No problem, it acts as expected :-)

Now, as always, when building a program, there’s a small bug with the lower limit of 0 character !

I, successively, tried to make an empty search selection, then an empty replace selection and, finally, both search and replace selections empty.

Note : To obtain, physically, a zero-length selection, I just select one character with the mouse, then move back the mouse, with a possible hit on the CTRL key, to only get the caret

Results :

If both selections are empty, the message Error: Either empty selection or unsupported selection mode detected occurs, as expected. Nice !
If, ONLY, the search selection is empty, the Find/Replace opens normally. May be, in that case, Claudia, a message would be better !
If, ONLY, the replace selection is empty, the Find/Replace opens normally, with the Find what: box filled and the Replace with: empty. That the expected behaviour, in order to delete all the search blocks of text found

I also noticed that if I Ctrl + click and select some text, ONLY, it is, logically, inserted in the Replace with box, leaving the Find what: box empty :-D

But, if I, simply, click, without the Ctrl key, and select some text, the message Warning: Only two selections are possible. Received:1 occurs. However, Claudia, I think it’s a valid case.

So, in the case of a normal selection 0, only, the Find/Replace dialog should pop up and contain :

A Find what: box, filled with the selection contents
A Replace with: box, wiped out of any [previous] character

Best Regards,

guy038

P.S. :

I found out something weird, but logic : If I build a one-line rectangular selection, this selection is correctly written in the Find what: box !!

Claudia Frank

@guy038

Guy, here the updated one.
A “one-selection” action results in opening the standard replace dialog behavior.
A “two-selections” action, even with an empty one, results in modifying the fields.
I see it as a benefit that you are able to decide that only one of the fields should be filled
and the other should be empty in any case.

import ctypes
from ctypes.wintypes import BOOL, HWND, LPARAM

WNDENUMPROC = ctypes.WINFUNCTYPE(BOOL, HWND, LPARAM)

FindWindow = ctypes.windll.user32.FindWindowW
FindWindowEx = ctypes.windll.user32.FindWindowExW
SendMessage = ctypes.windll.user32.SendMessageW
EnumChildWindows = ctypes.windll.user32.EnumChildWindows
GetClassName = ctypes.windll.user32.GetClassNameW
GetWindowText = ctypes.windll.user32.GetWindowTextW
GetWindowTextLength = ctypes.windll.user32.GetWindowTextLengthW
SetWindowText = ctypes.windll.user32.SetWindowTextW
GetACP = ctypes.windll.kernel32.GetACP
create_unicode_buffer = ctypes.create_unicode_buffer

replace_tab_caption  = u'Replace'
replacewith_caption = u'Rep&lace with :'
replacewith_is_next_ctrl = False
replacewith_handle = None
replacewith_text = None
findwhat_caption = u'&Find what :'
findwhat_is_next_ctrl = False
findwhat_handle = None
findwhat_text = None


def EnumCallback(hwnd, lparam):
    global replacewith_is_next_ctrl
    global findwhat_is_next_ctrl
    global replacewith_handle
    global findwhat_handle
    curr_class = create_unicode_buffer(256)
    GetClassName(hwnd, curr_class, 256)
    length = GetWindowTextLength(hwnd)
    buff = ctypes.create_unicode_buffer(length + 1)
    GetWindowText(hwnd, buff, length + 1)
    if curr_class.value.lower() == 'static':
        if buff.value == replacewith_caption:
            replacewith_is_next_ctrl = True
        elif buff.value == findwhat_caption:
            findwhat_is_next_ctrl = True
    elif curr_class.value.lower() == 'edit':
        if findwhat_is_next_ctrl:
            findwhat_handle = hwnd
            findwhat_is_next_ctrl = False
        elif replacewith_is_next_ctrl:
            replacewith_handle = hwnd
            replacewith_is_next_ctrl = False
            return False  # stop enumeration
    return True  # let enumeration continue

def return_proper_string(selected_text):
    if notepad.getEncoding() == BUFFERENCODING.ENC8BIT:
        _selected_text = unicode(selected_text, '{}'.format(GetACP()))
    else:
        _selected_text = unicode(selected_text, 'utf-8')
    return _selected_text

def main():
    msg = ''
    if editor.getSelections() == 1:
        notepad.menuCommand(MENUCOMMAND.SEARCH_REPLACE)
    elif editor.getSelections() == 2:
        if editor.getSelectionMode() == 0 and not editor.getSelectionEmpty():
            _find_what = editor.getTextRange(editor.getSelectionNStart(0), editor.getSelectionNEnd(0))
            _replace_with = editor.getTextRange(editor.getSelectionNStart(1), editor.getSelectionNEnd(1))

            if len(_find_what) > 2046:
                _find_what = _find_what[:2046]
                msg += 'Warning:  Selected text too long for find-what box; truncating to 2046 characters.  '
                    
            if len(_replace_with) > 2046:
                _replace_with = _replace_with[:2046]
                msg += 'Warning:  Selected text too long for replace-with box; truncating to 2046 characters.  '
                                        
            notepad.menuCommand(MENUCOMMAND.SEARCH_REPLACE)
            find_dialog_hwnd = FindWindow(None, replace_tab_caption)
            
            if find_dialog_hwnd:
                EnumChildWindows(find_dialog_hwnd, WNDENUMPROC(EnumCallback), 0)
                if findwhat_handle and replacewith_handle:
                    if SetWindowText(findwhat_handle, return_proper_string(_find_what)) == 0:
                        msg += 'Error:  Problem setting find-what text'
                    if SetWindowText(replacewith_handle, return_proper_string(_replace_with)) == 0:
                        msg += 'Error:  Problem setting replace-with text'
                else:
                    msg += 'Error:  Bad value for replacewith_handle'
            else:
                msg += 'Error:  Bad value for find_dialog_hwnd'
        else:
            msg += 'Error:  Either empty selection or unsupported selection mode detected'
    else:
        msg += 'Warning:  Only one or two selections are possible. Received:{}'.format(editor.getSelections())
    if len(msg) > 0: notepad.messageBox(msg)

main()

Cheers
Claudia

guy038

Hello, @claudia-frank, @Scott-sumner, @pouemes44, @go2to, @jorge-campos, @herofiles, @azjio-azjio, @alan-kilborn and All

Thanks to @claudia-frank, this present topic and the discussions, below, about multi-lines search AND multi-lines Replacement :

https://notepad-plus-plus.org/community/topic/13823/replace-function/1

https://notepad-plus-plus.org/community/topic/13684/feature-request-textarea-search-replace/1

have, now, an ELEGANT solution, with her Python’s script, just above !

You just need to be able to do multiple selections ( Option Settings > Preferences… > Editing > Multi-Editing Settings > Enable CHECKED )

BTW, the upper limit of 2046 characters, in the Find what: box of the Find/Replace dialog, only, could be by-passed, easily :-). Indeed, just use the Regular expression search mode and use the generic regex (?s)Left-boundary.+?Right-boundary !

For instance, you can choose a particular character, which does not exist,yet, in your file(s) to be modified, and build the regex :

(?s)(#####\R).+?\1

This regex contains any non-null amount of characters between TWO same complete lines #####, with their line-breaks

So :

Do a normal selection of this regex (?s)(#####\R).+?\1, using the mouse
Then, with a Ctrl + Left Click action, simply, select your Replace block, multi-lines or not
Run the Claudia’s script above

=> Immediately, the Find/Replace dialog pops-up and :

The Find what: box is filled with the regex (?s)(#####\R).+?\1
The Replace with: box is filled with the block of text, which must replace the searched text

Best Regards,

guy038

P.S. :

@claudia-frank, I understand your point of view. Your script is quite flexible :-D. For instance, I was able to :

First, do a Ctrl + Clic selection of a multi-lines block of text
Run your script => Find what: box empty and Replace with: box filled with that multi-lines block
Select an second file, containing the text (?s)(#####\R).+?\1
Do a normal selection of that regex
Run again, your script => The find.Replace dialog, presently in the background, is, then, updated with this regex, filled in the Find what: box
Select a third file, containing the ##### boundaries lines
Perform the S/R on the contents of this third file

Et voilà !!

Many thanks, again, for this very, very, valuable script, indeed !!!

Hum… Already 3 h 25 !! I’d better go to bed : working tomorrow !

AZJIO AZJIO

It would be nice if the author would make an additional window when the button is clicked
[http://radikal.ru/big/m0wcdchejv3ve](link url)

AZJIO AZJIO

The external program is working. I make a plugin and no longer works (EnumChildWindows).

Eko palypse

Sorry, but what are you try to tell us?
Which external program and which meaning has EnumChildWindows API in this context?