Max Wrapper Module
[Jitter]

Collaboration diagram for Max Wrapper Module:

Functions
void	max_jit_attr_set (void *x, t_symbol *s, short ac, t_atom *av)
	Sets attribute value.
t_jit_err	max_jit_attr_get (void *x, t_symbol *s, long *ac, t_atom **av)
	Retrieves attribute value.
void	max_jit_attr_getdump (void *x, t_symbol *s, short argc, t_atom *argv)
	Retrieves attribute value and sends out dump outlet.
long	max_jit_attr_args_offset (short ac, t_atom *av)
	Determines argument offset to first attribute argument.
void	max_jit_attr_args (void *x, short ac, t_atom *av)
	Processes attribtue arguments.
void	max_jit_classex_standard_wrap (void *mclass, void *jclass, long flags)
	Adds standard Jitter methods, as well as public methods and attributes of the specified Jitter class.
void	max_addmethod_defer (method m, char *s)
	Adds method to Max class that calls defer rather than the method directly.
void	max_addmethod_defer_low (method m, char *s)
	Adds method to Max class that calls defer_low rather than the method directly.
void	max_addmethod_usurp (method m, char *s)
	Adds method to Max class that uses the usurp mechanism to execute method at low priority without backlog.
void	max_addmethod_usurp_low (method m, char *s)
	Adds method to Max class that uses the usurp mechanism to execute method at low priority without backlog.
void *	max_jit_classex_setup (long oboffset)
	Allocates and initializes special t_max_jit_classex data, used by the Max wrapper class.
t_jit_err	max_jit_classex_addattr (void *x, void *attr)
	Adds an attribute to the Max wrapper class.
void *	max_jit_obex_new (void *mc, t_symbol *classname)
	Allocates an initializes a new Max wrapper object instance.
void	max_jit_obex_free (void *x)
	Frees additional resources for the Max wrapper object instance.
t_jit_err	max_jit_obex_attr_set (void *x, t_symbol *s, long ac, t_atom *av)
	Sets an attribute of the Max wrapper or the wrapped Jitter object.
t_jit_err	max_jit_obex_attr_get (void *x, t_symbol *s, long *ac, t_atom **av)
	Retrienves an attribute of the Max wrapper or the wrapped Jitter object.
void *	max_jit_obex_jitob_get (void *x)
	Retrieves the wrapped Jitter object from a Max wrapper object.
void	max_jit_obex_jitob_set (void *x, void *jitob)
	Sets the wrapped Jitter object for a Max wrapper object.
long	max_jit_obex_inletnumber_get (void *x)
	Retrieves the current inlet number used by inlet proxies.
void	max_jit_obex_inletnumber_set (void *x, long inletnumber)
	Sets the current inlet number used by inlet proxies.
t_jit_err	max_jit_obex_proxy_new (void *x, long c)
	Creates a new proxy inlet.
void	max_jit_obex_dumpout_set (void *x, void *outlet)
	Sets the Max wrapper object's dump outlet's outlet pointer.
void *	max_jit_obex_dumpout_get (void *x)
	Retrieves the Max wrapper object's dump outlet's outlet pointer.
void	max_jit_obex_dumpout (void *x, t_symbol *s, short argc, t_atom *argv)
	Sends a message and arguments out the dump outlet.
void *	max_jit_obex_adornment_get (void *x, t_symbol *classname)
	Retrieves Max wrapper object adornment specified by class name.
void	max_jit_obex_gimmeback (void *x, t_symbol *s, long ac, t_atom *av)
	Calls gimmeback methods and frees any return value.
void	max_jit_obex_gimmeback_dumpout (void *x, t_symbol *s, long ac, t_atom *av)
	Calls gimmeback methods and outputs any return value through the Max wrapper class' dump outlet.

---

Function Documentation

void max_addmethod_defer	(	method	m,
		char *	s
	)

Adds method to Max class that calls defer rather than the method directly.

To prevent sequencing problems which arize through the use of defer, rather than defer_low, you should instead use the max_addmethod_defer_low function.

Parameters:

	m	method (function pointer)
	s	method name

Definition at line 772 of file jit.max.c.

