RmlUi/Source/Core/ElementDecoration.cpp

/*
 * This source file is part of libRocket, the HTML/CSS Interface Middleware
 *
 * For the latest information, see http://www.librocket.com
 *
 * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
 *
 * 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 "precompiled.h"
#include "ElementDecoration.h"
#include "ElementDefinition.h"
#include "../../Include/Rocket/Core/Decorator.h"
#include "../../Include/Rocket/Core/Element.h"

namespace Rocket {
namespace Core {

ElementDecoration::ElementDecoration(Element* _element)
{
	element = _element;
	decorators_dirty = false;
}

ElementDecoration::~ElementDecoration()
{
	ReleaseDecorators();
}

// Releases existing decorators and loads all decorators required by the element's definition.
bool ElementDecoration::ReloadDecorators()
{
	ReleaseDecorators();

	StyleSheet* stylesheet = element->GetStyleSheet();
	if (!stylesheet)
		return true;

	const Property* property = element->GetLocalProperty(PropertyId::Decorator);
	if (!property)
		return true;

	String decorator_value = property->Get<String>();

	// @performance: Can optimize for the case of only one decorator
	StringList decorator_list;
	// We use custom quote characters as we don't want to split on any commas inside parenthesis, which may appear in decorator shorthands.
	StringUtilities::ExpandString(decorator_list, decorator_value, ',', '(', ')');

	for (const String& name : decorator_list)
	{
		Decorator* decorator = stylesheet->GetOrInstanceDecorator(name, property->source, property->source_line_number);

		if (decorator)
			LoadDecorator(decorator);
	}

	return true;
}

// Loads a single decorator and adds it to the list of loaded decorators for this element.
int ElementDecoration::LoadDecorator(Decorator* decorator)
{
	DecoratorHandle element_decorator;
	element_decorator.decorator = decorator;
	element_decorator.decorator->AddReference();
	element_decorator.decorator_data = decorator->GenerateElementData(element);

	decorators.push_back(element_decorator);
	return (int) (decorators.size() - 1);
}

// Releases all existing decorators and frees their data.
void ElementDecoration::ReleaseDecorators()
{
	for (size_t i = 0; i < decorators.size(); i++)
	{
		if (decorators[i].decorator_data)
			decorators[i].decorator->ReleaseElementData(decorators[i].decorator_data);

		decorators[i].decorator->RemoveReference();
	}

	decorators.clear();
}


void ElementDecoration::RenderDecorators()
{
	// @performance: Ignore dirty flag if e.g. pseudo classes do not affect the decorators
	if (decorators_dirty)
	{
		decorators_dirty = false;
		ReloadDecorators();
	}

	// Render the decorators attached to this element in its current state.
	// Render from back to front for correct render order.
	for (int i = (int)decorators.size() - 1; i >= 0; i--)
	{
		DecoratorHandle& decorator = decorators[i];
		decorator.decorator->RenderElement(element, decorator.decorator_data);
	}
}

void ElementDecoration::DirtyDecorators()
{
	decorators_dirty = true;
}

// Iterates over all active decorators attached to the decoration's element.
bool ElementDecoration::IterateDecorators(int& index, PseudoClassList& pseudo_classes, String& name, Decorator*& decorator, DecoratorDataHandle& decorator_data) const
{
	if (index < 0)
		return false;

	if (index < (int)decorators.size())
	{
		decorator = decorators[index].decorator;
		decorator_data = decorators[index].decorator_data;
		name = ":not implemented:";

		index += 1;
		return true;
	}

	return false;
}

}
}