(mdatabase__check): Add comment.

[m17n/m17n-lib.git] / src / database.c

/* database.c -- database module.
   Copyright (C) 2003, 2004
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H15PRO112

   This file is part of the m17n library.

   The m17n 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.

   The m17n 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 the m17n library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307, USA.  */

/***en
    @addtogroup m17nDatabase
    @brief The m17n database and API for it.

    The m17n library acquires various kinds of information
    from data in the <i> m17n database</i> on demand.  Application
    programs can also add/load their original data to/from the m17n
    database by setting the variable #mdatabase_dir to an
    application-specific directory and storing data in it.  Users can
    overwrite those data by storing preferable data in the directory
    specified by the environment variable "M17NDIR", or if it is not
    set, in the directory "~/.m17n.d".

    The m17n database contains multiple heterogeneous data, and each
    data is identified by four tags; TAG0, TAG1, TAG2, TAG3.  Each tag
    must be a symbol.

    TAG0 specifies the type of data stored in the database as below.

    @li
    If TAG0 is #Mchar_table, the data is of the @e chartable @e
    type and provides information about each character.  In this case,
    TAG1 specifies the type of the information and must be #Msymbol,
    #Minteger, #Mstring, #Mtext, or #Mplist.  TAG2 and TAG3 can be any
    symbols.

    @li
    If TAG0 is #Mcharset, the data is of the @e charset @e type
    and provides a decode/encode mapping table for a charset.  In this
    case, TAG1 must be a symbol representing a charset.  TAG2 and TAG3
    can be any symbols.

    @li 
    If TAG0 is neither #Mchar_table nor #Mcharset, the data is of
    the @e plist @e type.  See the documentation of the 
    mdatabase_load () function for the details.  
    In this case, TAG1, TAG2, and TAG3 can be any symbols.

    The notation \<TAG0, TAG1, TAG2, TAG3\> means a data with those
    tags.

    Application programs first calls the mdatabase_find () function to
    get a pointer to an object of the type #MDatabase.  That object
    holds information about the specified data.  When it is
    successfully returned, the mdatabase_load () function loads the
    data.  The implementation of the structure #MDatabase is
    concealed from application programs.
*/

/***ja
    @addtogroup m17nDatabase
    @brief m17n ¥Ç¡¼¥¿¥Ù¡¼¥¹¤Ë¤È¤½¤ì¤Ë´Ø¤¹¤ë API.

    m17n ¥é¥¤¥Ö¥é¥ê¤ÏɬÍפ˱þ¤¸¤ÆưŪ¤Ë @e m17n @e ¥Ç¡¼¥¿¥Ù¡¼¥¹ 
    ¤«¤é¾ðÊó¤ò¼èÆÀ¤¹¤ë¡£¤Þ¤¿¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤â¡¢Æȼ«¤Î¥Ç¡¼¥¿¤ò 
    m17n ¥Ç¡¼¥¿¥Ù¡¼¥¹¤ËÄɲä·¡¢¤½¤ì¤òưŪ¤Ë¼èÆÀ¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
    ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤¬Æȼ«¤Î¥Ç¡¼¥¿¤òÄɲᦼèÆÀ¤¹¤ë¤Ë¤Ï¡¢ÊÑ¿ô 
    #mdatabase_dir ¤Ë¤½¤Î¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¸ÇÍ­¤Î¥Ç¥£¥ì¥¯¥È¥ê¤ò¥»¥Ã¥È¤·¡¢
    ¤½¤ÎÃæ¤Ë¥Ç¡¼¥¿¤ò³ÊǼ¤¹¤ë¡£¥æ¡¼¥¶¤¬¤½¤Î¥Ç¡¼¥¿¤ò¥ª¡¼¥Ð¡¼¥é¥¤¥È¤·¤¿¤¤
    ¤È¤­¤Ï¡¢´Ä¶­ÊÑ¿ô "M17NDIR" ¤Ç»ØÄꤵ¤ì¤ë¥Ç¥£¥ì¥¯¥È¥ê¡Ê»ØÄꤵ¤ì¤Æ¤¤¤Ê
    ¤¤¤È¤­¤Ï "~/.m17n.d" ¤È¤¤¤¦¥Ç¥£¥ì¥¯¥È¥ê¡Ë¤ËÊ̤Υǡ¼¥¿¤òÃÖ¤¯¡£

    m17n 
    ¥Ç¡¼¥¿¥Ù¡¼¥¹¤Ë¤ÏÊ£¿ô¤Î¿Íͤʥǡ¼¥¿¤¬´Þ¤Þ¤ì¤Æ¤ª¤ê¡¢³Æ¥Ç¡¼¥¿¤Ï
    TAG0, TAG1, TAG2, TAG3¡Ê¤¹¤Ù¤Æ¥·¥ó¥Ü¥ë¡Ë¤Î£´¤Ä¤Î¥¿¥°¤Ë¤è¤Ã¤Æ¼±Ê̤µ¤ì¤ë¡£

    TAG0 ¤Ë¤è¤Ã¤Æ¡¢¥Ç¡¼¥¿¥Ù¡¼¥¹Æâ¤Î¥Ç¡¼¥¿¤Î¥¿¥¤¥×¤Ï¼¡¤Î¤è¤¦¤Ë»ØÄꤵ¤ì¤ë¡£

    @li 
    TAG0 ¤¬ #Mchar_table ¤Ç¤¢¤ë¥Ç¡¼¥¿¤Ï @e chartable¥¿¥¤¥× 
    ¤È¸Æ¤Ð¤ì¡¢³Æʸ»ú¤Ë´Ø¤¹¤ë¾ðÊó¤òÄ󶡤¹¤ë¡£¤³¤Î¾ì¹ç
    TAG1 ¤Ï¾ðÊó¤Î¼ïÎà¤ò»ØÄꤹ¤ë¥·¥ó¥Ü¥ë¤Ç¤¢¤ê¡¢#Msymbol, #Minteger, #Mstring,
    #Mtext, #Mplist ¤Î¤¤¤º¤ì¤«¤Ç¤¢¤ë¡£TAG2 ¤È TAG3 ¤ÏǤ°Õ¤Î¥·¥ó¥Ü¥ë¤Ç¤è¤¤¡£

    @li 
    TAG0 ¤¬ #Mcharset ¤Ç¤¢¤ë¥Ç¡¼¥¿¤Ï @e charset¥¿¥¤¥× 
    ¤È¸Æ¤Ð¤ì¡¢Ê¸»ú¥»¥Ã¥ÈÍѤΥǥ³¡¼¥É¡¿¥¨¥ó¥³¡¼¥É¥Þ¥Ã¥×¤òÄ󶡤¹¤ë¡£¤³¤Î¾ì¹ç TAG1
    ¤Ïʸ»ú¥»¥Ã¥È¤Î¥·¥ó¥Ü¥ë¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£TAG2 ¤È TAG3
    ¤ÏǤ°Õ¤Î¥·¥ó¥Ü¥ë¤Ç¤è¤¤¡£

    @li
    TAG0 ¤¬ #Mchar_table ¤Ç¤â #Mcharset ¤Ç¤â¤Ê¤¤¾ì¹ç¡¢¤½¤Î¥Ç¡¼¥¿¤Ï @e
    plist¥¿¥¤¥× ¤Ç¤¢¤ë¡£¾ÜºÙ¤Ë´Ø¤·¤Æ¤Ï´Ø¿ô mdatabase_load () 
    ¤ÎÀâÌÀ¤ò»²¾È¤Î¤³¤È¡£¤³¤Î¾ì¹ç TAG1¡¢TAG2¡¢TAG3 ¤ÏǤ°Õ¤Î¥·¥ó¥Ü¥ë¤Ç¤è¤¤¡£

    ÆÃÄê¤Î¥¿¥°¤ò»ý¤Ä¥Ç¡¼¥¿¥Ù¡¼¥¹¤ò \<TAG0, TAG1, TAG2, TAG3\> 
    ¤È¤¤¤¦·Á¼°¤Çɽ¤¹¡£

    ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤Ï¡¢¤Þ¤º´Ø¿ô mdatabase_find () 
    ¤ò»È¤Ã¤Æ¥Ç¡¼¥¿¥Ù¡¼¥¹¤Ë´Ø¤¹¤ë¾ðÊó¤òÊÝ»ý¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¡Ê#MDatabase
    ·¿¡Ë¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÆÀ¤ë¡£¤½¤ì¤ËÀ®¸ù¤·¤¿¤é¡¢ mdatabase_load () 
    ¤Ë¤è¤Ã¤Æ¼ÂºÝ¤Ë¥Ç¡¼¥¿¥Ù¡¼¥¹¤ò¥í¡¼¥É¤¹¤ë¡£¹½Â¤ÂÎ #MDatabase 
    ¼«¿È¤¬¤É¤¦¼ÂÁõ¤µ¤ì¤Æ¤¤¤ë¤«¤Ï¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£

    @latexonly \IPAlabel{database} @endlatexonly
*/