References A_CANT, A_GIMME, and addmess().

Referenced by max_jit_classex_addattr().

Here is the call graph for this function:

void max_addmethod_defer_low	(	method	m,
		char *	s
	)

Adds method to Max class that calls defer_low rather than the method directly.

Parameters:

	m	method (function pointer)
	s	method name

Definition at line 805 of file jit.max.c.

References A_CANT, A_GIMME, and addmess().

Referenced by max_jit_classex_addattr(), max_jit_classex_mop_wrap(), and max_jit_classex_standard_wrap().

Here is the call graph for this function:

void max_addmethod_usurp	(	method	m,
		char *	s
	)

Adds method to Max class that uses the usurp mechanism to execute method at low priority without backlog.

Equivalent to max_addmethod_usurp_low function.

Parameters:

	m	method (function pointer)
	s	method name

Definition at line 824 of file jit.max.c.

References A_CANT, A_GIMME, and addmess().

Referenced by max_jit_classex_addattr().

Here is the call graph for this function:

void max_addmethod_usurp_low	(	method	m,
		char *	s
	)

Adds method to Max class that uses the usurp mechanism to execute method at low priority without backlog.

Parameters:

	m	method (function pointer)
	s	method name

Definition at line 842 of file jit.max.c.

References A_CANT, A_GIMME, and addmess().

Referenced by max_jit_classex_addattr(), and max_jit_classex_mop_wrap().

Here is the call graph for this function:

void max_jit_attr_args	(	void *	x,
		short	ac,
		t_atom *	av
	)

Processes attribtue arguments.

Parameters:

	x	Max wrapper object pointer
	ac	argument count
	av	argument vector

Definition at line 415 of file jit.max.c.

References A_SYM, gensym(), jit_object_attr_usercanset(), jit_object_method(), jit_object_method_argsafe_get(), max_jit_obex_jitob_get(), object_method_typed(), and t_symbol::s_name.

Here is the call graph for this function:

long max_jit_attr_args_offset	(	short	ac,
		t_atom *	av
	)

Determines argument offset to first attribute argument.

Parameters:

	ac	argument count
	av	argument vector

Returns:

argument offset

Definition at line 389 of file jit.max.c.

References A_SYM.

Referenced by max_jit_mop_matrix_args().

t_jit_err max_jit_attr_get	(	void *	x,
		t_symbol *	s,
		long *	ac,
		t_atom **	av
	)

Retrieves attribute value.

Parameters:

	x	Max wrapper object pointer
	s	attribute name
	ac	pointer atom count
	av	pointer atom vector

Returns:

t_jit_err error code

Definition at line 339 of file jit.max.c.

References gensym(), jit_object_method(), max_jit_obex_jitob_get(), and t_symbol::s_name.

Referenced by max_jit_attr_getdump().

Here is the call graph for this function:

void max_jit_attr_getdump	(	void *	x,
		t_symbol *	s,
		short	argc,
		t_atom *	argv
	)

Retrieves attribute value and sends out dump outlet.

Parameters:

	x	Max wrapper object pointer
	s	attribute name
	argc	argument count (ignored)
	argv	argument vector (ignored)

Definition at line 361 of file jit.max.c.

References freebytes(), gensym(), jit_error_code(), max_jit_attr_get(), t_symbol::s_name, and zgetfn().

Here is the call graph for this function:

void max_jit_attr_set	(	void *	x,
		t_symbol *	s,
		short	ac,
		t_atom *	av
	)

Sets attribute value.

Parameters:

	x	Max wrapper object pointer
	s	attribute name
	ac	atom count
	av	atom vector

Definition at line 306 of file jit.max.c.

References jit_object_method(), max_jit_obex_jitob_get(), object_attr_get(), and object_notify().

Here is the call graph for this function:

long max_jit_classex_addattr	(	void *	x,
		void *	attr
	)

Adds an attribute to the Max wrapper class.

Parameters:

	x	pointer to t_max_jit_classex data (opaque)
	attr	attribute object pointer

Returns:

t_jit_err error code

Definition at line 1545 of file jit.max.c.

Referenced by max_jit_classex_mop_wrap().

void * max_jit_classex_setup

