#include <cstdlib>
#include <cstring>
#include <cwctype>
#include <optional>
#include <sys/stat.h>
#include <sys/types.h>
#include "MEM_guardedalloc.h"
#include "BLI_fileops.h"
#include "BLI_listbase.h"
#include "BLI_path_utils.hh"
#include "BLI_string.h"
#include "BLI_string_cursor_utf8.h"
#include "BLI_string_utf8.h"
#include "BLI_utildefines.h"
#include "BLT_translation.hh"
#include "DNA_text_types.h"
#include "DNA_userdef_types.h"
#include "BKE_bpath.hh"
#include "BKE_idtype.hh"
#include "BKE_lib_id.hh"
#include "BKE_library.hh"
#include "BKE_main.hh"
#include "BKE_text.h"
#include "BLO_read_write.hh"

Functions
Prototypes
static void	txt_pop_first (Text *text)
static void	txt_pop_last (Text *text)
static void	txt_delete_line (Text text, TextLine line)
static void	txt_delete_sel (Text *text)
static void	txt_make_dirty (Text *text)
static TextLine *	txt_line_malloc () ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
Text Add, Free, Validation
void	BKE_text_free_lines (Text *text)
Text *	BKE_text_add (Main bmain, const char name)
int	txt_extended_ascii_as_utf8 (char **str)
static void	cleanup_textline (TextLine *tl)
static void	text_from_buf (Text text, const uchar buffer, const int len)
bool	BKE_text_reload (Text *text)
Text *	BKE_text_load_ex (Main bmain, const char filepath, const char *relbase, const bool is_internal)
Text *	BKE_text_load (Main bmain, const char filepath, const char *relbase)
void	BKE_text_clear (Text *text)
void	BKE_text_write (Text text, const char str, int str_len)
int	BKE_text_file_modified_check (const Text *text)
void	BKE_text_file_modified_ignore (Text *text)
Editing Utility Functions
static void	make_new_line (TextLine line, char newline)
static TextLine *	txt_new_linen (const char *str, int str_len)
static TextLine *	txt_new_line (const char *str)
void	txt_clean_text (Text *text)
int	txt_get_span (const TextLine from, const TextLine to)
Cursor Utility Functions
static void	txt_curs_cur (Text text, TextLine linep, int charp)
static void	txt_curs_sel (Text text, TextLine linep, int charp)
bool	txt_cursor_is_line_start (const Text *text)
bool	txt_cursor_is_line_end (const Text *text)
Cursor Movement Functions
Note If the user moves the cursor the space containing that cursor should be popped See txt_pop_first, txt_pop_last Other space-types retain their own top location.
void	txt_move_up (Text *text, const bool sel)
void	txt_move_down (Text *text, const bool sel)
int	txt_calc_tab_left (const TextLine *tl, int ch)
int	txt_calc_tab_right (const TextLine *tl, int ch)
void	txt_move_left (Text *text, const bool sel)
void	txt_move_right (Text *text, const bool sel)
void	txt_jump_left (Text *text, const bool sel, const bool use_init_step)
void	txt_jump_right (Text *text, const bool sel, const bool use_init_step)
void	txt_move_bol (Text *text, const bool sel)
void	txt_move_eol (Text *text, const bool sel)
void	txt_move_bof (Text *text, const bool sel)
void	txt_move_eof (Text *text, const bool sel)
void	txt_move_toline (Text *text, uint line, const bool sel)
void	txt_move_to (Text *text, uint line, uint ch, const bool sel)
Text Selection Functions
static void	txt_curs_swap (Text *text)
void	txt_pop_sel (Text *text)
void	txt_order_cursors (Text *text, const bool reverse)
bool	txt_has_sel (const Text *text)
void	txt_sel_all (Text *text)
void	txt_sel_clear (Text *text)
void	txt_sel_line (Text *text)
void	txt_sel_set (Text *text, int startl, int startc, int endl, int endc)
Buffer Conversion for Undo/Redo
Buffer conversion functions that rely on the buffer already being validated. The only requirement for these functions is that they're reverse-able, the undo logic doesn't inspect their content. Currently buffers: Always ends with a new-line. Are not null terminated.
char *	txt_to_buf_for_undo (Text text, size_t r_buf_len)
void	txt_from_buf_for_undo (Text text, const char buf, size_t buf_len)
Cut and Paste Functions
char *	txt_to_buf (Text text, size_t r_buf_strlen)
char *	txt_sel_to_buf (const Text text, size_t r_buf_strlen)
void	txt_insert_buf (Text text, const char in_buffer, int in_buffer_len)
Find String in Text
bool	txt_find_string (Text text, const char findstr, int wrap, int match_case)
Character Queries
int	text_check_bracket (const char ch)
bool	text_check_delim (const char ch)
bool	text_check_digit (const char ch)
bool	text_check_identifier (const char ch)
bool	text_check_identifier_nodigit (const char ch)
int	text_check_identifier_unicode (const uint ch)
int	text_check_identifier_nodigit_unicode (const uint ch)
bool	text_check_whitespace (const char ch)
int	text_find_identifier_start (const char *str, int i)

Text Data-Block
IDTypeInfo	IDType_ID_TXT
static void	text_init_data (ID *id)
static void	text_copy_data (Main , std::optional< Library >, ID id_dst, const ID id_src, const int)
static void	text_free_data (ID *id)
static void	text_foreach_path (ID id, BPathForeachPathData bpath_data)
static void	text_blend_write (BlendWriter writer, ID id, const void *id_address)
static void	text_blend_read_data (BlendDataReader reader, ID id)

