RecordSourceNodes.h

/*
 * 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
 */

#ifndef JRD_RECORD_SOURCE_NODES_H
#define JRD_RECORD_SOURCE_NODES_H

#include "../common/classes/alloc.h"
#include "../common/classes/array.h"
#include "../common/classes/objects_array.h"
#include "../common/classes/NestConst.h"
#include "../jrd/QualifiedName.h"
#include "../dsql/ExprNodes.h"
#include "../jrd/jrd.h"
#include "../jrd/exe.h"
#include "../dsql/Visitors.h"
#include "../dsql/pass1_proto.h"

namespace Jrd {

class IndexRetrieval;
class OptimizerRetrieval;
class ProcedureScan;
class BoolExprNode;
class MessageNode;
class RecSourceListNode;
class RelationSourceNode;
class RseNode;
class SelectExprNode;
class ValueListNode;


class SortNode : public Firebird::PermanentStorage, public Printable
{
public:
	explicit SortNode(MemoryPool& pool)
		: PermanentStorage(pool),
		  unique(false),
		  expressions(pool),
		  direction(pool),
		  nullOrder(pool)
	{
	}

public:
	virtual Firebird::string internalPrint(NodePrinter& printer) const
	{
		//// FIXME-PRINT:
		return "SortNode";
	}

	SortNode* copy(thread_db* tdbb, NodeCopier& copier) const;
	SortNode* pass1(thread_db* tdbb, CompilerScratch* csb);
	SortNode* pass2(thread_db* tdbb, CompilerScratch* csb);
	bool computable(CompilerScratch* csb, StreamType stream, bool allowOnlyCurrentStream);
	void findDependentFromStreams(const CompilerScratch* csb,
		StreamType currentStream, SortedStreamList* streamList);

	NullsPlacement getEffectiveNullOrder(unsigned index) const
	{
		if (direction[index] == ORDER_ASC)
			return (nullOrder[index] == NULLS_DEFAULT) ? NULLS_FIRST : nullOrder[index];
		else if (direction[index] == ORDER_DESC)
			return (nullOrder[index] == NULLS_DEFAULT) ? NULLS_LAST : nullOrder[index];

		fb_assert(false);
		return NULLS_DEFAULT;
	}

public:
	bool unique;						// sort uses unique key - for DISTINCT and GROUP BY
	NestValueArray expressions;			// sort expressions
	Firebird::Array<SortDirection> direction;	// rse_order_*
	Firebird::Array<NullsPlacement> nullOrder;	// rse_nulls_*
};

class MapNode : public Firebird::PermanentStorage, public Printable
{
public:
	explicit MapNode(MemoryPool& pool)
		: PermanentStorage(pool),
		  sourceList(pool),
		  targetList(pool)
	{
	}

	MapNode* copy(thread_db* tdbb, NodeCopier& copier) const;
	MapNode* pass1(thread_db* tdbb, CompilerScratch* csb);
	MapNode* pass2(thread_db* tdbb, CompilerScratch* csb);

public:
	virtual Firebird::string internalPrint(NodePrinter& printer) const
	{
		/*** FIXME-PRINT:
		NODE_PRINT(printer, sourceList);
		NODE_PRINT(printer, targetList);
		***/

		return "MapNode";
	}

public:
	NestValueArray sourceList;
	NestValueArray targetList;
};

class PlanNode : public Firebird::PermanentStorage, public Printable
{
public:
	enum Type : UCHAR
	{
		TYPE_JOIN,
		TYPE_RETRIEVE
	};

	struct AccessItem
	{
		explicit AccessItem(MemoryPool& pool)
			: relationId(0),
			  indexId(0),
			  indexName(pool)
		{
		}

		explicit AccessItem(MemoryPool& pool, const AccessItem& o)
			: relationId(o.relationId),
			  indexId(o.indexId),
			  indexName(pool, o.indexName)
		{
		}

		SLONG relationId;
		SLONG indexId;
		QualifiedName indexName;
	};

	struct AccessType
	{
		enum Type : UCHAR
		{
			TYPE_SEQUENTIAL,
			TYPE_NAVIGATIONAL,
			TYPE_INDICES
		};

		AccessType(MemoryPool& pool, Type aType)
			: type(aType),
			  items(pool)
		{
		}

		Type const type;
		Firebird::ObjectsArray<AccessItem> items;
	};

public:
	PlanNode(MemoryPool& pool, Type aType)
		: PermanentStorage(pool),
		  type(aType),
		  accessType(NULL),
		  recordSourceNode(NULL),
		  subNodes(pool),
		  dsqlNames(NULL)
	{
	}

public:
	virtual Firebird::string internalPrint(NodePrinter& printer) const
	{
		//// FIXME-PRINT:
		return "PlanNode";
	}

