Table of Contents for
Regular Expressions Cookbook, 2nd Edition

Version ebook / Retour

Cover image for bash Cookbook, 2nd Edition Regular Expressions Cookbook, 2nd Edition by Steven Levithan Published by O'Reilly Media, Inc., 2012
  1. Cover
  2. Regular Expressions Cookbook
  3. Preface
  4. Caught in the Snarls of Different Versions
  5. Intended Audience
  6. Technology Covered
  7. Organization of This Book
  8. Conventions Used in This Book
  9. Using Code Examples
  10. Safari® Books Online
  11. How to Contact Us
  12. Acknowledgments
  13. 1. Introduction to Regular Expressions
  14. Regular Expressions Defined
  15. Search and Replace with Regular Expressions
  16. Tools for Working with Regular Expressions
  17. 2. Basic Regular Expression Skills
  18. 2.1. Match Literal Text
  19. 2.2. Match Nonprintable Characters
  20. 2.3. Match One of Many Characters
  21. 2.4. Match Any Character
  22. 2.5. Match Something at the Start and/or the End of a Line
  23. 2.6. Match Whole Words
  24. 2.7. Unicode Code Points, Categories, Blocks, and Scripts
  25. 2.8. Match One of Several Alternatives
  26. 2.9. Group and Capture Parts of the Match
  27. 2.10. Match Previously Matched Text Again
  28. 2.11. Capture and Name Parts of the Match
  29. 2.12. Repeat Part of the Regex a Certain Number of Times
  30. 2.13. Choose Minimal or Maximal Repetition
  31. 2.14. Eliminate Needless Backtracking
  32. 2.15. Prevent Runaway Repetition
  33. 2.16. Test for a Match Without Adding It to the Overall Match
  34. 2.17. Match One of Two Alternatives Based on a Condition
  35. 2.18. Add Comments to a Regular Expression
  36. 2.19. Insert Literal Text into the Replacement Text
  37. 2.20. Insert the Regex Match into the Replacement Text
  38. 2.21. Insert Part of the Regex Match into the Replacement Text
  39. 2.22. Insert Match Context into the Replacement Text
  40. 3. Programming with Regular Expressions
  41. Programming Languages and Regex Flavors
  42. 3.1. Literal Regular Expressions in Source Code
  43. 3.2. Import the Regular Expression Library
  44. 3.3. Create Regular Expression Objects
  45. 3.4. Set Regular Expression Options
  46. 3.5. Test If a Match Can Be Found Within a Subject String
  47. 3.6. Test Whether a Regex Matches the Subject String Entirely
  48. 3.7. Retrieve the Matched Text
  49. 3.8. Determine the Position and Length of the Match
  50. 3.9. Retrieve Part of the Matched Text
  51. 3.10. Retrieve a List of All Matches
  52. 3.11. Iterate over All Matches
  53. 3.12. Validate Matches in Procedural Code
  54. 3.13. Find a Match Within Another Match
  55. 3.14. Replace All Matches
  56. 3.15. Replace Matches Reusing Parts of the Match
  57. 3.16. Replace Matches with Replacements Generated in Code
  58. 3.17. Replace All Matches Within the Matches of Another Regex
  59. 3.18. Replace All Matches Between the Matches of Another Regex
  60. 3.19. Split a String
  61. 3.20. Split a String, Keeping the Regex Matches
  62. 3.21. Search Line by Line
  63. Construct a Parser
  64. 4. Validation and Formatting
  65. 4.1. Validate Email Addresses
  66. 4.2. Validate and Format North American Phone Numbers
  67. 4.3. Validate International Phone Numbers
  68. 4.4. Validate Traditional Date Formats
  69. 4.5. Validate Traditional Date Formats, Excluding Invalid Dates
  70. 4.6. Validate Traditional Time Formats
  71. 4.7. Validate ISO 8601 Dates and Times
  72. 4.8. Limit Input to Alphanumeric Characters
  73. 4.9. Limit the Length of Text
  74. 4.10. Limit the Number of Lines in Text
  75. 4.11. Validate Affirmative Responses
  76. 4.12. Validate Social Security Numbers
  77. 4.13. Validate ISBNs
  78. 4.14. Validate ZIP Codes
  79. 4.15. Validate Canadian Postal Codes
  80. 4.16. Validate U.K. Postcodes
  81. 4.17. Find Addresses with Post Office Boxes
  82. 4.18. Reformat Names From “FirstName LastName” to “LastName, FirstName”
  83. 4.19. Validate Password Complexity
  84. 4.20. Validate Credit Card Numbers
  85. 4.21. European VAT Numbers
  86. 5. Words, Lines, and Special Characters
  87. 5.1. Find a Specific Word
  88. 5.2. Find Any of Multiple Words
  89. 5.3. Find Similar Words
  90. 5.4. Find All Except a Specific Word
  91. 5.5. Find Any Word Not Followed by a Specific Word
  92. 5.6. Find Any Word Not Preceded by a Specific Word
  93. 5.7. Find Words Near Each Other
  94. 5.8. Find Repeated Words
  95. 5.9. Remove Duplicate Lines
  96. 5.10. Match Complete Lines That Contain a Word
  97. 5.11. Match Complete Lines That Do Not Contain a Word
  98. 5.12. Trim Leading and Trailing Whitespace
  99. 5.13. Replace Repeated Whitespace with a Single Space
  100. 5.14. Escape Regular Expression Metacharacters
  101. 6. Numbers
  102. 6.1. Integer Numbers
  103. 6.2. Hexadecimal Numbers
  104. 6.3. Binary Numbers
  105. 6.4. Octal Numbers
  106. 6.5. Decimal Numbers
  107. 6.6. Strip Leading Zeros
  108. 6.7. Numbers Within a Certain Range
  109. 6.8. Hexadecimal Numbers Within a Certain Range
  110. 6.9. Integer Numbers with Separators
  111. 6.10. Floating-Point Numbers
  112. 6.11. Numbers with Thousand Separators
  113. 6.12. Add Thousand Separators to Numbers
  114. 6.13. Roman Numerals
  115. 7. Source Code and Log Files
  116. Keywords
  117. Identifiers
  118. Numeric Constants
  119. Operators
  120. Single-Line Comments
  121. Multiline Comments
  122. All Comments
  123. Strings
  124. Strings with Escapes
  125. Regex Literals
  126. Here Documents
  127. Common Log Format
  128. Combined Log Format
  129. Broken Links Reported in Web Logs
  130. 8. URLs, Paths, and Internet Addresses
  131. 8.1. Validating URLs
  132. 8.2. Finding URLs Within Full Text
  133. 8.3. Finding Quoted URLs in Full Text
  134. 8.4. Finding URLs with Parentheses in Full Text
  135. 8.5. Turn URLs into Links
  136. 8.6. Validating URNs
  137. 8.7. Validating Generic URLs
  138. 8.8. Extracting the Scheme from a URL
  139. 8.9. Extracting the User from a URL
  140. 8.10. Extracting the Host from a URL
  141. 8.11. Extracting the Port from a URL
  142. 8.12. Extracting the Path from a URL
  143. 8.13. Extracting the Query from a URL
  144. 8.14. Extracting the Fragment from a URL
  145. 8.15. Validating Domain Names
  146. 8.16. Matching IPv4 Addresses
  147. 8.17. Matching IPv6 Addresses
  148. 8.18. Validate Windows Paths
  149. 8.19. Split Windows Paths into Their Parts
  150. 8.20. Extract the Drive Letter from a Windows Path
  151. 8.21. Extract the Server and Share from a UNC Path
  152. 8.22. Extract the Folder from a Windows Path
  153. 8.23. Extract the Filename from a Windows Path
  154. 8.24. Extract the File Extension from a Windows Path
  155. 8.25. Strip Invalid Characters from Filenames
  156. 9. Markup and Data Formats
  157. Processing Markup and Data Formats with Regular Expressions
  158. 9.1. Find XML-Style Tags
  159. 9.2. Replace Tags with
  160. 9.3. Remove All XML-Style Tags Except and
  161. 9.4. Match XML Names
  162. 9.5. Convert Plain Text to HTML by Adding

    and
    Tags

  163. 9.6. Decode XML Entities
  164. 9.7. Find a Specific Attribute in XML-Style Tags
  165. 9.8. Add a cellspacing Attribute to Tags That Do Not Already Include It
  166. 9.9. Remove XML-Style Comments
  167. 9.10. Find Words Within XML-Style Comments
  168. 9.11. Change the Delimiter Used in CSV Files
  169. 9.12. Extract CSV Fields from a Specific Column
  170. 9.13. Match INI Section Headers
  171. 9.14. Match INI Section Blocks
  172. 9.15. Match INI Name-Value Pairs
  173. Index
  174. Index
  175. Index
  176. Index
  177. Index
  178. Index
  179. Index
  180. Index
  181. Index
  182. Index
  183. Index
  184. Index
  185. Index
  186. Index
  187. Index
  188. Index
  189. Index
  190. Index
  191. Index
  192. Index
  193. Index
  194. Index
  195. Index
  196. Index
  197. Index
  198. Index
  199. About the Authors
  200. Colophon
  201. Copyright
  202. 3.8. Determine the Position and Length of the Match

    Problem

    Instead of extracting the substring matched by the regular expression, as shown in the previous recipe, you want to determine the starting position and length of the match. With this information, you can extract the match in your own code or apply whatever processing you fancy on the part of the original string matched by the regex.

    Solution

    C#

    For quick one-off matches, you can use the static call:

    int matchstart, matchlength = -1;
    Match matchResult = Regex.Match(subjectString, @"\d+");
    if (matchResult.Success) {
        matchstart = matchResult.Index;
        matchlength = matchResult.Length;
    }

    To use the same regex repeatedly, construct a Regex object:

    int matchstart, matchlength = -1;
    Regex regexObj = new Regex(@"\d+");
    Match matchResult = regexObj.Match(subjectString).Value;
    if (matchResult.Success) {
        matchstart = matchResult.Index;
        matchlength = matchResult.Length;
    }

    VB.NET

    For quick one-off matches, you can use the static call:

    Dim MatchStart = -1
    Dim MatchLength = -1
    Dim MatchResult = Regex.Match(SubjectString, "\d+")
    If MatchResult.Success Then
        MatchStart = MatchResult.Index
        MatchLength = MatchResult.Length
    End If

    To use the same regex repeatedly, construct a Regex object:

    Dim MatchStart = -1
    Dim MatchLength = -1
    Dim RegexObj As New Regex("\d+")
    Dim MatchResult = Regex.Match(SubjectString, "\d+")
    If MatchResult.Success Then
        MatchStart = MatchResult.Index
        MatchLength = MatchResult.Length
    End If

    Java

    int matchStart, matchLength = -1;
    Pattern regex = Pattern.compile("\\d+");
    Matcher regexMatcher = regex.matcher(subjectString);
    if (regexMatcher.find()) {
    	matchStart = regexMatcher.start();
    	matchLength = regexMatcher.end() - matchStart;
    }

    JavaScript

    var matchstart = -1;
    var matchlength = -1;
    var match = /\d+/.exec(subject);
    if (match) {
        matchstart = match.index;
        matchlength = match[0].length;
    }

    PHP

    if (preg_match('/\d+/', $subject, $groups, PREG_OFFSET_CAPTURE)) {
        $matchstart = $groups[0][1];
        $matchlength = strlen($groups[0][0]);
    }

    Perl

    if ($subject =~ m/\d+/g) {
        $matchstart = $-[0];
        $matchlength = $+[0] - $-[0];
    }

    Python

    For quick one-off matches, you can use the global function:

    matchobj = re.search(r"\d+", subject)
    if matchobj:
        matchstart = matchobj.start()
        matchlength = matchobj.end() - matchstart

    To use the same regex repeatedly, use a compiled object:

    reobj = re.compile(r"\d+")
    matchobj = reobj.search(subject)
    if matchobj:
        matchstart = matchobj.start()
        matchlength = matchobj.end() - matchstart

    Ruby

    You can use the =~ operator and its magic $~ variable:

    if subject =~ /regex pattern/
        matchstart = $~.begin()
        matchlength = $~.end() - matchstart
    end

    Alternatively, you can call the match method on a Regexp object:

    matchobj = /regex pattern/.match(subject)
    if matchobj
        matchstart = matchobj.begin()
        matchlength = matchobj.end() - matchstart
    end

    Discussion

    .NET

    To get the match index and length, we use the same Regex.Match() method described in the previous recipe. This time, we use the Index and Length properties of the Match object returned by Regex.Match().

    Index is the index in the subject string at which the regex match begins. If the regex match begins at the start of the string, Index will be zero. If the match starts at the second character in the string, Index will be one. The maximum value for Index is the length of the string. That can happen when the regex finds a zero-length match at the end of the string. For example, the regex consisting solely of the end-of-string anchor \Z always matches at the end of the string.

    Length indicates the number of characters that were matched. It is possible for a valid match to be zero characters long. For example, the regex consisting only of the word boundary \b will find a zero-length match at the start of the first word in the string.

    If the match attempt fails, Regex.Match() still returns a Match object. Its Index and Length properties will both be zero. These values can also happen with a successful match. The regex consisting of the start-of-string anchor \A will find a zero-length match at the start of the string. Thus, you cannot rely on Match.Index or Match.Length to indicate whether the match attempt was successful. Use Match.Success instead.

    Java

    To get the position and length of the match, call Matcher.find() as described in the previous recipe. When find() returns true, call Matcher.start() without any parameters to obtain the index of the first character that is part of the regex match. Call end() without any parameters to get the index of the first character after the match. Subtract the start from the end to get the length of the match, which can be zero. If you call start() or end() without a prior call to find(), you’ll get an IllegalStateException.

    JavaScript

    Call the exec() method on a regexp object to get an array with details about the match. This array has a few additional properties. The index property stores the position in the subject string at which the regex match begins. If the match begins at the start of the string, index will be zero. Element zero in the array holds a string with the overall regex match. Get the length property of that string to determine the length of the match.

    If the regular expression cannot match the string at all, regexp.exec() returns null.

    Do not use the lastIndex property of the array returned by exec() to determine the ending position of the match. In a strict JavaScript implementation, the lastIndex does not exist in the returned array at all, but only in the regexp object itself. You shouldn’t use regexp.lastIndex either. It is unreliable, due to cross-browser differences (see Recipe 3.11 for more details). Instead, simply add up match.index and match[0].length to determine where the regex match ended.

    PHP

    The previous recipe explains how you can get the text matched by the regular expression by passing a third parameter to preg_match(). You can get the position of the match by passing the constant PREG_OFFSET_CAPTURE as a fourth parameter. This parameter changes what preg_match() stores in the third parameter when it returns 1.

    When you either omit the fourth parameter or set it to zero, the variable passed as the third parameter receives an array of strings. When you pass PREG_OFFSET_CAPTURE as the fourth parameter, the variable receives an array of arrays. Element zero in the overall array is still the overall match (see the preceding recipe), and elements one and beyond are still capturing groups one and beyond (see the next recipe). But instead of holding a string with the text matched by the regex or a capturing group, the element holds an array with two values: the text that was matched and the position in the string at which it was matched.

    To get the details of the overall match, subelement zero of element zero gives us the text matched by the regex. We pass this to the strlen() function to calculate its length. Subelement one of element zero holds an integer with the position in the subject string at which the match starts.

    Perl

    Perl stores the position where the match of each capturing group starts in the array @- and the position where each group ends in @-. The overall regex match is group number zero. You can get starting position of the overall match with $-[0] and the ending position with $+[0].

    Python

    The start() method of MatchObject returns the position in the string at which the regular expression match begins. The end() method returns the position of the first character after the match. Both methods return the same value when a zero-length regular expression match is found.

    You can pass a parameter to start() and end() to retrieve the range of text matched by one of the capturing groups in the regular expressions. Call start(1) for the first capturing group, end(2) for the second group, and so on. Python supports up to 99 capturing groups. Group number 0 is the overall regular expression match. Any number other than zero up to the number of capturing groups in the regular expression (with 99 being the ceiling) causes start() and end() to raise an IndexError exception. If the group number is valid but the group did not participate in the regex match, start() and end() both return -1 for that group.

    If you want to store both the starting and ending positions in a tuple, call the span() method on the match object.

    Ruby

    Recipe 3.5 uses the =~ operator to find the first regex match in a string. A side effect of this operator is that it fills the special $~ variable with an instance of the MatchData class. This variable is thread-local and method-local. That means you can use the contents of this variable until your method exits or until the next time you use the =~ operator in your method, without worrying that another thread or another method in your thread will overwrite it.

    If you want to keep the details of multiple regex matches, call the match() method on a Regexp object. This method takes a subject string as its only parameter. It returns a MatchData instance when a match can be found, or nil otherwise. It also sets the $~ variable to the same MatchObject instance, but does not overwrite other MatchObject instances stored in other variables.

    The MatchData object stores all the details about a regular expression match. Recipes 3.7 and 3.9 explain how to get the text matched by the regular expression and by capturing groups.

    The begin() method returns the position in the subject string at which the regex match begins. end() returns the position of the first character after the regex match. offset() returns an array with the beginning and ending positions. These three methods take one parameter. Pass 0 to get the positions of the overall regex match, or pass a positive number to get the positions of the specified capturing group. For example, begin(1) returns the start of the first capturing group.

    Do not use length() or size() to get the length of the match. Both these methods return the number of elements in the array that MatchData evaluates to in array context, as explained in Recipe 3.9.

    See Also

    Recipe 3.5 shows code to test whether a regex matches a subject string, without retrieving the actual match.

    Recipe 3.7 shows code to get the text that was actually matched by the regex.

    Recipe 3.9 shows code to get the text matched by a particular part (capturing group) of a regex.