Repo: community/formatter/highlight/geshi.php

https://github.com/GeSHi/geshi-1.0
GeSHi Documentation

1. Usage

Call via (geshi [formatter])

%%(geshi php numbers=1 start=35 lines=37) source%%

2. Install

1. place the GeSHi lib under the lib/geshi/ folder
2. add geshi.php highlighter to the formatter/highlight/ folder
3. generate a external stylesheet (optional)

formatter/highlight/geshi.php

<?php

// WackoWiki Wrapper for GeSHi - Generic Syntax Highlighter
// https://wackowiki.org/doc/Dev/PatchesHacks/GeSHi

// GeSHi uses constants outside its class, so autoload will default with:
// PHP Fatal error:  Uncaught Error: Undefined constant "GESHI_NO_LINE_NUMBERS"
require_once 'lib/geshi/geshi.php'; // -> autoload.conf

if ($options['_default'])
{
    $language    = $options['_default'];
    $lines        = [];
    $numbers    = GESHI_NO_LINE_NUMBERS;
    $start        = (int) ($options['start'] ?? 1);
    $header        = GESHI_HEADER_PRE_VALID;

    $geshi = new GeSHi($text, $language);

    if (!empty($options['lines']))
    {
        $lines = array_map('intval', explode(',', $options['lines']));
        $lines = array_unique($lines);
    }

    if (!empty($options['numbers']))
    {
        $numbers = $options['numbers'] ? GESHI_NORMAL_LINE_NUMBERS : GESHI_NO_LINE_NUMBERS;

        $header = match ((int) $options['numbers'])
        {
            1        => GESHI_HEADER_PRE_VALID,
            2        => GESHI_HEADER_PRE_TABLE,
            default    => false,
        };
    }

    $geshi->enable_classes();            // use classes for highlighting (must be first after creating object)
    $geshi->set_overall_class('code');    // enables using a single stylesheet for multiple code fragments
    $geshi->set_tab_width(4);            // default: 8

    $geshi->set_header_type($header);    // GESHI_HEADER_DIV, GESHI_HEADER_PRE_VALID, GESHI_HEADER_PRE_TABLE, GESHI_HEADER_NONE

    $geshi->enable_line_numbers((bool) $numbers); // GESHI_NORMAL_LINE_NUMBERS, GESHI_FANCY_LINE_NUMBERS, 2 GESHI_NO_LINE_NUMBERS
    $geshi->start_line_numbers_at((int) abs($start));
    $geshi->highlight_lines_extra($lines);

    // get the stylesheet
    if (!file_exists(Ut::join_path(THEME_DIR, '_common/geshi.css')))
    {
        $tpl->css_styles    = $geshi->get_stylesheet(false);
    }
    else
    {
        $this->geshi = true;
    }

    $tpl->text            = $geshi->parse_code();
}
else
{
    $tpl->text            = Ut::html($text);
}
	

formatter/highlight/template/geshi.tpl

[ === main === ]
<ignore>
<!--notypo-->
	[= css _ =
		<style>
		[ ' styles ' ]
		</style>
	=]
	[ ' text | pre ' ]
<!--/notypo-->
</ignore>	

2.1. External stylesheet

GeSHi comes with a contrib/ directory, which in it contains a “wizard” script for creating a stylesheet. The script has been ported as a action to WackoWiki, see section below.

With up to 160 languages which one hardly will ever use, it is a good idea to generate a stylesheet with the languages you use. If you select all languages, the size of the stylesheet reaches almost 300 KiB.
There is no mixed usage of inline CSS and external stylesheet, its either one or the other. So if you select a subset, then no inline CSS is available for the other languages, consider that.

geshi.css (incomplete)

/* GeSHi - syntax highlighting code */

