ui_nodes.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2023 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 "../../shared/ufotypes.h"
#include "../../common/scripts.h"
#include "../../common/scripts_lua.h"

/* prototype */
struct uiSprite_t;
struct value_s;
struct nodeKeyBinding_s;
struct uiCallContext_s;
struct uiModel_s;
struct uiBehaviour_t;
struct uiLuaCallback_t;
struct hashTable_s;

typedef struct uiExcludeRect_s {
    vec2_t pos;
    vec2_t size;
    struct uiExcludeRect_s* next;
} uiExcludeRect_t;

struct uiBox_t {
    vec2_t pos;
    vec2_t size;

    void clear() {
        Vector2Clear(pos);
        Vector2Clear(size);
    }

    void set(vec2_t pos, vec2_t size) {
        Vector2Copy(pos, this->pos);
        Vector2Copy(size, this->size);
    }

    void expand(int dist) {
        pos[0] -= dist;
        pos[1] -= dist;
        size[0] += 2 * dist;
        size[1] += 2 * dist;
    }

    void alignBox(uiBox_t& inner, align_t direction);
};

struct uiNode_t {
    /* common identification */
    char name[MAX_VAR];         
    uiBehaviour_t* behaviour;
    uiNode_t const* super;      
    bool dynamic;               
    bool indexed;               
    /* common navigation */
    uiNode_t* firstChild;       
    uiNode_t* lastChild;        
    uiNode_t* next;             
    uiNode_t* parent;           
    uiNode_t* root;             
    /* common pos */
    uiBox_t box;

    /* common attributes */
    char* tooltip;              
    struct uiKeyBinding_s* key; 
    bool invis;                 
    bool disabled;              
    vec4_t disabledColor;           
    bool invalidated;           
    bool ghost;                 
    bool state;                 
    bool flash;                 
    float flashSpeed;           
    int padding;                
    int align;                  
    int num;                    
    struct uiAction_s* visibilityCondition; 
    int deleteTime;             
    uiExcludeRect_t* firstExcludeRect;

    /* other attributes */
    int contentAlign;           
    char* text;                 
    char* font;                 
    char* image;
    int border;                 
    vec4_t bgcolor;             
    vec4_t bordercolor;         
    vec4_t color;               
    vec4_t selectedColor;       
    vec4_t flashColor;          
    /* extended behaviour */
    hashTable_s* nodeMethods;       
    /* common events */
    struct uiAction_s* onClick;
    struct uiAction_s* onRightClick;
    struct uiAction_s* onMiddleClick;
    struct uiAction_s* onWheel;
    struct uiAction_s* onMouseEnter;
    struct uiAction_s* onMouseLeave;
    struct uiAction_s* onWheelUp;
    struct uiAction_s* onWheelDown;
    struct uiAction_s* onChange;    
    /* common events lua based */
    /* note: if new events are added here, make sure the value is initialized to LUA_NOREF
    @sa: UI_AllocNodeWithoutNew */
    LUA_EVENT lua_onClick; 
    LUA_EVENT lua_onRightClick; 
    LUA_EVENT lua_onMiddleClick; 
    LUA_EVENT lua_onWheelUp; 
    LUA_EVENT lua_onWheelDown; 
    LUA_EVENT lua_onWheel; 
    LUA_EVENT lua_onFocusGained; 
    LUA_EVENT lua_onFocusLost; 
    LUA_EVENT lua_onKeyPressed; 
    LUA_EVENT lua_onKeyReleased; 
    LUA_EVENT lua_onLoaded; 
    LUA_EVENT lua_onActivate; 
    LUA_EVENT lua_onMouseEnter; 
    LUA_EVENT lua_onMouseLeave; 
    LUA_EVENT lua_onChange; 
    LUA_EVENT lua_onVisibleWhen; 
    bool dragdrop; 
    LUA_EVENT lua_onDragDropEnter; 
    LUA_EVENT lua_onDragDropLeave; 
    LUA_EVENT lua_onDragDropMove; 
    LUA_EVENT lua_onDragDropDrop; 
    LUA_EVENT lua_onDragDropFinished; 
};


#define UI_EXTRADATA_POINTER(NODE, TYPE) ((TYPE*)((char*)NODE + sizeof(uiNode_t)))
#define UI_EXTRADATA(NODE, TYPE) (*UI_EXTRADATA_POINTER(NODE, TYPE))
#define UI_EXTRADATACONST_POINTER(NODE, TYPE) ((TYPE*)((const char*)NODE + sizeof(uiNode_t)))
#define UI_EXTRADATACONST(NODE, TYPE) (*UI_EXTRADATACONST_POINTER(NODE, const TYPE))

/* module initialization */
void UI_InitNodes(void);

/* nodes */
uiNode_t* UI_AllocNode(const char* name, const char* type, bool isDynamic);
uiNode_t* UI_GetNodeByPath(const char* path) __attribute__ ((warn_unused_result));
void UI_ReadNodePath(const char* path, const uiNode_t* relativeNode, const uiNode_t* iterationNode, uiNode_t** resultNode, const value_t** resultProperty, value_t* luaMethod = nullptr);
uiNode_t* UI_GetNodeAtPosition(int x, int y) __attribute__ ((warn_unused_result));
const char* UI_GetPath(const uiNode_t* node) __attribute__ ((warn_unused_result));
uiNode_t* UI_CloneNode(const uiNode_t* node, uiNode_t* newWindow, bool recursive, const char* newName, bool isDynamic) __attribute__ ((warn_unused_result));
bool UI_CheckVisibility(uiNode_t* node);
void UI_DeleteAllChild(uiNode_t* node);
void UI_DeleteNode(uiNode_t* node);

/* behaviours */
/* @todo move it to main */
uiBehaviour_t* UI_GetNodeBehaviour(const char* name) __attribute__ ((warn_unused_result));
uiBehaviour_t* UI_GetNodeBehaviourByIndex(int index) __attribute__ ((warn_unused_result));
int UI_GetNodeBehaviourCount(void) __attribute__ ((warn_unused_result));