Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_expr_pylike_eval.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) 2018 Blender Foundation, Alexander Gavrilov
19  * All rights reserved.
20  *
21  * Contributor(s): Alexander Gavrilov
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BLI_EXPR_PYLIKE_EVAL_H__
27 #define __BLI_EXPR_PYLIKE_EVAL_H__
28
29 /** \file BLI_expr_pylike_eval.h
30  *  \ingroup bli
31  */
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 /** Opaque structure containing pre-parsed data for evaluation. */
38 typedef struct ExprPyLike_Parsed ExprPyLike_Parsed;
39
40 /** Expression evaluation return code. */
41 typedef enum eExprPyLike_EvalStatus {
42         EXPR_PYLIKE_SUCCESS = 0,
43         /* Computation errors; result is still set, but may be NaN */
44         EXPR_PYLIKE_DIV_BY_ZERO,
45         EXPR_PYLIKE_MATH_ERROR,
46         /* Expression dependent errors or bugs; result is 0 */
47         EXPR_PYLIKE_INVALID,
48         EXPR_PYLIKE_FATAL_ERROR,
49 } eExprPyLike_EvalStatus;
50
51 void BLI_expr_pylike_free(struct ExprPyLike_Parsed *expr);
52 bool BLI_expr_pylike_is_valid(struct ExprPyLike_Parsed *expr);
53 bool BLI_expr_pylike_is_constant(struct ExprPyLike_Parsed *expr);
54 ExprPyLike_Parsed *BLI_expr_pylike_parse(
55         const char *expression,
56         const char **param_names, int param_names_len);
57 eExprPyLike_EvalStatus BLI_expr_pylike_eval(
58         struct ExprPyLike_Parsed *expr,
59         const double *param_values, int param_values_len,
60         double *r_result);
61
62 #ifdef __cplusplus
63 }
64 #endif
65
66 #endif /* __BLI_EXPR_PYLIKE_EVAL_H__ */