/* m17n-core.c -- body of the CORE API.

   Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012

     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., 51 Franklin Street, Fifth Floor,

   Boston, MA 02110-1301 USA.  */

/***en

    @addtogroup m17nIntro

    @brief Introduction to the m17n library.

    API LEVELS

    The API of the m17n library is divided into these five.

    
 CORE API

    It provides basic modules to handle M-texts.  To use this API, an

    application program must include <m17n-core<EM>.h> and be

    linked with -lm17n-core.

    
 SHELL API

    It provides modules for character properties, character set

    handling, code conversion, etc.  They load various kinds of

    data from the database on demand.  To use this API, an application

    program must include <m17n<EM>.h> and be linked with

    -lm17n-core -lm17n.

    When you use this API, CORE API is also available.

    
 FLT API

    It provides modules for text shaping using @ref mdbFLT.  To use

    this API, an application program must include <m17n<EM>.h>

    and be linked with -lm17n-core -lm17n-flt.

    When you use this API, CORE API is also available.

    
 GUI API

    It provides GUI modules such as drawing and inputting M-texts on a

    graphic device.  This API itself is independent of graphic

    devices, but most functions require an argument MFrame that is

    created for a specific type of graphic devices.  The currently

    supported graphic devices are null device, the X Window System,

    and image data (gdImagePtr) of the GD library.

    On a frame of a null device, you cannot draw text nor use input

    methods.  However, functions like mdraw_glyph_list (), etc. are

    available.

    On a frame of the X Window System, you can use the whole GUI API.

    On a frame of the GD library, you can use all drawing API but

    cannot use input methods.

    To use this API, an application program must include

    <m17n-gui<EM>.h> and be linked with -lm17n-core -lm17n

    -lm17n-gui.

    When you use this API, CORE, SHELL, and FLT APIs are also

    available.

    
 MISC API

    It provides miscellaneous functions to support error handling and

    debugging.  This API cannot be used standalone; it must be used

    with one or more APIs listed above.  To use this API, an

    application program must include <m17n-misc<EM>.h> in

    addition to one of the header files described above.

    See also the section @ref m17n-config "m17n-config(1)".

    ENVIRONMENT VARIABLES

    The m17n library pays attention to the following environment

    variables.

    
 @c M17NDIR

    The name of the directory that contains data of the m17n database.

    See @ref m17nDatabase for details.

    
 @c MDEBUG_XXX

    Environment variables whose names start with "MDEBUG_" control

    debug information output.  See @ref m17nDebug for details.

    API NAMING CONVENTION

    The m17n library exports functions, variables, macros, and types.

    All of them start with the letter 'm' or 'M', and are followed by

    an object name (e.g. "symbol", "plist") or a module name

    (e.g. draw, input).  Note that the name of M-text objects start

    with "mtext" and not with "mmtext".

    
 functions -- mobject () or mobject_xxx ()

    They start with 'm' and are followed by an object name in lower

    case.  Words are separated by '_'.  For example, msymbol (),

    mtext_ref_char (), mdraw_text ().

    
 non-symbol variables -- mobject, or mobject_xxx

    The naming convention is the same as functions (e.g. mface_large).

    
 symbol variables -- Mname

    Variables of the type MSymbol start with 'M' and are followed by

    their names.  Words are separated by '_'.  For example, Mlanguage

    (the name is "language"), Miso_2022 (the name is "iso-2022").

    
 macros -- MOBJECT_XXX

    They start with 'M' and are followed by an object name in upper

    case.  Words are separated by '_'.

    
 types -- MObject or MObjectXxx

    They start with 'M' and are followed by capitalized object names.

    Words are concatenated directly and no '_' are used.  For example,

    MConverter, MInputDriver.

  */

