UtlRegex.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef _REGEX_H
#define _REGEX_H

#include <string.h>
#include "utl/UtlString.h"

// Forward declarations
struct real_pcre;
typedef struct real_pcre pcre;
struct pcre_extra;

class RegEx
{
 public:

// ================================================================
   
  RegEx( const char * regex, //< the regular expression
         int               options = 0, //< any sum of PCRE options bits
         unsigned long int maxDepth = MAX_RECURSION // see MAX_RECURSION
         );
  static const unsigned long int MAX_RECURSION;
  RegEx( const RegEx& );
  ~RegEx();

  int SubStrings(void) const;

// ================================================================

  bool Search( const char * subject,  
               int len = -1,          
               int options = 0        
               );
  bool SearchAt(const char* subject,  
                int offset,           
                int len = -1,         
                int options = 0       
                );
  bool SearchAgain( int options = 0        
                   );
// ================================================================

  int Matches();
  bool MatchString(UtlString* matched, 
                   int i = 0           
                   );
  bool Match(const int i, 
             int& offset, 
             int& length  
             );
  int MatchStart(const int i 
                 );

  bool BeforeMatchString(UtlString* before 
                         );
  bool AfterMatchString(UtlString* before 
                         );
  int AfterMatch(int i 
                 );
  const char * Match(int i = 0  );

 private:
  /*
   * Use the copy constructor above instead of the = operator.
   */
  RegEx& operator=(const char *);

  void ClearMatchList(void);

  pcre * re;
  size_t re_size;
  pcre_extra * pe;
  bool allocated_study;
  size_t  study_size;
  int substrcount;         // maximum substrings in pattern
  const char * subjectStr; // original subject
  int subjectLen;          // original length
  int lastStart;           // offset of start for most recent Search or SearchAgain
  int lastMatches;         // pcre_exec return for most recent Search or SearchAgain
  int * ovector;           // results from (and workspace for) pcre_exec
  const char * * matchlist;// string cache for Match
};

#endif // _REGEX_H