Natural Docs
Version 1.2
Natural Docs
Packages
Objects
Languages
Output Formats
Extensions
Documentation
Indexes
Web Site

NaturalDocs:: SymbolTable:: File

A class representing a file, keeping track of what symbols and references are defined in it.

Summary
NaturalDocs:: SymbolTable:: File
A class representing a file, keeping track of what symbols and references are defined in it.
Implementation
Members
The class is implemented as a blessed arrayref.
Modification Functions
New
Creates and returns a new object.
AddSymbol
Adds a symbol definition.
DeleteSymbol
Removes a symbol definition.
AddReference
Adds a reference definition.
DeleteReference
Removes a reference definition.
Information Functions
HasAnything
Returns whether the file has any symbol or reference definitions at all.
Symbols
Returns an array of all the symbols defined in this file.
References
Returns an array of all the references defined in this file.
DefinesSymbol
Returns whether the file defines the passed symbol or not.
DefinesReference
Returns whether the file defines the passed reference or not.

Implementation

Members

The class is implemented as a blessed arrayref.  The following constants are its members.

SYMBOLSAn existence hashref of all the symbols it defines.
REFERENCESAn existence hashref of all the references in the file.

Modification Functions

New

sub New

Creates and returns a new object.

AddSymbol

sub AddSymbol #(symbolString)

Adds a symbol definition.

Parameters

symbolStringThe symbol string being added.

DeleteSymbol

sub DeleteSymbol #(symbolString)

Removes a symbol definition.

Parameters

symbolStringThe symbol to delete.

AddReference

sub AddReference #(referenceString)

Adds a reference definition.

Parameters

referenceStringThe reference string being added.

DeleteReference

sub DeleteReference #(referenceString)

Removes a reference definition.

Parameters

referenceStringThe reference to delete.

Information Functions

HasAnything

sub HasAnything

Returns whether the file has any symbol or reference definitions at all.

Symbols

sub Symbols

Returns an array of all the symbols defined in this file.  If none, returns an empty array.

References

sub References

Returns an array of all the references defined in this file.  If none, returns an empty array.

DefinesSymbol

sub DefinesSymbol #(symbolString)

Returns whether the file defines the passed symbol or not.

DefinesReference

sub DefinesReference #(referenceString)

Returns whether the file defines the passed reference or not.
Copyright © 2003-2004 Greg Valure.  Generated by Natural Docs.
sub New
Creates and returns a new object.
sub AddSymbol #(symbolString)
Adds a symbol definition.
sub DeleteSymbol #(symbolString)
Removes a symbol definition.
sub AddReference #(referenceString)
Adds a reference definition.
sub DeleteReference #(referenceString)
Removes a reference definition.
sub HasAnything
Returns whether the file has any symbol or reference definitions at all.
sub Symbols
Returns an array of all the symbols defined in this file.
sub References
Returns an array of all the references defined in this file.
sub DefinesSymbol #(symbolString)
Returns whether the file defines the passed symbol or not.
sub DefinesReference #(referenceString)
Returns whether the file defines the passed reference or not.