.code .de1, .code .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align\top;}
.code  {font-family:monospace;}
.code .imp {font-weight: bold; color: red;}
.code li, .code .li1 {font-weight: normal; vertical-align\top;}
.code .ln width:1px;text-align\right;margin:0;padding:0 2px;vertical-align\top;}
.code .li2 {font-weight: bold; vertical-align\top;}
.code .kw2 {color: #000000; font-weight: bold;}
.code .kw3 {color: #000066;}
.code .es0 {color: #000099; font-weight: bold;}
.code .br0 {color: #66cc66;}
.code .sy0 {color: #66cc66;}
.code .st0 {color: #ff0000;}
.code .nu0 {color: #cc66cc;}
.code .sc-2 {color: #404040;}
.code .sc-1 {color: #808080; font-style: italic;}
.code .sc0 {color: #00bbdd;}
.code .sc1 {color: #ddbb00;}
.code .sc2 {color: #009900;}
.code .ln-xtra, .code li.ln-xtra, .code div.ln-xtra {background-color: #ffc;}
.code span.xtra { display:block; } 	

<?php

// add to theme/_common/_header.php (above $tpl->additions)

// GeSHi styles
$this->add_html('header', '<link rel="stylesheet" href="' . Ut::join_path(THEME_DIR, '_common/geshi.css') . '">');
	

2.1.1. Generate custom CSS files

Script to generate custom GeSHi CSS files, only available for members of the Admin group.

action/geshicss.php

<?php

if (!defined('IN_WACKO'))
{
    exit;
}

/*

generate custom CSS files for GeSHi

{{geshicss custom=0}}

*/

if ($this->is_admin())
{
    // set defaults
    $checked    ??= null;
    $custom        ??= false;
    $wiki_text    ??= true;

    $checked    = (bool) ($_GET['all'] ?? false);
    $none        = (bool) ($_GET['none'] ?? false);

    require_once 'lib/geshi/geshi.php';

    $geshi = new GeSHi();
    $languages = $geshi->get_supported_languages();
    sort($languages);

    // [a] create stylesheet
    if (isset($_POST['langs']) && is_array($_POST['langs']))
    {
        foreach ($_POST['langs'] as $lang => $dummy)
        {
            if (in_array($lang, $languages))
            {
                $_languages[] = $lang;
            }
        }

        $tpl->enter('post_');

        foreach ($_languages as $i => $language)
        {
            $geshi->set_language($language);
            $css    = $geshi->get_stylesheet(false);
            // remove comments
            $styles    .= preg_replace('/^\/\*\*.*?\*\//s', '', $css);

            if ($wiki_text)
            {
                $tpl->enter('syntax_');

                $geshi->set_language($language);
                $tpl->n_n_num  = $i +1;
                $tpl->n_n_name = $geshi->get_language_name();
                $tpl->n_n_lang = $language;

                $tpl->leave();    // syntax_
                $tpl->commit = true;
            }
        }

        $tpl->stylesheet = $styles;
        $tpl->size = $this->binary_multiples(strlen($styles), false, true, true);
        $tpl->reset = true;
        $tpl->leave();    // post_
    }
    // [b] select languages
    else
    {
        $tpl->enter('form_');
        $tpl->n_select    = $this->href('', '', ['all' => 1]);
        $tpl->n_none    = $this->href('', '', ['none' => 1]);

        // set a preselection
        $pre_selected = [
            'css',
            'diff',
            'email',
            'html5',
            'ini',
            'javascript',
            'latex',
            'php',
            'python',
            'sql',
            'xml'
        ];

        foreach ($languages as $language)
        {
            $tpl->lang_lang        = $language;

            if ($checked || (!$none && in_array($language, $pre_selected)))
            {
                $tpl->lang_checked    = ' checked';
            }
        }

        if ($custom)
        {
            $new_lang = [
                'overall'            => ['Style for the overall code block:',
                                        'border: 1px dotted #a0a0a0; font-family: "Courier New", Courier, monospace; background-color: #f0f0f0; color: #0000bb;'],
                'default-styles'    => ['Default Styles',
                                        'font-weight:normal;background:transparent;color:#000; padding-left: 5px;'],
                'keywords-1'        => ['Keywords I (if, do, while etc)',
                                        'color: #a1a100;'],
                'keywords-2'        => ['Keywords II (null, true, false etc)',
                                        'color: #000; font-weight: bold;'],
                'keywords-3'        => ['Inbuilt Functions (echo, print etc)',
                                        'color: #000066;'],
                'keywords-4'        => ['Data Types (int, boolean etc)',
                                        'color: #f63333;'],
                'comments'            => ['Comments (//, <!--  --> etc)',
                                        'color: #808080;'],
                'escaped-chars'        => ['Escaped Characters (\n, \t etc)',
                                        'color: #000033; font-weight: bold;'],
                'brackets'            => ['Brackets ( ([{}]) etc)',
                                        'color: #66cc66;'],
                'strings'            => ['Strings ("foo" etc)',
                                        'color: #ff0000;'],
                'numbers'            => ['Numbers (1, -54, 2.5 etc)',
                                        'color: #ff33ff;'],
                'methods'            => ['Methods (Foo.bar() etc)',
                                        'color: #006600;'],
            ];

            $tpl->enter('custom_');

            foreach ($new_lang as $type => $style)
            {
                $tpl->style_type    = $type;
                $tpl->style_text    = $style[0];
                $tpl->style_style    = $style[1];
            }

            $tpl->leave();    // custom_
        }

        $tpl->leave();    // form_
    }
}
	

action/template/geshicss.tpl

[ === main === ]
	[= post _ =
		<div class="info type-success">
			<div class="info-content">
				<p class="info-title">Here is your completed stylesheet.</p>
				Note that it may not be perfect - no regular expression styles are included for one thing,
				you'll have to add those yourself (php and xml are just two languages that use them), and line numbers are not included, however
				it includes most of the basic information.
			</div>
		</div>
		[ '' reset ResetButton '' ]<br><br>
		<strong>theme/_common/geshi.css</strong> ([ ' size ' ])
		<pre class="code">
			[ ' stylesheet | pre' ]
		</pre>

		[= syntax _ =
			<strong>syntax wiki table</strong>
			<pre class="code">
				[ '' n table '' ]
			</pre>
		=]
		
		[ '' reset ResetButton '' ]
	=]

	[= form _ =
		<form action="[ ' href: ' ]" method="post" name="geshi_css">
			[ ' csrf: geshi_css ' ]
			What languages are you wanting to make this stylesheet for?<br><br>
			[ '' CreateButton '' ]<br><br>
			[ '' n selection '' ]<br>
			<div class="wrapper-col5">
			[= lang _ =
				<input type="checkbox" name="langs[[ ' lang ' ]]" id="lang_[ ' lang ' ]"[ ' checked ' ]>
				<label for="lang_[ ' lang ' ]">[ ' lang ' ]</label><br>
			=]
			</div>
			<br>
			[ '' n selection '' ]
			<br>

			[= custom _ =
				If you'd like any other languages not detected here to be supported, please enter
				them here, one per line:<br>
				<textarea rows="4" cols="20" name="extra-langs"></textarea><br>
				<br>
				Styles:
				<table>
				[= style _ =
					<tr>
						<th>[ ' text ' ]</th>
						<td><input type="text" name="[ ' type ' ]" value="[ ' style ' ]"></td>
					</tr>
				=]
				</table>
			=]

			[ '' CreateButton '' ]
		</form>
	=]

[ == selection == ]
Select: <a href="[ ' select ' ]">All</a>, <a href="[ ' none ' ]">None</a>, <a href="[ ' href: ' ]">[ ' _t: ResetButton ' ]</a><br>

[ == CreateButton == ]
<button type="submit" class="btn-ok">Create CSS</button>

[ == ResetButton == ]
<a href="[ ' href: ' ]" class="btn-link"><button type="button" class="btn-cancel">[ ' _t: ResetButton ' ]</button></a>

[ == table == ]
#|
*| # | Formatter | Language |* 
[= n _ =
|| [ ' num ' ] | ##[ ' lang ' ]## | [ ' name ' ] ||
[ ' commit | void' ]
=]
|#	

3. Supported Formats

4. Changelog

0.1 Initial version
0.2 Updated to work with R.6.0
0.3 Updated to work with R.6.1, PHP 8 (Match expression)
0.4 Added template and action to create custom CSS files