MediaWiki  1.29.1
SyntaxHighlight_GeSHi.class.php File Reference

Go to the source code of this file.

Functions

static buildHeadItem ( $geshi)
 Backward-compatibility shim for extensions. More...
 
static getLexer ( $lang)
 Get the Pygments lexer name for a particular language. More...
 
static makeCacheKey ( $code, $lexer, $options)
 Construct a cache key for the results of a Pygments invocation. More...
 
static onApiFormatHighlight (IContextSource $context, $text, $mime, $format)
 Hook to provide syntax highlighting for API pretty-printed output. More...
 
static onContentGetParserOutput (Content $content, Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
 Hook into Content::getParserOutput to provide syntax highlighting for script content. More...
 
static onParserFirstCallInit (Parser &$parser)
 Register parser hook. More...
 
static onRejectParserCacheValue (ParserOutput $parserOutput, $page, ParserOptions $popts)
 Reject parser cache values that are for GeSHi since those ResourceLoader modules no longer exist. More...
 
static onResourceLoaderRegisterModules (&$resourceLoader)
 Conditionally register resource loader modules that depends on the VisualEditor MediaWiki extension. More...
 
static onSetup ()
 
static parseHighlightLines ( $lineSpec)
 Take an input specifying a list of lines to highlight, returning a raw list of matching line numbers. More...
 
static parserHook ( $text, $args=array(), $parser)
 Parser hook. More...
 
static prepare ( $text, $lang)
 Backward-compatibility shim for extensions. More...
 
static validHighlightRange ( $start, $end)
 Validate a provided input range. More...
 

Variables

static array $mimeLexers
 Mapping of MIME-types to lexer names. More...
 
return $status
 
class SyntaxHighlight_GeSHi startinline highlight highlight hl_lines start start linenostart start nowrap l f html O
 
class SyntaxHighlight_GeSHi startinline highlight highlight hl_lines start start linenostart start nowrap l f html syntaxhighlight error pygments invocation failure Failed to invoke Pygments
 
$status value = self::highlight( $code, null, $args )->getValue()
 

Function Documentation

◆ buildHeadItem()

static buildHeadItem (   $geshi)
static

Backward-compatibility shim for extensions.

Deprecated:
since MW 1.25
Parameters
GeSHi$geshi
Returns
string

Definition at line 562 of file SyntaxHighlight_GeSHi.class.php.

References wfDeprecated().

◆ getLexer()

static getLexer (   $lang)
staticprivate

Get the Pygments lexer name for a particular language.

Parameters
string$langLanguage name.
Returns
string|null Lexer name, or null if no matching lexer.

Definition at line 329 of file SyntaxHighlight_GeSHi.class.php.

◆ makeCacheKey()

static makeCacheKey (   $code,
  $lexer,
  $options 
)
staticprivate

Construct a cache key for the results of a Pygments invocation.

Parameters
string$codeCode to be highlighted.
string$lexerLexer name.
array$optionsOptions array.
Returns
string Cache key.

Definition at line 333 of file SyntaxHighlight_GeSHi.class.php.

References $options, FormatJson::ALL_OK, FormatJson::encode(), and wfGlobalCacheKey().

◆ onApiFormatHighlight()

static onApiFormatHighlight ( IContextSource  $context,
  $text,
  $mime,
  $format 
)
static

Hook to provide syntax highlighting for API pretty-printed output.

Parameters
IContextSource$context
string$text
string$mime
string$format
Since
MW 1.24
Returns
bool

Definition at line 457 of file SyntaxHighlight_GeSHi.class.php.

References $context, $mime, $mimeLexers, $out, $output, $status, and ContextSource::getOutput().

◆ onContentGetParserOutput()

static onContentGetParserOutput ( Content  $content,
Title  $title,
  $revId,
ParserOptions  $options,
  $generateHtml,
ParserOutput $output 
)
static

Hook into Content::getParserOutput to provide syntax highlighting for script content.

Returns
bool
Since
MW 1.21

Definition at line 401 of file SyntaxHighlight_GeSHi.class.php.

References $content, $generateHtml, $options, $out, $output, $revId, $status, $title, $wgParser, ContentHandler::getContentText(), ExtensionRegistry::getInstance(), and global.

◆ onParserFirstCallInit()

static onParserFirstCallInit ( Parser &  $parser)
static

Register parser hook.

Parameters
$parserParser

Definition at line 363 of file SyntaxHighlight_GeSHi.class.php.

◆ onRejectParserCacheValue()

static onRejectParserCacheValue ( ParserOutput  $parserOutput,
  $page,
ParserOptions  $popts 
)
static

Reject parser cache values that are for GeSHi since those ResourceLoader modules no longer exist.

Parameters
ParserOutput$parserOutput
WikiPage | Article$page
ParserOptions$popts
Returns
bool

Definition at line 492 of file SyntaxHighlight_GeSHi.class.php.

References $page, $parserOutput, and as.

◆ onResourceLoaderRegisterModules()

static onResourceLoaderRegisterModules ( $resourceLoader)
static

Conditionally register resource loader modules that depends on the VisualEditor MediaWiki extension.

Parameters
ResourceLoader$resourceLoader

Definition at line 510 of file SyntaxHighlight_GeSHi.class.php.

References $resourceLoader, and ExtensionRegistry::getInstance().

◆ onSetup()

static onSetup ( )
static

Definition at line 314 of file SyntaxHighlight_GeSHi.class.php.

◆ parseHighlightLines()

static parseHighlightLines (   $lineSpec)
staticprotected

Take an input specifying a list of lines to highlight, returning a raw list of matching line numbers.

Input is comma-separated list of lines or line ranges.

Parameters
string$lineSpec
Returns
int[] Line numbers.

Definition at line 352 of file SyntaxHighlight_GeSHi.class.php.

References $lines, $value, array(), as, list, and validHighlightRange().

◆ parserHook()

static parserHook (   $text,
  $args = array(),
  $parser 
)
static

Parser hook.

Parameters
string$text
array$args
Parser$parser
Returns
string
Exceptions
MWException

Definition at line 378 of file SyntaxHighlight_GeSHi.class.php.

◆ prepare()

static prepare (   $text,
  $lang 
)
static

Backward-compatibility shim for extensions.

Deprecated:
since MW 1.25

Definition at line 551 of file SyntaxHighlight_GeSHi.class.php.

References $lang, and wfDeprecated().

◆ validHighlightRange()

static validHighlightRange (   $start,
  $end 
)
staticprotected

Validate a provided input range.

Parameters
$start
$end
Returns
bool

Definition at line 380 of file SyntaxHighlight_GeSHi.class.php.

Referenced by parseHighlightLines().

Variable Documentation

◆ $mimeLexers

static array $mimeLexers
staticprivate
Initial value:
'text/javascript' => 'javascript',
'application/json' => 'javascript',
'text/xml' => 'xml',
)

Mapping of MIME-types to lexer names.

Definition at line 308 of file SyntaxHighlight_GeSHi.class.php.

Referenced by onApiFormatHighlight().

◆ $status

return $status

◆ O

class SyntaxHighlight_GeSHi startinline highlight highlight hl_lines start start linenostart start nowrap l f html O

Definition at line 22 of file SyntaxHighlight_GeSHi.class.php.

◆ Pygments

class SyntaxHighlight_GeSHi startinline highlight highlight hl_lines start start linenostart start nowrap l f html syntaxhighlight error pygments invocation failure Failed to invoke Pygments

Definition at line 22 of file SyntaxHighlight_GeSHi.class.php.

◆ value

array
the array() calling protocol came about after MediaWiki 1.4rc1.