/* Copyright (c) 2006, 2014, Oracle and/or its affiliates. All rights
 reserved.

 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */

#ifndef SQL_TABLE_INCLUDED
#define SQL_TABLE_INCLUDED

#include "my_global.h" /* my_bool */
#include "my_pthread.h"
#include "m_ctype.h" /* CHARSET_INFO */
#include "mysql_com.h" /* enum_field_types */

class Alter_info;
class Alter_table_ctx;
class Create_field;
struct TABLE_LIST;
class THD;
struct TABLE;
struct handlerton;
typedef struct st_ha_create_information HA_CREATE_INFO;
typedef struct st_key KEY;
typedef struct st_key_cache KEY_CACHE;
typedef struct st_lock_param_type ALTER_PARTITION_PARAM_TYPE;
typedef struct st_mysql_lex_string LEX_STRING;
typedef struct st_order ORDER;

enum ddl_log_entry_code
{
 /*
 DDL_LOG_EXECUTE_CODE:
 This is a code that indicates that this is a log entry to
 be executed, from this entry a linked list of log entries
 can be found and executed.
 DDL_LOG_ENTRY_CODE:
 An entry to be executed in a linked list from an execute log
 entry.
 DDL_IGNORE_LOG_ENTRY_CODE:
 An entry that is to be ignored
 */
 DDL_LOG_EXECUTE_CODE = 'e',
 DDL_LOG_ENTRY_CODE = 'l',
 DDL_IGNORE_LOG_ENTRY_CODE = 'i'
};

enum ddl_log_action_code
{
 /*
 The type of action that a DDL_LOG_ENTRY_CODE entry is to
 perform.
 DDL_LOG_DELETE_ACTION:
 Delete an entity
 DDL_LOG_RENAME_ACTION:
 Rename an entity
 DDL_LOG_REPLACE_ACTION:
 Rename an entity after removing the previous entry with the
 new name, that is replace this entry.
 DDL_LOG_EXCHANGE_ACTION:
 Exchange two entities by renaming them a -> tmp, b -> a, tmp -> b.
 */
 DDL_LOG_DELETE_ACTION = 'd',
 DDL_LOG_RENAME_ACTION = 'r',
 DDL_LOG_REPLACE_ACTION = 's',
 DDL_LOG_EXCHANGE_ACTION = 'e'
};

enum enum_ddl_log_exchange_phase {
 EXCH_PHASE_NAME_TO_TEMP= 0,
 EXCH_PHASE_FROM_TO_NAME= 1,
 EXCH_PHASE_TEMP_TO_FROM= 2
};


typedef struct st_ddl_log_entry
{
 const char *name;
 const char *from_name;
 const char *handler_name;
 const char *tmp_name;
 uint next_entry;
 uint entry_pos;
 enum ddl_log_entry_code entry_type;
 enum ddl_log_action_code action_type;
 /*
 Most actions have only one phase. REPLACE does however have two
 phases. The first phase removes the file with the new name if
 there was one there before and the second phase renames the
 old name to the new name. EXCHANGE have three phases.
 */
 char phase;
} DDL_LOG_ENTRY;

typedef struct st_ddl_log_memory_entry
{
 uint entry_pos;
 struct st_ddl_log_memory_entry *next_log_entry;
 struct st_ddl_log_memory_entry *prev_log_entry;
 struct st_ddl_log_memory_entry *next_active_log_entry;
} DDL_LOG_MEMORY_ENTRY;


enum enum_explain_filename_mode
{
 EXPLAIN_ALL_VERBOSE= 0,
 EXPLAIN_PARTITIONS_VERBOSE,
 EXPLAIN_PARTITIONS_AS_COMMENT
};

/* Maximum length of GEOM_POINT Field */
#define MAX_LEN_GEOM_POINT_FIELD 25

/* depends on errmsg.txt Database `db`, Table `t` ... */
#define EXPLAIN_FILENAME_MAX_EXTRA_LENGTH 63

#define MYSQL50_TABLE_NAME_PREFIX "#mysql50#"
#define MYSQL50_TABLE_NAME_PREFIX_LENGTH 9

#define WFRM_WRITE_SHADOW 1
#define WFRM_INSTALL_SHADOW 2
#define WFRM_PACK_FRM 4
#define WFRM_KEEP_SHARE 8

/* Flags for conversion functions. */
static const uint FN_FROM_IS_TMP= 1 << 0;
static const uint FN_TO_IS_TMP= 1 << 1;
static const uint FN_IS_TMP= FN_FROM_IS_TMP | FN_TO_IS_TMP;
static const uint NO_FRM_RENAME= 1 << 2;
static const uint FRM_ONLY= 1 << 3;
/** Don't remove table in engine. Remove only .FRM and maybe .PAR files. */
static const uint NO_HA_TABLE= 1 << 4;
/** Don't resolve MySQL's fake "foo.sym" symbolic directory names. */
static const uint SKIP_SYMDIR_ACCESS= 1 << 5;
/** Don't check foreign key constraints while renaming table */
static const uint NO_FK_CHECKS= 1 << 6;

uint filename_to_tablename(const char *from, char *to, uint to_length
#ifndef DBUG_OFF
 , bool stay_quiet = false
#endif /* DBUG_OFF */
 );
uint tablename_to_filename(const char *from, char *to, uint to_length);
uint check_n_cut_mysql50_prefix(const char *from, char *to, uint to_length);
bool check_mysql50_prefix(const char *name);
uint build_table_filename(char *buff, size_t bufflen, const char *db,
 const char *table, const char *ext,
 uint flags, bool *was_truncated);
// For caller's who are mostly sure that path do not truncate
uint inline build_table_filename(char *buff, size_t bufflen, const char *db,
 const char *table, const char *ext, uint flags)
{
 bool truncated_not_used;
 return build_table_filename(buff, bufflen, db, table, ext, flags,
 &truncated_not_used);
}

bool fill_field_definition(THD *thd,
 class sp_head *sp,
 enum enum_field_types field_type,
 Create_field *field_def);
int prepare_create_field(Create_field *sql_field,
			 uint *blob_columns,
			 longlong table_flags);
const CHARSET_INFO* get_sql_field_charset(Create_field *sql_field,
 HA_CREATE_INFO *create_info);


template<typename T> class List;
void promote_first_timestamp_column(List<Create_field> *column_definitions);

/*
 These prototypes where under INNODB_COMPATIBILITY_HOOKS.
*/
uint explain_filename(THD* thd, const char *from, char *to, uint to_length,
 enum_explain_filename_mode explain_mode);


extern MYSQL_PLUGIN_IMPORT const char *primary_key_name;
extern mysql_mutex_t LOCK_gdl;

#endif /* SQL_TABLE_INCLUDED */