e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
140 lines
4.2 KiB
C++
140 lines
4.2 KiB
C++
/* SPDX-FileCopyrightText: 2009 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup sptext
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "BLI_span.hh"
|
|
|
|
using blender::Span;
|
|
|
|
struct Text;
|
|
|
|
/* *** Flatten String *** */
|
|
struct FlattenString {
|
|
char fixedbuf[256];
|
|
int fixedaccum[256];
|
|
|
|
char *buf;
|
|
int *accum;
|
|
int pos, len;
|
|
};
|
|
|
|
/**
|
|
* Format continuation flags (stored just after the null terminator).
|
|
*/
|
|
enum {
|
|
FMT_CONT_NOP = 0, /* no continuation */
|
|
FMT_CONT_QUOTESINGLE = (1 << 0), /* single quotes */
|
|
FMT_CONT_QUOTEDOUBLE = (1 << 1), /* double quotes */
|
|
FMT_CONT_TRIPLE = (1 << 2), /* triplets of quotes: """ or ''' */
|
|
FMT_CONT_QUOTESINGLE_TRIPLE = (FMT_CONT_TRIPLE | FMT_CONT_QUOTESINGLE),
|
|
FMT_CONT_QUOTEDOUBLE_TRIPLE = (FMT_CONT_TRIPLE | FMT_CONT_QUOTEDOUBLE),
|
|
FMT_CONT_COMMENT_C = (1 << 3) /* multi-line comments, OSL only (C style) */
|
|
};
|
|
#define FMT_CONT_ALL \
|
|
(FMT_CONT_QUOTESINGLE | FMT_CONT_QUOTEDOUBLE | FMT_CONT_TRIPLE | FMT_CONT_COMMENT_C)
|
|
|
|
int flatten_string(const SpaceText *st, FlattenString *fs, const char *in);
|
|
void flatten_string_free(FlattenString *fs);
|
|
/**
|
|
* Takes a string within `fs->buf` and returns its length.
|
|
*/
|
|
int flatten_string_strlen(FlattenString *fs, const char *str);
|
|
|
|
/**
|
|
* Ensures the format string for the given line is long enough, reallocating
|
|
* as needed. Allocation is done here, alone, to ensure consistency.
|
|
*/
|
|
int text_check_format_len(TextLine *line, unsigned int len);
|
|
/**
|
|
* Fill the string with formatting constant,
|
|
* advancing \a str_p and \a fmt_p
|
|
*
|
|
* \param len: length in bytes of \a fmt_p to fill.
|
|
*/
|
|
void text_format_fill(const char **str_p, char **fmt_p, char type, int len);
|
|
/**
|
|
* ASCII version of #text_format_fill,
|
|
* use when we no the text being stepped over is ascii (as is the case for most keywords)
|
|
*/
|
|
void text_format_fill_ascii(const char **str_p, char **fmt_p, char type, int len);
|
|
|
|
/* *** Generalize Formatting *** */
|
|
struct TextFormatType {
|
|
TextFormatType *next, *prev;
|
|
|
|
char (*format_identifier)(const char *string);
|
|
|
|
/* Formats the specified line. If do_next is set, the process will move on to
|
|
* the succeeding line if it is affected (eg. multi-line strings). Format strings
|
|
* may contain any of the following characters:
|
|
*
|
|
* It is terminated with a null-terminator '\0' followed by a continuation
|
|
* flag indicating whether the line is part of a multi-line string.
|
|
*
|
|
* See: FMT_TYPE_ enums below
|
|
*/
|
|
void (*format_line)(SpaceText *st, TextLine *line, bool do_next);
|
|
|
|
const char **ext; /* Null terminated extensions. */
|
|
|
|
/** The prefix of a single-line line comment (without trailing space). */
|
|
const char *comment_line;
|
|
};
|
|
|
|
enum {
|
|
/** White-space */
|
|
FMT_TYPE_WHITESPACE = '_',
|
|
/** Comment text */
|
|
FMT_TYPE_COMMENT = '#',
|
|
/** Punctuation and other symbols */
|
|
FMT_TYPE_SYMBOL = '!',
|
|
/** Numerals */
|
|
FMT_TYPE_NUMERAL = 'n',
|
|
/** String letters */
|
|
FMT_TYPE_STRING = 'l',
|
|
/** Decorator / Pre-processor directive */
|
|
FMT_TYPE_DIRECTIVE = 'd',
|
|
/** Special variables (class, def) */
|
|
FMT_TYPE_SPECIAL = 'v',
|
|
/** Reserved keywords currently not in use, but still prohibited (OSL -> switch e.g.) */
|
|
FMT_TYPE_RESERVED = 'r',
|
|
/** Built-in names (return, for, etc.) */
|
|
FMT_TYPE_KEYWORD = 'b',
|
|
/** Regular text (identifiers, etc.) */
|
|
FMT_TYPE_DEFAULT = 'q',
|
|
};
|
|
|
|
TextFormatType *ED_text_format_get(Text *text);
|
|
void ED_text_format_register(TextFormatType *tft);
|
|
|
|
/* formatters */
|
|
void ED_text_format_register_py();
|
|
void ED_text_format_register_osl();
|
|
void ED_text_format_register_pov();
|
|
void ED_text_format_register_pov_ini();
|
|
|
|
/**
|
|
* Checks the specified source string #text for a string literal in #string_literals array.
|
|
* This string literal must start at the beginning of the source string.
|
|
*
|
|
* If a string literal is found, the length of the string literal is returned.
|
|
* Otherwise, 0.
|
|
*/
|
|
int text_format_string_literal_find(const Span<const char *> string_literals, const char *text);
|
|
|
|
#ifndef NDEBUG
|
|
/**
|
|
* Check if #string_literals array is shorted. This validation is required since text formatters do
|
|
* binary search on these string literals arrays. Used only for assertions.
|
|
*/
|
|
const bool text_format_string_literals_check_sorted_array(
|
|
const Span<const char *> &string_literals);
|
|
|
|
#endif
|