*
* An aop_dynval serves as a placeholder during compile time for a
* value that will not be known until runtime. An aop_dynval gets
- * returned by a capture function, such as aop_capture_return_value(),
- * and can be passed to an advice function inserted with
- * aop_insert_advice().
+ * returned by a capture function, such as
+ * aop_capture_call_return_value(), and can be passed to an advice
+ * function inserted with aop_insert_advice().
*
* Internally, every aop_dynval has its own type, which is determined
* by how it was captured. For example, an aop_dynval created with
- * aop_capture_return_value() will have its type set based on how the
- * corresponding pointcut was filtered using
+ * aop_capture_call_return_value() will have its type set based on how
+ * the corresponding pointcut was filtered using
* aop_filter_call_pc_by_return_type(). (It is an error to capture
* the return value of a function call when the corresponding pointcut
* was not filtered by type. You must use
- * aop_capture_return_value_by_type() instead.)
+ * aop_capture_call_return_value_by_type() instead.)
*
* At runtime, the advice function itself simply gets the captured
* value; it will never see the original aop_dynval object.
/**
* Filter a function call pointcut to only include calls to functions
* with a specified return type. Note that you must filter a pointcut
- * by return type in order to call aop_capture_return_value() on any
- * of its join points.
+ * by return type in order to call aop_capture_call_return_value() on
+ * any of its join points.
* \param pc The function call pointcut to filter. Function call
* pointcuts are created with aop_match_function_call().
* \param type The return type to filter by.
/**
* Get a dynval representing a function call's return value. Note
* that you must filter with aop_filter_call_pc_by_return_type() in
- * order to capture the return value using aop_capture_return_value().
+ * order to capture the return value using
+ * aop_capture_call_return_value().
*
* Note that it is illegal to pass the resulting aop_dynval to
* aop_insert_advice() with #AOP_INSERT_BEFORE, as that would require
* aop_filter_call_pc_by_return_type().
*/
struct aop_dynval *
-aop_capture_return_value (struct aop_joinpoint *jp)
+aop_capture_call_return_value (struct aop_joinpoint *jp)
{
struct aop_pointcut *pc;
struct aop_dynval *dv;
* NULL if the return value does not match the specified type.
*/
struct aop_dynval *
-aop_capture_return_value_by_type (struct aop_joinpoint *jp,
- const struct aop_type *type)
+aop_capture_call_return_value_by_type (struct aop_joinpoint *jp,
+ const struct aop_type *type)
{
struct aop_pointcut *pc;
struct aop_dynval *dv;
switch (dv->kind)
{
case ADV_FUN_RETVAL:
- fatal_error("(InterAspect) Attempt to capture return value in"
- " before advice (see aop_capture_return_value()"
+ fatal_error("(InterAspect) Attempt to capture return value in before"
+ " advice (see aop_capture_call_return_value()"
" documentation).");
default:
break; /* Permitted. */
const struct aop_type *type);
extern const char *aop_capture_called_function_name(struct aop_joinpoint *jp);
-extern struct aop_dynval *aop_capture_return_value (struct aop_joinpoint *jp);
-extern struct aop_dynval *aop_capture_return_value_by_type (
+extern struct aop_dynval *aop_capture_call_return_value (
+ struct aop_joinpoint *jp);
+extern struct aop_dynval *aop_capture_call_return_value_by_type (
struct aop_joinpoint *jp, const struct aop_type *type);
extern struct aop_dynval *aop_capture_call_param (struct aop_joinpoint *jp,
int param_index);