diff --git a/Support/lib/Perl/Auxiliary.pm b/Support/lib/Perl/Auxiliary.pm index a060440f..0a5773c3 100644 --- a/Support/lib/Perl/Auxiliary.pm +++ b/Support/lib/Perl/Auxiliary.pm @@ -12,11 +12,15 @@ use strict; use warnings; use Carp qw(croak); +use Cwd qw(abs_path); use Data::Dumper; use Env qw(TM_BUNDLE_SUPPORT); use Exporter qw(import); +use File::Basename; use File::Path qw(remove_tree); -use YAML qw(LoadFile); + +use lib dirname( dirname( dirname abs_path $0) ) . '/Support/lib/Perl'; +use YAML::Tiny; # -- Exports ------------------------------------------------------------------- @@ -59,10 +63,9 @@ sub get_auxiliary_files { $tm_bundle_support ||= $TM_BUNDLE_SUPPORT; my $config_filepath = "$tm_bundle_support/config/auxiliary.yaml"; - open my $fh, '<', $config_filepath + my $yaml = YAML::Tiny->read($config_filepath) or croak "Can not open $config_filepath: $!"; - my $config = LoadFile($fh); - close($fh); + my $config = $yaml->[0]; return $config->{'files'}, $config->{'directories'}; } diff --git a/Support/lib/Perl/YAML/Tiny-license.txt b/Support/lib/Perl/YAML/Tiny-license.txt new file mode 100644 index 00000000..dbb034bf --- /dev/null +++ b/Support/lib/Perl/YAML/Tiny-license.txt @@ -0,0 +1,379 @@ +This software is copyright (c) 2006 by Adam Kennedy. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--- The GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2006 by Adam Kennedy. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 19yy + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2006 by Adam Kennedy. + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/Support/lib/Perl/YAML/Tiny.pm b/Support/lib/Perl/YAML/Tiny.pm new file mode 100644 index 00000000..472073c6 --- /dev/null +++ b/Support/lib/Perl/YAML/Tiny.pm @@ -0,0 +1,1485 @@ +use 5.008001; # sane UTF-8 support +use strict; +use warnings; +package YAML::Tiny; +# XXX-INGY is 5.8.1 too old/broken for utf8? +# XXX-XDG Lancaster consensus was that it was sufficient until +# proven otherwise + +our $VERSION = '1.70'; + +##################################################################### +# The YAML::Tiny API. +# +# These are the currently documented API functions/methods and +# exports: + +use Exporter; +our @ISA = qw{ Exporter }; +our @EXPORT = qw{ Load Dump }; +our @EXPORT_OK = qw{ LoadFile DumpFile freeze thaw }; + +### +# Functional/Export API: + +sub Dump { + return YAML::Tiny->new(@_)->_dump_string; +} + +# XXX-INGY Returning last document seems a bad behavior. +# XXX-XDG I think first would seem more natural, but I don't know +# that it's worth changing now +sub Load { + my $self = YAML::Tiny->_load_string(@_); + if ( wantarray ) { + return @$self; + } else { + # To match YAML.pm, return the last document + return $self->[-1]; + } +} + +# XXX-INGY Do we really need freeze and thaw? +# XXX-XDG I don't think so. I'd support deprecating them. +BEGIN { + *freeze = \&Dump; + *thaw = \&Load; +} + +sub DumpFile { + my $file = shift; + return YAML::Tiny->new(@_)->_dump_file($file); +} + +sub LoadFile { + my $file = shift; + my $self = YAML::Tiny->_load_file($file); + if ( wantarray ) { + return @$self; + } else { + # Return only the last document to match YAML.pm, + return $self->[-1]; + } +} + + +### +# Object Oriented API: + +# Create an empty YAML::Tiny object +# XXX-INGY Why do we use ARRAY object? +# NOTE: I get it now, but I think it's confusing and not needed. +# Will change it on a branch later, for review. +# +# XXX-XDG I don't support changing it yet. It's a very well-documented +# "API" of YAML::Tiny. I'd support deprecating it, but Adam suggested +# we not change it until YAML.pm's own OO API is established so that +# users only have one API change to digest, not two +sub new { + my $class = shift; + bless [ @_ ], $class; +} + +# XXX-INGY It probably doesn't matter, and it's probably too late to +# change, but 'read/write' are the wrong names. Read and Write +# are actions that take data from storage to memory +# characters/strings. These take the data to/from storage to native +# Perl objects, which the terms dump and load are meant. As long as +# this is a legacy quirk to YAML::Tiny it's ok, but I'd prefer not +# to add new {read,write}_* methods to this API. + +sub read_string { + my $self = shift; + $self->_load_string(@_); +} + +sub write_string { + my $self = shift; + $self->_dump_string(@_); +} + +sub read { + my $self = shift; + $self->_load_file(@_); +} + +sub write { + my $self = shift; + $self->_dump_file(@_); +} + + + + +##################################################################### +# Constants + +# Printed form of the unprintable characters in the lowest range +# of ASCII characters, listed by ASCII ordinal position. +my @UNPRINTABLE = qw( + 0 x01 x02 x03 x04 x05 x06 a + b t n v f r x0E x0F + x10 x11 x12 x13 x14 x15 x16 x17 + x18 x19 x1A e x1C x1D x1E x1F +); + +# Printable characters for escapes +my %UNESCAPES = ( + 0 => "\x00", z => "\x00", N => "\x85", + a => "\x07", b => "\x08", t => "\x09", + n => "\x0a", v => "\x0b", f => "\x0c", + r => "\x0d", e => "\x1b", '\\' => '\\', +); + +# XXX-INGY +# I(ngy) need to decide if these values should be quoted in +# YAML::Tiny or not. Probably yes. + +# These 3 values have special meaning when unquoted and using the +# default YAML schema. They need quotes if they are strings. +my %QUOTE = map { $_ => 1 } qw{ + null true false +}; + +# The commented out form is simpler, but overloaded the Perl regex +# engine due to recursion and backtracking problems on strings +# larger than 32,000ish characters. Keep it for reference purposes. +# qr/\"((?:\\.|[^\"])*)\"/ +my $re_capture_double_quoted = qr/\"([^\\"]*(?:\\.[^\\"]*)*)\"/; +my $re_capture_single_quoted = qr/\'([^\']*(?:\'\'[^\']*)*)\'/; +# unquoted re gets trailing space that needs to be stripped +my $re_capture_unquoted_key = qr/([^:]+(?::+\S(?:[^:]*|.*?(?=:)))*)(?=\s*\:(?:\s+|$))/; +my $re_trailing_comment = qr/(?:\s+\#.*)?/; +my $re_key_value_separator = qr/\s*:(?:\s+(?:\#.*)?|$)/; + + + + + +##################################################################### +# YAML::Tiny Implementation. +# +# These are the private methods that do all the work. They may change +# at any time. + + +### +# Loader functions: + +# Create an object from a file +sub _load_file { + my $class = ref $_[0] ? ref shift : shift; + + # Check the file + my $file = shift or $class->_error( 'You did not specify a file name' ); + $class->_error( "File '$file' does not exist" ) + unless -e $file; + $class->_error( "'$file' is a directory, not a file" ) + unless -f _; + $class->_error( "Insufficient permissions to read '$file'" ) + unless -r _; + + # Open unbuffered with strict UTF-8 decoding and no translation layers + open( my $fh, "<:unix:encoding(UTF-8)", $file ); + unless ( $fh ) { + $class->_error("Failed to open file '$file': $!"); + } + + # flock if available (or warn if not possible for OS-specific reasons) + if ( _can_flock() ) { + flock( $fh, Fcntl::LOCK_SH() ) + or warn "Couldn't lock '$file' for reading: $!"; + } + + # slurp the contents + my $contents = eval { + use warnings FATAL => 'utf8'; + local $/; + <$fh> + }; + if ( my $err = $@ ) { + $class->_error("Error reading from file '$file': $err"); + } + + # close the file (release the lock) + unless ( close $fh ) { + $class->_error("Failed to close file '$file': $!"); + } + + $class->_load_string( $contents ); +} + +# Create an object from a string +sub _load_string { + my $class = ref $_[0] ? ref shift : shift; + my $self = bless [], $class; + my $string = $_[0]; + eval { + unless ( defined $string ) { + die \"Did not provide a string to load"; + } + + # Check if Perl has it marked as characters, but it's internally + # inconsistent. E.g. maybe latin1 got read on a :utf8 layer + if ( utf8::is_utf8($string) && ! utf8::valid($string) ) { + die \<<'...'; +Read an invalid UTF-8 string (maybe mixed UTF-8 and 8-bit character set). +Did you decode with lax ":utf8" instead of strict ":encoding(UTF-8)"? +... + } + + # Ensure Unicode character semantics, even for 0x80-0xff + utf8::upgrade($string); + + # Check for and strip any leading UTF-8 BOM + $string =~ s/^\x{FEFF}//; + + # Check for some special cases + return $self unless length $string; + + # Split the file into lines + my @lines = grep { ! /^\s*(?:\#.*)?\z/ } + split /(?:\015{1,2}\012|\015|\012)/, $string; + + # Strip the initial YAML header + @lines and $lines[0] =~ /^\%YAML[: ][\d\.]+.*\z/ and shift @lines; + + # A nibbling parser + my $in_document = 0; + while ( @lines ) { + # Do we have a document header? + if ( $lines[0] =~ /^---\s*(?:(.+)\s*)?\z/ ) { + # Handle scalar documents + shift @lines; + if ( defined $1 and $1 !~ /^(?:\#.+|\%YAML[: ][\d\.]+)\z/ ) { + push @$self, + $self->_load_scalar( "$1", [ undef ], \@lines ); + next; + } + $in_document = 1; + } + + if ( ! @lines or $lines[0] =~ /^(?:---|\.\.\.)/ ) { + # A naked document + push @$self, undef; + while ( @lines and $lines[0] !~ /^---/ ) { + shift @lines; + } + $in_document = 0; + + # XXX The final '-+$' is to look for -- which ends up being an + # error later. + } elsif ( ! $in_document && @$self ) { + # only the first document can be explicit + die \"YAML::Tiny failed to classify the line '$lines[0]'"; + } elsif ( $lines[0] =~ /^\s*\-(?:\s|$|-+$)/ ) { + # An array at the root + my $document = [ ]; + push @$self, $document; + $self->_load_array( $document, [ 0 ], \@lines ); + + } elsif ( $lines[0] =~ /^(\s*)\S/ ) { + # A hash at the root + my $document = { }; + push @$self, $document; + $self->_load_hash( $document, [ length($1) ], \@lines ); + + } else { + # Shouldn't get here. @lines have whitespace-only lines + # stripped, and previous match is a line with any + # non-whitespace. So this clause should only be reachable via + # a perlbug where \s is not symmetric with \S + + # uncoverable statement + die \"YAML::Tiny failed to classify the line '$lines[0]'"; + } + } + }; + my $err = $@; + if ( ref $err eq 'SCALAR' ) { + $self->_error(${$err}); + } elsif ( $err ) { + $self->_error($err); + } + + return $self; +} + +sub _unquote_single { + my ($self, $string) = @_; + return '' unless length $string; + $string =~ s/\'\'/\'/g; + return $string; +} + +sub _unquote_double { + my ($self, $string) = @_; + return '' unless length $string; + $string =~ s/\\"/"/g; + $string =~ + s{\\([Nnever\\fartz0b]|x([0-9a-fA-F]{2}))} + {(length($1)>1)?pack("H2",$2):$UNESCAPES{$1}}gex; + return $string; +} + +# Load a YAML scalar string to the actual Perl scalar +sub _load_scalar { + my ($self, $string, $indent, $lines) = @_; + + # Trim trailing whitespace + $string =~ s/\s*\z//; + + # Explitic null/undef + return undef if $string eq '~'; + + # Single quote + if ( $string =~ /^$re_capture_single_quoted$re_trailing_comment\z/ ) { + return $self->_unquote_single($1); + } + + # Double quote. + if ( $string =~ /^$re_capture_double_quoted$re_trailing_comment\z/ ) { + return $self->_unquote_double($1); + } + + # Special cases + if ( $string =~ /^[\'\"!&]/ ) { + die \"YAML::Tiny does not support a feature in line '$string'"; + } + return {} if $string =~ /^{}(?:\s+\#.*)?\z/; + return [] if $string =~ /^\[\](?:\s+\#.*)?\z/; + + # Regular unquoted string + if ( $string !~ /^[>|]/ ) { + die \"YAML::Tiny found illegal characters in plain scalar: '$string'" + if $string =~ /^(?:-(?:\s|$)|[\@\%\`])/ or + $string =~ /:(?:\s|$)/; + $string =~ s/\s+#.*\z//; + return $string; + } + + # Error + die \"YAML::Tiny failed to find multi-line scalar content" unless @$lines; + + # Check the indent depth + $lines->[0] =~ /^(\s*)/; + $indent->[-1] = length("$1"); + if ( defined $indent->[-2] and $indent->[-1] <= $indent->[-2] ) { + die \"YAML::Tiny found bad indenting in line '$lines->[0]'"; + } + + # Pull the lines + my @multiline = (); + while ( @$lines ) { + $lines->[0] =~ /^(\s*)/; + last unless length($1) >= $indent->[-1]; + push @multiline, substr(shift(@$lines), length($1)); + } + + my $j = (substr($string, 0, 1) eq '>') ? ' ' : "\n"; + my $t = (substr($string, 1, 1) eq '-') ? '' : "\n"; + return join( $j, @multiline ) . $t; +} + +# Load an array +sub _load_array { + my ($self, $array, $indent, $lines) = @_; + + while ( @$lines ) { + # Check for a new document + if ( $lines->[0] =~ /^(?:---|\.\.\.)/ ) { + while ( @$lines and $lines->[0] !~ /^---/ ) { + shift @$lines; + } + return 1; + } + + # Check the indent level + $lines->[0] =~ /^(\s*)/; + if ( length($1) < $indent->[-1] ) { + return 1; + } elsif ( length($1) > $indent->[-1] ) { + die \"YAML::Tiny found bad indenting in line '$lines->[0]'"; + } + + if ( $lines->[0] =~ /^(\s*\-\s+)[^\'\"]\S*\s*:(?:\s+|$)/ ) { + # Inline nested hash + my $indent2 = length("$1"); + $lines->[0] =~ s/-/ /; + push @$array, { }; + $self->_load_hash( $array->[-1], [ @$indent, $indent2 ], $lines ); + + } elsif ( $lines->[0] =~ /^\s*\-\s*\z/ ) { + shift @$lines; + unless ( @$lines ) { + push @$array, undef; + return 1; + } + if ( $lines->[0] =~ /^(\s*)\-/ ) { + my $indent2 = length("$1"); + if ( $indent->[-1] == $indent2 ) { + # Null array entry + push @$array, undef; + } else { + # Naked indenter + push @$array, [ ]; + $self->_load_array( + $array->[-1], [ @$indent, $indent2 ], $lines + ); + } + + } elsif ( $lines->[0] =~ /^(\s*)\S/ ) { + push @$array, { }; + $self->_load_hash( + $array->[-1], [ @$indent, length("$1") ], $lines + ); + + } else { + die \"YAML::Tiny failed to classify line '$lines->[0]'"; + } + + } elsif ( $lines->[0] =~ /^\s*\-(\s*)(.+?)\s*\z/ ) { + # Array entry with a value + shift @$lines; + push @$array, $self->_load_scalar( + "$2", [ @$indent, undef ], $lines + ); + + } elsif ( defined $indent->[-2] and $indent->[-1] == $indent->[-2] ) { + # This is probably a structure like the following... + # --- + # foo: + # - list + # bar: value + # + # ... so lets return and let the hash parser handle it + return 1; + + } else { + die \"YAML::Tiny failed to classify line '$lines->[0]'"; + } + } + + return 1; +} + +# Load a hash +sub _load_hash { + my ($self, $hash, $indent, $lines) = @_; + + while ( @$lines ) { + # Check for a new document + if ( $lines->[0] =~ /^(?:---|\.\.\.)/ ) { + while ( @$lines and $lines->[0] !~ /^---/ ) { + shift @$lines; + } + return 1; + } + + # Check the indent level + $lines->[0] =~ /^(\s*)/; + if ( length($1) < $indent->[-1] ) { + return 1; + } elsif ( length($1) > $indent->[-1] ) { + die \"YAML::Tiny found bad indenting in line '$lines->[0]'"; + } + + # Find the key + my $key; + + # Quoted keys + if ( $lines->[0] =~ + s/^\s*$re_capture_single_quoted$re_key_value_separator// + ) { + $key = $self->_unquote_single($1); + } + elsif ( $lines->[0] =~ + s/^\s*$re_capture_double_quoted$re_key_value_separator// + ) { + $key = $self->_unquote_double($1); + } + elsif ( $lines->[0] =~ + s/^\s*$re_capture_unquoted_key$re_key_value_separator// + ) { + $key = $1; + $key =~ s/\s+$//; + } + elsif ( $lines->[0] =~ /^\s*\?/ ) { + die \"YAML::Tiny does not support a feature in line '$lines->[0]'"; + } + else { + die \"YAML::Tiny failed to classify line '$lines->[0]'"; + } + + if ( exists $hash->{$key} ) { + warn "YAML::Tiny found a duplicate key '$key' in line '$lines->[0]'"; + } + + # Do we have a value? + if ( length $lines->[0] ) { + # Yes + $hash->{$key} = $self->_load_scalar( + shift(@$lines), [ @$indent, undef ], $lines + ); + } else { + # An indent + shift @$lines; + unless ( @$lines ) { + $hash->{$key} = undef; + return 1; + } + if ( $lines->[0] =~ /^(\s*)-/ ) { + $hash->{$key} = []; + $self->_load_array( + $hash->{$key}, [ @$indent, length($1) ], $lines + ); + } elsif ( $lines->[0] =~ /^(\s*)./ ) { + my $indent2 = length("$1"); + if ( $indent->[-1] >= $indent2 ) { + # Null hash entry + $hash->{$key} = undef; + } else { + $hash->{$key} = {}; + $self->_load_hash( + $hash->{$key}, [ @$indent, length($1) ], $lines + ); + } + } + } + } + + return 1; +} + + +### +# Dumper functions: + +# Save an object to a file +sub _dump_file { + my $self = shift; + + require Fcntl; + + # Check the file + my $file = shift or $self->_error( 'You did not specify a file name' ); + + my $fh; + # flock if available (or warn if not possible for OS-specific reasons) + if ( _can_flock() ) { + # Open without truncation (truncate comes after lock) + my $flags = Fcntl::O_WRONLY()|Fcntl::O_CREAT(); + sysopen( $fh, $file, $flags ); + unless ( $fh ) { + $self->_error("Failed to open file '$file' for writing: $!"); + } + + # Use no translation and strict UTF-8 + binmode( $fh, ":raw:encoding(UTF-8)"); + + flock( $fh, Fcntl::LOCK_EX() ) + or warn "Couldn't lock '$file' for reading: $!"; + + # truncate and spew contents + truncate $fh, 0; + seek $fh, 0, 0; + } + else { + open $fh, ">:unix:encoding(UTF-8)", $file; + } + + # serialize and spew to the handle + print {$fh} $self->_dump_string; + + # close the file (release the lock) + unless ( close $fh ) { + $self->_error("Failed to close file '$file': $!"); + } + + return 1; +} + +# Save an object to a string +sub _dump_string { + my $self = shift; + return '' unless ref $self && @$self; + + # Iterate over the documents + my $indent = 0; + my @lines = (); + + eval { + foreach my $cursor ( @$self ) { + push @lines, '---'; + + # An empty document + if ( ! defined $cursor ) { + # Do nothing + + # A scalar document + } elsif ( ! ref $cursor ) { + $lines[-1] .= ' ' . $self->_dump_scalar( $cursor ); + + # A list at the root + } elsif ( ref $cursor eq 'ARRAY' ) { + unless ( @$cursor ) { + $lines[-1] .= ' []'; + next; + } + push @lines, $self->_dump_array( $cursor, $indent, {} ); + + # A hash at the root + } elsif ( ref $cursor eq 'HASH' ) { + unless ( %$cursor ) { + $lines[-1] .= ' {}'; + next; + } + push @lines, $self->_dump_hash( $cursor, $indent, {} ); + + } else { + die \("Cannot serialize " . ref($cursor)); + } + } + }; + if ( ref $@ eq 'SCALAR' ) { + $self->_error(${$@}); + } elsif ( $@ ) { + $self->_error($@); + } + + join '', map { "$_\n" } @lines; +} + +sub _has_internal_string_value { + my $value = shift; + my $b_obj = B::svref_2object(\$value); # for round trip problem + return $b_obj->FLAGS & B::SVf_POK(); +} + +sub _dump_scalar { + my $string = $_[1]; + my $is_key = $_[2]; + # Check this before checking length or it winds up looking like a string! + my $has_string_flag = _has_internal_string_value($string); + return '~' unless defined $string; + return "''" unless length $string; + if (Scalar::Util::looks_like_number($string)) { + # keys and values that have been used as strings get quoted + if ( $is_key || $has_string_flag ) { + return qq['$string']; + } + else { + return $string; + } + } + if ( $string =~ /[\x00-\x09\x0b-\x0d\x0e-\x1f\x7f-\x9f\'\n]/ ) { + $string =~ s/\\/\\\\/g; + $string =~ s/"/\\"/g; + $string =~ s/\n/\\n/g; + $string =~ s/[\x85]/\\N/g; + $string =~ s/([\x00-\x1f])/\\$UNPRINTABLE[ord($1)]/g; + $string =~ s/([\x7f-\x9f])/'\x' . sprintf("%X",ord($1))/ge; + return qq|"$string"|; + } + if ( $string =~ /(?:^[~!@#%&*|>?:,'"`{}\[\]]|^-+$|\s|:\z)/ or + $QUOTE{$string} + ) { + return "'$string'"; + } + return $string; +} + +sub _dump_array { + my ($self, $array, $indent, $seen) = @_; + if ( $seen->{refaddr($array)}++ ) { + die \"YAML::Tiny does not support circular references"; + } + my @lines = (); + foreach my $el ( @$array ) { + my $line = (' ' x $indent) . '-'; + my $type = ref $el; + if ( ! $type ) { + $line .= ' ' . $self->_dump_scalar( $el ); + push @lines, $line; + + } elsif ( $type eq 'ARRAY' ) { + if ( @$el ) { + push @lines, $line; + push @lines, $self->_dump_array( $el, $indent + 1, $seen ); + } else { + $line .= ' []'; + push @lines, $line; + } + + } elsif ( $type eq 'HASH' ) { + if ( keys %$el ) { + push @lines, $line; + push @lines, $self->_dump_hash( $el, $indent + 1, $seen ); + } else { + $line .= ' {}'; + push @lines, $line; + } + + } else { + die \"YAML::Tiny does not support $type references"; + } + } + + @lines; +} + +sub _dump_hash { + my ($self, $hash, $indent, $seen) = @_; + if ( $seen->{refaddr($hash)}++ ) { + die \"YAML::Tiny does not support circular references"; + } + my @lines = (); + foreach my $name ( sort keys %$hash ) { + my $el = $hash->{$name}; + my $line = (' ' x $indent) . $self->_dump_scalar($name, 1) . ":"; + my $type = ref $el; + if ( ! $type ) { + $line .= ' ' . $self->_dump_scalar( $el ); + push @lines, $line; + + } elsif ( $type eq 'ARRAY' ) { + if ( @$el ) { + push @lines, $line; + push @lines, $self->_dump_array( $el, $indent + 1, $seen ); + } else { + $line .= ' []'; + push @lines, $line; + } + + } elsif ( $type eq 'HASH' ) { + if ( keys %$el ) { + push @lines, $line; + push @lines, $self->_dump_hash( $el, $indent + 1, $seen ); + } else { + $line .= ' {}'; + push @lines, $line; + } + + } else { + die \"YAML::Tiny does not support $type references"; + } + } + + @lines; +} + + + +##################################################################### +# DEPRECATED API methods: + +# Error storage (DEPRECATED as of 1.57) +our $errstr = ''; + +# Set error +sub _error { + require Carp; + $errstr = $_[1]; + $errstr =~ s/ at \S+ line \d+.*//; + Carp::croak( $errstr ); +} + +# Retrieve error +my $errstr_warned; +sub errstr { + require Carp; + Carp::carp( "YAML::Tiny->errstr and \$YAML::Tiny::errstr is deprecated" ) + unless $errstr_warned++; + $errstr; +} + + + + +##################################################################### +# Helper functions. Possibly not needed. + + +# Use to detect nv or iv +use B; + +# XXX-INGY Is flock YAML::Tiny's responsibility? +# Some platforms can't flock :-( +# XXX-XDG I think it is. When reading and writing files, we ought +# to be locking whenever possible. People (foolishly) use YAML +# files for things like session storage, which has race issues. +my $HAS_FLOCK; +sub _can_flock { + if ( defined $HAS_FLOCK ) { + return $HAS_FLOCK; + } + else { + require Config; + my $c = \%Config::Config; + $HAS_FLOCK = grep { $c->{$_} } qw/d_flock d_fcntl_can_lock d_lockf/; + require Fcntl if $HAS_FLOCK; + return $HAS_FLOCK; + } +} + + +# XXX-INGY Is this core in 5.8.1? Can we remove this? +# XXX-XDG Scalar::Util 1.18 didn't land until 5.8.8, so we need this +##################################################################### +# Use Scalar::Util if possible, otherwise emulate it + +use Scalar::Util (); +BEGIN { + local $@; + if ( eval { Scalar::Util->VERSION(1.18); } ) { + *refaddr = *Scalar::Util::refaddr; + } + else { + eval <<'END_PERL'; +# Scalar::Util failed to load or too old +sub refaddr { + my $pkg = ref($_[0]) or return undef; + if ( !! UNIVERSAL::can($_[0], 'can') ) { + bless $_[0], 'Scalar::Util::Fake'; + } else { + $pkg = undef; + } + "$_[0]" =~ /0x(\w+)/; + my $i = do { no warnings 'portable'; hex $1 }; + bless $_[0], $pkg if defined $pkg; + $i; +} +END_PERL + } +} + +delete $YAML::Tiny::{refaddr}; + +1; + +# XXX-INGY Doc notes I'm putting up here. Changing the doc when it's wrong +# but leaving grey area stuff up here. +# +# I would like to change Read/Write to Load/Dump below without +# changing the actual API names. +# +# It might be better to put Load/Dump API in the SYNOPSIS instead of the +# dubious OO API. +# +# null and bool explanations may be outdated. + +__END__ + +=pod + +=head1 NAME + +YAML::Tiny - Read/Write YAML files with as little code as possible + +=head1 PREAMBLE + +The YAML specification is huge. Really, B huge. It contains all the +functionality of XML, except with flexibility and choice, which makes it +easier to read, but with a formal specification that is more complex than +XML. + +The original pure-Perl implementation L costs just over 4 megabytes +of memory to load. Just like with Windows F<.ini> files (3 meg to load) and +CSS (3.5 meg to load) the situation is just asking for a B +module, an incomplete but correct and usable subset of the functionality, +in as little code as possible. + +Like the other C<::Tiny> modules, YAML::Tiny has no non-core dependencies, +does not require a compiler to install, is back-compatible to Perl v5.8.1, +and can be inlined into other modules if needed. + +In exchange for this adding this extreme flexibility, it provides support +for only a limited subset of YAML. But the subset supported contains most +of the features for the more common uses of YAML. + +=head1 SYNOPSIS + +Assuming F like this: + + --- + rootproperty: blah + section: + one: two + three: four + Foo: Bar + empty: ~ + + +Read and write F like this: + + use YAML::Tiny; + + # Open the config + my $yaml = YAML::Tiny->read( 'file.yml' ); + + # Get a reference to the first document + my $config = $yaml->[0]; + + # Or read properties directly + my $root = $yaml->[0]->{rootproperty}; + my $one = $yaml->[0]->{section}->{one}; + my $Foo = $yaml->[0]->{section}->{Foo}; + + # Change data directly + $yaml->[0]->{newsection} = { this => 'that' }; # Add a section + $yaml->[0]->{section}->{Foo} = 'Not Bar!'; # Change a value + delete $yaml->[0]->{section}; # Delete a value + + # Save the document back to the file + $yaml->write( 'file.yml' ); + +To create a new YAML file from scratch: + + # Create a new object with a single hashref document + my $yaml = YAML::Tiny->new( { wibble => "wobble" } ); + + # Add an arrayref document + push @$yaml, [ 'foo', 'bar', 'baz' ]; + + # Save both documents to a file + $yaml->write( 'data.yml' ); + +Then F will contain: + + --- + wibble: wobble + --- + - foo + - bar + - baz + +=head1 DESCRIPTION + +B is a perl class for reading and writing YAML-style files, +written with as little code as possible, reducing load time and memory +overhead. + +Most of the time it is accepted that Perl applications use a lot +of memory and modules. The B<::Tiny> family of modules is specifically +intended to provide an ultralight and zero-dependency alternative to +many more-thorough standard modules. + +This module is primarily for reading human-written files (like simple +config files) and generating very simple human-readable files. Note that +I said B and not B. The sort of files that +your average manager or secretary should be able to look at and make +sense of. + +=for stopwords normalise + +L does not generate comments, it won't necessarily preserve the +order of your hashes, and it will normalise if reading in and writing out +again. + +It only supports a very basic subset of the full YAML specification. + +=for stopwords embeddable + +Usage is targeted at files like Perl's META.yml, for which a small and +easily-embeddable module is extremely attractive. + +Features will only be added if they are human readable, and can be written +in a few lines of code. Please don't be offended if your request is +refused. Someone has to draw the line, and for YAML::Tiny that someone +is me. + +If you need something with more power move up to L (7 megabytes of +memory overhead) or L (6 megabytes memory overhead and requires +a C compiler). + +To restate, L does B preserve your comments, whitespace, +or the order of your YAML data. But it should round-trip from Perl +structure to file and back again just fine. + +=head1 METHODS + +=for Pod::Coverage HAVE_UTF8 refaddr + +=head2 new + +The constructor C creates a C object as a blessed array +reference. Any arguments provided are taken as separate documents +to be serialized. + +=head2 read $filename + +The C constructor reads a YAML file from a file name, +and returns a new C object containing the parsed content. + +Returns the object on success or throws an error on failure. + +=head2 read_string $string; + +The C constructor reads YAML data from a character string, and +returns a new C object containing the parsed content. If you have +read the string from a file yourself, be sure that you have correctly decoded +it into characters first. + +Returns the object on success or throws an error on failure. + +=head2 write $filename + +The C method generates the file content for the properties, and +writes it to disk using UTF-8 encoding to the filename specified. + +Returns true on success or throws an error on failure. + +=head2 write_string + +Generates the file content for the object and returns it as a character +string. This may contain non-ASCII characters and should be encoded +before writing it to a file. + +Returns true on success or throws an error on failure. + +=for stopwords errstr + +=head2 errstr (DEPRECATED) + +Prior to version 1.57, some errors were fatal and others were available only +via the C<$YAML::Tiny::errstr> variable, which could be accessed via the +C method. + +Starting with version 1.57, all errors are fatal and throw exceptions. + +The C<$errstr> variable is still set when exceptions are thrown, but +C<$errstr> and the C method are deprecated and may be removed in a +future release. The first use of C will issue a deprecation +warning. + +=head1 FUNCTIONS + +YAML::Tiny implements a number of functions to add compatibility with +the L API. These should be a drop-in replacement. + +=head2 Dump + + my $string = Dump(list-of-Perl-data-structures); + +Turn Perl data into YAML. This function works very much like +Data::Dumper::Dumper(). + +It takes a list of Perl data structures and dumps them into a serialized +form. + +It returns a character string containing the YAML stream. Be sure to encode +it as UTF-8 before serializing to a file or socket. + +The structures can be references or plain scalars. + +Dies on any error. + +=head2 Load + + my @data_structures = Load(string-containing-a-YAML-stream); + +Turn YAML into Perl data. This is the opposite of Dump. + +Just like L's thaw() function or the eval() function in relation +to L. + +It parses a character string containing a valid YAML stream into a list of +Perl data structures representing the individual YAML documents. Be sure to +decode the character string correctly if the string came from a file or +socket. + + my $last_data_structure = Load(string-containing-a-YAML-stream); + +For consistency with YAML.pm, when Load is called in scalar context, it +returns the data structure corresponding to the last of the YAML documents +found in the input stream. + +Dies on any error. + +=head2 freeze() and thaw() + +Aliases to Dump() and Load() for L fans. This will also allow +YAML::Tiny to be plugged directly into modules like POE.pm, that use the +freeze/thaw API for internal serialization. + +=head2 DumpFile(filepath, list) + +Writes the YAML stream to a file with UTF-8 encoding instead of just +returning a string. + +Dies on any error. + +=head2 LoadFile(filepath) + +Reads the YAML stream from a UTF-8 encoded file instead of a string. + +Dies on any error. + +=head1 YAML TINY SPECIFICATION + +This section of the documentation provides a specification for "YAML Tiny", +a subset of the YAML specification. + +It is based on and described comparatively to the YAML 1.1 Working Draft +2004-12-28 specification, located at L. + +Terminology and chapter numbers are based on that specification. + +=head2 1. Introduction and Goals + +The purpose of the YAML Tiny specification is to describe a useful subset +of the YAML specification that can be used for typical document-oriented +use cases such as configuration files and simple data structure dumps. + +=for stopwords extensibility + +Many specification elements that add flexibility or extensibility are +intentionally removed, as is support for complex data structures, class +and object-orientation. + +In general, the YAML Tiny language targets only those data structures +available in JSON, with the additional limitation that only simple keys +are supported. + +As a result, all possible YAML Tiny documents should be able to be +transformed into an equivalent JSON document, although the reverse is +not necessarily true (but will be true in simple cases). + +=for stopwords PCRE + +As a result of these simplifications the YAML Tiny specification should +be implementable in a (relatively) small amount of code in any language +that supports Perl Compatible Regular Expressions (PCRE). + +=head2 2. Introduction + +YAML Tiny supports three data structures. These are scalars (in a variety +of forms), block-form sequences and block-form mappings. Flow-style +sequences and mappings are not supported, with some minor exceptions +detailed later. + +The use of three dashes "---" to indicate the start of a new document is +supported, and multiple documents per file/stream is allowed. + +Both line and inline comments are supported. + +Scalars are supported via the plain style, single quote and double quote, +as well as literal-style and folded-style multi-line scalars. + +The use of explicit tags is not supported. + +The use of "null" type scalars is supported via the ~ character. + +The use of "bool" type scalars is not supported. + +=for stopwords serializer + +However, serializer implementations should take care to explicitly escape +strings that match a "bool" keyword in the following set to prevent other +implementations that do support "bool" accidentally reading a string as a +boolean + + y|Y|yes|Yes|YES|n|N|no|No|NO + |true|True|TRUE|false|False|FALSE + |on|On|ON|off|Off|OFF + +The use of anchors and aliases is not supported. + +The use of directives is supported only for the %YAML directive. + +=head2 3. Processing YAML Tiny Information + +B + +=for stopwords deserialization + +The YAML specification dictates three-phase serialization and three-phase +deserialization. + +The YAML Tiny specification does not mandate any particular methodology +or mechanism for parsing. + +Any compliant parser is only required to parse a single document at a +time. The ability to support streaming documents is optional and most +likely non-typical. + +=for stopwords acyclic + +Because anchors and aliases are not supported, the resulting representation +graph is thus directed but (unlike the main YAML specification) B. + +Circular references/pointers are not possible, and any YAML Tiny serializer +detecting a circular reference should error with an appropriate message. + +B + +=for stopwords unicode + +YAML Tiny reads and write UTF-8 encoded files. Operations on strings expect +or produce Unicode characters not UTF-8 encoded bytes. + +B + +=for stopwords modality + +=for stopwords parsers + +YAML Tiny parsers and emitters are not expected to recover from, or +adapt to, errors. The specific error modality of any implementation is +not dictated (return codes, exceptions, etc.) but is expected to be +consistent. + +=head2 4. Syntax + +B + +YAML Tiny streams are processed in memory as Unicode characters and +read/written with UTF-8 encoding. + +The escaping and unescaping of the 8-bit YAML escapes is required. + +The escaping and unescaping of 16-bit and 32-bit YAML escapes is not +required. + +B + +Support for the "~" null/undefined indicator is required. + +Implementations may represent this as appropriate for the underlying +language. + +Support for the "-" block sequence indicator is required. + +Support for the "?" mapping key indicator is B required. + +Support for the ":" mapping value indicator is required. + +Support for the "," flow collection indicator is B required. + +Support for the "[" flow sequence indicator is B required, with +one exception (detailed below). + +Support for the "]" flow sequence indicator is B required, with +one exception (detailed below). + +Support for the "{" flow mapping indicator is B required, with +one exception (detailed below). + +Support for the "}" flow mapping indicator is B required, with +one exception (detailed below). + +Support for the "#" comment indicator is required. + +Support for the "&" anchor indicator is B required. + +Support for the "*" alias indicator is B required. + +Support for the "!" tag indicator is B required. + +Support for the "|" literal block indicator is required. + +Support for the ">" folded block indicator is required. + +Support for the "'" single quote indicator is required. + +Support for the """ double quote indicator is required. + +Support for the "%" directive indicator is required, but only +for the special case of a %YAML version directive before the +"---" document header, or on the same line as the document header. + +For example: + + %YAML 1.1 + --- + - A sequence with a single element + +Special Exception: + +To provide the ability to support empty sequences +and mappings, support for the constructs [] (empty sequence) and {} +(empty mapping) are required. + +For example, + + %YAML 1.1 + # A document consisting of only an empty mapping + --- {} + # A document consisting of only an empty sequence + --- [] + # A document consisting of an empty mapping within a sequence + - foo + - {} + - bar + +B + +Other than the empty sequence and mapping cases described above, YAML Tiny +supports only the indentation-based block-style group of contexts. + +All five scalar contexts are supported. + +Indentation spaces work as per the YAML specification in all cases. + +Comments work as per the YAML specification in all simple cases. +Support for indented multi-line comments is B required. + +Separation spaces work as per the YAML specification in all cases. + +B + +The only directive supported by the YAML Tiny specification is the +%YAML language/version identifier. Although detected, this directive +will have no control over the parsing itself. + +=for stopwords recognise + +The parser must recognise both the YAML 1.0 and YAML 1.1+ formatting +of this directive (as well as the commented form, although no explicit +code should be needed to deal with this case, being a comment anyway) + +That is, all of the following should be supported. + + --- #YAML:1.0 + - foo + + %YAML:1.0 + --- + - foo + + % YAML 1.1 + --- + - foo + +Support for the %TAG directive is B required. + +Support for additional directives is B required. + +Support for the document boundary marker "---" is required. + +Support for the document boundary market "..." is B required. + +If necessary, a document boundary should simply by indicated with a +"---" marker, with not preceding "..." marker. + +Support for empty streams (containing no documents) is required. + +Support for implicit document starts is required. + +That is, the following must be equivalent. + + # Full form + %YAML 1.1 + --- + foo: bar + + # Implicit form + foo: bar + +B + +Support for nodes optional anchor and tag properties is B required. + +Support for node anchors is B required. + +Support for node tags is B required. + +Support for alias nodes is B required. + +Support for flow nodes is B required. + +Support for block nodes is required. + +B + +Support for all five scalar styles is required as per the YAML +specification, although support for quoted scalars spanning more +than one line is B required. + +Support for multi-line scalar documents starting on the header +is not required. + +Support for the chomping indicators on multi-line scalar styles +is required. + +B + +Support for block-style sequences is required. + +Support for flow-style sequences is B required. + +Support for block-style mappings is required. + +Support for flow-style mappings is B required. + +Both sequences and mappings should be able to be arbitrarily +nested. + +Support for plain-style mapping keys is required. + +Support for quoted keys in mappings is B required. + +Support for "?"-indicated explicit keys is B required. + +=for stopwords endeth + +Here endeth the specification. + +=head2 Additional Perl-Specific Notes + +For some Perl applications, it's important to know if you really have a +number and not a string. + +That is, in some contexts is important that 3 the number is distinctive +from "3" the string. + +Because even Perl itself is not trivially able to understand the difference +(certainly without XS-based modules) Perl implementations of the YAML Tiny +specification are not required to retain the distinctiveness of 3 vs "3". + +=head1 SUPPORT + +Bugs should be reported via the CPAN bug tracker at + +L + +=begin html + +For other issues, or commercial enhancement or support, please contact +Adam Kennedy directly. + +=end html + +=head1 AUTHOR + +Adam Kennedy Eadamk@cpan.orgE + +=head1 SEE ALSO + +=over 4 + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=back + +=head1 COPYRIGHT + +Copyright 2006 - 2013 Adam Kennedy. + +This program is free software; you can redistribute +it and/or modify it under the same terms as Perl itself. + +The full text of the license can be found in the +LICENSE file included with this module. + +=cut