archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity
This repository has been archived on 2023-10-09. You can view files and clone it, but cannot push or open issues or pull requests.
Files
dbccbc51fb874b6c0f32c7bf207c208fa98b3f52
blender-archive/source/blender/blenkernel/BKE_text.h

133 lines
6.0 KiB
C++
Raw Normal View History

doxygen: blenkernel under core as module.
2011-02-18 13:05:18 +00:00
/*
Initial revision
2002-10-12 11:37:38 +00:00
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
Patch from GSR that a) fixes a whole bunch of GPL/BL license blocks that were previously missed; and b) greatly increase my ohloh stats!
2008-04-16 22:40:48 +00:00
* of the License, or (at your option) any later version.
Initial revision
2002-10-12 11:37:38 +00:00
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
correct fsf address
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Initial revision
2002-10-12 11:37:38 +00:00
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*/
unify include guard defines, __$FILENAME__ without the underscores these clogged up the namespace for autocompleation which was annoying.
2012-02-17 18:59:41 +00:00
#ifndef __BKE_TEXT_H__
#define __BKE_TEXT_H__
Initial revision
2002-10-12 11:37:38 +00:00
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it.
2019-02-18 08:08:12 +11:00
/** \file
* \ingroup bke
doxygen: blenkernel under core as module.
2011-02-18 13:05:18 +00:00
*/
Initial revision
2002-10-12 11:37:38 +00:00
#ifdef __cplusplus
extern "C" {
#endif
2.5 Make local and make single user are back for ID template. Internally these calls got unified, id_make_local and id_copy are now used to do these operations for all types that support it. Also reveals that for some ID types the implementation is still missing. Further, some small changes: * unlink_text is now in blenkernel. * copy_group was implemented. * ID template now has an open operator again. * fix preview to not change material reference count, even if temporary it shows up with threaded preview. * id_unlink unifies unlink for text, object and group.
2009-09-04 21:02:43 +00:00
struct Main;
Initial revision
2002-10-12 11:37:38 +00:00
struct Text;
struct TextLine;
Undo: split text undo steps out of the data-block This moves undo storage into a separate struct which is passed in from the undo system.
2018-04-05 15:22:33 +02:00
struct TextUndoBuf;
Initial revision
2002-10-12 11:37:38 +00:00
BLI_storage: util function BLI_file_read_as_mem Use for text loading and pasting from file.
2015-12-14 17:12:16 +11:00
void BKE_text_free_lines (struct Text *text);
code cleanup: function naming, use BKE_*type* prefix.
2012-05-05 14:03:12 +00:00
void BKE_text_free (struct Text *text);
First step to handle missing libs/datablocks when reading a file. Idea is, instead of ignoring completely missing linked datablocks, to create void placeholders for them. That way, you can work on your file, save it, and find again your missing data once lib becomes available again. Or you can edit missing lib's path (in Outliner), save and reload the file, and you are done. Also, Outliner now shows broken libraries (and placeholders) with a 'broken lib' icon. Future plans are also to be able to relocate missing libs and reload them at runtime. Code notes: - Placeholder ID is just a regular datablock of same type as expected linked one, with 'default' data, and a LIB_MISSING bitflag set. - To allow creation of such datablocks, creation of datablocks in BKE was split in two step: + Allocation of memory itself. + Setting of all internal data to default values. See also the design task (T43351). Reviewed by @campbellbarton, thanks a bunch! Differential Revision: https://developer.blender.org/D1394
2015-10-20 14:44:57 +02:00
void BKE_text_init(struct Text *ta);
style cleanup: odd indentation
2013-03-14 05:52:30 +00:00
struct Text *BKE_text_add (struct Main *bmain, const char *name);
Whitespace tabs vs. spaces consistency changes
2012-01-17 17:26:58 +00:00
int txt_extended_ascii_as_utf8(char **str);
Check ftell return values
2015-06-05 11:46:01 +10:00
bool BKE_text_reload(struct Text *text);
Better API design for making text datablocks after loading. An optional 'internal' argument was added to the bpy.data.texts.load() operator. The changes in revision 57153 were reverted, so that the is_in_memory and is_dirty properties of text datablocks are not editable again. In the C API layer, BKE_text_load_ex() was introduced to allow for optionally making text datablocks internal after loading.
2013-06-02 17:52:06 +00:00
struct Text *BKE_text_load_ex(struct Main *bmain, const char *file, const char *relpath,
const bool is_internal);
style cleanup: odd indentation
2013-03-14 05:52:30 +00:00
struct Text *BKE_text_load (struct Main *bmain, const char *file, const char *relpath);
Refactor ID copying (and to some extent, ID freeing). This will allow much finer controll over how we copy data-blocks, from full copy in Main database, to "lighter" ones (out of Main, inside an already allocated datablock, etc.). This commit also transfers a llot of what was previously handled by per-ID-type custom code to generic ID handling code in BKE_library. Hopefully will avoid in future inconsistencies and missing bits we had all over the codebase in the past. It also adds missing copying handling for a few types, most notably Scene (which where using a fully customized handling previously). Note that the type of allocation used during copying (regular in Main, allocated but outside of Main, or not allocated by ID handling code at all) is stored in ID's, which allows to handle them correctly when freeing. This needs to be taken care of with caution when doing 'weird' unusual things with ID copying and/or allocation! As a final note, while rather noisy, this commit will hopefully not break too much existing branches, old 'API' has been kept for the main part, as a wrapper around new code. Cleaning it up will happen later. Design task : T51804 Phab Diff: D2714
2017-08-07 16:39:55 +02:00
void BKE_text_copy_data(struct Main *bmain, struct Text *ta_dst, const struct Text *ta_src, const int flag);
Make whole ID copying code use const source pointer. Noisy change, but safe, and better do it sooner than later if we are to rework copying code. Also, previous commit shows this *is* useful to catch some mistakes.
2017-06-14 22:36:30 +02:00
struct Text *BKE_text_copy (struct Main *bmain, const struct Text *ta);
Fix missing datablocks types in id_make_local. Adding make_local for vfont/gpencil/group/freestyle linestyle/mask/scene/sound/text. Note that there are still some lose ends here, since some type are not handled by id_copy (Scene, Sound and VFont), which means in case a datablock of that type is used both directly and indirectly, localization will fail. Scene copying might be doable though (maybe with a simple new 'full shalow' mode to existing BKE_scene_copy?), not sure about sounds and vfonts... Situations where this becomes an issue should be very rare corner cases anyway.
2016-07-21 16:09:08 +02:00
void BKE_text_make_local (struct Main *bmain, struct Text *text, const bool lib_local);
Undo: split text undo steps out of the data-block This moves undo storage into a separate struct which is passed in from the undo system.
2018-04-05 15:22:33 +02:00
void BKE_text_clear (struct Text *text, struct TextUndoBuf *utxt);
void BKE_text_write (struct Text *text, struct TextUndoBuf *utxt, const char *str);
Use includes for blenderplayer stubs exposes many incorrect and redundant stubs
2014-01-28 01:55:10 +11:00
int BKE_text_file_modified_check(struct Text *text);
void BKE_text_file_modified_ignore(struct Text *text);
Initial revision
2002-10-12 11:37:38 +00:00
style cleanup: odd indentation
2013-03-14 05:52:30 +00:00
char *txt_to_buf (struct Text *text);
Initial revision
2002-10-12 11:37:38 +00:00
void txt_clean_text (struct Text *text);
text editor cursor motion (left/right arrows) with selected text typically jumps to either side of the selection previously the cursor would move and loose the selection too. text button fields already did this.
2013-09-02 00:47:27 +00:00
void txt_order_cursors (struct Text *text, const bool reverse);
use (const char*) rather than (char*) where possible. also removed some unused function definitons.
2011-11-05 11:04:28 +00:00
int txt_find_string (struct Text *text, const char *findstr, int wrap, int match_case);
Code cleanup: use bools where possible
2014-02-03 18:55:59 +11:00
bool txt_has_sel (struct Text *text);
Initial revision
2002-10-12 11:37:38 +00:00
int txt_get_span (struct TextLine *from, struct TextLine *to);
update python keywords (remove exec, print, add nonlocal)
2012-04-06 05:53:01 +00:00
int txt_utf8_offset_to_index(const char *str, int offset);
int txt_utf8_index_to_offset(const char *str, int index);
Patch [#34373] Use i18n monospace font in Text editor and Python console This patch allows Blender to display i18n monospace font in the text editor and the Python interactive console. Wide characters that occupy multiple columns such as CJK characters can be displayed correctly. Furthermore, wrapping, selection, suggestion, cursor drawing, and syntax highlighting should work. Also fixes a bug [#34543]: In Text Editor false color in comment on cyrillic To estimate how many columns each character occupies, this patch uses wcwidth.c written by Markus Kuhn and distributed under MIT-style license: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c wcwidth.c is stored in extern/wcwidth and used as a static library. This patch adds new API to blenfont, blenlib and blenkernel: BLF_get_unifont_mono() BLF_free_unifont_mono() BLF_draw_mono() BLI_wcwidth() BLI_wcswidth() BLI_str_utf8_char_width() BLI_str_utf8_char_width_safe() txt_utf8_offset_to_column() txt_utf8_column_to_offset()
2013-03-12 07:25:53 +00:00
int txt_utf8_offset_to_column(const char *str, int offset);
int txt_utf8_column_to_offset(const char *str, int column);
UI: Use bool rather then int/short's where possible
2014-01-04 17:16:19 +11:00
void txt_move_up (struct Text *text, const bool sel);
void txt_move_down (struct Text *text, const bool sel);
void txt_move_left (struct Text *text, const bool sel);
void txt_move_right (struct Text *text, const bool sel);
void txt_jump_left (struct Text *text, const bool sel, const bool use_init_step);
void txt_jump_right (struct Text *text, const bool sel, const bool use_init_step);
void txt_move_bof (struct Text *text, const bool sel);
void txt_move_eof (struct Text *text, const bool sel);
void txt_move_bol (struct Text *text, const bool sel);
void txt_move_eol (struct Text *text, const bool sel);
void txt_move_toline (struct Text *text, unsigned int line, const bool sel);
void txt_move_to (struct Text *text, unsigned int line, unsigned int ch, const bool sel);
Initial revision
2002-10-12 11:37:38 +00:00
void txt_pop_sel (struct Text *text);
Undo: split text undo steps out of the data-block This moves undo storage into a separate struct which is passed in from the undo system.
2018-04-05 15:22:33 +02:00
void txt_delete_char (struct Text *text, struct TextUndoBuf *utxt);
void txt_delete_word (struct Text *text, struct TextUndoBuf *utxt);
void txt_delete_selected (struct Text *text, struct TextUndoBuf *utxt);
Initial revision
2002-10-12 11:37:38 +00:00
void txt_sel_all (struct Text *text);
Fix Text editor home/end keys when theres a selection
2014-08-29 14:52:23 +10:00
void txt_sel_clear (struct Text *text);
Initial revision
2002-10-12 11:37:38 +00:00
void txt_sel_line (struct Text *text);
style cleanup: odd indentation
2013-03-14 05:52:30 +00:00
char *txt_sel_to_buf (struct Text *text);
Undo: split text undo steps out of the data-block This moves undo storage into a separate struct which is passed in from the undo system.
2018-04-05 15:22:33 +02:00
void txt_insert_buf (struct Text *text, struct TextUndoBuf *utxt, const char *in_buffer);
void txt_undo_add_op (struct Text *text, struct TextUndoBuf *utxt, int op);
void txt_do_undo (struct Text *text, struct TextUndoBuf *utxt);
void txt_do_redo (struct Text *text, struct TextUndoBuf *utxt);
void txt_split_curline (struct Text *text, struct TextUndoBuf *utxt);
void txt_backspace_char (struct Text *text, struct TextUndoBuf *utxt);
void txt_backspace_word (struct Text *text, struct TextUndoBuf *utxt);
bool txt_add_char (struct Text *text, struct TextUndoBuf *utxt, unsigned int add);
bool txt_add_raw_char (struct Text *text, struct TextUndoBuf *utxt, unsigned int add);
bool txt_replace_char (struct Text *text, struct TextUndoBuf *utxt, unsigned int add);
void txt_unindent (struct Text *text, struct TextUndoBuf *utxt);
void txt_comment (struct Text *text, struct TextUndoBuf *utxt);
void txt_indent (struct Text *text, struct TextUndoBuf *utxt);
void txt_uncomment (struct Text *text, struct TextUndoBuf *utxt);
void txt_move_lines (struct Text *text, struct TextUndoBuf *utxt, const int direction);
void txt_duplicate_line (struct Text *text, struct TextUndoBuf *utxt);
style cleanup: odd indentation
2013-03-14 05:52:30 +00:00
int txt_setcurr_tab_spaces(struct Text *text, int space);
holding ctrl when using arrow keys in the text editor didn't navigate newlines.
2013-05-01 00:15:22 +00:00
bool txt_cursor_is_line_start(struct Text *text);
bool txt_cursor_is_line_end(struct Text *text);
Text Markers: multiple, coloured selections within a Text object with group relationships. They allow portions of text to be edited as one and enable quick jumping between and editing of different areas. Flags control the behaviour and grouping of markers. At present, Ctrl+M places a marker with TMARK_EDITALL set for testing purposes. I have also split the text area event handler into separate methods for marker handling and the existing text tools. This makes the events system much easier to follow as it was getting a little hairy.
2008-08-04 23:01:47 +00:00
Text Editor: Auto indent for backspace/delete Editing with spaces + auto-indent didn't delete indentation as expected.
2016-03-11 00:04:13 +11:00
int txt_calc_tab_left(struct TextLine *line, int ch);
int txt_calc_tab_right(struct TextLine *line, int ch);
PyConsole improvements - Commands from the history wont get modified in-place when you cycle back and re-use them. - Ctrl Left/Right skip words. - Autocompletion on a variable that has no alternatives adds a '.' 'bpy' -> 'bpy.', generally more useful since autocomp again will give the members of bpy also moved text_check_* functions into BKE_text.h for the console to access.
2009-09-22 16:23:46 +00:00
/* utility functions, could be moved somewhere more generic but are python/text related */
Code cleanup: use bools where possible
2014-02-03 18:55:59 +11:00
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);
bool text_check_whitespace(const char ch);
int text_find_identifier_start(const char *str, int i);
PyConsole improvements - Commands from the history wont get modified in-place when you cycle back and re-use them. - Ctrl Left/Right skip words. - Autocompletion on a variable that has no alternatives adds a '.' 'bpy' -> 'bpy.', generally more useful since autocomp again will give the members of bpy also moved text_check_* functions into BKE_text.h for the console to access.
2009-09-22 16:23:46 +00:00
fix [#34275] Text autocomplete cuts words with accents or special characters autocomplete is now unicode aware, using python api's checks for now. eventually we should have our own.
2013-02-19 16:13:41 +00:00
/* defined in bpy_interface.c */
extern int text_check_identifier_unicode(const unsigned int ch);
extern int text_check_identifier_nodigit_unicode(const unsigned int ch);
make text move up/down into a single operator with a direction property
2012-05-04 16:17:09 +00:00
enum {
TXT_MOVE_LINE_UP = -1,
Cleanup: commas at the end of enums Without this clang-format may wrap them onto a single line.
2019-01-15 23:57:49 +11:00
TXT_MOVE_LINE_DOWN = 1,
make text move up/down into a single operator with a direction property
2012-05-04 16:17:09 +00:00
};
Undo: split text undo steps out of the data-block This moves undo storage into a separate struct which is passed in from the undo system.
2018-04-05 15:22:33 +02:00
typedef struct TextUndoBuf {
char *buf;
int pos, len;
} TextUndoBuf;
Initial revision
2002-10-12 11:37:38 +00:00
#ifdef __cplusplus
}
#endif
#endif
Copy Permalink