/*
  Copyright (C) 2011-2018  Brazil
  Copyright (C) 2018-2026  Sutou Kouhei <kou@clear-code.com>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#pragma once

#include "grn.h"
#include "grn_db.h"
#include "grn_table_module.h"

#ifdef __cplusplus
extern "C" {
#endif

struct _grn_dat {
  grn_db_obj obj;
  grn_io *io;
  struct grn_dat_header *header;
  uint32_t file_id;
  grn_encoding encoding;
  void *trie;
  void *old_trie;
  grn_table_module tokenizer;
  grn_obj normalizers;
  grn_obj token_filters;
  /* For backward compatibility */
  grn_obj token_filter_procs;
  grn_obj extractors;
  grn_critical_section lock;
  bool is_dirty;
};

struct grn_dat_header {
  uint32_t flags;
  grn_encoding encoding;
  grn_id tokenizer;
  uint32_t file_id;
  grn_id normalizer;
  uint32_t n_dirty_opens;
  uint64_t wal_id;
  uint32_t reserved[232];
};

struct _grn_dat_cursor {
  grn_db_obj obj;
  grn_dat *dat;
  void *cursor;
  const void *key;
  grn_id curr_rec;
};

GRN_API grn_id
grn_dat_curr_id(grn_ctx *ctx, grn_dat *dat);

/*
  Currently, grn_dat_truncate() is available if the grn_dat object is
  associated with a file.
 */
GRN_API grn_rc
grn_dat_truncate(grn_ctx *ctx, grn_dat *dat);

GRN_API const char *
_grn_dat_key(grn_ctx *ctx, grn_dat *dat, grn_id id, uint32_t *key_size);
GRN_API grn_id
grn_dat_next(grn_ctx *ctx, grn_dat *dat, grn_id id);
GRN_API grn_id
grn_dat_at(grn_ctx *ctx, grn_dat *dat, grn_id id);

GRN_API grn_rc
grn_dat_clear_status_flags(grn_ctx *ctx, grn_dat *dat);

/*
  Currently, grn_dat_repair() is available if the grn_dat object is associated
  with a file.
 */
GRN_API grn_rc
grn_dat_repair(grn_ctx *ctx, grn_dat *dat);

GRN_API grn_rc
grn_dat_flush(grn_ctx *ctx, grn_dat *dat);

bool
grn_dat_is_changing(grn_ctx *ctx, grn_dat *dat);

grn_rc
grn_dat_dirty(grn_ctx *ctx, grn_dat *dat);
bool
grn_dat_is_dirty(grn_ctx *ctx, grn_dat *dat);
grn_rc
grn_dat_clean(grn_ctx *ctx, grn_dat *dat);
grn_rc
grn_dat_clear_dirty(grn_ctx *ctx, grn_dat *dat);

bool
grn_dat_is_corrupt(grn_ctx *ctx, grn_dat *dat);

size_t
grn_dat_get_disk_usage(grn_ctx *ctx, grn_dat *dat);

grn_rc
grn_dat_wal_recover(grn_ctx *ctx, grn_dat *dat);
grn_rc
grn_dat_warm(grn_ctx *ctx, grn_dat *dat);

#ifdef __cplusplus
}
#endif
