/src/php-src/Zend/zend_highlight.c

Source
/*
   +----------------------------------------------------------------------+
   | Zend Engine                                                          |
   +----------------------------------------------------------------------+
   | Copyright (c) Zend Technologies Ltd. (http://www.zend.com)           |
   +----------------------------------------------------------------------+
   | This source file is subject to version 2.00 of the Zend license,     |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | http://www.zend.com/license/2_00.txt.                                |
   | If you did not receive a copy of the Zend license and are unable to  |
   | obtain it through the world-wide-web, please send a note to          |
   | license@zend.com so we can mail you a copy immediately.              |
   +----------------------------------------------------------------------+
   | Authors: Andi Gutmans <andi@php.net>                                 |
   |          Zeev Suraski <zeev@php.net>                                 |
   +----------------------------------------------------------------------+
*/

#include "zend.h"
#include <zend_language_parser.h>
#include "zend_compile.h"
#include "zend_highlight.h"
#include "zend_ptr_stack.h"
#include "zend_globals.h"
#include "zend_exceptions.h"

ZEND_API void zend_html_putc(char c)
{
  switch (c) {
    case '<':
      ZEND_PUTS("&lt;");
      break;
    case '>':
      ZEND_PUTS("&gt;");
      break;
    case '&':
      ZEND_PUTS("&amp;");
      break;
    case '\t':
      ZEND_PUTS("    ");
      break;
    default:
      ZEND_PUTC(c);
      break;
  }
}


ZEND_API void zend_html_puts(const char *s, size_t len)
{
  const unsigned char *ptr = (const unsigned char*)s, *end = ptr + len;
  unsigned char *filtered = NULL;
  size_t filtered_len;

  if (LANG_SCNG(output_filter)) {
    LANG_SCNG(output_filter)(&filtered, &filtered_len, ptr, len);
    ptr = filtered;
    end = filtered + filtered_len;
  }

  while (ptr<end) {
    if (*ptr==' ') {
      do {
        zend_html_putc(*ptr);
      } while ((++ptr < end) && (*ptr==' '));
    } else {
      zend_html_putc(*ptr++);
    }
  }

  if (LANG_SCNG(output_filter)) {
    efree(filtered);
  }
}


ZEND_API void zend_highlight(zend_syntax_highlighter_ini *syntax_highlighter_ini)
{
  zval token;
  int token_type;
  char *last_color = syntax_highlighter_ini->highlight_html;
  char *next_color;

  zend_printf("<pre><code style=\"color: %s\">", last_color);
  /* highlight stuff coming back from zendlex() */
  while ((token_type=lex_scan(&token, NULL))) {
    switch (token_type) {
      case T_INLINE_HTML:
        next_color = syntax_highlighter_ini->highlight_html;
        break;
      case T_COMMENT:
      case T_DOC_COMMENT:
        next_color = syntax_highlighter_ini->highlight_comment;
        break;
      case T_OPEN_TAG:
      case T_OPEN_TAG_WITH_ECHO:
      case T_CLOSE_TAG:
      case T_LINE:
      case T_FILE:
      case T_DIR:
      case T_TRAIT_C:
      case T_METHOD_C:
      case T_FUNC_C:
      case T_PROPERTY_C:
      case T_NS_C:
      case T_CLASS_C:
        next_color = syntax_highlighter_ini->highlight_default;
        break;
      case '"':
      case T_ENCAPSED_AND_WHITESPACE:
      case T_CONSTANT_ENCAPSED_STRING:
        next_color = syntax_highlighter_ini->highlight_string;
        break;
      case T_WHITESPACE:
        zend_html_puts((char*)LANG_SCNG(yy_text), LANG_SCNG(yy_leng));  /* no color needed */
        ZVAL_UNDEF(&token);
        continue;
        break;
      default:
        if (Z_TYPE(token) == IS_UNDEF) {
          next_color = syntax_highlighter_ini->highlight_keyword;
        } else {
          next_color = syntax_highlighter_ini->highlight_default;
        }
        break;
    }

    if (last_color != next_color) {
      if (last_color != syntax_highlighter_ini->highlight_html) {
        zend_printf("</span>");
      }
      last_color = next_color;
      if (last_color != syntax_highlighter_ini->highlight_html) {
        zend_printf("<span style=\"color: %s\">", last_color);
      }
    }

    zend_html_puts((char*)LANG_SCNG(yy_text), LANG_SCNG(yy_leng));

    if (Z_TYPE(token) == IS_STRING) {
      switch (token_type) {
        case T_OPEN_TAG:
        case T_OPEN_TAG_WITH_ECHO:
        case T_CLOSE_TAG:
        case T_WHITESPACE:
        case T_COMMENT:
        case T_DOC_COMMENT:
          break;
        default:
          zval_ptr_dtor_str(&token);
          break;
      }
    }
    ZVAL_UNDEF(&token);
  }

  if (last_color != syntax_highlighter_ini->highlight_html) {
    zend_printf("</span>");
  }
  zend_printf("</code></pre>");

  /* Discard parse errors thrown during tokenization */
  zend_clear_exception();
}