(

long

oboffset

)

Allocates and initializes special t_max_jit_classex data, used by the Max wrapper class.

Parameters:

oboffset

object struct byte offset to obex pointer

Returns:

pointer to t_max_jit_classex data (opaque)

Definition at line 1517 of file jit.max.c.

void max_jit_classex_standard_wrap	(	void *	mclass,
		void *	jclass,
		long	flags
	)

Adds standard Jitter methods, as well as public methods and attributes of the specified Jitter class.

This includes the following public methods: getattributes, getstate, summary, importattrs, exportattrs; and the following private methods: dumpout, quickref, attr_getnames, attr_get, attr_gettarget, and attrindex.

Parameters:

	mclass	Max wrapper class pointer
	jclass	jitter class pointer
	flags	reserved for future use (currently ignored)

Definition at line 691 of file jit.max.c.

void* max_jit_obex_adornment_get	(	void *	x,
		t_symbol *	classname
	)

Retrieves Max wrapper object adornment specified by class name.

Typcially used for accessing the jit_mop adornment for MOP Max wrapper objects.

Parameters:

	x	Max wrapper object pointer
	classname	adornment classname

Returns:

adornment pointer

Definition at line 2099 of file jit.max.c.

References jit_object_classname_compare(), and jit_object_method().

Referenced by max_jit_mop_adapt_matrix_all(), max_jit_mop_assist(), max_jit_mop_clear(), max_jit_mop_free(), max_jit_mop_get_io_by_name(), max_jit_mop_getinput(), max_jit_mop_getoutput(), max_jit_mop_getoutputmode(), max_jit_mop_inputs(), max_jit_mop_jit_matrix(), max_jit_mop_matrix_args(), max_jit_mop_matrixout_new(), max_jit_mop_notify(), max_jit_mop_outputmatrix(), max_jit_mop_outputs(), max_jit_mop_variable_addinputs(), and max_jit_mop_variable_addoutputs().

Here is the call graph for this function:

t_jit_err max_jit_obex_attr_get	(	void *	x,
		t_symbol *	s,
		long *	ac,
		t_atom **	av
	)

Retrienves an attribute of the Max wrapper or the wrapped Jitter object.

Parameters:

	x	Max wrapper object pointer
	s	attribute name
	ac	pointer to atom count
	av	pointer to atom vector

Returns:

t_jit_error error code

Definition at line 1819 of file jit.max.c.

References jit_attr_symcompare(), jit_linklist_findfirst(), and jit_object_method().

Here is the call graph for this function:

t_jit_err max_jit_obex_attr_set	(	void *	x,
		t_symbol *	s,
		long	ac,
		t_atom *	av
	)

Sets an attribute of the Max wrapper or the wrapped Jitter object.

Parameters:

	x	Max wrapper object pointer
	s	attribute name
	ac	atom count
	av	atom vector

Returns:

t_jit_error error code

Definition at line 1784 of file jit.max.c.

References jit_attr_symcompare(), jit_linklist_findfirst(), jit_object_method(), and object_notify().

Referenced by max_jit_classex_addattr().

Here is the call graph for this function:

void max_jit_obex_dumpout	(	void *	x,
		t_symbol *	s,
		short	argc,
		t_atom *	argv
	)

Sends a message and arguments out the dump outlet.

This message is equivalent to calling outlet_anything with the outlet returned by max_jit_obex_dumpout_get.

Parameters:

	x	Max wrapper object pointer
	s	message symbol
	argc	argument count
	argv	argument vector

Definition at line 2061 of file jit.max.c.

References outlet_anything().

Referenced by max_jit_classex_standard_wrap(), and max_jit_obex_gimmeback_dumpout().

Here is the call graph for this function:

void* max_jit_obex_dumpout_get

(

void *

x

)

Retrieves the Max wrapper object's dump outlet's outlet pointer.

Parameters:

x

Max wrapper object pointer

Returns:

dump outlet pointer

Definition at line 2039 of file jit.max.c.

void max_jit_obex_dumpout_set	(	void *	x,
		void *	outlet
	)

Sets the Max wrapper object's dump outlet's outlet pointer.

