/*
 * The contents of this file are subject to the Interbase Public
 * License Version 1.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy
 * of the License at http://www.Inprise.com/IPL.html
 *
 * Software distributed under the License is distributed on an
 * "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express
 * or implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code was created by Inprise Corporation
 * and its predecessors. Portions created by Inprise Corporation are
 * Copyright (C) Inprise Corporation.
 *
 * All Rights Reserved.
 * Contributor(s): ______________________________________.
 * Adriano dos Santos Fernandes - refactored from pass1.cpp
 */

#ifndef DSQL_VISITORS_H
#define DSQL_VISITORS_H

#include "../jrd/common.h"
#include "../dsql/dsql.h"
#include "../dsql/node.h"
#include "../common/classes/array.h"
#include "../common/classes/auto.h"

namespace Jrd {

class CompilerScratch;
class dsql_nod;
class ExprNode;
class jrd_nod;
class JrdNodeVisitor;


enum FieldMatchType
{
	FIELD_MATCH_TYPE_EQUAL = 0,
	FIELD_MATCH_TYPE_LOWER = 1,
	FIELD_MATCH_TYPE_LOWER_EQUAL = 2
	/***
	,
	FIELD_MATCH_TYPE_HIGHER = 3,
	FIELD_MATCH_TYPE_HIGHER_EQUAL = 4
	***/
};


template <typename T, typename T2>
class DsqlNodeVisitor
{
private:
	typedef bool (ExprNode::*Callback)(DsqlNodeVisitor& visitor);

public:
	template <typename T3>
	DsqlNodeVisitor(bool aAssertOnOthers, bool aReturnOnOthers, bool (ExprNode::*aExprVisit)(T3& visitor))
		: assertOnOthers(aAssertOnOthers),
		  returnOnOthers(aReturnOnOthers),
		  exprVisit(reinterpret_cast<Callback>(aExprVisit)),
		  currentNode(NULL)
	{
	}

public:
	dsql_nod* getCurrentNode()
	{
		return *currentNode;
	}

	void replaceNode(dsql_nod* node)
	{
		*currentNode = node;
	}

	bool visit(T2 nodePtr)
	{
		Firebird::AutoSetRestore<T2> autoInsideHigherMap(&currentNode, nodePtr);
		return internalVisit(*nodePtr);
	}

	bool visitChildren(T node);

	virtual bool internalVisit(T node) = 0;

private:
	const bool assertOnOthers;
	const bool returnOnOthers;
	const Callback exprVisit;
	T2 currentNode;
};

typedef DsqlNodeVisitor<const Jrd::dsql_nod*, const Jrd::dsql_nod* const*> ConstDsqlNodeVisitor;
typedef DsqlNodeVisitor<Jrd::dsql_nod*, Jrd::dsql_nod**> NonConstDsqlNodeVisitor;


// Check for an aggregate expression in an expression. It could be buried in an expression
// tree and therefore call itselfs again. The level parameters (currentLevel & deepestLevel)
// are used to see how deep we are with passing sub-queries (= scope_level).
class AggregateFinder : public ConstDsqlNodeVisitor
{
public:
	AggregateFinder(const DsqlCompilerScratch* aDsqlScratch, bool aWindow);

	static bool find(const DsqlCompilerScratch* dsqlScratch, bool window, const dsql_nod* node)
	{
		return AggregateFinder(dsqlScratch, window).visit(&node);
	}

	virtual bool internalVisit(const dsql_nod* node);

public:
	const DsqlCompilerScratch* const dsqlScratch;
	bool window;
	USHORT currentLevel;
	USHORT deepestLevel;
	bool ignoreSubSelects;
};

// Check the fields inside an aggregate and check if the field scope_level meets the specified
// conditions.
//
// The SQL 2008 standard says:
// <where clause> ::=
//   WHERE <search condition>
// Syntax Rules
// 1) If a <value expression> directly contained in the <search condition> is a
// <set function specification>, then the <where clause> shall be contained in a <having clause>
// or <select list>, the <set function specification> shall contain a column reference, and
// every column reference contained in an aggregated argument of the <set function specification>
// shall be an outer reference.
//    NOTE 160 - outer reference is defined in Subclause 6.7, "<column reference>".
// 2) The <search condition> shall not contain a <window function> without an intervening
// <query expression>.
class Aggregate2Finder : public ConstDsqlNodeVisitor
{
public:
	Aggregate2Finder(USHORT aCheckScopeLevel, FieldMatchType aMatchType, bool aWindowOnly);

