//---------------------------------------------------------------------------
//	Greenplum Database
//	Copyright (c) 2023 VMware, Inc. or its affiliates. All Rights Reserved.
//
//	@filename:
//		CPlanHint.h
//
//	@doc:
//		CPlanHint is a container for all hints (IHint) used by a query.
//---------------------------------------------------------------------------
#ifndef GPOS_CPlanHint_H
#define GPOS_CPlanHint_H

#include "gpos/base.h"
#include "gpos/common/CDynamicPtrArray.h"
#include "gpos/common/CRefCount.h"

#include "gpopt/hints/CJoinHint.h"
#include "gpopt/hints/CJoinTypeHint.h"
#include "gpopt/hints/CRowHint.h"
#include "gpopt/hints/CScanHint.h"
#include "gpopt/hints/IHint.h"
#include "gpopt/metadata/CTableDescriptor.h"
#include "gpopt/operators/CExpression.h"
#include "gpopt/operators/COperator.h"
#include "naucrates/dxl/xml/CXMLSerializer.h"

namespace gpopt
{
//---------------------------------------------------------------------------
//	@class:
//		CPlanHint
//---------------------------------------------------------------------------
class CPlanHint : public CRefCount, public DbgPrintMixin<CPlanHint>
{
private:
	CMemoryPool *m_mp{nullptr};

	// List of all scan hints
	ScanHintList *m_scan_hints{nullptr};

	// List of all row hints
	RowHintList *m_row_hints{nullptr};

	// List of all join hints
	JoinHintList *m_join_hints{nullptr};

	// List of all join type hints
	JoinTypeHintList *m_join_type_hints{nullptr};

public:
	CPlanHint(CMemoryPool *mp);

	~CPlanHint() override;

	// Add a scan hint
	void AddHint(CScanHint *hint);

	// Add a row hint
	void AddHint(CRowHint *hint);

	// Add a join hint
	void AddHint(CJoinHint *hint);

	// Add a join type hint
	void AddHint(CJoinTypeHint *hint);

	// Get a scan hint that matches a name (table or alias)
	CScanHint *GetScanHint(const char *name);
	CScanHint *GetScanHint(const CWStringBase *name);

	// Get a row hint that matches a set of table descriptors
	CRowHint *GetRowHint(CTableDescriptorHashSet *ptabdescset);

	// Get a join hint that covers an expression
	CJoinHint *GetJoinHint(CExpression *pexpr);

	// Get a join type hint that covers an expression
	CJoinTypeHint *GetJoinTypeHint(StringPtrArray *aliases);

	// Check whether an expression was created using a directed hint.
	bool WasCreatedViaDirectedHint(CExpression *pexpr);

	IOstream &OsPrint(IOstream &os) const;

	void Serialize(CXMLSerializer *xml_serializer) const;
};	// class CPlanHint

}  // namespace gpopt


#endif	// !GPOS_CPlanHint_H

// EOF