RmlUi/Source/Core/DataVariable.cpp

/*
 * This source file is part of RmlUi, the HTML/CSS Interface Middleware
 *
 * For the latest information, see http://github.com/mikke89/RmlUi
 *
 * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
 * Copyright (c) 2019-2023 The RmlUi Team, and contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

#include "../../Include/RmlUi/Core/DataVariable.h"

namespace Rml {

bool DataVariable::Get(Variant& variant)
{
	return definition->Get(ptr, variant);
}

bool DataVariable::Set(const Variant& variant)
{
	return definition->Set(ptr, variant);
}

int DataVariable::Size()
{
	return definition->Size(ptr);
}

DataVariable DataVariable::Child(const DataAddressEntry& address)
{
	return definition->Child(ptr, address);
}

DataVariableType DataVariable::Type()
{
	return definition->Type();
}

bool VariableDefinition::Get(void* /*ptr*/, Variant& /*variant*/)
{
	Log::Message(Log::LT_WARNING, "Values can only be retrieved from scalar data types.");
	return false;
}
bool VariableDefinition::Set(void* /*ptr*/, const Variant& /*variant*/)
{
	Log::Message(Log::LT_WARNING, "Values can only be assigned to scalar data types.");
	return false;
}
int VariableDefinition::Size(void* /*ptr*/)
{
	Log::Message(Log::LT_WARNING, "Tried to get the size from a non-array data type.");
	return 0;
}
DataVariable VariableDefinition::Child(void* /*ptr*/, const DataAddressEntry& /*address*/)
{
	Log::Message(Log::LT_WARNING, "Tried to get the child of a scalar type.");
	return DataVariable();
}

class LiteralIntDefinition final : public VariableDefinition {
public:
	LiteralIntDefinition() : VariableDefinition(DataVariableType::Scalar) {}

	bool Get(void* ptr, Variant& variant) override
	{
		variant = static_cast<int>(reinterpret_cast<intptr_t>(ptr));
		return true;
	}
};

DataVariable MakeLiteralIntVariable(int value)
{
	static LiteralIntDefinition literal_int_definition;
	return DataVariable(&literal_int_definition, reinterpret_cast<void*>(static_cast<intptr_t>(value)));
}

StructDefinition::StructDefinition() : VariableDefinition(DataVariableType::Struct) {}

DataVariable StructDefinition::Child(void* ptr, const DataAddressEntry& address)
{
	const String& name = address.name;
	if (name.empty())
	{
		Log::Message(Log::LT_WARNING, "Expected a struct member name but none given.");
		return DataVariable();
	}

	auto it = members.find(name);
	if (it == members.end())
	{
		Log::Message(Log::LT_WARNING, "Member %s not found in data struct.", name.c_str());
		return DataVariable();
	}

	VariableDefinition* next_definition = it->second.get();

	return DataVariable(next_definition, ptr);
}

void StructDefinition::AddMember(const String& name, UniquePtr<VariableDefinition> member)
{
	RMLUI_ASSERT(member);
	bool inserted = members.emplace(name, std::move(member)).second;
	RMLUI_ASSERTMSG(inserted, "Member name already exists.");
	(void)inserted;
}

FuncDefinition::FuncDefinition(DataGetFunc get, DataSetFunc set) :
	VariableDefinition(DataVariableType::Scalar), get(std::move(get)), set(std::move(set))
{}

bool FuncDefinition::Get(void* /*ptr*/, Variant& variant)
{
	if (!get)
		return false;
	get(variant);
	return true;
}

bool FuncDefinition::Set(void* /*ptr*/, const Variant& variant)
{
	if (!set)
		return false;
	set(variant);
	return true;
}

BasePointerDefinition::BasePointerDefinition(VariableDefinition* underlying_definition) :
	VariableDefinition(underlying_definition->Type()), underlying_definition(underlying_definition)
{}

bool BasePointerDefinition::Get(void* ptr, Variant& variant)
{
	if (!ptr)
		return false;
	return underlying_definition->Get(DereferencePointer(ptr), variant);
}

bool BasePointerDefinition::Set(void* ptr, const Variant& variant)
{
	if (!ptr)
		return false;
	return underlying_definition->Set(DereferencePointer(ptr), variant);
}

int BasePointerDefinition::Size(void* ptr)
{
	if (!ptr)
		return 0;
	return underlying_definition->Size(DereferencePointer(ptr));
}

DataVariable BasePointerDefinition::Child(void* ptr, const DataAddressEntry& address)
{
	if (!ptr)
		return DataVariable();
	return underlying_definition->Child(DereferencePointer(ptr), address);
}

} // namespace Rml