/*=*/

#if !defined (FOR_DOXYGEN) || defined (DOXYGEN_INTERNAL_MODULE)
/*** @addtogroup m17nInternal
     @{ */

#include <config.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <limits.h>
#include <glob.h>

#include "m17n.h"
#include "m17n-misc.h"
#include "internal.h"
#include "mtext.h"
#include "character.h"
#include "charset.h"
#include "database.h"
#include "coding.h"
#include "plist.h"

/** The file containing a list of databases.  */
#define MDB_DIR "mdb.dir"
#define MDB_DIR_LEN 8

#define MAX_TIME(TIME1, TIME2) ((TIME1) >= (TIME2) ? (TIME1) : (TIME2))

#ifndef PATH_MAX
#define PATH_MAX 1024
#endif

#define PATH_SEPARATOR '/'

#define USE_GEN_PATH                                    \
  char _path_static[PATH_MAX], *_path = _path_static;   \
  int _path_len = PATH_MAX, _this_len

#define GEN_PATH(DIR, FILE)                                                  \
  (_this_len = strlen (DIR) + strlen (FILE) + 2,                             \
   sprintf (((_this_len > _path_len)                                         \
             ? (_path_len = _this_len, _path = alloca (_path_len)) : _path), \
            "%s%c%s", (DIR), PATH_SEPARATOR, (FILE)),                        \
   _path)

#define GEN_PATH_FROM_MT(DIR, MT)                                       \
  (mtext_ref_char ((MT), 0) == PATH_SEPARATOR                           \
   ? (_this_len = mtext_nbytes (MT) + 1,                                \
      (_this_len > _path_len                                            \
       ? (_path_len = _this_len, _path = alloca (_path_len))            \
       : _path)[_this_len - 1] = '\0',                                  \
      memcpy (_path, MTEXT_DATA (MT), mtext_nbytes (MT)))               \
   : (_this_len = strlen (DIR) + mtext_nbytes (MT) + 2,                 \
      (_this_len > _path_len                                            \
       ? (_path_len = _this_len, _path = alloca (_path_len))            \
       : _path)[_this_len - 1] = '\0',                                  \
      memcpy (_path + sprintf (_path, "%s%c", (DIR), PATH_SEPARATOR),   \
              MTEXT_DATA (MT), mtext_nbytes (MT)),                      \
      _path))

static MSymbol Masterisk;

/** Structure for a data in the m17n database.  */

struct MDatabase
{
  /** Tags to identify the data.  <tag>[0] specifies the type of
      database.  If it is #Mchar_table, the type is @e chartable, if
      it is #Mcharset, the type is @e charset, otherwise the type is
      @e plist.  */
  MSymbol tag[4];

  void *(*loader) (MSymbol *tags, void *extra_info);

  /** The meaning of the value is dependent on <loader>.  If <loader>
      is load_database (), the value is a string of the file name that
      contains the data.  */
  void *extra_info;
};

