diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-09 12:01:44 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-09 12:01:44 +0300 |
commit | 9e365069afe156f33fadfad9705e1325f894cd54 (patch) | |
tree | 78373044d029feb51f987b45208e0c1a36958625 /source/blender/blenlib/BLI_expr_pylike_eval.h | |
parent | d8b42751625c915113b64f5a2d9c72f19f009fee (diff) |
Cleanup: move public doc-strings into headers for 'blenlib'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.
Ref T92709
Diffstat (limited to 'source/blender/blenlib/BLI_expr_pylike_eval.h')
-rw-r--r-- | source/blender/blenlib/BLI_expr_pylike_eval.h | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/source/blender/blenlib/BLI_expr_pylike_eval.h b/source/blender/blenlib/BLI_expr_pylike_eval.h index c074b5d8130..dccb1863b4b 100644 --- a/source/blender/blenlib/BLI_expr_pylike_eval.h +++ b/source/blender/blenlib/BLI_expr_pylike_eval.h @@ -41,13 +41,35 @@ typedef enum eExprPyLike_EvalStatus { EXPR_PYLIKE_FATAL_ERROR, } eExprPyLike_EvalStatus; +/** + * Free the parsed data; NULL argument is ok. + */ void BLI_expr_pylike_free(struct ExprPyLike_Parsed *expr); +/** + * Check if the parsing result is valid for evaluation. + */ bool BLI_expr_pylike_is_valid(struct ExprPyLike_Parsed *expr); +/** + * Check if the parsed expression always evaluates to the same value. + */ bool BLI_expr_pylike_is_constant(struct ExprPyLike_Parsed *expr); +/** + * Check if the parsed expression uses the parameter with the given index. + */ bool BLI_expr_pylike_is_using_param(struct ExprPyLike_Parsed *expr, int index); +/** + * Compile the expression and return the result. + * + * Parse the expression for evaluation later. + * Returns non-NULL even on failure; use is_valid to check. + */ ExprPyLike_Parsed *BLI_expr_pylike_parse(const char *expression, const char **param_names, int param_names_len); +/** + * Evaluate the expression with the given parameters. + * The order and number of parameters must match the names given to parse. + */ eExprPyLike_EvalStatus BLI_expr_pylike_eval(struct ExprPyLike_Parsed *expr, const double *param_values, int param_values_len, |