Hub::Data::Address -

 Usage: keydepth

For sorting parents and children, this simply lets you know how deep the key is named.

Example: (matches)

    keydepth( 'and:then:came:the:rain' )




    4

 Usage: vartype VARADDR, [DEFAULT]

Return a variables type (or a default value).

Example: (matches)

    vartype( );

Example: (matches)

    vartype( "clr-bg" );




    clr

Example: (matches)

    vartype( "clr-bg", "default" );




    clr

Example: (matches)

    vartype( "whatev", "default" );




    default

Example: (matches)

    vartype( "whatev" );

Example: (matches)

    vartype( "a:b:c" );

Example: (matches)

    vartype( "x-a:b:c" );




    x

Example: (matches)

    vartype( "a:b:x-c" );




    x

 Usage: varroot VARADDR

The root portion of the address.

Example: (matches)

    varroot( "p001:items:1002:text-description" );




    p001

Example: (matches)

    varroot( "p001" );




    p001

 Usage: varname VARADDR

Example: (matches)

    varname( "p001:items:1002:text-desc" );




    text-desc

Example: (matches)

    varname( "p001" );




    p001

 Usage: varparent VARADDR

Parent address.

Example: (matches)

    varparent( "p001:items:12:1000" );




    p001:items:12

Example: (matches)

    varparent( "p001:items:10:subs:100" );




    p001:items:10:subs

Example: (matches)

    varparent( "p001" );

 Usage: dotaddr VARADDR

Replace address separators with dots. In essence, protecting the address from expansion.

Example: (matches)

    dotaddr("p004:proj:1000");




    p004.proj.1000

Example: (matches)

    dotaddr("p004:proj:1000:name");




    p004.proj.1000.name

Example: (matches)

    dotaddr("p001");




    p001

Example returns: defined:

    dotaddr("");

 Usage: expand HASHREF, [OPTIONS]

Expands keys which are formatted as names (see naming.txt) into subhashes and subarrays as necessary.

OPTIONS:

  meta    => 1                # add '.address' and '.id' metadata to hashes
  root    => SCALAR           # use this as a prefix for '.address'

Returns HASHREF

Collapse a nested structure into key/value pairs

 Usage: collapse ?ref, [options]

options

  -containers=1        Just return containers

Returns a hash reference.

Ryan Gies (ryangies@livesite.net)

Copyright (C) 2006-2007 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.

08/02/2007