typedef struct
{
  char *filename;
  time_t time;
} MDatabaseInfo;

/** List of all data.  */
struct MDatabaseList
{
  int size, inc, used;
  MDatabase *mdbs;
};

static struct MDatabaseList mdb_list;


static int
read_number (char *buf, int *i)
{
  int idx = *i;
  int c = buf[idx++];
  int n;

  if (!c)
    return -1;

  while (c && isspace (c)) c = buf[idx++];

  if (c == '0')
    {
      if (buf[idx] == 'x')
        {
          for (idx++, c = 0; (n = hex_mnemonic[(unsigned) buf[idx]]) < 16;
               idx++)
            c  = (c << 4) | n;
          *i = idx;
          return c;
        }
      c = 0;
    }
  else if (c == '\'')
    {
      c = buf[idx++];
      if (c == '\\')
        {
          c = buf[idx++];
          n = escape_mnemonic[c];
          if (n != 255)
            c = n;
        }
      while (buf[idx] && buf[idx++] != '\'');
      *i = idx;
      return c;
    }
  else if (hex_mnemonic[c] < 10)
    c -= '0';
  else
    return -1;

  while ((n = hex_mnemonic[(unsigned) buf[idx]]) < 10)
    c = (c * 10) + n, idx++;
  *i = idx;
  return c;
}


/** Load a data of type @c chartable from the file FD, and return the
    newly created chartable.  */

static void *
load_chartable (FILE *fp, MSymbol type)
{
  int c, from, to;
  char buf[1024];
  void *val;
  MCharTable *table;

  if (! fp)
    MERROR (MERROR_DB, NULL);

  table = mchartable (type, (type == Msymbol ? (void *) Mnil
                             : type == Minteger ? (void *) -1
                             : NULL));

  while (! feof (fp))
    {
      int i, len;

      for (len = 0; len < 1023 && (c = getc (fp)) != EOF && c != '\n'; len++)
        buf[len] = c;
      buf[len] = '\0';    
      if (hex_mnemonic[(unsigned) buf[0]] >= 10)
        /* skip comment/invalid line */
        continue;
      i = 0;
      from = read_number (buf, &i);
      if (buf[i] == '-')
        i++, to = read_number (buf, &i);
      else
        to = from;
      if (from < 0 || to < from)
        continue;

      while (buf[i] && isspace ((unsigned) buf[i])) i++;
      c = buf[i];
      if (!c)
        continue;

      if (type == Mstring)
        {
          /* VAL is a C-string.  */
          if (! (val = strdup (buf + i)))
            MEMORY_FULL (MERROR_DB);
        }
      else if (type == Minteger)
        {
          /* VAL is an integer.  */
          int positive = 1;
          int n;

          if (c == '-')
            i++, positive = -1;
          n = read_number (buf, &i);
          if (n < 0)
            goto label_error;
          val = (void *) (n * positive);
        }
      else if (type == Mtext)
        {
          /* VAL is an M-text.  */
          MText *mt;
          if (c == '"')
            mt = mconv_decode_buffer (Mcoding_utf_8,
                                      (unsigned char *) (buf + i),
                                      len - i - 1);
          else
            {
              mt = mtext ();
              while ((c = read_number (buf, &i)) >= 0)
                mt = mtext_cat_char (mt, c);
            }
          val = (void *) mt;
        }
      else if (type == Msymbol)
        {
          char *p = buf + i;

          while (*p && ! isspace (*p)) 
            {
              if (*p == '\\' && p[1] != '\0')
                {
                  memmove (p, p + 1, buf + len - (p + 1));
                  len--;
                }
              p++;
            }
          *p = '\0';
          if (! strcmp (buf + i, "nil"))
            val = (void *) Mnil;
          else
            val = (void *) msymbol (buf + i);
        }
      else if (type == Mplist)
        {
          val = (void *) mplist__from_string ((unsigned char *) buf + i,
                                              strlen (buf + i));
        }
      else
        val = NULL;

      if (from == to)
        mchartable_set (table, from, val);
      else
        mchartable_set_range (table, from, to, val);
    }
  return table;

 label_error:
  M17N_OBJECT_UNREF (table);
  MERROR (MERROR_DB, NULL);
}


/** Load a data of type @c charset from the file FD.  */

static void *
load_charset (FILE *fp, MSymbol charset_name)
{
  MCharset *charset = MCHARSET (charset_name);
  int *decoder;
  MCharTable *encoder;
  int size;
  int i, c;
  int found = 0;
  MPlist *plist;

  if (! charset)
    MERROR (MERROR_DB, NULL);
  size = (charset->code_range[15]
          - (charset->min_code - charset->code_range_min_code));
  MTABLE_MALLOC (decoder, size, MERROR_DB);
  for (i = 0; i < size; i++)
    decoder[i] = -1;
  encoder = mchartable (Minteger, (void *) MCHAR_INVALID_CODE);

  while ((c = getc (fp)) != EOF)
    {
      unsigned code1, code2, c1, c2;
      int idx1, idx2;
      char buf[256];

      ungetc (c, fp);
      fgets (buf, 256, fp);
      if (c != '#')
        {
          if (sscanf (buf, "0x%x-0x%x 0x%x", &code1, &code2, &c1) == 3)
            {
              idx1 = CODE_POINT_TO_INDEX (charset, code1);
              if (idx1 >= size)
                continue;
              idx2 = CODE_POINT_TO_INDEX (charset, code2);
              if (idx2 >= size)
                idx2 = size - 1;
              c2 = c1 + (idx2 - idx1);
            }
          else if (sscanf (buf, "0x%x 0x%x", &code1, &c1) == 2)
            {
              idx1 = idx2 = CODE_POINT_TO_INDEX (charset, code1);
              if (idx1 >= size)
                continue;
              c2 = c1;
            }
          else
            continue;
          if (idx1 >= 0 && idx2 >= 0)
            {
              decoder[idx1] = c1;
              mchartable_set (encoder, c1, (void *) code1);
              for (idx1++, c1++; idx1 <= idx2; idx1++, c1++)
                {
                  code1 = INDEX_TO_CODE_POINT (charset, idx1);
                  decoder[idx1] = c1;
                  mchartable_set (encoder, c1, (void *) code1);
                }
              found++;
            }
        }
    }

  if (! found)
    {
      free (decoder);
      M17N_OBJECT_UNREF (encoder);
      return NULL;
    }
  plist = mplist ();
  mplist_add (plist, Mt, decoder);
  mplist_add (plist, Mt, encoder);
  return plist;
}

