This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/blender/editors/space_text/text_format.h
Campbell Barton c434782e3a File headers: SPDX License migration
Use a shorter/simpler license convention, stops the header taking so
much space.

Follow the SPDX license specification: https://spdx.org/licenses

- C/C++/objc/objc++
- Python
- Shell Scripts
- CMake, GNUmakefile

While most of the source tree has been included

- `./extern/` was left out.
- `./intern/cycles` & `./intern/atomic` are also excluded because they
  use different header conventions.

doc/license/SPDX-license-identifiers.txt has been added to list SPDX all
used identifiers.

See P2788 for the script that automated these edits.

Reviewed By: brecht, mont29, sergey

Ref D14069
2022-02-11 09:14:36 +11:00

115 lines
3.6 KiB
C++

/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2009 Blender Foundation. All rights reserved. */
/** \file
* \ingroup sptext
*/
#pragma once
/* *** Flatten String *** */
typedef struct FlattenString {
char fixedbuf[256];
int fixedaccum[256];
char *buf;
int *accum;
int pos, len;
} FlattenString;
/**
* 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 struct 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 *** */
typedef struct TextFormatType {
struct 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 */
} TextFormatType;
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);
void ED_text_format_register_osl(void);
void ED_text_format_register_lua(void);
void ED_text_format_register_pov(void);
void ED_text_format_register_pov_ini(void);
#define STR_LITERAL_STARTSWITH(str, str_literal, len_var) \
(strncmp(str, str_literal, len_var = (sizeof(str_literal) - 1)) == 0)