PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

---

Parent package: Foswiki::Plugins::BeautifierPlugin
Child packages:

More ...Less ...

• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_bash
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_cpp
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_csharp
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_html
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_java
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_javascript
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_lua
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_makefile
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_perl
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_php3
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_plsql
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_python
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_scheme
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_tcl
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_verilog
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_vhdl
• Foswiki::Plugins::BeautifierPlugin::HFile::HFile_xml

internal package BeautifierPlugin::HFile

Base class and object instance factory for Beautifier Language Syntax Highlighter definitions. This class was originally derived from Mike Jewell's Beautifier: Flexible Syntax Highlighter package written in PHP.

StaticMethod getLanguage( $topic, $lang ) → $HFile

Factory method that loads the submodule for the requested language definition and instantiates and returns a handler object for it.

• $topic - the web.topic of the topic being processed
• $lang - the language specifier for the desired language definition

Returns: the language definition object on success or undef on failure

ClassMethod new( $class ) → $HFile

Contructor for the abstract BeautifierPlugin::HFile superclass.

• $class - the invocant (i.e., the class being instantiated into an object)

Returns: a reference to the newly instantiated object

_warning( $topic, $msg )

Log a warning and debug message. The topic is prepended to the message.

• $topic - the web.topic being processed
• $msg - the message text to write to the warning and debug logs

_debugEntryPoint( $topic, $func, $args )

Write a function entry message to the debug log if debug logging is enabled. The topic is prepended to the message.

• $topic - the web.topic being processed
• $func - the name of the function being logged
• $args - a reference to a hash containing the arguments passed to $func

_debug( $topic, $msg )

Write the supplied message to the debug log if debug logging is enabled. The Perl package name and topic are prepended to the message.

• $topic - the web.topic being processed
• $msg - the message text to write to the debug log