/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2013 Blender Foundation.
 * All rights reserved.
 *
 * Original Author: Joshua Leung
 * Contributor(s): None Yet
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/** \file blender/depsgraph/intern/nodes/deg_node_operation.h
 *  \ingroup depsgraph
 */

#pragma once

#include "intern/nodes/deg_node.h"

struct ID;

struct Depsgraph;

namespace DEG {

struct ComponentDepsNode;

/* Flags for Depsgraph Nodes. */
typedef enum eDepsOperation_Flag {
	/* Node needs to be updated. */
	DEPSOP_FLAG_NEEDS_UPDATE       = (1 << 0),
	/* Node was directly modified, causing need for update. */
	DEPSOP_FLAG_DIRECTLY_MODIFIED  = (1 << 1),
	/* Node was updated due to user input. */
	DEPSOP_FLAG_USER_MODIFIED      = (1 << 2),

	/* Set of flags which gets flushed along the relations. */
	DEPSOP_FLAG_FLUSH = (DEPSOP_FLAG_USER_MODIFIED)
} eDepsOperation_Flag;

/* Atomic Operation - Base type for all operations */
struct OperationDepsNode : public DepsNode {
	OperationDepsNode();
	~OperationDepsNode();

	virtual string identifier() const override;
	string full_identifier() const;

	virtual void tag_update(Depsgraph *graph, eDepsTag_Source source) override;

	bool is_noop() const { return (bool)evaluate == false; }

	virtual OperationDepsNode *get_entry_operation() override {
		return this;
	}
	virtual OperationDepsNode *get_exit_operation() override {
		return this;
	}

	/* Set this operation as component's entry/exit operation. */
	void set_as_entry();
	void set_as_exit();

	/* Component that contains the operation. */
	ComponentDepsNode *owner;

	/* Callback for operation. */
	DepsEvalOperationCb evaluate;

	/* How many inlinks are we still waiting on before we can be evaluated. */
	uint32_t num_links_pending;
	bool scheduled;

	/* Identifier for the operation being performed. */
	eDepsOperation_Code opcode;
	int name_tag;

	/* (eDepsOperation_Flag) extra settings affecting evaluation. */
	int flag;

	DEG_DEPSNODE_DECLARE;
};

void deg_register_operation_depsnodes();

}  // namespace DEG