	PlanNode* dsqlPass(DsqlCompilerScratch* dsqlScratch);

private:
	dsql_ctx* dsqlPassAliasList(DsqlCompilerScratch* dsqlScratch);
	static dsql_ctx* dsqlPassAlias(DsqlCompilerScratch* dsqlScratch, DsqlContextStack& stack,
		const QualifiedName& alias);

public:
	Type const type;
	AccessType* accessType;
	RecordSourceNode* recordSourceNode;
	Firebird::Array<NestConst<PlanNode> > subNodes;
	Firebird::ObjectsArray<QualifiedName>* dsqlNames;
};

class InversionNode
{
public:
	enum Type : UCHAR
	{
		TYPE_AND,
		TYPE_OR,
		TYPE_IN,
		TYPE_DBKEY,
		TYPE_INDEX
	};

	InversionNode(Type aType, InversionNode* aNode1, InversionNode* aNode2)
		: impure(0),
		  id(0),
		  type(aType),
		  retrieval(NULL),
		  node1(aNode1),
		  node2(aNode2),
		  value(NULL)
	{
	}

	InversionNode(IndexRetrieval* aRetrieval, ULONG anImpure)
		: impure(anImpure),
		  id(0),
		  type(TYPE_INDEX),
		  retrieval(aRetrieval),
		  node1(NULL),
		  node2(NULL),
		  value(NULL)
	{
	}

	InversionNode(ValueExprNode* aValue, USHORT aId)
		: impure(0),
		  id(aId),
		  type(TYPE_DBKEY),
		  retrieval(NULL),
		  node1(NULL),
		  node2(NULL),
		  value(aValue)
	{
	}

	ULONG impure;
	USHORT id;
	Type type;
	NestConst<IndexRetrieval> retrieval;
	NestConst<InversionNode> node1;
	NestConst<InversionNode> node2;
	NestConst<ValueExprNode> value;
};

class DbKeyRangeNode
{
public:
	DbKeyRangeNode(ValueExprNode* aLower, ValueExprNode* aUpper)
		: lower(aLower), upper(aUpper)
	{
	}

	NestConst<ValueExprNode> lower;
	NestConst<ValueExprNode> upper;
};

class WithClause : public Firebird::Array<SelectExprNode*>
{
public:
	explicit WithClause(Firebird::MemoryPool& pool)
		: Firebird::Array<SelectExprNode*>(pool),
		  recursive(false)
	{
	}

public:
	bool recursive;
};


class LocalTableSourceNode final : public TypedNode<RecordSourceNode, RecordSourceNode::TYPE_LOCAL_TABLE>
{
public:
	explicit LocalTableSourceNode(MemoryPool& pool, const MetaName& aDsqlName = NULL)
		: TypedNode<RecordSourceNode, RecordSourceNode::TYPE_LOCAL_TABLE>(pool),
		  alias(pool)
	{
	}

	static LocalTableSourceNode* parse(thread_db* tdbb, CompilerScratch* csb, const SSHORT blrOp,
		bool parseContext);

	Firebird::string internalPrint(NodePrinter& printer) const override;
	RecordSourceNode* dsqlPass(DsqlCompilerScratch* dsqlScratch) override;

	bool dsqlSubSelectFinder(SubSelectFinder& /*visitor*/) override
	{
		return false;
	}

	bool dsqlMatch(DsqlCompilerScratch* dsqlScratch, const ExprNode* other, bool ignoreMapCast) const override;
	void genBlr(DsqlCompilerScratch* dsqlScratch) override;

	LocalTableSourceNode* copy(thread_db* tdbb, NodeCopier& copier) const override;

	RecordSourceNode* pass1(thread_db* tdbb, CompilerScratch* csb) override
	{
		return this;
	}

	void pass1Source(thread_db* tdbb, CompilerScratch* csb, RseNode* rse,
		BoolExprNode** boolean, RecordSourceNodeStack& stack) override;

	RecordSourceNode* pass2(thread_db* /*tdbb*/, CompilerScratch* /*csb*/) override
	{
		return this;
	}

	void pass2Rse(thread_db* tdbb, CompilerScratch* csb) override;

	bool containsStream(StreamType checkStream) const override
	{
		return checkStream == stream;
	}

	void computeDbKeyStreams(StreamList& streamList) const override
	{
		streamList.add(getStream());
	}

	bool computable(CompilerScratch* /*csb*/, StreamType /*stream*/,
		bool /*allowOnlyCurrentStream*/, ValueExprNode* /*value*/) override
	{
		return true;
	}

	void findDependentFromStreams(const CompilerScratch* /*csb*/,
		StreamType /*currentStream*/, SortedStreamList* /*streamList*/) override
	{
	}

	RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream) override;

public:
	Firebird::string alias;
	USHORT tableNumber = 0;
	SSHORT context = 0;			// user-specified context number for the local table reference
};

