/ 
lsn-data-hub-05.00289
River stage zero No dependents
/ Data::Format::Hash

NAME

Data::Format::Hash - Parse and format perl data structures

SYNOPSIS

EXPORTS

Nothing exported by default

Exported upon request

HF_VERSION_MAJOR, HF_VERSION_MINOR, HF_VERSION_STR, hf_parse, hf_format

:all

HF_VERSION_MAJOR, HF_VERSION_MINOR, HF_VERSION_STR, hf_parse, hf_format

DEPENDENCIES

This module requires these other modules and libraries:

Data::Hub::Address
Error::Programatic
Perl::Module
Data::Hub::Util
Exporter
Data::OrderedHash

DESCRIPTION

PUBLIC INTERFACE

parse

Parse text into perl data structures

options:

-as_array=1         # Treat text as an array list (and return an array ref)
-hint=hint          # Usually a filename, used in debug/error output

This example will not abort:

use Data::Format::Hash qw(hf_parse);

This example:

# Parse a simple nested collection
my $d = q(
baz => biz
foo => %{
bar => @{
tender
stool
}
}
);
my $h = hf_parse(\$d);
$$h{'baz'};

will return:

biz

format

Format nested data structure as string

options:

-as_ref => 1        Return a reference (default 0)
-with_crown => 1    Prepend output with "# HashFile M.m" (where M.m is version)

This example will not abort:

use Data::Format::Hash qw(hf_format);

This example:

# Format a simple nested collection
my $d = {foo=>{bar=>['tender','stool']}};
hf_format($d)

will return:

foo => %{
  bar => @{
    tender
    stool
  }
}

PACKAGE INTERNALS

_trace

Debug output while parsing

_make_crown

Return the hash-format file crown

_format

Implementation of format

_escape

Esacape patterns which would be interpred as control characters

_unescape

Remove protective backslashes

_get_indent

Get the indent for formatting nested sructures

_get_hint

Context information for error messages

AUTHORS

Ryan Gies <ryangies@cpan.org>

COPYRIGHT

Copyright (C) 2014-2016 by Ryan Gies. All rights reserved.
Copyright (C) 2006-2013 by Livesite Networks, LLC. All rights reserved.
Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.
Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, 
this list of conditions and the following disclaimer.
* The origin of this software must not be misrepresented; you must not 
claim that you wrote the original software. If you use this software in a 
product, an acknowledgment in the product documentation would be 
appreciated but is not required.
* Altered source versions must be plainly marked as such, and must not be 
misrepresented as being the original software.
* The name of the author may not be used to endorse or promote products 
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
OF SUCH DAMAGE.
To the best of our knowledge, no patented algorithms have been used. However, we
do not have the resources to carry out a patent search, and therefore cannot 
give any guarantee of the above statement.