Line Editing Functions
static char	tab_to_spaces [] = " "
void	txt_split_curline (Text *text)
static void	txt_combine_lines (Text text, TextLine linea, TextLine *lineb)
void	txt_duplicate_line (Text *text)
void	txt_delete_char (Text *text)
void	txt_delete_word (Text *text)
void	txt_backspace_char (Text *text)
void	txt_backspace_word (Text *text)
static void	txt_convert_tab_to_spaces (Text *text)
static bool	txt_add_char_intern (Text *text, uint add, bool replace_tabs)
bool	txt_add_char (Text *text, uint add)
bool	txt_add_raw_char (Text *text, uint add)
void	txt_delete_selected (Text *text)
bool	txt_replace_char (Text *text, uint add)
static void	txt_select_prefix (Text text, const char add, bool skip_blank_lines)
static bool	txt_select_unprefix (Text text, const char remove, const bool require_all)
void	txt_comment (Text text, const char prefix)
bool	txt_uncomment (Text text, const char prefix)
void	txt_indent (Text *text)
bool	txt_unindent (Text *text)
void	txt_move_lines (Text *text, const int direction)
int	txt_setcurr_tab_spaces (Text *text, int space)

Function Documentation

◆ BKE_text_add()

Text * BKE_text_add	(	Main *	bmain,
		const char *	name )

Definition at line 281 of file text.cc.

References BKE_id_new(), Text::id, id_fake_user_set(), id_us_min(), and name.

Referenced by text_new_exec().

◆ BKE_text_clear()

void BKE_text_clear ( Text * text )

Definition at line 511 of file text.cc.

References txt_delete_sel(), txt_make_dirty(), and txt_sel_all().

◆ BKE_text_file_modified_check()

int BKE_text_file_modified_check ( const Text * text )

Definition at line 525 of file text.cc.

References BLI_exists(), BLI_path_abs(), BLI_stat(), FILE_MAX, Text::filepath, Text::id, ID_BLEND_PATH_FROM_GLOBAL, Text::mtime, result, and STRNCPY().

◆ BKE_text_file_modified_ignore()

void BKE_text_file_modified_ignore ( Text * text )

Definition at line 559 of file text.cc.

References BLI_exists(), BLI_path_abs(), BLI_stat(), FILE_MAX, Text::filepath, Text::id, ID_BLEND_PATH_FROM_GLOBAL, Text::mtime, result, and STRNCPY().

Referenced by text_resolve_conflict_exec().

◆ BKE_text_free_lines()

void BKE_text_free_lines ( struct Text * text )

Note: caller must handle compiled member.

Definition at line 264 of file text.cc.

References BLI_listbase_clear(), Text::curl, ListBase::first, Text::lines, MEM_freeN(), and Text::sell.

Referenced by BKE_text_reload(), and text_free_data().

◆ BKE_text_load()

Text * BKE_text_load	(	Main *	bmain,
		const char *	filepath,
		const char *	relbase )

Definition at line 506 of file text.cc.

References BKE_text_load_ex().

◆ BKE_text_load_ex()

Text * BKE_text_load_ex	(	Main *	bmain,
		const char *	filepath,
		const char *	relbase,
		const bool	is_internal )

Definition at line 452 of file text.cc.

References BKE_libblock_alloc(), BLI_file_read_text_as_mem(), BLI_listbase_clear(), BLI_path_abs(), BLI_path_basename(), BLI_stat(), Text::curl, FILE_MAX, Text::filepath, Text::flags, Text::id, id_fake_user_set(), ID_TXT, id_us_min(), Text::lines, MEM_freeN(), MEM_malloc_arrayN(), Text::mtime, Text::sell, STRNCPY(), text_from_buf(), TXT_ISDIRTY, TXT_ISMEM, TXT_TABSTOSPACES, U, and USER_TXT_TABSTOSPACES_DISABLE.

Referenced by BKE_text_load().

◆ BKE_text_reload()

bool BKE_text_reload ( Text * text )

Definition at line 415 of file text.cc.

References BKE_text_free_lines(), BLI_file_read_text_as_mem(), BLI_path_abs(), BLI_stat(), FILE_MAX, Text::filepath, Text::id, ID_BLEND_PATH_FROM_GLOBAL, MEM_freeN(), Text::mtime, STRNCPY(), text_from_buf(), and txt_make_dirty().

Referenced by text_blend_read_data(), and text_reload_exec().

◆ BKE_text_write()

void BKE_text_write	(	Text *	text,
		const char *	str,
		int	str_len )

Definition at line 518 of file text.cc.

References str, txt_insert_buf(), txt_make_dirty(), and txt_move_eof().

◆ cleanup_textline()

void cleanup_textline ( TextLine * tl )

static

Removes any control characters from a text-line and fixes invalid UTF8 sequences.

Definition at line 338 of file text.cc.

References i, TextLine::len, TextLine::line, and txt_extended_ascii_as_utf8().

Referenced by text_from_buf().

◆ make_new_line()

void make_new_line	(	TextLine *	line,
		char *	newline )

static

Definition at line 599 of file text.cc.

References TextLine::format, TextLine::len, TextLine::line, and MEM_freeN().

Referenced by txt_add_char_intern(), txt_combine_lines(), txt_delete_sel(), and txt_select_prefix().

◆ text_blend_read_data()

void text_blend_read_data	(	BlendDataReader *	reader,
		ID *	id )

static

Definition at line 195 of file text.cc.

References BKE_text_reload(), BLO_read_string(), BLO_read_struct, BLO_read_struct_list, Text::compiled, Text::curl, Text::filepath, Text::flags, Text::lines, LISTBASE_FOREACH, printf, Text::sell, and TXT_ISEXT.

◆ text_blend_write()

void text_blend_write	(	BlendWriter *	writer,
		ID *	id,
		const void *	id_address )

static

Definition at line 163 of file text.cc.

