NaturalDocs::Languages::Advanced::Scope

A class used to store a scope level.

Summary

NaturalDocs::Languages::Advanced::Scope	A class used to store a scope level.
Constants
Implementation	The object is implemented as a blessed arrayref.
Functions
New	Creates and returns a new object.
ClosingSymbol	Returns the closing symbol character of the scope.
Package	Returns the package SymbolString of the scope, or undef if none.
SetPackage	Sets the package SymbolString of the scope.
Using	Returns an arrayref of SymbolStrings for using statements, or undef if none
AddUsing	Adds a SymbolString to the Using() array.

The object is implemented as a blessed arrayref. The constants below are used as indexes.

CLOSING_SYMBOL	The closing symbol character of the scope.
PACKAGE	The package SymbolString of the scope.
USING	An arrayref of SymbolStrings for using statements, or undef if none.

sub New #( closingSymbol,
package,
using )

Creates and returns a new object.

closingSymbol	The closing symbol character of the scope.
package	The package SymbolString of the scope.
using	An arrayref of using SymbolStrings, or undef if none. The contents of the array will be duplicated.

If package is set to undef, it is assumed that it inherits the value of the previous scope on the stack.

sub ClosingSymbol

Returns the closing symbol character of the scope.

sub Package

Returns the package SymbolString of the scope, or undef if none.

sub SetPackage #( package )

Sets the package SymbolString of the scope.

sub Using

Returns an arrayref of SymbolStrings for using statements, or undef if none

sub AddUsing #( using )

Adds a SymbolString to the Using() array.