local-lib5/man/man3/TAP::Parser::YAMLish::Writer.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "TAP::Parser::YAMLish::Writer 3"
 132 .TH TAP::Parser::YAMLish::Writer 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 TAP::Parser::YAMLish::Writer \- Write YAMLish data
 135 .SH "VERSION"
 136 .IX Header "VERSION"
 137 Version 3.17
 138 .SH "SYNOPSIS"
 139 .IX Header "SYNOPSIS"
 140 .Vb 1
 141 \&    use TAP::Parser::YAMLish::Writer;
 142 .Ve
 143 .PP
 144 .Vb 5
 145 \&    my $data = {
 146 \&        one => 1,
 147 \&        two => 2,
 148 \&        three => [ 1, 2, 3 ],
 149 \&    };
 150 .Ve
 151 .PP
 152 .Vb 1
 153 \&    my $yw = TAP::Parser::YAMLish::Writer\->new;
 154 .Ve
 155 .PP
 156 .Vb 2
 157 \&    # Write to an array...
 158 \&    $yw\->write( $data, \e@some_array );
 159 .Ve
 160 .PP
 161 .Vb 2
 162 \&    # ...an open file handle...
 163 \&    $yw\->write( $data, $some_file_handle );
 164 .Ve
 165 .PP
 166 .Vb 2
 167 \&    # ...a string ...
 168 \&    $yw\->write( $data, \e$some_string );
 169 .Ve
 170 .PP
 171 .Vb 5
 172 \&    # ...or a closure
 173 \&    $yw\->write( $data, sub {
 174 \&        my $line = shift;
 175 \&        print "$line\en";
 176 \&    } );
 177 .Ve
 178 .SH "DESCRIPTION"
 179 .IX Header "DESCRIPTION"
 180 Encodes a scalar, hash reference or array reference as YAMLish.
 181 .SH "METHODS"
 182 .IX Header "METHODS"
 183 .Sh "Class Methods"
 184 .IX Subsection "Class Methods"
 185 \fI\f(CI\*(C`new\*(C'\fI\fR
 186 .IX Subsection "new"
 187 .PP
 188 .Vb 1
 189 \& my $writer = TAP::Parser::YAMLish::Writer\->new;
 190 .Ve
 191 .PP
 192 The constructor \f(CW\*(C`new\*(C'\fR creates and returns an empty
 193 \&\f(CW\*(C`TAP::Parser::YAMLish::Writer\*(C'\fR object.
 194 .Sh "Instance Methods"
 195 .IX Subsection "Instance Methods"
 196 \fI\f(CI\*(C`write\*(C'\fI\fR
 197 .IX Subsection "write"
 198 .PP
 199 .Vb 1
 200 \& $writer\->write($obj, $output );
 201 .Ve
 202 .PP
 203 Encode a scalar, hash reference or array reference as \s-1YAML\s0.
 204 .PP
 205 .Vb 4
 206 \&    my $writer = sub {
 207 \&        my $line = shift;
 208 \&        print SOMEFILE "$line\en";
 209 \&    };
 210 .Ve
 211 .PP
 212 .Vb 5
 213 \&    my $data = {
 214 \&        one => 1,
 215 \&        two => 2,
 216 \&        three => [ 1, 2, 3 ],
 217 \&    };
 218 .Ve
 219 .PP
 220 .Vb 2
 221 \&    my $yw = TAP::Parser::YAMLish::Writer\->new;
 222 \&    $yw\->write( $data, $writer );
 223 .Ve
 224 .PP
 225 The \f(CW $output \fR argument may be:
 226 .IP "* a reference to a scalar to append \s-1YAML\s0 to" 4
 227 .IX Item "a reference to a scalar to append YAML to"
 228 .PD 0
 229 .IP "* the handle of an open file" 4
 230 .IX Item "the handle of an open file"
 231 .IP "* a reference to an array into which \s-1YAML\s0 will be pushed" 4
 232 .IX Item "a reference to an array into which YAML will be pushed"
 233 .IP "* a code reference" 4
 234 .IX Item "a code reference"
 235 .PD
 236 .PP
 237 If you supply a code reference the subroutine will be called once for
 238 each line of output with the line as its only argument. Passed lines
 239 will have no trailing newline.
 240 .SH "AUTHOR"
 241 .IX Header "AUTHOR"
 242 Andy Armstrong, <andy@hexten.net>
 243 .SH "SEE ALSO"
 244 .IX Header "SEE ALSO"
 245 YAML::Tiny, \s-1YAML\s0, YAML::Syck, Config::Tiny, CSS::Tiny,
 246 <http://use.perl.org/~Alias/journal/29427>
 247 .SH "COPYRIGHT"
 248 .IX Header "COPYRIGHT"
 249 Copyright 2007\-2008 Andy Armstrong.
 250 .PP
 251 This program is free software; you can redistribute
 252 it and/or modify it under the same terms as Perl itself.
 253 .PP
 254 The full text of the license can be found in the
 255 \&\s-1LICENSE\s0 file included with this module.