rpm: rpmio/rpmsquirrel.h File Reference

rpm 5.3.12

#include <rpmiotypes.h>
#include <rpmio.h>

Include dependency graph for rpmsquirrel.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	rpmsquirrelUnlink(_squirrel) ((rpmsquirrel)rpmioUnlinkPoolItem((rpmioItem)(_squirrel), __FUNCTION__, __FILE__, __LINE__))
#define	rpmsquirrelLink(_squirrel) ((rpmsquirrel)rpmioLinkPoolItem((rpmioItem)(_squirrel), __FUNCTION__, __FILE__, __LINE__))
#define	rpmsquirrelFree(_squirrel) ((rpmsquirrel)rpmioFreePoolItem((rpmioItem)(_squirrel), __FUNCTION__, __FILE__, __LINE__))
Typedefs
typedef struct rpmsquirrel_s *	rpmsquirrel
Functions
rpmsquirrel	rpmsquirrelUnlink (rpmsquirrel squirrel)
	Unreference a squirrel interpreter instance.
rpmsquirrel	rpmsquirrelLink (rpmsquirrel squirrel)
	Reference a squirrel interpreter instance.
rpmsquirrel	rpmsquirrelFree (rpmsquirrel squirrel)
	Destroy a squirrel interpreter.
rpmsquirrel	rpmsquirrelNew (char **av, uint32_t flags)
	Create and load a squirrel interpreter.
rpmRC	rpmsquirrelRunFile (rpmsquirrel squirrel, const char fn, const char *resultp)
	Execute squirrel from a file.
rpmRC	rpmsquirrelRun (rpmsquirrel squirrel, const char str, const char *resultp)
	Execute squirrel string.
Variables
int	_rpmsquirrel_debug
rpmsquirrel	_rpmsquirrelI

Detailed Description

Definition in file rpmsquirrel.h.

Define Documentation

#define rpmsquirrelFree ( _squirrel ) ((rpmsquirrel)rpmioFreePoolItem((rpmioItem)(_squirrel), __FUNCTION__, __FILE__, __LINE__))

Definition at line 66 of file rpmsquirrel.h.

#define rpmsquirrelLink ( _squirrel ) ((rpmsquirrel)rpmioLinkPoolItem((rpmioItem)(_squirrel), __FUNCTION__, __FILE__, __LINE__))

Definition at line 54 of file rpmsquirrel.h.

#define rpmsquirrelUnlink ( _squirrel ) ((rpmsquirrel)rpmioUnlinkPoolItem((rpmioItem)(_squirrel), __FUNCTION__, __FILE__, __LINE__))

Definition at line 43 of file rpmsquirrel.h.

Typedef Documentation

typedef struct rpmsquirrel_s* rpmsquirrel

Definition at line 11 of file rpmsquirrel.h.

Function Documentation

rpmsquirrel rpmsquirrelFree ( rpmsquirrel squirrel )

Destroy a squirrel interpreter.

Parameters:

squirrel squirrel interpreter

Returns:: NULL on last dereference

Referenced by expandMacro(), and rpmioClean().

rpmsquirrel rpmsquirrelLink ( rpmsquirrel squirrel )

Reference a squirrel interpreter instance.

Parameters:

squirrel squirrel interpreter

Returns:: new squirrel interpreter reference

Referenced by rpmsquirrelNew().

rpmsquirrel rpmsquirrelNew	(	char **	av,
		uint32_t	flags
	)

Create and load a squirrel interpreter.

Parameters:

av	squirrel interpreter args (or NULL)
flags	squirrel interpreter flags ((1<<31): use global interpreter)

Returns:: new squirrel interpreter

Definition at line 87 of file rpmsquirrel.c.

References argvCount(), rpmiobNew(), rpmsquirrelGetPool(), rpmsquirrelI(), and rpmsquirrelLink().

Referenced by expandMacro(), and rpmsquirrelI().

rpmRC rpmsquirrelRun	(	rpmsquirrel	squirrel,
		const char *	str,
		const char **	resultp
	)

Execute squirrel string.

Parameters:

squirrel	squirrel interpreter (NULL uses global interpreter)
str	squirrel string to execute (NULL returns RPMRC_FAIL)
*resultp	squirrel exec result

Returns:: RPMRC_OK on success

Definition at line 146 of file rpmsquirrel.c.

References _rpmsquirrel_debug, rpmiobStr(), RPMRC_FAIL, RPMRC_OK, and rpmsquirrelI().

Referenced by expandMacro().

rpmRC rpmsquirrelRunFile	(	rpmsquirrel	squirrel,
		const char *	fn,
		const char **	resultp
	)

Execute squirrel from a file.

Parameters:

squirrel	squirrel interpreter (NULL uses global interpreter)
fn	squirrel file to run (NULL returns RPMRC_FAIL)
*resultp	squirrel exec result

Returns:: RPMRC_OK on success

Definition at line 127 of file rpmsquirrel.c.

References _rpmsquirrel_debug, rpmiobStr(), RPMRC_FAIL, RPMRC_OK, and rpmsquirrelI().

rpmsquirrel rpmsquirrelUnlink ( rpmsquirrel squirrel )

Unreference a squirrel interpreter instance.

Parameters:

squirrel squirrel interpreter

Returns:: NULL on last dereference

Variable Documentation

int _rpmsquirrel_debug

Definition at line 15 of file rpmsquirrel.c.

Referenced by rpmsquirrelGetPool(), rpmsquirrelRun(), and rpmsquirrelRunFile().

rpmsquirrel _rpmsquirrelI

Definition at line 18 of file rpmsquirrel.c.

Referenced by rpmioClean(), and rpmsquirrelI().