Matching Multi-Line Regular Expression Patterns In MULTILINE Mode (?m)

Posted November 5, 2009 at 2:04 PM

Tags: ColdFusion

This morning, I was (and am still) having a problem getting some MULTILINE regular expression patterns to match properly. As such, I wanted to put a quick blog post together as a sanity check for myself. As I have blogged about before, when a Java regular expression is running in multiline mode (as denoted by the "?m" flag), the "^" and "$" expressions match the line start and line terminator (respectively) rather than the start and end of the source string. This allows us to do line-level pattern matching.

This is really useful; but, when we are running our regular expressions in multiline mode, we have to be aware that the new line and carriage return data is not matched inside of the ^ and $ expressions. As such, if we want to match a pattern across multiple lines in multiline mode, we have to define the new line and carriage return expressions explicitly in our pattern. To see this, take a look at the following demo:

 Launch code in new window » Download code as text file »

  • <!--- Store target data. --->
  • <cfsavecontent variable="data">
  • AAAAAAAAAABBBBBBBBBB
  • CCCCCCCCCCDDDDDDDDDD
  • EEEEEEEEEEFFFFFFFFFF
  • GGGGGGGGGGHHHHHHHHHH
  • </cfsavecontent>
  •  
  • <!---
  • Create the Java pattern. Note that we are using the
  • MULTILINE mode flag; this will allow ^ and $ to match the
  • line delimiters.
  • --->
  • <cfset pattern = createObject( "java", "java.util.regex.Pattern" )
  • .compile(
  • javaCast(
  • "string",
  • (
  • "(?m)D.++$" &
  • "(\r\n?|\n)" &
  • "^.*+$" &
  • "(\r\n?|\n)" &
  • "^G"
  • ))
  • )
  • />
  •  
  • <!--- Get the matcher for our target text. --->
  • <cfset matcher = pattern.matcher(
  • javaCast( "string", trim( data ) )
  • ) />
  •  
  • <!--- Move to the first match. --->
  • <cfset matcher.find() />
  •  
  • <!--- Output the first match. --->
  • [#matcher.group()#]

Here, we start out matching the letter "D" and then everything until the end of the line (remember that in Java, the "dot" does not match line terminators until DOTALL mode [aka. single-line mode] is turned on using ?s). We then add the line terminators to the pattern. We then match the entire next line and match its line terminators. We then match the line start followed by "G". When we run this code, we get the followingg output:

[DDDDDDDDDD
EEEEEEEEEEFFFFFFFFFF
G]

Anyway, nothing revolutionary going on here; like I said above, I mostly put this post together as a sanity check for myself to make sure that I really understood what was going on in Java's multiline mode.

Download Code Snippet ZIP File

Post Comment  |  Ask Ben  |  Permalink  |  Other Searches  |  Print Page





Reader Comments

Nov 5, 2009 at 2:43 PM // reply »
29 Comments

Did you look to see if it would return the end of line character if in single line mode? I have an idea how I would go about it and may try it later.


Nov 5, 2009 at 3:34 PM // reply »
2 Comments

The way that expression is written, you know you'll have exactly one line between the DDD line and the line that starts with a G. Was that your intention? If you add a line or even a blank line no match is found. If you need more flexibility may I suggest something like:

"(?m)D+$(\r\n?|\n)((^.*$)(\r\n?|\n))+^G"

a match is found even with:

<cfsavecontent variable="data">
AAAAAAAAAABBBBBBBBBB
CCCCCCCCCCDDDDDDDDDD
EEEEEEEEEEFFFFFFFFFF

T

GGGGGGGGGGHHHHHHHHHH
</cfsavecontent>


Nov 5, 2009 at 3:48 PM // reply »
6,516 Comments

@Daniel,

Hmm, I think it would. When in single line mode, the dot will match line terminators, which means that .++ should possessively match ALL characters until it hits the end of the string.

@Travis,

Yes, I mean to only match a single line between the D and G (that was more along the lines of the use case I was trying to debug). But yes, the way you have it would be more flexible.


Nov 8, 2009 at 10:06 AM // reply »
2 Comments

This is a good web log and i like it.
It will help people to learn ColdFusion.


Post Comment  |  Ask Ben

Recent Blog Comments
Nov 21, 2009 at 5:15 PM
Using ColdFusion Structures To Remove Duplicate List Values
@Jose Galdamez, Oh heh yeah I didn't paste the whole code. I should have defined the vars -- my bad. It's fixed thou. Thanks. ... read »
Nov 21, 2009 at 4:49 PM
Styling The ColdFusion 8 WriteToBrowser CFImage Output
Great work yet again Ben! Whilst I didn't use this whole code, I copied some of your regex code for a similar problem with the lack of an alt attribute and unescaped ampersands in CFIMAGE for Railo 3 ... read »
Nov 21, 2009 at 1:13 PM
My First ColdFusion Builder Extension - Encrypting And Decrypting CFM / CFC Files
@Ben, Because I am pedantic, I just want to make sure that everyone knows there is absolutely no encryption going on. There is only encoding and obfuscation. The cfencode tool only obfuscates your C ... read »
Nov 21, 2009 at 12:28 PM
Using ColdFusion Structures To Remove Duplicate List Values
@Jody I can't seem to get your code sample to work. If you are still having problems, try this code out and see if it gets you what you wanted. <!--- Comma delimited list with various duplicates ... read »
Nov 21, 2009 at 11:03 AM
Groovy Operator Overloading Does Not Work In The ColdFusion Context
Hi Ben, Thanks for this informative post. Now I am reading ur old posts too ... read »
Nov 21, 2009 at 10:56 AM
HostMySite.com Has The Best ColdFusion Hosting
@Mehul, Yes very nice people, however several downtimes per day which was not acceptable. Hence we had to move out. I am glad you are having good luck with them so far. ... read »
Nov 20, 2009 at 11:32 PM
Five Months Without Hungarian Notation And I'm Loving It
I've used headless camel case for years for not only ColdFusion variables, but also SQL tables and fields... pretty much everything involving code. I also subscribe to the "don't abbreviate and clea ... read »