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

Source
/*
   +----------------------------------------------------------------------+
   | Zend Engine                                                          |
   +----------------------------------------------------------------------+
   | Copyright © Zend Technologies Ltd., a subsidiary company of          |
   |     Perforce Software, Inc., and Contributors.                       |
   +----------------------------------------------------------------------+
   | This source file is subject to the Modified BSD License that is      |
   | bundled with this package in the file LICENSE, and is available      |
   | through the World Wide Web at <https://www.php.net/license/>.        |
   |                                                                      |
   | SPDX-License-Identifier: BSD-3-Clause                                |
   +----------------------------------------------------------------------+
   | 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;
  const char *last_color = syntax_highlighter_ini->highlight_html;
  const 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-06-02 06:36

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