.\" -*- 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 "YAML::PP::Common 3"
.TH YAML::PP::Common 3 2024-02-14 "perl v5.38.2" "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
YAML::PP::Common \- Constants and common functions
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 7
\&    use YAML::PP::Common \*(Aq:STYLES\*(Aq;
\&    # or
\&    use YAML::PP::Common qw/
\&        YAML_ANY_SCALAR_STYLE YAML_PLAIN_SCALAR_STYLE
\&        YAML_SINGLE_QUOTED_SCALAR_STYLE YAML_DOUBLE_QUOTED_SCALAR_STYLE
\&        YAML_LITERAL_SCALAR_STYLE YAML_FOLDED_SCALAR_STYLE
\&        YAML_QUOTED_SCALAR_STYLE
\&
\&        YAML_ANY_SEQUENCE_STYLE
\&        YAML_BLOCK_SEQUENCE_STYLE YAML_FLOW_SEQUENCE_STYLE
\&
\&        YAML_ANY_MAPPING_STYLE
\&        YAML_BLOCK_MAPPING_STYLE YAML_FLOW_MAPPING_STYLE
\&    /;
\&
\&    use YAML::PP::Common \*(Aq:PRESERVE\*(Aq;
\&    # or
\&    use YAML::PP::Common qw/
\&        PRESERVE_ALL PRESERVE_ORDER PRESERVE_SCALAR_STYLE PRESERVE_FLOW_STYLE
\&        PRESERVE_ALIAS
\&    /:
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides common constants and functions for modules working with
YAML::PP events.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.IP event_to_test_suite 4
.IX Item "event_to_test_suite"
.Vb 1
\&    my $string = YAML::PP::Common::event_to_test_suite($event_prom_parser);
.Ve
.Sp
For examples of the returned format look into this distributions's directory
\&\f(CW\*(C`yaml\-test\-suite\*(C'\fR which is a copy of
<https://github.com/yaml/yaml\-test\-suite>.
.IP test_suite_to_event 4
.IX Item "test_suite_to_event"
.Vb 1
\&    my $event = YAML::PP::Common::test_suite_to_event($str);
.Ve
.Sp
Turns an event string in test suite format into an event hashref. Not complete
yet.