rune_caster::spell::PunctuationFilter Class Reference

Remove punctuation characters using C++20 concepts. More...

#include <spell_filter.hpp>

Inheritance diagram for rune_caster::spell::PunctuationFilter:

Collaboration diagram for rune_caster::spell::PunctuationFilter:

Public Types
using	input_type = RuneSequence
using	output_type = RuneSequence
Public Types inherited from rune_caster::spell_base< RuneSequence >
using	input_type
using	output_type

Public Member Functions
	PunctuationFilter (bool remove=true)
RuneSequence	operator() (const RuneSequence &input) const override
	Apply the spell transformation.
std::string	description () const override
	Get the spell's description.
std::string	name () const override
	Get the spell's name.
bool	is_remove_mode () const noexcept
Public Member Functions inherited from rune_caster::spell_base< RuneSequence >
virtual	~spell_base ()=default

Additional Inherited Members
Static Public Member Functions inherited from rune_caster::spell_base< RuneSequence >
static constexpr bool	can_process () noexcept
	Check if this spell can be applied to the given input type (C++20 concepts)
static constexpr bool	produces () noexcept
	Check if this spell produces the expected output type (C++20 concepts)
static constexpr const char *	input_type_name () noexcept
	Get input type name as compile-time string (C++20)
static constexpr const char *	output_type_name () noexcept
	Get output type name as compile-time string (C++20)

Detailed Description

Remove punctuation characters using C++20 concepts.

This spell removes (or keeps only) characters recognized as punctuation by the Unicode helper.

Definition at line 101 of file spell_filter.hpp.

Member Typedef Documentation

input_type

using rune_caster::spell::filter::PunctuationFilter::input_type = RuneSequence

Definition at line 106 of file spell_filter.hpp.

output_type

using rune_caster::spell::filter::PunctuationFilter::output_type = RuneSequence

Definition at line 107 of file spell_filter.hpp.

Constructor & Destructor Documentation

PunctuationFilter()

rune_caster::spell::filter::PunctuationFilter::PunctuationFilter ( bool remove = true )

inlineexplicit

Definition at line 109 of file spell_filter.hpp.

Member Function Documentation

description()

std::string rune_caster::spell::filter::PunctuationFilter::description ( ) const

inlineoverridevirtual

Get the spell's description.

Returns

A human-readable description of what the spell does

Implements rune_caster::spell_base< RuneSequence >.

Definition at line 113 of file spell_filter.hpp.

is_remove_mode()

bool rune_caster::spell::filter::PunctuationFilter::is_remove_mode ( ) const

inlinenoexcept

Definition at line 119 of file spell_filter.hpp.

name()

std::string rune_caster::spell::filter::PunctuationFilter::name ( ) const

inlineoverridevirtual

Get the spell's name.

Returns

A string identifying the spell

Implements rune_caster::spell_base< RuneSequence >.

Definition at line 117 of file spell_filter.hpp.

operator()()

RuneSequence rune_caster::spell::filter::PunctuationFilter::operator() ( const RuneSequence & input ) const

overridevirtual

Apply the spell transformation.

Parameters

input

The input data to transform

Returns

The transformed output

Implements rune_caster::spell_base< RuneSequence >.

Definition at line 8 of file punctuation_filter.cpp.

---

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

• include/rune_caster/spell_filter.hpp
• src/spell/filter/punctuation_filter.cpp