/***ja

    @addtogroup m17nIntro

    @brief m17n ライブラリ イントロダクション.

    @em APIのレベル

    m17n ライブラリの API は以下の４種に分類されている。

    
 コア API

    M-text を扱うための基本的なモジュールを提供する。

    この API を利用するためには、アプリケーションプログラムは

    <m17n-core<EM>.h> を include し、 -lm17n-core

    でリンクされなくてはならない。

    
 シェル API

    文字プロパティ、文字集合操作、コード変換等のためのモジュールを提供する。

    これらのモジュールは、データベースから必要に応じて多様なデータをロードする。

    この API を利用するためには、アプリケーションプログラムは

    <m17n<EM>.h> を include し、 -lm17n-core -lm17n

    でリンクされなくてはならない。

    この API を使用すれば、コア API も自動的に使用可能となる。

    
 FLT API

    文字列表示に @ref mdbFLT を用いるモジュールを提供する。この API

    を利用するためには、アプリケーションプログラムは <m17n<EM>.h> 

    を include し、 -lm17n-core -lm17n-flt でリンクされなくてはならない。

    この API を使用すれば、コア API も自動的に使用可能となる。

    
 GUI API

    グラフィックデバイス上で M-text を表示したり入力したりするための

    GUI モジュールを提供する。この API

    自体はグラフィックデバイスとは独立であるが、

    多くの関数は特定のグラフィックデバイス用に作成された 

    MFrame を引数に取る。

    現時点でサポートされているグラフィックデバイスは、ヌルデバイス、X

    ウィンドウシステム、および GD ライブラリのイメージデータ

    (gdImagePtr) である。

    ヌルデバイスのフレーム上では表示も入力もできない。ただし

    mdraw_glyph_list () などの関数は使用可能である。

    X ウィンドウシステムのフレーム上ではすべての GUI API が使用できる。

    GD ライブラリのフレーム上では、描画用の API

    はすべて使用できるが、入力はできない。

    この API を使用するためには、アプリケーションプログラムは

    <m17n-gui<EM>.h> を include し、-lm17n-core -lm17n -lm17n-gui

    でリンクされなくてはならない。

    この API を使用すれば、コア API、シェル API、および FLT API

    も自動的に使用可能となる。

    
 その他の API

    エラー処理、デバッグ用のその他の関数を提供する。この API

    はそれだけでは使用できず、上記の他の API

    と共に使う。利用するためには、上記のいずれかのinclude

    ファイルに加えて、 <m17n-misc<EM>.h> をinclude

    しなくてはならない。

    @ref m17n-config "m17n-config(1)" 節も参照。

    @em 環境変数

    m17n ライブラリは以下の環境変数を参照する。

    
 @c M17NDIR

    m17n データベースのデータを格納したディレクトリの名前。詳細は @ref

    m17nDatabase 参照。

    
 @c MDEBUG_XXX

    "MDEBUG_" で始まる名前を持つ環境変数はデバッグ情報の出力を制御する。

    詳細は @ref m17nDebug 参照。

    @em API @em の命名規則

    m17n ライブラリは、関数、変数、マクロ、型を export する。それらは 'm' 

    または 'M' のあとにオブジェクト名 ("symbol"、"plist" など)

    またはモジュール名 (draw, input など) を続けたものである。

    M-text オブジェクトの名前は "mmtext" ではなくて "mtext"

    で始まることに注意。

    
 関数 -- mobject () または mobject_xxx ()

    'm' のあとに小文字でオブジェクト名が続く。単語間は '_'

    で区切られる。たとえば、msymbol (),

     mtext_ref_char (), mdraw_text () など。

    
 シンボルでない変数 -- mobject,  または mobject_xxx

    関数と同じ命名規則に従う。たとえば  mface_large など。

    
 シンボル変数 -- Mname

    MSymbol 型変数は、'M' の後に名前が続く。単語間は '_'

    で区切られる。たとえば Mlanguage (名前は "language"), Miso_2022

    (名前は"iso-2022") など。

    
 マクロ -- MOBJECT_XXX

    'M' の後に大文字でオブジェクト名が続く。単語間は '_' で区切られる。

    
 タイプ -- MObject または MObjectXxx

    'M' の後に大文字で始まるオブジェクト名が続く。単語は連続して書かれ、

    '_' は用いられない。たとえば MConverter, MInputDriver など。

    */

/*=*/

/*** @{ */

#ifdef FOR_DOXYGEN

/***en

    The #M17NLIB_MAJOR_VERSION macro gives the major version number

    of the m17n library.  */

/***ja

    マクロ #M17NLIB_MAJOR_VERSION は m17n 

    ライブラリのメジャーバージョン番号を与える.  */

#define M17NLIB_MAJOR_VERSION

/*=*/

/***en

    The #M17NLIB_MINOR_VERSION macro gives the minor version number

    of the m17n library.  */

/***ja

    マクロ #M17NLIB_MINOR_VERSION は m17n 

    ライブラリのマイナーバージョン番号を与える.  */

#define M17NLIB_MINOR_VERSION

/*=*/

/***en

    The #M17NLIB_PATCH_LEVEL macro gives the patch level number

    of the m17n library.  */

/***ja

    マクロ #M17NLIB_PATCH_LEVEL は m17n 

    ライブラリのパッチレベル番号を与える.  */

