patch [#33609] Syntax highlighting for OSL in Text Editor

from Patrick Boelens (senshi). with modifications to split it into its own function.

also added C style multi-line comment support /* ... */

I've left out the part of this patch that sets the language in the space, since I think this might be better stored in the text block.

For now it simply uses OSL syntax highlighting when the extension is '.osl'.

1 files changed, 331 insertions, 0 deletions

diff --git a/source/blender/editors/space_text/text_format_osl.c b/source/blender/editors/space_text/text_format_osl.c
new file mode 100644
index 00000000000..2d536ca1109
--- /dev/null
+++ b/source/blender/editors/space_text/text_format_osl.c
@@ -0,0 +1,331 @@
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
+ * All rights reserved.
+ *
+ * The Original Code is: all of this file.
+ *
+ * Contributor(s): none yet.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/editors/space_text/text_format_py.c
+ *  \ingroup sptext
+ */
+
+#include <string.h>
+
+#include "BLI_blenlib.h"
+
+#include "DNA_text_types.h"
+#include "DNA_space_types.h"
+
+#include "BKE_text.h"
+
+#include "text_format.h"
+
+/* *** Local Functions (for format_line) *** */
+
+static int txtfmt_osl_find_builtinfunc(const char *string)
+{
+	int i, len;
+	/* list is from...
+	 * XXX - link to docs!
+	 */
+	if      (STR_LITERAL_STARTSWITH(string, "break",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "closure",      len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "color",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "continue",     len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "do",           len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "else",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "emit",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "float",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "for",          len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "if",           len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "illuminance",  len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "illuminate",   len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "int",          len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "matrix",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "normal",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "output",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "point",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "public",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "return",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "string",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "struct",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "vector",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "void",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "while",        len)) i = len;
+	else                                                          i = 0;
+
+	/* If next source char is an identifier (eg. 'i' in "definate") no match */
+	if (i == 0 || text_check_identifier(string[i]))
+		return -1;
+	return i;
+}
+
+static int txtfmt_osl_find_reserved(const char *string)
+{
+	int i, len;
+	/* list is from...
+	 * XXX - link to docs!
+	 */
+	if      (STR_LITERAL_STARTSWITH(string, "bool",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "case",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "catch",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "char",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "const",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "delete",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "default",      len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "double",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "enum",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "extern",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "false",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "friend",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "goto",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "inline",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "long",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "new",          len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "operator",     len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "private",      len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "protected",    len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "short",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "signed",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "sizeof",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "static",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "switch",       len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "template",     len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "this",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "throw",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "true",         len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "try",          len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "typedef",      len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "uniform",      len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "union",        len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "unsigned",     len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "varying",      len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "virtual",      len)) i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "volatile",     len)) i = len;
+
+	/* If next source char is an identifier (eg. 'i' in "definate") no match */
+	if (i == 0 || text_check_identifier(string[i]))
+		return -1;
+	return i;
+}
+
+/* Checks the specified source string for a Python special name. This name must
+ * start at the beginning of the source string and must be followed by a non-
+ * identifier (see text_check_identifier(char)) or null character.
+ *
+ * If a special name is found, the length of the matching name is returned.
+ * Otherwise, -1 is returned. */
+
+static int txtfmt_osl_find_specialvar(const char *string)
+{
+	int i, len;
+
+	if      (STR_LITERAL_STARTSWITH(string, "shader", len)) i = len;
+	else                                                    i = 0;
+
+	/* If next source char is an identifier (eg. 'i' in "definate") no match */
+	if (i == 0 || text_check_identifier(string[i]))
+		return -1;
+	return i;
+}
+
+/* matches py 'txtfmt_osl_find_decorator' */
+static int txtfmt_osl_find_preprocessor(const char *string)
+{
+	if (string[0] == '#') {
+		int i = 1;
+		/* whitespace is ok '#  foo' */
+		while (string[i] == '\t' || string[i] == ' ') {
+			i++;
+		}
+		while (text_check_identifier(string[i])) {
+			i++;
+		}
+		return i;
+	}
+	return -1;
+}
+
+/* not in OSL, keep for now though */
+#if 0
+static int txtfmt_osl_find_bool(const char *string)
+{
+	int i, len;
+
+	if      (STR_LITERAL_STARTSWITH(string, "None",  len))  i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "True",  len))  i = len;
+	else if (STR_LITERAL_STARTSWITH(string, "False", len))  i = len;
+	else                                                    i = 0;
+
+	/* If next source char is an identifier (eg. 'i' in "Nonetheless") no match */
+	if (i == 0 || text_check_identifier(string[i]))
+		return -1;
+	return i;
+}
+#endif
+
+static void txtfmt_osl_format_line(SpaceText *st, TextLine *line, const int do_next)
+{
+	FlattenString fs;
+	const char *str;
+	char *fmt;
+	char orig, cont, find, prev = ' ';
+	int len, i;
+
+	/* Get continuation from previous line */
+	if (line->prev && line->prev->format != NULL) {
+		fmt = line->prev->format;
+		cont = fmt[strlen(fmt) + 1]; /* Just after the null-terminator */
+	}
+	else {
+		cont = 0;
+	}
+
+	/* Get original continuation from this line */
+	if (line->format != NULL) {
+		fmt = line->format;
+		orig = fmt[strlen(fmt) + 1]; /* Just after the null-terminator */
+	}
+	else {
+		orig = 0xFF;
+	}
+
+	len = flatten_string(st, &fs, line->line);
+	str = fs.buf;
+	if (!text_check_format_len(line, len)) {
+		flatten_string_free(&fs);
+		return;
+	}
+	fmt = line->format;
+
+	while (*str) {
+		/* Handle escape sequences by skipping both \ and next char */
+		if (*str == '\\') {
+			*fmt = prev; fmt++; str++;
+			if (*str == '\0') break;
+			*fmt = prev; fmt++; str += BLI_str_utf8_size_safe(str);
+			continue;
+		}
+		/* Handle continuations */
+		else if (cont) {
+			/* C-Style comments */
+			if (cont & TXT_CONT_COMMENT_CXX) {
+				*fmt = '#';
+			}
+			else if (cont & TXT_CONT_COMMENT_C) {
+				if (*str == '*' && *(str + 1) == '/') {
+					*fmt = '#'; fmt++; str++;
+					*fmt = '#';
+					cont = 0;
+				}
+				else {
+					*fmt = '#';
+				}
+				/* Handle other comments */
+			}
+			else {
+				find = (cont & TXT_DBLQUOTSTR) ? '"' : '\'';
+				if (*str == find) cont = 0;
+				*fmt = 'l';
+			}
+
+			str += BLI_str_utf8_size_safe(str) - 1;
+		}
+		/* Not in a string... */
+		else {
+			/* Deal with comments first */
+			if (*str == '/' && *(str + 1) == '/') {
+				cont = TXT_CONT_COMMENT_CXX;
+				*fmt = '#';
+			}
+			/* C-Style (multi-line) comments */
+			else if (*str == '/' && *(str + 1) == '*') {
+				cont = TXT_CONT_COMMENT_C;
+				*fmt = '#'; fmt++; str++;
+				*fmt = '#';
+			}
+			else if (*str == '"' || *str == '\'') {
+				/* Strings */
+				find = *str;
+				cont = (*str == '"') ? TXT_DBLQUOTSTR : TXT_SNGQUOTSTR;
+				*fmt = 'l';
+			}
+			/* Whitespace (all ws. has been converted to spaces) */
+			else if (*str == ' ') {
+				*fmt = '_';
+			}
+			/* Numbers (digits not part of an identifier and periods followed by digits) */
+			else if ((prev != 'q' && text_check_digit(*str)) || (*str == '.' && text_check_digit(*(str + 1)))) {
+				*fmt = 'n';
+			}
+			/* Punctuation */
+			else if ((*str != '#') && text_check_delim(*str)) {
+				*fmt = '!';
+			}
+			/* Identifiers and other text (no previous ws. or delims. so text continues) */
+			else if (prev == 'q') {
+				str += BLI_str_utf8_size_safe(str) - 1;
+				*fmt = 'q';
+			}
+			/* Not ws, a digit, punct, or continuing text. Must be new, check for special words */
+			else {
+				/* Special vars(v) or built-in keywords(b) */
+				if      ((i = txtfmt_osl_find_specialvar(str))   != -1) prev = 'v';
+				else if ((i = txtfmt_osl_find_builtinfunc(str))  != -1) prev = 'b';
+				else if ((i = txtfmt_osl_find_reserved(str))     != -1) prev = 'r';
+				else if ((i = txtfmt_osl_find_preprocessor(str)) != -1) prev = 'd';
+
+				if (i > 0) {
+					memset(fmt, prev, i);
+					i--; fmt += i; str += i;
+				}
+				else {
+					str += BLI_str_utf8_size_safe(str) - 1;
+					*fmt = 'q';
+				}
+			}
+		}
+		prev = *fmt; fmt++; str++;
+	}
+
+	/* Terminate and add continuation char */
+	*fmt = '\0'; fmt++;
+	*fmt = cont;
+
+	/* If continuation has changed and we're allowed, process the next line */
+	if (cont != orig && do_next && line->next) {
+		txtfmt_osl_format_line(st, line->next, do_next);
+	}
+
+	flatten_string_free(&fs);
+}
+
+void ED_text_format_register_osl(void)
+{
+	static TextFormatType tft = {0};
+	static const char *ext[] = {"osl", NULL};
+
+	tft.format_line = txtfmt_osl_format_line;
+	tft.ext = ext;
+
+	ED_text_format_register(&tft);
+}