static char *
gen_database_name (char *buf, MSymbol *tags)
{
  int i;

  strcpy (buf, msymbol_name (tags[0]));
  for (i = 1; i < 4; i++)
    {
      strcat (buf, ", ");
      strcat (buf, msymbol_name (tags[i]));
    }
  return buf;
}

static char *
get_database_filename (MDatabaseInfo *db_info)
{
  char *filename = NULL;
  struct stat buf;

  if (db_info->filename[0] == '/')
    {
      if (stat (db_info->filename, &buf) == 0)
        {
          filename = db_info->filename;
          db_info->time = MAX_TIME (buf.st_mtime, buf.st_ctime);
        }
    }
  else
    {
      MPlist *plist;
      USE_GEN_PATH;

      MPLIST_DO (plist, mdatabase__dir_list)
        {
          MDatabaseInfo *dir_info = MPLIST_VAL (plist);
          char *path = GEN_PATH (dir_info->filename, db_info->filename);

          if (stat (path, &buf) == 0)
            {
              free (db_info->filename);
              filename = db_info->filename = strdup (path);
              db_info->time = MAX_TIME (buf.st_mtime, buf.st_ctime);
              break;
            }
        }
    }
  return filename;
}

static void *
load_database (MSymbol *tags, void *extra_info)
{
  char *filename = get_database_filename ((MDatabaseInfo *) extra_info);
  FILE *fp;
  void *value;

  if (! filename || ! (fp = fopen (filename, "r")))
    MERROR (MERROR_DB, NULL);

  if (tags[0] == Mchar_table)
    value = load_chartable (fp, tags[1]);
  else if (tags[0] == Mcharset)
    value = load_charset (fp, tags[1]);
  else
    value = mplist__from_file (fp, NULL);
  fclose (fp);

  if (! value)
    MERROR (MERROR_DB, NULL);
  return value;
}


/** If DIRNAME is a readable directory, allocate MDatabaseInfo and
    copy DIRNAME to a newly allocated memory and return it.  If
    DIRNAME does not end with a slash, append a slash to the new memory.  */

static MDatabaseInfo *
get_dir_info (char *dirname)
{
  struct stat buf;
  int len;
  MDatabaseInfo *dir_info;

  if (! dirname
      || stat (dirname, &buf) < 0
      || ! (buf.st_mode & S_IFDIR))
    return NULL;

  MSTRUCT_MALLOC (dir_info, MERROR_DB);
  len = strlen (dirname) + 1;
  MTABLE_MALLOC (dir_info->filename, len, MERROR_DB);
  memcpy (dir_info->filename, dirname, len);
  /* Don't include the last '/' in filename.  */
  if (dir_info->filename[len - 2] == PATH_SEPARATOR)
      dir_info->filename[len - 2] = '\0';
  /* Set this to zero so that the first call of update_database_list
     surely checks this directory.  */
  dir_info->time = 0;
  return dir_info;
}

static MDatabase *
find_database (MSymbol tag0, MSymbol tag1, MSymbol tag2, MSymbol tag3)
{
  int i;

  for (i = 0; i < mdb_list.used; i++)
    {
      MDatabase *mdb = mdb_list.mdbs + i;

      if (tag0 == mdb->tag[0]
          && tag1 == mdb->tag[1]
          && tag2 == mdb->tag[2]
          && tag3 == mdb->tag[3])
        return mdb;
    }
  return NULL;
}

static void
register_database (MDatabase *mdb, char *path)
{
  if (find_database (mdb->tag[0], mdb->tag[1], mdb->tag[2], mdb->tag[3]))
    return;
  mdb->loader = load_database;
  mdb->extra_info = calloc (1, sizeof (MDatabaseInfo));
  if (! mdb->extra_info)
    MEMORY_FULL (MERROR_DB);
  ((MDatabaseInfo*) mdb->extra_info)->filename = strdup (path);
  MLIST_APPEND1 (&mdb_list, mdbs, *mdb, MERROR_DB);
  if (mdb->tag[0] == Mchar_table
      && mdb->tag[2] != Mnil
      && (mdb->tag[1] == Mstring || mdb->tag[1] == Mtext
          || mdb->tag[1] == Msymbol || mdb->tag[1] == Minteger
          || mdb->tag[1] == Mplist))
    mchar__define_prop (mdb->tag[2], mdb->tag[1],
                        mdb_list.mdbs + mdb_list.used - 1);
}

