Find-in-FIles: Can’t Replace Multiple Instances of Word

Sylvester Bullitt

@Alan-Kilborn Seems to me a simple modification to NPP’s logic for a multi-file search-and-replace might handle it:

loop_for_each_file {
   Perform the search-and-replace on the file.
   If search found zero matches {
       Exit the loop, and proceed to next file.
   } 
  Else return to top of loop & repeat the search-and-replace
} end_loop

The secret sauce is: Don’t exit the loop until zero matches are found in the file. That ensures that all instances of the search term have been found and replaced.

And yes, there is a performance hit. But (1) it only occurs if there are multiple matches in the file and (2) the hit is minuscule compared to the work involved in making all the extra search-and-replaces manually. In my use case, I’ll have to perform manual search-and-replaces on about 500 files, which is a non-starter.

Another option would be to simply use the same search-and-replace logic that is invoked by the Replace All button on the single-file-search-and-replace dialog.

Alan Kilborn

@Sylvester-Bullitt said:

a simple modification to NPP’s logic for a multi-file search-and-replace might handle it
Don’t exit the loop until zero matches are found in the file. That ensures that all instances of the search term have been found and replaced

You can try making an official feature request for it if you’d like; see HERE for tips on doing so.

The idea has some downsides, that may limit its appeal to developers:

it isn’t a frequent need
it wouldn’t be used by many users
it could introduce “infinite loop” potential that would need to be addressed (consider simple and unrealistic – but possible – case of replacing a with a)

There may be more downsides (haven’t had enough coffee yet this morning to fully consider), but even the last point above is enough such that calling it “a simple modification” is an oversimplification…

Alan Kilborn

@Sylvester-Bullitt

If you’d be receptive to PythonScript scripting within Notepad++, I could give you some tips for your specific need, but I won’t bother unless you have some enthusiasm for it.

Sylvester Bullitt

@Alan-Kilborn Those downsides are easily avoided:

Since only few users might want that functionality, use the current behavior as the default. Use the new behavior as a selectable option (e.g., a check box).
To avoid the infinite loop: Compare the search string with the replacement string before beginning the operation. If they’re identical, show an error message to the user and and do nothing else.

Alan Kilborn

@Sylvester-Bullitt said:

use the current behavior as the default. Use the new behavior as a selectable option (e.g., a check box).

Well, that much is obvious, but it does nothing for any deeper problems.
Of course, if you actually make a true feature request, you should go a step further and provide some suggested captioning for the checkbox.

Those downsides are easily avoided

…before beginning the operation. If they’re identical…

Sorry, no. In your naïveté, you can’t see it. Like a lot of users, you oversimplify a situation…and think software is “easy” (you’ve stated that twice now, tsk tsk).

But it is all moot anyway, unless you make a feature request as a first step.

Cheers, and good luck.

PeterJones

@Sylvester-Bullitt said in Find-in-FIles: Can’t Replace Multiple Instances of Word:

Is there some reason this functionality couldn’t be added to the search-and-replace in multiple files?

Your regex doesn’t do all the replacements in a single file when you do Replace All once, and you have to hit Replace or Replace All multiple times to get it to work, even with your “wraparound” option in a single file. Why would you expect the Find in Files version to behave any differently across multiple files? The problem is not with Notepad++'s user interface not having enough options, but in your understanding of the regex involved, and the way that “wrap around” works.

Regarding “wrap around”: <PrincessBride character="Inigo">I do not think that word means what you think it means</PricessBride>. It’s a holdover from the terminology present in Microsoft Windows’ “notepad.exe” search dialog for time immemorial: they called it “wrap around”, because in normal searches, the search starts where your cursor is, but if it reaches the end of the file, it “wraps around” to the beginning once.

In the Notepad++ implementation, it follows that behavior for a standard search or replace. But with Search All or Replace All, as described here, it makes exactly one pass through the entire document, starting at the beginning (regardless of where your caret is) and going through the very end.

This “exactly one pass” is why your original regex with Replace All in one file didn’t replace all instances unless you hit it multiple times, and it’s exactly the same reason it doesn’t Replace All in Files when you hit Replace All once.