class RelationSourceNode final : public TypedNode<RecordSourceNode, RecordSourceNode::TYPE_RELATION>
{
public:
	explicit RelationSourceNode(MemoryPool& pool, const QualifiedName& aDsqlName = {})
		: TypedNode<RecordSourceNode, RecordSourceNode::TYPE_RELATION>(pool),
		  dsqlName(pool, aDsqlName),
		  alias(pool),
		  context(0)
	{
	}

	static RelationSourceNode* parse(thread_db* tdbb, CompilerScratch* csb, const SSHORT blrOp,
		bool parseContext);

	virtual Firebird::string internalPrint(NodePrinter& printer) const;
	virtual RecordSourceNode* dsqlPass(DsqlCompilerScratch* dsqlScratch);

	virtual bool dsqlSubSelectFinder(SubSelectFinder& /*visitor*/)
	{
		return false;
	}

	virtual bool dsqlMatch(DsqlCompilerScratch* dsqlScratch, const ExprNode* other, bool ignoreMapCast) const;
	virtual void genBlr(DsqlCompilerScratch* dsqlScratch);

	virtual RelationSourceNode* copy(thread_db* tdbb, NodeCopier& copier) const;

	virtual RecordSourceNode* pass1(thread_db* tdbb, CompilerScratch* csb);

	virtual void pass1Source(thread_db* tdbb, CompilerScratch* csb, RseNode* rse,
		BoolExprNode** boolean, RecordSourceNodeStack& stack);

	virtual RecordSourceNode* pass2(thread_db* /*tdbb*/, CompilerScratch* /*csb*/)
	{
		return this;
	}

	virtual void pass2Rse(thread_db* tdbb, CompilerScratch* csb);

	virtual bool containsStream(StreamType checkStream) const
	{
		return checkStream == stream;
	}

	virtual void computeDbKeyStreams(StreamList& streamList) const
	{
		streamList.add(getStream());
	}

	virtual bool computable(CompilerScratch* /*csb*/, StreamType /*stream*/,
		bool /*allowOnlyCurrentStream*/, ValueExprNode* /*value*/)
	{
		return true;
	}

	virtual void findDependentFromStreams(const CompilerScratch* /*csb*/,
		StreamType /*currentStream*/, SortedStreamList* /*streamList*/)
	{
	}

	virtual RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream);

public:
	QualifiedName dsqlName;
	Firebird::string alias;	// SQL alias for the relation
	Rsc::Rel relation;

private:
	Rsc::Rel view;		// parent view for posting access

public:
	SSHORT context;			// user-specified context number for the relation reference
};

class ProcedureSourceNode final : public TypedNode<RecordSourceNode, RecordSourceNode::TYPE_PROCEDURE>
{
public:
	explicit ProcedureSourceNode(MemoryPool& pool,
			const QualifiedName& aDsqlName = {})
		: TypedNode<RecordSourceNode, RecordSourceNode::TYPE_PROCEDURE>(pool),
		  dsqlName(pool, aDsqlName),
		  alias(pool)
	{
	}

	static ProcedureSourceNode* parse(thread_db* tdbb, CompilerScratch* csb, const SSHORT blrOp,
		bool parseContext);

public:
	Firebird::string internalPrint(NodePrinter& printer) const override;
	RecordSourceNode* dsqlPass(DsqlCompilerScratch* dsqlScratch) override;

	bool dsqlAggregateFinder(AggregateFinder& visitor) override;
	bool dsqlAggregate2Finder(Aggregate2Finder& visitor) override;
	bool dsqlInvalidReferenceFinder(InvalidReferenceFinder& visitor) override;
	bool dsqlSubSelectFinder(SubSelectFinder& visitor) override;
	bool dsqlFieldFinder(FieldFinder& visitor) override;
	RecordSourceNode* dsqlFieldRemapper(FieldRemapper& visitor) override;

	bool dsqlMatch(DsqlCompilerScratch* dsqlScratch, const ExprNode* other, bool ignoreMapCast) const override;
	void genBlr(DsqlCompilerScratch* dsqlScratch) override;

	ProcedureSourceNode* copy(thread_db* tdbb, NodeCopier& copier) const override;

	RecordSourceNode* pass1(thread_db* tdbb, CompilerScratch* csb) override;
	void pass1Source(thread_db* tdbb, CompilerScratch* csb, RseNode* rse,
		BoolExprNode** boolean, RecordSourceNodeStack& stack) override;
	RecordSourceNode* pass2(thread_db* tdbb, CompilerScratch* csb) override;
	void pass2Rse(thread_db* tdbb, CompilerScratch* csb) override;

	bool containsStream(StreamType checkStream) const override
	{
		return checkStream == stream;
	}

	void computeDbKeyStreams(StreamList& /*streamList*/) const override
	{
	}

	bool deterministic(thread_db* /*tdbb*/) const override
	{
		return false;
	}

	bool computable(CompilerScratch* csb, StreamType stream,
		bool allowOnlyCurrentStream, ValueExprNode* value) override;
	void findDependentFromStreams(const CompilerScratch* csb,
		StreamType currentStream, SortedStreamList* streamList) override;

