1 /* m17n-core.c -- body of the CORE API.
2 Copyright (C) 2003, 2004
3 National Institute of Advanced Industrial Science and Technology (AIST)
4 Registration Number H15PRO112
6 This file is part of the m17n library.
8 The m17n library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Lesser General Public License
10 as published by the Free Software Foundation; either version 2.1 of
11 the License, or (at your option) any later version.
13 The m17n library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public
19 License along with the m17n library; if not, write to the Free
20 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
25 @brief Introduction to the m17n library
29 The API of the m17n library is divided into these four.
34 It provides basic modules to handle M-texts. They don't require
35 the m17n database. To use this API, an application program must
36 include <m17n-core.h> and be linked by -lm17n-core.
40 It provides modules that utilize the m17n database. They load
41 various kinds of data from the database on demand. To use this
42 API, an application program must include <m17n.h> and be linked by
43 -lm17n-core -lm17n. With that, CORE API is also available.
47 It provides GUI modules such as drawing and inputting M-texts on a
48 window system. The API itself is independent on a window system,
49 but the m17n library must be configured to use a specific window
50 system. Currently, we support only the X Window System. To use
51 this API, an application program must include <m17n-gui.h> and
52 <m17n-X.h>, and be linked by -lm17n-core -lm17n -lm17n-X. With
53 that, CORE and SHELL APIs are also available.
57 It provides miscellaneous functions to support error handling and
58 debugging. This API can't be used by itself, but with one or more
59 APIs listed above. To use the API, an application program must
60 include <m17n-misc.h> in addition to one of <m17n-core.h>,
61 <m17n.h>, and <m17n-gui.h>.
65 See also the section @ref m17n-config "m17n-config(1)".
67 <em>ENVIRONMENT VARIABLE</em>
69 The m17n library pays attention to these environment variables.
74 Name of a directory that contains data of the m17n database. See
75 @ref m17nDatabase for the detail.
79 Environment variables whose name start by "MDEBUG_" controls
80 printing of debug information. See @ref m17nDebug for the detail.
84 <em>API NAMING CONVENTION</em>
86 The library exports functions, variables, macros, and types. All
87 of them start by the letter 'm' or 'M' followed by an object name
88 (e.g. "symbol" and "plist", but "mtext" object is given the name
89 "text" to avoid double 'm' at the head) or a module name
94 <li> functions -- mobject () or mobject_xxx ()
96 They start with 'm' followed by lower case object name. For
97 example, msymbol (), mtext_ref_char (), mdraw_text ().
99 <li> non-symbol variables -- mobject, or mobject_xxx
101 The naming convention is the same as functions (e.g. mface_large).
103 <li> symbol variables -- Mname
105 Variables of type MSymbol start with 'M' followed by their names
106 (e.g. Mlanguage (name is "langauge"), Miso_2022 (name is
109 <li> macross -- MOBJECT_XXX
111 They start by 'M' followed by upper case object names.
113 <li> types -- MObject or MObjectXxx
115 They start by 'M' followed by capitalized object names (e.g.
116 MConverter, MInputDriver).
123 @addtogroup m17nIntro
125 @e m17n¥é¥¤¥Ö¥é¥ê ¤Ï C ¸À¸ìÍÑ¿¸À¸ì¾ðÊó½èÍý¥é¥¤¥Ö¥é¥ê¤Ç¤¢¤ë¡£
126 ¤³¤Î¥é¥¤¥Ö¥é¥ê¤Ï¡¢Â¿¸À¸ìʸ½ñ¤ò°·¤¦¤¿¤á¤ËɬÍפʰʲ¼¤Î´ðËܵ¡Ç½¤ò¥¢¥×
127 ¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤ËÄ󶡤¹¤ë¡£
129 @li ¿¸À¸ì¥Æ¥¥¹¥ÈÍÑ¥ª¥Ö¥¸¥§¥¯¥È¤È¤·¤Æ¤Î¹½Â¤ÂÎ @e M-text
131 @li M-text ¤ò°·¤¦¤¿¤á¤Î¿¤¯¤Î´Ø¿ô¡¦¥Þ¥¯¥í·²
133 @li ¼ï¡¹¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤Ç¥¨¥ó¥³¡¼¥É¤µ¤ì¤¿¥Æ¥¥¹¥È¤È M-text ´Ö¤ÎÊÑ´¹
134 ¤ò¹Ô¤Ê¤¦¥Ç¥³¡¼¥À¡¿¥¨¥ó¥³¡¼¥À
136 @li Unicode ¤ÎÁ´¤Æ¤Îʸ»ú¤Ë²Ã¤¨¡¢¤½¤ì¤ÈƱ¤¸¿ô¤ÎÈó Unicode ʸ»ú¤ò°·
139 @li ʸ»úËè¤Î¾ðÊó¤ò¸úΨÎɤ¯³ÊǼ¤¹¤ë¹½Â¤ÂÎ @e ʸ»ú¥Æ¡¼¥Ö¥ë (CharTable)
141 @li ¥ª¥×¥·¥ç¥ó¡§M-text¤Î¥¦¥£¥ó¥É¥¦¥·¥¹¥Æ¥à¾å¤Ç¤Îɽ¼¨¡¦ÆþÎÏ¥·¥¹¥Æ¥à¡£
142 ¡Ê¤³¤Î¤¿¤á¤Î API ¤Ï m17n-win.h ¤Ë´Þ¤Þ¤ì¤Æ¤¤¤ë¡£¡Ë */
147 The #M17NLIB_MAJOR_VERSION macro gives the major version number
148 of the m17n library. */
151 ¥Þ¥¯¥í #M17NLIB_MAJOR_VERSION ¤Ï m17n ¥é¥¤¥Ö¥é¥ê¤Î¥á¥¸¥ã¡¼¥Ð¡¼¥¸¥ç
154 #define M17NLIB_MAJOR_VERSION
159 The #M17NLIB_MINOR_VERSION macro gives the minor version number
160 of the m17n library. */
163 ¥Þ¥¯¥í #M17NLIB_MINOR_VERSION ¤Ï m17n ¥é¥¤¥Ö¥é¥ê¤Î¥Þ¥¤¥Ê¡¼¥Ð¡¼¥¸¥ç
166 #define M17NLIB_MINOR_VERSION
171 The #M17NLIB_VERSION_NAME macro gives the version name of the
172 m17n library as a string. */
175 ¥Þ¥¯¥í #M17NLIB_VERSION_NAME ¤Ï m17n ¥é¥¤¥Ö¥é¥ê¤Î¥Ð¡¼¥¸¥ç¥ó̾¤ò
176 C-string ¤Î·Á¤ÇÍ¿¤¨¤ë¡£ */
178 #define M17NLIB_VERSION_NAME
183 @brief Initialize the m17n library.
185 The macro M17N_INIT () initializes the m17n library. This
186 function must be called before any m17n functions are used.
188 If the initialization was successful, the external variable @c
189 merror_code is set to 0. Otherwise it is set to -1. */
192 @brief m17n ¥é¥¤¥Ö¥é¥ê¤Î½é´ü²½
194 ¥Þ¥¯¥í M17N_INIT () ¤Ï m17n ¥é¥¤¥Ö¥é¥ê¤ò½é´ü²½¤¹¤ë¡£m17n ¥é¥¤¥Ö¥é
195 ¥ê¤ò»È¤¦¤È¤¤Ï¡¢ºÇ½é¤Ë¤³¤Î´Ø¿ô¤ò¸Æ¤Ð¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
197 ÊÑ¿ô #merror_code ¤Ï¡¢½é´ü²½¤¬À®¸ù¤¹¤ì¤Ð 0 ¤Ë¡¢¤½¤¦¤Ç¤Ê¤±¤ì¤Ð -1
205 @brief Finalize the m17n library.
207 The macro M17N_FINI () finalizes the m17n library. It frees all the
208 memory area used by the m17n library. Once this function is
209 called, no m17n functions should be used until the
210 macro M17N_INIT () is called again. */
213 @brief m17n ¥é¥¤¥Ö¥é¥ê¤Î½ªÎ» */
216 #endif /* FOR_DOXYGEN */
221 #if !defined (FOR_DOXYGEN) || defined (DOXYGEN_INTERNAL_MODULE)
222 /*** @addtogroup m17nInternal
228 #include <sys/time.h>
229 #include <sys/resource.h>
232 #include "m17n-core.h"
233 #include "m17n-misc.h"
234 #include "internal.h"
236 static int core_initialized;
239 default_error_handler (enum MErrorCode err)
244 static struct timeval time_stack[16];
245 static int time_stack_index;
247 static int report_header_printed;
253 mdebug__report_object (char *name, M17NObjectArray *array)
255 if (! (mdebug__flag & MDEBUG_FINI))
257 if (! report_header_printed)
259 fprintf (stderr, "%16s %7s %7s %7s\n",
260 "object", "created", "freed", "alive");
261 fprintf (stderr, "%16s %7s %7s %7s\n",
262 "------", "-------", "-----", "-----");
263 report_header_printed = 1;
265 fprintf (stderr, "%16s %7d %7d %7d\n", name,
266 array->used, array->used - array->count, array->count);
270 void *(*mdatabase__finder) (MSymbol tag1, MSymbol tag2,
271 MSymbol tag3, MSymbol tag4);
272 void *(*mdatabase__loader) (void *);
281 gettimeofday (time_stack + time_stack_index++, &tz);
291 mdebug__print_time ()
297 gettimeofday (&tv, &tz);
298 diff = ((tv.tv_sec - time_stack[time_stack_index - 1].tv_sec) * 1000000
299 + (tv.tv_usec - time_stack[time_stack_index - 1].tv_usec));
300 fprintf (stderr, "%8ld ms.", diff);
301 time_stack[time_stack_index - 1] = tv;
304 #define SET_DEBUG_FLAG(env_name, mask) \
306 char *env_value = getenv (env_name); \
308 if (env_value && env_value[0] == '1') \
309 mdebug__flag |= (mask); \
316 /* The following two are actually not exposed to a user but concealed
317 by the macro M17N_INIT (). */
320 m17n_init_core (void)
322 int mdebug_mask = MDEBUG_INIT;
324 if (core_initialized)
328 m17n_memory_full_handler = default_error_handler;
331 SET_DEBUG_FLAG ("MDEBUG_INIT", MDEBUG_INIT);
332 SET_DEBUG_FLAG ("MDEBUG_FINI", MDEBUG_FINI);
333 SET_DEBUG_FLAG ("MDEBUG_CHARSET", MDEBUG_CHARSET);
334 SET_DEBUG_FLAG ("MDEBUG_CODING", MDEBUG_CODING);
335 SET_DEBUG_FLAG ("MDEBUG_DATABASE", MDEBUG_DATABASE);
336 SET_DEBUG_FLAG ("MDEBUG_FONT", MDEBUG_FONT);
337 SET_DEBUG_FLAG ("MDEBUG_FONT_FLT", MDEBUG_FONT_FLT);
338 SET_DEBUG_FLAG ("MDEBUG_FONT_OTF", MDEBUG_FONT_OTF);
339 SET_DEBUG_FLAG ("MDEBUG_INPUT", MDEBUG_INPUT);
343 if (msymbol__init () < 0)
345 MDEBUG_PRINT_TIME ("INIT", (stderr, " to initialize symbol module."));
346 if (mplist__init () < 0)
348 MDEBUG_PRINT_TIME ("INIT", (stderr, " to initialize plist module."));
349 if (mtext__init () < 0)
351 if (mtext__prop_init () < 0)
353 MDEBUG_PRINT_TIME ("INIT", (stderr, " to initialize mtext module."));
354 if (mchartable__init () < 0)
356 MDEBUG_PRINT_TIME ("INIT", (stderr, " to initialize chartable module."));
358 mdatabase__finder = NULL;
359 mdatabase__loader = NULL;
360 core_initialized = 1;
364 MDEBUG_PRINT_TIME ("INIT", (stderr, " to initialize the core modules."));
367 report_header_printed = 0;
371 m17n_fini_core (void)
373 int mdebug_mask = MDEBUG_FINI;
375 if (core_initialized)
379 MDEBUG_PRINT_TIME ("INIT", (stderr, " to finalize chartable module."));
381 MDEBUG_PRINT_TIME ("INIT", (stderr, " to finalize textprop module."));
383 MDEBUG_PRINT_TIME ("INIT", (stderr, " to finalize mtext module."));
385 MDEBUG_PRINT_TIME ("INIT", (stderr, " to finalize symbol module."));
387 MDEBUG_PRINT_TIME ("INIT", (stderr, " to finalize plist module."));
389 core_initialized = 0;
391 MDEBUG_PRINT_TIME ("INIT", (stderr, " to finalize the core modules."));
397 #endif /* !FOR_DOXYGEN || DOXYGEN_INTERNAL_MODULE */
401 @addtogroup m17nObject
402 @brief Managed objects are objects managed by the reference count.
404 There are some types of m17n objects that are managed by their
405 reference count. Those objects are called @e managed @e objects.
406 When created, the reference count of a managed object is
407 initialized to one. The m17n_object_ref () function increments
408 the reference count of a managed object by one, and the
409 m17n_object_unref () function decrements by one. A managed
410 object is automatically freed when its reference count becomes
413 A property whose key is a managing key can have only a managed
414 object as its value. Such functions as msymbol_put () and
415 mplist_put () pay special attention to such a property.
417 In addition to the predefined managed object types, users can
418 define their own managed object types. See the documentation of
419 the m17n_object () for the details. */
424 @brief Allocate a managed object.
426 The m17n_object () function allocates a new managed object of
427 $SIZE bytes and sets its reference count to 1. $FREER is the
428 function that is used to free the object when the reference count
429 becomes 0. If $FREER is NULL, the object is freed by the free ()
432 The heading bytes of the allocated object is occupied by
433 #M17NObjectHead. That area is reserved for the m17n library and
434 application programs should never touch it.
437 This function returns a newly allocated object.
440 This function never fails. */
453 free (((MYStruct *) obj)->mem2);
458 my_func (MText *mt, MSymbol key, int num, char *str)
460 MYStruct *st = m17n_object (sizeof (MYStruct), my_freer);
463 st->mem2 = strdup (str);
464 /* KEY must be a managing key. */
465 mtext_put_prop (mt, 0, mtext_len (mt), key, st);
466 /* This sets the reference count of ST back to 1. */
467 m17n_object_unref (st);
472 m17n_object (int size, void (*freer) (void *))
474 M17NObject *obj = malloc (size);
477 obj->u.freer = freer;
484 @brief Increment the reference count of a managed object.
486 The m17n_object_ref () function increments the reference count of
487 the managed object pointed to by $OBJECT.
490 This function returns the resulting reference count if it fits in
491 a 16-bit unsigned integer (i.e. less than 0x10000). Otherwise, it
495 This function never fails. */
498 m17n_object_ref (void *object)
500 M17NObject *obj = (M17NObject *) object;
501 M17NObjectRecord *record;
504 if (! obj->ref_count_extended)
506 if (++obj->ref_count)
507 return (int) obj->ref_count;
508 MSTRUCT_MALLOC (record, MERROR_OBJECT);
509 record->freer = obj->u.freer;
510 MLIST_INIT1 (record, counts, 1);
511 MLIST_APPEND1 (record, counts, 0, MERROR_OBJECT);
512 obj->u.record = record;
513 obj->ref_count_extended = 1;
516 record = obj->u.record;
518 count = record->counts;
519 while (*count == 0xFFFFFFFF)
522 if (*count == 0xFFFFFFFF)
523 MLIST_APPEND1 (record, counts, 0, MERROR_OBJECT);
530 @brief Decrement the reference count of a managed object.
532 The m17n_object_unref () function decrements the reference count
533 of the managed object pointed to by $OBJECT. When the reference
534 count becomes zero, the object is freed by its freer function.
537 This function returns the resulting reference count if it fits in
538 a 16-bit unsigned integer (i.e. less than 0x10000). Otherwise, it
539 returns -1. Thus, the return value zero means that $OBJECT is
543 This function never fails. */
546 m17n_object_unref (void *object)
548 M17NObject *obj = (M17NObject *) object;
549 M17NObjectRecord *record;
552 if (! obj->ref_count_extended)
554 if (! --obj->ref_count)
557 (obj->u.freer) (object);
562 return (int) obj->ref_count;
565 record = obj->u.record;
566 count = record->counts;
568 *(count++) = 0xFFFFFFFF;
570 if (! record->counts[0])
572 obj->ref_count_extended = 0;
574 obj->u.freer = record->freer;
575 MLIST_FREE1 (record, counts);
586 @addtogroup m17nError Error handling
587 @brief Error handling of the m17n library.
589 There are two types of errors that may happen in a function of
592 The first type is argument errors. When a library function is
593 called with invalid arguments, it returns a value that indicates
594 error and at the same time sets the external variable @e
595 merror_code to a non-zero integer.
597 The second type is memory allocation errors. When the required
598 amount of memory is not available on the system, m17n library
599 functions call a function pointed to by the external variable @c
600 m17n_memory_full_handler. The default value of the variable is a
601 pointer to the default_error_handle () function, which just calls
605 @addtogroup m17nError ¥¨¥é¡¼½èÍý
606 @brief m17n ¥é¥¤¥Ö¥é¥ê¤Î¥¨¥é¡¼½èÍý
608 m17n ¥é¥¤¥Ö¥é¥ê¤Î´Ø¿ô¤Ç¤Ï¡¢£²¤Ä¤Î¼ïÎà¤Î¥¨¥é¡¼¤¬µ¯¤³¤êÆÀ¤ë¡£
610 °ì¤Ä¤Ï°ú¿ô¤Î¥¨¥é¡¼¤Ç¤¢¤ë¡£¥é¥¤¥Ö¥é¥ê¤Î´Ø¿ô¤¬ÂÅÅö¤Ç¤Ê¤¤°ú¿ô¤È¤È¤â¤Ë
611 ¸Æ¤Ð¤ì¤¿¾ì¹ç¡¢¤½¤Î´Ø¿ô¤Ï¥¨¥é¡¼¤ò°ÕÌ£¤¹¤ëÃͤòÊÖ¤·¡¢Æ±»þ¤Ë³°ÉôÊÑ¿ô
612 #merror_code ¤Ë¥¼¥í¤Ç¤Ê¤¤À°¿ô¤ò¥»¥Ã¥È¤¹¤ë¡£
614 ¤â¤¦°ì¤Ä¤Î¼ïÎà¤Ï¥á¥â¥ê³äÅö¤Æ¥¨¥é¡¼¤Ç¤¢¤ë¡£¥·¥¹¥Æ¥à¤¬É¬ÍפÊÎ̤Υá¥â
615 ¥ê¤ò³äÅö¤Æ¤ë¤³¤È¤¬¤Ç¤¤Ê¤¤¾ì¹ç¡¢¥é¥¤¥Ö¥é¥ê´Ø¿ô¤Ï³°ÉôÊÑ¿ô @c
616 m17n_memory_full_handler ¤¬»Ø¤¹´Ø¿ô¤ò¸Æ¤Ö¡£¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï¡¢Ã±¤Ë
617 <tt>exit ()</tt> ¤ò¸Æ¤Ö¤³¤È¤Ë¤Ê¤Ã¤Æ¤¤¤ë¡£
624 /***en @brief External variable to hold error code of the m17n library
626 The external variable #merror_code holds an error code of the
627 m17n library. When a library function is called with an invalid
628 argument, it sets this variable to one of @c enum #MErrorCode.
630 This variable initially has the value 0. */
632 /***ja @brief m17n ¥é¥¤¥Ö¥é¥ê¤Î¥¨¥é¡¼¥³¡¼¥É¤òÊÝ»ý¤¹¤ë³°ÉôÊÑ¿ô
634 ³°ÉôÊÑ¿ô #merror_code ¤Ï¡¢m17n ¥é¥¤¥Ö¥é¥ê¤Î¥¨¥é¡¼¥³¡¼¥É¤òÊÝ»ý¤¹¤ë¡£
635 ¥é¥¤¥Ö¥é¥ê´Ø¿ô¤¬ÂÅÅö¤Ç¤Ê¤¤°ú¿ô¤È¤È¤â¤Ë¸Æ¤Ð¤ì¤¿ºÝ¤Ë¤Ï¡¢
636 ¤³¤ÎÊÑ¿ô¤ò @c enum #MErrorCode ¤Î°ì¤Ä¤Ë¥»¥Ã¥È¤¹¤ë¡£
638 ¤³¤ÎÊÑ¿ô¤Î½é´üÃͤϣ°¤Ç¤¢¤ë¡£ */
640 enum MErrorCode merror_code;
644 /***en @brief Memory allocation error handler
646 The external variable #m17n_memory_full_handler holds a pointer
647 to the function to call when a library function failed to allocate
648 memory. $ERR is one of @c enum #MErrorCode indicating in which
649 function the error occurred.
651 This variable initially points a function that simply calls the
652 exit () function with $ERR as an argument.
654 An application program that needs a different error handling can
655 change this variable to point a proper function. */
657 /***ja @brief ¥á¥â¥ê³äÅö¤Æ¥¨¥é¡¼¥Ï¥ó¥É¥é
659 ÊÑ¿ô #m17n_memory_full_handler ¤Ï¡¢¥é¥¤¥Ö¥é¥ê´Ø¿ô¤¬¥á¥â¥ê³äÅö¤Æ
660 ¤Ë¼ºÇÔ¤·¤¿ºÝ¤Ë¸Æ¤Ö¤Ù¤´Ø¿ô¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤¢¤ë¡£$ERR ¤Ï @c enum
661 #MErrorCode ¤Î¤¤¤º¤ì¤«¤Ç¤¢¤ê¡¢¤É¤Î¥é¥¤¥Ö¥é¥ê´Ø¿ô¤Ç¥¨¥é¡¼¤¬µ¯¤Ã¤¿
666 ½é´üÀßÄê¤Ç¤Ï¡¢¤³¤ÎÊÑ¿ô¤Ïñ¤Ë <tt>exit ()</tt> ¤ò $ERR ¤ò°ú¿ô¤È¤·¤Æ
667 ¸Æ¤Ö´Ø¿ô¤ò»Ø¤·¤Æ¤¤¤ë¡£
669 ¤³¤ì¤È¤Ï°Û¤Ê¤ë¥¨¥é¡¼½èÍý¤òɬÍפȤ¹¤ë¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ï¡¢¤³¤ÎÊÑ¿ô¤ò
670 ŬÅö¤Ê´Ø¿ô¤ËÀßÄꤹ¤ë¤³¤È¤Ç¡¢ÌÜŪ¤òãÀ®¤Ç¤¤ë¡£ */
672 void (*m17n_memory_full_handler) (enum MErrorCode err);
679 @addtogroup m17nDebug
680 @brief Support for m17n library users to debug their programs.
682 The m17n library provides the following facilities to support the
683 library users to debug their programs.
687 <li> Environment variables to control printing of various
692 <li> MDEBUG_INIT -- If set to 1, print information about the
693 library initialization on the call of M17N_INIT ().
695 <li> MDEBUG_FINI -- If set to 1, print counts of objects that are
696 not yet freed on the call of M17N_FINI ().
698 <li> MDEBUG_CHARSET -- If set to 1, print information about
699 charsets being loaded from the m17n database.
701 <li> MDEBUG_CODING -- If set to 1, print information about coding
702 systems being loaded from the m17n database.
704 <li> MDEBUG_DATABASE -- If set to 1, print information about
705 data being loaded from the m17n database.
707 <li> MDEBUG_FONT -- If set to 1, print information about fonts
708 being selected and opened.
710 <li> MDEBUG_FONT_FLT -- If set to 1, print information about which
711 command of Font Layout Table are being executed.
713 <li> MDEBUG_FONT_OTF -- If set to 1, print information about which
714 feature of OpenType Layout Table are being executed.
716 <li> MDEBUG_INPUT -- If set to 1, print information about how an
717 input method is running.
719 <li> MDEBUG_ALL -- Setting this variable to 1 is equivalent to
720 setting all the above variables to 1.
724 <li> Functions to print various objects in a human readable way.
725 See the documentation of mdebug_dump_XXXX () functions.
727 <li> The hook function called on an error. See the documentation
738 @brief Hook function called on an error.
740 The mdebug_hook () function is called when an error happens. It
741 returns -1q without doing anything. It is useful to set a break
742 point on this function in a debugger. */