small edits to text editor from writing a python editor extension.
[blender.git] / source / blender / makesrna / intern / rna_text.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2008)
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26 #include <limits.h>
27
28 #include "MEM_guardedalloc.h"
29
30 #include "BKE_text.h"
31
32 #include "RNA_define.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_text_types.h"
37
38 #include "WM_types.h"
39
40 #ifdef RNA_RUNTIME
41
42 int text_file_modified(Text *text);
43
44 static void rna_Text_filename_get(PointerRNA *ptr, char *value)
45 {
46         Text *text= (Text*)ptr->data;
47
48         if(text->name)
49                 strcpy(value, text->name);
50         else
51                 strcpy(value, "");
52 }
53
54 static int rna_Text_filename_length(PointerRNA *ptr)
55 {
56         Text *text= (Text*)ptr->data;
57         return (text->name)? strlen(text->name): 0;
58 }
59
60 static void rna_Text_filename_set(PointerRNA *ptr, const char *value)
61 {
62         Text *text= (Text*)ptr->data;
63
64         if(text->name)
65                 MEM_freeN(text->name);
66
67         if(strlen(value))
68                 text->name= BLI_strdup(value);
69         else
70                 text->name= NULL;
71 }
72
73 static int rna_Text_modified_get(PointerRNA *ptr)
74 {
75         Text *text= (Text*)ptr->data;
76         return text_file_modified(text);
77 }
78
79 static void rna_TextLine_body_get(PointerRNA *ptr, char *value)
80 {
81         TextLine *line= (TextLine*)ptr->data;
82
83         if(line->line)
84                 strcpy(value, line->line);
85         else
86                 strcpy(value, "");
87 }
88
89 static int rna_TextLine_body_length(PointerRNA *ptr)
90 {
91         TextLine *line= (TextLine*)ptr->data;
92         return line->len;
93 }
94
95 static void rna_TextLine_body_set(PointerRNA *ptr, const char *value)
96 {
97         TextLine *line= (TextLine*)ptr->data;
98         int len= strlen(value);
99
100         if(line->line)
101                 MEM_freeN(line->line);
102
103         line->line= MEM_mallocN((len + 1) * sizeof(char), "rna_text_body");
104         line->len= len;
105         memcpy(line->line, value, len + 1);
106
107         if(line->format) {
108                 MEM_freeN(line->format);
109                 line->format= NULL;
110         }
111 }
112
113 #else
114
115 static void rna_def_text_line(BlenderRNA *brna)
116 {
117         StructRNA *srna;
118         PropertyRNA *prop;
119         
120         srna = RNA_def_struct(brna, "TextLine", NULL);
121         RNA_def_struct_ui_text(srna, "Text Line", "Line of text in a Text datablock");
122         
123         prop= RNA_def_property(srna, "body", PROP_STRING, PROP_NONE);
124         RNA_def_property_string_funcs(prop, "rna_TextLine_body_get", "rna_TextLine_body_length", "rna_TextLine_body_set");
125         RNA_def_property_ui_text(prop, "Line", "Text in the line");
126         RNA_def_property_update(prop, NC_TEXT|NA_EDITED, NULL);
127 }
128
129 static void rna_def_text_marker(BlenderRNA *brna)
130 {
131         StructRNA *srna;
132         PropertyRNA *prop;
133         
134         srna = RNA_def_struct(brna, "TextMarker", NULL);
135         RNA_def_struct_ui_text(srna, "Text Marker", "Marker highlighting a portion of text in a Text datablock");
136
137         prop= RNA_def_property(srna, "line", PROP_INT, PROP_UNSIGNED);
138         RNA_def_property_int_sdna(prop, NULL, "lineno");
139         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
140         RNA_def_property_ui_text(prop, "Line", "Line in which the marker is located");
141         
142         prop= RNA_def_property(srna, "start", PROP_INT, PROP_UNSIGNED);
143         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
144         RNA_def_property_ui_text(prop, "Start", "Start position of the marker in the line");
145
146         prop= RNA_def_property(srna, "end", PROP_INT, PROP_UNSIGNED);
147         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
148         RNA_def_property_ui_text(prop, "End", "Start position of the marker in the line");
149         
150         prop= RNA_def_property(srna, "group", PROP_INT, PROP_UNSIGNED);
151         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
152         RNA_def_property_range(prop, 0, (int)0xFFFF);
153         RNA_def_property_ui_text(prop, "Group", "");
154         
155         prop= RNA_def_property(srna, "temporary", PROP_BOOLEAN, PROP_NONE);
156         RNA_def_property_boolean_sdna(prop, NULL, "flags", TMARK_TEMP);
157         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
158         RNA_def_property_ui_text(prop, "Temporary", "Marker is temporary");
159
160         prop= RNA_def_property(srna, "edit_all", PROP_BOOLEAN, PROP_NONE);
161         RNA_def_property_boolean_sdna(prop, NULL, "flags", TMARK_EDITALL);
162         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
163         RNA_def_property_ui_text(prop, "Edit All", "Edit all markers of the same group as one");
164         
165         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
166         RNA_def_property_ui_text(prop, "Color", "Color to display the marker with");
167 }
168
169 static void rna_def_text(BlenderRNA *brna)
170 {
171         StructRNA *srna;
172         PropertyRNA *prop;
173         
174         srna = RNA_def_struct(brna, "Text", "ID");
175         RNA_def_struct_ui_text(srna, "Text", "Text datablock referencing an external or packed text file");
176         RNA_def_struct_ui_icon(srna, ICON_TEXT);
177         RNA_def_struct_clear_flag(srna, STRUCT_ID_REFCOUNT);
178         
179         prop= RNA_def_property(srna, "filepath", PROP_STRING, PROP_NONE);
180         RNA_def_property_string_funcs(prop, "rna_Text_filename_get", "rna_Text_filename_length", "rna_Text_filename_set");
181         RNA_def_property_ui_text(prop, "File Path", "Filename of the text file");
182
183         prop= RNA_def_property(srna, "dirty", PROP_BOOLEAN, PROP_NONE);
184         RNA_def_property_boolean_sdna(prop, NULL, "flags", TXT_ISDIRTY);
185         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
186         RNA_def_property_ui_text(prop, "Dirty", "Text file has been edited since last save");
187
188         prop= RNA_def_property(srna, "modified", PROP_BOOLEAN, PROP_NONE);
189         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
190         RNA_def_property_boolean_funcs(prop, "rna_Text_modified_get", NULL);
191         RNA_def_property_ui_text(prop, "Modified", "Text file on disk is different than the one in memory");
192
193         prop= RNA_def_property(srna, "memory", PROP_BOOLEAN, PROP_NONE);
194         RNA_def_property_boolean_sdna(prop, NULL, "flags", TXT_ISMEM);
195         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
196         RNA_def_property_ui_text(prop, "Memory", "Text file is in memory, without a corresponding file on disk");
197         
198         prop= RNA_def_property(srna, "use_module", PROP_BOOLEAN, PROP_NONE);
199         RNA_def_property_boolean_sdna(prop, NULL, "flags", TXT_ISSCRIPT);
200         RNA_def_property_ui_text(prop, "Register", "Register this text as a module on loading, Text name must end with \".py\"");
201
202         prop= RNA_def_property(srna, "tabs_as_spaces", PROP_BOOLEAN, PROP_NONE);
203         RNA_def_property_boolean_sdna(prop, NULL, "flags", TXT_TABSTOSPACES);
204         RNA_def_property_ui_text(prop, "Tabs as Spaces", "Automatically converts all new tabs into spaces");
205
206         prop= RNA_def_property(srna, "lines", PROP_COLLECTION, PROP_NONE);
207         RNA_def_property_struct_type(prop, "TextLine");
208         RNA_def_property_ui_text(prop, "Lines", "Lines of text");
209         
210         prop= RNA_def_property(srna, "current_line", PROP_POINTER, PROP_NONE);
211         RNA_def_property_flag(prop, PROP_NEVER_NULL);
212         RNA_def_property_pointer_sdna(prop, NULL, "curl");
213         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
214         RNA_def_property_struct_type(prop, "TextLine");
215         RNA_def_property_ui_text(prop, "Current Line", "Current line, and start line of selection if one exists");
216
217         prop= RNA_def_property(srna, "current_character", PROP_INT, PROP_UNSIGNED);
218         RNA_def_property_int_sdna(prop, NULL, "curc");
219         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
220         RNA_def_property_ui_text(prop, "Current Character", "Index of current character in current line, and also start index of character in selection if one exists");
221         
222         prop= RNA_def_property(srna, "selection_end_line", PROP_POINTER, PROP_NONE);
223         RNA_def_property_flag(prop, PROP_NEVER_NULL);
224         RNA_def_property_pointer_sdna(prop, NULL, "sell");
225         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
226         RNA_def_property_struct_type(prop, "TextLine");
227         RNA_def_property_ui_text(prop, "Selection End Line", "End line of selection");
228         
229         prop= RNA_def_property(srna, "selection_end_character", PROP_INT, PROP_UNSIGNED);
230         RNA_def_property_int_sdna(prop, NULL, "selc");
231         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
232         RNA_def_property_ui_text(prop, "Selection End Character", "Index of character after end of selection in the selection end line");
233         
234         prop= RNA_def_property(srna, "markers", PROP_COLLECTION, PROP_NONE);
235         RNA_def_property_struct_type(prop, "TextMarker");
236         RNA_def_property_ui_text(prop, "Markers", "Text markers highlighting part of the text");
237
238         RNA_api_text(srna);
239 }
240
241 void RNA_def_text(BlenderRNA *brna)
242 {
243         rna_def_text_line(brna);
244         rna_def_text_marker(brna);
245         rna_def_text(brna);
246 }
247
248 #endif