.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "POE::Filter::IRC::Compat 3pm"
.TH POE::Filter::IRC::Compat 3pm "2021-09-30" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
POE::Filter::IRC::Compat \- A filter which converts POE::Filter::IRCD
output into POE::Component::IRC events
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& my $filter = POE::Filter::IRC::Compat\->new();
\& my @events = @{ $filter\->get( [ @lines ] ) };
\& my @msgs = @{ $filter\->put( [ @messages ] ) };
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Filter::IRC::Compat is a POE::Filter that converts
POE::Filter::IRCD output into the POE::Component::IRC
compatible event references. Basically a hack, so I could replace
POE::Filter::IRC with something that was more
generic.
.PP
Among other things, it converts normal text into thoroughly CTCP-quoted
messages, and transmogrifies CTCP-quoted messages into their normal,
sane components. Rather what you'd expect a filter to do.
.PP
A note: the \s-1CTCP\s0 protocol sucks bollocks. If I ever meet the fellow who
came up with it, I'll shave their head and tattoo obscenities on it.
Just read the \*(L"specification\*(R" (\fIdocs/ctcpspec.html\fR in this distribution)
and you'll hopefully see what I mean. Quote this, quote that, quote this
again, all in different and weird ways... and who the hell needs to send
mixed \s-1CTCP\s0 and text messages? \s-1WTF\s0? It looks like it's practically complexity
for complexity's sake \*(-- and don't even get me started on the design of the
\&\s-1DCC\s0 protocol! Anyhow, enough ranting. Onto the rest of the docs...
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
Returns a POE::Filter::IRC::Compat object. Takes no arguments.
.ie n .SS """clone"""
.el .SS "\f(CWclone\fP"
.IX Subsection "clone"
Makes a copy of the filter, and clears the copy's buffer.
.ie n .SS """get"""
.el .SS "\f(CWget\fP"
.IX Subsection "get"
Takes an arrayref of POE::Filter::IRCD hashrefs and produces an arrayref of
POE::Component::IRC compatible event hashrefs. Yay.
.ie n .SS """get_one_start"", ""get_one"""
.el .SS "\f(CWget_one_start\fP, \f(CWget_one\fP"
.IX Subsection "get_one_start, get_one"
These perform a similar function as \f(CW\*(C`get\*(C'\fR but enable the filter to work with
POE::Filter::Stackable.
.ie n .SS """put"""
.el .SS "\f(CWput\fP"
.IX Subsection "put"
Takes an array reference of \s-1CTCP\s0 messages to be properly quoted. This
doesn't support CTCPs embedded in normal messages, which is a
brain-dead hack in the protocol, so do it yourself if you really need
it. Returns an array reference of the quoted lines for sending.
.ie n .SS """debug"""
.el .SS "\f(CWdebug\fP"
.IX Subsection "debug"
Takes an optional true/false value which enables/disables debugging
accordingly. Returns the debug status.
.ie n .SS """chantypes"""
.el .SS "\f(CWchantypes\fP"
.IX Subsection "chantypes"
Takes an arrayref of possible channel prefix indicators.
.ie n .SS """identifymsg"""
.el .SS "\f(CWidentifymsg\fP"
.IX Subsection "identifymsg"
Takes a boolean to turn on/off the support for \s-1CAPAB\s0 IDENTIFY-MSG.
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris 'BinGOs' Williams
.SH "SEE ALSO"
.IX Header "SEE ALSO"
POE::Filter::IRCD
.PP
POE::Filter
.PP
POE::Filter::Stackable