unicode-conversion.php in Typogrify 6

File

unicode-conversion.php

<?php

/**
 * Return the unicode conversion maps.
 *
 * @param string $type
 *    The map type we're looking for, one of 'ligature', 'punctuation', 
 *    'arrow' 'nested' or 'all'.
 * @return array
 *    Array of conversions, keyed by the original string.
 */
function unicode_conversion_map($type = 'all') {
  $map = array(
    // See http://www.unicode.org/charts/PDF/UFB00.pdf
    'ligature' => array(
      'ffi' => '&#xfb03;',
      'ffl' => '&#xfb04;',
      'ff' => '&#xfb00;',
      'fi' => '&#xfb01;',
      'fl' => '&#xfb02;',
      'ij' => '&#x0133;',
      'IJ' => '&#x0132;',
      'st' => '&#xfb06;',
      'ss' => '&szlig;',
    ),
    // See http:#www.unicode.org/charts/PDF/U2000.pdf
    'punctuation' => array(
      '...' => '&#x2026;',
      '..' => '&#x2025;',
      '. . .' => '&#x2026;',
      '---' => '&mdash;',
      '--' => '&ndash;',
    ),
    // See http:#www.unicode.org/charts/PDF/U2190.pdf
    'arrow' => array(
      '->>' => '&#x21a0;',
      '<<-' => '&#x219e;',
      '->|' => '&#x21e5;',
      '|<-' => '&#x21e4;',
      '<->' => '&#x2194;',
      '->' => '&#x2192;',
      '<-' => '&#x2190;',
      '<=>' => '&#x21d4;',
      '=>' => '&#x21d2;',
      '<=' => '&#x21d0;',
    ),
  );
  if ($type == 'all') {
    return array_merge($map['ligature'], $map['arrow'], $map['punctuation']);
  }
  elseif ($type == 'nested') {
    return $map;
  }
  else {
    return $map[$type];
  }
}

/**
 * Perform character conversion.
 *
 * @param string $test
 *    Text to be parsed.
 * @param array $characters_to_convert
 *    Array of ASCII characters to convert.
 * @return string
 *    The result of the conversion.
 */
function convert_characters($text, $characters_to_convert) {
  if ($characters_to_convert == NULL || count($characters_to_convert) < 1) {

    // do nothing
    return $text;
  }

  // get ascii to unicode mappings
  $unicode_map = unicode_conversion_map();
  foreach ($characters_to_convert as $ascii_string) {
    $unicode_strings[] = $unicode_map[$ascii_string];
  }
  $tokens = _TokenizeHTML($text);
  $result = '';
  $in_pre = 0;

  // Keep track of when we're inside <pre> or <code> tags
  foreach ($tokens as $cur_token) {
    if ($cur_token[0] == "tag") {

      // Don't mess with text inside tags, <pre> blocks, or <code> blocks
      $result .= $cur_token[1];

      // Get the tags to skip regex from SmartyPants
      if (preg_match(SMARTYPANTS_TAGS_TO_SKIP, $cur_token[1], $matches)) {
        $in_pre = isset($matches[1]) && $matches[1] == '/' ? 0 : 1;
      }
    }
    else {
      $t = $cur_token[1];
      if ($in_pre == 0) {
        $t = ProcessEscapes($t);
        $t = str_replace($characters_to_convert, $unicode_strings, $t);
      }
      $result .= $t;
    }
  }
  return $result;
}

// _TokenizeHTML is shared between PHP SmartyPants and PHP Markdown.
// We're borrowing it for Typogrify.module, too
// We only define it if it is not already defined.
if (!function_exists('_TokenizeHTML')) {
  function _TokenizeHTML($str) {

    //
    //   Parameter:  String containing HTML markup.
    //  Returns:    An array of the tokens comprising the input
    //              string. Each token is either a tag (possibly with nested,
    //              tags contained therein, such as <a href="<MTFoo>">, or a
    //              run of text between tags. Each element of the array is a
    //              two-element array; the first is either 'tag' or 'text';
    //              the second is the actual value.
    //
    //
    //  Regular expression derived from the _tokenize() subroutine in
    //  Brad Choate's MTRegex plugin.
    //  <http://www.bradchoate.com/past/mtregex.php>
    //
    $index = 0;
    $tokens = array();
    $match = '(?s:<!(?:--.*?--\\s*)+>)|' . '(?s:<\\?.*?\\?>)|' . '(?:<[/!$]?[-a-zA-Z0-9:]+\\b(?>[^"\'>]+|"[^"]*"|\'[^\']*\')*>)';
    $parts = preg_split("{({$match})}", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
    foreach ($parts as $part) {
      if (++$index % 2 && $part != '') {
        $tokens[] = array(
          'text',
          $part,
        );
      }
      else {
        $tokens[] = array(
          'tag',
          $part,
        );
      }
    }
    return $tokens;
  }
}

Functions

Name	Description
convert_characters	Perform character conversion.
unicode_conversion_map	Return the unicode conversion maps.