/*
 * Copyright (C) 2008 Search Solution Corporation. All rights reserved by Search Solution.
 *
 *   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; version 2 of the License.
 *
 *  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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */


/*
 * parser_support.h - Query processor memory management module
 */

#ifndef _PARSER_SUPPORT_H_
#define _PARSER_SUPPORT_H_

#ident "$Id$"

#include "config.h"
#include "error_manager.h"
#include "oid.h"
#include "storage_common.h"
#include "dbtype.h"
#include "heap_file.h"

/*
 *
 *       	         Miscellaneous macros
 *
 */

typedef struct
{
  int oid_cnt;
  OID *oidp;
} OID_LIST;			/* list of OIDs */

typedef struct
{
  int ptr_cnt;
  OID_LIST **oidptr;		/* list of OID_LIST pointers */
} OID_PTRLIST;

#define OID_BLOCK_ARRAY_SIZE    10
typedef struct oid_block_list
{
  struct oid_block_list *next;
  int last_oid_idx;
  OID oid_array[OID_BLOCK_ARRAY_SIZE];
} OID_BLOCK_LIST;

/*
 *       	         CATALOG STRUCTURES
 */

typedef int CL_REPR_ID;
typedef int CL_ATTR_ID;

typedef struct
{
  CL_ATTR_ID id;		/* Attribute identifier */
  DB_TYPE type;			/* Attribute data type */
  HEAP_CACHE_ATTRINFO *cache_attrinfo;	/* used to cache catalog info */
  DB_VALUE *cache_dbvalp;	/* cached value for particular attr */
  /* in cache_attrinfo */
} ATTR_DESCR;			/* Attribute Descriptor */

#define UT_CLEAR_ATTR_DESCR(ptr) \
{ (ptr)->id = -1; \
  (ptr)->type = DB_TYPE_NULL; \
  (ptr)->cache_dbvalp = NULL; \
}

/*
 *       	         INDEX STRUCTURES
 */

typedef enum
{ T_BTID = 1, T_EHID } INDX_ID_TYPE;

typedef struct index_id_node
{
  INDX_ID_TYPE type;		/* Index Type */
  union
  {
    BTID btid;			/* B+tree index identifier */
    EHID ehid;			/* Extendible Hash index identifier */
  } i;
} INDX_ID;			/* Index Identifier */

typedef enum
{
  R_KEY = 1,			/* key value search */
  R_RANGE,			/* range search with the two key values and range spec */
  R_KEYLIST,			/* a list of key value searches */
  R_RANGELIST			/* a list of range searches */
} RANGE_TYPE;

/*
 * Forward declaration (defined in query_opfunc.h)
 */
struct regu_variable_node;

typedef struct key_range
{
  RANGE range;			/* range spec; GE_LE, GT_LE, GE_LT,
				   GT_LT, GE_INF, GT_INF, INF_LT,
				   INF_LE, INF_INF */
  struct regu_variable_node *key1;	/* pointer to first key value */
  struct regu_variable_node *key2;	/* pointer to second key value */
} KEY_RANGE;			/* key range structure */

typedef struct key_info
{
  int key_cnt;			/* key count */
  KEY_RANGE *key_ranges;	/* a list of key ranges */
  int is_constant;		/* every key value is a constant */
} KEY_INFO;			/* key information structure */

typedef struct indx_info
{
  INDX_ID indx_id;		/* index identifier */
  RANGE_TYPE range_type;	/* range type */
  KEY_INFO key_info;		/* key information */
} INDX_INFO;			/* index information structure */


/*
 *       	   ESQL POSITIONAL VALUES RELATED TYPEDEFS
 */

typedef struct val_descr
{
  int dbval_cnt;		/* Value Count */
  DB_VALUE *dbval_ptr;		/* Array of values */
  DB_TIMESTAMP sys_timestamp;
  long lrand;
  double drand;
  struct xasl_state *xasl_state;	/* XASL_STATE pointer */
} VAL_DESCR;			/* Value Descriptor */

/*
 *       	      STRUCTURE FOR QUERY PROCESSOR DOMAIN
 */

/* The following structure is semantically similar to the structure DOMAIN
 * except that every single node represents a physical class instead of a
 * class hierarchy.
 */

struct qp_domain
{
  struct qp_domain *next;
  OID classid;
  DB_TYPE type;
  struct qp_domain *setdomain;
};

/*
 *       		STRUCTURES FOR STRING LISTS
 */

typedef struct qproc_string_list QPROC_STRING_LIST;
struct qproc_string_list
{
  QPROC_STRING_LIST *next;
  char *name;
};

extern int qp_Packing_er_code;

/* Memory Buffer Related Routines */
extern char *pt_alloc_packing_buf (int size);
extern void pt_final_packing_buf (void);
extern void pt_enter_packing_buf (void);
extern void pt_exit_packing_buf (void);

#endif /* _PARSER_SUPPORT_H_ */