efd38cac232140548dbdb19950efb580a6281f96
[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                    free_text               (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*    copy_text               (struct Text *ta);
53 void                    unlink_text             (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(char *str, int offset);
64 int             txt_utf8_index_to_offset(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 int     setcurr_tab_spaces      (struct Text *text, int space);
100
101 void    txt_add_marker                                          (struct Text *text, struct TextLine *line, int start, int end, const unsigned char color[4], int group, int flags);
102 short   txt_clear_marker_region                         (struct Text *text, struct TextLine *line, int start, int end, int group, int flags);
103 short   txt_clear_markers                                       (struct Text *text, int group, int flags);
104 struct TextMarker       *txt_find_marker                (struct Text *text, struct TextLine *line, int curs, int group, int flags);
105 struct TextMarker       *txt_find_marker_region (struct Text *text, struct TextLine *line, int start, int end, int group, int flags);
106 struct TextMarker       *txt_prev_marker                (struct Text *text, struct TextMarker *marker);
107 struct TextMarker       *txt_next_marker                (struct Text *text, struct TextMarker *marker);
108
109 /* utility functions, could be moved somewhere more generic but are python/text related  */
110 int text_check_bracket(char ch);
111 int text_check_delim(char ch);
112 int text_check_digit(char ch);
113 int text_check_identifier(char ch);
114 int text_check_whitespace(char ch);
115
116
117 /* Undo opcodes */
118
119 /* Simple main cursor movement */
120 #define UNDO_CLEFT              001
121 #define UNDO_CRIGHT             002
122 #define UNDO_CUP                003
123 #define UNDO_CDOWN              004
124
125 /* Simple selection cursor movement */
126 #define UNDO_SLEFT              005
127 #define UNDO_SRIGHT             006
128 #define UNDO_SUP                007
129 #define UNDO_SDOWN              010
130
131 /* Complex movement (opcode is followed
132  * by 4 character line ID + a 2 character
133  * position ID and opcode (repeat)) */
134 #define UNDO_CTO                011
135 #define UNDO_STO                012
136
137 /* Complex editing */
138 /* 1 - opcode is followed by 1 byte for ascii character and opcode (repeat)) */
139 /* 2 - opcode is followed by 2 bytes for utf-8 character and opcode (repeat)) */
140 /* 3 - opcode is followed by 3 bytes for utf-8 character and opcode (repeat)) */
141 /* 4 - opcode is followed by 4 bytes for unicode character and opcode (repeat)) */
142 #define UNDO_INSERT_1   013
143 #define UNDO_INSERT_2   014
144 #define UNDO_INSERT_3   015
145 #define UNDO_INSERT_4   016
146
147 #define UNDO_BS_1       017
148 #define UNDO_BS_2       020
149 #define UNDO_BS_3       021
150 #define UNDO_BS_4       022
151
152 #define UNDO_DEL_1      023
153 #define UNDO_DEL_2      024
154 #define UNDO_DEL_3      025
155 #define UNDO_DEL_4      026
156
157 /* Text block (opcode is followed
158  * by 4 character length ID + the text
159  * block itself + the 4 character length
160  * ID (repeat) and opcode (repeat)) */
161 #define UNDO_DBLOCK     027 /* Delete block */
162 #define UNDO_IBLOCK     030 /* Insert block */
163
164 /* Misc */
165 #define UNDO_SWAP       031     /* Swap cursors */
166
167 #define UNDO_INDENT     032
168 #define UNDO_UNINDENT   033
169 #define UNDO_COMMENT    034
170 #define UNDO_UNCOMMENT  035
171
172 /* Marker flags */
173 #define TMARK_TEMP              0x01    /* Remove on non-editing events, don't save */
174 #define TMARK_EDITALL   0x02    /* Edit all markers of the same group as one */
175
176 #ifdef __cplusplus
177 }
178 #endif
179
180 #endif