You designed a regex that “consumes” too much of the data, so it cannot do it all in one – unless you put it into an infinite loop mode (which I think is not the right idea, nor do I think Notepad++ should have to implement an “infinite loop mode”). The regex syntax has a \G assertion, which means “match at the end of previous match”, which can be used in a regex alternation to good effect (see, for example, it’s use in the FAQ: Generic Regex => Replacing in a Zone, where once you enter a zone, \G allows you to continue in the same zone, even though the regex cannot “see” the beginning of the zone any more.

A simple example text to show what \G allows in an alternation:

line prefix: word another word final word
word another word final word
line prefix: word another word final word

The regex FIND=^line prefix:.*?\Kword REPLACE=newText only replaces the first word on the line prefix: lines, so you have to hit Replace All three times to do them all.

But if you change it to FIND=(^line prefix:|\G).*?\Kword, then the same action only takes one Replace All.

Thus, if your original regex was working for doing a single replacement that had to be run multiple times:

lyrics-text.+?(?<!^)(?<!<p>)(?<!<p class="chorus">)\Kword_to_find(?=(.+?</div>))

… then my guess is that this slight change, putting an alternation group before the \K with a \G as the second choice in the alternative section, would work (but I don’t have the time to test it out thoroughly for you):

(?:lyrics-text|\G).+?(?<!^)(?<!<p>)(?<!<p class="chorus">)\Kword_to_find(?=(.+?</div>))

----

Useful References

Sylvester Bullitt

@PeterJones Interesting. I’ve never had an occasion to use /g before. Maybe now’s the time for me to learn something new about the mysteries of regex.

At any rate, I probably won’t be able to look at it today. I’ll try to start digging into your suggestions tomorrow. Thanks for taking the time to give such detailed feedback!

PeterJones

@Sylvester-Bullitt said in Find-in-FIles: Can’t Replace Multiple Instances of Word:

/g

Exact characters and capitalization are important in regex. /g means "the literal / character followed by the literal lower-case g character; whereas I used \G , which is the Continuation Escape found in the Anchors section of the regex documentation , and holds special meaning to regex. Using the /g instead of \G will not give the same results.

Coises

@Sylvester-Bullitt said in Find-in-FIles: Can’t Replace Multiple Instances of Word:

Regarding a scripting language, I am familiar with PowerShell (posh). Could you give me some insight on how you think posh might be used with NPP?

I would not attempt to use PowerShell with, but rather instead of Notepad++.

I’m afraid I haven’t yet learned PowerShell (despite using it anyway), but you probably want to start by reviewing:

Get-ChildItem
Get-Content
New-Item
about Regular Expressions
-match and -replace operators

Establish a folder where you’ll put your results.
Get the collection of files you want to examine.
For each file, get the content.
Determine if the content requires modification.
Iterate through the content making the needed modifications.
Copy the file if it’s unchanged, write a new file if it is changed.

Sylvester Bullitt

@Coises Got it. Thanks!

Sylvester Bullitt

@PeterJones I tried the regex modification you suggested

(?:lyrics-text|\G).+?(?<!^)(?<!<p>)(?<!<p class="chorus">)\Kstar(?=(.+?</div>))

To keep it simple, I ran it against a single file in the editor (rather than multiple files on disk). The file text that was in the editor:

<!DOCTYPE HTML>
<html lang="en-us">

<head>
<meta charset="utf-8">
<title>Twinkle, Twinkle, Little Star</title>
<meta name="description" content="Words: Jane Taylor, 1806. Music: ___, ___">
<meta name="keywords" content="Jane Taylor">
<link rel="stylesheet" href="../../css/hymn.css">
<script src="../../js/jquery.js"></script>
<script src="../../js/base.js"></script>
<script src="../../js/hymn.js"></script>
<link rel="prev" href="../../htm/h/e/w/o/hewonsav.htm">
<link rel="next" href="../../htm/h/e/s/a/hesallwo.htm">
<link rel="up" href="../../ttl/ttl-h.htm">
</head>

<body>

<section id="preface">
<h1 class="screen-reader-only">Introduction</h1>
<div class="preface-text">
<p><span class="lead">Words:</span> <a href="../../bio/t/a/y/l/taylor_jane.htm">Jane Taylor</a>, 1806.</p>
<p><span class="lead">Music:</span> John Doe  (<a href="../../mid/d/u/m/m/dummy.mid" title="Listen to music, MIDI format">🔊</a> <a href="../../pdf/en/d/u/m/m/Dummy.pdf" title="Download score, PDF format">pdf</a> <a href="../../nwc/d/u/m/m/Dummy.nwc" title="Download score, Noteworthy Composer format">nwc</a>).</p>
</div>
</section>

<p>This page is used to test global search-and-replace using regular expressions.</p>

<section class="lyrics">
<h1 class="screen-reader-only">Lyrics</h1>
<div class="stanzas"><div class="lyrics-text mc ll">
<p>Twinkle, twinkle, little star,<br>
How I wonder what you are!<br>
Up above the world so high,<br>
Like a diamond in the sky.</p>
<p>When the blazing sun is gone,<br>
When he nothing shines upon,<br>
Then you show your little light,<br>
Twinkle, twinkle, all the night.</p>
<p>Then the trav’ller in the dark,<br>
Thanks you for your tiny spark,<br>
He could not see which way to go,<br>
If you did not twinkle so.</p>
<p>In the dark blue sky you keep,<br>
And often thro’ my curtains peep,<br>
For you never shut your eye,<br>
Till the sun is in the sky.</p>
<p>’Tis your bright and tiny spark,<br>
Lights the trav’ller in the dark:<br>
Tho’ I know not what you are,<br>
Twinkle, twinkle, little star.</p>
</div></div>
</section>

</body>
</html>

I put the cursor at the beginning of the file, clicked the Find Next button. and got this error.

If I click the Replace All button instead, a different message appears: Replace All: 0 occurrences were replaced in entire file.

PeterJones

@Sylvester-Bullitt said in Find-in-FIles: Can’t Replace Multiple Instances of Word:

The file text that was in the editor:

I tried that text with your original regex from your first post, and got the same result.

As I said, “if your original regex was working for doing a single replacement that had to be run multiple times”. Your text didn’t match your regex even once, thus the “if” condition was not met, and you should not expect my modification to work.

Sylvester Bullitt

@PeterJones Oops. Mea culpa.

Forgot to change the search mode to Regular Expression. After doing that, and clicking Replace All, all 3 occurrences were replaced in one fell swoop. Sorry for the confusion.

My next step is to try it on multiple files on the hard disk.

Whew!

PeterJones

@PeterJones said in Find-in-FIles: Can’t Replace Multiple Instances of Word:

I tried that text with your original regex from your first post, and got the same result.

My test of your regex+data was failing for a different reason than your test had failed: as you said, yours failed because you forgot to enable Regular Expression mode.

My test, on the other hand, failed because I didn’t have “. matches newline” checkmarked. Once I did that, I could get the search to work with either your original or my edited regex.

Sylvester Bullitt

@PeterJones I love it when a plan comes together!

Will let you know how testing goes “in the wild” (i.e., on actual files).

PeterJones

@Sylvester-Bullitt said in Find-in-FIles: Can’t Replace Multiple Instances of Word:

(?:lyrics-text|\G).+?(?<!^)(?<!<p>)(?<!<p class="chorus">)\Kstar(?=(.+?</div>))
…
all 3 occurrences were replaced in one fell swoop.

I was surprised it was 3 occurrences, because the first occurrence was before lyrics-text.

I was reminded that the \G can actually match the start of the text under certain circumstances. This isn’t 100% clear in the User Manual, but in the Boost Regex documentation that it links to, it says (emphasis mine),

The sequence \G matches only at the end of the last match found, or at the start of the text being matched if no previous match was found.

To prevent \G from matching the start, you need to make sure the first alternative consumes the \A: FIND = (?s)(\A.*?lyrics-text|\G).+?(?<!^)(?<!<p>)(?<!<p class="chorus">)\Kstar(?=(.+?</div>))
With that, it only finds and replaces 2 in your “Twinkle Twinkle” file, instead of 3.

Coises

This post is deleted!

PeterJones

@PeterJones said in Find-in-FIles: Can’t Replace Multiple Instances of Word:

This isn’t 100% clear in the User Manual,

I have tweaked the UM to include the phrase from the boost manual, to make it more clear. It is doubtful anything I write, especially regarding regular expressions, can be 100% clear. ;-)

Sylvester Bullitt

@PeterJones Peter, I’m unfamiliar with the syntax (?:lyrics-text|\G). It resembles a lookbehind, but all the lookbehinds I’ve seen look like (? <=a) (i.e., no colon). What exactly is this thing? Where is it documented?

Coises

@PeterJones said in Find-in-FIles: Can’t Replace Multiple Instances of Word:

To prevent \G from matching the start, you need to make sure the first alternative consumes the \A: FIND = (?s)(\A.*?lyrics-text|\G).+?(?<!^)(?<!<p>)(?<!<p class=“chorus”>)\Kstar(?=(.+?</div>))
With that, it only finds and replaces 2 in your “Twinkle Twinkle” file, instead of 3.

It might not matter in @Sylvester-Bullitt’s application, but it should be noted that if the file does not contain the text lyrics-text at all, the expression given will replace every occurrence of star.