/*
 * Copyright (C) 2008 Search Solution Corporation. All rights reserved by Search Solution. 
 *
 * Redistribution and use in source and binary forms, with or without modification, 
 * are permitted provided that the following conditions are met: 
 *
 * - Redistributions of source code must retain the above copyright notice, 
 *   this list of conditions and the following disclaimer. 
 *
 * - Redistributions in binary form must reproduce the above copyright notice, 
 *   this list of conditions and the following disclaimer in the documentation 
 *   and/or other materials provided with the distribution. 
 *
 * - Neither the name of the <ORGANIZATION> nor the names of its contributors 
 *   may be used to endorse or promote products derived from this software without 
 *   specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
 * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
 * OF SUCH DAMAGE. 
 *
 */

#ifndef	__ODBC_STMT_HEADER	/* to avoid multiple inclusion */
#define	__ODBC_STMT_HEADER

#include		"odbc_portable.h"
#include		"sqlext.h"
#include		"odbc_descriptor.h"
#include		"odbc_util.h"
#include		"odbc_type.h"

#define   IND_IS_DATA_AT_EXEC(value)	( (value) == SQL_DATA_AT_EXEC || \
					(value) <= SQL_LEN_DATA_AT_EXEC_OFFSET )

#define		METHOD_STMT_TYPE(stmt_type)		\
		( stmt_type == CUBRID_STMT_CALL || stmt_type == CUBRID_STMT_EVALUATE )
// Does stmt_type create result set?
#define		RESULTSET_STMT_TYPE(stmt_type)	\
		( stmt_type == CUBRID_STMT_SELECT || METHOD_STMT_TYPE(stmt_type) || GET_STAT_STMT_TYPE(stmt_type))
#define		GET_STAT_STMT_TYPE(stmt_type)	\
		( stmt_type == CUBRID_STMT_GET_STATS )

typedef enum
{ NULL_RESULT =
    0, QUERY, TABLES, STATISTICS, COLUMNS, SPECIALCOLUMNS,
    TYPE_INFO } RESULT_TYPE;

typedef long SQL_STMT_OPTION;	/* SQL_CLOSE, etc */


typedef struct tagPARAM_DATA
{
  D_STRING val;
  int index;
} PARAM_DATA;

typedef struct tagCATALOG_RESULT
{
  ST_LIST *value;
  void *current;		// catalog result set cursor
} CATALOG_RESULT;

/* COLUMN_DATA
 *		large data¿¡ ´ëÇؼ­ ºÐÇÒÇÏ¿© °¡Á®¿Ã ¼ö ÀÖµµ·Ï ÇÏ´Â SQLGetData¸¦
 *		Áö¿øÇϱâ À§Çؼ­ °í¾ÈµÇ¾ú´Ù.
 *		column_no : column_no°¡ °°À¸¸é sequential call·Î ÀνÄÇÑ´Ù.
 *		current_pt : ³²Àº dataÀÇ start pointer
 *		remain_length :	³²Àº dataÀÇ length, ¹®Á¦´Â remain_length°¡ 0À̶ó°í Çؼ­
 *			SQL_NO_DATA¸¦ returnÇÒ ¼ö ¾ú´Ù.  empty string¿¡ ´ëÇؼ­ buffer length°¡ 0À̸é
 *			¿¹¿Ü »óȲÀÌ ¹ß»ýÇÑ´Ù.  À̸¦ ¸·±â À§Çؼ­ µµÀÔÇÑ°Ô fetch_statusÀÌ´Ù.
 *		fetch_status :  
 *				ÃÖÃÊÀÇ function call¿¡¼­ SQL_NO_DATA°¡ ¹ß»ýÇÒ ¼ö ¾øÀ¸¸ç, SQL_SUCCESS_WITH_INFO
 *				´ÙÀ½¿¡ SQL_NO_DATA·Î °Ç³Ê ¶Û ¼ö ¾ø´Ù. ÀÌ°ÍÀ» ÀÌ¿ëÇؼ­ Àú¹ø return status¸¦
 *				ÀúÀåÇؼ­ buffer length°¡ 0¿¡ ´ëÇؼ­ SQL_NO_DATA¸¦ returnÇÒ °ÇÁö °áÁ¤ÇÑ´Ù.
 *					
 *					->		SQL_SUCCESS_WITH_INFO
 *
 *					->		SQL_SUCCESS
 *
 *					X		SQL_NO_DATA
 */
typedef struct tagCOLUMN_DATA
{
  short column_no;
  char *current_pt;
  int remain_length;
  short prev_return_status;
} COLUMN_DATA;

typedef struct tagREVISED_SQL
{
  char *sql_text;		// revised sql text
  char *org_param_pos;		// original param pos in revised sql text
  char *oid_param_pos;		// oid param pos in revised sql text
  char *oid_param_val;		// oid param val
  short oid_param_num;
} REVISED_SQL;