	void collectStreams(SortedStreamList& streamList) const override;

	RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream) override;

public:
	QualifiedName dsqlName;
	Firebird::string alias;

	/***
	dimitr: Referencing procedures via a pointer is not currently reliable, because
			procedures can be removed from the metadata cache after ALTER/DROP.
			Usually, this is prevented via the reference counting, but it's incremented
			only for compiled requests. Node trees without requests (e.g. computed fields)
			are not protected and may end with dead procedure pointers, causing problems
			(up to crashing) when they're copied the next time. See CORE-5456 / CORE-5457.

			ExecProcedureNode is a lucky exception because it's never (directly) used in
			expressions. Sub-procedures are safe too. In other cases the procedure object
			must be refetched from the metadata cache while copying the node.

			A better (IMO) solution would be to add a second-level reference counting for
			metadata objects since the parsing stage till either request creation or
			explicit unload from the metadata cache. But we don't have clearly established
			cache management policies yet, so I leave it for the other day.
	***/

	SubRoutine<jrd_prc> procedure;
	NestConst<ValueListNode> inputSources;
	NestConst<ValueListNode> inputTargets;
	NestConst<Firebird::ObjectsArray<MetaName>> dsqlInputArgNames;

private:
	NestConst<MessageNode> inputMessage;
	Rsc::Rel view;
	USHORT procedureId = 0;
	SSHORT context = 0;
};

class AggregateSourceNode final : public TypedNode<RecordSourceNode, RecordSourceNode::TYPE_AGGREGATE_SOURCE>
{
public:
	explicit AggregateSourceNode(MemoryPool& pool)
		: TypedNode<RecordSourceNode, RecordSourceNode::TYPE_AGGREGATE_SOURCE>(pool),
		  dsqlGroup(NULL),
		  dsqlRse(NULL),
		  group(NULL),
		  map(NULL),
		  rse(NULL),
		  dsqlWindow(false)
	{
	}

	static AggregateSourceNode* parse(thread_db* tdbb, CompilerScratch* csb);

	virtual Firebird::string internalPrint(NodePrinter& printer) const;
	virtual bool dsqlAggregateFinder(AggregateFinder& visitor);
	virtual bool dsqlAggregate2Finder(Aggregate2Finder& visitor);
	virtual bool dsqlInvalidReferenceFinder(InvalidReferenceFinder& visitor);
	virtual bool dsqlSubSelectFinder(SubSelectFinder& visitor);
	virtual bool dsqlFieldFinder(FieldFinder& visitor);
	virtual RecordSourceNode* dsqlFieldRemapper(FieldRemapper& visitor);

	virtual bool dsqlMatch(DsqlCompilerScratch* dsqlScratch, const ExprNode* other, bool ignoreMapCast) const;
	virtual void genBlr(DsqlCompilerScratch* dsqlScratch);

	virtual AggregateSourceNode* copy(thread_db* tdbb, NodeCopier& copier) const;
	virtual RecordSourceNode* pass1(thread_db* tdbb, CompilerScratch* csb);
	virtual void pass1Source(thread_db* tdbb, CompilerScratch* csb, RseNode* rse,
		BoolExprNode** boolean, RecordSourceNodeStack& stack);
	virtual RecordSourceNode* pass2(thread_db* tdbb, CompilerScratch* csb);
	virtual void pass2Rse(thread_db* tdbb, CompilerScratch* csb);
	virtual bool containsStream(StreamType checkStream) const;

	virtual void computeDbKeyStreams(StreamList& /*streamList*/) const
	{
	}

	virtual bool computable(CompilerScratch* csb, StreamType stream,
		bool allowOnlyCurrentStream, ValueExprNode* value);
	virtual void findDependentFromStreams(const CompilerScratch* csb,
		StreamType currentStream, SortedStreamList* streamList);

	virtual RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream);

private:
	void genMap(DsqlCompilerScratch* dsqlScratch, UCHAR blrVerb, dsql_map* map);

public:
	NestConst<ValueListNode> dsqlGroup;
	NestConst<RseNode> dsqlRse;
	NestConst<SortNode> group;
	NestConst<MapNode> map;

private:
	NestConst<RseNode> rse;

public:
	bool dsqlWindow;
};

class UnionSourceNode final : public TypedNode<RecordSourceNode, RecordSourceNode::TYPE_UNION>
{
public:
	explicit UnionSourceNode(MemoryPool& pool)
		: TypedNode<RecordSourceNode, RecordSourceNode::TYPE_UNION>(pool),
		  dsqlClauses(NULL),
		  dsqlParentRse(NULL),
		  clauses(pool),
		  maps(pool),
		  mapStream(0),
		  dsqlAll(false),
		  recursive(false)
	{
	}

	static UnionSourceNode* parse(thread_db* tdbb, CompilerScratch* csb, const SSHORT blrOp);

