NAME

cs::GNUInfo::Node - a node in a cs::GNUInfo object

SYNOPSIS

use cs::GNUInfo::Node;

DESCRIPTION

This module provides the node description used by the cs::GNUInfo object.

GENERAL FUNCTIONS

OBJECT CREATION

Preamble on creation methods.

new cs::GNUInfo::Node type, name: Creates a new node of the specified type (FILE, INDIRECT, etc) optionally named name.

OBJECT METHODS

Type(): Get the TYPE of this node.
Name(name): Get or set the node name.
Fields(hashref): if the optional parameter hashref is supplied, set values in the FIELDS hash from those in hashref. Returns a reference to the FIELDS hash.
Field(name,value): Set or get the FIELDS entry named name.
Level(level): Set or get the LEVEL of this node, used to determine the heading level.
SetLevels(level): Recursively mark this node and its subsidiaries with their depth. The level parameter is normally omitted, defaulting to 1.
Info(info): Set or get the INFO of this node, a reference to the parent cs::GNUInfo object.
ByName(name): Return the node named name by consulting the parent cs::GNUInfo object.
Title(title): Set or get the TITLE of this node.
SubNodes(): Return the array of subsidiary nodes.
AddSubNode(subnode): Attach the specified subnode as a child of this node.
Super(parent): Record the node parent as the superior node of this one.
Data(): Return a reference to the DATA array.
AddDatum(datum): Push the datum onto the end of the DATA array.
Indent(): Return the indent of the last line added to the node.
HadNL(): Return whether the last line added to the node was blank.
AddLine(line,source,filename): Add the supplied line (from the cs::Source source, named filename) to the node.; If this is the first nonblank line and is a heading then set the title for the node and discard the line and add the first line after the heading.
Pod2s(sink): Transcribe this node and its subsidiaries to the cs::Sink sink.

AUTHOR

Cameron Simpson <cs@zip.com.au>