#define M17NLIB_PATCH_LEVEL

/*=*/

/***en

    The #M17NLIB_VERSION_NAME macro gives the version name of the

    m17n library as a string.  */

/***ja

    マクロ #M17NLIB_VERSION_NAME は m17n 

    ライブラリのバージョン名を文字列として与える.  */

#define M17NLIB_VERSION_NAME

/*=*/

/***en

    @brief Initialize the m17n library.

    The macro M17N_INIT () initializes the m17n library.  This macro

    must be called before any m17n functions are used.

    It is safe to call this macro multiple times, but in that case,

    the macro M17N_FINI () must be called the same times to free the

    memory.

    If the initialization was successful, the external variable

    #merror_code is set to 0.  Otherwise it is set to -1.

    @seealso

    M17N_FINI (), m17n_status ()  */

/***ja

    @brief m17n ライブラリを初期化する.

    マクロ M17N_INIT () は m17n ライブラリを初期化する。m17n 

    の関数を利用する前に、このマクロをまず呼ばなくてはならない。

    このマクロを複数回呼んでも安全であるが、その場合メモリを解放するためにマクロ

    M17N_FINI () を同じ回数呼ぶ必要がある。

    外部変数 #merror_code は、初期化が成功すれば 0 に、そうでなければ 

    -1 に設定される。  

    @seealso

    M17N_FINI (), m17n_status ()  */

#define M17N_INIT()

/*=*/

/***en

    @brief Finalize the m17n library.

    The macro M17N_FINI () finalizes the m17n library.  It frees all the

    memory area used by the m17n library.  Once this macro is

    called, no m17n functions should be used until the

    macro M17N_INIT () is called again.

    If the macro M17N_INIT () was called N times, the Nth call of this

    macro actually free the memory. 

    @seealso

    M17N_INIT (), m17n_status ()  */

/***ja

    @brief m17n ライブラリを終了する. 

    マクロ M17N_FINI () は m17n ライブラリを終了する。m17n 

    ライブラリが使った全てのメモリ領域は解放される。一度このマクロが呼ばれたら、マクロ

    M17N_INIT () が再度呼ばれるまで m17n 関数は使うべきでない。

    マクロ M17N_INIT () が N 回呼ばれていた場合には、このマクロが N 

    回呼ばれて初めてメモリが解放される。

    @seealso

    M17N_INIT (), m17n_status ()  */

#define M17N_FINI()

#endif /* FOR_DOXYGEN */

/*=*/

/*** @} */ 

/*=*/

#if !defined (FOR_DOXYGEN) || defined (DOXYGEN_INTERNAL_MODULE)

/*** @addtogroup m17nInternal

     @{ */

#include <config.h>

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include <sys/time.h>

#include <sys/resource.h>

#include <unistd.h>

#include "m17n-core.h"

#include "m17n-misc.h"

#include "internal.h"

#include "symbol.h"

static void

default_error_handler (enum MErrorCode err)

{

  exit (err);

}

static struct timeval time_stack[16];

static int time_stack_index;

static M17NObjectArray *object_array_root;

static void

report_object_array ()

{

  fprintf (mdebug__output, "%16s %7s %7s %7s\n",

	   "object", "created", "freed", "alive");

  fprintf (mdebug__output, "%16s %7s %7s %7s\n",

	   "------", "-------", "-----", "-----");

  for (; object_array_root; object_array_root = object_array_root->next)

    {

      M17NObjectArray *array = object_array_root;

      fprintf (mdebug__output, "%16s %7d %7d %7d\n", array->name,

	       array->used, array->used - array->count, array->count);

      if (array->count > 0)

	{

	  int i;

	  for (i = 0; i < array->used && ! array->objects[i]; i++);

	  if (strcmp (array->name, "M-text") == 0)

	    {

	      MText *mt = (MText *) array->objects[i];

	      if (mt->format <= MTEXT_FORMAT_UTF_8)

		fprintf (mdebug__output, "\t\"%s\"\n", (char *) mt->data);

	    }

	  else if (strcmp (array->name, "Plist") == 0)

	    {

	      MPlist *plist = (MPlist *) array->objects[i];

	      mdebug_dump_plist (plist, 8);

	      fprintf (mdebug__output, "\n");

	    }

	}

      if (array->objects != NULL)

	{

	  free (array->objects);

	  array->count = array->used = 0;

	}

    }

}

/* Internal API */

int m17n__core_initialized;

int m17n__shell_initialized;