	virtual bool dsqlAggregateFinder(AggregateFinder& visitor);
	virtual bool dsqlAggregate2Finder(Aggregate2Finder& visitor);
	virtual bool dsqlInvalidReferenceFinder(InvalidReferenceFinder& visitor);
	virtual bool dsqlSubSelectFinder(SubSelectFinder& visitor);
	virtual bool dsqlFieldFinder(FieldFinder& visitor);
	virtual RecordSourceNode* dsqlFieldRemapper(FieldRemapper& visitor);

	virtual Firebird::string internalPrint(NodePrinter& printer) const;
	virtual void genBlr(DsqlCompilerScratch* dsqlScratch);

	virtual UnionSourceNode* copy(thread_db* tdbb, NodeCopier& copier) const;

	virtual RecordSourceNode* pass1(thread_db* /*tdbb*/, CompilerScratch* /*csb*/)
	{
		return this;
	}

	virtual void pass1Source(thread_db* tdbb, CompilerScratch* csb, RseNode* rse,
		BoolExprNode** boolean, RecordSourceNodeStack& stack);
	virtual RecordSourceNode* pass2(thread_db* tdbb, CompilerScratch* csb);
	virtual void pass2Rse(thread_db* tdbb, CompilerScratch* csb);
	virtual bool containsStream(StreamType checkStream) const;
	virtual void computeDbKeyStreams(StreamList& streamList) const;
	virtual bool computable(CompilerScratch* csb, StreamType stream,
		bool allowOnlyCurrentStream, ValueExprNode* value);
	virtual void findDependentFromStreams(const CompilerScratch* csb,
		StreamType currentStream, SortedStreamList* streamList);

	virtual RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream);

public:
	RecSourceListNode* dsqlClauses;
	RseNode* dsqlParentRse;

private:
	Firebird::Array<NestConst<RseNode> > clauses;	// RseNode's for union
	Firebird::Array<NestConst<MapNode> > maps;		// RseNode's maps
	StreamType mapStream;	// stream for next level record of recursive union

public:
	bool dsqlAll;		// UNION ALL
	bool recursive;		// union node is a recursive union
};

class WindowSourceNode final : public TypedNode<RecordSourceNode, RecordSourceNode::TYPE_WINDOW>
{
public:
	struct Window
	{
		explicit Window(MemoryPool&)
			: stream(INVALID_STREAM),
			  exclusion(WindowClause::Exclusion::NO_OTHERS)
		{
		}

		StreamType stream;
		NestConst<SortNode> group;
		NestConst<SortNode> regroup;
		NestConst<SortNode> order;
		NestConst<MapNode> map;
		NestConst<WindowClause::FrameExtent> frameExtent;
		WindowClause::Exclusion exclusion;
	};

	explicit WindowSourceNode(MemoryPool& pool)
		: TypedNode<RecordSourceNode, RecordSourceNode::TYPE_WINDOW>(pool),
		  rse(NULL),
		  windows(pool)
	{
	}

	static WindowSourceNode* parse(thread_db* tdbb, CompilerScratch* csb);

private:
	void parseLegacyPartitionBy(thread_db* tdbb, CompilerScratch* csb);
	void parseWindow(thread_db* tdbb, CompilerScratch* csb);

public:
	virtual StreamType getStream() const
	{
		fb_assert(false);
		return 0;
	}

	virtual Firebird::string internalPrint(NodePrinter& printer) const;

	virtual WindowSourceNode* copy(thread_db* tdbb, NodeCopier& copier) const;
	virtual RecordSourceNode* pass1(thread_db* tdbb, CompilerScratch* csb);
	virtual void pass1Source(thread_db* tdbb, CompilerScratch* csb, RseNode* rse,
		BoolExprNode** boolean, RecordSourceNodeStack& stack);
	virtual RecordSourceNode* pass2(thread_db* tdbb, CompilerScratch* csb);
	virtual void pass2Rse(thread_db* tdbb, CompilerScratch* csb);
	virtual bool containsStream(StreamType checkStream) const;
	virtual void collectStreams(SortedStreamList& streamList) const;

	virtual void computeDbKeyStreams(StreamList& /*streamList*/) const
	{
	}

	virtual void computeRseStreams(StreamList& streamList) const;

	virtual bool computable(CompilerScratch* csb, StreamType stream,
		bool allowOnlyCurrentStream, ValueExprNode* value);
	virtual void findDependentFromStreams(const CompilerScratch* csb,
		StreamType currentStream, SortedStreamList* streamList);
	virtual RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream);

private:
	NestConst<RseNode> rse;
	Firebird::ObjectsArray<Window> windows;
};