References BKE_id_blend_write(), BLO_write_id_struct, BLO_write_string(), BLO_write_struct, Text::compiled, Text::filepath, Text::flags, Text::id, Text::lines, LISTBASE_FOREACH, TXT_ISEXT, and TXT_ISMEM.

◆ text_check_bracket()

int text_check_bracket ( char ch )

Utility functions, could be moved somewhere more generic but are python/text related.

Definition at line 2273 of file text.cc.

Referenced by draw_brackets(), and txt_calc_tab_right().

◆ text_check_delim()

bool text_check_delim ( const char ch )

Definition at line 2290 of file text.cc.

Referenced by txt_calc_tab_right(), txtfmt_glsl_format_line(), txtfmt_osl_format_line(), txtfmt_pov_format_line(), txtfmt_pov_ini_format_line(), and txtfmt_py_format_line().

◆ text_check_digit()

bool text_check_digit ( const char ch )

Definition at line 2306 of file text.cc.

Referenced by txt_calc_tab_right(), txtfmt_glsl_format_line(), txtfmt_osl_format_line(), txtfmt_pov_format_line(), txtfmt_pov_ini_format_line(), txtfmt_py_find_numeral_inner(), and txtfmt_py_literal_numeral().

◆ text_check_identifier()

bool text_check_identifier ( const char ch )

◆ text_check_identifier_nodigit()

bool text_check_identifier_nodigit ( const char ch )

Definition at line 2340 of file text.cc.

Referenced by text_check_identifier_nodigit_unicode(), text_check_identifier_nodigit_unicode(), and txt_calc_tab_right().

◆ text_check_identifier_nodigit_unicode()

int text_check_identifier_nodigit_unicode ( const uint ch )

Definition at line 2366 of file text.cc.

◆ text_check_identifier_unicode()

int text_check_identifier_unicode ( const uint ch )

Definition at line 2361 of file text.cc.

◆ text_check_whitespace()

bool text_check_whitespace ( const char ch )

Definition at line 2372 of file text.cc.

References ELEM.

Referenced by text_autocomplete_modal(), txt_calc_tab_right(), txtfmt_glsl_find_preprocessor(), txtfmt_osl_find_preprocessor(), and txtfmt_py_find_decorator().

◆ text_copy_data()

void text_copy_data	(	Main *	,
		std::optional< Library * >	,
		ID *	id_dst,
		const ID *	id_src,
		const int	)

static

Only copy internal data of Text ID from source to already allocated/initialized destination. You probably never want to use that directly, use BKE_id_copy or BKE_id_copy_ex for typical needs.

WARNING! This function will not handle ID user count!

Parameters

