Code Index:

package Regexp::Profanity::US
- profane
- profane_list
__END__
EOF

NAME

Regexp::Profanity::US - Simple functions for detecting U.S. profanity

SYNOPSIS

  use Regexp::Profanity::US;

  my $degree  = 'definite'; # or 'ambiguous';

  my $profane = profane     ($string, $degree);
  my @profane = profane_list($string, $degree);

DESCRIPTION

This module provides an API for checking strings for strings containing various degrees of profanity, per US standards.

FUNCTIONS

$profane_word = profane($string, $degree)

Check $string for profanity of degree $degree, where $degree eq 'definite' or $degree eq 'ambiguous'

For positive matches, returns TRUE, with TRUE being the first match in the string.

For negative matches, FALSE is returned.

@profane_word = profane_list($string, $degree)

The sub returns a list of all profane words found in $string, or an empty list if none were found.

EXPORT

profane() and profane_list

DEPENDENCIES

Regexp::Common and Regexp::Common::profanity_us

OTHER

There is another module supporting profanity checking, namely Regexp::Common::profanity, but many of the profane words were of European origin and I did not find them profane at all from an American standpoint.

AUTHOR

T. M. Brannon, tbone@cpan.org

Refactored by Matthew Simon Cavalletto, evo@cpan.org.