ZEND_API void zend_strip(void)
{
  zval token;
  int token_type;
  int prev_space = 0;

  while ((token_type=lex_scan(&token, NULL))) {
    switch (token_type) {
      case T_WHITESPACE:
        if (!prev_space) {
          zend_write(" ", sizeof(" ") - 1);
          prev_space = 1;
        }
        ZEND_FALLTHROUGH;
      case T_COMMENT:
      case T_DOC_COMMENT:
        ZVAL_UNDEF(&token);
        continue;

      case T_END_HEREDOC:
        zend_write((char*)LANG_SCNG(yy_text), LANG_SCNG(yy_leng));
        /* read the following character, either newline or ; */
        if (lex_scan(&token, NULL) != T_WHITESPACE) {
          zend_write((char*)LANG_SCNG(yy_text), LANG_SCNG(yy_leng));
        }
        zend_write("\n", sizeof("\n") - 1);
        prev_space = 1;
        ZVAL_UNDEF(&token);
        continue;

      default:
        zend_write((char*)LANG_SCNG(yy_text), LANG_SCNG(yy_leng));
        break;
    }

    if (Z_TYPE(token) == IS_STRING) {
      switch (token_type) {
        case T_OPEN_TAG:
        case T_OPEN_TAG_WITH_ECHO:
        case T_CLOSE_TAG:
        case T_WHITESPACE:
        case T_COMMENT:
        case T_DOC_COMMENT:
          break;

        default:
          zval_ptr_dtor_str(&token);
          break;
      }
    }
    prev_space = 0;
    ZVAL_UNDEF(&token);
  }

  /* Discard parse errors thrown during tokenization */
  zend_clear_exception();
}

Coverage Report

Created: 2026-01-18 06:48

