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