/* Eliot                                                                     */
/* Copyright (C) 1999  Antoine Fraboulet                                     */
/*                                                                           */
/* This file is part of Eliot.                                               */
/*                                                                           */
/* Eliot 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; either version 2 of the License, or         */
/* (at your option) any later version.                                       */
/*                                                                           */
/* Elit 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 */

/**
 *  \file dic_internals.h
 *  \brief  Internal dictionary structures
 *  \author Antoine Fraboulet
 *  \date   2002
 */

#ifndef _DIC_INTERNALS_H
#define _DIC_INTERNALS_H
#if defined(__cplusplus)
extern "C"
  {
#endif

/**
 * bit masking for ascii characters \n
 * ('a' & CHAR) == ('A' & CHAR) == 1
 */
#define DIC_CHAR_MASK    0x1F

/**
 * keyword included in dictionary headers
 * implies little endian storage on words
 */
#define _COMPIL_KEYWORD_ "_COMPILED_DICTIONARY_"

/**
 *  structure of a compressed dictionary \n
 *  \n
 *  ----------------    \n
 *  header              \n
 *  ----------------    \n
 *  specialnode (0)     \n
 *  +                   \n
 *  + nodes             \n
 *  +                   \n
 *  firstnode (= root)  \n
 *  ----------------
 */

typedef struct _Dawg_edge {
   unsigned int ptr  : 24;
   unsigned int term : 1;
   unsigned int last : 1;
   unsigned int fill : 1;
   unsigned int chr  : 5;
} Dawg_edge;

typedef struct _Dict_header {
  char ident[sizeof(_COMPIL_KEYWORD_)];
  char unused_1;
  char unused_2;
  int root;
  int nwords;
  unsigned int edgesused;
  unsigned int nodesused;
  unsigned int nodessaved;
  unsigned int edgessaved;
} Dict_header;

struct _Dictionary
{
  Dawg_edge *dawg;
  unsigned int root;
  int nwords;
  int nnodes;
  int nedges;
};

#if defined(__cplusplus)
  }
#endif
#endif /* _DIC_INTERNALS_H */