NaturalDocs::SourceDB::File

A class used to index items by file.

Summary
NaturalDocs::SourceDB::FileA class used to index items by file.
Variables
MembersThese constants serve as indexes into the object array.
Functions
NewReturns a new object.
AddItemAdds an item to this file.
HasItemReturns whether the item exists in this file.
DeleteItemDeletes the passed item.
ListItemsReturns an array of all the item strings defined for a particular extension, or an empty list if none.

Variables

Members

These constants serve as indexes into the object array.

ITEMSAn arrayref where an ExtensionID is the index and the members are existence hashrefs of the item strigs defined in this file.  The arrayref will always exist, but the hashrefs may be undef.

Functions

New

sub New

Returns a new object.

AddItem

sub AddItem #(ExtensionID extension,
string itemString) => bool

Adds an item to this file.  Returns whether this added a new item.

HasItem

sub HasItem #(ExtensionID extension,
string itemString) => bool

Returns whether the item exists in this file.

DeleteItem

sub DeleteItem #(ExtensionID extension,
string itemString) => bool

Deletes the passed item.  Returns whether it existed.

ListItems

sub ListItems #(ExtensionID extension) => string array

Returns an array of all the item strings defined for a particular extension, or an empty list if none.

sub New
Returns a new object.
sub AddItem #(ExtensionID extension,
string itemString) => bool
Adds an item to this file.
sub HasItem #(ExtensionID extension,
string itemString) => bool
Returns whether the item exists in this file.
sub DeleteItem #(ExtensionID extension,
string itemString) => bool
Deletes the passed item.
sub ListItems #(ExtensionID extension) => string array
Returns an array of all the item strings defined for a particular extension, or an empty list if none.
A unique identifier for each NaturalDocs::SourceDB extension as given out by RegisterExtension().
Close