Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / makesrna / intern / rna_packedfile.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 #include <stdlib.h>
21
22 #include "BLI_utildefines.h"
23
24 #include "DNA_packedFile_types.h"
25
26 #include "RNA_define.h"
27 #include "RNA_enum_types.h"
28
29 #include "rna_internal.h"
30
31 const EnumPropertyItem rna_enum_unpack_method_items[] = {
32         {PF_USE_LOCAL, "USE_LOCAL", 0, "Use Local File", ""},
33         {PF_WRITE_LOCAL, "WRITE_LOCAL", 0, "Write Local File (overwrite existing)", ""},
34         {PF_USE_ORIGINAL, "USE_ORIGINAL", 0, "Use Original File", ""},
35         {PF_WRITE_ORIGINAL, "WRITE_ORIGINAL", 0, "Write Original File (overwrite existing)", ""},
36         {0, NULL, 0, NULL, NULL},
37 };
38
39 #ifdef RNA_RUNTIME
40
41 static void rna_PackedImage_data_get(PointerRNA *ptr, char *value)
42 {
43         PackedFile *pf = (PackedFile *)ptr->data;
44         memcpy(value, pf->data, (size_t)pf->size);
45         value[pf->size] = '\0';
46 }
47
48 static int rna_PackedImage_data_len(PointerRNA *ptr)
49 {
50         PackedFile *pf = (PackedFile *)ptr->data;
51         return pf->size;  /* No need to include trailing NULL char here! */
52 }
53
54 #else
55
56 void RNA_def_packedfile(BlenderRNA *brna)
57 {
58         StructRNA *srna;
59         PropertyRNA *prop;
60
61         srna = RNA_def_struct(brna, "PackedFile", NULL);
62         RNA_def_struct_ui_text(srna, "Packed File", "External file packed into the .blend file");
63
64         prop = RNA_def_property(srna, "size", PROP_INT, PROP_NONE);
65         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
66         RNA_def_property_ui_text(prop, "Size", "Size of packed file in bytes");
67
68         prop = RNA_def_property(srna, "data", PROP_STRING, PROP_BYTESTRING);
69         RNA_def_property_string_funcs(prop, "rna_PackedImage_data_get", "rna_PackedImage_data_len", NULL);
70         RNA_def_property_ui_text(prop, "Data", "Raw data (bytes, exact content of the embedded file)");
71         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
72 }
73
74 #endif