int m17n__gui_initialized;

int mdebug__flags[MDEBUG_MAX];

FILE *mdebug__output;

void

mdebug__push_time ()

{

  struct timezone tz;

  gettimeofday (time_stack + time_stack_index++, &tz;;

}

void

mdebug__pop_time ()

{

  time_stack_index--;

}

void

mdebug__print_time ()

{

  struct timeval tv;

  struct timezone tz;

  long diff;

  gettimeofday (&tv, &tz;;

  diff = ((tv.tv_sec - time_stack[time_stack_index - 1].tv_sec) * 1000000

	  + (tv.tv_usec - time_stack[time_stack_index - 1].tv_usec));

  fprintf (mdebug__output, "%8ld ms.", diff);

  time_stack[time_stack_index - 1] = tv;

}

static void

SET_DEBUG_FLAG (char *env_name, enum MDebugFlag flag)

{

  char *env_value = getenv (env_name);

  if (env_value)

    {

      int int_value = atoi (env_value);

      if (flag == MDEBUG_ALL)

	{

	  int i;

	  for (i = 0; i < MDEBUG_MAX; i++)

	    mdebug__flags[i] = int_value;

	}

      else

	mdebug__flags[flag] = int_value;

    }

}

void

mdebug__add_object_array (M17NObjectArray *array, char *name)

{

  array->name = name;

  array->count = 0;

  array->next = object_array_root;

  object_array_root = array;

}

void

mdebug__register_object (M17NObjectArray *array, void *object)

{

  if (array->objects == NULL)

    MLIST_INIT1 (array, objects, 256);

  array->count++;

  MLIST_APPEND1 (array, objects, object, MERROR_OBJECT);

}

void

mdebug__unregister_object (M17NObjectArray *array, void *object)

{

  array->count--;

  if (array->count >= 0)

    {

      int i;

      for (i = array->used - 1; i >= 0 && array->objects[i] != object; i--);

      if (i >= 0)

	{

	  if (i == array->used - 1)

	    array->used--;

	  array->objects[i] = NULL;

	}

      else

	mdebug_hook ();

    }

  else									\

    mdebug_hook ();

}

/* External API */

/* The following two are actually not exposed to a user but concealed

   by the macro M17N_INIT (). */

void

m17n_init_core (void)

{

  int mdebug_flag = MDEBUG_INIT;

  merror_code = MERROR_NONE;

  if (m17n__core_initialized++)

    return;

  m17n_memory_full_handler = default_error_handler;

  SET_DEBUG_FLAG ("MDEBUG_ALL", MDEBUG_ALL);

  SET_DEBUG_FLAG ("MDEBUG_INIT", MDEBUG_INIT);

  SET_DEBUG_FLAG ("MDEBUG_FINI", MDEBUG_FINI);

  SET_DEBUG_FLAG ("MDEBUG_CHARSET", MDEBUG_CHARSET);

  SET_DEBUG_FLAG ("MDEBUG_CODING", MDEBUG_CODING);

  SET_DEBUG_FLAG ("MDEBUG_DATABASE", MDEBUG_DATABASE);

  SET_DEBUG_FLAG ("MDEBUG_FONT", MDEBUG_FONT); 

  SET_DEBUG_FLAG ("MDEBUG_FLT", MDEBUG_FLT);

  SET_DEBUG_FLAG ("MDEBUG_FONTSET", MDEBUG_FONTSET);

  SET_DEBUG_FLAG ("MDEBUG_INPUT", MDEBUG_INPUT);

  /* for backward compatibility... */

  SET_DEBUG_FLAG ("MDEBUG_FONT_FLT", MDEBUG_FLT);

  SET_DEBUG_FLAG ("MDEBUG_FONT_OTF", MDEBUG_FLT);

  {

    char *env_value = getenv ("MDEBUG_OUTPUT_FILE");

    mdebug__output = NULL;

    if (env_value)

      {

	if (strcmp (env_value, "stdout") == 0)

	  mdebug__output = stdout;

	else

	  mdebug__output = fopen (env_value, "a");

      }

    if (! mdebug__output)

      mdebug__output = stderr;

  }

  MDEBUG_PUSH_TIME ();

  MDEBUG_PUSH_TIME ();

  if (msymbol__init () < 0)

    goto err;

  MDEBUG_PRINT_TIME ("INIT", (mdebug__output, " to initialize symbol module."));

  if  (mplist__init () < 0)

    goto err;

  MDEBUG_PRINT_TIME ("INIT", (mdebug__output, " to initialize plist module."));

  if (mchar__init () < 0)

    goto err;

  MDEBUG_PRINT_TIME ("INIT",

		     (mdebug__output, " to initialize character module."));

  if  (mchartable__init () < 0)

    goto err;

  MDEBUG_PRINT_TIME ("INIT",

		     (mdebug__output, " to initialize chartable module."));

  if (mtext__init () < 0 || mtext__prop_init () < 0)

    goto err;

  MDEBUG_PRINT_TIME ("INIT", (mdebug__output, " to initialize mtext module."));

  if (mdatabase__init () < 0)

    goto err;

  MDEBUG_PRINT_TIME ("INIT",

		     (mdebug__output, " to initialize database module."));

#if ENABLE_NLS

  bindtextdomain ("m17n-lib", GETTEXTDIR);

  bindtextdomain ("m17n-db", GETTEXTDIR);

  bindtextdomain ("m17n-contrib", GETTEXTDIR);

  bind_textdomain_codeset ("m17n-lib", "UTF-8");

  bind_textdomain_codeset ("m17n-db", "UTF-8");

  bind_textdomain_codeset ("m17n-contrib", "UTF-8");

#endif

 err:

  MDEBUG_POP_TIME ();

  MDEBUG_PRINT_TIME ("INIT",

		     (mdebug__output, " to initialize the core modules."));

  MDEBUG_POP_TIME ();

}

void

m17n_fini_core (void)

{

  int mdebug_flag = MDEBUG_FINI;

  if (m17n__core_initialized == 0

      || --m17n__core_initialized > 0)

    return;

  MDEBUG_PUSH_TIME ();

  MDEBUG_PUSH_TIME ();

  mchartable__fini ();

  MDEBUG_PRINT_TIME ("FINI", (mdebug__output, " to finalize chartable module."));

  mtext__fini ();

  MDEBUG_PRINT_TIME ("FINI", (mdebug__output, " to finalize mtext module."));

  msymbol__fini ();

  MDEBUG_PRINT_TIME ("FINI", (mdebug__output, " to finalize symbol module."));

  mplist__fini ();

  MDEBUG_PRINT_TIME ("FINI", (mdebug__output, " to finalize plist module."));

  /* We must call this after the aboves because it frees interval

     pools.  */

  mtext__prop_fini ();

  MDEBUG_PRINT_TIME ("FINI", (mdebug__output, " to finalize textprop module."));

  MDEBUG_POP_TIME ();

  MDEBUG_PRINT_TIME ("FINI", (mdebug__output, " to finalize the core modules."));

  MDEBUG_POP_TIME ();

  if (mdebug__flags[MDEBUG_FINI])

    report_object_array ();

  msymbol__free_table ();

  if (mdebug__output != stderr)

    fclose (mdebug__output);

}

/*** @} */

#endif /* !FOR_DOXYGEN || DOXYGEN_INTERNAL_MODULE */

/*=*/

/*** @addtogroup m17nIntro */

/*** @{  */

/*=*/

/***en

    @brief Report which part of the m17n library is initialized.

    The m17n_status () function returns one of these values depending

    on which part of the m17n library is initialized:

	#M17N_NOT_INITIALIZED, #M17N_CORE_INITIALIZED,

	#M17N_SHELL_INITIALIZED, #M17N_GUI_INITIALIZED  */

/***ja

    @brief m17n ライブラリのどの部分が初期化されたか報告する.

    関数 m17n_status () は 

    m17n ライブラリのどの部分が初期化されたかに応じて、以下の値のいずれかを返す。

	#M17N_NOT_INITIALIZED, #M17N_CORE_INITIALIZED,

	#M17N_SHELL_INITIALIZED, #M17N_GUI_INITIALIZED  */

enum M17NStatus

m17n_status (void)

{

  return (m17n__gui_initialized ? M17N_GUI_INITIALIZED

	  : m17n__shell_initialized ? M17N_SHELL_INITIALIZED

	  : m17n__core_initialized ? M17N_CORE_INITIALIZED

	  : M17N_NOT_INITIALIZED);

}

/*** @} */

/*=*/

/***en

    @addtogroup m17nObject

    @brief Managed objects are objects managed by the reference count.

    There are some types of m17n objects that are managed by their

    reference count.  Those objects are called @e managed @e objects.

    When created, the reference count of a managed object is

    initialized to one.  The m17n_object_ref () function increments

    the reference count of a managed object by one, and the

    m17n_object_unref () function decrements by one.  A managed

    object is automatically freed when its reference count becomes

    zero.

    A property whose key is a managing key can have only a managed

    object as its value.  Some functions, for instance msymbol_put ()

    and mplist_put (), pay special attention to such a property.

    In addition to the predefined managed object types, users can

    define their own managed object types.  See the documentation of

    the m17n_object () for more details.  */

/***ja

    @addtogroup m17nObject

    @brief 管理下オブジェクトとは参照数によって管理されているオブジェクトである.

    m17n オブジェクトのある型のものは、参照数によって管理されている。

    それらのオブジェクトは @e 管理下オブジェクト と呼ばれる。生成された時点での参照数は

    1 に初期化されている。関数 m17n_object_ref () は管理下オブジェクトの参照数を

    1 増やし、関数m17n_object_unref () は 1 減らす。参照数が

    0 になった管理下オブジェクトは自動的に解放される。

    キーが管理キーであるプロパティは、値として管理下オブジェクトだけを取る。

    関数 msymbol_put () や mplist_put () などはそれらのプロパティを特別扱いする。

    定義済み管理下オブジェクトタイプの他に、ユーザは必要な管理下オブジェクトタイプを自分で定義することができる。詳細は

    m17n_object () の説明を参照。  */

/*** @{  */

/*=*/

/***en

    @brief Allocate a managed object.

    The m17n_object () function allocates a new managed object of

    $SIZE bytes and sets its reference count to 1.  $FREER is the

    function that is used to free the object when the reference count

    becomes 0.  If $FREER is NULL, the object is freed by the free ()

    function.

    The heading bytes of the allocated object is occupied by

    #M17NObjectHead.  That area is reserved for the m17n library and

    application programs should never touch it.

    @return

    This function returns a newly allocated object.

    @errors

    This function never fails.  */

/***ja

    @brief 管理下オブジェクトを割り当てる.

    関数 m17n_object () は$SIZE バイトの新しい管理下オブジェクトを割り当て、その参照数を

    1 とする。 $FREER は参照数が 0 

    になった際にそのオブジェクトを解放するために用いられる関数である。$FREER

    が NULLならば、オブジェクトは関数 free () によって解放される。

    割り当てられたオブジェクト冒頭のバイトは、#M17NObjectHead 

    が占める。この領域は m17n ライブラリが使用するので、アプリケーションプログラムは触れてはならない。

    @return

    この関数は新しく割り当てられたオブジェクトを返す。

    @errors

    この関数は失敗しない。    */

#if EXAMPLE_CODE

typedef struct

{

  M17NObjectHead head;

  int mem1;

  char *mem2;

} MYStruct;

void

my_freer (void *obj)

{

  free (((MYStruct *) obj)->mem2);

  free (obj);

}

void

my_func (MText *mt, MSymbol key, int num, char *str)

{

  MYStruct *st = m17n_object (sizeof (MYStruct), my_freer);

  st->mem1 = num;

  st->mem2 = strdup (str);

  /* KEY must be a managing key.   */

  mtext_put_prop (mt, 0, mtext_len (mt), key, st);

  /* This sets the reference count of ST back to 1.  */

  m17n_object_unref (st);

}

#endif

void *

m17n_object (int size, void (*freer) (void *))

{

  M17NObject *obj = malloc (size);

  obj->ref_count = 1;

  obj->ref_count_extended = 0;

  obj->flag = 0;

  obj->u.freer = freer;

  return obj;

}

/*=*/

/***en

    @brief Increment the reference count of a managed object.

    The m17n_object_ref () function increments the reference count of

    the managed object pointed to by $OBJECT.

    @return

    This function returns the resulting reference count if it fits in

    a 16-bit unsigned integer (i.e. less than 0x10000).  Otherwise, it

    return -1.

    @errors

    This function never fails.  */

/***ja

    @brief 管理下オブジェクトの参照数を 1 増やす.

    関数 m17n_object_ref () は $OBJECT 

    で指される管理下オブジェクトの参照数を 1 増やす。

    @return 

    この関数は、増やした参照数が 16 ビットの符号無し整数値(すなわち 

    0x10000 未満)におさまれば、それを返す。そうでなければ -1 を返す。

    @errors

    この関数は失敗しない。    */

int

m17n_object_ref (void *object)

{

  M17NObject *obj = (M17NObject *) object;

  M17NObjectRecord *record;

  unsigned *count;

  if (! obj->ref_count_extended)

    {

      if (++obj->ref_count)

	return (int) obj->ref_count;