typedef struct st_odbc_statement
{
  unsigned short handle_type;
  struct st_diag *diag;


  struct st_odbc_statement *next;
  struct st_odbc_connection *conn;
  int stmthd;			/* internal handle for CAS */
  CATALOG_RESULT catalog_result;
  struct tagCOLUMN_DATA column_data;

  RESULT_TYPE result_type;	/* if NULL_RESULT, no result set. */
  char *sql_text;		/* origianl SQL statement */
  struct tagREVISED_SQL revised_sql;
  char *cursor;			/* cursor name */
  short data_at_exec_state;	/*      > 0ÀÏ ¶§´Â ÇöÀç º¸³»¾ßÇÒ bind parameter,
				   STMT_NEED_DATA ¾ÆÁ÷ º¸³»±â Á÷Àü,
				   STMT_NEED_NO_MORE_DATA º¸³¾ data°¡ ¾ø°Å³ª,
				   ¸ðµÎ º¸³½ ÀÌÈÄ */
  unsigned long tpl_number;	/* tpl_number - result setÀÇ tuple °³¼ö, ¶Ç´Â
				 * update°¡ ¹Ý¿µµÈ row ¼ö
				 * row_number - currunt row position */
  unsigned long current_tpl_pos;	/* result set¿¡¼­ cursorÀÇ À§Ä¡,
					 * attr_row_number¿Í ÀÇ¹Ì»ó °°´Ù. 
					 * 0 Befor start, -1 After end */

  // param number´Â column number¿Í´Â ´Þ¸® ipdÀÇ record°³¼ö°¡ ¾Æ´Ï´Ù.
  // ¿Ö³Ä¸é ird¿Í ´Þ¸® auto ipd°¡ ¾Æ´Ï±â ¶§¹®ÀÌ´Ù.
  unsigned short param_number;
  int stmt_type;
  PARAM_DATA param_data;	/* For data at exec */
  char is_prepared;		// SQLPrepare¿¡ ÀÇÇؼ­¸¸ prepare»óÅ¿¡ ³õÀδÙ.


  /* Supported attributes */
  unsigned long attr_metadata_id;	// Core
  unsigned long attr_cursor_scrollable;	// 1
  unsigned long attr_cursor_type;	// core, 2
  unsigned long attr_async_enable;	// 1, 2
  unsigned long attr_use_bookmark;	/* 2    
					 * bookmark°¡ okÀÎ °æ¿ì 
					 * prepare½Ã 0¹ø record¸¦ Ãß°¡·Î
					 * »ý¼ºÇÑ´Ù. */


  /* Not supported attributes */
  unsigned long attr_noscan;	// Core
  unsigned long attr_concurrency;	// 1, 2
  unsigned long attr_cursor_sensitivity;	// 2
  unsigned long attr_enable_auto_ipd;	// 2
  void *attr_fetch_bookmark_ptr;	// 2
  unsigned long attr_keyset_size;	// 2
  unsigned long attr_max_length;	// 1
  unsigned long attr_max_rows;	// 1
  unsigned long attr_query_timeout;	// 2
  unsigned long attr_retrieve_data;	// 1
  unsigned short *attr_row_operation_ptr;	// 1
  unsigned long attr_simulate_cursor;	// 2



  // Descriptor section
  struct st_odbc_desc *i_apd;
  struct st_odbc_desc *i_ard;
  struct st_odbc_desc *i_ipd;
  struct st_odbc_desc *i_ird;

  struct st_odbc_desc *apd;
  struct st_odbc_desc *ard;
  struct st_odbc_desc *ipd;
  struct st_odbc_desc *ird;

} ODBC_STATEMENT;

PUBLIC RETCODE odbc_alloc_statement (struct st_odbc_connection *conn,
				     ODBC_STATEMENT ** stmt_ptr);
PUBLIC RETCODE odbc_free_statement (ODBC_STATEMENT * stmt);
PUBLIC RETCODE odbc_reset_statement (ODBC_STATEMENT * stmt,
				     unsigned short option);
PUBLIC RETCODE odbc_set_stmt_attr (ODBC_STATEMENT * stmt,
				   long attribute,
				   void *valueptr,
				   long stringlength, short is_driver);
PUBLIC RETCODE odbc_get_stmt_attr (ODBC_STATEMENT * stmt,
				   long attr,
				   void *value_ptr,
				   long buffer_length, long *length_ptr);
PUBLIC RETCODE odbc_set_cursor_name (ODBC_STATEMENT * stmt,
				     char *cursor_name, short name_length);
PUBLIC RETCODE odbc_get_cursor_name (ODBC_STATEMENT * stmt,
				     char *cursor_name,
				     short buffer_length,
				     long *name_length_ptr);
PUBLIC RETCODE odbc_bind_parameter (ODBC_STATEMENT * stmt,
				    unsigned short parameter_num,
				    short input_output_type,
				    short value_type,
				    short parameter_type,
				    unsigned long column_size,
				    short decimal_digits,
				    void *parameter_value_ptr,
				    long buffer_length, long *strlen_ind_ptr);
PUBLIC RETCODE odbc_num_params (ODBC_STATEMENT * stmt,
				short *parameter_count);
PUBLIC RETCODE odbc_prepare (ODBC_STATEMENT * stmt, char *statement_text);
PUBLIC RETCODE odbc_execute (ODBC_STATEMENT * stmt);
PUBLIC RETCODE odbc_param_data (ODBC_STATEMENT * stmt, void **valueptr_ptr);
PUBLIC RETCODE odbc_put_data (ODBC_STATEMENT * stmt,
			      void *data_ptr, long strlen_or_ind);
PUBLIC RETCODE odbc_close_cursor (ODBC_STATEMENT * stmt);
PUBLIC RETCODE odbc_cancel (ODBC_STATEMENT * stmt);
PUBLIC RETCODE odbc_bulk_operations (ODBC_STATEMENT * stmt, short pperation);
PUBLIC RETCODE odbc_set_pos (ODBC_STATEMENT * stmt,
			     unsigned short row_number,
			     unsigned short operation,
			     unsigned short lock_type);
PUBLIC void free_column_data (COLUMN_DATA * data, int option);
PUBLIC void reset_result_set (ODBC_STATEMENT * stmt);
PUBLIC void create_ird (ODBC_STATEMENT * stmt, T_CCI_COL_INFO * cci_col_info,
			int column_number);

#endif /* ! __ODBC_STMT_HEADER */