Matcher.h File Reference

---

Detailed Description

This file contains the declaration of the Matcher classes.

Definition in file Matcher.h.

#include <string>
#include <boost/shared_ptr.hpp>
#include <boost/noncopyable.hpp>
#include <libcw/events.h>
#include <sys/types.h>
#include <regex.h>
#include "debug.h"
#include "match.h"
#include "MessageIn.h"
#include "Counter.h"

Go to the source code of this file.

Classes
class	Matcher
	Matcher base class. More...
class	Matcher_noarg
	A Matcher base class for matchers that do not take an extra argument. More...
class	Matcher_matchcomp
	Wildcard (* and ?) matcher. More...
class	Matcher_regexp
	Regular expression matcher. More...
class	Matcher_exactmatch
	Exact match matcher. More...
struct	MatchRequestList
	A list of match requests. More...
class	MatchRequest
	A match request. More...
class	MatcherEventType
	The type of the argument that is returned with the callback. More...
class	MatcherEventRequestBase
	Matcher event request base class. More...
class	MatcherEventRequestQueue
	Matches event request queue. More...
Typedefs
typedef event_data_server_tct < MatcherEventRequestBase, MatcherEventRequestQueue >	MatcherEventServer
	The event server for MatcherEventType.
Enumerations
enum	match0_type
	Match types that do not need an extra argument. More...
enum	match1_type
	Match types that need one extra argument (the pattern to match against). More...
Functions
std::ostream &	operator<< (std::ostream &os, match0_type mt)
	For debugging purposes. Write a match0_type to os.
std::ostream &	operator<< (std::ostream &os, match1_type mt)
	For debugging purposes. Write a match1_type to os.
bool	operator< (boost::shared_ptr< Matcher > const &matcher1, boost::shared_ptr< Matcher > const &matcher2)
	Returns true if matcher1 is expected to be a faster match than matcher2.

---

Typedef Documentation

typedef event_data_server_tct<MatcherEventRequestBase, MatcherEventRequestQueue> MatcherEventServer

The event server for MatcherEventType.

Definition at line 423 of file Matcher.h.

---

Enumeration Type Documentation

enum match0_type

Match types that do not need an extra argument.

Definition at line 34 of file Matcher.h.

                 {
  // Ordered roughly in the order of matching speed.
  anystring_mt = 0,
  nonemptystring_mt = 1,
  anyglobalchannel_mt = 2,      // Any string starting with a '#'.
  anylocalchannel_mt = 3,       // Any string starting with a '&'.
  anychannel_mt = 4,            // Any string starting with a '#' or '&'.
  anyserver_mt = 5,             // Any string containing a dot.
  anynick_mt = 6,               // Any string that is not a channel or server.
  mynick_mt = 8,
  localserver_mt = 9
};

enum match1_type

Match types that need one extra argument (the pattern to match against).

Definition at line 48 of file Matcher.h.

                 {
  // Ordered roughly in the order of matching speed.
  exactmatch_mt = 7,
  wildcard_mt = 10,             // ? == one character, * == any string of characters.
  regexp_mt = 11
};

---

Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		match0_type	mt
	)

For debugging purposes. Write a match0_type to os.

Definition at line 181 of file debug_ostream_operators.cc.

References debug::match0_type_name().

{
  return os << debug::match0_type_name(mt);
}

std::ostream& operator<<	(	std::ostream &	os,
		match1_type	mt
	)

For debugging purposes. Write a match1_type to os.

Definition at line 187 of file debug_ostream_operators.cc.

References debug::match1_type_name().

{
  return os << debug::match1_type_name(mt);
}

bool operator<	(	boost::shared_ptr< Matcher > const &	matcher1,
		boost::shared_ptr< Matcher > const &	matcher2
	)			[inline]

Returns true if matcher1 is expected to be a faster match than matcher2.

Definition at line 234 of file Matcher.h.

{
  return matcher1->sort_value() < matcher2->sort_value();
}