static void
update_database_list ()
{
  MPlist *plist;
  char *path;
  USE_GEN_PATH;

  MPLIST_DO (plist, mdatabase__dir_list)
    {
      MDatabaseInfo *dir_info = MPLIST_VAL (plist);
      struct stat statbuf;
      MPlist *pl, *p;
      int i, j;
      FILE *fp;

      if (stat (dir_info->filename, &statbuf) < 0)
        continue;
      if (dir_info->time >= statbuf.st_ctime
          && dir_info->time >= statbuf.st_mtime)
        continue;
      dir_info->time = MAX_TIME (statbuf.st_ctime, statbuf.st_mtime);
      path = GEN_PATH (dir_info->filename, MDB_DIR);
      if (! (fp = fopen (path, "r")))
        continue;
      pl = mplist__from_file (fp, NULL);
      fclose (fp);
      if (! pl)
        continue;
      MPLIST_DO (p, pl)
        {
          MDatabase mdb;
          MPlist *p1;
          MText *mt;
          int nbytes;
          int with_wildcard = 0;

          if (! MPLIST_PLIST_P (p))
            continue;
          p1 = MPLIST_PLIST (p);
          if (! MPLIST_SYMBOL_P (p1))
              continue;
          for (i = 0, p1 = MPLIST_PLIST (p);
               i < 4 && MPLIST_KEY (p1) == Msymbol;
               i++, p1 = MPLIST_NEXT (p1))
            with_wildcard |= ((mdb.tag[i] = MPLIST_SYMBOL (p1)) == Masterisk);
          if (i == 0
              || mdb.tag[0] == Masterisk
              || ! MPLIST_MTEXT_P (p1))
            continue;
          for (; i < 4; i++)
            mdb.tag[i] = Mnil;
          mdb.loader = load_database;
          mt = MPLIST_MTEXT (p1);
          if (mt->format >= MTEXT_FORMAT_UTF_16LE)
            mtext__adjust_format (mt, MTEXT_FORMAT_UTF_8);
          nbytes = mtext_nbytes (mt);
#ifdef PATH_MAX
          if (nbytes > PATH_MAX)
            continue;
#endif  /* PATH_MAX */
          if (with_wildcard
              && mdb.tag[0] != Mchar_table
              && mdb.tag[0] != Mcharset)
            {
              MPlist *dlist;
              MPlist *load_key = mplist ();

              MPLIST_DO (dlist, mdatabase__dir_list)
                {
                  MDatabaseInfo *d_info = MPLIST_VAL (dlist);
                  glob_t globbuf;

                  path = GEN_PATH_FROM_MT (d_info->filename, mt);
                  if (glob (path, GLOB_NOSORT | GLOB_NOCHECK, NULL, &globbuf))
                    {
                      if (path[0] == PATH_SEPARATOR)
                        break;
                      continue;
                    }
                  for (i = 0; i < globbuf.gl_pathc; i++)
                    {
                      if (! (fp = fopen (globbuf.gl_pathv[i], "r")))
                        continue;
                      p1 = mplist__from_file (fp, load_key);
                      fclose (fp);
                      if (! p1)
                        continue;
                      if (MPLIST_PLIST_P (p1))
                        {
                          MPlist *p0;
                          MDatabase mdb2;

                          for (j = 0, p0 = MPLIST_PLIST (p1);
                               j < 4 && MPLIST_SYMBOL_P (p0);
                               j++, p0 = MPLIST_NEXT (p0))
                            mdb2.tag[j] = MPLIST_SYMBOL (p0);
                          for (; j < 4; j++)
                            mdb2.tag[j] = Mnil;
                          for (j = 0; j < 4; j++)
                            if (mdb.tag[j] == Masterisk
                                ? mdb2.tag[j] == Mnil
                                : (mdb.tag[j] != Mnil
                                   && mdb.tag[j] != mdb2.tag[j]))
                              break;
                          if (j == 4)
                            register_database (&mdb2, globbuf.gl_pathv[i]);
                        }
                      M17N_OBJECT_UNREF (p1);
                    }
                  globfree (&globbuf);
                  if (MTEXT_DATA (mt)[0] == PATH_SEPARATOR)
                    break;
                }

              M17N_OBJECT_UNREF (load_key);
            }
          else
            {
              path = GEN_PATH_FROM_MT (dir_info->filename, mt);
              register_database (&mdb, path);
            }
        }
      M17N_OBJECT_UNREF (pl);
    }
}

\f
/* Internal API */

/** List of database directories.  */ 
MPlist *mdatabase__dir_list;

int
mdatabase__init ()
{
  MDatabaseInfo *dir_info;

  Mchar_table = msymbol ("char-table");
  Masterisk = msymbol ("*");

  mdatabase__dir_list = mplist ();
  /** The macro M17NDIR specifies a directory where the system-wide
    MDB_DIR file exists.  */
  if ((dir_info = get_dir_info (M17NDIR)))
    mplist_set (mdatabase__dir_list, Mt, dir_info);

  /* The variable mdatabase_dir specifies a directory where an
     application program specific MDB_DIR file exists.  */
  if ((dir_info = get_dir_info (mdatabase_dir)))
    mplist_push (mdatabase__dir_list, Mt, dir_info);

  /* The environment variable M17NDIR (if non-NULL) specifies a
     directory where a user specific MDB_DIR file exists.  */
  if ((dir_info = get_dir_info (getenv ("M17NDIR"))))
    mplist_push (mdatabase__dir_list, Mt, dir_info);
  /* If M17NDIR is not set, check "~/.m17n.d".  */
  else
    {
      char *home = getenv ("HOME");
      USE_GEN_PATH;

      if (home
          && (dir_info = get_dir_info (GEN_PATH (home, ".m17n.d"))))
        mplist_push (mdatabase__dir_list, Mt, dir_info);
    }

  MLIST_INIT1 (&mdb_list, mdbs, 256);
  update_database_list ();

  mdatabase__finder = ((void *(*) (MSymbol, MSymbol, MSymbol, MSymbol))
                       mdatabase_find);
  mdatabase__loader = (void *(*) (void *)) mdatabase_load;

  return 0;
}

void
mdatabase__fini (void)
{
  int i;
  MPlist *plist; 

  MPLIST_DO (plist, mdatabase__dir_list)
    {
      MDatabaseInfo *dir_info = MPLIST_VAL (plist);

      free (dir_info->filename);
      free (dir_info);
    }
  M17N_OBJECT_UNREF (mdatabase__dir_list);

  for (i = 0; i < mdb_list.used; i++)
    {
      MDatabase *mdb = mdb_list.mdbs + i;

      if (mdb->loader == load_database)
        {
          MDatabaseInfo *db_info = mdb->extra_info;

          free (db_info->filename);
          free (db_info);
        }
    }
  MLIST_FREE1 (&mdb_list, mdbs);
}

