code cleanup: function naming, use BKE_*type* prefix.
[blender.git] / source / blender / blenkernel / BKE_text.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_TEXT_H__
28 #define __BKE_TEXT_H__
29
30 /** \file BKE_text.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct Main;
41 struct Text;
42 struct TextLine;
43 struct SpaceText;
44
45 void                    BKE_text_free           (struct Text *text);
46 void                    txt_set_undostate       (int u);
47 int                     txt_get_undostate       (void);
48 struct Text*    add_empty_text  (const char *name);
49 int                             txt_extended_ascii_as_utf8(char **str);
50 int                             reopen_text             (struct Text *text);
51 struct Text*    add_text                (const char *file, const char *relpath); 
52 struct Text*    BKE_text_copy           (struct Text *ta);
53 void                    BKE_text_unlink         (struct Main *bmain, struct Text *text);
54 void                    clear_text(struct Text *text);
55 void                    write_text(struct Text *text, const char *str);
56
57 char*   txt_to_buf                      (struct Text *text);
58 void    txt_clean_text          (struct Text *text);
59 void    txt_order_cursors       (struct Text *text);
60 int             txt_find_string         (struct Text *text, const char *findstr, int wrap, int match_case);
61 int             txt_has_sel                     (struct Text *text);
62 int             txt_get_span            (struct TextLine *from, struct TextLine *to);
63 int             txt_utf8_offset_to_index(const char *str, int offset);
64 int             txt_utf8_index_to_offset(const char *str, int index);
65 void    txt_move_up                     (struct Text *text, short sel);
66 void    txt_move_down           (struct Text *text, short sel);
67 void    txt_move_left           (struct Text *text, short sel);
68 void    txt_move_right          (struct Text *text, short sel);
69 void    txt_jump_left           (struct Text *text, short sel);
70 void    txt_jump_right          (struct Text *text, short sel);
71 void    txt_move_bof            (struct Text *text, short sel);
72 void    txt_move_eof            (struct Text *text, short sel);
73 void    txt_move_bol            (struct Text *text, short sel);
74 void    txt_move_eol            (struct Text *text, short sel);
75 void    txt_move_toline         (struct Text *text, unsigned int line, short sel);
76 void    txt_move_to                     (struct Text *text, unsigned int line, unsigned int ch, short sel);
77 void    txt_pop_sel                     (struct Text *text);
78 void    txt_delete_char         (struct Text *text);
79 void    txt_delete_word         (struct Text *text);
80 void    txt_delete_selected     (struct Text *text);
81 void    txt_sel_all                     (struct Text *text);
82 void    txt_sel_line            (struct Text *text);
83 char*   txt_sel_to_buf          (struct Text *text);
84 void    txt_insert_buf          (struct Text *text, const char *in_buffer);
85 void    txt_print_undo          (struct Text *text);
86 void    txt_undo_add_toop       (struct Text *text, int op, unsigned int froml, unsigned short fromc, unsigned int tol, unsigned short toc);
87 void    txt_do_undo                     (struct Text *text);
88 void    txt_do_redo                     (struct Text *text);
89 void    txt_split_curline       (struct Text *text);
90 void    txt_backspace_char      (struct Text *text);
91 void    txt_backspace_word      (struct Text *text);
92 int             txt_add_char            (struct Text *text, unsigned int add);
93 int             txt_add_raw_char        (struct Text *text, unsigned int add);
94 int             txt_replace_char        (struct Text *text, unsigned int add);
95 void    txt_unindent            (struct Text *text);
96 void    txt_comment                     (struct Text *text);
97 void    txt_indent                      (struct Text *text);
98 void    txt_uncomment           (struct Text *text);
99 void    txt_move_lines          (struct Text *text, const int direction);
100 void    txt_duplicate_line      (struct Text *text);
101 int     setcurr_tab_spaces      (struct Text *text, int space);
102
103 void    txt_add_marker                                          (struct Text *text, struct TextLine *line, int start, int end, const unsigned char color[4], int group, int flags);
104 short   txt_clear_marker_region                         (struct Text *text, struct TextLine *line, int start, int end, int group, int flags);
105 short   txt_clear_markers                                       (struct Text *text, int group, int flags);
106 struct TextMarker       *txt_find_marker                (struct Text *text, struct TextLine *line, int curs, int group, int flags);
107 struct TextMarker       *txt_find_marker_region (struct Text *text, struct TextLine *line, int start, int end, int group, int flags);
108 struct TextMarker       *txt_prev_marker                (struct Text *text, struct TextMarker *marker);
109 struct TextMarker       *txt_next_marker                (struct Text *text, struct TextMarker *marker);
110
111 /* utility functions, could be moved somewhere more generic but are python/text related  */
112 int text_check_bracket(const char ch);
113 int text_check_delim(const char ch);
114 int text_check_digit(const char ch);
115 int text_check_identifier(const char ch);
116 int text_check_whitespace(const char ch);
117
118 enum {
119         TXT_MOVE_LINE_UP   = -1,
120         TXT_MOVE_LINE_DOWN =  1
121 };
122
123
124 /* Undo opcodes */
125
126 /* Simple main cursor movement */
127 #define UNDO_CLEFT              001
128 #define UNDO_CRIGHT             002
129 #define UNDO_CUP                003
130 #define UNDO_CDOWN              004
131
132 /* Simple selection cursor movement */
133 #define UNDO_SLEFT              005
134 #define UNDO_SRIGHT             006
135 #define UNDO_SUP                007
136 #define UNDO_SDOWN              010
137
138 /* Complex movement (opcode is followed
139  * by 4 character line ID + a 2 character
140  * position ID and opcode (repeat)) */
141 #define UNDO_CTO                011
142 #define UNDO_STO                012
143
144 /* Complex editing */
145 /* 1 - opcode is followed by 1 byte for ascii character and opcode (repeat)) */
146 /* 2 - opcode is followed by 2 bytes for utf-8 character and opcode (repeat)) */
147 /* 3 - opcode is followed by 3 bytes for utf-8 character and opcode (repeat)) */
148 /* 4 - opcode is followed by 4 bytes for unicode character and opcode (repeat)) */
149 #define UNDO_INSERT_1   013
150 #define UNDO_INSERT_2   014
151 #define UNDO_INSERT_3   015
152 #define UNDO_INSERT_4   016
153
154 #define UNDO_BS_1       017
155 #define UNDO_BS_2       020
156 #define UNDO_BS_3       021
157 #define UNDO_BS_4       022
158
159 #define UNDO_DEL_1      023
160 #define UNDO_DEL_2      024
161 #define UNDO_DEL_3      025
162 #define UNDO_DEL_4      026
163
164 /* Text block (opcode is followed
165  * by 4 character length ID + the text
166  * block itself + the 4 character length
167  * ID (repeat) and opcode (repeat)) */
168 #define UNDO_DBLOCK     027 /* Delete block */
169 #define UNDO_IBLOCK     030 /* Insert block */
170
171 /* Misc */
172 #define UNDO_SWAP       031     /* Swap cursors */
173
174 #define UNDO_INDENT     032
175 #define UNDO_UNINDENT   033
176 #define UNDO_COMMENT    034
177 #define UNDO_UNCOMMENT  035
178
179 #define UNDO_MOVE_LINES_UP      036
180 #define UNDO_MOVE_LINES_DOWN    037
181
182 #define UNDO_DUPLICATE  040
183
184 /* Marker flags */
185 #define TMARK_TEMP              0x01    /* Remove on non-editing events, don't save */
186 #define TMARK_EDITALL   0x02    /* Edit all markers of the same group as one */
187
188 #ifdef __cplusplus
189 }
190 #endif
191
192 #endif