ui_behaviour.h

Go to the documentation of this file.

 
/*
Copyright (C) 2002-2025 UFO: Alien Invasion.
 
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.
 
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.
 
*/
 
#pragma once
 
#include "ui_nodes.h"
#include "node/ui_node_abstractnode.h"
 
struct value_s;
struct uiBehaviour_t;
struct uiNode_t;
struct hashTable_s;

struct uiBehaviour_t {
    /* behaviour attributes */
    const char* name;               
    const char* extends;            
    UINodePtr manager;              
    bool registration;              
    bool isVirtual;                 
    bool isFunction;                
    bool isAbstract;                
    bool isInitialized;             
    bool focusEnabled;              
    bool drawItselfChild;           
 
    const value_t** localProperties;    
    int propertyCount;              
    intptr_t extraDataSize;         
    uiBehaviour_t* super;           
 
    void* lua_SWIG_typeinfo;        
    hashTable_s* nodeMethods;       
#ifdef DEBUG
    int count;                      
#endif
};

typedef void (*uiNodeMethod_t)(uiNode_t* node, const struct uiCallContext_s* context);

const struct value_s* UI_RegisterNodePropertyPosSize_(uiBehaviour_t* behaviour, const char* name, int type, size_t pos, size_t size);

#define UI_RegisterNodeProperty(BEHAVIOUR, NAME, TYPE, OBJECTTYPE, ATTRIBUTE) UI_RegisterNodePropertyPosSize_(BEHAVIOUR, NAME, TYPE, offsetof(OBJECTTYPE, ATTRIBUTE), MEMBER_SIZEOF(OBJECTTYPE, ATTRIBUTE))

#define UI_EXTRADATA_OFFSETOF_(TYPE, MEMBER) ((size_t) &((TYPE *)(UI_EXTRADATA_POINTER(0, TYPE)))->MEMBER)

#define UI_RegisterExtradataNodeProperty(BEHAVIOUR, NAME, TYPE, EXTRADATATYPE, ATTRIBUTE) UI_RegisterNodePropertyPosSize_(BEHAVIOUR, NAME, TYPE, UI_EXTRADATA_OFFSETOF_(EXTRADATATYPE, ATTRIBUTE), MEMBER_SIZEOF(EXTRADATATYPE, ATTRIBUTE))

#define UI_RegisterOveridedNodeProperty(BEHAVIOUR, NAME) ;

const struct value_s* UI_RegisterNodeMethod(uiBehaviour_t* behaviour, const char* name, uiNodeMethod_t function);

const struct value_s* UI_GetPropertyFromBehaviour(const uiBehaviour_t* behaviour, const char* name) __attribute__ ((warn_unused_result));

const value_t* UI_GetPropertyOrLuaMethod(const uiNode_t* node, const char* name, value_t *out);

void UI_InitializeNodeBehaviour(uiBehaviour_t* behaviour);
 
void UI_AddBehaviourMethod (uiBehaviour_t* behaviour, const char* name, LUA_METHOD fcn);
bool UI_HasBehaviourMethod (uiBehaviour_t* behaviour, const char* name);
bool UI_GetBehaviourMethod (const uiBehaviour_t* behaviour, const char* name, LUA_METHOD &fcn);