Parameters:

	x	Max wrapper object pointer
	outlet	dump outlet pointer

Definition at line 2022 of file jit.max.c.

Referenced by max_jit_mop_setup_simple(), and max_jit_obex_new().

void max_jit_obex_free

(

void *

x

)

Frees additional resources for the Max wrapper object instance.

Parameters:

x

Max wrapper object pointer

Definition at line 1677 of file jit.max.c.

void max_jit_obex_gimmeback	(	void *	x,
		t_symbol *	s,
		long	ac,
		t_atom *	av
	)

Calls gimmeback methods and frees any return value.

Parameters:

	x	Max wrapper object pointer
	s	method name
	ac	argument count
	av	argument vector

Definition at line 2189 of file jit.max.c.

References A_NOTHING, A_OBJ, t_atom::a_type, t_atom::a_w, freebytes(), freeobject(), max_jit_obex_jitob_get(), object_method_typed(), and word::w_obj.

Here is the call graph for this function:

void max_jit_obex_gimmeback_dumpout	(	void *	x,
		t_symbol *	s,
		long	ac,
		t_atom *	av
	)

Calls gimmeback methods and outputs any return value through the Max wrapper class' dump outlet.

Parameters:

	x	Max wrapper object pointer
	s	method name
	ac	argument count
	av	argument vector

Definition at line 2216 of file jit.max.c.

References A_NOTHING, A_OBJ, t_atom::a_type, t_atom::a_w, freebytes(), freeobject(), gensym(), max_jit_obex_dumpout(), max_jit_obex_jitob_get(), object_getvalueof(), object_method_typed(), t_symbol::s_name, and word::w_obj.

Here is the call graph for this function:

long max_jit_obex_inletnumber_get

(

void *

x

)

Retrieves the current inlet number used by inlet proxies.

Parameters:

x

Max wrapper object pointer

Returns:

current inlet index

Definition at line 1959 of file jit.max.c.

References proxy_getinlet().

Referenced by max_jit_mop_jit_matrix().

Here is the call graph for this function:

void max_jit_obex_inletnumber_set	(	void *	x,
		long	inletnumber
	)

Sets the current inlet number used by inlet proxies.

Warning:

Typically not used outside jitlib.

Parameters:

	x	Max wrapper object pointer
	inletnumber	inlet index

Definition at line 1975 of file jit.max.c.

Referenced by max_jit_obex_new().

void* max_jit_obex_jitob_get

(

void *

x

)

Retrieves the wrapped Jitter object from a Max wrapper object.

Parameters:

x

Max wrapper object pointer

Returns:

Jitter object pointer

Definition at line 1884 of file jit.max.c.

Referenced by max_jit_attr_args(), max_jit_attr_get(), max_jit_attr_set(), max_jit_mop_jit_matrix(), max_jit_mop_setup(), max_jit_ob3d_detach(), max_jit_obex_gimmeback(), and max_jit_obex_gimmeback_dumpout().

void max_jit_obex_jitob_set	(	void *	x,
		void *	jitob
	)

Sets the wrapped Jitter object for a Max wrapper object.

Parameters:

	x	Max wrapper object pointer
	jitob	Jitter object pointer

Definition at line 1902 of file jit.max.c.

References gensym(), and OBJ_FLAG_REF.

Referenced by max_jit_mop_setup_simple(), and max_jit_obex_new().

Here is the call graph for this function:

void * max_jit_obex_new	(	void *	mc,
		t_symbol *	classname
	)

Allocates an initializes a new Max wrapper object instance.

This is used in place of the newobject function.

Parameters:

	mc	Max class pointer
	classname	Jitter class name to wrap

Returns:

pointer to new Max wrapper object instance

Definition at line 1647 of file jit.max.c.

t_jit_err max_jit_obex_proxy_new	(	void *	x,
		long	c
	)

Creates a new proxy inlet.

Parameters:

	x	Max wrapper object pointer
	c	inlet index

Returns:

t_jit_err error code

Definition at line 1993 of file jit.max.c.

References jit_linklist_append(), jit_linklist_new(), and proxy_new().

Referenced by max_jit_mop_inputs().

Here is the call graph for this function: