Joseph Gilbert
8b060dd5ad
- give it the key/items interface - creates some factory functions for const generation - genutils methods - method for getting module constants - method for throwing errors with a print string - updates to function names - clean up interpreter launch a bit
591 lines
16 KiB
C
591 lines
16 KiB
C
/*
|
|
* $Id$
|
|
*
|
|
* ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version. The Blender
|
|
* Foundation also sells licenses for use in proprietary software under
|
|
* the Blender License. See http://www.blender.org/BL/ for information
|
|
* about this.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
* All rights reserved.
|
|
*
|
|
* This is a new part of Blender.
|
|
*
|
|
* Contributor(s): Michel Selten, Willian P. Germano, Alex Mole, Ken Hughes
|
|
*
|
|
* ***** END GPL/BL DUAL LICENSE BLOCK *****
|
|
*/
|
|
|
|
#include "gen_utils.h" /*This must come first*/
|
|
|
|
#include "DNA_text_types.h"
|
|
#include "MEM_guardedalloc.h"
|
|
#include "BLI_blenlib.h"
|
|
#include "BIF_space.h"
|
|
#include "BKE_global.h"
|
|
#include "BKE_main.h"
|
|
|
|
//---------------------- EXPP_GetModuleConstant -------------------------
|
|
//Helper function for returning a module constant
|
|
PyObject *EXPP_GetModuleConstant(char *module, char *constant)
|
|
{
|
|
PyObject *py_module = NULL, *py_dict = NULL, *py_constant = NULL;
|
|
|
|
/*Careful to pass the correct Package.Module string here or
|
|
* else you add a empty module somewhere*/
|
|
py_module = PyImport_AddModule(module);
|
|
if(!py_module){ //null = error returning module
|
|
return ( EXPP_ReturnPyObjError( PyExc_RuntimeError,
|
|
"error encountered with returning module constant..." ) );
|
|
}
|
|
py_dict = PyModule_GetDict(py_module); //never fails
|
|
|
|
py_constant = PyDict_GetItemString(py_dict, constant);
|
|
if(!py_constant){ //null = key not found
|
|
return ( EXPP_ReturnPyObjError( PyExc_RuntimeError,
|
|
"error encountered with returning module constant..." ) );
|
|
}
|
|
|
|
return EXPP_incr_ret(py_constant);
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Description: This function clamps an int to the given interval */
|
|
/* [min, max]. */
|
|
/*****************************************************************************/
|
|
int EXPP_ClampInt( int value, int min, int max )
|
|
{
|
|
if( value < min )
|
|
return min;
|
|
else if( value > max )
|
|
return max;
|
|
return value;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Description: This function clamps a float to the given interval */
|
|
/* [min, max]. */
|
|
/*****************************************************************************/
|
|
float EXPP_ClampFloat( float value, float min, float max )
|
|
{
|
|
if( value < min )
|
|
return min;
|
|
else if( value > max )
|
|
return max;
|
|
return value;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Description: This function returns true if both given strings are equal, */
|
|
/* otherwise it returns false. */
|
|
/*****************************************************************************/
|
|
int StringEqual( const char *string1, const char *string2 )
|
|
{
|
|
return ( strcmp( string1, string2 ) == 0 );
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Description: This function returns the name of the given ID struct */
|
|
/* without the Object type identifying characters prepended. */
|
|
/*****************************************************************************/
|
|
char *GetIdName( ID * id )
|
|
{
|
|
return ( ( id->name ) + 2 );
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Description: This function returns the ID of the object with given name */
|
|
/* from a given list. */
|
|
/*****************************************************************************/
|
|
ID *GetIdFromList( ListBase * list, char *name )
|
|
{
|
|
ID *id = list->first;
|
|
|
|
while( id ) {
|
|
if( strcmp( name, id->name + 2 ) == 0 )
|
|
break;
|
|
id = id->next;
|
|
}
|
|
|
|
return id;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Description: These functions set an internal string with the given type */
|
|
/* and error_msg arguments. */
|
|
/*****************************************************************************/
|
|
|
|
PyObject *EXPP_ReturnPyObjError( PyObject * type, char *error_msg )
|
|
{ /* same as above, just to change its name smoothly */
|
|
PyErr_SetString( type, error_msg );
|
|
return NULL;
|
|
}
|
|
|
|
int EXPP_ReturnIntError( PyObject * type, char *error_msg )
|
|
{
|
|
PyErr_SetString( type, error_msg );
|
|
return -1;
|
|
}
|
|
|
|
|
|
int EXPP_intError(PyObject *type, const char *format, ...)
|
|
{
|
|
char *error = "";
|
|
va_list vlist;
|
|
|
|
va_start(vlist, format);
|
|
vsprintf(error, format, vlist);
|
|
va_end(vlist);
|
|
|
|
PyErr_SetString(type, error);
|
|
return -1;
|
|
}
|
|
//Like EXPP_ReturnPyObjError but takes a printf format string and multiple arguments
|
|
PyObject *EXPP_objError(PyObject *type, const char *format, ...)
|
|
{
|
|
char *error = "";
|
|
va_list vlist;
|
|
|
|
va_start(vlist, format);
|
|
vsprintf(error, format, vlist);
|
|
va_end(vlist);
|
|
|
|
PyErr_SetString(type, error);
|
|
return NULL;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Description: This function increments the reference count of the given */
|
|
/* Python object (usually Py_None) and returns it. */
|
|
/*****************************************************************************/
|
|
|
|
PyObject *EXPP_incr_ret( PyObject * object )
|
|
{
|
|
Py_INCREF( object );
|
|
return ( object );
|
|
}
|
|
|
|
/* return Py_False - to avoid warnings, we use the fact that
|
|
* 0 == False in Python: */
|
|
PyObject *EXPP_incr_ret_False()
|
|
{
|
|
return Py_BuildValue("i", 0);
|
|
}
|
|
|
|
/* return Py_True - to avoid warnings, we use the fact that
|
|
* 1 == True in Python: */
|
|
PyObject *EXPP_incr_ret_True()
|
|
{
|
|
return Py_BuildValue("i", 1);
|
|
}
|
|
|
|
void EXPP_incr2( PyObject * ob1, PyObject * ob2 )
|
|
{
|
|
Py_INCREF( ob1 );
|
|
Py_INCREF( ob2 );
|
|
}
|
|
|
|
void EXPP_incr3( PyObject * ob1, PyObject * ob2, PyObject * ob3 )
|
|
{
|
|
Py_INCREF( ob1 );
|
|
Py_INCREF( ob2 );
|
|
Py_INCREF( ob3 );
|
|
}
|
|
|
|
void EXPP_decr2( PyObject * ob1, PyObject * ob2 )
|
|
{
|
|
Py_DECREF( ob1 );
|
|
Py_DECREF( ob2 );
|
|
}
|
|
|
|
void EXPP_decr3( PyObject * ob1, PyObject * ob2, PyObject * ob3 )
|
|
{
|
|
Py_DECREF( ob1 );
|
|
Py_DECREF( ob2 );
|
|
Py_DECREF( ob3 );
|
|
}
|
|
/*****************************************************************************/
|
|
/* Description: This function maps the event identifier to a string. */
|
|
/*****************************************************************************/
|
|
char *event_to_name( short event )
|
|
{
|
|
switch ( event ) {
|
|
case SCRIPT_FRAMECHANGED:
|
|
return "FrameChanged";
|
|
case SCRIPT_ONLOAD:
|
|
return "OnLoad";
|
|
case SCRIPT_ONSAVE:
|
|
return "OnSave";
|
|
case SCRIPT_REDRAW:
|
|
return "Redraw";
|
|
case SCRIPT_RENDER:
|
|
return "Render";
|
|
case SCRIPT_POSTRENDER:
|
|
return "PostRender";
|
|
default:
|
|
return "Unknown";
|
|
}
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Description: Checks whether all objects in a PySequence are of a same */
|
|
/* given type. Returns 0 if not, 1 on success. */
|
|
/*****************************************************************************/
|
|
int EXPP_check_sequence_consistency( PyObject * seq, PyTypeObject * against )
|
|
{
|
|
PyObject *ob;
|
|
int len = PySequence_Length( seq );
|
|
int i, result = 1;
|
|
|
|
for( i = 0; i < len; i++ ) {
|
|
ob = PySequence_GetItem( seq, i );
|
|
if( ob == Py_None )
|
|
result = 2;
|
|
else if( ob->ob_type != against ) {
|
|
Py_DECREF( ob );
|
|
return 0;
|
|
}
|
|
Py_DECREF( ob );
|
|
}
|
|
return result; /* 1 if all of 'against' type, 2 if there are (also) Nones */
|
|
}
|
|
|
|
PyObject *EXPP_tuple_repr( PyObject * self, int size )
|
|
{
|
|
PyObject *repr, *item;
|
|
int i;
|
|
|
|
/*@ note: a value must be built because the list is decrefed!
|
|
* otherwise we have nirvana pointers inside python.. */
|
|
|
|
repr = PyString_FromString( "" );
|
|
if( !repr )
|
|
return 0;
|
|
|
|
item = PySequence_GetItem( self, 0 );
|
|
PyString_ConcatAndDel( &repr, PyObject_Repr( item ) );
|
|
Py_DECREF( item );
|
|
|
|
for( i = 1; i < size; i++ ) {
|
|
item = PySequence_GetItem( self, i );
|
|
PyString_ConcatAndDel( &repr, PyObject_Repr( item ) );
|
|
Py_DECREF( item );
|
|
}
|
|
|
|
return repr;
|
|
}
|
|
|
|
/****************************************************************************/
|
|
/* Description: searches through a map for a pair with a given name. If the */
|
|
/* pair is present, its ival is stored in *ival and nonzero is */
|
|
/* returned. If the pair is absent, zero is returned. */
|
|
/****************************************************************************/
|
|
int EXPP_map_getIntVal( const EXPP_map_pair * map, const char *sval,
|
|
int *ival )
|
|
{
|
|
while( map->sval ) {
|
|
if( StringEqual( sval, map->sval ) ) {
|
|
*ival = map->ival;
|
|
return 1;
|
|
}
|
|
++map;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/* same as above, but string case is ignored */
|
|
int EXPP_map_case_getIntVal( const EXPP_map_pair * map, const char *sval,
|
|
int *ival )
|
|
{
|
|
while( map->sval ) {
|
|
if( !BLI_strcasecmp( sval, map->sval ) ) {
|
|
*ival = map->ival;
|
|
return 1;
|
|
}
|
|
++map;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/****************************************************************************/
|
|
/* Description: searches through a map for a pair with a given name. If the */
|
|
/* pair is present, its ival is stored in *ival and nonzero is */
|
|
/* returned. If the pair is absent, zero is returned. */
|
|
/* note: this function is identical to EXPP_map_getIntVal except that the */
|
|
/* output is stored in a short value. */
|
|
/****************************************************************************/
|
|
int EXPP_map_getShortVal( const EXPP_map_pair * map,
|
|
const char *sval, short *ival )
|
|
{
|
|
while( map->sval ) {
|
|
if( StringEqual( sval, map->sval ) ) {
|
|
*ival = (short)map->ival;
|
|
return 1;
|
|
}
|
|
++map;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/****************************************************************************/
|
|
/* Description: searches through a map for a pair with a given ival. If the */
|
|
/* pair is present, a pointer to its name is stored in *sval */
|
|
/* and nonzero is returned. If the pair is absent, zero is */
|
|
/* returned. */
|
|
/****************************************************************************/
|
|
int EXPP_map_getStrVal( const EXPP_map_pair * map, int ival,
|
|
const char **sval )
|
|
{
|
|
while( map->sval ) {
|
|
if( ival == map->ival ) {
|
|
*sval = map->sval;
|
|
return 1;
|
|
}
|
|
++map;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/* Redraw wrappers */
|
|
|
|
/* this queues redraws if we're not in background mode: */
|
|
void EXPP_allqueue(unsigned short event, short val)
|
|
{
|
|
if (!G.background) allqueue(event, val);
|
|
}
|
|
|
|
/************************************************************************/
|
|
/* Scriptlink-related functions, used by scene, object, etc. bpyobjects */
|
|
/************************************************************************/
|
|
PyObject *EXPP_getScriptLinks( ScriptLink * slink, PyObject * args,
|
|
int is_scene )
|
|
{
|
|
PyObject *list = NULL;
|
|
char *eventname = NULL;
|
|
int i, event = 0;
|
|
|
|
/* actually !scriptlink shouldn't happen ... */
|
|
if( !slink || !slink->totscript )
|
|
return EXPP_incr_ret( Py_None );
|
|
|
|
if( !PyArg_ParseTuple( args, "s", &eventname ) )
|
|
return EXPP_ReturnPyObjError( PyExc_TypeError,
|
|
"expected event name (string) as argument" );
|
|
|
|
list = PyList_New( 0 );
|
|
if( !list )
|
|
return EXPP_ReturnPyObjError( PyExc_MemoryError,
|
|
"couldn't create PyList!" );
|
|
|
|
if( !strcmp( eventname, "FrameChanged" ) )
|
|
event = SCRIPT_FRAMECHANGED;
|
|
else if( !strcmp( eventname, "Redraw" ) )
|
|
event = SCRIPT_REDRAW;
|
|
else if( !strcmp( eventname, "Render" ) )
|
|
event = SCRIPT_RENDER;
|
|
else if( is_scene && !strcmp( eventname, "OnLoad" ) )
|
|
event = SCRIPT_ONLOAD;
|
|
else if( is_scene && !strcmp( eventname, "OnSave" ) )
|
|
event = SCRIPT_ONSAVE;
|
|
else
|
|
return EXPP_ReturnPyObjError( PyExc_AttributeError,
|
|
"invalid event name" );
|
|
|
|
for( i = 0; i < slink->totscript; i++ ) {
|
|
if( ( slink->flag[i] == event ) && slink->scripts[i] )
|
|
PyList_Append( list,
|
|
PyString_FromString( slink->scripts[i]->
|
|
name + 2 ) );
|
|
}
|
|
|
|
return list;
|
|
}
|
|
|
|
PyObject *EXPP_clearScriptLinks( ScriptLink * slink, PyObject * args )
|
|
{
|
|
int i, j, totLinks, deleted = 0;
|
|
PyObject *seq = NULL;
|
|
ID **stmp = NULL;
|
|
short *ftmp = NULL;
|
|
|
|
/* check for an optional list of strings */
|
|
if( !PyArg_ParseTuple( args, "|O", &seq ) )
|
|
return ( EXPP_ReturnPyObjError
|
|
( PyExc_TypeError,
|
|
"expected no arguments or a list of strings" ) );
|
|
|
|
|
|
/* if there was a parameter, handle it */
|
|
if ( seq != NULL ) {
|
|
/* check that parameter IS list of strings */
|
|
if ( !PyList_Check ( seq ) )
|
|
return ( EXPP_ReturnPyObjError
|
|
( PyExc_TypeError,
|
|
"expected a list of strings" ) );
|
|
|
|
totLinks = PyList_Size ( seq );
|
|
for ( i = 0 ; i < totLinks ; ++i ) {
|
|
if ( !PyString_Check ( PySequence_GetItem( seq, i ) ) )
|
|
return ( EXPP_ReturnPyObjError
|
|
( PyExc_TypeError,
|
|
"expected list to contain strings" ) );
|
|
}
|
|
|
|
/*
|
|
parameters OK: now look for each script, and delete
|
|
its link as we find it (this handles multiple links)
|
|
*/
|
|
for ( i = 0 ; i < totLinks ; ++i )
|
|
{
|
|
char *str;
|
|
str = PyString_AsString ( PySequence_GetItem( seq, i ) );
|
|
for ( j = 0 ; j < slink->totscript ; ++j ) {
|
|
if ( slink->scripts[j] && !strcmp ( slink->scripts[j]->name+2, str ) ) {
|
|
slink->scripts[j] = NULL;
|
|
++deleted;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
/* if no parameter, then delete all scripts */
|
|
else {
|
|
deleted = slink->totscript;
|
|
}
|
|
|
|
/*
|
|
if not all scripts deleted, create new lists and copy remaining
|
|
links to them
|
|
*/
|
|
|
|
if ( slink->totscript > deleted ) {
|
|
slink->totscript = slink->totscript - (short)deleted;
|
|
|
|
stmp = slink->scripts;
|
|
slink->scripts =
|
|
MEM_mallocN( sizeof( ID * ) * ( slink->totscript ),
|
|
"bpySlinkL" );
|
|
|
|
ftmp = slink->flag;
|
|
slink->flag =
|
|
MEM_mallocN( sizeof( short * ) * ( slink->totscript ),
|
|
"bpySlinkF" );
|
|
|
|
for ( i = 0, j = 0 ; i < slink->totscript ; ++j ) {
|
|
if ( stmp[j] != NULL ) {
|
|
memcpy( slink->scripts+i, stmp+j, sizeof( ID * ) );
|
|
memcpy( slink->flag+i, ftmp+j, sizeof( short ) );
|
|
++i;
|
|
}
|
|
}
|
|
MEM_freeN( stmp );
|
|
MEM_freeN( ftmp );
|
|
|
|
/*EXPP_allqueue (REDRAWBUTSSCRIPT, 0 );*/
|
|
slink->actscript = 1;
|
|
} else {
|
|
|
|
/* all scripts deleted, so delete entire list and free memory */
|
|
|
|
if( slink->scripts )
|
|
MEM_freeN( slink->scripts );
|
|
if( slink->flag )
|
|
MEM_freeN( slink->flag );
|
|
|
|
slink->scripts = NULL;
|
|
slink->flag = NULL;
|
|
slink->totscript = slink->actscript = 0;
|
|
}
|
|
|
|
return EXPP_incr_ret( Py_None );
|
|
}
|
|
|
|
|
|
PyObject *EXPP_addScriptLink(ScriptLink *slink, PyObject *args, int is_scene)
|
|
{
|
|
int event = 0, found_txt = 0;
|
|
void *stmp = NULL, *ftmp = NULL;
|
|
Text *bltxt = G.main->text.first;
|
|
char *textname = NULL;
|
|
char *eventname = NULL;
|
|
|
|
/* !scriptlink shouldn't happen ... */
|
|
if( !slink ) {
|
|
return EXPP_ReturnPyObjError( PyExc_RuntimeError,
|
|
"internal error: no scriptlink!" );
|
|
}
|
|
|
|
if( !PyArg_ParseTuple( args, "ss", &textname, &eventname ) )
|
|
return EXPP_ReturnPyObjError( PyExc_TypeError,
|
|
"expected two strings as arguments" );
|
|
|
|
while( bltxt ) {
|
|
if( !strcmp( bltxt->id.name + 2, textname ) ) {
|
|
found_txt = 1;
|
|
break;
|
|
}
|
|
bltxt = bltxt->id.next;
|
|
}
|
|
|
|
if( !found_txt )
|
|
return EXPP_ReturnPyObjError( PyExc_AttributeError,
|
|
"no such Blender Text" );
|
|
|
|
if( !strcmp( eventname, "FrameChanged" ) )
|
|
event = SCRIPT_FRAMECHANGED;
|
|
else if( !strcmp( eventname, "Redraw" ) )
|
|
event = SCRIPT_REDRAW;
|
|
else if( !strcmp( eventname, "Render" ) )
|
|
event = SCRIPT_RENDER;
|
|
else if( is_scene && !strcmp( eventname, "OnLoad" ) )
|
|
event = SCRIPT_ONLOAD;
|
|
else if( is_scene && !strcmp( eventname, "OnSave" ) )
|
|
event = SCRIPT_ONSAVE;
|
|
else
|
|
return EXPP_ReturnPyObjError( PyExc_AttributeError,
|
|
"invalid event name" );
|
|
|
|
stmp = slink->scripts;
|
|
slink->scripts =
|
|
MEM_mallocN( sizeof( ID * ) * ( slink->totscript + 1 ),
|
|
"bpySlinkL" );
|
|
|
|
ftmp = slink->flag;
|
|
slink->flag =
|
|
MEM_mallocN( sizeof( short * ) * ( slink->totscript + 1 ),
|
|
"bpySlinkF" );
|
|
|
|
if( slink->totscript ) {
|
|
memcpy( slink->scripts, stmp,
|
|
sizeof( ID * ) * ( slink->totscript ) );
|
|
MEM_freeN( stmp );
|
|
|
|
memcpy( slink->flag, ftmp,
|
|
sizeof( short ) * ( slink->totscript ) );
|
|
MEM_freeN( ftmp );
|
|
}
|
|
|
|
slink->scripts[slink->totscript] = ( ID * ) bltxt;
|
|
slink->flag[slink->totscript] = (short)event;
|
|
|
|
slink->totscript++;
|
|
|
|
if( slink->actscript < 1 )
|
|
slink->actscript = 1;
|
|
|
|
return EXPP_incr_ret (Py_None); /* normal exit */
|
|
}
|