flag	Copying options (see BKE_lib_id.hh's LIB_ID_COPY_... flags for more).

Definition at line 105 of file text.cc.

References BLI_addtail(), BLI_listbase_clear(), BLI_strdup(), BLI_strdupn(), Text::compiled, Text::curc, Text::curl, Text::filepath, ListBase::first, Text::flags, TextLine::format, TextLine::len, TextLine::line, Text::lines, LISTBASE_FOREACH, Text::selc, Text::sell, TXT_ISDIRTY, and txt_line_malloc().

◆ text_find_identifier_start()

int text_find_identifier_start	(	const char *	str,
		int	i )

Definition at line 2380 of file text.cc.

References i, str, text_check_identifier(), and UNLIKELY.

Referenced by confirm_suggestion(), draw_suggestion_list(), get_suggest_prefix(), text_autocomplete_build(), and txt_calc_tab_right().

◆ text_foreach_path()

void text_foreach_path	(	ID *	id,
		BPathForeachPathData *	bpath_data )

static

Definition at line 154 of file text.cc.

References BKE_bpath_foreach_path_allocated_process(), and Text::filepath.

◆ text_free_data()

void text_free_data ( ID * id )

static

Free (or release) any data used by this text (does not free the text itself).

Definition at line 141 of file text.cc.

References BKE_text_free_lines(), BPY_text_free_code(), Text::filepath, and MEM_SAFE_FREE.

◆ text_from_buf()

void text_from_buf	(	Text *	text,
		const uchar *	buffer,
		const int	len )

static

used for load and reload (unlike txt_insert_buf) assumes all fields are empty

Definition at line 356 of file text.cc.

References BLI_addtail(), BLI_assert, BLI_listbase_is_empty(), cleanup_textline(), Text::curc, Text::curl, ListBase::first, TextLine::format, i, len, TextLine::len, TextLine::line, Text::lines, MEM_malloc_arrayN(), Text::selc, Text::sell, and txt_line_malloc().

Referenced by BKE_text_load_ex(), and BKE_text_reload().

◆ text_init_data()

void text_init_data ( ID * id )

static

Definition at line 62 of file text.cc.

References BLI_addhead(), BLI_assert, BLI_listbase_clear(), Text::curc, Text::curl, Text::filepath, ListBase::first, Text::flags, TextLine::format, TextLine::len, TextLine::line, Text::lines, MEM_malloc_arrayN(), MEMCMP_STRUCT_AFTER_IS_ZERO, TextLine::next, TextLine::prev, Text::selc, Text::sell, text_init_data(), TXT_ISDIRTY, TXT_ISMEM, txt_line_malloc(), TXT_TABSTOSPACES, U, and USER_TXT_TABSTOSPACES_DISABLE.

Referenced by text_init_data().

◆ txt_add_char()

bool txt_add_char	(	Text *	text,
		uint	add )

Definition at line 1918 of file text.cc.

References add(), Text::flags, txt_add_char_intern(), and TXT_TABSTOSPACES.

Referenced by text_indent_exec(), text_insert_exec(), text_insert_invoke(), text_line_break_exec(), txt_insert_buf(), and txt_replace_char().

◆ txt_add_char_intern()

bool txt_add_char_intern	(	Text *	text,
		uint	add,
		bool	replace_tabs )

static

Definition at line 1875 of file text.cc.

References add(), BLI_str_utf8_from_unicode(), BLI_UTF8_MAX, Text::curc, Text::curl, TextLine::len, TextLine::line, make_new_line(), MEM_malloc_arrayN(), txt_clean_text(), txt_convert_tab_to_spaces(), txt_delete_sel(), txt_make_dirty(), txt_pop_sel(), and txt_split_curline().

Referenced by txt_add_char(), and txt_add_raw_char().

◆ txt_add_raw_char()

bool txt_add_raw_char	(	Text *	text,
		uint	add )

Definition at line 1923 of file text.cc.

References add(), and txt_add_char_intern().

Referenced by txt_insert_buf(), and txt_insert_buf().

◆ txt_backspace_char()

void txt_backspace_char ( Text * text )

Definition at line 1811 of file text.cc.

References BLI_str_cursor_step_prev_utf8(), Text::curc, Text::curl, TextLine::len, TextLine::line, TextLine::next, pos, TextLine::prev, txt_clean_text(), txt_combine_lines(), txt_delete_sel(), txt_has_sel(), txt_make_dirty(), and txt_pop_sel().

Referenced by text_delete_exec(), and txt_insert_buf().

◆ txt_backspace_word()

void txt_backspace_word ( Text * text )

Definition at line 1853 of file text.cc.

References txt_delete_sel(), txt_jump_left(), and txt_make_dirty().

Referenced by text_delete_exec(), and txt_insert_buf().

◆ txt_calc_tab_left()

int txt_calc_tab_left	(	const TextLine *	tl,
		int	ch )

Definition at line 829 of file text.cc.

References i, TextLine::line, and TXT_TABSIZE.

Referenced by txt_move_left().

◆ txt_calc_tab_right()

int txt_calc_tab_right	(	const TextLine *	tl,
		int	ch )

Definition at line 849 of file text.cc.

References i, TextLine::line, and TXT_TABSIZE.

Referenced by txt_move_right().

◆ txt_clean_text()

void txt_clean_text ( Text * text )

Definition at line 634 of file text.cc.

References Text::curc, Text::curl, ListBase::first, ListBase::last, Text::lines, TextLine::next, Text::selc, Text::sell, top, and txt_new_line().

Referenced by draw_text_main(), txt_add_char_intern(), txt_backspace_char(), txt_combine_lines(), txt_delete_char(), txt_delete_line(), txt_duplicate_line(), txt_move_lines(), txt_replace_char(), txt_select_prefix(), txt_select_unprefix(), and txt_split_curline().

◆ txt_combine_lines()

void txt_combine_lines	(	Text *	text,
		TextLine *	linea,
		TextLine *	lineb )

static

Definition at line 1723 of file text.cc.

References TextLine::len, TextLine::line, make_new_line(), MEM_malloc_arrayN(), txt_clean_text(), txt_delete_line(), and txt_make_dirty().

Referenced by txt_backspace_char(), and txt_delete_char().

◆ txt_comment()

void txt_comment	(	Text *	text,
		const char *	prefix )

Definition at line 2138 of file text.cc.

References Text::curl, ELEM, Text::sell, txt_has_sel(), and txt_select_prefix().

Referenced by text_comment_exec(), and txt_insert_buf().

◆ txt_convert_tab_to_spaces()

void txt_convert_tab_to_spaces ( Text * text )

static

Definition at line 1865 of file text.cc.

References Text::curc, tab_to_spaces, txt_insert_buf(), and TXT_TABSIZE.

Referenced by txt_add_char_intern().

◆ txt_curs_cur()

void txt_curs_cur	(	Text *	text,
		TextLine ***	linep,
		int **	charp )

static

Definition at line 733 of file text.cc.

References Text::curc, Text::curl, and linep.

Referenced by txt_jump_left(), txt_jump_right(), txt_move_bof(), txt_move_bol(), txt_move_down(), txt_move_eof(), txt_move_eol(), txt_move_left(), txt_move_right(), txt_move_to(), and txt_move_up().

◆ txt_curs_sel()

void txt_curs_sel	(	Text *	text,
		TextLine ***	linep,
		int **	charp )

static

Definition at line 739 of file text.cc.

References linep, Text::selc, and Text::sell.

Referenced by txt_jump_left(), txt_jump_right(), txt_move_bof(), txt_move_bol(), txt_move_down(), txt_move_eof(), txt_move_eol(), txt_move_left(), txt_move_right(), txt_move_to(), and txt_move_up().

◆ txt_curs_swap()

void txt_curs_swap ( Text * text )

static

Definition at line 1141 of file text.cc.

References Text::curc, Text::curl, Text::selc, and Text::sell.

Referenced by txt_order_cursors(), txt_pop_first(), and txt_pop_last().

◆ txt_cursor_is_line_end()

bool txt_cursor_is_line_end ( const Text * text )

Definition at line 750 of file text.cc.

References TextLine::len, Text::selc, and Text::sell.

◆ txt_cursor_is_line_start()

bool txt_cursor_is_line_start ( const Text * text )

Definition at line 745 of file text.cc.

References Text::selc.

◆ txt_delete_char()

void txt_delete_char ( Text * text )

Definition at line 1766 of file text.cc.

References BLI_str_cursor_step_next_utf8(), Text::curc, Text::curl, TextLine::len, TextLine::line, TextLine::next, pos, txt_clean_text(), txt_combine_lines(), txt_delete_sel(), txt_has_sel(), txt_make_dirty(), and txt_pop_sel().

Referenced by text_delete_exec(), and txt_get_span().

◆ txt_delete_line()

void txt_delete_line	(	Text *	text,
		TextLine *	line )

static

Definition at line 1702 of file text.cc.

References BLI_remlink(), Text::curl, TextLine::format, TextLine::line, Text::lines, MEM_freeN(), txt_clean_text(), and txt_make_dirty().

Referenced by txt_combine_lines(), and txt_delete_sel().

◆ txt_delete_sel()

void txt_delete_sel ( Text * text )

static

Definition at line 1214 of file text.cc.

References Text::curc, Text::curl, TextLine::len, TextLine::line, make_new_line(), MEM_malloc_arrayN(), TextLine::next, TextLine::prev, Text::selc, Text::sell, txt_delete_line(), txt_has_sel(), and txt_order_cursors().

Referenced by BKE_text_clear(), txt_add_char_intern(), txt_backspace_char(), txt_backspace_word(), txt_delete_char(), txt_delete_selected(), txt_delete_word(), txt_insert_buf(), and txt_split_curline().

◆ txt_delete_selected()

void txt_delete_selected ( Text * text )

Definition at line 1928 of file text.cc.

References txt_delete_sel(), and txt_make_dirty().

Referenced by text_cut_exec(), and txt_get_span().

◆ txt_delete_word()

void txt_delete_word ( Text * text )

Definition at line 1804 of file text.cc.

References txt_delete_sel(), txt_jump_right(), and txt_make_dirty().

Referenced by text_delete_exec(), and txt_get_span().

◆ txt_duplicate_line()

void txt_duplicate_line ( Text * text )

Definition at line 1749 of file text.cc.

References BLI_insertlinkafter(), Text::curl, TextLine::line, Text::lines, Text::sell, txt_clean_text(), txt_make_dirty(), and txt_new_line().

Referenced by text_duplicate_line_exec(), and txt_insert_buf().

◆ txt_extended_ascii_as_utf8()

int txt_extended_ascii_as_utf8 ( char ** str )

Use to a valid UTF8 sequences. this function replaces extended ASCII characters.

Definition at line 294 of file text.cc.

References BLI_str_utf8_from_unicode(), BLI_str_utf8_invalid_byte(), i, length(), MEM_freeN(), MEM_malloc_arrayN(), and str.

Referenced by blo_do_versions_260(), cleanup_textline(), and txt_insert_buf().

◆ txt_find_string()

bool txt_find_string	(	Text *	text,
		const char *	findstr,
		int	wrap,
		int	match_case )

Definition at line 1595 of file text.cc.

References BLI_strcasestr(), Text::curl, ListBase::first, TextLine::line, Text::lines, TextLine::next, Text::selc, Text::sell, txt_get_span(), txt_move_to(), txt_order_cursors(), and wrap().

Referenced by text_find_and_replace(), and text_replace_all().

◆ txt_from_buf_for_undo()

void txt_from_buf_for_undo	(	Text *	text,
		const char *	buf,
		size_t	buf_len )

Definition at line 1362 of file text.cc.

References BLI_addtail(), BLI_listbase_clear(), Text::curc, Text::curl, ListBase::first, TextLine::format, l, len, TextLine::line, Text::lines, MEM_freeN(), MEM_malloc_arrayN(), MEM_reallocN, MEM_SAFE_FREE, TextLine::next, Text::selc, Text::sell, txt_line_malloc(), and txt_make_dirty().

◆ txt_get_span()

int txt_get_span	(	const TextLine *	from,
		const TextLine *	to )

Definition at line 677 of file text.cc.

References TextLine::next, TextLine::prev, and ret.

Referenced by txt_find_string(), txt_order_cursors(), txt_pop_first(), txt_pop_last(), and txt_sel_to_buf().

◆ txt_has_sel()

bool txt_has_sel ( const Text * text )

Definition at line 1209 of file text.cc.

References Text::curc, Text::curl, Text::selc, and Text::sell.

Referenced by txt_backspace_char(), txt_comment(), txt_delete_char(), and txt_delete_sel().

◆ txt_indent()

void txt_indent ( Text * text )

Definition at line 2157 of file text.cc.

References Text::curl, ELEM, Text::flags, Text::sell, tab_to_spaces, txt_select_prefix(), and TXT_TABSTOSPACES.

Referenced by text_indent_exec(), and txt_insert_buf().

◆ txt_insert_buf()

void txt_insert_buf	(	Text *	text,
		const char *	in_buffer,
		int	in_buffer_len )

Definition at line 1541 of file text.cc.

References add(), BLI_assert, BLI_insertlinkbefore(), BLI_str_utf8_as_unicode_step_safe(), BLI_strdupn(), Text::curl, i, l, Text::lines, MEM_freeN(), txt_add_raw_char(), txt_delete_sel(), txt_extended_ascii_as_utf8(), txt_new_linen(), and txt_split_curline().

Referenced by BKE_text_write(), and txt_convert_tab_to_spaces().

◆ txt_jump_left()

void txt_jump_left	(	Text *	text,
		const bool	sel,
		const bool	use_init_step )

Definition at line 957 of file text.cc.

References BLI_str_cursor_step_utf8(), linep, STRCUR_DIR_PREV, STRCUR_JUMP_DELIM, txt_curs_cur(), txt_curs_sel(), txt_pop_first(), and txt_pop_sel().

Referenced by text_move_cursor(), txt_backspace_word(), and txt_get_span().

◆ txt_jump_right()

void txt_jump_right	(	Text *	text,
		const bool	sel,
		const bool	use_init_step )

Definition at line 981 of file text.cc.

References BLI_str_cursor_step_utf8(), linep, STRCUR_DIR_NEXT, STRCUR_JUMP_DELIM, txt_curs_cur(), txt_curs_sel(), txt_pop_last(), and txt_pop_sel().

Referenced by text_move_cursor(), txt_delete_word(), and txt_get_span().

◆ txt_line_malloc()

TextLine * txt_line_malloc ( )

static

Definition at line 591 of file text.cc.

References l, and MEM_mallocN().

Referenced by text_copy_data(), text_from_buf(), text_init_data(), txt_from_buf_for_undo(), txt_new_linen(), and txt_split_curline().

◆ txt_make_dirty()

void txt_make_dirty ( Text * text )

static

Definition at line 717 of file text.cc.

References BPY_text_free_code(), Text::compiled, Text::flags, and TXT_ISDIRTY.

Referenced by BKE_text_clear(), BKE_text_reload(), BKE_text_write(), txt_add_char_intern(), txt_backspace_char(), txt_backspace_word(), txt_combine_lines(), txt_delete_char(), txt_delete_line(), txt_delete_selected(), txt_delete_word(), txt_duplicate_line(), txt_from_buf_for_undo(), txt_move_lines(), txt_replace_char(), txt_select_prefix(), txt_select_unprefix(), and txt_split_curline().

◆ txt_move_bof()

void txt_move_bof	(	Text *	text,
		const bool	sel )

Definition at line 1049 of file text.cc.

References ListBase::first, linep, Text::lines, txt_curs_cur(), txt_curs_sel(), and txt_pop_sel().

Referenced by text_move_cursor(), and txt_get_span().

◆ txt_move_bol()

void txt_move_bol	(	Text *	text,
		const bool	sel )

Definition at line 1005 of file text.cc.

References linep, txt_curs_cur(), txt_curs_sel(), and txt_pop_sel().

Referenced by text_move_cursor(), txt_get_span(), and txt_move_up().

◆ txt_move_down()

void txt_move_down	(	Text *	text,
		const bool	sel )

Definition at line 797 of file text.cc.

References BLI_str_utf8_offset_from_column_with_tabs(), BLI_str_utf8_offset_to_column_with_tabs(), linep, txt_curs_cur(), txt_curs_sel(), txt_move_eol(), txt_pop_last(), txt_pop_sel(), and TXT_TABSIZE.

Referenced by text_move_cursor(), txt_get_span(), and txt_move_right().

◆ txt_move_eof()

void txt_move_eof	(	Text *	text,
		const bool	sel )

Definition at line 1072 of file text.cc.

References ListBase::last, TextLine::len, linep, Text::lines, txt_curs_cur(), txt_curs_sel(), and txt_pop_sel().

Referenced by BKE_text_write(), text_move_cursor(), and txt_get_span().

◆ txt_move_eol()

void txt_move_eol	(	Text *	text,
		const bool	sel )

Definition at line 1027 of file text.cc.

References linep, txt_curs_cur(), txt_curs_sel(), and txt_pop_sel().

Referenced by text_move_cursor(), txt_get_span(), and txt_move_down().

◆ txt_move_left()

void txt_move_left	(	Text *	text,
		const bool	sel )

Definition at line 870 of file text.cc.

References BLI_str_cursor_step_prev_utf8(), Text::flags, linep, txt_calc_tab_left(), txt_curs_cur(), txt_curs_sel(), txt_move_up(), txt_pop_first(), txt_pop_sel(), and TXT_TABSTOSPACES.

Referenced by text_autocomplete_modal(), text_insert_invoke(), text_move_cursor(), and txt_get_span().

◆ txt_move_lines()

void txt_move_lines	(	Text *	text,
		const int	direction )

Definition at line 2179 of file text.cc.

References BLI_assert, BLI_insertlinkafter(), BLI_insertlinkbefore(), BLI_remlink(), Text::curl, ELEM, Text::lines, TextLine::next, TextLine::prev, Text::sell, txt_clean_text(), txt_make_dirty(), TXT_MOVE_LINE_DOWN, TXT_MOVE_LINE_UP, and txt_order_cursors().

Referenced by move_lines_exec(), and txt_insert_buf().

◆ txt_move_right()

void txt_move_right	(	Text *	text,
		const bool	sel )

Definition at line 913 of file text.cc.

References BLI_str_cursor_step_next_utf8(), Text::flags, linep, txt_calc_tab_right(), txt_curs_cur(), txt_curs_sel(), txt_move_down(), txt_pop_last(), txt_pop_sel(), and TXT_TABSTOSPACES.

Referenced by text_autocomplete_modal(), text_delete_exec(), text_move_cursor(), and txt_get_span().

◆ txt_move_to()

void txt_move_to	(	struct Text *	text,
		unsigned int	line,
		unsigned int	ch,
		bool	sel )

Moves to a certain byte in a line, not a certain UTF8-character.

Definition at line 1100 of file text.cc.

References ListBase::first, i, linep, Text::lines, txt_curs_cur(), txt_curs_sel(), and txt_pop_sel().

Referenced by python_script_error_jump_text(), text_jump_to_file_at_point_internal(), text_reload_exec(), text_replace_all(), text_state_decode(), txt_find_string(), txt_get_span(), and txt_move_toline().

◆ txt_move_toline()

void txt_move_toline	(	Text *	text,
		uint	line,
		const bool	sel )

Definition at line 1095 of file text.cc.

References txt_move_to().

Referenced by text_find_and_replace(), text_jump_exec(), text_line_number_invoke(), text_replace_all(), and txt_get_span().

◆ txt_move_up()

void txt_move_up	(	Text *	text,
		const bool	sel )

Definition at line 765 of file text.cc.

References BLI_str_utf8_offset_from_column_with_tabs(), BLI_str_utf8_offset_to_column_with_tabs(), linep, txt_curs_cur(), txt_curs_sel(), txt_move_bol(), txt_pop_first(), txt_pop_sel(), and TXT_TABSIZE.

Referenced by text_move_cursor(), txt_get_span(), and txt_move_left().

◆ txt_new_line()

TextLine * txt_new_line ( const char * str )

static

Definition at line 629 of file text.cc.

References str, and txt_new_linen().

Referenced by txt_clean_text(), and txt_duplicate_line().

◆ txt_new_linen()

TextLine * txt_new_linen	(	const char *	str,
		int	str_len )

static

Definition at line 613 of file text.cc.

References BLI_assert, TextLine::format, TextLine::len, TextLine::line, MEM_malloc_arrayN(), TextLine::next, TextLine::prev, str, and txt_line_malloc().

Referenced by txt_insert_buf(), and txt_new_line().

◆ txt_order_cursors()

void txt_order_cursors	(	Text *	text,
		const bool	reverse )

Definition at line 1183 of file text.cc.

References Text::curc, Text::curl, Text::selc, Text::sell, txt_curs_swap(), and txt_get_span().

Referenced by text_comment_exec(), text_delete_exec(), text_indent_exec(), text_insert_invoke(), text_move_cursor(), text_unindent_exec(), txt_delete_sel(), txt_find_string(), and txt_move_lines().

◆ txt_pop_first()

void txt_pop_first ( Text * text )

static

Definition at line 1155 of file text.cc.

References Text::curc, Text::curl, Text::selc, Text::sell, txt_curs_swap(), txt_get_span(), and txt_pop_sel().

Referenced by txt_jump_left(), txt_move_left(), and txt_move_up().

◆ txt_pop_last()

void txt_pop_last ( Text * text )

static

Definition at line 1166 of file text.cc.

References Text::curc, Text::curl, Text::selc, Text::sell, txt_curs_swap(), txt_get_span(), and txt_pop_sel().

Referenced by txt_jump_right(), txt_move_down(), and txt_move_right().

◆ txt_pop_sel()

void txt_pop_sel ( Text * text )

◆ txt_replace_char()

bool txt_replace_char	(	Text *	text,
		uint	add )

Definition at line 1934 of file text.cc.

References add(), BLI_str_utf8_as_unicode_step_safe(), BLI_str_utf8_from_unicode(), BLI_UTF8_MAX, Text::curc, Text::curl, TextLine::len, TextLine::line, MEM_freeN(), MEM_malloc_arrayN(), txt_add_char(), txt_clean_text(), txt_has_sel(), txt_make_dirty(), txt_pop_sel(), and UNUSED_VARS.

Referenced by text_insert_exec(), and txt_insert_buf().

◆ txt_sel_all()

void txt_sel_all ( Text * text )

Definition at line 1255 of file text.cc.

References Text::curc, Text::curl, ListBase::first, ListBase::last, TextLine::len, Text::lines, Text::selc, and Text::sell.

Referenced by BKE_text_clear(), text_select_all_exec(), and txt_get_span().

◆ txt_sel_clear()

void txt_sel_clear ( struct Text * text )

Reverse of txt_pop_sel Clears the selection and ensures the cursor is located at the selection (where the cursor is visually while editing).

Definition at line 1264 of file text.cc.

References Text::curc, Text::curl, Text::selc, and Text::sell.

Referenced by text_move_cursor(), and txt_get_span().

◆ txt_sel_line()

void txt_sel_line ( Text * text )

Definition at line 1272 of file text.cc.

References Text::curc, Text::curl, TextLine::len, Text::selc, and Text::sell.

Referenced by text_select_line_exec(), and txt_get_span().

◆ txt_sel_set()

void txt_sel_set	(	Text *	text,
		int	startl,
		int	startc,
		int	endl,
		int	endc )

Definition at line 1283 of file text.cc.

References BLI_findlink(), BLI_listbase_count(), BLI_str_utf8_offset_from_index(), BLI_strlen_utf8(), CLAMP_MIN, Text::curc, Text::curl, ListBase::last, TextLine::len, TextLine::line, Text::lines, Text::selc, and Text::sell.

Referenced by bpy_rna_region_as_string(), bpy_rna_region_from_string(), and txt_get_span().

◆ txt_sel_to_buf()

char * txt_sel_to_buf	(	const Text *	text,
		size_t *	r_buf_strlen )

Definition at line 1458 of file text.cc.

References Text::curc, Text::curl, TextLine::len, length(), TextLine::line, MEM_malloc_arrayN(), TextLine::next, Text::selc, Text::sell, and txt_get_span().

◆ txt_select_prefix()

void txt_select_prefix	(	Text *	text,
		const char *	add,
		bool	skip_blank_lines )

static

Generic prefix operation, use for comment & indent.

Note: caller must handle undo.

Definition at line 1987 of file text.cc.

References add(), BLI_assert, Text::curc, Text::curl, ELEM, len, TextLine::len, TextLine::line, make_new_line(), MEM_malloc_arrayN(), TextLine::next, num, TextLine::prev, Text::selc, Text::sell, txt_clean_text(), and txt_make_dirty().

Referenced by txt_comment(), and txt_indent().

◆ txt_select_unprefix()

bool txt_select_unprefix	(	Text *	text,
		const char *	remove,
		const bool	require_all )

static

Generic un-prefix operation, use for comment & indent.

Parameters

require_all When true, all non-empty lines must have this prefix. Needed for comments where we might want to un-comment a block which contains some comments.

Note: caller must handle undo.

Definition at line 2067 of file text.cc.

References BLI_assert, Text::curc, Text::curl, ELEM, i, l, TextLine::len, TextLine::line, TextLine::next, num, TextLine::prev, Text::selc, Text::sell, STREQLEN, txt_clean_text(), and txt_make_dirty().

Referenced by txt_uncomment(), and txt_unindent().

◆ txt_setcurr_tab_spaces()

int txt_setcurr_tab_spaces	(	Text *	text,
		int	space )

Definition at line 2210 of file text.cc.

References Text::curc, Text::curl, ELEM, Text::flags, i, TextLine::line, and TXT_TABSTOSPACES.

Referenced by text_line_break_exec(), and txt_insert_buf().

◆ txt_split_curline()

void txt_split_curline ( Text * text )

Definition at line 1653 of file text.cc.

References BLI_insertlinkbefore(), Text::curc, Text::curl, TextLine::format, left, TextLine::len, TextLine::line, Text::lines, MEM_freeN(), MEM_malloc_arrayN(), txt_clean_text(), txt_delete_sel(), txt_line_malloc(), txt_make_dirty(), and txt_pop_sel().

Referenced by text_line_break_exec(), txt_add_char_intern(), txt_insert_buf(), and txt_insert_buf().

◆ txt_to_buf()

char * txt_to_buf	(	Text *	text,
		size_t *	r_buf_strlen )

Definition at line 1430 of file text.cc.

References BLI_listbase_is_empty(), l, Text::lines, LISTBASE_FOREACH, and MEM_malloc_arrayN().

◆ txt_to_buf_for_undo()

char * txt_to_buf_for_undo	(	Text *	text,
		size_t *	r_buf_len )

Definition at line 1345 of file text.cc.

References l, Text::lines, LISTBASE_FOREACH, and MEM_malloc_arrayN().

◆ txt_uncomment()

bool txt_uncomment	(	Text *	text,
		const char *	prefix )

Definition at line 2148 of file text.cc.

References Text::curl, ELEM, Text::sell, and txt_select_unprefix().

Referenced by text_comment_exec(), and txt_insert_buf().

◆ txt_unindent()

bool txt_unindent ( Text * text )

Definition at line 2168 of file text.cc.

References Text::curl, ELEM, Text::flags, Text::sell, tab_to_spaces, txt_select_unprefix(), and TXT_TABSTOSPACES.

Referenced by text_unindent_exec(), and txt_insert_buf().

Variable Documentation

◆ IDType_ID_TXT

IDTypeInfo IDType_ID_TXT

Initial value:

                         = {
     Text::id_type,
     FILTER_ID_TXT,
     0,
     INDEX_ID_TXT,
     sizeof(Text),
     "Text",
     N_("texts"),
     BLT_I18NCONTEXT_ID_TEXT,
     IDTYPE_FLAGS_NO_ANIMDATA | IDTYPE_FLAGS_APPEND_IS_REUSABLE,
     nullptr,
 
     text_init_data,
     text_copy_data,
     text_free_data,
     nullptr,
     nullptr,
     nullptr,
     text_foreach_path,
     nullptr,
     nullptr,
 
     text_blend_write,
     text_blend_read_data,
     nullptr,
 
     nullptr,
 
     nullptr,
}

Definition at line 227 of file text.cc.

◆ tab_to_spaces

char tab_to_spaces[] = " "

static

Definition at line 1863 of file text.cc.

Referenced by txt_convert_tab_to_spaces(), txt_indent(), and txt_unindent().

Functions

Text Data-Block

Line Editing Functions

Function Documentation

◆ BKE_text_add()

◆ BKE_text_clear()

◆ BKE_text_file_modified_check()

◆ BKE_text_file_modified_ignore()

◆ BKE_text_free_lines()

◆ BKE_text_load()

◆ BKE_text_load_ex()

◆ BKE_text_reload()

◆ BKE_text_write()

◆ cleanup_textline()

◆ make_new_line()

◆ text_blend_read_data()

◆ text_blend_write()

◆ text_check_bracket()

◆ text_check_delim()

◆ text_check_digit()

◆ text_check_identifier()

◆ text_check_identifier_nodigit()

◆ text_check_identifier_nodigit_unicode()

◆ text_check_identifier_unicode()

◆ text_check_whitespace()

◆ text_copy_data()

◆ text_find_identifier_start()

◆ text_foreach_path()

◆ text_free_data()

◆ text_from_buf()

◆ text_init_data()

◆ txt_add_char()

◆ txt_add_char_intern()

◆ txt_add_raw_char()

◆ txt_backspace_char()

◆ txt_backspace_word()

◆ txt_calc_tab_left()

◆ txt_calc_tab_right()

◆ txt_clean_text()

◆ txt_combine_lines()

◆ txt_comment()

◆ txt_convert_tab_to_spaces()

◆ txt_curs_cur()

◆ txt_curs_sel()

◆ txt_curs_swap()

◆ txt_cursor_is_line_end()

◆ txt_cursor_is_line_start()

◆ txt_delete_char()

◆ txt_delete_line()

◆ txt_delete_sel()

◆ txt_delete_selected()

◆ txt_delete_word()

◆ txt_duplicate_line()

◆ txt_extended_ascii_as_utf8()

◆ txt_find_string()

◆ txt_from_buf_for_undo()

◆ txt_get_span()

◆ txt_has_sel()

◆ txt_indent()

◆ txt_insert_buf()

◆ txt_jump_left()

◆ txt_jump_right()

◆ txt_line_malloc()

◆ txt_make_dirty()

◆ txt_move_bof()

◆ txt_move_bol()

◆ txt_move_down()

◆ txt_move_eof()

◆ txt_move_eol()

◆ txt_move_left()

◆ txt_move_lines()

◆ txt_move_right()

◆ txt_move_to()

◆ txt_move_toline()

◆ txt_move_up()

◆ txt_new_line()

◆ txt_new_linen()

◆ txt_order_cursors()

◆ txt_pop_first()

◆ txt_pop_last()