dalu/crayon-syntax-highlighter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
crayon-syntax-highlighter/crayon_formatter.class.php

632 lines
27 KiB
PHP
Raw Permalink Normal View History

fork
2019-08-30 19:30:19 +02:00
<?php
require_once('global.php');
require_once(CRAYON_HIGHLIGHTER_PHP);
require_once(CRAYON_SETTINGS_PHP);
require_once(CRAYON_PARSER_PHP);
require_once(CRAYON_THEMES_PHP);
/* Manages formatting the html with html and css. */
class CrayonFormatter {
// Properties and Constants ===============================================
/* Used to temporarily store the array of CrayonElements passed to format_code(), so that
format_matches() can access them and identify which elements were captured and format
accordingly. This must be static for preg_replace_callback() to access it.*/
private static $elements = array();
// Delimiters
// Current crayon undergoing delimiter replace
private static $curr;
private static $delimiters;
private static $delim_regex;
private static $delim_pieces;
// Methods ================================================================
private function __construct() {
}
/* Formats the code using the parsed language elements. */
public static function format_code($code, $language, $hl = NULL) {
// Ensure the language is defined
if ($language != NULL && $hl->is_highlighted()) {
$code = self::clean_code($code, FALSE, FALSE, FALSE, TRUE);
/* Perform the replace on the code using the regex, pass the captured matches for
formatting before they are replaced */
try {
CrayonParser::parse($language->id());
// Match language regex
$elements = $language->elements();
$regex = $language->regex();
if (!empty($regex) && !empty($elements)) {
// Get array of CrayonElements
self::$elements = array_values($elements);
$code = preg_replace_callback($regex, 'CrayonFormatter::format_match', $code);
}
} catch (Exception $e) {
$error = 'An error occured when formatting: ' . $e->message();
$hl ? $hl->log($error) : CrayonLog::syslog($error);
}
return $code;
} else {
return self::clean_code($code, TRUE, TRUE, TRUE, TRUE);
}
}
/* Performs a replace to format each match based on the captured element. */
private static function format_match($matches) {
/* First index in $matches is full match, subsequent indices are groups.
* Minimum number of elements in array is 2, so minimum captured group is 0. */
$captured_group_number = count($matches) - 2;
$code = $matches[0];
if (array_key_exists($captured_group_number, self::$elements)) {
$captured_element = self::$elements[$captured_group_number];
// Avoid capturing and formatting internal Crayon elements
if ($captured_element->name() == CrayonParser::CRAYON_ELEMENT) {
return $code; // Return as is
} else {
// Separate lines and add css class, keep extended class last to allow overriding
$fallback_css = CrayonLangs::known_elements($captured_element->fallback());
$element_css = $captured_element->css();
$css = !empty($fallback_css) ? $fallback_css . ' ' . $element_css : $element_css;
return self::split_lines($code, $css);
}
} else {
// All else fails, return the match
return $matches[0];
}
}
/* Prints the formatted code, option to override the line numbers with a custom string */
public static function print_code($hl, $code, $line_numbers = TRUE, $print = TRUE) {
global $CRAYON_VERSION;
// We can print either block or inline, inline is treated differently, factor out common stuff here
$output = '';
// Used for style tag
$main_style = $code_style = $toolbar_style = $info_style = $font_style = $line_style = $pre_style = '';
// Unique ID for this instance of Crayon
$uid = 'crayon-' . $hl->id();
// Print theme id
// We make the assumption that the id is correct (checked in crayon_wp)
$theme_id = $hl->setting_val(CrayonSettings::THEME);
$theme_id_dashed = CrayonUtil::space_to_hyphen($theme_id);
if (!$hl->setting_val(CrayonSettings::ENQUEUE_THEMES)) {
$output .= CrayonResources::themes()->get_css($theme_id);
}
// Print font id
// We make the assumption that the id is correct (checked in crayon_wp)
$font_id = $hl->setting_val(CrayonSettings::FONT);
$font_id_dashed = CrayonUtil::space_to_hyphen($font_id);
if (!$hl->setting_val(CrayonSettings::ENQUEUE_FONTS)) {
$output .= CrayonResources::fonts()->get_css($font_id);
}
// Inline margin
if ($hl->is_inline()) {
$inline_margin = $hl->setting_val(CrayonSettings::INLINE_MARGIN) . 'px !important;';
}
// Determine font size
// TODO improve logic
if ($hl->setting_val(CrayonSettings::FONT_SIZE_ENABLE)) {
$_font_size = $hl->setting_val(CrayonSettings::FONT_SIZE);
$_font_size = $_font_size . 'px !important;';
$_line_height = $hl->setting_val(CrayonSettings::LINE_HEIGHT);
// Don't allow line height to be less than font size
$line_height = ($_line_height > $_font_size ? $_line_height : $_font_size) . 'px !important;';
upstream changes
2021-11-29 00:26:49 +01:00
$toolbar_height = floatval($_font_size) * 1.5 . 'px !important;';
$info_height = floatval($_font_size) * 1.4 . 'px !important;';
fork
2019-08-30 19:30:19 +02:00
$font_style .= "font-size: $_font_size line-height: $line_height";
$toolbar_style .= "font-size: $_font_size";
$line_style .= "height: $line_height";
if ($hl->is_inline()) {
$font_style .= "font-size: $_font_size";
} else {
$toolbar_style .= "height: $toolbar_height line-height: $toolbar_height";
$info_style .= "min-height: $info_height line-height: $info_height";
}
} else if (!$hl->is_inline()) {
if (($_font_size = CrayonGlobalSettings::get(CrayonSettings::FONT_SIZE)) !== FALSE) {
$_font_size = $_font_size->def() . 'px !important;';
$line_height = ($_font_size * 1.4) . 'px !important;';
}
}
$tab = $hl->setting_val(CrayonSettings::TAB_SIZE);
$pre_style = "-moz-tab-size:$tab; -o-tab-size:$tab; -webkit-tab-size:$tab; tab-size:$tab;";
// This will return from function with inline print
if ($hl->is_inline()) {
$wrap = !$hl->setting_val(CrayonSettings::INLINE_WRAP) ? 'crayon-syntax-inline-nowrap' : '';
$output .= '
<span id="' . $uid . '" class="crayon-syntax crayon-syntax-inline ' . $wrap . ' crayon-theme-' . $theme_id_dashed . ' crayon-theme-' . $theme_id_dashed . '-inline crayon-font-' . $font_id_dashed . '" style="' . $font_style . '">' .
'<span class="crayon-pre crayon-code" style="' . $font_style . ' ' . $pre_style . '">' . $code . '</span>' .
'</span>';
return $output;
}
// Below code only for block (default) printing
// Generate the code lines and separate each line as a div
$print_code = '';
$print_nums = '';
$hl->line_count(preg_match_all("#(?:^|(?<=\r\n|\n))[^\r\n]*#", $code, $code_lines));
// The line number to start from
$start_line = $hl->setting_val(CrayonSettings::START_LINE);
$marking = $hl->setting_val(CrayonSettings::MARKING);
$striped = $hl->setting_val(CrayonSettings::STRIPED);
$range = $hl->setting_val(CrayonSettings::RANGES) ? $hl->range() : FALSE;
for ($i = 1; $i <= $hl->line_count(); $i++) {
// Check if the current line is in the range of code to display
if ($range) {
if ($i < $range[0]) {
continue;
} else if ($i > $range[1]) {
break;
}
}
$code_line = $code_lines[0][$i - 1];
// If line is blank, add a space so the div has the correct height
if ($code_line == '') {
$code_line = '&nbsp;';
}
// Check if the current line has been selected
$marked_lines = $hl->marked();
// Check if lines need to be marked as important
if ($marking && in_array($i, $marked_lines)) {
$marked_num = ' crayon-marked-num';
$marked_line = ' crayon-marked-line';
// If multiple lines are marked, only show borders for top and bottom lines
if (!in_array($i - 1, $marked_lines)) {
$marked_num .= ' crayon-top';
$marked_line .= ' crayon-top';
}
// Single lines are both the top and bottom of the multiple marked lines
if (!in_array($i + 1, $marked_lines)) {
$marked_num .= ' crayon-bottom';
$marked_line .= ' crayon-bottom';
}
} else {
$marked_num = $marked_line = '';
}
// Stripe odd lines
if ($striped && $i % 2 == 0) {
$striped_num = ' crayon-striped-num';
$striped_line = ' crayon-striped-line';
} else {
$striped_num = $striped_line = '';
}
// Generate the lines
$line_num = $start_line + $i - 1;
$line_id = $uid . '-' . $line_num;
$print_code .= '<div class="crayon-line' . $marked_line . $striped_line . '" id="' . $line_id . '">' . $code_line . '</div>';
if (!is_string($line_numbers)) {
$print_nums .= '<div class="crayon-num' . $marked_num . $striped_num . '" data-line="' . $line_id . '">' . $line_num . '</div>';
}
}
// If $line_numbers is a string, display it
if (is_string($line_numbers) && !empty($line_numbers)) {
$print_nums .= '<div class="crayon-num">' . $line_numbers . '</div>';
} else if (empty($line_numbers)) {
$print_nums = FALSE;
}
// Determine whether to print title, encode characters
$title = $hl->title();
// Decode if needed
if ($hl->setting_val(CrayonSettings::DECODE_ATTRIBUTES)) {
$title = CrayonUtil::html_entity_decode($title);
}
$print_title = '<span class="crayon-title">' . $title . '</span>';
// Determine whether to print language
$print_lang = '';
// XXX Use for printing the regex
if ($hl->language()) {
$lang = $hl->language()->name();
switch ($hl->setting_index(CrayonSettings::SHOW_LANG)) {
case 0 :
if ($hl->language()->id() == CrayonLangs::DEFAULT_LANG) {
break;
}
// Falls through
case 1 :
$print_lang = '<span class="crayon-language">' . $lang . '</span>';
break;
}
}
// Disable functionality for errors
$error = $hl->error();
// Combined settings for code
$code_settings = '';
// Disable mouseover for touchscreen devices and mobiles, if we are told to
$touch = FALSE; // Whether we have detected a touchscreen device
if ($hl->setting_val(CrayonSettings::TOUCHSCREEN) && CrayonUtil::is_touch()) {
$touch = TRUE;
$code_settings .= ' touchscreen';
}
// Disabling Popup
if (!$hl->setting_val(CrayonSettings::POPUP)) {
$code_settings .= ' no-popup';
}
// Minimize
if (!$hl->setting_val(CrayonSettings::MINIMIZE)) {
$code_settings .= ' minimize';
}
// Draw the plain code and toolbar
$toolbar_settings = $print_plain_button = $print_copy_button = '';
$toolbar_index = $hl->setting_index(CrayonSettings::TOOLBAR);
if (empty($error) && ($toolbar_index != 2 || $hl->setting_val(CrayonSettings::MINIMIZE))) {
// Enable mouseover setting for toolbar
if ($toolbar_index == 0 && !$touch) {
// No touchscreen detected
$toolbar_settings .= ' mouseover';
if ($hl->setting_val(CrayonSettings::TOOLBAR_OVERLAY)) {
$toolbar_settings .= ' overlay';
}
if ($hl->setting_val(CrayonSettings::TOOLBAR_HIDE)) {
$toolbar_settings .= ' hide';
}
if ($hl->setting_val(CrayonSettings::TOOLBAR_DELAY)) {
$toolbar_settings .= ' delay';
}
} else if ($toolbar_index == 1) {
// Always display the toolbar
$toolbar_settings .= ' show';
} else if ($toolbar_index == 2) {
$toolbar_settings .= ' never-show';
}
$buttons = array();
if ($hl->setting_val(CrayonSettings::NUMS_TOGGLE)) {
$buttons['nums'] = crayon__('Toggle Line Numbers');
}
if ($hl->setting_val(CrayonSettings::PLAIN) && $hl->setting_val(CrayonSettings::PLAIN_TOGGLE)) {
$buttons['plain'] = crayon__('Toggle Plain Code');
}
if ($hl->setting_val(CrayonSettings::WRAP_TOGGLE)) {
$buttons['wrap'] = crayon__('Toggle Line Wrap');
}
if ($hl->setting_val(CrayonSettings::EXPAND_TOGGLE)) {
$buttons['expand'] = crayon__('Expand Code');
}
if (!$touch && $hl->setting_val(CrayonSettings::PLAIN) && $hl->setting_val(CrayonSettings::COPY)) {
$buttons['copy'] = crayon__('Copy');
}
if ($hl->setting_val(CrayonSettings::POPUP)) {
$buttons['popup'] = crayon__('Open Code In New Window');
}
$buttons_str = '';
foreach ($buttons as $button => $value) {
$buttons_str .= '<div class="crayon-button crayon-' . $button . '-button"';
if (!is_array($value)) {
$value = array('title' => $value);
}
foreach ($value as $k => $v) {
$buttons_str .= ' ' . $k . '="' . $v . '"';
}
$buttons_str .= '><div class="crayon-button-icon"></div></div>';
}
/* The table is rendered invisible by CSS and enabled with JS when asked to. If JS
is not enabled or fails, the toolbar won't work so there is no point to display it. */
$print_plus = $hl->is_mixed() && $hl->setting_val(CrayonSettings::SHOW_MIXED) ? '<span class="crayon-mixed-highlight" title="' . crayon__('Contains Mixed Languages') . '"></span>' : '';
$buttons = $print_plus . $buttons_str . $print_lang;
$toolbar = '
<div class="crayon-toolbar" data-settings="' . $toolbar_settings . '" style="' . $toolbar_style . '">' . $print_title . '
<div class="crayon-tools" style="' . $toolbar_style . '">' . $buttons . '</div></div>
<div class="crayon-info" style="' . $info_style . '"></div>';
} else {
$toolbar = $buttons = $plain_settings = '';
}
if (empty($error) && $hl->setting_val(CrayonSettings::PLAIN)) {
// Different events to display plain code
switch ($hl->setting_index(CrayonSettings::SHOW_PLAIN)) {
case 0 :
$plain_settings = 'dblclick';
break;
case 1 :
$plain_settings = 'click';
break;
case 2 :
$plain_settings = 'mouseover';
break;
default :
$plain_settings = '';
}
if ($hl->setting_val(CrayonSettings::SHOW_PLAIN_DEFAULT)) {
$plain_settings .= ' show-plain-default';
}
$readonly = $touch ? '' : 'readonly';
$print_plain = $print_plain_button = '';
$textwrap = !$hl->setting_val(CrayonSettings::WRAP) ? 'wrap="soft"' : '';
$print_plain = '<textarea ' . $textwrap . ' class="crayon-plain print-no" data-settings="' . $plain_settings . '" ' . $readonly . ' style="' . $pre_style . ' ' . $font_style . '">' . "\n" . self::clean_code($hl->code()) . '</textarea>';
} else {
$print_plain = $plain_settings = $plain_settings = '';
}
// Line numbers visibility
$num_vis = $num_settings = '';
if ($line_numbers === FALSE) {
$num_vis = 'crayon-invisible';
} else {
$num_settings = ($hl->setting_val(CrayonSettings::NUMS) ? 'show' : 'hide');
}
// Determine scrollbar visibility
$code_settings .= $hl->setting_val(CrayonSettings::SCROLL) && !$touch ? ' scroll-always' : ' scroll-mouseover';
// Disable animations
if ($hl->setting_val(CrayonSettings::DISABLE_ANIM)) {
$code_settings .= ' disable-anim';
}
// Wrap
if ($hl->setting_val(CrayonSettings::WRAP)) {
$code_settings .= ' wrap';
}
// Expand
if ($hl->setting_val(CrayonSettings::EXPAND)) {
$code_settings .= ' expand';
}
// Determine dimensions
if ($hl->setting_val(CrayonSettings::HEIGHT_SET)) {
$height_style = self::dimension_style($hl, CrayonSettings::HEIGHT);
// XXX Only set height for main, not code (if toolbar always visible, code will cover main)
if ($hl->setting_index(CrayonSettings::HEIGHT_UNIT) == 0) {
$main_style .= $height_style;
}
}
if ($hl->setting_val(CrayonSettings::WIDTH_SET)) {
$width_style = self::dimension_style($hl, CrayonSettings::WIDTH);
$code_style .= $width_style;
if ($hl->setting_index(CrayonSettings::WIDTH_UNIT) == 0) {
$main_style .= $width_style;
}
}
// Determine margins
if ($hl->setting_val(CrayonSettings::TOP_SET)) {
$code_style .= ' margin-top: ' . $hl->setting_val(CrayonSettings::TOP_MARGIN) . 'px;';
}
if ($hl->setting_val(CrayonSettings::BOTTOM_SET)) {
$code_style .= ' margin-bottom: ' . $hl->setting_val(CrayonSettings::BOTTOM_MARGIN) . 'px;';
}
if ($hl->setting_val(CrayonSettings::LEFT_SET)) {
$code_style .= ' margin-left: ' . $hl->setting_val(CrayonSettings::LEFT_MARGIN) . 'px;';
}
if ($hl->setting_val(CrayonSettings::RIGHT_SET)) {
$code_style .= ' margin-right: ' . $hl->setting_val(CrayonSettings::RIGHT_MARGIN) . 'px;';
}
// Determine horizontal alignment
$align_style = '';
switch ($hl->setting_index(CrayonSettings::H_ALIGN)) {
case 1 :
$align_style = ' float: left;';
break;
case 2 :
$align_style = ' float: none; margin-left: auto; margin-right: auto;';
break;
case 3 :
$align_style = ' float: right;';
break;
}
$code_style .= $align_style;
// Determine allowed float elements
if ($hl->setting_val(CrayonSettings::FLOAT_ENABLE)) {
$clear_style = ' clear: none;';
} else {
$clear_style = '';
}
$code_style .= $clear_style;
// Determine if operating system is mac
$crayon_os = CrayonUtil::is_mac() ? 'mac' : 'pc';
// Produce output
$output .= '
<div id="' . $uid . '" class="crayon-syntax crayon-theme-' . $theme_id_dashed . ' crayon-font-' . $font_id_dashed . ' crayon-os-' . $crayon_os . ' print-yes notranslate" data-settings="' . $code_settings . '" style="' . $code_style . ' ' . $font_style . '">
' . $toolbar . '
<div class="crayon-plain-wrap">' . $print_plain . '</div>' . '
<div class="crayon-main" style="' . $main_style . '">
<table class="crayon-table">
<tr class="crayon-row">';
if ($print_nums !== FALSE) {
$output .= '
<td class="crayon-nums ' . $num_vis . '" data-settings="' . $num_settings . '">
<div class="crayon-nums-content" style="' . $font_style . '">' . $print_nums . '</div>
</td>';
}
// XXX
$output .= '
<td class="crayon-code"><div class="crayon-pre" style="' . $font_style . ' ' . $pre_style . '">' . $print_code . '</div></td>
</tr>
</table>
</div>
</div>';
// Debugging stats
$runtime = $hl->runtime();
if (!$hl->setting_val(CrayonSettings::DISABLE_RUNTIME) && is_array($runtime) && !empty($runtime)) {
$output = '<!-- Crayon Syntax Highlighter v' . $CRAYON_VERSION . ' -->'
. CRAYON_NL . $output . CRAYON_NL . '<!-- ';
foreach ($hl->runtime() as $type => $time) {
$output .= '[' . $type . ': ' . sprintf('%.4f seconds', $time) . '] ';
}
$output .= '-->' . CRAYON_NL;
}
// Determine whether to print to screen or save
if ($print) {
echo $output;
} else {
return $output;
}
}
public static function print_error($hl, $error, $line_numbers = 'ERROR', $print = TRUE) {
if (get_class($hl) != CRAYON_HIGHLIGHTER) {
return;
}
// Either print the error returned by the handler, or a custom error message
if ($hl->setting_val(CrayonSettings::ERROR_MSG_SHOW)) {
$error = $hl->setting_val(CrayonSettings::ERROR_MSG);
}
$error = self::split_lines(trim($error), 'crayon-error');
return self::print_code($hl, $error, $line_numbers, $print);
}
// Delimiters =============================================================
public static function format_mixed_code($code, $language, $hl) {
self::$curr = $hl;
self::$delim_pieces = array();
// Remove crayon internal element from INPUT code
$code = preg_replace('#' . CrayonParser::CRAYON_ELEMENT_REGEX_CAPTURE . '#msi', '', $code);
if (self::$delimiters == NULL) {
self::$delimiters = CrayonResources::langs()->delimiters();
}
// Find all delimiters in all languages
if (self::$delim_regex == NULL) {
self::$delim_regex = '#(' . implode(')|(', array_values(self::$delimiters)) . ')#msi';
}
// Extract delimited code, replace with internal elements
$internal_code = preg_replace_callback(self::$delim_regex, 'CrayonFormatter::delim_to_internal', $code);
// Format with given language
$formatted_code = CrayonFormatter::format_code($internal_code, $language, $hl);
// Replace internal elements with delimited pieces
$formatted_code = preg_replace_callback('#\{\{crayon-internal:(\d+)\}\}#', 'CrayonFormatter::internal_to_code', $formatted_code);
return $formatted_code;
}
public static function delim_to_internal($matches) {
// Mark as mixed so we can show (+)
self::$curr->is_mixed(TRUE);
$capture_group = count($matches) - 2;
$capture_groups = array_keys(self::$delimiters);
$lang_id = $capture_groups[$capture_group];
if (($lang = CrayonResources::langs()->get($lang_id)) === NULL) {
return $matches[0];
}
$internal = sprintf('{{crayon-internal:%d}}', count(self::$delim_pieces));
// TODO fix
self::$delim_pieces[] = CrayonFormatter::format_code($matches[0], $lang, self::$curr);
return $internal;
}
public static function internal_to_code($matches) {
return self::$delim_pieces[intval($matches[1])];
}
// Auxiliary Methods ======================================================
/* Prepares code for formatting. */
public static function clean_code($code, $escape = TRUE, $spaces = FALSE, $tabs = FALSE, $lines = FALSE) {
if (empty($code)) {
return $code;
}
/* Convert <, > and & characters to entities, as these can appear as HTML tags and entities. */
if ($escape) {
$code = CrayonUtil::htmlspecialchars($code);
}
if ($spaces) {
// Replace 2 spaces with html escaped characters
$code = preg_replace('#[ ]{2}#msi', '&nbsp;&nbsp;', $code);
}
if ($tabs && CrayonGlobalSettings::val(CrayonSettings::TAB_CONVERT)) {
// Replace tabs with 4 spaces
$code = preg_replace('#\t#', str_repeat('&nbsp;', CrayonGlobalSettings::val(CrayonSettings::TAB_SIZE)), $code);
}
if ($lines) {
$code = preg_replace('#(\r\n)|\r|\n#msi', "\r\n", $code);
}
return $code;
}
/* Converts the code to entities and wraps in a <pre><code></code></pre> */
public static function plain_code($code, $encoded = TRUE) {
if (is_array($code)) {
// When used as a preg_replace_callback
$code = $code[1];
}
if (!$encoded) {
$code = CrayonUtil::htmlentities($code);
}
if (CrayonGlobalSettings::val(CrayonSettings::TRIM_WHITESPACE)) {
$code = trim($code);
}
return '<pre class="crayon-plain-tag">' . $code . '</pre>';
}
public static function split_lines($code, $class) {
$code = self::clean_code($code, TRUE, TRUE, TRUE, FALSE);
$class = preg_replace('#(\w+)#m', 'crayon-$1', $class);
$code = preg_replace('#^([^\r\n]+)(?=\r\n|\r|\n|$)#m', '<span class="' . $class . '">$1</span>', $code);
return $code;
}
private static function dimension_style($hl, $name) {
$mode = $unit = '';
switch ($name) {
case CrayonSettings::HEIGHT :
$mode = CrayonSettings::HEIGHT_MODE;
$unit = CrayonSettings::HEIGHT_UNIT;
break;
case CrayonSettings::WIDTH :
$mode = CrayonSettings::WIDTH_MODE;
$unit = CrayonSettings::WIDTH_UNIT;
break;
}
// XXX Uses actual index value to identify options
$mode = $hl->setting_index($mode);
$unit = $hl->setting_index($unit);
$dim_mode = $dim_unit = '';
if ($mode !== FALSE) {
switch ($mode) {
case 0 :
$dim_mode .= 'max-';
break;
case 1 :
$dim_mode .= 'min-';
break;
}
}
$dim_mode .= $name;
if ($unit !== FALSE) {
switch ($unit) {
case 0 :
$dim_unit = 'px';
break;
case 1 :
$dim_unit = '%';
break;
}
}
return ' ' . $dim_mode . ': ' . $hl->setting_val($name) . $dim_unit . ';';
}
}
Reference in New Issue Copy Permalink