MPlist *
mdatabase__load_for_keys (MDatabase *mdb, MPlist *keys)
{
  int mdebug_mask = MDEBUG_DATABASE;
  FILE *fp;
  MPlist *plist;
  char buf[256];
  char *filename;

  if (mdb->loader != load_database
      || mdb->tag[0] == Mchar_table
      || mdb->tag[0] == Mcharset)
    MERROR (MERROR_DB, NULL);
  MDEBUG_PRINT1 (" [DATABASE] loading <%s>.\n",
                 gen_database_name (buf, mdb->tag));
  filename = get_database_filename ((MDatabaseInfo *) mdb->extra_info);
  if (! filename || ! (fp = fopen (filename, "r")))
    MERROR (MERROR_DB, NULL);
  plist = mplist__from_file (fp, keys);
  fclose (fp);
  return plist;
}


/* Check if the database MDB should be reloaded or not.  Return -1 if
   the database became not reloadable.  */

int
mdatabase__check (MDatabase *mdb)
{
  MDatabaseInfo *db_info = (MDatabaseInfo *) mdb->extra_info;
  struct stat buf;

  if (stat (db_info->filename, &buf) < 0)
    return -1;
  return (db_info->time >= buf.st_ctime
          && db_info->time >= buf.st_mtime);
}

/* Find a file FILENAME in mdatabase__dir_list.  If the file exist,
   return the absolute pathname.  If FILENAME is already absolute,
   return a copy of it.  */

char *
mdatabase__find_file (char *filename)
{
  MDatabaseInfo db_info;

  db_info.filename = strdup (filename);
  db_info.time = 0;
  if (! get_database_filename (&db_info))
    {
      free (db_info.filename);
      return NULL;
    }
  return db_info.filename;
}


/*** @} */
#endif /* !FOR_DOXYGEN || DOXYGEN_INTERNAL_MODULE */

\f
/* External API */

/*** @addtogroup m17nDatabase */
/*** @{ */

/*=*/
/***en
    @brief Directory for application specific data.

    If an application program wants to provide a data specific to the
    program or a data overriding what supplied by the m17n database,
    it must set this variable to a name of directory that contains the
    data files before it calls the macro M17N_INIT ().  The directory
    may contain a file "mdb.dir" which contains a list of data
    definitions in the format described in @ref mdbDir "mdbDir(5)".

    The default value is NULL.  */
/***ja
    @brief ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¸ÇÍ­¤Î¥Ç¡¼¥¿Íѥǥ£¥ì¥¯¥È¥ê.

    ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤¬¡¢¤½¤Î¥×¥í¥°¥é¥à¸ÇÍ­¤Î¥Ç¡¼¥¿¤ä m17n 
    ¥Ç¡¼¥¿¥Ù¡¼¥¹¤ò¾å½ñ¤­¤¹¤ë¥Ç¡¼¥¿¤òÄ󶡤¹¤ë¾ì¹ç¤Ë¤Ï¡¢¥Þ¥¯¥í M17N_INIT () 
    ¤ò¸Æ¤ÖÁ°¤Ë¤³¤ÎÊÑ¿ô¤ò¥Ç¡¼¥¿¥Õ¥¡¥¤¥ë¤ò´Þ¤à¥Ç¥£¥ì¥¯¥È¥ê̾¤Ë¥»¥Ã¥È¤·¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤Ï
    "mdb.dir" ¥Õ¥¡¥¤¥ë¤ò¤ª¤¯¤³¤È¤¬¤Ç¤­¤ë¡£¤½¤Î"mdb.dir"¥Õ¥¡¥¤¥ë¤Ë¤Ï¡¢ 
    @ref mdbDir "mdbDir(5)" ¤ÇÀâÌÀ¤µ¤ì¤Æ¤¤¤ë¥Õ¥©¡¼¥Þ¥Ã¥È¤Ç¥Ç¡¼¥¿ÄêµÁ¤Î¥ê¥¹¥È¤òµ­½Ò¤¹¤ë¡£

    ¥Ç¥Õ¥©¥ë¥È¤ÎÃÍ¤Ï NULL ¤Ç¤¢¤ë¡£  */

char *mdatabase_dir;

/*=*/
/***en
    @brief Look for a data in the database.

    The mdatabase_find () function searches the m17n database for a
    data who has tags $TAG0 through $TAG3, and returns a pointer to
    the data.  If such a data is not found, it returns @c NULL.  */

/***ja
    @brief ¥Ç¡¼¥¿¥Ù¡¼¥¹Ãæ¤Î¥Ç¡¼¥¿¤òõ¤¹.

    ´Ø¿ô mdatabase_find () ¤Ï¡¢ m17n ¸À¸ì¾ðÊó¥Ù¡¼¥¹Ãæ¤Ç $TAG0 ¤«¤é 
    $TAG3 ¤Þ¤Ç¤Î¥¿¥°¤ò»ý¤Ä¥Ç¡¼¥¿¤òõ¤·¡¢¤½¤ì¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£¤½¤Î¤è¤¦¤Ê¥Ç¡¼¥¿¤¬¤Ê¤±¤ì¤Ð
    @c NULL ¤òÊÖ¤¹¡£

    @latexonly \IPAlabel{mdatabase_find} @endlatexonly  */

MDatabase *
mdatabase_find (MSymbol tag0, MSymbol tag1, MSymbol tag2, MSymbol tag3)
{
  update_database_list ();
  return find_database (tag0, tag1, tag2, tag3);
}

/*=*/
/***en
    @brief Return a data list of the m17n database.

    The mdatabase_list () function searches the m17n database for data
    who have tags $TAG0 through $TAG3, and returns their list by a
    plist.  The value #Mnil in $TAGn means a wild card that matches
    any tag.  Each element of the plist has key #Mt and value a
    pointer to type #MDatabase.  */
