NaturalDocs:: Languages

A package to manage all the programming languages Natural Docs supports.

Usage and Dependencies

Prior to use, NaturalDocs::Settings must be initialized and all supported languages need to be added via Add().

Summary

NaturalDocs:: Languages	A package to manage all the programming languages Natural Docs supports.
Variables
languages	An array of all the defined languages.
extensions	A hash of all the defined languages’ extensions.
shebangs	A hash of all the defined languages’ strings to search for in the shebang (#!)
Functions
LanguageOf	Returns the language of the passed source file.
IsSupported	Returns whether the language of the passed file is supported.
SeparateMember	Separates a class from its member.
Support Functions
Add	Adds a language to the package.

Variables

languages

my @languages

An array of all the defined languages. Each entry is a NaturalDocs::Languages::Language object.

extensions

my %extensions

A hash of all the defined languages’ extensions. The keys are the all-lowercase extensions, and the values are indexes into languages.

shebangs

my %shebangs

A hash of all the defined languages’ strings to search for in the shebang (#!) line. The keys are the all-lowercase strings, and the values are indexes into languages.

Functions

LanguageOf

sub LanguageOf #(file)

Returns the language of the passed source file.

Parameters

file	The source file to get the language of.

Returns

A NaturalDocs::Languages::Language object for the passed file, or undef if the file is not a recognized language.

IsSupported

sub IsSupported #(file)

Returns whether the language of the passed file is supported.

Parameters

file	The file to test.

Returns

Whether the file’s language is supported.

SeparateMember

sub SeparateMember #(string)

Separates a class from its member. If there are multiple member separators in the string, it assumes the last one is correct and all previous ones are part of the class name. For example, “package::class::function” will be split into “package::class” and “function”.

Parameters

string

The string of text to separate.

Returns

An array. If the string had a member separator in it, the first item will be the class and the second the identifier. If there was no member separator, there will only be one item, which will contain the original string.

Support Functions

Add

sub Add #(name, extensions, shebangStrings, lineComment, startComment, endComment, functionEnders, variableEnders)

Adds a language to the package.

Parameters

name	The name of the language.
extensions	An arrayref of the extensions of the language’s files.
shebangStrings	An arrayref of the strings to search for in the #! line of the language’s files. Only used when the file has a .cgi extension or no extension at all. Undef if not applicable.
lineComment	The symbol that starts a single line comment. Undef if none.
startComment	The symbol that starts a multi-line comment. Undef if none.
endComment	The symbol that ends a multi-line comment. Undef if none.
functionEnders	An arrayref of symbols that end a function prototype. Include “\n” if necessary. Undef if the language doesn’t have functions.
variableEnders	An arrayref of symbols that end a variable declaration. Include “\n” if necessary. Undef if the doesn’t have variables.

Note that if neither of the comment styles are specified, it is assumed that the entire file should be treated as a comment.