	static bool find(USHORT checkScopeLevel, FieldMatchType matchType, bool windowOnly,
		const dsql_nod* node)
	{
		return Aggregate2Finder(checkScopeLevel, matchType, windowOnly).visit(&node);
	}

public:
	virtual bool internalVisit(const dsql_nod* node);

public:
	const USHORT checkScopeLevel;
	const FieldMatchType matchType;
	bool windowOnly;
	bool currentScopeLevelEqual;
};

// Check the fields inside an aggregate and check if the field scope_level meets the specified
// conditions.
class FieldFinder : public ConstDsqlNodeVisitor
{
public:
	FieldFinder(USHORT aCheckScopeLevel, FieldMatchType aMatchType);

	static bool find(USHORT checkScopeLevel, FieldMatchType matchType, const dsql_nod* node)
	{
		return FieldFinder(checkScopeLevel, matchType).visit(&node);
	}

	virtual bool internalVisit(const dsql_nod* node);

public:
	bool getField() const
	{
		return field;
	}

public:
	const USHORT checkScopeLevel;
	const FieldMatchType matchType;
	bool field;
};

// Validate that an expanded field / context pair is in a specified list. This is used in one
// instance to check that a simple field selected through a grouping rse is a grouping field -
// thus a valid field reference. For the sake of argument, we'll match qualified to unqualified
// reference, but qualified reference must match completely.
// A list element containing a simple CAST for collation purposes is allowed.
class InvalidReferenceFinder : public ConstDsqlNodeVisitor
{
public:
	InvalidReferenceFinder(const dsql_ctx* aContext, const dsql_nod* aList);

	static bool find(const dsql_ctx* context, const dsql_nod* list, const dsql_nod* node)
	{
		return InvalidReferenceFinder(context, list).visit(&node);
	}

	virtual bool internalVisit(const dsql_nod* node);

public:
	const dsql_ctx* const context;
	const dsql_nod* const list;
	bool insideOwnMap;
	bool insideHigherMap;
};

// Called to map fields used in an aggregate-context after all pass1 calls
// (SELECT-, ORDER BY-lists). Walk completly through the given node 'field' and map the fields
// with same scope_level as the given context to the given context with the post_map function.
class FieldRemapper : public NonConstDsqlNodeVisitor
{
public:
	FieldRemapper(DsqlCompilerScratch* aDsqlScratch, dsql_ctx* aContext, bool aWindow,
				dsql_nod* aPartitionNode, dsql_nod* aOrderNode);

	static dsql_nod* remap(DsqlCompilerScratch* dsqlScratch, dsql_ctx* context, bool window,
		dsql_nod* field, dsql_nod* partitionNode = NULL, dsql_nod* orderNode = NULL)
	{
		// The bool value returned by the visitor is completely discarded in this class.
		FieldRemapper(dsqlScratch, context, window, partitionNode, orderNode).visit(&field);
		return field;
	}

	virtual bool internalVisit(dsql_nod* node);

public:
	DsqlCompilerScratch* const dsqlScratch;
	dsql_ctx* const context;
	const bool window;
	dsql_nod* partitionNode;
	dsql_nod* orderNode;
	USHORT currentLevel;
};

// Search if a sub select is buried inside a select list from a query expression.
class SubSelectFinder : public ConstDsqlNodeVisitor
{
public:
	SubSelectFinder();

	static bool find(const dsql_nod* node)
	{
		return SubSelectFinder().visit(&node);
	}

	virtual bool internalVisit(const dsql_nod* node);
};


class JrdNodeVisitor
{
private:
	typedef bool (ExprNode::*Callback)(JrdNodeVisitor& visitor);

public:
	template <typename T>
	JrdNodeVisitor(bool aReturnOnOthers, bool (ExprNode::*aExprVisit)(T& visitor))
		: returnOnOthers(aReturnOnOthers),
		  exprVisit(reinterpret_cast<Callback>(aExprVisit))
	{
	}

public:
	bool visitChildren(jrd_nod* node);