/***ja
    @brief m17n ¥Ç¡¼¥¿¥Ù¡¼¥¹¤Î¥Ç¡¼¥¿¥ê¥¹¥È¤òÊÖ¤¹.

    ´Ø¿ô mdatabase_list () ¤Ï m17n ¥Ç¡¼¥¿¥Ù¡¼¥¹Ã椫¤é $TAG0 ¤«¤é$TAG3 
    ¤Þ¤Ç¤Î¥¿¥°¤ò»ý¤Ä¥Ç¡¼¥¿¤òõ¤·¡¢¤½¤Î¥ê¥¹¥È¤òplist ¤È¤·¤ÆÊÖ¤¹¡£ $TAGn ¤¬ #Mnil
    ¤Ç¤¢¤Ã¤¿¾ì¹ç¤Ë¤Ï¡¢Ç¤°Õ¤Î¥¿¥°¤Ë¥Þ¥Ã¥Á¤¹¤ë¥ï¥¤¥ë¥É¥«¡¼¥É¤È¤·¤Æ¼è¤ê°·¤ï¤ì¤ë¡£ÊÖ¤µ¤ì¤ë
    plist ¤Î³ÆÍ×ÁǤϥ­¡¼ ¤È¤·¤Æ #Mt ¤ò¡¢ÃͤȤ·¤Æ #MDatabase ·¿¤Ø¤Î¥Ý¥¤¥ó¥¿¤ò»ý¤Ä¡£  */

MPlist *
mdatabase_list (MSymbol tag0, MSymbol tag1, MSymbol tag2, MSymbol tag3)
{
  int i;
  MPlist *plist = NULL, *pl;

  update_database_list ();

  for (i = 0; i < mdb_list.used; i++)
    {
      MDatabase *mdb = mdb_list.mdbs + i;

      if ((tag0 == Mnil || tag0 == mdb->tag[0])
          && (tag1 == Mnil || tag1 == mdb->tag[1])
          && (tag2 == Mnil || tag2 == mdb->tag[2])
          && (tag3 == Mnil || tag3 == mdb->tag[3]))
        {
          if (! plist)
            plist = pl = mplist ();
          pl = mplist_add (pl, Mt, mdb);
        }
    }
  return plist;
}

/*=*/
/***en
    @brief Define a data of the m17n database.

    The mdatabase_define () function defines a data that has tags
    $TAG0 through $TAG3 and additional information $EXTRA_INFO.

    $LOADER is a pointer to a function that loads the data from the
    database.  This function is called from the mdatabase_load ()
    function with the two arguments $TAGS and $EXTRA_INFO.  Here,
    $TAGS is the array of $TAG0 through $TAG3.

    If $LOADER is @c NULL, the default loader of the m17n library is
    used.  In this case, $EXTRA_INFO must be a string specifying a
    filename that contains the data.

    @return
    If the operation was successful, mdatabase_define () returns a
    pointer to the defined data, which can be used as an argument to
    mdatabase_load ().  Otherwise, it returns @c NULL.  */

/***ja
    @brief m17n ¥Ç¡¼¥¿¥Ù¡¼¥¹¤Î¥Ç¡¼¥¿¤òÄêµÁ¤¹¤ë.

    ´Ø¿ô mdatabase_define () ¤Ï $TAG0 ¤«¤é $TAG3 ¤Þ¤Ç¤Î¥¿¥°¤ª¤è¤ÓÉղþðÊó 
    $EXTRA_INFO ¤ò»ý¤Ä¥Ç¡¼¥¿¤òÄêµÁ¤¹¤ë¡£

    $LOADER ¤Ï¤½¤Î¥Ç¡¼¥¿¤Î¥í¡¼¥É¤ËÍѤ¤¤é¤ì¤ë´Ø¿ô¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤¢¤ë¡£¤³¤Î´Ø¿ô¤Ï
    mdatabase_load () ¤«¤é $TAGS ¤È $EXTRA_INFO ¤È¤¤¤¦Æó¤Ä¤Î°ú¿ôÉÕ¤­¤Ç¸Æ¤Ó½Ð¤µ¤ì¤ë¡£¤³¤³¤Ç 
    $TAGS ¤Ï $TAG0 ¤«¤é $TAG3 ¤Þ¤Ç¤ÎÇÛÎó¤Ç¤¢¤ë¡£

    ¤â¤· $LOADER ¤¬ @c NULL ¤Ê¤é¡¢m17n ¥é¥¤¥Ö¥é¥êɸ½à¤Î¥í¡¼¥À¤¬»È¤ï¤ì¤ë¡£¤³¤Î¾ì¹ç¤Ë¤Ï
    $EXTRA_INFO ¤Ï¥Ç¡¼¥¿¤ò´Þ¤à¥Õ¥¡¥¤¥ë̾¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£

    @return
    ½èÍý¤ËÀ®¸ù¤¹¤ì¤Ð mdatabase_define () 
    ¤ÏÄêµÁ¤µ¤ì¤¿¥Ç¡¼¥¿¥Ù¡¼¥¹¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£¤³¤Î¥Ý¥¤¥ó¥¿¤Ï´Ø¿ô mdatabase_load () 
    ¤Î°ú¿ô¤È¤·¤ÆÍѤ¤¤ë¤³¤È¤¬¤Ç¤­¤ë¡£¤½¤¦¤Ç¤Ê¤±¤ì¤Ð @c NULL ¤òÊÖ¤¹¡£

    @latexonly \IPAlabel{mdatabase_define} @endlatexonly  */

/***
    @seealso
    mdatabase_load (),  mdatabase_define ()  */