class RseNode final : public TypedNode<RecordSourceNode, RecordSourceNode::TYPE_RSE>
{
	enum : UCHAR							// storage is BLR-compatible
	{
		INNER_JOIN	= blr_inner,
		LEFT_JOIN	= blr_left,
		RIGHT_JOIN	= blr_right,
		FULL_JOIN	= blr_full,
		SEMI_JOIN,
		ANTI_JOIN
	};

public:
	enum : USHORT
	{
		FLAG_VARIANT			= 0x01,		// variant (not invariant?)
		FLAG_SINGULAR			= 0x02,		// singleton select
		FLAG_WRITELOCK			= 0x04,		// locked for write
		FLAG_SCROLLABLE			= 0x08,		// scrollable cursor
		FLAG_DSQL_COMPARATIVE	= 0x10,		// transformed from DSQL ComparativeBoolNode
		FLAG_LATERAL			= 0x20,		// lateral derived table
		FLAG_SKIP_LOCKED		= 0x40,		// skip locked
		FLAG_SUB_QUERY			= 0x80		// sub-query
	};

	bool isInnerJoin() const
	{
		return (rse_jointype == INNER_JOIN);
	}

	bool isOuterJoin() const
	{
		return (rse_jointype == LEFT_JOIN || rse_jointype == RIGHT_JOIN || rse_jointype == FULL_JOIN);
	}

	bool isFullJoin() const
	{
		return (rse_jointype == FULL_JOIN);
	}

	bool isSpecialJoin() const
	{
		return (rse_jointype == SEMI_JOIN || rse_jointype == ANTI_JOIN);
	}

	bool isSemiJoin() const
	{
		fb_assert(isSpecialJoin());
		return (rse_jointype == SEMI_JOIN);
	}

	bool isInvariant() const
	{
		return (flags & FLAG_VARIANT) == 0;
	}

	bool isSingular() const
	{
		return (flags & FLAG_SINGULAR) != 0;
	}

	bool isScrollable() const
	{
		return (flags & FLAG_SCROLLABLE) != 0;
	}

	bool isLateral() const
	{
		return (flags & FLAG_LATERAL) != 0;
	}

	bool isSubQuery() const
	{
		return (flags & FLAG_SUB_QUERY) != 0;
	}

	bool hasWriteLock() const
	{
		return (flags & FLAG_WRITELOCK) != 0;
	}

	bool hasSkipLocked() const
	{
		return (flags & FLAG_SKIP_LOCKED) != 0;
	}

	explicit RseNode(MemoryPool& pool)
		: TypedNode<RecordSourceNode, RecordSourceNode::TYPE_RSE>(pool),
		  rse_relations(pool)
	{}

	RseNode* clone(MemoryPool& pool)
	{
		RseNode* obj = FB_NEW_POOL(pool) RseNode(pool);

		obj->dsqlFirst = dsqlFirst;
		obj->dsqlSkip = dsqlSkip;
		obj->dsqlDistinct = dsqlDistinct;
		obj->dsqlSelectList = dsqlSelectList;
		obj->dsqlFrom = dsqlFrom;
		obj->dsqlWhere = dsqlWhere;
		obj->dsqlJoinUsing = dsqlJoinUsing;
		obj->dsqlGroup = dsqlGroup;
		obj->dsqlHaving = dsqlHaving;
		obj->dsqlNamedWindows = dsqlNamedWindows;
		obj->dsqlOrder = dsqlOrder;
		obj->dsqlStreams = dsqlStreams;
		obj->dsqlContext = dsqlContext;
		obj->dsqlExplicitJoin = dsqlExplicitJoin;

		obj->rse_jointype = rse_jointype;
		obj->rse_first = rse_first;
		obj->rse_skip = rse_skip;
		obj->rse_boolean = rse_boolean;
		obj->rse_sorted = rse_sorted;
		obj->rse_projection = rse_projection;
		obj->rse_aggregate = rse_aggregate;
		obj->rse_plan = rse_plan;
		obj->rse_invariants = rse_invariants;
		obj->flags = flags;
		obj->rse_relations = rse_relations;
		obj->firstRows = firstRows;

		return obj;
	}

	virtual void getChildren(NodeRefsHolder& holder, bool dsql) const
	{
		RecordSourceNode::getChildren(holder, dsql);

		if (dsql)
		{
			holder.add(dsqlStreams);
			holder.add(dsqlWhere);
			holder.add(dsqlJoinUsing);
			holder.add(dsqlOrder);
			holder.add(dsqlDistinct);
			holder.add(dsqlSelectList);
			holder.add(dsqlFirst);
			holder.add(dsqlSkip);
		}
	}

	virtual Firebird::string internalPrint(NodePrinter& printer) const;
	virtual bool dsqlAggregateFinder(AggregateFinder& visitor);
	virtual bool dsqlAggregate2Finder(Aggregate2Finder& visitor);
	virtual bool dsqlInvalidReferenceFinder(InvalidReferenceFinder& visitor);
	virtual bool dsqlSubSelectFinder(SubSelectFinder& visitor);
	virtual bool dsqlFieldFinder(FieldFinder& visitor);
	virtual RseNode* dsqlFieldRemapper(FieldRemapper& visitor);

