godot/editor/array_property_edit.cpp

/*************************************************************************/
/*  array_property_edit.cpp                                              */
/*************************************************************************/
/*                       This file is part of:                           */
/*                           GODOT ENGINE                                */
/*                      https://godotengine.org                          */
/*************************************************************************/
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur.                 */
/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md)    */
/*                                                                       */
/* 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 "array_property_edit.h"

#include "core/io/marshalls.h"
#include "editor_node.h"

#define ITEMS_PER_PAGE 100

Variant ArrayPropertyEdit::get_array() const {

	Object *o = ObjectDB::get_instance(obj);
	if (!o)
		return Array();
	Variant arr = o->get(property);
	if (!arr.is_array()) {
		Variant::CallError ce;
		arr = Variant::construct(default_type, NULL, 0, ce);
	}
	return arr;
}

void ArrayPropertyEdit::_notif_change() {
	_change_notify();
}
void ArrayPropertyEdit::_notif_changev(const String &p_v) {

	_change_notify(p_v.utf8().get_data());
}

void ArrayPropertyEdit::_set_size(int p_size) {

	Variant arr = get_array();
	arr.call("resize", p_size);
	Object *o = ObjectDB::get_instance(obj);
	if (!o)
		return;

	o->set(property, arr);
}

void ArrayPropertyEdit::_set_value(int p_idx, const Variant &p_value) {

	Variant arr = get_array();
	arr.set(p_idx, p_value);
	Object *o = ObjectDB::get_instance(obj);
	if (!o)
		return;

	o->set(property, arr);
}

bool ArrayPropertyEdit::_set(const StringName &p_name, const Variant &p_value) {

	String pn = p_name;

	if (pn.begins_with("array/")) {

		if (pn == "array/size") {

			Variant arr = get_array();
			int size = arr.call("size");

			int newsize = p_value;
			if (newsize == size)
				return true;

			UndoRedo *ur = EditorNode::get_singleton()->get_undo_redo();
			ur->create_action(TTR("Resize Array"));
			ur->add_do_method(this, "_set_size", newsize);
			ur->add_undo_method(this, "_set_size", size);
			if (newsize < size) {
				for (int i = newsize; i < size; i++) {
					ur->add_undo_method(this, "_set_value", i, arr.get(i));
				}
			} else if (newsize > size) {

				Variant init;
				Variant::CallError ce;
				Variant::Type new_type = subtype;
				if (new_type == Variant::NIL && size) {
					new_type = arr.get(size - 1).get_type();
				}
				if (new_type != Variant::NIL) {
					init = Variant::construct(new_type, NULL, 0, ce);
					for (int i = size; i < newsize; i++) {
						ur->add_do_method(this, "_set_value", i, init);
					}
				}
			}
			ur->add_do_method(this, "_notif_change");
			ur->add_undo_method(this, "_notif_change");
			ur->commit_action();
			return true;
		}
		if (pn == "array/page") {
			page = p_value;
			_change_notify();
			return true;
		}

	} else if (pn.begins_with("indices")) {

		if (pn.find("_") != -1) {
			//type
			int idx = pn.get_slicec('/', 1).get_slicec('_', 0).to_int();

			int type = p_value;

			Variant arr = get_array();

			Variant value = arr.get(idx);
			if (value.get_type() != type && type >= 0 && type < Variant::VARIANT_MAX) {
				Variant::CallError ce;
				Variant new_value = Variant::construct(Variant::Type(type), NULL, 0, ce);
				UndoRedo *ur = EditorNode::get_singleton()->get_undo_redo();

				ur->create_action(TTR("Change Array Value Type"));
				ur->add_do_method(this, "_set_value", idx, new_value);
				ur->add_undo_method(this, "_set_value", idx, value);
				ur->add_do_method(this, "_notif_change");
				ur->add_undo_method(this, "_notif_change");
				ur->commit_action();
			}
			return true;

		} else {
			int idx = pn.get_slicec('/', 1).to_int();
			Variant arr = get_array();

			Variant value = arr.get(idx);
			UndoRedo *ur = EditorNode::get_singleton()->get_undo_redo();

			ur->create_action(TTR("Change Array Value"));
			ur->add_do_method(this, "_set_value", idx, p_value);
			ur->add_undo_method(this, "_set_value", idx, value);
			ur->add_do_method(this, "_notif_changev", p_name);
			ur->add_undo_method(this, "_notif_changev", p_name);
			ur->commit_action();
			return true;
		}
	}

	return false;
}

bool ArrayPropertyEdit::_get(const StringName &p_name, Variant &r_ret) const {

	Variant arr = get_array();
	//int size = arr.call("size");

	String pn = p_name;
	if (pn.begins_with("array/")) {

		if (pn == "array/size") {
			r_ret = arr.call("size");
			return true;
		}
		if (pn == "array/page") {
			r_ret = page;
			return true;
		}
	} else if (pn.begins_with("indices")) {

		if (pn.find("_") != -1) {
			//type
			int idx = pn.get_slicec('/', 1).get_slicec('_', 0).to_int();
			bool valid;
			r_ret = arr.get(idx, &valid);
			if (valid)
				r_ret = r_ret.get_type();
			return valid;

		} else {
			int idx = pn.get_slicec('/', 1).to_int();
			bool valid;
			r_ret = arr.get(idx, &valid);

			if (r_ret.get_type() == Variant::OBJECT && Object::cast_to<EncodedObjectAsID>(r_ret)) {
				r_ret = Object::cast_to<EncodedObjectAsID>(r_ret)->get_object_id();
			}

			return valid;
		}
	}

	return false;
}

void ArrayPropertyEdit::_get_property_list(List<PropertyInfo> *p_list) const {

	Variant arr = get_array();
	int size = arr.call("size");

	p_list->push_back(PropertyInfo(Variant::INT, "array/size", PROPERTY_HINT_RANGE, "0,100000,1"));
	int pages = size / ITEMS_PER_PAGE;
	if (pages > 0)
		p_list->push_back(PropertyInfo(Variant::INT, "array/page", PROPERTY_HINT_RANGE, "0," + itos(pages) + ",1"));

	int offset = page * ITEMS_PER_PAGE;

	int items = MIN(size - offset, ITEMS_PER_PAGE);

	for (int i = 0; i < items; i++) {

		Variant v = arr.get(i + offset);
		bool is_typed = arr.get_type() != Variant::ARRAY || subtype != Variant::NIL;

		if (!is_typed) {
			p_list->push_back(PropertyInfo(Variant::INT, "indices/" + itos(i + offset) + "_type", PROPERTY_HINT_ENUM, vtypes));
		}

		if (v.get_type() == Variant::OBJECT && Object::cast_to<EncodedObjectAsID>(v)) {
			p_list->push_back(PropertyInfo(Variant::INT, "indices/" + itos(i + offset), PROPERTY_HINT_OBJECT_ID, "Object"));
			continue;
		}

		if (is_typed || v.get_type() != Variant::NIL) {
			PropertyInfo pi(v.get_type(), "indices/" + itos(i + offset));
			if (subtype != Variant::NIL) {
				pi.type = Variant::Type(subtype);
				pi.hint = PropertyHint(subtype_hint);
				pi.hint_string = subtype_hint_string;
			} else if (v.get_type() == Variant::OBJECT) {
				pi.hint = PROPERTY_HINT_RESOURCE_TYPE;
				pi.hint_string = "Resource";
			}

			p_list->push_back(pi);
		}
	}
}

void ArrayPropertyEdit::edit(Object *p_obj, const StringName &p_prop, const String &p_hint_string, Variant::Type p_deftype) {

	page = 0;
	property = p_prop;
	obj = p_obj->get_instance_id();
	default_type = p_deftype;

	if (!p_hint_string.empty()) {
		int hint_subtype_seperator = p_hint_string.find(":");
		if (hint_subtype_seperator >= 0) {
			String subtype_string = p_hint_string.substr(0, hint_subtype_seperator);

			int slash_pos = subtype_string.find("/");
			if (slash_pos >= 0) {
				subtype_hint = PropertyHint(subtype_string.substr(slash_pos + 1, subtype_string.size() - slash_pos - 1).to_int());
				subtype_string = subtype_string.substr(0, slash_pos);
			}

			subtype_hint_string = p_hint_string.substr(hint_subtype_seperator + 1, p_hint_string.size() - hint_subtype_seperator - 1);
			subtype = Variant::Type(subtype_string.to_int());
		}
	}
}

Node *ArrayPropertyEdit::get_node() {

	return Object::cast_to<Node>(ObjectDB::get_instance(obj));
}

void ArrayPropertyEdit::_bind_methods() {

	ClassDB::bind_method(D_METHOD("_set_size"), &ArrayPropertyEdit::_set_size);
	ClassDB::bind_method(D_METHOD("_set_value"), &ArrayPropertyEdit::_set_value);
	ClassDB::bind_method(D_METHOD("_notif_change"), &ArrayPropertyEdit::_notif_change);
	ClassDB::bind_method(D_METHOD("_notif_changev"), &ArrayPropertyEdit::_notif_changev);
}

ArrayPropertyEdit::ArrayPropertyEdit() {
	page = 0;
	for (int i = 0; i < Variant::VARIANT_MAX; i++) {

		if (i > 0)
			vtypes += ",";
		vtypes += Variant::get_type_name(Variant::Type(i));
	}
	default_type = Variant::NIL;
	subtype = Variant::NIL;
	subtype_hint = PROPERTY_HINT_NONE;
	subtype_hint_string = "";
}