MDatabase *
mdatabase_define (MSymbol tag0, MSymbol tag1, MSymbol tag2, MSymbol tag3,
                  void *(*loader) (MSymbol *, void *),
                  void *extra_info)
{
  MDatabase *mdb;

  mdb = mdatabase_find (tag0, tag1, tag2, tag3);
  if (! mdb)
    {
      MDatabase template;

      template.tag[0] = tag0, template.tag[1] = tag1;
      template.tag[2] = tag2, template.tag[3] = tag3;
      template.extra_info = NULL;
      MLIST_APPEND1 (&mdb_list, mdbs, template, MERROR_DB);
      mdb = mdb_list.mdbs + (mdb_list.used - 1);
    }
  mdb->loader = loader ? loader : load_database;
  if (mdb->loader == load_database)
    {
      MDatabaseInfo *db_info = mdb->extra_info;

      if (db_info)
        free (db_info->filename);
      else
        db_info = mdb->extra_info = malloc (sizeof (MDatabaseInfo));
      db_info->filename = strdup ((char *) extra_info);
      db_info->time = 0;
    }
  else
    mdb->extra_info = extra_info;
  return (&(mdb_list.mdbs[mdb_list.used - 1]));
}

/*=*/
/***en
    @brief Load a data from the database.

    The mdatabase_load () function loads a data specified in $MDB and
    returns the contents.  The type of contents depends on the type of
    the data.

    If the data is of the @e plist @e type, this function returns a
    pointer to @e plist.

    If the database is of the @e chartable @e type, it returns a
    chartable.  The default value of the chartable is set according to
    the second tag of the data as below:

    @li If the tag is #Msymbol, the default value is #Mnil.
    @li If the tag is #Minteger, the default value is -1.
    @li Otherwise, the default value is @c NULL.

    If the data is of the @e charset @e type, it returns a plist of length 2
    (keys are both #Mt).  The value of the first element is an array
    of integers that maps code points to the corresponding character
    codes.  The value of the second element is a chartable of integers
    that does the reverse mapping.  The charset must be defined in
    advance.  */


/***ja
    @brief ¥Ç¡¼¥¿¥Ù¡¼¥¹¤«¤é¥Ç¡¼¥¿¤ò¥í¡¼¥É¤¹¤ë.

    ´Ø¿ô mdatabase_load () ¤Ï $MDB 
    ¤¬»Ø¤¹¥Ç¡¼¥¿¤ò¥í¡¼¥É¤·¡¢¤½¤ÎÃæ¿È¤òÊÖ¤¹¡£ÊÖ¤µ¤ì¤ë¤â¤Î¤Ï¥Ç¡¼¥¿¤Î¥¿¥¤¥×¤Ë¤è¤Ã¤Æ°Û¤Ê¤ë¡£

    ¥Ç¡¼¥¿¤¬ @e plist¥¿¥¤¥× ¤Ê¤é¤Ð¡¢ @e plist ¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£

    ¥Ç¡¼¥¿¤¬ @e chartable¥¿¥¤¥× ¤Ê¤é¤Ðʸ»ú¥Æ¡¼¥Ö¥ë¤òÊÖ¤¹¡£
    ʸ»ú¥Æ¡¼¥Ö¥ë¤Î¥Ç¥Õ¥©¥ë¥ÈÃͤϡ¢¥Ç¡¼¥¿¤ÎÂè2¥¿¥°¤Ë¤è¤Ã¤Æ°Ê²¼¤Î¤è¤¦¤Ë·è¤Þ¤ë¡£

    @li ¥¿¥°¤¬ #Msymbol ¤Ê¤é¡¢¥Ç¥Õ¥©¥ë¥ÈÃÍ¤Ï #Mnil
    @li ¥¿¥°¤¬ #Minteger ¤Ê¤é¡¢¥Ç¥Õ¥©¥ë¥ÈÃÍ¤Ï -1
    @li ¤½¤ì°Ê³°¤Ê¤é¡¢¥Ç¥Õ¥©¥ë¥ÈÃÍ¤Ï @c NULL

    ¥Ç¡¼¥¿¤¬ @e charset¥¿¥¤¥× ¤Ê¤é¤ÐŤµ 2 ¤Î plist ¤òÊÖ¤¹¡Ê¥­¡¼¤Ï¶¦¤Ë#Mt ¡Ë¡£
    ºÇ½é¤ÎÍ×ÁǤÎÃͤϥ³¡¼¥É¥Ý¥¤¥ó¥È¤òÂбþ¤¹¤ëʸ»ú¥³¡¼¥É¤Ë¥Þ¥Ã¥×¤¹¤ëÀ°¿ô¤ÎÇÛÎó¤Ç¤¢¤ë¡£
    £²ÈÖÌܤÎÍ×ÁǤÎÃͤϵդΥޥåפò¤¹¤ëʸ»ú¥Æ¡¼¥Ö¥ë¤Ç¤¢¤ë¡£
    ¤³¤Îʸ»ú¥»¥Ã¥È¤Ïͽ¤áÄêµÁ¤µ¤ì¤Æ¤¤¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£

    @latexonly \IPAlabel{mdatabase_load} @endlatexonly
  */

/***
    @seealso
    mdatabase_load (),  mdatabase_define ()  */

void *
mdatabase_load (MDatabase *mdb)
{
  int mdebug_mask = MDEBUG_DATABASE;
  char buf[256];

  MDEBUG_PRINT1 (" [DATABASE] loading <%s>.\n",
                 gen_database_name (buf, mdb->tag));
  return (*mdb->loader) (mdb->tag, mdb->extra_info);
}

/*=*/
/***en
    @brief Get tags of a data.

    The mdatabase_tag () function returns an array of tags (symbols)
    that identify the data in $MDB.  The length of the array is
    four.  */

/***ja
    @brief ¥Ç¡¼¥¿¤Î¥¿¥°¤òÆÀ¤ë.

    ´Ø¿ô mdatabase_tag () ¤Ï¡¢¥Ç¡¼¥¿ $MDB ¤Î¥¿¥°¡Ê¥·¥ó¥Ü¥ë¡Ë¤ÎÇÛÎó¤òÊÖ¤¹¡£ÇÛÎó¤ÎŤµ¤Ï
    4 ¤Ç¤¢¤ë¡£

    @latexonly \IPAlabel{mdatabase_tag} @endlatexonly  */

MSymbol *
mdatabase_tag (MDatabase *mdb)
{
  return mdb->tag;
}

/*** @} */

/*
  Local Variables:
  coding: euc-japan
  End:
*/