	virtual bool dsqlMatch(DsqlCompilerScratch* dsqlScratch, const ExprNode* other, bool ignoreMapCast) const;
	virtual RseNode* dsqlPass(DsqlCompilerScratch* dsqlScratch);

	virtual RseNode* copy(thread_db* tdbb, NodeCopier& copier) const;
	virtual RseNode* pass1(thread_db* tdbb, CompilerScratch* csb);
	virtual void pass1Source(thread_db* tdbb, CompilerScratch* csb, RseNode* rse,
		BoolExprNode** boolean, RecordSourceNodeStack& stack);

	virtual RseNode* pass2(thread_db* /*tdbb*/, CompilerScratch* /*csb*/)
	{
		return this;
	}

	virtual void pass2Rse(thread_db* tdbb, CompilerScratch* csb);
	virtual bool containsStream(StreamType checkStream) const;
	virtual void computeDbKeyStreams(StreamList& streamList) const;
	virtual void computeRseStreams(StreamList& streamList) const;
	virtual bool computable(CompilerScratch* csb, StreamType stream,
		bool allowOnlyCurrentStream, ValueExprNode* value);
	virtual void findDependentFromStreams(const CompilerScratch* csb,
		StreamType currentStream, SortedStreamList* streamList);

	virtual void collectStreams(SortedStreamList& streamList) const;

	virtual RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream);

private:
	void planCheck(thread_db* tdbb, const CompilerScratch* csb) const;
	static void planSet(thread_db* tdbb, CompilerScratch* csb, PlanNode* plan);
	RseNode* processPossibleJoins(thread_db* tdbb, CompilerScratch* csb);

public:
	NestConst<ValueExprNode> dsqlFirst;
	NestConst<ValueExprNode> dsqlSkip;
	NestConst<ValueListNode> dsqlDistinct;
	NestConst<ValueListNode> dsqlSelectList;
	NestConst<RecSourceListNode> dsqlFrom;
	NestConst<BoolExprNode> dsqlWhere;
	NestConst<ValueListNode> dsqlJoinUsing;
	NestConst<ValueListNode> dsqlGroup;
	NestConst<BoolExprNode> dsqlHaving;
	NestConst<ValueListNode> dsqlOrder;
	NestConst<RecSourceListNode> dsqlStreams;
	NamedWindowsClause* dsqlNamedWindows = nullptr;
	bool dsqlExplicitJoin = false;
	NestConst<ValueExprNode> rse_first;
	NestConst<ValueExprNode> rse_skip;
	NestConst<BoolExprNode> rse_boolean;
	NestConst<SortNode> rse_sorted;
	NestConst<SortNode> rse_projection;
	NestConst<SortNode> rse_aggregate;	// singleton aggregate for optimizing to index
	NestConst<PlanNode> rse_plan;		// user-specified access plan
	NestConst<VarInvariantArray> rse_invariants; // Invariant nodes bound to top-level RSE
	Firebird::Array<NestConst<RecordSourceNode> > rse_relations;
	USHORT flags = 0;
	UCHAR rse_jointype = INNER_JOIN;
	Firebird::TriState firstRows;		// optimize for first rows
};

class SelectExprNode final : public TypedNode<RecordSourceNode, RecordSourceNode::TYPE_SELECT_EXPR>
{
public:
	explicit SelectExprNode(MemoryPool& pool)
		: TypedNode<RecordSourceNode, RecordSourceNode::TYPE_SELECT_EXPR>(pool),
		  querySpec(NULL),
		  orderClause(NULL),
		  rowsClause(NULL),
		  withClause(NULL),
		  alias(pool),
		  columns(NULL)
	{
	}

	virtual Firebird::string internalPrint(NodePrinter& printer) const;
	virtual RseNode* dsqlPass(DsqlCompilerScratch* dsqlScratch);

	virtual bool dsqlSubSelectFinder(SubSelectFinder& visitor)
	{
		return true;
	}

	virtual RseNode* copy(thread_db* /*tdbb*/, NodeCopier& /*copier*/) const
	{
		fb_assert(false);
		return NULL;
	}

	virtual RseNode* pass1(thread_db* /*tdbb*/, CompilerScratch* /*csb*/)
	{
		fb_assert(false);
		return NULL;
	}

	virtual void pass1Source(thread_db* /*tdbb*/, CompilerScratch* /*csb*/, RseNode* /*rse*/,
		BoolExprNode** /*boolean*/, RecordSourceNodeStack& /*stack*/)
	{
		fb_assert(false);
	}

	virtual RseNode* pass2(thread_db* /*tdbb*/, CompilerScratch* /*csb*/)
	{
		fb_assert(false);
		return NULL;
	}

	virtual void pass2Rse(thread_db* /*tdbb*/, CompilerScratch* /*csb*/)
	{
		fb_assert(false);
	}