	virtual bool visit(jrd_nod* node) = 0;

private:
	const bool returnOnOthers;
	const Callback exprVisit;
};


// Check if expression could return NULL or expression can turn NULL into a true/false.
class PossibleUnknownFinder : public JrdNodeVisitor
{
public:
	PossibleUnknownFinder();

public:
	static bool find(jrd_nod* node)
	{
		return PossibleUnknownFinder().visit(node);
	}

protected:
	virtual bool visit(jrd_nod* node);
};

// Search if somewhere in the expression the given stream is used.
// If a unknown node is found it will return true.
class StreamFinder : public JrdNodeVisitor
{
public:
	StreamFinder(CompilerScratch* aCsb, UCHAR aStream);

public:
	static bool find(CompilerScratch* csb, UCHAR stream, jrd_nod* node)
	{
		return StreamFinder(csb, stream).visit(node);
	}

protected:
	virtual bool visit(jrd_nod* node);

private:
	CompilerScratch* const csb;
	const UCHAR stream;
};

// Return all streams referenced by the expression.
class StreamsCollector : public JrdNodeVisitor
{
public:
	StreamsCollector(Firebird::SortedArray<int>& aStreams);

public:
	static bool collect(jrd_nod* node, Firebird::SortedArray<int>& streams)
	{
		return StreamsCollector(streams).visit(node);
	}

protected:
	virtual bool visit(jrd_nod* node);

private:
	Firebird::SortedArray<int>& streams;
};

// Verify if this node is allowed in an unmapped boolean.
class UnmappedNodeGetter : public JrdNodeVisitor
{
public:
	UnmappedNodeGetter(jrd_nod* aMap, UCHAR aShellStream);

public:
	static jrd_nod* get(jrd_nod* map, UCHAR shellStream, jrd_nod* node)
	{
		UnmappedNodeGetter obj(map, shellStream);
		return obj.visit(node) && !obj.invalid ? obj.nodeFound : NULL;
	}

protected:
	virtual bool visit(jrd_nod* node);

public:
	jrd_nod* const map;
	const UCHAR shellStream;
	bool rootNode;
	bool invalid;
	jrd_nod* nodeFound;
};


// Generic node copier.
class NodeCopier
{
public:
	NodeCopier(CompilerScratch* aCsb, UCHAR* aRemap)
		: csb(aCsb),
		  remap(aRemap),
		  message(NULL)
	{
	}

	virtual ~NodeCopier()
	{
	}

public:
	jrd_nod* copy(thread_db* tdbb, jrd_nod* input);

	static jrd_nod* copy(thread_db* tdbb, CompilerScratch* csb, jrd_nod* input, UCHAR* remap)
	{
		return NodeCopier(csb, remap).copy(tdbb, input);
	}

protected:
	virtual bool remapArgument()
	{
		return false;
	}

	virtual USHORT remapField(USHORT /*stream*/, USHORT fldId)
	{
		return fldId;
	}

	virtual USHORT getFieldId(jrd_nod* input);

protected:
	CompilerScratch* csb;
	UCHAR* remap;
	jrd_nod* message;
};


template <typename T, typename T2>
inline bool DsqlNodeVisitor<T, T2>::visitChildren(T node)
{
	using namespace Firebird;
	using namespace Dsql;

	bool ret = false;

	if (!node)
		return ret;

	switch (node->nod_type)
	{
		case nod_class_exprnode:
		{
			Jrd::ExprNode* exprNode = reinterpret_cast<Jrd::ExprNode*>(node->nod_arg[0]);
			ret |= (exprNode->*exprVisit)(*this);
			break;
		}

		case nod_constant:
		case nod_parameter:
		case nod_variable:
		case nod_null:
		case nod_current_date:
		case nod_current_time:
		case nod_current_timestamp:
		case nod_user_name:
		case nod_current_role:
		case nod_dom_value:
			break;

		case nod_alias:
			ret |= visit(&node->nod_arg[e_alias_value]);
			break;

		case nod_hidden_var:
			ret |= visit(&node->nod_arg[e_hidden_var_expr]);
			break;

		case nod_order:
			ret |= visit(&node->nod_arg[e_order_field]);
			break;

		case nod_gen_id:
		case nod_gen_id2:
		case nod_cast:
		case nod_sys_function:
			if (node->nod_count == 2)
				ret |= visit(&node->nod_arg[1]);
			break;

		case nod_udf:
			if (node->nod_count == 3)
				ret |= visit(&node->nod_arg[2]);
			break;

		case nod_or:
		case nod_and:
		case nod_not:
		case nod_equiv:
		case nod_eql:
		case nod_neq:
		case nod_gtr:
		case nod_geq:
		case nod_lss:
		case nod_leq:
		case nod_between:
		case nod_like:
		case nod_containing:
		case nod_similar:
		case nod_starting:
		case nod_missing:
		case nod_add:
		case nod_add2:
		case nod_divide:
		case nod_divide2:
		case nod_multiply:
		case nod_multiply2:
		case nod_negate:
		case nod_substr:
		case nod_subtract:
		case nod_subtract2:
		case nod_trim:
		case nod_upcase:
		case nod_lowcase:
		case nod_extract:
		case nod_strlen:
		case nod_simple_case:
		case nod_searched_case:
		case nod_any:
		case nod_ansi_any:
		case nod_ansi_all:
		case nod_list:
		case nod_join:
		case nod_join_inner:
		case nod_join_left:
		case nod_join_right:
		case nod_join_full:
		{
			T2 ptr = node->nod_arg;
			for (T2 end = ptr + node->nod_count; ptr < end; ++ptr)
				ret |= visit(ptr);
			break;
		}

		default:
			if (assertOnOthers)
				fb_assert(false);
			return returnOnOthers;
	}

	return ret;
}


} // namespace

#endif // DSQL_VISITORS_H