hext::FunctionCapture Class Reference

Captures the result of applying a function to an HTML node. More...

Inheritance diagram for hext::FunctionCapture:

Collaboration diagram for hext::FunctionCapture:

Public Member Functions
	FunctionCapture (CaptureFunction func, std::string result_name, std::unique_ptr< StringPipe > pipe={}) noexcept
	Constructs a FunctionCapture. More...
	FunctionCapture (const FunctionCapture &other)
	FunctionCapture (FunctionCapture &&) noexcept=default
FunctionCapture &	operator= (const FunctionCapture &other)
FunctionCapture &	operator= (FunctionCapture &&) noexcept=default
std::optional< ResultPair >	capture (const GumboNode *node) const override
	Captures the result of calling a given CaptureFunction with node as its argument. More...
Public Member Functions inherited from hext::Cloneable< FunctionCapture, Capture >
virtual std::unique_ptr< Capture >	clone () const override
	Clones objects of template type Derived and returns an owning pointer to the newly allocated Base. More...
Public Member Functions inherited from hext::Capture
	Capture () noexcept=default
	Capture (const Capture &)=default
	Capture (Capture &&) noexcept=default
Capture &	operator= (const Capture &)=default
Capture &	operator= (Capture &&) noexcept=default
virtual	~Capture () noexcept=default

Detailed Description

Captures the result of applying a function to an HTML node.

Example:

GumboNode * node = ...; // <div>5 reasons why foo is better than bar</div>
FunctionCapture text(
  TextBuiltin,  // predefined CaptureFunction
  "text"        // result name
);
if( auto result = text.capture(node) )
  assert(
    *result == ResultPair("text", "5 reasons why foo is better than bar")
  );

Example with regex:

GumboNode * node = ...; // <div>The result is 25cm.</div>
FunctionCapture centimeters(
  InnerHtmlBuiltin,  // predefined CaptureFunction
  "centimeters",     // result name
  std::make_unique<RegexPipe>(boost::regex("(\\d+)cm"))
);
if( auto result = centimeters.capture(node) )
  assert(*result == ResultPair("centimeters", "25"));

Definition at line 63 of file FunctionCapture.h.

Constructor & Destructor Documentation

FunctionCapture() [1/3]

hext::FunctionCapture::FunctionCapture ( CaptureFunction  func, std::string  result_name, std::unique_ptr< StringPipe >  pipe = {}  )

noexcept

Constructs a FunctionCapture.

Parameters

func	The function that will be applied to an HTML node.
result_name	The name for the result that is returned from FuntionCapture::capture.
pipe	If given, the captured value will be sent through this StringPipe before returning from capture().

FunctionCapture() [2/3]

hext::FunctionCapture::FunctionCapture

(

const FunctionCapture &

other

)

FunctionCapture() [3/3]

hext::FunctionCapture::FunctionCapture ( FunctionCapture &&  )

defaultnoexcept

Member Function Documentation

capture()

std::optional<ResultPair> hext::FunctionCapture::capture ( const GumboNode *  node ) const

overridevirtual

Captures the result of calling a given CaptureFunction with node as its argument.

Optionally applies a StringPipe to the value before returning.

Parameters

node	A pointer to a GumboNode.

Returns

A pair in the form of {result_name, result_value} or an empty optional if the capture failed.

Implements hext::Capture.

operator=() [1/2]

FunctionCapture& hext::FunctionCapture::operator=

(

const FunctionCapture &

other

)

operator=() [2/2]

FunctionCapture& hext::FunctionCapture::operator= ( FunctionCapture &&  )

defaultnoexcept

---

The documentation for this class was generated from the following file:

• hext/FunctionCapture.h