	virtual bool containsStream(StreamType /*checkStream*/) const
	{
		fb_assert(false);
		return false;
	}

	virtual void computeDbKeyStreams(StreamList& /*streamList*/) const
	{
		fb_assert(false);
	}

	virtual RecordSource* compile(thread_db* /*tdbb*/, Optimizer* /*opt*/, bool /*innerSubStream*/)
	{
		fb_assert(false);
		return NULL;
	}

public:
	NestConst<RecordSourceNode> querySpec;
	NestConst<ValueListNode> orderClause;
	NestConst<RowsClause> rowsClause;
	NestConst<WithClause> withClause;
	Firebird::string alias;
	Firebird::ObjectsArray<MetaName>* columns;
};

class TableValueFunctionSourceNode
	: public TypedNode<RecordSourceNode, RecordSourceNode::TYPE_TABLE_VALUE_FUNCTION>
{
public:
	explicit TableValueFunctionSourceNode(MemoryPool& pool)
		: TypedNode<RecordSourceNode, RecordSourceNode::TYPE_TABLE_VALUE_FUNCTION>(pool),
		  dsqlName(pool), alias(pool), dsqlField(nullptr), dsqlNameColumns(pool),
		  m_csbTableValueFun(nullptr)
	{
	}
	static TableValueFunctionSourceNode* parse(thread_db* tdbb, CompilerScratch* csb,
											   const SSHORT blrOp);
	static TableValueFunctionSourceNode* parseFunction(thread_db* tdbb,
													   CompilerScratch* csb,
													   const SSHORT blrOp);

	Firebird::string internalPrint(NodePrinter& printer) const override;
	RecordSourceNode* dsqlPass(DsqlCompilerScratch* dsqlScratch) override;
	bool dsqlMatch(DsqlCompilerScratch* dsqlScratch, const ExprNode* other,
				   bool ignoreMapCast) const override;
	RecordSourceNode* pass1(thread_db* tdbb, CompilerScratch* csb) override;
	RecordSourceNode* pass2(thread_db* tdbb, CompilerScratch* csb) override;
	TableValueFunctionSourceNode* copy(thread_db* tdbb, NodeCopier& copier) const override;
	void genBlr(DsqlCompilerScratch* dsqlScratch) override;
	void pass1Source(thread_db* tdbb, CompilerScratch* csb, RseNode* rse, BoolExprNode** boolean,
					 RecordSourceNodeStack& stack) override;
	void pass2Rse(thread_db* tdbb, CompilerScratch* csb) override;
	bool containsStream(StreamType checkStream) const override;
	void computeDbKeyStreams(StreamList& streamList) const override;
	RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream) override;

	bool computable(CompilerScratch* csb, StreamType stream, bool allowOnlyCurrentStream,
					ValueExprNode* value) override;
	void findDependentFromStreams(const CompilerScratch* csb, StreamType currentStream,
								  SortedStreamList* streamList) override;

	void collectStreams(SortedStreamList& streamList) const override;

	virtual dsql_fld* makeField(DsqlCompilerScratch* dsqlScratch);
	void setDefaultNameField(DsqlCompilerScratch* dsqlScratch);

	virtual const char* getName() const
	{
		return nullptr;
	}

public:
	MetaName dsqlName;
	MetaName alias;
	NestConst<ValueListNode> inputList;
	dsql_fld* dsqlField;
	Firebird::ObjectsArray<Jrd::MetaName> dsqlNameColumns;

private:
	jrd_table_value_fun* m_csbTableValueFun;
};

class UnlistFunctionSourceNode : public TableValueFunctionSourceNode
{
public:
	explicit UnlistFunctionSourceNode(MemoryPool& pool)	: TableValueFunctionSourceNode(pool)
	{
	}

	RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream) final;
	dsql_fld* makeField(DsqlCompilerScratch* dsqlScratch) override;

	static constexpr char const* FUNC_NAME = "UNLIST";
	static constexpr USHORT DEFAULT_UNLIST_TEXT_LENGTH = 32;

	const char* getName() const override
	{
		return FUNC_NAME;
	}

public:
	NestConst<ValueExprNode> dsqlAutoTypeFromValue;
	bool shortEntry = false;
};

class GenSeriesFunctionSourceNode final : public TableValueFunctionSourceNode
{
public:
	explicit GenSeriesFunctionSourceNode(MemoryPool& pool)
		: TableValueFunctionSourceNode(pool)
	{
	}

	RecordSource* compile(thread_db* tdbb, Optimizer* opt, bool innerSubStream) override;
	dsql_fld* makeField(DsqlCompilerScratch* dsqlScratch) override;

	static constexpr char const* FUNC_NAME = "GENERATE_SERIES";

	const char* getName() const override
	{
		return FUNC_NAME;
	}
};

} // namespace Jrd

#endif	// JRD_RECORD_SOURCE_NODES_H