Line	Count	Source
1		/*
2		+----------------------------------------------------------------------+
3		\| Zend Engine \|
4		+----------------------------------------------------------------------+
5		\| Copyright (c) Zend Technologies Ltd. (http://www.zend.com) \|
6		+----------------------------------------------------------------------+
7		\| This source file is subject to version 2.00 of the Zend license, \|
8		\| that is bundled with this package in the file LICENSE, and is \|
9		\| available through the world-wide-web at the following url: \|
10		\| http://www.zend.com/license/2_00.txt. \|
11		\| If you did not receive a copy of the Zend license and are unable to \|
12		\| obtain it through the world-wide-web, please send a note to \|
13		\| license@zend.com so we can mail you a copy immediately. \|
14		+----------------------------------------------------------------------+
15		\| Authors: Andi Gutmans <andi@php.net> \|
16		\| Zeev Suraski <zeev@php.net> \|
17		+----------------------------------------------------------------------+
18		*/
19
20		#include "zend.h"
21		#include <zend_language_parser.h>
22		#include "zend_compile.h"
23		#include "zend_highlight.h"
24		#include "zend_ptr_stack.h"
25		#include "zend_globals.h"
26		#include "zend_exceptions.h"
27
28		ZEND_API void zend_html_putc(char c)
29	101k	{
30	101k	switch (c) {
31	3.85k	case '<':
32	3.85k	ZEND_PUTS("<");
33	3.85k	break;
34	657	case '>':
35	657	ZEND_PUTS(">");
36	657	break;
37	134	case '&':
38	134	ZEND_PUTS("&");
39	134	break;
40	479	case '\t':
41	479	ZEND_PUTS(" ");
42	479	break;
43	95.9k	default:
44	95.9k	ZEND_PUTC(c);
45	95.9k	break;
46	101k	}
47	101k	}
48
49
50		ZEND_API void zend_html_puts(const char *s, size_t len)
51	20.4k	{
52	20.4k	const unsigned char ptr = (const unsigned char)s, *end = ptr + len;
53	20.4k	unsigned char *filtered = NULL;
54	20.4k	size_t filtered_len;
55
56	20.4k	if (LANG_SCNG(output_filter)) {
57	0	LANG_SCNG(output_filter)(&filtered, &filtered_len, ptr, len);
58	0	ptr = filtered;
59	0	end = filtered + filtered_len;
60	0	}
61
62	120k	while (ptr<end) {
63	99.6k	if (*ptr==' ') {
64	6.06k	do {
65	6.06k	zend_html_putc(*ptr);
66	6.06k	} while ((++ptr < end) && (*ptr==' '));
67	95.0k	} else {
68	95.0k	zend_html_putc(*ptr++);
69	95.0k	}
70	99.6k	}
71
72	20.4k	if (LANG_SCNG(output_filter)) {
73	0	efree(filtered);
74	0	}
75	20.4k	}
76
77
78		ZEND_API void zend_highlight(zend_syntax_highlighter_ini *syntax_highlighter_ini)
79	32	{
80	32	zval token;
81	32	int token_type;
82	32	char *last_color = syntax_highlighter_ini->highlight_html;
83	32	char *next_color;
84
85	32	zend_printf("<pre><code style=\"color: %s\">", last_color);
86		/* highlight stuff coming back from zendlex() */
87	20.4k	while ((token_type=lex_scan(&token, NULL))) {
88	20.4k	switch (token_type) {
89	44	case T_INLINE_HTML:
90	44	next_color = syntax_highlighter_ini->highlight_html;
91	44	break;
92	352	case T_COMMENT:
93	352	case T_DOC_COMMENT:
94	352	next_color = syntax_highlighter_ini->highlight_comment;
95	352	break;
96	53	case T_OPEN_TAG:
97	53	case T_OPEN_TAG_WITH_ECHO:
98	74	case T_CLOSE_TAG:
99	86	case T_LINE:
100	86	case T_FILE:
101	86	case T_DIR:
102	86	case T_TRAIT_C:
103	89	case T_METHOD_C:
104	89	case T_FUNC_C:
105	89	case T_PROPERTY_C:
106	89	case T_NS_C:
107	89	case T_CLASS_C:
108	89	next_color = syntax_highlighter_ini->highlight_default;
109	89	break;
110	117	case '"':
111	847	case T_ENCAPSED_AND_WHITESPACE:
112	1.05k	case T_CONSTANT_ENCAPSED_STRING:
113	1.05k	next_color = syntax_highlighter_ini->highlight_string;
114	1.05k	break;
115	3.50k	case T_WHITESPACE:
116	3.50k	zend_html_puts((char)LANG_SCNG(yy_text), LANG_SCNG(yy_leng)); / no color needed */
117	3.50k	ZVAL_UNDEF(&token);
118	3.50k	continue;
119	0	break;
120	15.4k	default:
121	15.4k	if (Z_TYPE(token) == IS_UNDEF) {
122	10.7k	next_color = syntax_highlighter_ini->highlight_keyword;
123	10.7k	} else {
124	4.62k	next_color = syntax_highlighter_ini->highlight_default;
125	4.62k	}
126	15.4k	break;
127	20.4k	}
128
129	16.9k	if (last_color != next_color) {
130	9.48k	if (last_color != syntax_highlighter_ini->highlight_html) {
131	9.43k	zend_printf("</span>");
132	9.43k	}
133	9.48k	last_color = next_color;
134	9.48k	if (last_color != syntax_highlighter_ini->highlight_html) {
135	9.46k	zend_printf("<span style=\"color: %s\">", last_color);
136	9.46k	}
137	9.48k	}
138
139	16.9k	zend_html_puts((char*)LANG_SCNG(yy_text), LANG_SCNG(yy_leng));
140
141	16.9k	if (Z_TYPE(token) == IS_STRING) {
142	5.24k	switch (token_type) {
143	0	case T_OPEN_TAG:
144	0	case T_OPEN_TAG_WITH_ECHO:
145	0	case T_CLOSE_TAG:
146	0	case T_WHITESPACE:
147	0	case T_COMMENT:
148	0	case T_DOC_COMMENT:
149	0	break;
150	5.24k	default:
151	5.24k	zval_ptr_dtor_str(&token);
152	5.24k	break;
153	5.24k	}
154	5.24k	}
155	16.9k	ZVAL_UNDEF(&token);
156	16.9k	}
157
158	32	if (last_color != syntax_highlighter_ini->highlight_html) {
159	32	zend_printf("</span>");
160	32	}
161	32	zend_printf("</code></pre>");
162
163		/* Discard parse errors thrown during tokenization */
164	32	zend_clear_exception();
165	32	}
166
167		ZEND_API void zend_strip(void)
168	0	{
169	0	zval token;
170	0	int token_type;
171	0	int prev_space = 0;
172
173	0	while ((token_type=lex_scan(&token, NULL))) {
174	0	switch (token_type) {
175	0	case T_WHITESPACE:
176	0	if (!prev_space) {
177	0	zend_write(" ", sizeof(" ") - 1);
178	0	prev_space = 1;
179	0	}
180	0	ZEND_FALLTHROUGH;
181	0	case T_COMMENT:
182	0	case T_DOC_COMMENT:
183	0	ZVAL_UNDEF(&token);
184	0	continue;
185
186	0	case T_END_HEREDOC:
187	0	zend_write((char*)LANG_SCNG(yy_text), LANG_SCNG(yy_leng));
188		/* read the following character, either newline or ; */
189	0	if (lex_scan(&token, NULL) != T_WHITESPACE) {
190	0	zend_write((char*)LANG_SCNG(yy_text), LANG_SCNG(yy_leng));
191	0	}
192	0	zend_write("\n", sizeof("\n") - 1);
193	0	prev_space = 1;
194	0	ZVAL_UNDEF(&token);
195	0	continue;
196
197	0	default:
198	0	zend_write((char*)LANG_SCNG(yy_text), LANG_SCNG(yy_leng));
199	0	break;
200	0	}
201
202	0	if (Z_TYPE(token) == IS_STRING) {
203	0	switch (token_type) {
204	0	case T_OPEN_TAG:
205	0	case T_OPEN_TAG_WITH_ECHO:
206	0	case T_CLOSE_TAG:
207	0	case T_WHITESPACE:
208	0	case T_COMMENT:
209	0	case T_DOC_COMMENT:
210	0	break;
211
212	0	default:
213	0	zval_ptr_dtor_str(&token);
214	0	break;
215	0	}
216	0	}
217	0	prev_space = 0;
218	0	ZVAL_UNDEF(&token);
219	0	}
220
221		/* Discard parse errors thrown during tokenization */
222	0	zend_clear_exception();
223	0	}