python api for ID property access by Joseph Eager, copied from blender 2.4x.
[blender.git] / source / blender / makesrna / intern / rna_image_api.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Arystanbek Dyussenov
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <string.h>
32 #include <time.h>
33
34 #include "RNA_define.h"
35 #include "RNA_types.h"
36
37 #ifdef RNA_RUNTIME
38
39 #include "BKE_image.h"
40 #include "BKE_main.h"
41 #include "BKE_utildefines.h"
42
43 #include "DNA_image_types.h"
44 #include "DNA_scene_types.h"
45
46 #include "MEM_guardedalloc.h"
47
48 /*
49   User should check if returned path exists before copying a file there.
50
51   TODO: it would be better to return a (abs, rel) tuple.
52 */
53 static char *rna_Image_get_export_path(Image *image, char *dest_dir, int rel)
54 {
55         int length = FILE_MAX;
56         char *path= MEM_callocN(length, "image file path");
57
58         if (!BKE_get_image_export_path(image, dest_dir, rel ? NULL : path, length, rel ? path : NULL, length )) {
59                 MEM_freeN(path);
60                 return NULL;
61         }
62
63         return path;
64 }
65
66 char *rna_Image_get_abs_filename(Image *image, bContext *C)
67 {
68         char *filename= MEM_callocN(FILE_MAX, "Image.get_abs_filename()");
69
70         BLI_strncpy(filename, image->name, FILE_MAXDIR + FILE_MAXFILE);
71         BLI_convertstringcode(filename, CTX_data_main(C)->name);
72         BLI_convertstringframe(filename, CTX_data_scene(C)->r.cfra);
73
74         return filename;
75 }
76
77 #else
78
79 void RNA_api_image(StructRNA *srna)
80 {
81         FunctionRNA *func;
82         PropertyRNA *parm;
83
84         func= RNA_def_function(srna, "get_export_path", "rna_Image_get_export_path");
85         RNA_def_function_ui_description(func, "Produce image export path.");
86         parm= RNA_def_string(func, "dest_dir", "", 0, "", "Destination directory.");
87         RNA_def_property_flag(parm, PROP_REQUIRED);
88         parm= RNA_def_boolean(func, "get_rel_path", 1, "", "Return relative path if True.");
89         RNA_def_property_flag(parm, PROP_REQUIRED);
90         parm= RNA_def_string(func, "path", "", 0, "", "Absolute export path.");
91         RNA_def_function_return(func, parm);
92
93         func= RNA_def_function(srna, "get_abs_filename", "rna_Image_get_abs_filename");
94         RNA_def_function_ui_description(func, "Get absolute filename.");
95         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
96         parm= RNA_def_string_file_path(func, "abs_filename", NULL, 0, "", "Image/movie absolute filename.");
97         RNA_def_function_return(func, parm);
98 }
99
100 #endif
101