ui_parse.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 "../../common/scripts.h"

struct uiNode_t;
struct uiAction_s;
struct value_s;

bool UI_ParseWindow(const char* type, const char* name, const char** text);
bool UI_ParseComponent(const char* type, const char* name, const char** text);
bool UI_ParseSprite(const char* name, const char** text);
bool UI_ParseUIModel(const char* name, const char** text);
float UI_GetReferenceFloat(uiNode_t const* node, const void* ref);
const char* UI_GetReferenceString(uiNode_t const* node, const char* ref) __attribute__ ((warn_unused_result));
const value_t* UI_FindPropertyByName(const value_t* propertyList, const char* name) __attribute__ ((warn_unused_result));
char* UI_AllocStaticString(const char* string, int size) __attribute__ ((warn_unused_result));
float* UI_AllocStaticFloat(int count) __attribute__ ((warn_unused_result));
vec4_t* UI_AllocStaticColor(int count) __attribute__ ((warn_unused_result));
struct uiAction_s* UI_AllocStaticAction(void) __attribute__ ((warn_unused_result));
bool UI_InitRawActionValue(struct uiAction_s* action, uiNode_t* node, const struct value_s* property, const char* string);

bool UI_TokenIsReserved (const char* name);
bool UI_TokenIsName (const char* name, bool isQuoted);

/* main special type */
#define V_UI_MASK           0x8F00          
#define V_UI                0x8000          
#define V_NOT_UI            0
#define V_UI_ACTION         (V_UI + 0)      
#define V_UI_EXCLUDERECT    (V_UI + 1)      
#define V_UI_SPRITEREF      (V_UI + 3)      
#define V_UI_IF             (V_UI + 4)      
#define V_UI_DATAID         (V_UI + 5)
#define V_UI_CVAR           (V_UI + 0x0100) 
#define V_UI_REF            (V_UI + 0x0200) 
#define V_UI_NODEMETHOD     (V_UI + 0x0400) 
#define V_UI_NODEMETHOD_LUA (V_UI + 0x0800) 
/* alias */
#define V_UI_ALIGN          V_INT

/* composite special type */
#define V_CVAR_OR_FLOAT         (V_UI_CVAR + V_FLOAT)
#define V_CVAR_OR_STRING        (V_UI_CVAR + V_STRING)
#define V_CVAR_OR_LONGSTRING    (V_UI_CVAR + V_LONGSTRING)
#define V_REF_OF_STRING         (V_UI_REF + V_STRING)