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