text_format.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2009 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#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;
};
 
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);
int flatten_string_strlen(FlattenString *fs, const char *str);
 
int text_check_format_len(TextLine *line, unsigned int len);
void text_format_fill(const char **str_p, char **fmt_p, char type, int len);
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. */
 
  const char *comment_line;
};
 
enum {
  FMT_TYPE_WHITESPACE = '_',
  FMT_TYPE_COMMENT = '#',
  FMT_TYPE_SYMBOL = '!',
  FMT_TYPE_NUMERAL = 'n',
  FMT_TYPE_STRING = 'l',
  FMT_TYPE_DIRECTIVE = 'd',
  FMT_TYPE_SPECIAL = 'v',
  FMT_TYPE_RESERVED = 'r',
  FMT_TYPE_KEYWORD = 'b',
  FMT_TYPE_DEFAULT = 'q',
};
 
TextFormatType *ED_text_format_get(Text *text);
void ED_text_format_register(TextFormatType *tft);
 
/* formatters */
void ED_text_format_register_glsl();
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();
 
int text_format_string_literal_find(Span<const char *> string_literals, const char *text);
 
#ifndef NDEBUG
const bool text_format_string_literals_check_sorted_array(Span<const char *> string_literals);
 
#endif