forked from avar/YAML-Syck
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
577 additions
and
210 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,188 @@ | ||
=head1 NAME | ||
|
||
YAML::Syck - Fast, lightweight YAML loader and dumper | ||
|
||
=head1 SYNOPSIS | ||
|
||
use YAML::Syck; | ||
|
||
# Set this for interoperability with other YAML/Syck bindings: | ||
# e.g. Load('Yes') becomes 1 and Load('No') becomes ''. | ||
$YAML::Syck::ImplicitTyping = 1; | ||
|
||
$data = Load($yaml); | ||
$yaml = Dump($data); | ||
|
||
# $file can be an IO object, or a filename | ||
$data = LoadFile($file); | ||
DumpFile($file, $data); | ||
|
||
# A string with multiple YAML streams in it | ||
$yaml = Dump(@data); | ||
@data = Load($yaml); | ||
|
||
# Dumping into a pre-existing output buffer | ||
my $yaml; | ||
DumpInto(\$yaml, @data); | ||
|
||
=head1 DESCRIPTION | ||
|
||
This module provides a Perl interface to the B<libsyck> data serialization | ||
library. It exports the C<Dump> and C<Load> functions for converting | ||
Perl data structures to YAML strings, and the other way around. | ||
|
||
B<NOTE>: If you are working with other language's YAML/Syck bindings | ||
(such as Ruby), please set C<$YAML::Syck::ImplicitTyping> to C<1> before | ||
calling the C<Load>/C<Dump> functions. The default setting is for | ||
preserving backward-compatibility with C<YAML.pm>. | ||
|
||
=head1 Differences Between YAML::Syck and YAML | ||
|
||
=head2 Error handling | ||
|
||
Some calls are designed to die rather than returning YAML. You should wrap | ||
your calls in eval to assure you do not get unexpected results. | ||
|
||
=head1 FLAGS | ||
|
||
=head2 $YAML::Syck::Headless | ||
|
||
Defaults to false. Setting this to a true value will make C<Dump> omit the | ||
leading C<---\n> marker. | ||
|
||
=head2 $YAML::Syck::SortKeys | ||
|
||
Defaults to false. Setting this to a true value will make C<Dump> sort | ||
hash keys. | ||
|
||
=head2 $YAML::Syck::SingleQuote | ||
|
||
Defaults to false. Setting this to a true value will make C<Dump> always emit | ||
single quotes instead of bare strings. | ||
|
||
=head2 $YAML::Syck::ImplicitTyping | ||
|
||
Defaults to false. Setting this to a true value will make C<Load> recognize | ||
various implicit types in YAML, such as unquoted C<true>, C<false>, as well as | ||
integers and floating-point numbers. Otherwise, only C<~> is recognized to | ||
be C<undef>. | ||
|
||
=head2 $YAML::Syck::ImplicitUnicode | ||
|
||
Defaults to false. For Perl 5.8.0 or later, setting this to a true value will | ||
make C<Load> set Unicode flag on for every string that contains valid UTF8 | ||
sequences, and make C<Dump> return a unicode string. | ||
|
||
Regardless of this flag, Unicode strings are dumped verbatim without escaping; | ||
byte strings with high-bit set will be dumped with backslash escaping. | ||
|
||
However, because YAML does not distinguish between these two kinds of strings, | ||
so this flag will affect loading of both variants of strings. | ||
|
||
If you want to use LoadFile or DumpFile with unicode, you are required to open | ||
your own file in order to assure it's UTF8 encoded: | ||
|
||
open(my $fh, ">:encoding(UTF-8)", "out.yml"); | ||
DumpFile($fh, $hashref); | ||
|
||
=head2 $YAML::Syck::ImplicitBinary | ||
|
||
Defaults to false. For Perl 5.8.0 or later, setting this to a true value will | ||
make C<Dump> generate Base64-encoded C<!!binary> data for all non-Unicode | ||
scalars containing high-bit bytes. | ||
|
||
=head2 $YAML::Syck::UseCode / $YAML::Syck::LoadCode / $YAML::Syck::DumpCode | ||
|
||
These flags control whether or not to try and eval/deparse perl source code; | ||
each of them defaults to false. | ||
|
||
Setting C<$YAML::Syck::UseCode> to a true value is equivalent to setting | ||
both C<$YAML::Syck::LoadCode> and C<$YAML::Syck::DumpCode> to true. | ||
|
||
=head2 $YAML::Syck::LoadBlessed | ||
|
||
Defaults to true. Setting to false will block YAML::Syck from doing ANY | ||
blessing. This is an interface change since 1.21. The variable name was | ||
misleading, implying that no blessing would happen when in fact it did. | ||
|
||
Prior to 1.22, setting this to a false value only prevented C<Load> from | ||
blessing tag names that did not begin with C<!!perl> or C<!perl>;. | ||
|
||
=head1 BUGS | ||
|
||
Dumping Glob/IO values do not work yet. | ||
|
||
Dumping of Tied variables is unsupported. | ||
|
||
Dumping into tied (or other magic variables) with C<DumpInto> might not work | ||
properly in all cases. | ||
|
||
=head1 CAVEATS | ||
|
||
This module implements the YAML 1.0 spec. To deal with data in YAML 1.1, | ||
please use the C<YAML::XS> module instead. | ||
|
||
The current implementation bundles libsyck source code; if your system has a | ||
site-wide shared libsyck, it will I<not> be used. | ||
|
||
Tag names such as C<!!perl/hash:Foo> is blessed into the package C<Foo>, but | ||
the C<!hs/foo> and C<!!hs/Foo> tags are blessed into C<hs::Foo>. Note that | ||
this holds true even if the tag contains non-word characters; for example, | ||
C<!haskell.org/Foo> is blessed into C<haskell.org::Foo>. Please use | ||
L<Class::Rebless> to cast it into other user-defined packages. You can also | ||
set the LoadBlessed flag false to disable all blessing. | ||
|
||
This module has L<a lot of known | ||
issues|https://rt.cpan.org/Public/Dist/Display.html?Name=YAML-Syck> | ||
and has only been semi-actively maintained since 2007. If you | ||
encounter an issue with it probably won't be fixed unless you L<offer | ||
up a patch|http://github.com/toddr/YAML-Syck> in Git that's ready for | ||
release. | ||
|
||
There are still good reasons to use this module, such as better | ||
interoperability with other syck wrappers (like Ruby's), or some edge | ||
case of YAML's syntax that it handles better. It'll probably work | ||
perfectly for you, but if it doesn't you may want to look at | ||
L<YAML::XS>, or perhaps at looking another serialization format like | ||
L<JSON>. | ||
|
||
=head1 SEE ALSO | ||
|
||
L<YAML>, L<JSON::Syck> | ||
|
||
L<http://www.yaml.org/> | ||
|
||
=head1 AUTHORS | ||
|
||
Audrey Tang E<lt>cpan@audreyt.orgE<gt> | ||
|
||
=head1 COPYRIGHT | ||
|
||
Copyright 2005-2009 by Audrey Tang E<lt>cpan@audreyt.orgE<gt>. | ||
|
||
This software is released under the MIT license cited below. | ||
|
||
The F<libsyck> code bundled with this library is released by | ||
"why the lucky stiff", under a BSD-style license. See the F<COPYING> | ||
file for details. | ||
|
||
=head2 The "MIT" License | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS | ||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | ||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
DEALINGS IN THE SOFTWARE. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,4 +30,4 @@ sub F_UTF8 () { 0x8000 } | |
1; | ||
__END__ | ||
#line 332 | ||
#line 331 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
#line 1 | ||
# Scalar::Util.pm | ||
# | ||
# Copyright (c) 1997-2007 Graham Barr <gbarr@pobox.com>. All rights reserved. | ||
# This program is free software; you can redistribute it and/or | ||
# modify it under the same terms as Perl itself. | ||
|
||
package Scalar::Util; | ||
|
||
use strict; | ||
require Exporter; | ||
require List::Util; # List::Util loads the XS | ||
|
||
our @ISA = qw(Exporter); | ||
our @EXPORT_OK = qw( | ||
blessed | ||
dualvar | ||
isdual | ||
isvstring | ||
isweak | ||
looks_like_number | ||
openhandle | ||
readonly | ||
refaddr | ||
reftype | ||
set_prototype | ||
tainted | ||
weaken | ||
); | ||
our $VERSION = "1.27"; | ||
$VERSION = eval $VERSION; | ||
|
||
our @EXPORT_FAIL; | ||
|
||
unless (defined &weaken) { | ||
push @EXPORT_FAIL, qw(weaken); | ||
} | ||
unless (defined &isweak) { | ||
push @EXPORT_FAIL, qw(isweak isvstring); | ||
} | ||
unless (defined &isvstring) { | ||
push @EXPORT_FAIL, qw(isvstring); | ||
} | ||
|
||
sub export_fail { | ||
if (grep { /^(?:weaken|isweak)$/ } @_ ) { | ||
require Carp; | ||
Carp::croak("Weak references are not implemented in the version of perl"); | ||
} | ||
|
||
if (grep { /^isvstring$/ } @_ ) { | ||
require Carp; | ||
Carp::croak("Vstrings are not implemented in the version of perl"); | ||
} | ||
|
||
@_; | ||
} | ||
|
||
1; | ||
|
||
__END__ | ||
#line 303 |
Oops, something went wrong.