R_ext/Callbacks.h File Reference

#include <Rinternals.h>

Include dependency graph for Callbacks.h:

Go to the source code of this file.

Data Structures
struct	_ToplevelCallback
struct	_R_ObjectTable
Typedefs
typedef Rboolean(*	R_ToplevelCallback )(SEXP expr, SEXP value, Rboolean succeeded, Rboolean visible, void *)
typedef struct _ToplevelCallback	R_ToplevelCallbackEl
typedef struct _R_ObjectTable	R_ObjectTable
typedef Rboolean(*	Rdb_exists )(const char *const name, Rboolean *canCache, R_ObjectTable *)
typedef SEXP(*	Rdb_get )(const char *const name, Rboolean *canCache, R_ObjectTable *)
typedef int(*	Rdb_remove )(const char *const name, R_ObjectTable *)
typedef SEXP(*	Rdb_assign )(const char *const name, SEXP value, R_ObjectTable *)
typedef SEXP(*	Rdb_objects )(R_ObjectTable *)
typedef Rboolean(*	Rdb_canCache )(const char *const name, R_ObjectTable *)
typedef void(*	Rdb_onDetach )(R_ObjectTable *)
typedef void(*	Rdb_onAttach )(R_ObjectTable *)
Functions
Rboolean	Rf_removeTaskCallbackByIndex (int id)
Rboolean	Rf_removeTaskCallbackByName (const char *name)
SEXP	R_removeTaskCallback (SEXP which)
R_ToplevelCallbackEl *	Rf_addTaskCallback (R_ToplevelCallback cb, void *data, void(*finalizer)(void *), const char *name, int *pos)

---

Typedef Documentation

typedef struct _R_ObjectTable R_ObjectTable

typedef Rboolean(* R_ToplevelCallback)(SEXP expr, SEXP value, Rboolean succeeded, Rboolean visible, void *)

These structures are for C (and R function) top-level task handlers. Such routines are called at the end of every (successful) top-level task in the regular REPL. The signature of the C routine that a callback must implement. expr - the expression for the top-level task that was evaluated. value - the result of the top-level task, i.e. evaluating expr. succeeded - a logical value indicating whether the task completed propertly. visible - a logical value indicating whether the result was printed to the R ``console''/stdout. data - user-level data passed to the registration routine.

typedef struct _ToplevelCallback R_ToplevelCallbackEl

typedef SEXP(* Rdb_assign)(const char *const name, SEXP value, R_ObjectTable *)

typedef Rboolean(* Rdb_canCache)(const char *const name, R_ObjectTable *)

typedef Rboolean(* Rdb_exists)(const char *const name, Rboolean *canCache, R_ObjectTable *)

typedef SEXP(* Rdb_get)(const char *const name, Rboolean *canCache, R_ObjectTable *)

typedef SEXP(* Rdb_objects)(R_ObjectTable *)

typedef void(* Rdb_onAttach)(R_ObjectTable *)

typedef void(* Rdb_onDetach)(R_ObjectTable *)

typedef int(* Rdb_remove)(const char *const name, R_ObjectTable *)

---

Function Documentation

SEXP R_removeTaskCallback

(

SEXP

which

)

R_ToplevelCallbackEl* Rf_addTaskCallback	(	R_ToplevelCallback	cb,
		void *	data,
		void(*)(void *)	finalizer,
		const char *	name,
		int *	pos
	)

Rboolean Rf_removeTaskCallbackByIndex

(

int

id

)

Rboolean Rf_removeTaskCallbackByName

(

const char *

name

)