396 lines
10 KiB
C++
396 lines
10 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup sptext
|
|
*
|
|
* Note that this formatter shares core logic with `text_format_glsl.cc`,
|
|
* improvements here may apply there too.
|
|
*/
|
|
|
|
#include <cstring>
|
|
|
|
#include "BLI_blenlib.h"
|
|
|
|
#include "DNA_space_types.h"
|
|
#include "DNA_text_types.h"
|
|
|
|
#include "BKE_text.h"
|
|
|
|
#include "text_format.hh"
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Local Literal Definitions
|
|
* \{ */
|
|
|
|
/**
|
|
* OSL builtin function.
|
|
* list is from
|
|
* https://github.com/imageworks/OpenShadingLanguage/raw/master/src/doc/osl-languagespec.pdf
|
|
*/
|
|
static const char *text_format_osl_literals_builtinfunc_data[] = {
|
|
/* Force single column, sorted list. */
|
|
/* clang-format off */
|
|
"break",
|
|
"closure",
|
|
"color",
|
|
"continue",
|
|
"do",
|
|
"else",
|
|
"emit",
|
|
"float",
|
|
"for",
|
|
"if",
|
|
"illuminance",
|
|
"illuminate",
|
|
"int",
|
|
"matrix",
|
|
"normal",
|
|
"output",
|
|
"point",
|
|
"public",
|
|
"return",
|
|
"string",
|
|
"struct",
|
|
"vector",
|
|
"void",
|
|
"while",
|
|
/* clang-format on */
|
|
};
|
|
static const Span<const char *> text_format_osl_literals_builtinfunc(
|
|
text_format_osl_literals_builtinfunc_data,
|
|
ARRAY_SIZE(text_format_osl_literals_builtinfunc_data));
|
|
|
|
/**
|
|
* OSL reserved keywords
|
|
* See:
|
|
* https://github.com/imageworks/OpenShadingLanguage/raw/master/src/doc/osl-languagespec.pdf
|
|
*/
|
|
static const char *text_format_osl_literals_reserved_data[] = {
|
|
/* Force single column, sorted list. */
|
|
/* clang-format off */
|
|
"bool",
|
|
"case",
|
|
"catch",
|
|
"char",
|
|
"const",
|
|
"default",
|
|
"delete",
|
|
"double",
|
|
"enum",
|
|
"extern",
|
|
"false",
|
|
"friend",
|
|
"goto",
|
|
"inline",
|
|
"long",
|
|
"new",
|
|
"operator",
|
|
"private",
|
|
"protected",
|
|
"short",
|
|
"signed",
|
|
"sizeof",
|
|
"static",
|
|
"switch",
|
|
"template",
|
|
"this",
|
|
"throw",
|
|
"true",
|
|
"try",
|
|
"typedef",
|
|
"uniform",
|
|
"union",
|
|
"unsigned",
|
|
"varying",
|
|
"virtual",
|
|
"volatile",
|
|
/* clang-format on */
|
|
};
|
|
static const Span<const char *> text_format_osl_literals_reserved(
|
|
text_format_osl_literals_reserved_data, ARRAY_SIZE(text_format_osl_literals_reserved_data));
|
|
|
|
/* OSL shader types */
|
|
static const char *text_format_osl_literals_specialvar_data[] = {
|
|
/* Force single column, sorted list. */
|
|
/* clang-format off */
|
|
"displacement",
|
|
"shader",
|
|
"surface",
|
|
"volume",
|
|
/* clang-format on */
|
|
};
|
|
static const Span<const char *> text_format_osl_literals_specialvar(
|
|
text_format_osl_literals_specialvar_data,
|
|
ARRAY_SIZE(text_format_osl_literals_specialvar_data));
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Local Functions (for #TextFormatType::format_line)
|
|
* \{ */
|
|
|
|
static int txtfmt_osl_find_builtinfunc(const char *string)
|
|
{
|
|
const int i = text_format_string_literal_find(text_format_osl_literals_builtinfunc, string);
|
|
|
|
/* If next source char is an identifier (eg. 'i' in "definite") no match */
|
|
if (i == 0 || text_check_identifier(string[i])) {
|
|
return -1;
|
|
}
|
|
return i;
|
|
}
|
|
|
|
static int txtfmt_osl_find_reserved(const char *string)
|
|
{
|
|
const int i = text_format_string_literal_find(text_format_osl_literals_reserved, string);
|
|
|
|
/* If next source char is an identifier (eg. 'i' in "definite") no match */
|
|
if (i == 0 || text_check_identifier(string[i])) {
|
|
return -1;
|
|
}
|
|
return i;
|
|
}
|
|
|
|
static int txtfmt_osl_find_specialvar(const char *string)
|
|
{
|
|
const int i = text_format_string_literal_find(text_format_osl_literals_specialvar, string);
|
|
|
|
/* If next source char is an identifier (eg. 'i' in "definite") 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;
|
|
/* White-space is ok '# foo'. */
|
|
while (text_check_whitespace(string[i])) {
|
|
i++;
|
|
}
|
|
while (text_check_identifier(string[i])) {
|
|
i++;
|
|
}
|
|
return i;
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
static char txtfmt_osl_format_identifier(const char *str)
|
|
{
|
|
char fmt;
|
|
|
|
/* Keep aligned args for readability. */
|
|
/* clang-format off */
|
|
|
|
if (txtfmt_osl_find_specialvar(str) != -1) { fmt = FMT_TYPE_SPECIAL;
|
|
} else if (txtfmt_osl_find_builtinfunc(str) != -1) { fmt = FMT_TYPE_KEYWORD;
|
|
} else if (txtfmt_osl_find_reserved(str) != -1) { fmt = FMT_TYPE_RESERVED;
|
|
} else if (txtfmt_osl_find_preprocessor(str) != -1) { fmt = FMT_TYPE_DIRECTIVE;
|
|
} else { fmt = FMT_TYPE_DEFAULT;
|
|
}
|
|
|
|
/* clang-format on */
|
|
|
|
return fmt;
|
|
}
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Format Line Implementation (#TextFormatType::format_line)
|
|
* \{ */
|
|
|
|
static void txtfmt_osl_format_line(SpaceText *st, TextLine *line, const bool do_next)
|
|
{
|
|
FlattenString fs;
|
|
const char *str;
|
|
char *fmt;
|
|
char cont_orig, cont, find, prev = ' ';
|
|
int len, i;
|
|
|
|
/* Get continuation from previous line */
|
|
if (line->prev && line->prev->format != nullptr) {
|
|
fmt = line->prev->format;
|
|
cont = fmt[strlen(fmt) + 1]; /* Just after the null-terminator */
|
|
BLI_assert((FMT_CONT_ALL & cont) == cont);
|
|
}
|
|
else {
|
|
cont = FMT_CONT_NOP;
|
|
}
|
|
|
|
/* Get original continuation from this line */
|
|
if (line->format != nullptr) {
|
|
fmt = line->format;
|
|
cont_orig = fmt[strlen(fmt) + 1]; /* Just after the null-terminator */
|
|
BLI_assert((FMT_CONT_ALL & cont_orig) == cont_orig);
|
|
}
|
|
else {
|
|
cont_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 */
|
|
if (cont) {
|
|
/* C-Style comments */
|
|
if (cont & FMT_CONT_COMMENT_C) {
|
|
if (*str == '*' && *(str + 1) == '/') {
|
|
*fmt = FMT_TYPE_COMMENT;
|
|
fmt++;
|
|
str++;
|
|
*fmt = FMT_TYPE_COMMENT;
|
|
cont = FMT_CONT_NOP;
|
|
}
|
|
else {
|
|
*fmt = FMT_TYPE_COMMENT;
|
|
}
|
|
/* Handle other comments */
|
|
}
|
|
else {
|
|
find = (cont & FMT_CONT_QUOTEDOUBLE) ? '"' : '\'';
|
|
if (*str == find) {
|
|
cont = 0;
|
|
}
|
|
*fmt = FMT_TYPE_STRING;
|
|
}
|
|
|
|
str += BLI_str_utf8_size_safe(str) - 1;
|
|
}
|
|
/* Not in a string... */
|
|
else {
|
|
/* Deal with comments first */
|
|
if (*str == '/' && *(str + 1) == '/') {
|
|
/* fill the remaining line */
|
|
text_format_fill(&str, &fmt, FMT_TYPE_COMMENT, len - int(fmt - line->format));
|
|
}
|
|
/* C-Style (multi-line) comments */
|
|
else if (*str == '/' && *(str + 1) == '*') {
|
|
cont = FMT_CONT_COMMENT_C;
|
|
*fmt = FMT_TYPE_COMMENT;
|
|
fmt++;
|
|
str++;
|
|
*fmt = FMT_TYPE_COMMENT;
|
|
}
|
|
else if (ELEM(*str, '"', '\'')) {
|
|
/* Strings */
|
|
find = *str;
|
|
cont = (*str == '"') ? FMT_CONT_QUOTEDOUBLE : FMT_CONT_QUOTESINGLE;
|
|
*fmt = FMT_TYPE_STRING;
|
|
}
|
|
/* White-space (all white-space has been converted to spaces). */
|
|
else if (*str == ' ') {
|
|
*fmt = FMT_TYPE_WHITESPACE;
|
|
}
|
|
/* Numbers (digits not part of an identifier and periods followed by digits) */
|
|
else if ((prev != FMT_TYPE_DEFAULT && text_check_digit(*str)) ||
|
|
(*str == '.' && text_check_digit(*(str + 1))))
|
|
{
|
|
*fmt = FMT_TYPE_NUMERAL;
|
|
}
|
|
/* Punctuation */
|
|
else if ((*str != '#') && text_check_delim(*str)) {
|
|
*fmt = FMT_TYPE_SYMBOL;
|
|
}
|
|
/* Identifiers and other text (no previous white-space or delimiters. so text continues). */
|
|
else if (prev == FMT_TYPE_DEFAULT) {
|
|
str += BLI_str_utf8_size_safe(str) - 1;
|
|
*fmt = FMT_TYPE_DEFAULT;
|
|
}
|
|
/* Not white-space, a digit, punctuation, or continuing text.
|
|
* Must be new, check for special words. */
|
|
else {
|
|
/* Keep aligned arguments for readability. */
|
|
/* clang-format off */
|
|
|
|
/* Special vars(v) or built-in keywords(b) */
|
|
/* keep in sync with `txtfmt_osl_format_identifier()`. */
|
|
if ((i = txtfmt_osl_find_specialvar(str)) != -1) { prev = FMT_TYPE_SPECIAL;
|
|
} else if ((i = txtfmt_osl_find_builtinfunc(str)) != -1) { prev = FMT_TYPE_KEYWORD;
|
|
} else if ((i = txtfmt_osl_find_reserved(str)) != -1) { prev = FMT_TYPE_RESERVED;
|
|
} else if ((i = txtfmt_osl_find_preprocessor(str)) != -1) { prev = FMT_TYPE_DIRECTIVE;
|
|
}
|
|
/* clang-format on */
|
|
|
|
if (i > 0) {
|
|
if (prev == FMT_TYPE_DIRECTIVE) { /* can contain utf8 */
|
|
text_format_fill(&str, &fmt, prev, i);
|
|
}
|
|
else {
|
|
text_format_fill_ascii(&str, &fmt, prev, i);
|
|
}
|
|
}
|
|
else {
|
|
str += BLI_str_utf8_size_safe(str) - 1;
|
|
*fmt = FMT_TYPE_DEFAULT;
|
|
}
|
|
}
|
|
}
|
|
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 != cont_orig && do_next && line->next) {
|
|
txtfmt_osl_format_line(st, line->next, do_next);
|
|
}
|
|
|
|
flatten_string_free(&fs);
|
|
}
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Registration
|
|
* \{ */
|
|
|
|
void ED_text_format_register_osl()
|
|
{
|
|
static TextFormatType tft = {nullptr};
|
|
static const char *ext[] = {"osl", nullptr};
|
|
|
|
tft.format_identifier = txtfmt_osl_format_identifier;
|
|
tft.format_line = txtfmt_osl_format_line;
|
|
tft.ext = ext;
|
|
tft.comment_line = "//";
|
|
|
|
ED_text_format_register(&tft);
|
|
|
|
BLI_assert(text_format_string_literals_check_sorted_array(text_format_osl_literals_builtinfunc));
|
|
BLI_assert(text_format_string_literals_check_sorted_array(text_format_osl_literals_reserved));
|
|
BLI_assert(text_format_string_literals_check_sorted_array(text_format_osl_literals_specialvar));
|
|
}
|
|
|
|
/** \} */
|