.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Sort::Key::Types 3"
.TH Sort::Key::Types 3 2023-07-25 "perl v5.38.0" "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 "Sort::Key::Types \- handle Sort::Key data types"
.IX Header "Sort::Key::Types - handle Sort::Key data types"
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  use Sort::Key::Types qw(register_type);
\&  register_type(Color => sub { $_\->R, $_\->G, $_\->B }, qw(int, int, int));
\&
\&  # you better
\&  # use Sort::Key::Register ...
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The Sort::Key family of modules can be extended to support new key
types using this module (or the more friendly Sort::Key::Register).
.SS FUNCTIONS
.IX Subsection "FUNCTIONS"
The following functions are provided:
.ie n .IP "Sort::Key::register_type($name, \e&gensubkeys, @subkeystypes)" 4
.el .IP "Sort::Key::register_type($name, \e&gensubkeys, \f(CW@subkeystypes\fR)" 4
.IX Item "Sort::Key::register_type($name, &gensubkeys, @subkeystypes)"
registers a new datatype named \f(CW$name\fR defining how to convert it to
a multi-key.
.Sp
\&\f(CW&gensubkeys\fR should convert the object of type \f(CW$name\fR passed on
\&\f(CW$_\fR to a list of values composing the multi-key.
.Sp
\&\f(CW@subkeystypes\fR is the list of types for the generated multi-keys.
.Sp
For instance:
.Sp
.Vb 6
\&  Sort::Key::Types::register_type
\&                 \*(AqPerson\*(Aq,
\&                 sub { $_\->surname,
\&                       $_\->name,
\&                       $_\->middlename },
\&                 qw(str str str);
\&
\&  Sort::Key::Types::register_type
\&                 \*(AqColor\*(Aq,
\&                 sub { $_\->R, $_\->G, $_\->B },
\&                 qw(int int int);
.Ve
.Sp
Once a datatype has been registered it can be used in the same way
as types supported natively, even for defining new types, i.e.:
.Sp
.Vb 4
\&  Sort::Key::Types::register_type
\&                 \*(AqFamily\*(Aq,
\&                 sub { $_\->father, $_\->mother },
\&                 qw(Person Person);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sort::Key, Sort::Key::Merger, Sort::Key::Register.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2005\-2007, 2014 by Salvador Fandiño,
<sfandino@yahoo.com>.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.4 or,
at your option, any later version of Perl 5 you may have available.