/* Fundamental definitions for XEmacs Lisp interpreter.
   Copyright (C) 1985-1987, 1992-1995 Free Software Foundation, Inc.
   Copyright (C) 1993-1996 Richard Mlynarik.
   Copyright (C) 1995, 1996, 2000-2005, 2009, 2010 Ben Wing.

This file is part of XEmacs.

XEmacs 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 3 of the License, or (at your
option) any later version.

XEmacs 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 XEmacs.  If not, see <http://www.gnu.org/licenses/>. */

/* Synched up with: FSF 19.30. */

#ifndef INCLUDED_lisp_h_
#define INCLUDED_lisp_h_

/* Authorship:

   Based on code from pre-release FSF 19, c. 1991.
   Various changes by Jamie Zawinski 1991-1994:
     converting to ANSI C, splitting out function prototypes to a separate
     file (later moved back for unknown reasons by Steve Baur?), debug-gcpro
     stuff (now moribund).
   ANSI-fication of DEFUN macros by Felix Lee, c. 1992?
   NOT_REACHED, DOESNT_RETURN, PRINTF_ARGS by Richard Mlynarik, c. 1994.
   Many changes over the years corresponding to Lisp_Object definition
     changes, esp. by Richard Mlynarik (c. 1993) and Kyle Jones (c. 1998).
     See alloc.c for more details.
   Overhauled and reordered by Ben Wing, 1995-1996, and many things added:
     Dynarrs, REALLOC macros, asserts, typedefs, inline header code,
     first LIST_LOOP macros, CONCHECK_*, all error-checking code
     (e.g. error-checking versions of XFOO macros), structure read syntax,
     weak lists, lcrecord lists, reworking of quit handling, object hashing,
     nested GCPRO, character objects and Ebola checking, memory usage stats,
     others.
   LOADHIST changes from Steve Baur, c. 1997?
   Various macro-related changes by Martin Buchholz, 1998-1999:
     LIST_LOOP macros greatly expanded and tortoise-hared;
     RETURN_SANS_WARNINGS; reworked DEFUN macros; EXFUN macros (???).
   Various macro-related changes by Jerry James, 2003:
     MODULE_API introduced;
     Compiler-specific definitions modernized and moved to compiler.h.
*/

/* Conventions in comments:

   "Mule-izing" is the process of going through a file and eliminating
   assumptions that the internal format (Ibyte * text) is the same as the
   external format used by library routines.  Mule-ization should also
   include replacing *ALL* raw references to `char' or `unsigned char' with
   one of the self-documenting types created below.  How exactly to do the
   conversion, and how to write correctly Mule-ized code, is described in
   the internals manual.  Files that say "This file is Mule-ized" have
   been reviewed at some point; that's not to say that incorrect code hasn't
   crept in, though.

   "Unicode-splitting" is the process of fixing a file so that it will
   handle external text in Unicode under Microsoft Windows, as appropriate.
   ("splitting" because it needs to handle either Unicode or variable-width
   multibyte depending on the OS -- NT or 9x).  See intl-win32.c.

   #### is a way of marking problems of any sort.

   !!#### marks places that are not properly Mule-ized.

   &&#### marks places that need to be fixed in order for the "8-bit mule"
   conversion to work correctly, i.e. in order to support multiple different
   buffer formats under Mule, including a fixed 8-bit format.

   ^^#### marks places that need to be fixed in order to eliminate the
   assumption that Ibyte * text is composed of 1-byte units (e.g. UTF-16
   is composed of 2-byte units and might be a possible format to consider
   for Ibyte * text).

   %%#### marks places that need work for KKCC (the new garbage collector).

   @@#### marks places that need work to get Unicode-internal working,
   i.e. using UTF-8 as the internal text format.

   #### BILL! marks places that need work for GTK.

   #### GEOM! marks places needing work to fix various bugs in the handling
        of window and frame sizing and positioning.  Often the root of the
        problems is that the code was originally written before there was a
	gutter and then not completely fixed up to accommodate the gutter.

   */

/************************************************************************/
/*                            include files                             */
/************************************************************************/

/* We include the following generally useful header files so that you
   don't have to worry about prototypes when using the standard C
   library functions and macros.  These files shouldn't be excessively
   large so they shouldn't cause that much of a slowdown. */

#include <stdlib.h>
/* Evil, but ...  -Wshadow is genuinely useful but also leads to spurious
   warnings when you have a local var named `index'.  Avoid this by
   hacking around it. */
#define index old_index
#include <string.h>		/* primarily for memcpy, etc. */
#undef index
#include <stdio.h>		/* NULL, etc. */
#include <ctype.h>
#include <stdarg.h>
#include <stddef.h>		/* offsetof */
#include <sys/types.h>
#include <limits.h>
#include <math.h>
#ifdef __cplusplus
#include <limits>		/* necessary for max()/min() under G++ 4 */
#endif

/************************************************************************/
/*                            error checking                            */
/************************************************************************/

/* ------------------------- large categories ------------------------- */

/* How these work:

   The most common classes will be `text' and `type', followed by `structure'.
   `text' is for problems related to bad textual format.  `type' is for
   problems related to wrongly typed arguments, structure fields, etc.
   `structure' is for bad data inside of a structure.  Sometimes these are
   used "incorrectly", e.g. `type' is often used for structure-checking.
   Consider `text':

   `text_checking_assert() will assert() only when ERROR_CHECK_TEXT is defined;
   otherwise it's a no-op.  text_checking_assert_at_line() is similar, but
   allows you to override the file name and line number normally supplied in
   the message.  This is especially useful in inline header functions, and
   so there's a special inline_text_checking_assert() for this; this works
   like text_checking_assert() but supplies the file and line of the calling
   function.  In order for this to work, you need to declare your inline
   function with INLINE_TEXT_CHECK_ARGS at the end of its argument list,
   and give its function name a _1 extension or similar.  Then create a
   macro that calls your inline function and includes INLINE_TEXT_CHECK_CALL
   at the end of the parameter list.  This will arrange to pass in and receive
   the file and line (__FILE__, __LINE__) at place where the call occurs in
   the calling function; but nothing will get passed in when ERROR_CHECK_TEXT
   is not defined.

   Currently the full bevy of *foo_checking_assert* macros are defined only
   for `text' and `types'; for others, only the basic foo_checking_assert()
   macro is defined.  Writing out all the variations for all possible error
   categories would produce too much clutter.  If any of these become
   needed, they can always be defined. */

   /* #### I suggest revamping these and making proper use of the
      category/subcategory system.  Here is one proposal:

	Major category 	Minor categories
	--------------------------------
	Allocation
			Malloc
			Dynarr

	Display
			Extents
			Glyphs
			Redisplay

	Execution
			Byte-Code
			Catch
			Garbage Collection
			Trapping-Problems

	Lisp Objects
			Buffers
			Char Tables
			Events
			Lstreams
			Hash Tables
			Range Tables

	Types
			Lrecord Types
			Subtypes

	Text
			Byte Positions
			Conversion
			Eistrings
			Itext
			Lisp Strings

    --ben
*/


#define INLINE_ERROR_CHECK_ARGS , const char *__file__, int __line__
#define INLINE_ERROR_CHECK_CALL , __FILE__, __LINE__
#define DISABLED_INLINE_ERROR_CHECK_ARGS
#define DISABLED_INLINE_ERROR_CHECK_CALL

/* For assertions in inline header functions which will report the file and
   line of the calling function */
#define inline_assert(assertion) assert_at_line (assertion, __file__, __line__)
/* The following should not use disabled_assert_at_line() because when the
   inline assert is disabled, params __file__ and __line__ do not exist. */
#define disabled_inline_assert(assertion) disabled_assert (assertion)

/* ------- the specific categories -------- */

#if defined (ERROR_CHECK_BYTE_CODE) || defined (ERROR_CHECK_DISPLAY) || defined (ERROR_CHECK_EXTENTS) || defined (ERROR_CHECK_GC) || defined (ERROR_CHECK_GLYPHS) || defined (ERROR_CHECK_MALLOC) || defined (ERROR_CHECK_STRUCTURES) || defined (ERROR_CHECK_TEXT) || defined (ERROR_CHECK_TYPES)
#define ERROR_CHECK_ANY
#endif

/* KEEP THESE SORTED! */

#ifdef ERROR_CHECK_BYTE_CODE
#define byte_code_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_BYTE_CODE */
#define byte_code_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_BYTE_CODE */

#ifdef ERROR_CHECK_DISPLAY
#define display_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_DISPLAY */
#define display_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_DISPLAY */

#ifdef ERROR_CHECK_EXTENTS
#define extent_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_EXTENTS */
#define extent_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_EXTENTS */

#ifdef ERROR_CHECK_GC
#define gc_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_GC */
#define gc_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_GC */

#ifdef ERROR_CHECK_GLYPHS
#define glyph_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_GLYPHS */
#define glyph_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_GLYPHS */

#ifdef ERROR_CHECK_MALLOC
#define malloc_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_MALLOC */
#define malloc_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_MALLOC */

#ifdef ERROR_CHECK_STRUCTURES
#define structure_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_STRUCTURES */
#define structure_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_STRUCTURES */

#ifdef ERROR_CHECK_TEXT
#define text_checking_assert(assertion) assert (assertion)
#define text_checking_assert_at_line(assertion, file, line) \
  assert_at_line (assertion, file, line)
#define inline_text_checking_assert(assertion) inline_assert (assertion)
#define INLINE_TEXT_CHECK_ARGS INLINE_ERROR_CHECK_ARGS
#define INLINE_TEXT_CHECK_CALL INLINE_ERROR_CHECK_CALL
#define text_checking_assert_with_message(assertion, msg) \
  assert_with_message (assertion, msg)
#else /* not ERROR_CHECK_TEXT */
#define text_checking_assert(assertion) disabled_assert (assertion)
#define text_checking_assert_at_line(assertion, file, line) \
  disabled_assert_at_line (assertion, file, line)
#define inline_text_checking_assert(assertion) \
  disabled_inline_assert (assertion)
#define INLINE_TEXT_CHECK_ARGS DISABLED_INLINE_ERROR_CHECK_ARGS
#define INLINE_TEXT_CHECK_CALL DISABLED_INLINE_ERROR_CHECK_CALL
#define text_checking_assert_with_message(assertion, msg) \
  disabled_assert_with_message (assertion, msg)
#endif /* ERROR_CHECK_TEXT */

#ifdef ERROR_CHECK_TYPES
#define type_checking_assert(assertion) assert (assertion)
#define type_checking_assert_at_line(assertion, file, line) \
  assert_at_line (assertion, file, line)
#define inline_type_checking_assert(assertion) inline_assert (assertion)
#define INLINE_TYPE_CHECK_ARGS INLINE_ERROR_CHECK_ARGS
#define INLINE_TYPE_CHECK_CALL INLINE_ERROR_CHECK_CALL
#define type_checking_assert_with_message(assertion, msg) \
  assert_with_message (assertion, msg)
#else /* not ERROR_CHECK_TYPES */
#define type_checking_assert(assertion) disabled_assert (assertion)
#define type_checking_assert_at_line(assertion, file, line) \
  disabled_assert_at_line (assertion, file, line)
#define inline_type_checking_assert(assertion) \
  disabled_inline_assert (assertion)
#define INLINE_TYPE_CHECK_ARGS DISABLED_INLINE_ERROR_CHECK_ARGS
#define INLINE_TYPE_CHECK_CALL DISABLED_INLINE_ERROR_CHECK_CALL
#define type_checking_assert_with_message(assertion, msg) \
  disabled_assert_with_message (assertion, msg)
#endif /* ERROR_CHECK_TYPES */

/* ------------------------- small categories ------------------------- */

/* The large categories established by configure can be subdivided into
   smaller subcategories, for problems in specific modules.  You can't
   control this using configure, but you can manually stick in a define as
   necessary.

   The idea is to go ahead and create a new type of error-checking and
   have it turned on if the larger category it is a part of is also
   turned on.  For example, ERROR_CHECK_DYNARR is considered a subcategory
   of ERROR_CHECK_STRUCTURES.

   We also define foo_checking_assert() macros for convenience, but
   generally don't define the many variations of this macro as for the
   major types above, because it produces too much clutter.  If any of
   these become needed, they can always be defined. */

#ifdef ERROR_CHECK_STRUCTURES
/* Check for problems with the catch list and specbind stack */
#define ERROR_CHECK_CATCH
/* Check for incoherent dynarr structures, attempts to access Dynarr
   positions out of range, reentrant use of dynarrs through dynarr locking,
   etc. */
#define ERROR_CHECK_DYNARR
/* Check for insufficient use of call_trapping_problems(), particularly
   due to glyph-related changes causing eval or QUIT within redisplay */
#define ERROR_CHECK_TRAPPING_PROBLEMS
#endif /* ERROR_CHECK_STRUCTURES */

#ifdef ERROR_CHECK_CATCH
#define catch_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_CATCH */
#define catch_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_CATCH */

#ifdef ERROR_CHECK_DYNARR
#define dynarr_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_DYNARR */
#define dynarr_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_DYNARR */

#ifdef ERROR_CHECK_TRAPPING_PROBLEMS
#define trapping_problems_checking_assert(assertion) assert (assertion)
#else /* not ERROR_CHECK_TRAPPING_PROBLEMS */
#define trapping_problems_checking_assert(assertion) disabled_assert (assertion)
#endif /* ERROR_CHECK_TRAPPING_PROBLEMS */

/************************************************************************/
/**                     Definitions of basic types                     **/
/************************************************************************/

/* ------------- generic 8/16/32/64/128-bit integral types ------------ */

#if SIZEOF_SHORT == 2
#define INT_16_BIT short
#define UINT_16_BIT unsigned short
#elif SIZEOF_INT == 2
/* Bwa ha ha.  As if XEmacs could actually support such systems. */
#define INT_16_BIT int
#define UINT_16_BIT unsigned int
#else
#error Unable to find a 16-bit integral type
#endif

#if SIZEOF_INT == 4
#define INT_32_BIT int
#define UINT_32_BIT unsigned int
#define MAKE_32_BIT_UNSIGNED_CONSTANT(num) num##U
#elif SIZEOF_LONG == 4
/* Bwa ha ha again. */
#define INT_32_BIT long
#define UINT_32_BIT unsigned long
#define MAKE_32_BIT_UNSIGNED_CONSTANT(num) num##UL
#elif SIZEOF_SHORT == 4
/* And again. */
#define INT_32_BIT short
#define UINT_32_BIT unsigned short
#define MAKE_32_BIT_UNSIGNED_CONSTANT(num) num##U
#elif 1 /* Unable to find a 32-bit integral type! */
#error What kind of strange-ass system are you running on?
#endif

#if SIZEOF_LONG == 8
#define INT_64_BIT long
#define UINT_64_BIT unsigned long
#define MAKE_64_BIT_UNSIGNED_CONSTANT(num) num##UL
#elif SIZEOF_LONG_LONG == 8
#define INT_64_BIT long long
#define UINT_64_BIT unsigned long long
#define MAKE_64_BIT_UNSIGNED_CONSTANT(num) num##ULL
#elif defined(WIN32_ANY)
#define INT_64_BIT __int64
#define UINT_64_BIT unsigned __int64
#define MAKE_64_BIT_UNSIGNED_CONSTANT(num) num##UI64
/* No error otherwise; just leave undefined */
#endif

#if SIZEOF_LONG_LONG == 16
#define INT_128_BIT long long
#define UINT_128_BIT unsigned long long
#define MAKE_128_BIT_UNSIGNED_CONSTANT(num) num##ULL
/* No error otherwise; just leave undefined */
#endif

/* #### Fill this in for other systems */
#if defined (INT_64_BIT) && !(defined (i386) || defined (__i386__))
#define EFFICIENT_INT_64_BIT INT_64_BIT
#define EFFICIENT_UINT_64_BIT UINT_64_BIT
#endif

#if defined (INT_128_BIT)
#define EFFICIENT_INT_128_BIT INT_128_BIT
#define EFFICIENT_UINT_128_BIT UINT_128_BIT
#endif

/* These are easily computable using `dc'.
   (Just in case you cared, the maximum 256-bit unsigned int is
   115792089237316195423570985008687907853269984665640564039457584007913 \
   129639935.  You can get this with

   echo '2 256^ 1-p' | dc
   )
*/

#define INT_16_BIT_MAX 32767
#define INT_32_BIT_MAX 2147483647
#define INT_64_BIT_MAX 9223372036854775807
#define INT_128_BIT_MAX 170141183460469231731687303715884105727

#define UINT_16_BIT_MAX 65535
#define UINT_32_BIT_MAX 4294967295
#define UINT_64_BIT_MAX 18446744073709551615
#define UINT_128_BIT_MAX 340282366920938463463374607431768211455

#define INT_16_BIT_MIN -32768
#define INT_32_BIT_MIN -2147483648
#define INT_64_BIT_MIN -9223372036854775808
#define INT_128_BIT_MIN -170141183460469231731687303715884105728

#if SIZEOF_VOID_P == 8
#define DEADBEEF_CONSTANT 0xCAFEBABEDEADBEEF
#elif SIZEOF_VOID_P == 4
#define DEADBEEF_CONSTANT 0xDEADBEEF
#else
#error "What size are your pointers, really?"
#endif /* SIZEOF_VOID_P == 8 */

/* ---------------------- definition of EMACS_INT --------------------- */

/* EMACS_INT is the underlying integral type into which a Lisp_Object must fit.
   In particular, it must be large enough to contain a pointer.
   config.h can override this, e.g. to use `long long' for bigger lisp ints.

   #### In point of fact, it would NOT be a good idea for config.h to mess
   with EMACS_INT.  A lot of code makes the basic assumption that EMACS_INT
   is the size of a pointer. */

#ifndef SIZEOF_EMACS_INT
# define SIZEOF_EMACS_INT SIZEOF_VOID_P
#endif

#ifndef EMACS_INT
# if   SIZEOF_EMACS_INT == SIZEOF_LONG
#  define EMACS_INT long
# elif SIZEOF_EMACS_INT == SIZEOF_INT
#  define EMACS_INT int
# elif SIZEOF_EMACS_INT == SIZEOF_LONG_LONG
#  define EMACS_INT long long
# else
#  error Unable to determine suitable type for EMACS_INT
# endif
#endif

#ifndef EMACS_UINT
# define EMACS_UINT unsigned EMACS_INT
#endif

#define BITS_PER_EMACS_INT (SIZEOF_EMACS_INT * BITS_PER_CHAR)

/* Make a version of abs() available appropriate for an EMACS_INT. */
#if   SIZEOF_EMACS_INT == SIZEOF_INT
# define EMACS_INT_ABS abs
#elif SIZEOF_EMACS_INT == SIZEOF_LONG
# define EMACS_INT_ABS labs
#elif SIZEOF_EMACS_INT == SIZEOF_LONG_LONG
# define EMACS_INT_ABS llabs
#endif

/* -------------------------- basic byte typedefs --------------------- */

/* The definitions we put here and in the next section use typedefs to
   attribute specific meaning to types that by themselves are pretty
   general.

   REMEMBER!  These typedefs are purely for documentation purposes; from
   the C code's perspective, they are exactly equivalent to `char *',
   `unsigned char *', etc., so you can freely use them with library
   functions declared as such.

   (See also "Byte/Character Types" in text.c)
 
   The basic semantics for `char':

   a) [Ibyte] pointer to internally-formatted text
   b) [Extbyte] pointer to text in some external format, which can be
                defined as all formats other than the internal one
   c) [Ascbyte] pure ASCII text
   d) [Binbyte] binary data that is not meant to be interpreted as text
   e) [Rawbyte] general data in memory, where we don't care about whether
                it's text or binary; often used when computing memory-
                based/byte-based offsets of pointers
   f) [Boolbyte] a zero or a one
   g) [Bitbyte] a byte used for bit fields
   h) [Chbyte] null-semantics `char *'; used when casting an argument to
               an external API where the the other types may not be
               appropriate


   Prefixing codes:

   C = plain char, when the base type is unsigned
   U = unsigned
   S = signed

   Ideally, XEmacs code should NEVER directly use `char' or any type
   derived from it.  This is for Mule-cleanliness.  If you find yourself
   wanting or needing to use `char' and one of the above six semantics does
   not apply, add a new type of semantics; don't use `char' directly.

   See text.c under "Byte Types", and following sections.
*/

/* The data representing the text in a buffer is logically a set
   of Ibytes, declared as follows. */

typedef unsigned char Ibyte;

/* The following should be used when you are working with internal data
   but for whatever reason need to have it declared a "char *".  Examples
   are function arguments whose values are most commonly literal strings,
   or where you have to apply a stdlib string function to internal data.

   In general, you should avoid this where possible and use Ascbyte if the
   text is just ASCII (e.g. string literals) or otherwise Ibyte, for
   consistency.  For example, the new Mule workspace contains Ibyte
   versions of the stdlib string functions. */

typedef char CIbyte;

/* The data representing a string in "external" format (binary or any
   external encoding) is logically a set of Extbytes, declared as
   follows.  Extbyte is guaranteed to be just a char, so for example
   strlen (Extbyte *) is OK.  Extbyte is only a documentation device
   for referring to external text. */

typedef char Extbyte;
typedef unsigned char UExtbyte;

#define EXTTEXT_ZTERM_SIZE (sizeof (Extbyte))

/* A byte in a string in entirely US-ASCII format: (Nothing outside
 the range 00 - 7F) */

typedef char Ascbyte;
typedef unsigned char UAscbyte;

/* A generic memory pointer, no text or binary semantics assumed.
   In general, there should be no manipulation of the memory pointed to
   by these pointers other than just copying it around. */

typedef unsigned char Rawbyte;
typedef char CRawbyte;

/* A byte in a string in binary (not meant as text) format: */

typedef unsigned char Binbyte;
typedef char CBinbyte;
typedef signed char SBinbyte;

/* A byte used to represent a boolean value: 0 or 1.
   Normally use plain Boolint, and only use Boolbyte to save space. */

typedef char Boolbyte;

/* A byte composed of bitfields.  Hardly ever used. */

typedef unsigned char Bitbyte;

/* A no-semantics `char'.  Used (pretty-much) ONLY for casting arguments to
   functions accepting a `char *', `unsigned char *', etc. where the other
   types don't exactly apply and what you are logically concerned with is
   the type of the function's argument and not its semantics.

   DO NOT DO NOT DO NOT DO NOT use this as a sloppy replacement for one of
   the other types.  If you're not using this as part of casting an
   argument to a function call, and you're not Ben Wing, you're using it
   wrong.  Go find another one of the types. */

typedef char Chbyte;
typedef unsigned char UChbyte;
typedef signed char SChbyte;

/* ------------------------ other text-related typedefs ------------------- */

/* To the user, a buffer is made up of characters.  In the non-Mule world,
   characters and Ibytes are equivalent, restricted to the range 0 - 255.
   In the Mule world, many more characters are possible (21 bits worth,
   more or less), and a character requires (typically) 1 to 4 Ibytes for
   its representation in a buffer or string.  Note that the representation
   of a character by itself, in a variable, is very different from its
   representation in a string of text (in a buffer or Lisp string).

   Under Mule, text can be represented in more than one way.  The "default"
   format is variable-width (1 to 4 bytes) and compatible with ASCII --
   ASCII chars are stored in one byte, as themselves, and all other chars
   use only high bytes.  The default format is currently the only format
   used for text stored anywhere but in a buffer.  In a buffer, other
   formats -- fixed-width formats (1, 2, or 4 bytes) -- are possible, for
   speed.

   See text.c/text.h for a detailed discussion of all of this. */

/* A character, as represented on its own. */

typedef int Ichar;

/* The "raw value" of a character as stored in the buffer.  In the default
   format, this is just the same as the character.  In fixed-width formats,
   this is the actual value in the buffer, which will be limited to the
   range as established by the format.  This is used when searching for a
   character in a buffer -- it's faster to convert the character to the raw
   value and look for that, than repeatedly convert each raw value in the
   buffer into a character. */

typedef int Raw_Ichar;

/* Internal text as a series of textual units (8-bit bytes in the old
   "Mule" encoding -- still the standard internal encoding -- and in UTF-8,
   but 16-bit bytes in UTF-16 and 32-bit bytes in UTF-32).  See text.c. */

#ifdef UTF16_IBYTE_FORMAT
#define NON_ASCII_INTERNAL_FORMAT
typedef unsigned short Itext;
#else
typedef Ibyte Itext;
#endif
typedef EMACS_INT Textcount;

#define ITEXT_SIZE (sizeof (Itext))
/* Use this to emphasize that we are adding space for the zero-terminator */
#define ITEXT_ZTERM_SIZE ITEXT_SIZE

/* Wexttext is wchar_t on WIN32_NATIVE (and perhaps other systems that
   support wchar_t's in library functions), and Extbyte otherwise.  This is
   used whenever we have to do any sort of manipulation of
   externally-encoded strings -- generally a very bad idea, and unsafe, but
   in some cases we have no choice (especially at startup, and esp. prior
   to pdump, where we haven't loaded the Unicode tables necessary for
   conversion under Windows).  On platforms where the external encoding may
   be Unicode (i.e. Windows), we always do our manipulations in Unicode,
   converting to and from multibyte if necessary -- otherwise we'd have to
   conditionalize on Unicode vs. multibyte all over the place, which is
   just a nightmare. */
#ifdef WIN32_NATIVE
#define WEXTTEXT_IS_WIDE
typedef wchar_t Wexttext;
#else
typedef Extbyte Wexttext;
#endif

#if !defined (__cplusplus) || !defined (CPLUSPLUS_INTEGRAL_CLASSES_NOT_YET)

/* Counts of bytes or chars */

typedef EMACS_INT Bytecount;
typedef EMACS_INT Charcount;

/* Different ways of referring to a position in a buffer.  We use
   the typedefs in preference to 'EMACS_INT' to make it clearer what
   sort of position is being used.  See text.c for a description
   of the different positions.

   Note that buffer positions are 1-based, and there's a gap in the middle
   of a buffer; that's why we have separate typedefs.  For Lisp strings and
   other strings of text, we just use Bytecount and Charcount. */

typedef EMACS_INT Charbpos;
typedef EMACS_INT Bytebpos;
typedef EMACS_INT Membpos;

/* Different ways of referring to a position that can be either in a buffer
   or string; used when passing around an object that can be either a
   buffer or string, and an associated position.  Conceptually, they
   resolve as follows:

   Typedef		Buffer			String
   ------------------------------------------------------
   Charxpos		Charbpos		Charcount
   Bytexpos		Bytebpos		Bytecount
   Memxpos		Membpos			Bytecount
   
   */

typedef EMACS_INT Charxpos;
typedef EMACS_INT Bytexpos;
typedef EMACS_INT Memxpos;

#else /* __cplusplus */

/* Implement strong type-checking of the above integral types by declaring
   them to be classes and using operator overloading.  Unfortunately this
   is a huge pain in the ass because C++ doesn't strongly distinguish
   "bool" and "size_t" from int.  The problem is especially bad with "bool"
   -- if you want to be able to say `if (len--)' where len is e.g. a
   Bytecount, you need to declare a conversion operator to bool(); and
   since bool is just an alias for int, you suddenly get tons and tons of
   ambiguities, which need to be resolved by lots of laborious declarations
   for every single possible type combination.  Hence the multitude of
   declarations in DECLARE_INTCLASS_ARITH_COMPARE().  The bool/int
   equivalence also means that we have to forcibly block the combinations
   we don't want by creating overloaded versions of them and declaring them
   private. */
   
class Bytecount;
class Bytebpos;
class Bytexpos;
class Charcount;
class Charbpos;
class Charxpos;
class Membpos;
class Memxpos;

/* Declare the arithmetic and comparison operations for an integral class,
   i.e. one of the above classes.  If this is a "position" class, where the
   difference between two positions is a different class (a "count" class),
   then use POSCL for the position class and COUNTCL for the count class.
   If this is a simple class, where all operations yield the same class,
   substitute the same class for POSCL and COUNTCL. */

#define DECLARE_INTCLASS_ARITH_COMPARE(poscl, countcl)			      \
  poscl operator += (const countcl& l) { data += l.data; return *this; }      \
  poscl operator -= (const countcl& l) { data -= l.data; return *this; }      \
  poscl operator + (const countcl& l) const { return poscl (data + l.data); } \
  poscl operator - (const countcl& l) const { return poscl (data - l.data); } \
  poscl operator += (const int& l) { data += l; return *this; }		      \
  poscl operator -= (const int& l) { data -= l; return *this; }		      \
  poscl operator + (const int& l) const { return poscl (data + l); }	      \
  poscl operator - (const int& l) const { return poscl (data - l); }	      \
  poscl operator += (const unsigned int& l) { data += l; return *this; }      \
  poscl operator -= (const unsigned int& l) { data -= l; return *this; }      \
  poscl operator + (const unsigned int& l) const			      \
    { return poscl (data + l); }					      \
  poscl operator - (const unsigned int& l) const			      \
    { return poscl (data - l); }					      \
  poscl operator += (const long& l) { data += l; return *this; }	      \
  poscl operator -= (const long& l) { data -= l; return *this; }	      \
  poscl operator + (const long& l) const { return poscl (data + l); }	      \
  poscl operator - (const long& l) const { return poscl (data - l); }	      \
  poscl operator += (const unsigned long& l) { data += l; return *this; }     \
  poscl operator -= (const unsigned long& l) { data -= l; return *this; }     \
  poscl operator + (const unsigned long& l) const			      \
    { return poscl (data + l); }					      \
  poscl operator - (const unsigned long& l) const			      \
    { return poscl (data - l); }					      \
  poscl operator += (const short& l) { data += l; return *this; }	      \
  poscl operator -= (const short& l) { data -= l; return *this; }	      \
  poscl operator + (const short& l) const { return poscl (data + l); }	      \
  poscl operator - (const short& l) const { return poscl (data - l); }	      \
  poscl operator += (const unsigned short& l) { data += l; return *this; }    \
  poscl operator -= (const unsigned short& l) { data -= l; return *this; }    \
  poscl operator + (const unsigned short& l) const			      \
    { return poscl (data + l); }					      \
  poscl operator - (const unsigned short& l) const			      \
    { return poscl (data - l); }					      \
									      \
  poscl operator *= (const countcl& l) { data *= l.data; return *this; }      \
  poscl operator /= (const countcl& l) { data /= l.data; return *this; }      \
  poscl operator * (const countcl& l) const { return poscl (data * l.data); } \
  poscl operator / (const countcl& l) const { return poscl (data / l.data); } \
  poscl operator *= (const int& l) { data *= l; return *this; }		      \
  poscl operator /= (const int& l) { data /= l; return *this; }		      \
  poscl operator * (const int& l) const { return poscl (data * l); }	      \
  poscl operator / (const int& l) const { return poscl (data / l); }	      \
  poscl operator *= (const unsigned int& l) { data *= l; return *this; }      \
  poscl operator /= (const unsigned int& l) { data /= l; return *this; }      \
  poscl operator * (const unsigned int& l) const { return poscl (data * l); } \
  poscl operator / (const unsigned int& l) const { return poscl (data / l); } \
  poscl operator *= (const long& l) { data *= l; return *this; }	      \
  poscl operator /= (const long& l) { data /= l; return *this; }	      \
  poscl operator * (const long& l) const { return poscl (data * l); }	      \
  poscl operator / (const long& l) const { return poscl (data / l); }	      \
  poscl operator *= (const unsigned long& l) { data *= l; return *this; }     \
  poscl operator /= (const unsigned long& l) { data /= l; return *this; }     \
  poscl operator * (const unsigned long& l) const			      \
    { return poscl (data * l); }					      \
  poscl operator / (const unsigned long& l) const			      \
    { return poscl (data / l); }					      \
  poscl operator *= (const short& l) { data *= l; return *this; }	      \
  poscl operator /= (const short& l) { data /= l; return *this; }	      \
  poscl operator * (const short& l) const { return poscl (data * l); }	      \
  poscl operator / (const short& l) const { return poscl (data / l); }	      \
  poscl operator *= (const unsigned short& l) { data *= l; return *this; }    \
  poscl operator /= (const unsigned short& l) { data /= l; return *this; }    \
  poscl operator * (const unsigned short& l) const			      \
    { return poscl (data * l); }					      \
  poscl operator / (const unsigned short& l) const			      \
    { return poscl (data / l); }					      \
									      \
  poscl operator &= (const countcl& l) { data &= l.data; return *this; }      \
  poscl operator |= (const countcl& l) { data |= l.data; return *this; }      \
  poscl operator & (const countcl& l) const { return poscl (data & l.data); } \
  poscl operator | (const countcl& l) const { return poscl (data | l.data); } \
  poscl operator &= (const int& l) { data &= l; return *this; }		      \
  poscl operator |= (const int& l) { data |= l; return *this; }		      \
  poscl operator & (const int& l) const { return poscl (data & l); }	      \
  poscl operator | (const int& l) const { return poscl (data | l); }	      \
  poscl operator &= (const unsigned int& l) { data &= l; return *this; }      \
  poscl operator |= (const unsigned int& l) { data |= l; return *this; }      \
  poscl operator & (const unsigned int& l) const { return poscl (data & l); } \
  poscl operator | (const unsigned int& l) const { return poscl (data | l); } \
  poscl operator &= (const long& l) { data &= l; return *this; }	      \
  poscl operator |= (const long& l) { data |= l; return *this; }	      \
  poscl operator & (const long& l) const { return poscl (data & l); }	      \
  poscl operator | (const long& l) const { return poscl (data | l); }	      \
  poscl operator &= (const unsigned long& l) { data &= l; return *this; }     \
  poscl operator |= (const unsigned long& l) { data |= l; return *this; }     \
  poscl operator & (const unsigned long& l) const			      \
    { return poscl (data & l); }					      \
  poscl operator | (const unsigned long& l) const			      \
    { return poscl (data | l); }					      \
  poscl operator &= (const short& l) { data &= l; return *this; }	      \
  poscl operator |= (const short& l) { data |= l; return *this; }	      \
  poscl operator & (const short& l) const { return poscl (data & l); }	      \
  poscl operator | (const short& l) const { return poscl (data | l); }	      \
  poscl operator &= (const unsigned short& l) { data &= l; return *this; }    \
  poscl operator |= (const unsigned short& l) { data |= l; return *this; }    \
  poscl operator & (const unsigned short& l) const			      \
    { return poscl (data & l); }					      \
  poscl operator | (const unsigned short& l) const			      \
    { return poscl (data | l); }					      \
									      \
  poscl operator - ()           { return poscl (-data); }		      \
  poscl operator-- ()           { data--; return *this; }		      \
  poscl operator-- (int)	     { data--; return poscl (data + 1); }     \
  poscl operator++ ()           { data++; return *this; }		      \
  poscl operator++ (int)        { data++; return poscl (data - 1); }	      \
									      \
  bool operator < (const poscl& l) const { return data < l.data; }	      \
  bool operator <= (const poscl& l) const { return data <= l.data; }	      \
  bool operator > (const poscl& l) const { return data > l.data; }	      \
  bool operator >= (const poscl& l) const { return data >= l.data; }	      \
  bool operator == (const poscl& l) const { return data == l.data; }	      \
  bool operator != (const poscl& l) const { return data != l.data; }	      \
  bool operator < (const int& l) const { return data < (EMACS_INT) l; }	      \
  bool operator <= (const int& l) const { return data <= (EMACS_INT) l; }     \
  bool operator > (const int& l) const { return data > (EMACS_INT) l; }	      \
  bool operator >= (const int& l) const { return data >= (EMACS_INT) l; }     \
  bool operator == (const int& l) const { return data == (EMACS_INT) l; }     \
  bool operator != (const int& l) const { return data != (EMACS_INT) l; }     \
  bool operator < (const unsigned int& l) const				      \
    { return data < (EMACS_INT) l; }					      \
  bool operator <= (const unsigned int& l) const			      \
    { return data <= (EMACS_INT) l; }					      \
  bool operator > (const unsigned int& l) const				      \
    { return data > (EMACS_INT) l; }					      \
  bool operator >= (const unsigned int& l) const			      \
    { return data >= (EMACS_INT) l; }					      \
  bool operator == (const unsigned int& l) const			      \
    { return data == (EMACS_INT) l; }					      \
  bool operator != (const unsigned int& l) const			      \
    { return data != (EMACS_INT) l; }					      \
  bool operator < (const long& l) const { return data < (EMACS_INT) l; }      \
  bool operator <= (const long& l) const { return data <= (EMACS_INT) l; }    \
  bool operator > (const long& l) const { return data > (EMACS_INT) l; }      \
  bool operator >= (const long& l) const { return data >= (EMACS_INT) l; }    \
  bool operator == (const long& l) const { return data == (EMACS_INT) l; }    \
  bool operator != (const long& l) const { return data != (EMACS_INT) l; }    \
  bool operator < (const unsigned long& l) const			      \
    { return data < (EMACS_INT) l; }					      \
  bool operator <= (const unsigned long& l) const			      \
    { return data <= (EMACS_INT) l; }					      \
  bool operator > (const unsigned long& l) const			      \
    { return data > (EMACS_INT) l; }					      \
  bool operator >= (const unsigned long& l) const			      \
    { return data >= (EMACS_INT) l; }					      \
  bool operator == (const unsigned long& l) const			      \
    { return data == (EMACS_INT) l; }					      \
  bool operator != (const unsigned long& l) const			      \
    { return data != (EMACS_INT) l; }					      \
  bool operator < (const short& l) const { return data < (EMACS_INT) l; }     \
  bool operator <= (const short& l) const { return data <= (EMACS_INT) l; }   \
  bool operator > (const short& l) const { return data > (EMACS_INT) l; }     \
  bool operator >= (const short& l) const { return data >= (EMACS_INT) l; }   \
  bool operator == (const short& l) const { return data == (EMACS_INT) l; }   \
  bool operator != (const short& l) const { return data != (EMACS_INT) l; }   \
  bool operator < (const unsigned short& l) const			      \
    { return data < (EMACS_INT) l; }					      \
  bool operator <= (const unsigned short& l) const			      \
    { return data <= (EMACS_INT) l; }					      \
  bool operator > (const unsigned short& l) const			      \
    { return data > (EMACS_INT) l; }					      \
  bool operator >= (const unsigned short& l) const			      \
    { return data >= (EMACS_INT) l; }					      \
  bool operator == (const unsigned short& l) const			      \
    { return data == (EMACS_INT) l; }					      \
  bool operator != (const unsigned short& l) const			      \
    { return data != (EMACS_INT) l; }					      \
  bool operator ! () const { return !data; }

/* Declare the "bad" or disallowed arithmetic and comparion operations
   between class GOOD and class BAD.  Meant to go inside the private
   section of class GOOD. */

#define DECLARE_BAD_INTCLASS_ARITH_COMPARE(good, bad)	\
  good operator += (const bad& l) { return badret; }	\
  good operator -= (const bad& l) { return badret; }	\
  good operator *= (const bad& l) { return badret; }	\
  good operator /= (const bad& l) { return badret; }	\
  good operator + (const bad& l) { return badret; }	\
  good operator - (const bad& l) { return badret; }	\
  good operator * (const bad& l) { return badret; }	\
  good operator / (const bad& l) { return badret; }	\
							\
  bool operator < (const bad& l)  { return 0; }		\
  bool operator <= (const bad& l) { return 0; }		\
  bool operator > (const bad& l)  { return 0; }		\
  bool operator >= (const bad& l) { return 0; }		\
  bool operator == (const bad& l) { return 0; }		\
  bool operator != (const bad& l) { return 0; }

/* Declare the "bad" or disallowed arithmetic operations between class GOOD
   and another of the same class, for a position class.  Meant to go inside
   the private section of class GOOD. */

#define DECLARE_BAD_POS_CLASS_ARITH(good)		\
  good operator += (const good& l) { return badret; }	\
  good operator -= (const good& l) { return badret; }	\
  good operator *= (const good& l) { return badret; }	\
  good operator /= (const good& l) { return badret; }	\
  good operator + (const good& l) { return badret; }	\
  good operator * (const good& l) { return badret; }	\
  good operator / (const good& l) { return badret; }

/* Basic declaration at the top of all integral classes.  Don't call
   directly, use one of the more specific versions below. */

#define DECLARE_INTCLASS(cl)			\
 public:					\
  EMACS_INT data;				\
  cl () { data = 0xCDCDCDCD; }			\
  cl (int i) { data = i; }			\
  cl (unsigned int i) { data = i; }		\
  cl (long i) { data = i; }			\
  cl (unsigned long i) { data = i; }		\
  cl (short i) { data = i; }			\
  cl (unsigned short i) { data = i; }		\
  operator EMACS_INT ()  const { return data; }

/* Basic declaration at the top of all count classes. */

#define DECLARE_COUNT_CLASS(cl)				\
  DECLARE_INTCLASS (cl)					\
  DECLARE_INTCLASS_ARITH_COMPARE (cl, cl)		\
 private:						\
  static cl badret;

/* Basic declaration at the bottom of the prelude of all position classes.
   Don't call directly. */

#define DECLARE_POS_CLASS_SECOND_HALF(cl, countcl)			     \
  DECLARE_INTCLASS_ARITH_COMPARE (cl, countcl)				     \
  countcl operator - (const cl& l) const { return countcl (data - l.data); } \
 private:								     \
  static cl badret;							     \
  DECLARE_BAD_POS_INTCLASS_ARITH (cl)

/* Basic declaration at the top of all buffer position classes. */

#define DECLARE_BPOS_CLASS(cl, countcl)		\
  DECLARE_INTCLASS (cl)				\
  DECLARE_POS_CLASS_SECOND_HALF (cl, countcl)

/* Basic declaration at the top of all X-position classes (that can refer
   to buffers or strings).  CL1 and CL2 are the equivalent more specific
   classes referring only to buffers or strings, respectively. */

#define DECLARE_XPOS_CLASS(cl, countcl, cl1, cl2)	\
  DECLARE_INTCLASS (cl)					\
  cl (const cl1& x) { data = x.data; }			\
  cl (const cl2& x) { data = x.data; }			\
  operator cl1 () const { return cl1 (data); }		\
  operator cl2 () const { return cl2 (data); }		\
  DECLARE_POS_CLASS_SECOND_HALF (cl, countcl)

/* Declare the "bad" or disallowed arithmetic and comparion operations
   between class CHARCL (a character class) and various non-character
   classes.  Meant to go inside the private section of class GOOD. */

#define DECLARE_BAD_CHAR_INTCLASS_ARITH_COMPARE(charcl)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (charcl, Bytecount)	\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (charcl, Bytebpos)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (charcl, Bytexpos)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (charcl, Membpos)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (charcl, Memxpos)

/* Declare the "bad" or disallowed arithmetic and comparion operations
   between class BYTECL (a byte class) and various non-byte classes.
   Meant to go inside the private section of class GOOD. */

#define DECLARE_BAD_BYTE_INTCLASS_ARITH_COMPARE(bytecl)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Charcount)	\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Charbpos)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Charxpos)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Membpos)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Memxpos)

/* Declare the "bad" or disallowed arithmetic and comparison operations
   between class BYTECL (a mem class) and various non-mem classes.
   Meant to go inside the private section of class GOOD. */

#define DECLARE_BAD_MEM_INTCLASS_ARITH_COMPARE(bytecl)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Charcount)	\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Charbpos)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Charxpos)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Bytebpos)		\
  DECLARE_BAD_INTCLASS_ARITH_COMPARE (bytecl, Bytexpos)

class Charcount
{
  DECLARE_COUNT_CLASS (Charcount)
  DECLARE_BAD_CHAR_INTCLASS_ARITH_COMPARE (Charcount)
};

class Charbpos
{
  DECLARE_BPOS_CLASS (Charbpos, Charcount)
  DECLARE_BAD_CHAR_INTCLASS_ARITH_COMPARE (Charbpos)
};

class Charxpos
{
  DECLARE_XPOS_CLASS (Charxpos, Charcount, Charbpos, Charcount)
  DECLARE_BAD_CHAR_INTCLASS_ARITH_COMPARE (Charxpos)
};

class Bytecount
{
  DECLARE_COUNT_CLASS (Bytecount)
  DECLARE_BAD_BYTE_INTCLASS_ARITH_COMPARE (Bytecount)
};

class Bytebpos
{
  DECLARE_BPOS_CLASS (Bytebpos, Bytecount)
  DECLARE_BAD_BYTE_INTCLASS_ARITH_COMPARE (Bytebpos)
};

class Bytexpos
{
  DECLARE_XPOS_CLASS (Bytexpos, Bytecount, Bytebpos, Bytecount)
  DECLARE_BAD_BYTE_INTCLASS_ARITH_COMPARE (Bytexpos)
};

class Membpos
{
  DECLARE_BPOS_CLASS (Membpos, Bytecount)
  DECLARE_BAD_MEM_INTCLASS_ARITH_COMPARE (Membpos)
};

class Memxpos
{
  DECLARE_XPOS_CLASS (Memxpos, Bytecount, Membpos, Bytecount)
  DECLARE_BAD_MEM_INTCLASS_ARITH_COMPARE (Memxpos)
};

#define DECLARE_POINTER_TYPE_ARITH_COUNT(pointer, countcl)		\
inline pointer operator += (const pointer & x, const countcl& y)	\
{ x += y.data; return x; }						\
inline pointer operator -= (const pointer & x, const countcl& y)	\
{ x -= y.data; return x; }						\
inline pointer operator + (const pointer x, const countcl& y)		\
{ return x + y.data; }							\
inline pointer operator - (const pointer x, const countcl& y)		\
{ return x - y.data; }

#define DECLARE_INTEGRAL_TYPE_ARITH_COUNT(integral, countcl)	\
inline integral operator += (integral & x, const countcl& y)	\
{ x += y.data; return x; }					\
inline integral operator -= (integral & x, const countcl& y)	\
{ x -= y.data; return x; }					\
inline countcl operator + (integral x, const countcl& y)	\
{ return countcl (x + y.data); }				\
inline countcl operator - (integral x, const countcl& y)	\
{ return countcl (x - y.data); }

#define DECLARE_INTEGRAL_TYPE_COMPARE(integral, cl)	\
inline bool operator < (integral x, const cl& y)	\
  { return (EMACS_INT) x < y.data; }			\
inline bool operator <= (integral x, const cl& y)	\
  { return (EMACS_INT) x <= y.data; }			\
inline bool operator > (integral x, const cl& y)	\
  { return (EMACS_INT) x > y.data; }			\
inline bool operator >= (integral x, const cl& y)	\
  { return (EMACS_INT) x >= y.data; }			\
inline bool operator == (integral x, const cl& y)	\
  { return (EMACS_INT) x == y.data; }			\
inline bool operator != (integral x, const cl& y)	\
  { return (EMACS_INT) x != y.data; }

#if 0
/* Unfortunately C++ doesn't let you overload the ?: operator, so we have
   to manually deal with ambiguities using casting */
#define DECLARE_INTEGRAL_TYPE_TRISTATE(integral, cl)	\
inline cl operator ?: (bool b, integral x, const cl& y)	\
  { return b ? cl (x) : y; }				\
inline cl operator ?: (bool b, const cl& x, integral y)	\
  { return b ? x : cl (y); }
#endif /* 0 */

/* DECLARE_POINTER_TYPE_ARITH_COUNT (const Ibyte *, Bytecount);
   DECLARE_POINTER_TYPE_ARITH_COUNT (const Extbyte *, Bytecount); */
DECLARE_POINTER_TYPE_ARITH_COUNT (Ibyte *, Bytecount);
DECLARE_POINTER_TYPE_ARITH_COUNT (Extbyte *, Bytecount);

DECLARE_INTEGRAL_TYPE_ARITH_COUNT (int, Bytecount);
DECLARE_INTEGRAL_TYPE_ARITH_COUNT (int, Charcount);
DECLARE_INTEGRAL_TYPE_ARITH_COUNT (unsigned int, Bytecount);
DECLARE_INTEGRAL_TYPE_ARITH_COUNT (unsigned int, Charcount);
DECLARE_INTEGRAL_TYPE_ARITH_COUNT (long, Bytecount);
DECLARE_INTEGRAL_TYPE_ARITH_COUNT (long, Charcount);
DECLARE_INTEGRAL_TYPE_ARITH_COUNT (unsigned long, Bytecount);
DECLARE_INTEGRAL_TYPE_ARITH_COUNT (unsigned long, Charcount);

DECLARE_INTEGRAL_TYPE_COMPARE (int, Bytecount);
DECLARE_INTEGRAL_TYPE_COMPARE (int, Charcount);
DECLARE_INTEGRAL_TYPE_COMPARE (unsigned int, Bytecount);
DECLARE_INTEGRAL_TYPE_COMPARE (unsigned int, Charcount);
DECLARE_INTEGRAL_TYPE_COMPARE (long, Bytecount);
DECLARE_INTEGRAL_TYPE_COMPARE (long, Charcount);
DECLARE_INTEGRAL_TYPE_COMPARE (unsigned long, Bytecount);
DECLARE_INTEGRAL_TYPE_COMPARE (unsigned long, Charcount);

#if 0 /* doesn't work */
inline Bytecount operator - (const Ibyte *x, const Ibyte *y)	\
  { return Bytecount (x - y); }
#endif

#endif /* __cplusplus */

/* Counts of elements */
typedef EMACS_INT Elemcount;
/* Hash codes */
typedef EMACS_UINT Hashcode;
/* Booleans */
typedef int Boolint;

/* ------------------------ basic compiler defines ------------------- */

#include "compiler.h"

/* ------------------------ alignment definitions ------------------- */

#if (!defined (__STDC_VERSION__) || __STDC_VERSION__ < 201112L) && \
    (!defined (__cplusplus)						\
     || (__cplusplus < 201103L && (_MSC_VER < 1929))) &&		\
    (!defined (__CLANG_MAX_ALIGN_T_DEFINED) && !defined (_GCC_MAX_ALIGN_T))
/* No type has a greater alignment requirement than max_align_t.
   (except perhaps for types we don't use, like long double) */
typedef union
{
  struct { long l; } l;
  struct { void *p; } p;
  struct { void (*f)(void); } f;
  struct { double d; } d;
} max_align_t;
#endif

/* ALIGNOF returns the required alignment of a type -- i.e. a value such
   that data of this type must begin at a memory address which is a
   multiple of that value.  For simple types, this is often the same size
   as the type itself. */

#ifndef ALIGNOF
# if defined (__GNUC__) && (__GNUC__ >= 2)
/* gcc has an extension that gives us exactly what we want. */
#  define ALIGNOF(type) __alignof__ (type)
# elif ! defined (__cplusplus)
/* The following is mostly portable, except that:
   - it doesn't work for inside out declarations like void (*) (void).
     (so just call ALIGNOF with a typedef'ed name)
   - it doesn't work with C++.  The C++ committee has decided,
     in its infinite wisdom, that:
     "Types must be declared in declarations, not in expressions." */
#  define ALIGNOF(type) offsetof (struct { char c; type member; }, member)
# else
/* C++ is annoying, but it has a big bag of tricks.
   The following doesn't have the "inside out" declaration bug C does. */
template<typename T> struct alignment_trick { char c; T member; };
#  define ALIGNOF(type) offsetof (alignment_trick<type>, member)
# endif
#endif /* ALIGNOF */

/* ALIGN_SIZE returns the smallest size greater than or equal to LEN which
   is a multiple of UNIT.  This can be used to assure that data that
   follows a block of the returned size is of correct alignment for a type
   whose alignment (as returned by ALIGNOF) is UNIT (provided that the
   block itself is correctly aligned for this type; memory returned by
   malloc() is guaranteed to be correctly aligned for all types). */

#define ALIGN_SIZE(len, unit) \
  ((((len) + (unit) - 1) / (unit)) * (unit))

/* ALIGN_FOR_TYPE returns the smallest size greater than or equal to LEN
   which is aligned for the given type.  This can be used to assure that
   data that follows a block of the returned size is of correct alignment
   for the type (provided that the block itself is correctly aligned for
   this type; memory returned by malloc() is guaranteed to be correctly
   aligned for all types). */

#define ALIGN_FOR_TYPE(len, type) ALIGN_SIZE (len, ALIGNOF (type))

/* MAX_ALIGN_SIZE returns the smallest size greater than or equal to LEN
   which guarantees that data following a block of such size is correctly
   aligned for all types (provided that the block itself is so aligned,
   which is the case for memory returned by malloc()). */

#define MAX_ALIGN_SIZE(len) ALIGN_FOR_TYPE (len, max_align_t)

/* ALIGN_PTR returns the smallest pointer >= PTR which is aligned for
   data of TYPE. */
#define ALIGN_PTR(ptr, type) ((void *) ALIGN_FOR_TYPE ((size_t) (ptr), type))

BEGIN_C_DECLS

/* ------------------------ assertions ------------------- */

/* We define assert iff USE_ASSERTIONS or DEBUG_XEMACS is defined.
   Otherwise we define it to be empty.  Quantify has shown that the
   time the assert checks take is measurable so let's not include them
   in production binaries.

   If ASSERTIONS_DONT_ABORT defined, we will continue after assertion
   failures.

   assert_at_line() is used for asserts inside of inline functions called
   from error-checking macros.  If we're not tricky, we just get the file
   and line of the inline function, which is not very useful. */

/* Highly dubious kludge */
/*   (thanks, Jamie, I feel better now -- ben) */
MODULE_API void assert_failed (const Ascbyte *, int, const Ascbyte *);
void assert_equal_failed (const Ascbyte *file, int line, EMACS_INT x,
			  EMACS_INT y, const Ascbyte *exprx,
			  const Ascbyte *expry);
#define ABORT() assert_failed (__FILE__, __LINE__, "ABORT()")
#define abort_with_message(msg) assert_failed (__FILE__, __LINE__, msg)

/* This used to be ((void) (0)) but that triggers lots of unused variable
   warnings -- furthermore, if `x' has any side effects, e.g.
   assert (++depth <= 20);, we DEFINITELY want to execute the code inside of
   `x'.  Any reasonable compiler will eliminate an expression with
   no effects.  We keep this abstracted out like this in case we want to
   change it in the future. */
#define disabled_assert(x) ((void) (x))
#define disabled_assert_with_message(x, msg) ((void) msg, disabled_assert (x))
#define disabled_assert_at_line(x, file, line) \
  ((void) file, (void) line, disabled_assert (x))

#ifdef USE_ASSERTIONS
# define assert(x) ((x) ? (void) 0 : assert_failed (__FILE__, __LINE__, #x))
# define assert_with_message(x, msg) \
  ((x) ? (void) 0 : assert_failed (__FILE__, __LINE__, msg))
# define assert_at_line(x, file, line) \
  ((x) ? (void) 0 : assert_failed (file, line, #x))
# define assert_equal(x, y)						\
  ((x) == (y) ? (void) 0 :						\
   assert_equal_failed (__FILE__, __LINE__, (EMACS_INT) x, (EMACS_INT) y, \
                        #x, #y))
#else
# define assert(x) disabled_assert (x)
# define assert_with_message(x, msg) disabled_assert_with_message (x, msg)
# define assert_at_line(x, file, line) disabled_assert_at_line (x, file, line)
# define assert_equal(x, y) disabled_assert ((x) == (y))
#endif


/************************************************************************/
/**                       Simple bit operations                        **/
/************************************************************************/

#define BIT_INDEX_TO_SET_MASK(ind) (1 << (ind))
#define BIT_INDEX_TO_CLEAR_MASK(ind) \
  ((CATEGORY_TAB_BASE_TYPE) ~BIT_INDEX_TO_SET_MASK (ind))


/* Set bit number BIT in bit-array ARRAY. */
#define SET_BIT_IN_ARRAY(array, bit)		\
do {						\
  (array) |= BIT_INDEX_TO_SET_MASK (bit);	\
} while (0)

/* Clear bit number BIT in bit-array ARRAY. */
#define CLEAR_BIT_IN_ARRAY(array, bit)		\
do {						\
  (array) &= BIT_INDEX_TO_CLEAR_MASK (bit);	\
} while (0)

/* Test whether bit number BIT is set in bit-array ARRAY. */
#define BIT_IS_SET_IN_ARRAY(array, bit) \
  ((array) & BIT_INDEX_TO_SET_MASK (bit))


/************************************************************************/
/**                         Memory allocation                          **/
/************************************************************************/

/* ------------------------ simple memory allocation ------------------- */

/* Basic memory allocation and freeing functions */
void malloc_warning (const Ascbyte *);
MODULE_API void *xmalloc (Bytecount size) ATTRIBUTE_MALLOC;
MODULE_API void *xmalloc_and_zero (Bytecount size) ATTRIBUTE_MALLOC;
MODULE_API void *xrealloc (void *, Bytecount size) ATTRIBUTE_MALLOC;
MODULE_API Chbyte *xstrdup (const Chbyte *) ATTRIBUTE_MALLOC;

/* Basic free function */

MODULE_API void xfree_1 (void *);
#ifdef ERROR_CHECK_MALLOC
/* This used to use a temporary variable.  But that triggered
   complaints under strict aliasing. #### There should be a better way. */
#define xfree(lvalue) do						\
{									\
  xfree_1 (lvalue);							\
  VOIDP_CAST (lvalue) = (void *) DEADBEEF_CONSTANT;                     \
} while (0)
#else
#define xfree(lvalue) xfree_1 (lvalue)
#endif /* ERROR_CHECK_MALLOC */

#define XFREE(lvalue) do                        \
    {                                           \
      xfree (lvalue);                           \
      lvalue = 0;                               \
    } while (0)


/* ------------------------ stack allocation -------------------------- */

/* Allocating excessively large blocks on the stack can cause crashes.
   We provide MALLOC_OR_ALLOCA() below for places where it's likely that
   large amounts will be allocated; it mallocs the block if it's too big.
   Unfortunately, that requires a call to unbind_to() at the end of the
   function, and it's not feasible to rewrite all calls to alloca() this
   way.

   Instead, we use the portable C alloca() substitute in alloca.c above a
   certain size.  This actually uses malloc(), but checks the current stack
   pointer to see if data from previous alloca() calls needs to be freed.
   However, this can lead to large heap sizes -- especially since cleanup
   can only happen in a parent function, and will never happen if (as will
   often be the case) it's the same function in the same place in the code
   that keeps tripping the alloca() limit.

   So we set up a system to periodically force cleanup.  Currently we
   do cleanup:

   -- Only when there's C alloca() data, and then
   -- Every stack alloca() or allocation of Lisp data, every call to
      next_event_internal() [typically near the top of the stack],
      or every 10th funcall

   This should not be a big penalty because

   (a) If there are few C alloca() chunks, checking them will be fast
   (b) If not, we've allocated a huge amount of heap space (remember, each
       chunk represents > 256K of heap), and we really want them gone
*/

/* We use a larger maximum when the choice is alloca() vs. the C alloca()
   substitute than when the choice is vs. malloc(), because in the former
   case, our alternative choice is less palatable because the memory may
   not be freed for awhile. */

#define MAX_ALLOCA_VS_C_ALLOCA 262144
#define MAX_ALLOCA_VS_MALLOC 65536

#define MAX_FUNCALLS_BETWEEN_ALLOCA_CLEANUP 10

extern MODULE_API Bytecount __temp_alloca_size__;
extern Bytecount funcall_alloca_count;

#ifdef ERROR_CHECK_MALLOC
extern MODULE_API int regex_malloc_disallowed;
#define REGEX_MALLOC_CHECK() assert (!regex_malloc_disallowed)
#else
#define REGEX_MALLOC_CHECK() ((void) 0)
#endif

/* Do stack or heap alloca() depending on size.

NOTE: The use of a global temporary like this is unsafe if ALLOCA() occurs
twice anywhere in the same expression.  The alternative is to force all
callers to declare a local temporary if the argument to ALLOCA() has side
effects -- something easy to forget.

Normally, the use of ALLOCA() twice in the same expression is unlikely,
but it can certainly occur in conjunction with the DFC macros.  To fix this,
we do two things:

  (1) Under GCC, there's an extended syntax we can use that avoids the problem
      with global temporaries.
  (2) For other compilers, we provide a special two-argument version that
      is passed the size twice and uses each argument once and in a guaranteed
      order.  This is useful in cases where the size argument to ALLOCA()
      has side effects -- as is the case with the DFC macros. */

/* #define TEST_MULTIUSE_ALLOCA */

#if defined (__GNUC__) && !defined (TEST_MULTIUSE_ALLOCA)
#define USE_GCC_EXTENDED_EXPRESSION_SYNTAX
#endif

#ifdef USE_GCC_EXTENDED_EXPRESSION_SYNTAX
#define ALLOCA(size)						\
  ({ size_t temp_alloca_size;					\
     REGEX_MALLOC_CHECK ();					\
     temp_alloca_size = (size);					\
     temp_alloca_size  > MAX_ALLOCA_VS_C_ALLOCA ?		\
       xemacs_c_alloca (temp_alloca_size) :			\
       (need_to_check_c_alloca ? xemacs_c_alloca (0) : 0,	\
	alloca (temp_alloca_size)); })
#else /* not USE_GCC_EXTENDED_EXPRESSION_SYNTAX */
#define ALLOCA(size)					\
  (REGEX_MALLOC_CHECK (),				\
   __temp_alloca_size__ = (size),			\
   __temp_alloca_size__  > MAX_ALLOCA_VS_C_ALLOCA ?	\
   xemacs_c_alloca (__temp_alloca_size__) :		\
   (need_to_check_c_alloca ? xemacs_c_alloca (0) : 0,	\
    alloca (__temp_alloca_size__)))
#endif /* (not) USE_GCC_EXTENDED_EXPRESSION_SYNTAX */

/* Version of ALLOCA() that can be safely used multiple times within
   a single expression.  Regular ALLOCA() is not safe in this way since it
   uses a global temporary variable.  However, regular ALLOCA() under GCC
   *IS* safe since it uses a GCC extension that allows arbitrary code to
   be made into an expression.  For non-GCC, we define a special
   MULTIUSE_ALLOCA() that is safe for multiple use in function calls and
   avoids global temporaries.  To do that, however, it needs to be able to
   retrieve the size twice -- hence the two arguments.  MULTIUSE_ALLOCA()
   is guaranteed to evaluate SIZE prior to SIZEAGAIN.  If the first SIZE
   expression has no side effects, just make SIZEAGAIN be the same as
   SIZE; otherwise, SIZEAGAIN may have to be different. */

#ifdef USE_GCC_EXTENDED_EXPRESSION_SYNTAX
#define MULTIUSE_ALLOCA(size, sizeagain) ALLOCA(size)
#else
#define MULTIUSE_ALLOCA(size, sizeagain)		\
  (REGEX_MALLOC_CHECK (),				\
   (size)  > MAX_ALLOCA_VS_C_ALLOCA ?			\
   xemacs_c_alloca (sizeagain) :			\
   (need_to_check_c_alloca ? xemacs_c_alloca (0) : 0,	\
    alloca (sizeagain)))
#endif /* (not) USE_GCC_EXTENDED_EXPRESSION_SYNTAX */

/* Version of ALLOCA() that is guaranteed to work inside of function calls
   (i.e., we call the C alloca if regular alloca() is broken inside of
   function calls). */
#ifdef BROKEN_ALLOCA_IN_FUNCTION_CALLS
#define ALLOCA_FUNCALL_OK(size) xemacs_c_alloca (size)
#define MULTIUSE_ALLOCA_FUNCALL_OK(size, sizeagain) xemacs_c_alloca (size)
#else /* not BROKEN_ALLOCA_IN_FUNCTION_CALLS */
#define ALLOCA_FUNCALL_OK(size) ALLOCA (size)
#define MULTIUSE_ALLOCA_FUNCALL_OK(size, sizeagain) \
  MULTIUSE_ALLOCA (size, sizeagain)
#endif /* (not) BROKEN_ALLOCA_IN_FUNCTION_CALLS */

MODULE_API void *xemacs_c_alloca (size_t size) ATTRIBUTE_MALLOC;

MODULE_API int record_unwind_protect_freeing (void *ptr);

DECLARE_INLINE_HEADER (
void *
xmalloc_and_record_unwind (Bytecount size)
)
{
  void *ptr = xmalloc (size);
  record_unwind_protect_freeing (ptr);
  return ptr;
}

/* WARNING: If you use this, you must unbind_to() at the end of your
   function! */

#define MALLOC_OR_ALLOCA(size)				\
  (REGEX_MALLOC_CHECK (),				\
   __temp_alloca_size__ = (size),			\
   __temp_alloca_size__  > MAX_ALLOCA_VS_MALLOC ?	\
   xmalloc_and_record_unwind (__temp_alloca_size__) :	\
   (need_to_check_c_alloca ? xemacs_c_alloca (0) : 0,	\
    alloca (__temp_alloca_size__)))

/* -------------- convenience functions for memory allocation ------------- */

#define countof(x) ((int) (sizeof(x)/sizeof((x)[0])))
/* This is a hack.  Here below we have the standard "portable" definition of
   offsetof().  Normally we just use offsetof(), but under g++ (but not gcc)
   complains about using offsetof when the `field' argument is not constant,
   e.g. it's an array reference using a variable as the index.  So in that
   case, which happens in file-coding.h, we fall back to portable_offsetof().
   Fuck me harder!!!! --ben
       As of Mo 23. Sep 08:31:24 IST 2024 portable_offsetof() causes errors
       with -fsanitize=undefined and clang++-14 in file-coding.h; I have
       changed that use to offsetof() without difficulty. -- Aidan Kehoe. */
#define portable_offsetof(st, m) \
    ((Bytecount) ( (char *)&((st *)(0))->m - (char *)0 ))
#define xnew(type) ((type *) xmalloc (sizeof (type)))
#define xnew_array(type, len) ((type *) xmalloc ((len) * sizeof (type)))
#define xnew_and_zero(type) ((type *) xmalloc_and_zero (sizeof (type)))
#define xzero(lvalue) ((void) memset (&(lvalue), '\0', sizeof (lvalue)))
#define xnew_array_and_zero(type, len) ((type *) xmalloc_and_zero ((len) * sizeof (type)))

#define alloca_new(type) ((type *) ALLOCA (sizeof (type)))
#define alloca_array(type, len) ((type *) ALLOCA ((len) * sizeof (type)))

#define alloca_itexts(num) alloca_array (Itext, num)
#define alloca_ibytes(num) alloca_array (Ibyte, num)
#define alloca_extbytes(num) alloca_array (Extbyte, num)
#define alloca_chbytes(num) alloca_array (Chbyte, num)
#define alloca_rawbytes(num) alloca_array (Rawbyte, num)
#define alloca_binbytes(num) alloca_array (Binbyte, num)
#define alloca_ascbytes(num) alloca_array (Ascbyte, num)
#define xmalloc_itexts(num) xnew_array (Itext, num)
#define xnew_ibytes(num) xnew_array (Ibyte, num)
#define xnew_extbytes(num) xnew_array (Extbyte, num)
#define xnew_rawbytes(num) xnew_array (Rawbyte, num)
#define xnew_binbytes(num) xnew_array (Binbyte, num)
#define xnew_ascbytes(num) xnew_array (Ascbyte, num)

/* Make an alloca'd copy of a Ibyte * */
#define IBYTE_STRING_TO_ALLOCA(p, lval)		\
do {						\
  Ibyte **_bsta_ = (Ibyte **) &(lval);		\
  const Ibyte *_bsta_2 = (p);			\
  Bytecount _bsta_3 = qxestrlen (_bsta_2);	\
  *_bsta_ = alloca_ibytes (1 + _bsta_3);	\
  memcpy (*_bsta_, _bsta_2, 1 + _bsta_3);	\
} while (0)

/* Make an alloca'd copy of a Extbyte * */
#define EXTBYTE_STRING_TO_ALLOCA(p, lval)	\
do {						\
  Extbyte **_esta_ = (Extbyte **) &(lval);	\
  const Extbyte *_esta_2 = (p);			\
  Bytecount _esta_3 = strlen (_esta_2);		\
  *_esta_ = alloca_extbytes (1 + _esta_3);	\
  memcpy (*_esta_, _esta_2, 1 + _esta_3);	\
} while (0)

/* ----------------- convenience functions for reallocation --------------- */

#define XREALLOC_ARRAY(ptr, type, len) \
  ((void) (ptr = (type *) xrealloc (ptr, (len) * sizeof (type))))

/* also generally useful if you want to avoid arbitrary size limits
   but don't need a full dynamic array.  Assumes that BASEVAR points
   to a malloced array of TYPE objects (or possibly a NULL pointer,
   if SIZEVAR is 0), with the total size stored in SIZEVAR.  This
   macro will realloc BASEVAR as necessary so that it can hold at
   least NEEDED_SIZE objects.  The reallocing is done by doubling,
   which ensures constant amortized time per element. */
#define DO_REALLOC(basevar, sizevar, needed_size, type)	do {	\
  Bytecount do_realloc_needed_size = (needed_size);		\
  REGEX_MALLOC_CHECK ();					\
  if ((sizevar) < do_realloc_needed_size)			\
    {								\
      if ((sizevar) < 32)					\
	(sizevar) = 32;						\
      while ((sizevar) < do_realloc_needed_size)		\
	(sizevar) *= 2;						\
      XREALLOC_ARRAY (basevar, type, (sizevar));		\
    }								\
} while (0)

/************************************************************************/
/**                 Definitions of more complex types                  **/
/************************************************************************/

/* Note that the simplest typedefs are near the top of this file. */

/* We put typedefs here so that prototype declarations don't choke.
   Note that we don't actually declare the structures here (except
   maybe for simple structures like dynarrs); that keeps them private
   to the routines that actually use them. */

/* ------------------------------- */
/*    Error_Behavior typedefs      */
/* ------------------------------- */

#ifndef ERROR_CHECK_TYPES

typedef enum error_behavior
{
  ERROR_ME,
  ERROR_ME_NOT,
  ERROR_ME_WARN,
  ERROR_ME_DEBUG_WARN
} Error_Behavior;

#define ERRB_EQ(a, b) ((a) == (b))

#else

/* By defining it like this, we provide strict type-checking
   for code that lazily uses ints. */

typedef struct _error_behavior_struct_
{
  int really_unlikely_name_to_have_accidentally_in_a_non_errb_structure;
} Error_Behavior;

extern Error_Behavior ERROR_ME;
extern Error_Behavior ERROR_ME_NOT;
extern Error_Behavior ERROR_ME_WARN;
extern Error_Behavior ERROR_ME_DEBUG_WARN;

#define ERRB_EQ(a, b)							   \
 ((a).really_unlikely_name_to_have_accidentally_in_a_non_errb_structure == \
  (b).really_unlikely_name_to_have_accidentally_in_a_non_errb_structure)

#endif

/* ------------------------------- */
/*  Empty structures and typedefs  */
/* ------------------------------- */

struct buffer;                  /* "buffer.h" */
struct console;			/* "console.h" */
struct device;			/* "device.h" */
struct extent_fragment;
struct extent;
struct frame;			/* "frame.h" */
struct window;                  /* "window.h" */
struct utimbuf;                 /* "systime.h" or <utime.h> */
struct display_line;
struct display_glyph_area;
struct display_box;
struct redisplay_info;
struct window_mirror;
struct scrollbar_instance;
struct font_metric_info;
struct face_cachel;
struct console_type_entry;

typedef int face_index;
typedef int glyph_index;
typedef struct lstream Lstream; /* lstream.h */
typedef struct extent *EXTENT; /* extents-impl.h */
typedef struct Lisp_Event Lisp_Event; /* "events.h" */
typedef struct Lisp_Face Lisp_Face;   /* "faces-impl.h" */
typedef struct Lisp_Process Lisp_Process; /* "procimpl.h" */
typedef struct Lisp_Color_Instance Lisp_Color_Instance; /* fontcolor-impl.h */
typedef struct Lisp_Font_Instance Lisp_Font_Instance; /* fontcolor-impl.h */
typedef struct Lisp_Image_Instance Lisp_Image_Instance; /* glyphs.h */
typedef struct Lisp_Gui_Item Lisp_Gui_Item;

/* ------------------------------- */
/*          enum typedefs          */
/* ------------------------------- */

enum run_hooks_condition
{
  RUN_HOOKS_TO_COMPLETION,
  RUN_HOOKS_UNTIL_SUCCESS,
  RUN_HOOKS_UNTIL_FAILURE
};

enum edge_style
{
  EDGE_ETCHED_IN,
  EDGE_ETCHED_OUT,
  EDGE_BEVEL_IN,
  EDGE_BEVEL_OUT
};

enum munge_me_out_the_door
{
  MUNGE_ME_FUNCTION_KEY,
  MUNGE_ME_KEY_TRANSLATION
};

/* The various stages of font instantiation; initial means "find a font for
   CHARSET that matches the charset's registries" and final means "find a
   font for CHARSET that matches iso10646-1, since we haven't found a font
   that matches its registry."
*/
enum font_specifier_matchspec_stages
{
  STAGE_INITIAL,
  STAGE_FINAL,
  NUM_MATCHSPEC_STAGES,
};

/* ------------------------------- */
/*                misc             */
/* ------------------------------- */

/* This structure is used to keep statistics on the amount of memory
   in use.

   WAS_REQUESTED stores the actual amount of memory that was requested
   of the allocation function.  The *_OVERHEAD fields store the
   additional amount of memory that was grabbed by the functions to
   facilitate allocation, reallocation, etc.  MALLOC_OVERHEAD is for
   memory allocated with malloc(); DYNARR_OVERHEAD is for dynamic
   arrays; GAP_OVERHEAD is for gap arrays.  Note that for (e.g.)
   dynamic arrays, there is both MALLOC_OVERHEAD and DYNARR_OVERHEAD
   memory: The dynamic array allocates memory above and beyond what
   was asked of it, and when it in turns allocates memory using
   malloc(), malloc() allocates memory beyond what it was asked
   to allocate.

   Functions that accept a structure of this sort do not initialize
   the fields to 0, and add any existing values to whatever was there
   before; this way, you can get a cumulative effect. */

struct usage_stats
{
  Bytecount was_requested;
  Bytecount malloc_overhead;
  Bytecount dynarr_overhead;
  Bytecount gap_overhead;
};

/* Generic version of usage stats structure including extra non-Lisp and
   Lisp storage associated with the object, but not including the memory
   used to hold the object itself.  Up to 32 statistics are allowed,
   in addition to the statistics in `U', which store another slice onto the
   ancillary non-Lisp storage.

   Normally, each object creates its own version of this structure, e.g.
   `struct window_stats', which parallels the structure in beginning with
   a `struct usage_stats' and followed by Bytecount fields, so that a
   pointer to that structure can be cast to a pointer of this structure
   and sensible results gotten. */

struct generic_usage_stats
{
  struct usage_stats u;
  Bytecount othervals[32];
};


/************************************************************************/
/*		     Definition of Lisp_Object data type		*/
/************************************************************************/

/* Define the fundamental Lisp data structures */

/* This is the set of Lisp data types */

enum Lisp_Type
{
  Lisp_Type_Record,
  Lisp_Type_Fixnum_Even,
  Lisp_Type_Char,
  Lisp_Type_Fixnum_Odd
};

#define POINTER_TYPE_P(type) ((type) == Lisp_Type_Record)

/* Overridden by m/next.h */
#ifndef ASSERT_VALID_POINTER
# define ASSERT_VALID_POINTER(pnt) (assert ((((EMACS_UINT) pnt) & 3) == 0))
#endif

#define GCMARKBITS  0
#define GCTYPEBITS  2
#define GCBITS      2
#define FIXNUM_GCBITS  1

#define FIXNUM_VALBITS (BITS_PER_EMACS_INT - FIXNUM_GCBITS)
#define VALBITS (BITS_PER_EMACS_INT - GCBITS)
#define MOST_POSITIVE_FIXNUM_UNSIGNED (((EMACS_UINT)1 << (FIXNUM_VALBITS - 1)) -1)
#define MOST_POSITIVE_FIXNUM ((EMACS_INT) MOST_POSITIVE_FIXNUM_UNSIGNED)
#define MOST_NEGATIVE_FIXNUM (-(MOST_POSITIVE_FIXNUM) - 1)
/* WARNING: evaluates its arg twice. */
#ifdef USE_GCC_EXTENDED_EXPRESSION_SYNTAX
#define NUMBER_FITS_IN_A_FIXNUM(num)                                    \
  ({ __typeof__ (num) _num = (num);                                     \
    assert (_num == num); /* Catch any non-idempotent argument. */      \
    (((__typeof__ (num))-1 < 0) ? /* Signed? */                         \
     ((sizeof (_num) * BITS_PER_CHAR) <= FIXNUM_VALBITS ||              \
      (((__typeof__ (num)) MOST_NEGATIVE_FIXNUM <= _num) &&             \
       _num <= ((__typeof__ (num)) MOST_POSITIVE_FIXNUM)))              \
     : ((sizeof (_num) * BITS_PER_CHAR) < FIXNUM_VALBITS ||             \
        (((__typeof__ (num)) 0 <= _num) &&                              \
         _num <= ((__typeof__ (num)) MOST_POSITIVE_FIXNUM)))); })
#define UNSIGNED_NUMBER_FITS_IN_A_FIXNUM(num)                   \
  ((num) <= (__typeof__ (num)) MOST_POSITIVE_FIXNUM_UNSIGNED)
#else
#define NUMBER_FITS_IN_A_FIXNUM(num) \
  ((num) <= MOST_POSITIVE_FIXNUM && (num) >= MOST_NEGATIVE_FIXNUM)
#define UNSIGNED_NUMBER_FITS_IN_A_FIXNUM(num) \
  ((num) <= MOST_POSITIVE_FIXNUM_UNSIGNED)

#endif
#ifdef USE_UNION_TYPE
# include "lisp-union.h"
#else /* !USE_UNION_TYPE */
# include "lisp-disunion.h"
#endif /* !USE_UNION_TYPE */

#define XPNTR(x) ((void *) XPNTRVAL(x))

/* Close your eyes now lest you vomit or spontaneously combust ... */

#define HACKEQ_UNSAFE(obj1, obj2)				\
  (EQ (obj1, obj2) || (!POINTER_TYPE_P (XTYPE (obj1))		\
		       && !POINTER_TYPE_P (XTYPE (obj2))	\
		       && XCHAR_OR_FIXNUM (obj1) == XCHAR_OR_FIXNUM (obj2)))

#ifdef DEBUG_XEMACS
extern MODULE_API int debug_issue_ebola_notices;
MODULE_API int eq_with_ebola_notice (Lisp_Object, Lisp_Object);
#define EQ_WITH_EBOLA_NOTICE(obj1, obj2)				\
  (debug_issue_ebola_notices ? eq_with_ebola_notice (obj1, obj2)	\
   : EQ (obj1, obj2))
#else
#define EQ_WITH_EBOLA_NOTICE(obj1, obj2) EQ (obj1, obj2)
#endif

/* OK, you can open them again */

END_C_DECLS

#include "lrecord.h"

/* Turn any void * pointer into a Lisp object.  This is the counterpart of
   STORE_LISP_IN_VOID, which works in the opposite direction.  Note that
   you CANNOT use STORE_LISP_IN_VOID to undo the effects of STORE_VOID_IN_LISP!
   Instead, you GET_VOID_FROM_LISP:

   STORE_VOID_IN_LISP <--> GET_VOID_FROM_LISP         vs.
   STORE_LISP_IN_VOID <--> GET_LISP_FROM_VOID

   STORE_VOID_IN_LISP has a restriction on the void * pointers it can
   handle -- the pointer must be an even address (lowest bit set to 0).
   Generally this is not a problem as nowadays virtually all allocation is
   at least 4-byte aligned, if not 8-byte.

   However, if this proves problematic, you can use make_opaque_ptr(), which
   is guaranteed to handle any kind of void * pointer but which does
   Lisp allocation.
   */

DECLARE_INLINE_HEADER (
Lisp_Object
STORE_VOID_IN_LISP (void *ptr)
)
{
  EMACS_UINT p = (EMACS_UINT) ptr;

  type_checking_assert ((p & 1) == 0);
  return make_fixnum (p >> 1);
}

DECLARE_INLINE_HEADER (
void *
GET_VOID_FROM_LISP (Lisp_Object obj)
)
{
  EMACS_UINT p = XUINT (obj);
  return (void *) (p << 1);
}

/************************************************************************/
/**            Definitions of dynarrs and other allocators             **/
/************************************************************************/

#include "array.h"

/************* Dynarr typedefs *************/

/* Dynarr typedefs -- basic types first */

typedef struct
{
  Dynarr_declare (Ibyte);
} Ibyte_dynarr;

typedef struct
{
  Dynarr_declare (Extbyte);
} Extbyte_dynarr;

typedef struct
{
  Dynarr_declare (Ichar);
} Ichar_dynarr;

typedef struct
{
  Dynarr_declare (char);
} char_dynarr;

typedef struct
{
  Dynarr_declare (char *);
} char_ptr_dynarr;

typedef unsigned char unsigned_char;
typedef struct
{
  Dynarr_declare (unsigned char);
} unsigned_char_dynarr;

typedef unsigned long unsigned_long;
typedef struct
{
  Dynarr_declare (unsigned long);
} unsigned_long_dynarr;

typedef const Ascbyte *const_Ascbyte_ptr;
typedef struct
{
  Dynarr_declare (const Ascbyte *);
} const_Ascbyte_ptr_dynarr;

extern const struct sized_memory_description const_Ascbyte_ptr_description;
extern const struct sized_memory_description const_Ascbyte_ptr_dynarr_description;

typedef struct
{
  Dynarr_declare (int);
} int_dynarr;

typedef struct
{
  Dynarr_declare (Charbpos);
} Charbpos_dynarr;

typedef struct
{
  Dynarr_declare (Bytebpos);
} Bytebpos_dynarr;

typedef struct
{
  Dynarr_declare (Charcount);
} Charcount_dynarr;

typedef struct
{
  Dynarr_declare (Bytecount);
} Bytecount_dynarr;

/* Dynarr typedefs -- more complex types */

typedef struct
{
  Dynarr_declare (struct face_cachel);
} face_cachel_dynarr;


typedef struct
{
  Dynarr_declare (struct glyph_cachel);
} glyph_cachel_dynarr;


typedef struct
{
  Dynarr_declare (struct console_type_entry);
} console_type_entry_dynarr;

/* WARNING WARNING WARNING.  You must ensure on your own that proper
   GC protection is provided for the elements in this array. */
typedef struct
{
  Dynarr_declare (Lisp_Object);
} Lisp_Object_dynarr;

typedef struct
{
  Dynarr_declare (Lisp_Object *);
} Lisp_Object_ptr_dynarr;

typedef struct
{
  Lisp_Object key, value;
} Lisp_Object_pair;

typedef struct
{
  Dynarr_declare (Lisp_Object_pair);
} Lisp_Object_pair_dynarr;

/************************************************************************/
/**              Definitions of other basic Lisp objects               **/
/************************************************************************/

/*------------------------------ unbound -------------------------------*/

/* Qunbound is a special Lisp_Object (of type Lisp_Opaque), that can never be
   visible to the Lisp caller and thus can be used in the C code to mean "no
   such value".

   It is named as a symbol (the initial Q) because it traditionally was a
   symbol (and still is a symbol in GNU Emacs); the advantage of making it
   Lisp_Opaque is that type is not printable and does not have a read syntax,
   so errors that lead to Qunbound escaping to Lisp are more evident. */
#define UNBOUNDP(val) EQ (val, Qunbound)

/* Evaluate expr, return it if it's not Qunbound. */
#define RETURN_IF_NOT_UNBOUND(expr) do	\
{					\
  Lisp_Object ret_nunb_val = (expr);	\
  if (!UNBOUNDP (ret_nunb_val))		\
    RETURN_SANS_WARNINGS ret_nunb_val;	\
} while (0)

/*------------------------------- cons ---------------------------------*/

/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
{
  FROB_BLOCK_LISP_OBJECT_HEADER lheader;
  Lisp_Object car_, cdr_;
};
typedef struct Lisp_Cons Lisp_Cons;

#if 0 /* FSFmacs */
/* Like a cons, but records info on where the text lives that it was read from */
/* This is not really in use now */

struct Lisp_Buffer_Cons
{
  Lisp_Object car, cdr;
  struct buffer *buffer;
  int charbpos;
};
#endif

DECLARE_MODULE_API_LISP_OBJECT (cons, Lisp_Cons);
#define XCONS(x) XRECORD (x, cons, Lisp_Cons)
#define wrap_cons(p) wrap_record (p, cons)
#define CONSP(x) RECORDP (x, cons)
#define CHECK_CONS(x) CHECK_RECORD (x, cons)
#define CONCHECK_CONS(x) CONCHECK_RECORD (x, cons)

#define CONS_MARKED_P(c) MARKED_RECORD_HEADER_P(&((c)->lheader))
#define MARK_CONS(c) MARK_RECORD_HEADER (&((c)->lheader))

extern MODULE_API Lisp_Object Qnil;

#define NILP(x)  EQ (x, Qnil)
#define cons_car(a) ((a)->car_)
#define cons_cdr(a) ((a)->cdr_)
#define XCAR(a) (XCONS (a)->car_)
#define XCDR(a) (XCONS (a)->cdr_)
#define XCADR(a) (XCAR (XCDR (a)))
#define XCDDR(a) (XCDR (XCDR (a)))
#define XCADDR(a) (XCAR (XCDDR (a)))
#define XCDDDR(a) (XCDR (XCDDR (a)))
#define XCADDDR(a) (XCAR (XCDDDR (a)))
#define XCDDDDR(a) (XCDR (XCDDDR (a)))
#define XCADDDDR(a) (XCAR (XCDDDDR (a)))
#define XCDDDDDR(a) (XCDR (XCDDDDR (a)))
#define XCADDDDDR(a) (XCAR (XCDDDDDR (a)))
#define XCDDDDDDR(a) (XCDR (XCDDDDDR (a)))
#define XCADDDDDDR(a) (XCAR (XCDDDDDDR (a)))
#define XCDDDDDDDR(a) (XCDR (XCDDDDDDR (a)))
#define XCADDDDDDDR(a) (XCAR (XCDDDDDDDR (a)))
#define XCDDDDDDDDR(a) (XCDR (XCDDDDDDDR (a)))
#define XCADDDDDDDDR(a) (XCAR (XCDDDDDDDDR (a)))
#define XCDDDDDDDDDR(a) (XCDR (XCDDDDDDDDR (a)))
#define XCADDDDDDDDDR(a) (XCAR (XCDDDDDDDDDR (a)))
#define XCDDDDDDDDDDR(a) (XCDR (XCDDDDDDDDDR (a)))
#define X1ST(a)  XCAR (a)
#define X2ND(a)  XCADR (a)
#define X3RD(a)  XCADDR (a)
#define X4TH(a)  XCADDDR (a)
#define X5TH(a)  XCADDDDR (a)
#define X6TH(a)  XCADDDDDR (a)
#define X7TH(a)  XCADDDDDDR (a)
#define X8TH(a)  XCADDDDDDDR (a)
#define X9TH(a)  XCADDDDDDDDR (a)
#define X10TH(a) XCADDDDDDDDDR (a)
#define X1STCDR(a)  XCDR (a)
#define X2NDCDR(a)  XCDDR (a)
#define X3RDCDR(a)  XCDDDR (a)
#define X4THCDR(a)  XCDDDDR (a)
#define X5THCDR(a)  XCDDDDDR (a)
#define X6THCDR(a)  XCDDDDDDR (a)
#define X7THCDR(a)  XCDDDDDDDR (a)
#define X8THCDR(a)  XCDDDDDDDDR (a)
#define X9THCDR(a)  XCDDDDDDDDDR (a)
#define X10THCDR(a) XCDDDDDDDDDDR (a)

#define XSETCAR(a, b) (XCONS (a)->car_ = (b))
#define XSETCDR(a, b) (XCONS (a)->cdr_ = (b))
#define LISTP(x) (CONSP(x) || NILP(x))

#define CHECK_NIL(x) do {			\
  if (!NILP (x))				\
    dead_wrong_type_argument (Qnull, x);	\
} while (0)

#define CHECK_LIST(x) do {			\
  if (!LISTP (x))				\
    dead_wrong_type_argument (Qlistp, x);	\
} while (0)

#define CONCHECK_LIST(x) do {			\
  if (!LISTP (x))				\
    x = wrong_type_argument (Qlistp, x);	\
} while (0)

/*---------------------- list traversal macros -------------------------*/

/* Note: These macros are for traversing through a list in some format,
   and executing code that you specify on each member of the list.

   There are two kinds of macros, those requiring surrounding braces, and
   those not requiring this.  Which type of macro will be indicated.
   The general format for using a brace-requiring macro is

   {
     LIST_LOOP_3 (elt, list, tail)
       execute_code_here;
   }

   or

   {
     LIST_LOOP_3 (elt, list, tail)
       {
         execute_code_here;
       }
   }

   You can put variable declarations between the brace and beginning of
   macro, but NOTHING ELSE.

   The brace-requiring macros typically declare themselves any arguments
   that are initialized and iterated by the macros.  If for some reason
   you need to declare these arguments yourself (e.g. to do something on
   them before the iteration starts, use the _NO_DECLARE versions of the
   macros.)
*/

/* There are two basic kinds of macros: those that handle "internal" lists
   that are known to be correctly structured (i.e. first element is a cons
   or nil, and the car of each cons is also a cons or nil, and there are
   no circularities), and those that handle "external" lists, where the
   list may have any sort of invalid formation.  This is reflected in
   the names: those with "EXTERNAL_" work with external lists, and those
   without this prefix work with internal lists.  The internal-list
   macros will hit an assertion failure if the structure is ill-formed;
   the external-list macros will signal an error in this case, either a
   malformed-list error or a circular-list error.
*/

/* LIST_LOOP is a simple, old-fashioned macro.  It doesn't require brace
   surrounding, and iterates through a list, which may or may not known to
   be syntactically correct.  It accepts two args, TAIL (set progressively
   to each cons starting with the first), and LIST, the list to iterate
   over.  TAIL needs to be defined by the caller.

   In each iteration, you can retrieve the current list item using XCAR
   (tail), or destructively modify the list using XSETCAR (tail,
   ...). */

#define LIST_LOOP(tail, list)		\
  for (tail = list;			\
       !NILP (tail);			\
       tail = XCDR (tail))

/* The following macros are the "core" macros for list traversal.

   *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***

   LIST_LOOP_2 and EXTERNAL_LIST_LOOP_2 are the standard, most-often used
   macros.  They take two arguments, an element variable ELT and the list
   LIST.  ELT is automatically declared, and set to each element in turn
   from LIST.

   LIST_LOOP_3 and EXTERNAL_LIST_LOOP_3 are the same, but they have a third
   argument TAIL, another automatically-declared variable.  At each iteration,
   this one points to the cons cell for which ELT is the car.

   EXTERNAL_LIST_LOOP_4 is like EXTERNAL_LIST_LOOP_3 but takes an additional
   LEN argument, again automatically declared, which counts the number of
   iterations gone by.  It is 0 during the first iteration.

   EXTERNAL_LIST_LOOP_4_NO_DECLARE is like EXTERNAL_LIST_LOOP_4 but none
   of the variables are automatically declared, and so you need to declare
   them yourself. (ELT and TAIL are Lisp_Objects, and LEN is an EMACS_INT.)
*/

#define LIST_LOOP_2(elt, list)		\
  LIST_LOOP_3(elt, list, unused_tail_##elt)

#define LIST_LOOP_3(elt, list, tail)	\
  Lisp_Object elt, tail;		\
  for (tail = list;			\
       NILP (tail) ?			\
	 0 : (elt = XCAR (tail), 1);	\
       tail = XCDR (tail))

/* The following macros are for traversing lisp lists.
   Signal an error if LIST is not properly acyclic and nil-terminated.

   Use tortoise/hare algorithm to check for cycles, but only if it
   looks like the list is getting too long.  Not only is the hare
   faster than the tortoise; it even gets a head start! */

/* Optimized and safe macros for looping over external lists.  */
#define CIRCULAR_LIST_SUSPICION_LENGTH 1024

#define EXTERNAL_LIST_LOOP_1(list)					\
Lisp_Object ELL1_elt, ELL1_hare, ELL1_tortoise;				\
EMACS_INT ELL1_len;							\
PRIVATE_EXTERNAL_LIST_LOOP_6 (ELL1_elt, list, ELL1_len, ELL1_hare,	\
		      ELL1_tortoise, CIRCULAR_LIST_SUSPICION_LENGTH)

#define EXTERNAL_LIST_LOOP_2(elt, list)					\
Lisp_Object elt, hare_##elt, tortoise_##elt;				\
EMACS_INT len_##elt;							\
PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, hare_##elt,		\
		      tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)


#define GC_EXTERNAL_LIST_LOOP_2(elt, list)				\
do {									\
  XGCDECL3 (elt);							\
  Lisp_Object elt, hare_##elt, tortoise_##elt;				\
  EMACS_INT len_##elt;							\
  XGCPRO3 (elt, elt, hare_##elt, tortoise_##elt);			\
  PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, hare_##elt,	\
				tortoise_##elt,				\
				CIRCULAR_LIST_SUSPICION_LENGTH)

#define END_GC_EXTERNAL_LIST_LOOP(elt)		\
  XUNGCPRO (elt);				\
}						\
while (0)

#define EXTERNAL_LIST_LOOP_3(elt, list, tail)				\
Lisp_Object elt, tail, tortoise_##elt;					\
EMACS_INT len_##elt;							\
PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, tail,		\
		      tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)

#define GC_EXTERNAL_LIST_LOOP_3(elt, list, tail)			\
do {									\
  XGCDECL3 (elt);							\
  Lisp_Object elt, tail, tortoise_##elt;				\
  EMACS_INT len_##elt;							\
  XGCPRO3 (elt, elt, tail, tortoise_##elt);				\
  PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, tail,		\
				tortoise_##elt,				\
				CIRCULAR_LIST_SUSPICION_LENGTH)

#define EXTERNAL_LIST_LOOP_4_NO_DECLARE(elt, list, tail, len)		\
Lisp_Object tortoise_##elt;						\
PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, tail,			\
		      tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)

#define EXTERNAL_LIST_LOOP_4(elt, list, tail, len)			\
Lisp_Object elt, tail, tortoise_##elt;					\
EMACS_INT len;								\
PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, tail,			\
		      tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)

#define GC_EXTERNAL_LIST_LOOP_4(elt, list, tail, len)			\
do {									\
  XGCDECL3 (elt);							\
  Lisp_Object elt, tail, tortoise_##elt;				\
  XGCPRO3 (elt, elt, tail, tortoise_##elt);				\
  PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, tail,			\
				tortoise_##elt,				\
				CIRCULAR_LIST_SUSPICION_LENGTH)

#define PRIVATE_UNVERIFIED_LIST_LOOP_7(elt, list, len, hare,		\
				       tortoise, suspicion_length,	\
                                       signalp)				\
  for (tortoise = hare = list, len = 0;					\
									\
       (CONSP (hare) ? ((elt = XCAR (hare)), 1) :			\
	(NILP (hare) ? 0 :						\
	 ((signalp ? signal_malformed_list_error (list) : (void) 0), 0)));\
									\
       hare = XCDR (hare),						\
	 (void)								\
	 ((++len > suspicion_length)					\
	  &&								\
	  ((((len & 1) != 0) ? (tortoise = XCDR (tortoise), 0) : 0),    \
	   (EQ (hare, tortoise) &&					\
            ((signalp ? signal_circular_list_error (list) :             \
              ((hare = Qunbound, (void) 0))), 0)))))

#define PRIVATE_EXTERNAL_LIST_LOOP_6(elt, list, len, hare,		\
				     tortoise, suspicion_length)	\
  PRIVATE_UNVERIFIED_LIST_LOOP_7 (elt, list, len, hare, tortoise,	\
                                  suspicion_length, 1)

#define PRIVATE_SAFE_LIST_LOOP_6(elt, list, len, hare,			\
				 tortoise, suspicion_length)		\
  PRIVATE_UNVERIFIED_LIST_LOOP_7 (elt, list, len, hare, tortoise,	\
                                  suspicion_length, 0)

/* Similar to EXTERNAL_LIST_LOOP_2() but don't signal when an error
   is detected, just stop. */
#define SAFE_LIST_LOOP_2(elt, list)					\
Lisp_Object elt, hare_##elt, tortoise_##elt;				\
EMACS_INT len_##elt;							\
PRIVATE_SAFE_LIST_LOOP_6 (elt, list, len_##elt, hare_##elt,		\
		          tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)

/* Similar to EXTERNAL_LIST_LOOP_3() but don't signal when an error is
   detected, just stop.  If LIST was a true, non-circular list, then TAIL will
   be Qnil after SAFE_LIST_LOOP_3 completes.  If LIST was circular, TAIL will
   be Qunbound; otherwise it will be the last (non-list) cdr in LIST. */
#define SAFE_LIST_LOOP_3(elt, list, tail)				\
Lisp_Object elt, tail, tortoise_##elt;					\
EMACS_INT len_##elt;							\
PRIVATE_SAFE_LIST_LOOP_6 (elt, list, len_##elt, tail,			\
		          tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)

/* GET_LIST_LENGTH and GET_EXTERNAL_LIST_LENGTH:

   These two macros return the length of LIST (either an internal or external
   list, according to which macro is used), stored into LEN (which must
   be declared by the caller).  Circularities are trapped in external lists
   (and cause errors).  Neither macro need be declared inside brackets. */

#define GET_LIST_LENGTH(list, len) do {		\
  Lisp_Object GLL_tail;				\
  for (GLL_tail = list, len = 0;		\
       !NILP (GLL_tail);			\
       GLL_tail = XCDR (GLL_tail), ++len)	\
    DO_NOTHING;					\
} while (0)

#define GET_EXTERNAL_LIST_LENGTH(list, len)				\
do {									\
  Lisp_Object GELL_elt, GELL_tail;					\
  EXTERNAL_LIST_LOOP_4_NO_DECLARE (GELL_elt, list, GELL_tail, len)	\
    ;									\
  USED (GELL_elt); /* Silence warning. */                              \
} while (0)

/* For a list that's known to be in valid list format, where we may
   be deleting the current element out of the list --
   will ABORT() if the list is not in valid format */
#define LIST_LOOP_DELETING(consvar, nextconsvar, list)		\
  for (consvar = list;						\
       !NILP (consvar) ? (nextconsvar = XCDR (consvar), 1) :0;	\
       consvar = nextconsvar)

/* LIST_LOOP_DELETE_IF and EXTERNAL_LIST_LOOP_DELETE_IF:

   These two macros delete all elements of LIST (either an internal or
   external list, according to which macro is used) satisfying
   CONDITION, a C expression referring to variable ELT.  ELT is
   automatically declared.  Circularities are trapped in external
   lists (and cause errors).  Neither macro need be declared inside
   brackets. */

#define LIST_LOOP_DELETE_IF(elt, list, condition) do {		\
  /* Do not use ##list when creating new variables because	\
     that may not be just a variable name. */			\
  Lisp_Object prev_tail_##elt = Qnil;				\
  LIST_LOOP_3 (elt, list, tail_##elt)				\
    {								\
      if (condition)						\
	{							\
	  if (NILP (prev_tail_##elt))				\
	    list = XCDR (tail_##elt);				\
	  else							\
	    XCDR (prev_tail_##elt) = XCDR (tail_##elt);	\
	}							\
      else							\
	prev_tail_##elt = tail_##elt;				\
    }								\
} while (0)

#define EXTERNAL_LIST_LOOP_DELETE_IF(elt, list, condition) do {	\
  Lisp_Object prev_tail_##elt = Qnil;				\
  EXTERNAL_LIST_LOOP_4 (elt, list, tail_##elt, len_##elt)	\
    {								\
      if (condition)						\
	{							\
	  if (NILP (prev_tail_##elt))				\
	    list = XCDR (tail_##elt);				\
	  else							\
	    XCDR (prev_tail_##elt) = XCDR (tail_##elt);		\
          /* Keep tortoise from ever passing hare. */		\
	  len_##elt = 0;					\
	}							\
      else							\
	prev_tail_##elt = tail_##elt;				\
    }								\
} while (0)


/* Macros for looping over internal alists.

   *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***

   ALIST_LOOP_3 loops over an alist, at each iteration setting CAR and CDR
   to the car and cdr of the acons.  CAR and CDR are automatically
   declared.

   ALIST_LOOP_4 is similar to ALIST_LOOP_3 but contains an additional
   variable ACONS at the beginning for access to the acons itself.All of
   the variables ACONS, CAR and CDR are automatically declared.
*/

#define ALIST_LOOP_3(car, cdr, alist)				\
Lisp_Object _al3_acons_##car, car, cdr, _al3_tail_##car;	\
  for (_al3_tail_##car = alist;					\
       NILP (_al3_tail_##car) ?					\
	 0 : (_al3_acons_##car = XCAR (_al3_tail_##car),	\
	      car = XCAR (_al3_acons_##car),			\
	      cdr = XCDR (_al3_acons_##car), 1);		\
       _al3_tail_##car = XCDR (_al3_tail_##car))

#define ALIST_LOOP_4(acons, car, cdr, list)			\
Lisp_Object acons, car, cdr, _al4_tail_##car;			\
  for (_al4_tail_##car = list;					\
       NILP (_al4_tail_##car) ?					\
	 0 : (elt = XCAR (_al4_tail_##car), car = XCAR (elt),	\
	      cdr = XCDR (elt), 1);				\
       _al4_tail_##car = XCDR (_al4_tail_##car))

/* Macros for looping over external alists.

   *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***

   EXTERNAL_ALIST_LOOP_4 is similar to EXTERNAL_LIST_LOOP_2, but it
   assumes the elements are aconses (the elements in an alist) and
   sets two additional argument variables ELT_CAR and ELT_CDR to the
   car and cdr of the acons.  All of the variables ELT, ELT_CAR and
   ELT_CDR are automatically declared.

   EXTERNAL_ALIST_LOOP_5 adds a TAIL argument to EXTERNAL_ALIST_LOOP_4,
   just like EXTERNAL_LIST_LOOP_3 does, and again TAIL is automatically
   declared.

   EXTERNAL_ALIST_LOOP_6 adds a LEN argument to EXTERNAL_ALIST_LOOP_5,
   just like EXTERNAL_LIST_LOOP_4 does, and again LEN is automatically
   declared.

   EXTERNAL_ALIST_LOOP_6_NO_DECLARE does not declare any of its arguments,
   just like EXTERNAL_LIST_LOOP_4_NO_DECLARE, and so these must be declared
   manually.
 */

/* Optimized and safe macros for looping over external alists. */
#define EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, list)	\
Lisp_Object elt, elt_car, elt_cdr;				\
Lisp_Object hare_##elt, tortoise_##elt;				\
EMACS_INT len_##elt;						\
PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list,	\
		       len_##elt, hare_##elt, tortoise_##elt,	\
		       CIRCULAR_LIST_SUSPICION_LENGTH)

#define EXTERNAL_ALIST_LOOP_5(elt, elt_car, elt_cdr, list, tail)	\
Lisp_Object elt, elt_car, elt_cdr, tail;				\
Lisp_Object tortoise_##elt;						\
EMACS_INT len_##elt;							\
PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list,		\
		       len_##elt, tail, tortoise_##elt,			\
		       CIRCULAR_LIST_SUSPICION_LENGTH)			\

#define EXTERNAL_ALIST_LOOP_6(elt, elt_car, elt_cdr, list, tail, len)	\
Lisp_Object elt, elt_car, elt_cdr, tail;				\
EMACS_INT len;								\
Lisp_Object tortoise_##elt;						\
PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list,		\
		       len, tail, tortoise_##elt,			\
		       CIRCULAR_LIST_SUSPICION_LENGTH)

#define EXTERNAL_ALIST_LOOP_6_NO_DECLARE(elt, elt_car, elt_cdr, list,	\
					 tail, len)			\
Lisp_Object tortoise_##elt;						\
PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list,		\
		       len, tail, tortoise_##elt,			\
		       CIRCULAR_LIST_SUSPICION_LENGTH)


#define PRIVATE_EXTERNAL_ALIST_LOOP_8(elt, elt_car, elt_cdr, list, len, \
				      hare, tortoise, suspicion_length)	\
PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, hare, tortoise,		\
			      suspicion_length)				\
  if (CONSP (elt) ? (elt_car = XCAR (elt), elt_cdr = XCDR (elt), 0) :1)	\
    continue;								\
  else

/* Macros for looping over external property lists.

   *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***

   EXTERNAL_PROPERTY_LIST_LOOP_3 maps over an external list assumed to
   be a property list, consisting of alternating pairs of keys
   (typically symbols or keywords) and values.  Each iteration
   processes one such pair out of LIST, assigning the two elements to
   KEY and VALUE respectively.  Malformed lists and circularities are
   trapped as usual, and in addition, property lists with an odd number
   of elements also signal an error.

   EXTERNAL_PROPERTY_LIST_LOOP_4 adds a TAIL argument to
   EXTERNAL_PROPERTY_LIST_LOOP_3, just like EXTERNAL_LIST_LOOP_3 does,
   and again TAIL is automatically declared.

   EXTERNAL_PROPERTY_LIST_LOOP_5 adds a LEN argument to
   EXTERNAL_PROPERTY_LIST_LOOP_4, just like EXTERNAL_LIST_LOOP_4 does,
   and again LEN is automatically declared.  Note that in this case,
   LEN counts the iterations, NOT the total number of list elements
   processed, which is 2 * LEN.

   EXTERNAL_PROPERTY_LIST_LOOP_5_NO_DECLARE does not declare any of its
   arguments, just like EXTERNAL_LIST_LOOP_4_NO_DECLARE, and so these
   must be declared manually.  */

/* Optimized and safe macros for looping over external property lists. */
#define EXTERNAL_PROPERTY_LIST_LOOP_3(key, value, list)			\
Lisp_Object key, value, hare_##key, tortoise_##key;			\
EMACS_INT len_##key;							\
EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len_##key, hare_##key,	\
		     tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)

#define EXTERNAL_PROPERTY_LIST_LOOP_4(key, value, list, tail)		\
Lisp_Object key, value, tail, tortoise_##key;				\
EMACS_INT len_##key;							\
EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len_##key, tail,	\
		     tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)

#define EXTERNAL_PROPERTY_LIST_LOOP_5(key, value, list, tail, len)	\
Lisp_Object key, value, tail, tortoise_##key;				\
EMACS_INT len;								\
EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len, tail,		\
		     tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)

#define EXTERNAL_PROPERTY_LIST_LOOP_5_NO_DECLARE(key, value, list,	\
						 tail, len)		\
Lisp_Object tortoise_##key;						\
EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len, tail,		\
		     tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)


#define EXTERNAL_PROPERTY_LIST_LOOP_7(key, value, list, len, hare,	\
                             tortoise, suspicion_length)		\
  for (tortoise = hare = list, len = 0;					\
									\
       ((CONSP (hare) &&						\
	 (key = XCAR (hare),						\
	  hare = XCDR (hare),						\
	  (CONSP (hare) ? 1 :						\
	   (signal_malformed_property_list_error (list), 0)))) ?	\
	(value = XCAR (hare), 1) :					\
	(NILP (hare) ? 0 :						\
	 (signal_malformed_property_list_error (list), 0)));		\
									\
       hare = XCDR (hare),						\
	 ((++len < suspicion_length) ?					\
	  ((void) 0) :							\
	  (((len & 1) ?							\
	    ((void) (tortoise = XCDR (XCDR (tortoise)))) :		\
	    ((void) 0))							\
	   ,								\
	   (EQ (hare, tortoise) ?					\
	    ((void) signal_circular_property_list_error (list)) :	\
	    ((void) 0)))))

#define PRIVATE_PROPERTY_LIST_LOOP_4(tail, key, value, plist)	\
  for (tail = plist;						\
       NILP (tail) ? 0 :					\
	 (key   = XCAR (tail), tail = XCDR (tail),		\
	  value = XCAR (tail), tail = XCDR (tail), 1);		\
       )

#define PROPERTY_LIST_LOOP_3(key, value, plist)			\
  Lisp_Object key, value, tail_##key;				\
  PRIVATE_PROPERTY_LIST_LOOP_4 (tail_##key, key, value, plist)

#define GC_PROPERTY_LIST_LOOP_3(key, value, plist)		\
do {								\
  XGCDECL3 (key);						\
  Lisp_Object key, value, tail_##key;				\
  XGCPRO3 (key, key, value, tail_##key);			\
  PRIVATE_PROPERTY_LIST_LOOP_4 (tail_##key, key, value, plist)

#define END_GC_PROPERTY_LIST_LOOP(key)		\
  XUNGCPRO (key);				\
}						\
while (0)

/* Signal an error if LIST is not properly acyclic and nil-terminated. */
#define CHECK_TRUE_LIST(list) do {			\
  Lisp_Object CTL_list = (list);			\
  Lisp_Object CTL_hare, CTL_tortoise;			\
  EMACS_INT CTL_len;					\
							\
  for (CTL_hare = CTL_tortoise = CTL_list, CTL_len = 0;	\
       CONSP (CTL_hare);				\
       CTL_hare = XCDR (CTL_hare), CTL_len++)		\
    {							\
      if (CTL_len < CIRCULAR_LIST_SUSPICION_LENGTH)	\
	continue;					\
							\
      if (CTL_len & 1)					\
	CTL_tortoise = XCDR (CTL_tortoise);		\
      else if (EQ (CTL_hare, CTL_tortoise))		\
	Fsignal (Qcircular_list, list1 (CTL_list));	\
    }							\
							\
  if (! NILP (CTL_hare))				\
    signal_malformed_list_error (CTL_list);		\
} while (0)

/*------------------------------ string --------------------------------*/


struct Lisp_String
{
  union
    {
      struct lrecord_header lheader;
      struct
	{
	  /* WARNING: Everything before modiffp must agree exactly with
	     struct lrecord_header. (Actually, the `free' field in old-GC
	     overlaps with modiffp there; we can get away with this
	     because in old-GC the `free' field is used only for lcrecords. */
	  unsigned int type :8;
	  unsigned int mark :1;
	  unsigned int c_readonly :1;
	  unsigned int lisp_readonly :1;
#define NUM_ASCII_END_BITS 20
	  /* A flag describing whether this string has ever been
	     modified; the actual modified tick is stored on the plist
	     if and only if this flag is non-zero. */
	  unsigned int modiffp :1;
	  /* Length of the stretch of ASCII (byte_ascii_p) octets at the
	     beginning of the string; equivalently, the byte offset of the
	     first non-ASCII octet in the string. */
	  unsigned int ascii_end :NUM_ASCII_END_BITS;
	} v;
    } u;
  Bytecount size_;
  Ibyte *data_;
  Lisp_Object plist;
};
typedef struct Lisp_String Lisp_String;

#define MAX_STRING_ASCII_END ((1 << NUM_ASCII_END_BITS) - 1)

DECLARE_MODULE_API_LISP_OBJECT (string, Lisp_String);
#define XSTRING(x) XRECORD (x, string, Lisp_String)
#define wrap_string(p) wrap_record (p, string)
#define STRINGP(x) RECORDP (x, string)
#define CHECK_STRING(x) CHECK_RECORD (x, string)
#define CONCHECK_STRING(x) CONCHECK_RECORD (x, string)

/* Most basic macros for strings -- basically just accessing or setting
   fields -- are here.  Everything else is in text.h, since they depend on
   stuff there. */

/* Operations on Lisp_String *'s; only ones left */
#define set_lispstringp_length(s, len) ((void) ((s)->size_ = (len)))
#define set_lispstringp_data(s, ptr) ((void) ((s)->data_ = (ptr)))

/* Operations on strings as Lisp_Objects.  Don't manipulate Lisp_String *'s
   in any new code. */
#define XSTRING_LENGTH(s) (XSTRING (s)->size_)
#define XSTRING_PLIST(s) (XSTRING (s)->plist)
#define XSTRING_DATA(s) (XSTRING (s)->data_ + 0)
#define XSTRING_ASCII_END(s) (XSTRING (s)->u.v.ascii_end + 0)
#define XSET_STRING_LENGTH(s, ptr) set_lispstringp_length (XSTRING (s), ptr)
#define XSET_STRING_DATA(s, ptr) set_lispstringp_data (XSTRING (s), ptr)
/* WARNING: If you modify an existing string, you must call
   bump_string_modiff() afterwards. */
#define XSET_STRING_ASCII_END(s, val) \
  ((void) (XSTRING (s)->u.v.ascii_end = min (val, MAX_STRING_ASCII_END)))
#define XSTRING_FORMAT(s) FORMAT_DEFAULT

#define XSTRING_MODIFFP(s) (XSTRING (s)->u.v.modiffp + 0)
#define XSET_STRING_MODIFFP(s) (XSTRING (s)->u.v.modiffp = 1)
#define XCLEAR_STRING_MODIFFP(s) (XSTRING (s)->u.v.modiffp = 0)

/* Return the true aligned size of a struct whose last member is a
   variable-length array field.  (this is known as the "struct hack") */
/* Implementation: in practice, structtype and fieldtype usually have
   the same alignment, but we can't be sure.  We need to use
   ALIGN_SIZE to be absolutely sure of getting the correct alignment.
   To help the compiler's optimizer, we use a ternary expression that
   only a very stupid compiler would fail to correctly simplify. */
#define FLEXIBLE_ARRAY_STRUCT_SIZEOF(structtype,	\
				     fieldtype,		\
				     fieldname,		\
				     array_length)	\
(ALIGNOF (structtype) == ALIGNOF (fieldtype)		\
 ? (offsetof (structtype, fieldname) +			\
    (offsetof (structtype, fieldname[1]) -		\
     offsetof (structtype, fieldname[0])) *		\
    (array_length))					\
 : (ALIGN_FOR_TYPE					\
    ((offsetof (structtype, fieldname) +		\
      (offsetof (structtype, fieldname[1]) -		\
       offsetof (structtype, fieldname[0])) *		\
      (array_length)),					\
     structtype)))

/*------------------------------ vector --------------------------------*/

struct Lisp_Vector
{
  NORMAL_LISP_OBJECT_HEADER header;
  Elemcount size;
  Lisp_Object contents[1];
};
typedef struct Lisp_Vector Lisp_Vector;

DECLARE_LISP_OBJECT (vector, Lisp_Vector);
#define XVECTOR(x) XRECORD (x, vector, Lisp_Vector)
#define wrap_vector(p) wrap_record (p, vector)
#define VECTORP(x) RECORDP (x, vector)
#define CHECK_VECTOR(x) CHECK_RECORD (x, vector)
#define CONCHECK_VECTOR(x) CONCHECK_RECORD (x, vector)

#define vector_length(v) ((v)->size)
#define XVECTOR_LENGTH(s) vector_length (XVECTOR (s))
#define vector_data(v) ((v)->contents)
#define XVECTOR_DATA(s) vector_data (XVECTOR (s))

/*---------------------------- bit vectors -----------------------------*/

#if (LONGBITS < 16)
#error What the hell?!
#elif (LONGBITS < 32)
# define LONGBITS_LOG2 4
# define LONGBITS_POWER_OF_2 16
#elif (LONGBITS < 64)
# define LONGBITS_LOG2 5
# define LONGBITS_POWER_OF_2 32
#elif (LONGBITS < 128)
# define LONGBITS_LOG2 6
# define LONGBITS_POWER_OF_2 64
#else
#error You really have 128-bit integers?!
#endif

struct Lisp_Bit_Vector
{
  NORMAL_LISP_OBJECT_HEADER lheader;
  Elemcount size;
  unsigned long bits[1];
};
typedef struct Lisp_Bit_Vector Lisp_Bit_Vector;

DECLARE_LISP_OBJECT (bit_vector, Lisp_Bit_Vector);
#define XBIT_VECTOR(x) XRECORD (x, bit_vector, Lisp_Bit_Vector)
#define wrap_bit_vector(p) wrap_record (p, bit_vector)
#define BIT_VECTORP(x) RECORDP (x, bit_vector)
#define CHECK_BIT_VECTOR(x) CHECK_RECORD (x, bit_vector)
#define CONCHECK_BIT_VECTOR(x) CONCHECK_RECORD (x, bit_vector)

#define BITP(x) (FIXNUMP (x) && (XFIXNUM (x) == 0 || XFIXNUM (x) == 1))

#define CHECK_BIT(x) do {		\
  if (!BITP (x))			\
    dead_wrong_type_argument (Qbitp, x);\
} while (0)

#define CONCHECK_BIT(x) do {		\
  if (!BITP (x))			\
    x = wrong_type_argument (Qbitp, x);	\
} while (0)

#define bit_vector_length(v) ((v)->size)

DECLARE_INLINE_HEADER (
int
bit_vector_bit (Lisp_Bit_Vector *v, Elemcount n)
)
{
  return ((v->bits[n >> LONGBITS_LOG2] >> (n & (LONGBITS_POWER_OF_2 - 1)))
	  & 1);
}

DECLARE_INLINE_HEADER (
void
set_bit_vector_bit (Lisp_Bit_Vector *v, Elemcount n, int value)
)
{
  if (value)
    v->bits[n >> LONGBITS_LOG2] |= (1UL << (n & (LONGBITS_POWER_OF_2 - 1)));
  else
    v->bits[n >> LONGBITS_LOG2] &= ~(1UL << (n & (LONGBITS_POWER_OF_2 - 1)));
}

/* Number of longs required to hold LEN bits */
#define BIT_VECTOR_LONG_STORAGE(len) \
  (((len) + LONGBITS_POWER_OF_2 - 1) >> LONGBITS_LOG2)

/* For when we want to include a bit vector in another structure, and we
   know it's of a fixed size. */
#define DECLARE_INLINE_LISP_BIT_VECTOR(numbits) struct {	\
  NORMAL_LISP_OBJECT_HEADER lheader;				        \
  Elemcount size;						\
  unsigned long bits[BIT_VECTOR_LONG_STORAGE(numbits)];		\
}
/*---------------------- array, sequence -----------------------------*/

#define ARRAYP(x) (VECTORP (x) || STRINGP (x) || BIT_VECTORP (x))

#define CHECK_ARRAY(x) do {			\
  if (!ARRAYP (x))				\
    dead_wrong_type_argument (Qarrayp, x);	\
} while (0)

#define CONCHECK_ARRAY(x) do {			\
  if (!ARRAYP (x))				\
    x = wrong_type_argument (Qarrayp, x);	\
} while (0)

#define SEQUENCEP(x) (LISTP (x) || ARRAYP (x))

#define CHECK_SEQUENCE(x) do {			\
  if (!SEQUENCEP (x))				\
    dead_wrong_type_argument (Qsequencep, x);	\
} while (0)

#define CONCHECK_SEQUENCE(x) do {		\
  if (!SEQUENCEP (x))				\
    x = wrong_type_argument (Qsequencep, x);	\
} while (0)

/*------------------------------ symbol --------------------------------*/

typedef struct Lisp_Symbol Lisp_Symbol;
struct Lisp_Symbol
{
  union
  {
    FROB_BLOCK_LISP_OBJECT_HEADER lheader;
    struct
    {
      /* Everything before package_count must agree exactly with struct
         lrecord_header. */
      unsigned int type :8;
      unsigned int mark :1;
      unsigned int c_readonly :1;
      unsigned int lisp_readonly :1;
      /* Number of packages this symbol is interned in, zero, one, or many. */
      unsigned int package_count :2;
      /* ID of the first package this symbol was interned in. Zero is
         uninterned, one is obarray. */
      unsigned int first_package_id :19;
    } v;
  } u;

  Lisp_Object name;
  Lisp_Object value;
  Lisp_Object function;
  Lisp_Object plist;
};

#define IN_OBARRAY(symbol) ((XSYMBOL (symbol)->u.v.first_package_id) == 1)

#define SYMBOL_IS_KEYWORD(sym) (IN_OBARRAY (sym) &&                     \
                                (string_byte (symbol_name (XSYMBOL (sym)), \
                                              0) == ':'))

#define KEYWORDP(obj) (SYMBOLP (obj) && SYMBOL_IS_KEYWORD (obj))

DECLARE_MODULE_API_LISP_OBJECT (symbol, Lisp_Symbol);
#define XSYMBOL(x) XRECORD (x, symbol, Lisp_Symbol)
#define wrap_symbol(p) wrap_record (p, symbol)
#define SYMBOLP(x) RECORDP (x, symbol)
#define CHECK_SYMBOL(x) CHECK_RECORD (x, symbol)
#define CONCHECK_SYMBOL(x) CONCHECK_RECORD (x, symbol)

#define symbol_name(s) ((s)->name)
#define symbol_value(s) ((s)->value)
#define symbol_function(s) ((s)->function)
#define symbol_plist(s) ((s)->plist)

#define XSYMBOL_NAME(s) (XSYMBOL (s)->name)
#define XSYMBOL_VALUE(s) (XSYMBOL (s)->value)
#define XSYMBOL_FUNCTION(s) (XSYMBOL (s)->function)
#define XSYMBOL_PLIST(s) (XSYMBOL (s)->plist)



/*------------------------------- subr ---------------------------------*/

/* A function that takes no arguments and returns a Lisp_Object.
   We could define such types for n arguments, if needed. */
typedef Lisp_Object (*lisp_fn_t) (void);

struct Lisp_Subr
{
  FROB_BLOCK_LISP_OBJECT_HEADER lheader;
  /* The symbol name of the subr. */
  Lisp_Object name;
  /* Either a fixnum (an offset into DOC) or a Lisp string (for functions in
     modules). */
  Lisp_Object doc;
  lisp_fn_t subr_fn;
  /* A Lisp string if this is interactive, Qnil otherwise. */
  Lisp_Object prompt;
  short min_args;
  short max_args;
};
typedef struct Lisp_Subr Lisp_Subr;

DECLARE_LISP_OBJECT (subr, Lisp_Subr);
#define XSUBR(x) XRECORD (x, subr, Lisp_Subr)
#define wrap_subr(p) wrap_record (p, subr)
#define SUBRP(x) RECORDP (x, subr)
#define CHECK_SUBR(x) CHECK_RECORD (x, subr)
#define CONCHECK_SUBR(x) CONCHECK_RECORD (x, subr)

#define subr_function(subr) ((subr)->subr_fn)
#define SUBR_FUNCTION(subr,max_args) \
  ((Lisp_Object (*) (EXFUN_##max_args)) (subr)->subr_fn)
#define subr_name(subr) (XSTRING_DATA (XSYMBOL_NAME (subr)->name))

/*------------------------------ marker --------------------------------*/


typedef struct Lisp_Marker Lisp_Marker;
struct Lisp_Marker
{
  FROB_BLOCK_LISP_OBJECT_HEADER lheader;
  Lisp_Marker *next;
  Lisp_Marker *prev;
  struct buffer *buffer;
  Membpos membpos;
  char insertion_type;
};

DECLARE_MODULE_API_LISP_OBJECT (marker, Lisp_Marker);
#define XMARKER(x) XRECORD (x, marker, Lisp_Marker)
#define wrap_marker(p) wrap_record (p, marker)
#define MARKERP(x) RECORDP (x, marker)
#define CHECK_MARKER(x) CHECK_RECORD (x, marker)
#define CONCHECK_MARKER(x) CONCHECK_RECORD (x, marker)

/* The second check was looking for GCed markers still in use */
/* assert (!FIXNUMP (XMARKER (x)->lheader.next.v)); */

#define marker_next(m) ((m)->next)
#define marker_prev(m) ((m)->prev)

/*-------------------basic int (no connection to char)------------------*/

#define ZEROP(x) EQ (x, Qzero)
#define ONEP(x) EQ (x, Qone)

#ifdef ERROR_CHECK_TYPES

#define XFIXNUM(x) XFIXNUM_1 (x, __FILE__, __LINE__) 

DECLARE_INLINE_HEADER (
EMACS_INT
XFIXNUM_1 (Lisp_Object obj, const Ascbyte *file, int line)
)
{
  assert_at_line (FIXNUMP (obj), file, line);
  return XREALFIXNUM (obj);
}

#else /* not ERROR_CHECK_TYPES */

#define XFIXNUM(obj) XREALFIXNUM (obj)

#endif /* (not) ERROR_CHECK_TYPES */

#define CHECK_FIXNUM(x) do {			\
  if (!FIXNUMP (x))				\
    dead_wrong_type_argument (Qfixnump, x);	\
} while (0)

#define CONCHECK_FIXNUM(x) do {			\
  if (!FIXNUMP (x))				\
    x = wrong_type_argument (Qfixnump, x);	\
} while (0)

/* -------------- properties of internally-formatted text ------------- */

#include "text.h"

/*------------------------------- char ---------------------------------*/

BEGIN_C_DECLS

/* NOTE: There are basic functions for converting between a character and
   the string representation of a character in text.h, as well as lots of
   other character-related stuff.  There are other functions/macros for
   working with Ichars in charset.h, for retrieving the charset of an
   Ichar, the length of an Ichar when converted to text, etc.
*/

#ifdef ERROR_CHECK_TYPES

DECLARE_INLINE_HEADER (
int
CHARP_1 (Lisp_Object obj, const Ascbyte *file, int line)
)
{
  if (XTYPE (obj) != Lisp_Type_Char)
    return 0;
  assert_at_line (valid_ichar_p (XCHARVAL (obj)), file, line);
  return 1;
}

#define CHARP(x) CHARP_1 (x, __FILE__, __LINE__) 

DECLARE_INLINE_HEADER (
Ichar
XCHAR_1 (Lisp_Object obj, const Ascbyte *file, int line)
)
{
  EMACS_INT ch;
  assert_at_line (CHARP (obj), file, line);
  ch = XCHARVAL (obj);
  assert_at_line (valid_ichar_p (ch), file, line);
  return (Ichar) ch;
}

#define XCHAR(x) XCHAR_1 (x, __FILE__, __LINE__) 

#else /* not ERROR_CHECK_TYPES */

#define CHARP(x) (XTYPE (x) == Lisp_Type_Char)
#define XCHAR(x) ((Ichar) XCHARVAL (x))

#endif /* (else) not ERROR_CHECK_TYPES */

#define CONCHECK_CHAR(x) do {			\
 if (!CHARP (x))				\
   x = wrong_type_argument (Qcharacterp, x);	\
 } while (0)

#define CHECK_CHAR(x) do {			\
 if (!CHARP (x))				\
   dead_wrong_type_argument (Qcharacterp, x);	\
 } while (0)


DECLARE_INLINE_HEADER (
Lisp_Object
make_char (Ichar val)
)
{
  ASSERT_VALID_ICHAR (val);
  /* This is defined in lisp-union.h or lisp-disunion.h */
  return make_char_1 (val);
}

/*------------------------- int-char connection ------------------------*/

#ifdef ERROR_CHECK_TYPES

#define XCHAR_OR_FIXNUM(x) XCHAR_OR_FIXNUM_1 (x, __FILE__, __LINE__) 

DECLARE_INLINE_HEADER (
EMACS_INT
XCHAR_OR_FIXNUM_1 (Lisp_Object obj, const Ascbyte *file, int line)
)
{
  assert_at_line (FIXNUMP (obj) || CHARP (obj), file, line);
  return CHARP (obj) ? XCHAR (obj) : XFIXNUM (obj);
}

#else /* no error checking */

/* obj is multiply eval'ed and not an lvalue; use an inline function instead
   of a macro. */
DECLARE_INLINE_HEADER (
EMACS_INT
XCHAR_OR_FIXNUM (Lisp_Object obj)
)
{
  return CHARP (obj) ? XCHAR (obj) : XFIXNUM (obj);
}

#endif /* no error checking */

/* True of X is an integer whose value is the valid integral equivalent of a
   character. */

#define CHAR_INTP(x) (FIXNUMP (x) && valid_ichar_p (XFIXNUM (x)))

/* True of X is a character or an integral value that can be converted into a
   character. */
#define CHAR_OR_CHAR_INTP(x) (CHARP (x) || CHAR_INTP (x))

#define XCHAR_OR_CHAR_INT(x) XCHAR_OR_CHAR_INT_1 (x, __FILE__, __LINE__)

DECLARE_INLINE_HEADER (
Ichar
XCHAR_OR_CHAR_INT_1 (Lisp_Object obj, const Ascbyte *file, int line)
)
{
  if (CHARP (obj))
    {
      return (Ichar) XCHARVAL (obj);
    }
  if (FIXNUMP (obj))
    {
      EMACS_INT ival = XREALFIXNUM (obj);
      if (valid_ichar_p (ival))
	{
	  return (Ichar) ival;
	}
    }
  assert_at_line (CHARP (obj) || CHAR_INTP (obj), file, line);
  return (Ichar) -1;
}

/* Signal an error if CH is not a valid character or integer Lisp_Object.
   If CH is an integer Lisp_Object, convert it to a character Lisp_Object,
   but merely by repackaging, without performing tests for char validity.
   */

#define CHECK_CHAR_COERCE_INT(x) do {		\
  if (CHARP (x))				\
     ;						\
  else if (CHAR_INTP (x))			\
    x = make_char ((Ichar) XREALFIXNUM (x));	\
  else						\
    x = wrong_type_argument (Qcharacterp, x);	\
} while (0)

/* next three always continuable because they coerce their arguments. */
#define CHECK_FIXNUM_COERCE_CHAR(x) do {			\
  if (FIXNUMP (x))						\
    ;							\
  else if (CHARP (x))					\
    x = make_fixnum (XCHAR (x));				\
  else							\
    x = wrong_type_argument (Qinteger_or_char_p, x);	\
} while (0)

#define CHECK_FIXNUM_COERCE_MARKER(x) do {			\
  if (FIXNUMP (x))						\
    ;							\
  else if (MARKERP (x))					\
    x = make_fixnum (marker_position (x));			\
  else							\
    x = wrong_type_argument (Qinteger_or_marker_p, x);	\
} while (0)

#define CHECK_FIXNUM_COERCE_CHAR_OR_MARKER(x) do {			\
  if (FIXNUMP (x))							\
    ;								\
  else if (CHARP (x))						\
    x = make_fixnum (XCHAR (x));					\
  else if (MARKERP (x))						\
    x = make_fixnum (marker_position (x));				\
  else								\
    x = wrong_type_argument (Qinteger_char_or_marker_p, x);	\
} while (0)

/*------------------------------ float ---------------------------------*/

/* Note: the 'unused_next_' field exists only to ensure that the
   `next' pointer fits within the structure, for the purposes of the
   free list.  This makes a difference in the unlikely case of
   sizeof(double) being smaller than sizeof(void *). */

struct Lisp_Float
{
  FROB_BLOCK_LISP_OBJECT_HEADER lheader;
  union { double d; struct Lisp_Float *unused_next_; } data;
};
typedef struct Lisp_Float Lisp_Float;

DECLARE_LISP_OBJECT (float, Lisp_Float);
#define XFLOAT(x) XRECORD (x, float, Lisp_Float)
#define wrap_float(p) wrap_record (p, float)
#define FLOATP(x) RECORDP (x, float)
#define CHECK_FLOAT(x) CHECK_RECORD (x, float)
#define CONCHECK_FLOAT(x) CONCHECK_RECORD (x, float)

#define float_data(f) ((f)->data.d)
#define XFLOAT_DATA(x) float_data (XFLOAT (x))

#define XFLOATFIXNUM(n) extract_float (n)

#define CHECK_FIXNUM_OR_FLOAT(x) do {		\
  if (!FIXNUM_OR_FLOATP (x))			\
    dead_wrong_type_argument (Qnumberp, x);	\
} while (0)

#define CONCHECK_FIXNUM_OR_FLOAT(x) do {		\
  if (!FIXNUM_OR_FLOATP (x))			\
    x = wrong_type_argument (Qnumberp, x);	\
} while (0)

# define FIXNUM_OR_FLOATP(x) (FIXNUMP (x) || FLOATP (x))

#define FLOAT_HASHCODE_FROM_DOUBLE(dbl) (Hashcode)((EMACS_INT) (fmod (dbl, \
                                                                      4e9)))
/* We used to worry about changing FLOAT_HASHCODE_FROM_DOUBLE for 64-bit
   machines. Our hashing algorithm only uses the lower-order bits of the
   Hashcode, and XEmacs hash tables are unlikely to be much bigger than 4 GB,
   limited value to that. */

/*--------------------------- readonly objects -------------------------*/

#define CHECK_C_WRITEABLE(obj)					\
  do { if (c_readonly (obj)) c_write_error (obj); } while (0)

#define C_READONLY(obj) (C_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))

#define CHECK_LISP_WRITEABLE(obj)					\
  do { if (lisp_readonly (obj)) lisp_write_error (obj); } while (0)

#define LISP_READONLY(obj) (LISP_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))

#define SET_LISP_READONLY(obj) (SET_LISP_READONLY_RECORD_HEADER (XRECORD_LHEADER (obj)))

/*----------------------------- structures ----------------------------*/

typedef struct structure_keyword_entry structure_keyword_entry;
struct structure_keyword_entry
{
  Lisp_Object keyword;
  int (*validate) (Lisp_Object keyword, Lisp_Object value,
		   Error_Behavior errb);
};

typedef struct
{
  Dynarr_declare (structure_keyword_entry);
} structure_keyword_entry_dynarr;

typedef struct structure_type structure_type;
struct structure_type
{
  Lisp_Object type;
  structure_keyword_entry_dynarr *keywords;
  int (*validate) (Lisp_Object data, Error_Behavior errb);
  Lisp_Object (*instantiate) (Lisp_Object data);
};

typedef struct
{
  Dynarr_declare (structure_type);
} structure_type_dynarr;

struct structure_type *define_structure_type (Lisp_Object type,
					      int (*validate)
					      (Lisp_Object data,
					       Error_Behavior errb),
					      Lisp_Object (*instantiate)
					      (Lisp_Object data));
void define_structure_type_keyword (struct structure_type *st,
				    Lisp_Object keyword,
				    int (*validate) (Lisp_Object keyword,
						     Lisp_Object value,
						     Error_Behavior errb));

/*--------------------------- ephemerons ----------------------------*/

struct ephemeron 
{
  NORMAL_LISP_OBJECT_HEADER header;

  Lisp_Object key;

  /* This field holds a pair.  The cdr of this cons points to the next
     ephemeron in Vall_ephemerons.  The car points to another pair
     whose car is the value and whose cdr is the finalizer.

     This representation makes it very easy to unlink an ephemeron
     from Vall_ephemerons and chain it into
     Vall_ephemerons_to_finalize. */

  Lisp_Object cons_chain;

  Lisp_Object value;
};

void prune_ephemerons (void);
Lisp_Object ephemeron_value(Lisp_Object ephi);
void init_marking_ephemerons(void);
int continue_marking_ephemerons(void);
int finish_marking_ephemerons(void);
Lisp_Object zap_finalize_list(void);
Lisp_Object make_ephemeron(Lisp_Object key, Lisp_Object value, Lisp_Object finalizer);

DECLARE_LISP_OBJECT(ephemeron, struct ephemeron);
#define XEPHEMERON(x) XRECORD (x, ephemeron, struct ephemeron)
#define XEPHEMERON_REF(x) (XEPHEMERON (x)->value)
#define XEPHEMERON_NEXT(x) (XCDR (XEPHEMERON(x)->cons_chain))
#define XEPHEMERON_FINALIZER(x) (XCDR (XCAR (XEPHEMERON (x)->cons_chain)))
#define XSET_EPHEMERON_NEXT(x, n) (XSETCDR (XEPHEMERON(x)->cons_chain, n))
#define XSET_EPHEMERON_VALUE(x, v) (XEPHEMERON(x)->value = (v))
#define XSET_EPHEMERON_KEY(x, k) (XEPHEMERON(x)->key = (k))
#define wrap_ephemeron(p) wrap_record (p, ephemeron)
#define EPHEMERONP(x) RECORDP (x, ephemeron)
#define CHECK_EPHEMERON(x) CHECK_RECORD (x, ephemeron)
#define CONCHECK_EPHEMERON(x) CONCHECK_RECORD (x, ephemeron)


/*---------------------------- weak lists ------------------------------*/

enum weak_list_type
{
  /* element disappears if it's unmarked. */
  WEAK_LIST_SIMPLE,
  /* element disappears if it's a cons and either its car or
     cdr is unmarked. */
  WEAK_LIST_ASSOC,
  /* element disappears if it's a cons and its car is unmarked. */
  WEAK_LIST_KEY_ASSOC,
  /* element disappears if it's a cons and its cdr is unmarked. */
  WEAK_LIST_VALUE_ASSOC,
  /* element disappears if it's a cons and neither its car nor
     its cdr is marked. */
  WEAK_LIST_FULL_ASSOC
};

struct weak_list
{
  NORMAL_LISP_OBJECT_HEADER header;
  Lisp_Object list; /* don't mark through this! */
  enum weak_list_type type;
  Lisp_Object next_weak; /* don't mark through this! */
};

DECLARE_LISP_OBJECT (weak_list, struct weak_list);
#define XWEAK_LIST(x) XRECORD (x, weak_list, struct weak_list)
#define wrap_weak_list(p) wrap_record (p, weak_list)
#define WEAK_LISTP(x) RECORDP (x, weak_list)
#define CHECK_WEAK_LIST(x) CHECK_RECORD (x, weak_list)
#define CONCHECK_WEAK_LIST(x) CONCHECK_RECORD (x, weak_list)

#define weak_list_list(w) ((w)->list)
#define XWEAK_LIST_LIST(w) (XWEAK_LIST (w)->list)

Lisp_Object make_weak_list (enum weak_list_type type);
/* The following two are only called by the garbage collector */
int finish_marking_weak_lists (void);
void prune_weak_lists (void);


/************************************************************************/
/*	   Definitions of primitive Lisp functions and variables	*/
/************************************************************************/


/* DEFUN - Define a built-in Lisp-visible C function or `subr'.
 `lname' should be the name to give the function in Lisp,
    as a null-terminated C string.
 `Fname' should be the C equivalent of `lname', using only characters
    valid in a C identifier, with an "F" prepended.
    The name of the C constant structure that records information
    on this function for internal use is "S" concatenated with Fname.
 `min_args' should be a number, the minimum number of arguments allowed.
 `max_args' should be a number, the maximum number of arguments allowed,
    or else MANY, KEYWORDS or UNEVALLED.
    MANY means pass a vector of evaluated arguments,
	 in the form of an integer number-of-arguments
	 followed by the address of a vector of Lisp_Objects
	 which contains the argument values.
    KEYWORDS is numerically the same as MANY but tells the C preprocessor to
         make LNAME and MIN_ARGS available to PARSE_KEYWORDS(), and forces the
         name of the number of arguments to be NARGS, and the argument itself
         ARGS. If the subr does not use PARSE_KEYWORDS() (e.g. if it needs to
         do more complicated pprocessing that requires PARSE_KEYWORDS_7()), use
         MANY to suppress warnings.
    UNEVALLED means pass the list of unevaluated arguments.
 `prompt' says how to read arguments for an interactive call.
    See the doc string for `interactive'.
    A null string means call interactively with no arguments.
 `arglist' are the comma-separated arguments (always Lisp_Objects) for
    the function.
  The docstring for the function is placed as a "C" comment between
    the prompt and the `args' argument.  make-docfile reads the
    comment and creates the DOC file from it.
*/

#define EXFUN_0 void
#define EXFUN_1 Lisp_Object
#define EXFUN_2 Lisp_Object,Lisp_Object
#define EXFUN_3 Lisp_Object,Lisp_Object,Lisp_Object
#define EXFUN_4 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
#define EXFUN_5 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
#define EXFUN_6 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
Lisp_Object
#define EXFUN_7 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
Lisp_Object,Lisp_Object
#define EXFUN_8 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
Lisp_Object,Lisp_Object,Lisp_Object
#define EXFUN_MANY int, Lisp_Object*
#define EXFUN_KEYWORDS EXFUN_MANY
#define EXFUN_UNEVALLED Lisp_Object
#define EXFUN(sym, max_args) Lisp_Object sym (EXFUN_##max_args)
#define EXFUN_NORETURN(sym, max_args) \
  DECLARE_DOESNT_RETURN_TYPE (Lisp_Object, sym (EXFUN_##max_args))

#define SUBR_MAX_ARGS 8
#define MANY -2
#define KEYWORDS -2
#define UNEVALLED -1

#define DECLARE_LISP_NAME_0(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_1(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_2(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_3(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_4(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_5(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_6(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_7(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_8(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_MANY(Fname, val) /* Nothing */
#define DECLARE_LISP_NAME_KEYWORDS(Fname, val) static const CIbyte *Fname##_lisp_name = val;
#define DECLARE_LISP_NAME_UNEVALLED(Fname, val) /* Nothing */

#define DECLARE_MIN_ARGS_0(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_1(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_2(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_3(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_4(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_5(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_6(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_7(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_8(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_MANY(Fname, val) /* Nothing */
#define DECLARE_MIN_ARGS_KEYWORDS(Fname, val) static const short Fname##_min_args = val;
#define DECLARE_MIN_ARGS_UNEVALLED(Fname, val) /* Nothing */

#define DEFUN(lname, Fname, min_args, max_args, prompt, arglist)	\
  Lisp_Object Fname (EXFUN_##max_args);					\
  DECLARE_INLINE_HEADER (                                               \
  /* Communicate the args to defsubr() and defsubr_macro()  */          \
  /* by means of an inline function, since recursive macros */          \
  /* don't work in C. This function is local to the file of */          \
  /* DEFUN() and DEFSUBR(), despite the use of */                       \
  /* DECLARE_INLINE_HEADER(). */                                        \
  Lisp_Object                                                           \
  defsubr_##Fname (Boolint macrop))                                     \
  {									\
    if (macrop)                                                         \
      return defsubr_macro (lname, (lisp_fn_t) Fname, min_args,         \
                            max_args,                                   \
                            prompt);                                    \
    return defsubr (lname, (lisp_fn_t) Fname, min_args, max_args,       \
                    prompt);                                            \
  }									\
  DECLARE_MIN_ARGS_##max_args (Fname, min_args)                         \
  DECLARE_LISP_NAME_##max_args (Fname, lname)                           \
  Lisp_Object Fname (DEFUN_##max_args arglist)

#define DEFUN_NORETURN(lname, Fname, min_args, max_args, prompt, arglist) \
  DECLARE_DOESNT_RETURN_TYPE (Lisp_Object, Fname (EXFUN_##max_args));	\
  DECLARE_INLINE_HEADER (                                               \
  Lisp_Object                                                           \
  defsubr_##Fname (Boolint macrop))                                     \
  {									\
    if (macrop)                                                         \
      return defsubr_macro (lname, (lisp_fn_t) Fname, min_args,         \
                            max_args,                                   \
                            prompt);                                    \
    return defsubr (lname, (lisp_fn_t) Fname, min_args, max_args,       \
                    prompt);                                            \
  }									\
  DECLARE_MIN_ARGS_##max_args (Fname, min_args)                         \
  DECLARE_LISP_NAME_##max_args (Fname, lname)                           \
  DOESNT_RETURN_TYPE (Lisp_Object) Fname (DEFUN_##max_args arglist)

/* Heavy ANSI C preprocessor hackery to get DEFUN to declare a
   prototype that matches max_args, and add the obligatory
   `Lisp_Object' type declaration to the formal C arguments.  */

#define DEFUN_MANY(named_int, named_Lisp_Object) named_int, named_Lisp_Object
#define DEFUN_KEYWORDS(named_int, named_Lisp_Object) int nargs, Lisp_Object *args
#define DEFUN_UNEVALLED(args) Lisp_Object args
#define DEFUN_0() void
#define DEFUN_1(a)					Lisp_Object a
#define DEFUN_2(a,b)		 DEFUN_1(a),		Lisp_Object b
#define DEFUN_3(a,b,c)		 DEFUN_2(a,b),		Lisp_Object c
#define DEFUN_4(a,b,c,d)	 DEFUN_3(a,b,c),	Lisp_Object d
#define DEFUN_5(a,b,c,d,e)	 DEFUN_4(a,b,c,d),	Lisp_Object e
#define DEFUN_6(a,b,c,d,e,f)	 DEFUN_5(a,b,c,d,e),	Lisp_Object f
#define DEFUN_7(a,b,c,d,e,f,g)	 DEFUN_6(a,b,c,d,e,f),	Lisp_Object g
#define DEFUN_8(a,b,c,d,e,f,g,h) DEFUN_7(a,b,c,d,e,f,g),Lisp_Object h

/* WARNING: If you add defines here for higher values of max_args,
   make sure to also fix the clauses in PRIMITIVE_FUNCALL(),
   and change the define of SUBR_MAX_ARGS above.  */

END_C_DECLS

#include "symeval.h"

BEGIN_C_DECLS

/* `specpdl' is the special binding/unwind-protect stack.

   Knuth says (see the Jargon File):
   At MIT, `pdl' [abbreviation for `Push Down List'] used to
   be a more common synonym for `stack'.
   Everywhere else `stack' seems to be the preferred term.

   specpdl_depth is the current depth of `specpdl'.
   Save this for use later as arg to `unbind_to_1'.  */
extern MODULE_API int specpdl_depth_counter;
#define specpdl_depth() specpdl_depth_counter


#define CHECK_FUNCTION(fun) do {		\
 while (NILP (Ffunctionp (fun)))		\
   signal_invalid_function_error (fun);		\
 } while (0)

#define CHECK_COMMAND(x) do {                           \
    if (NILP (Fcommandp (x)))                           \
      {                                                 \
        dead_wrong_type_argument (Qcommandp, x);        \
      }                                                 \
  } while (0)

/************************************************************************/
/*                      Parsing keyword arguments                       */
/************************************************************************/

/* The C subr must have been declared with KEYWORDS as its max args, and this
   PARSE_KEYWORDS call must come before any statements. Equivalently, it
   can appear within braces.

   The count of arguments must be declared as nargs, and the argument vector
   must be declared as args; compilation will fail if this is not the case.

   FUNCTION is the C name of the current DEFUN.  If there is no current DEFUN,
   if the current DEFUN has optional arguments that are not keywords, or if
   there are optional arguments that come before the keywords (as Common Lisp
   specifies for #'read-from-string), use PARSE_KEYWORDS_7().

   KEYWORDS is a parenthesised list of the keywords FUNCTION is normally
   prepared to handle, without the initial Q_.

   KEYWORD_DEFAULTS allows you to set non-nil defaults. Put (keywordname =
   initial_value) in this parameter, a collection of C statements surrounded
   by parentheses and separated by the comma operator. If you don't need
   this, supply NULL as KEYWORD_DEFAULTS.

   For keywords which appear multiple times in the called argument list, the
   leftmost one overrides, as specified in section 7.1.1 of the CLHS.

   If you want to check whether a given keyword argument was set (as in the
   SVAR argument to defun*), supply Qunbound as its default in
   KEYWORD_DEFAULTS, and examine it once PARSE_KEYWORDS is done. Lisp code
   cannot supply Qunbound as an argument, so if it is still Qunbound, it was
   not set.

   There is no elegant way with this macro to have one name for the keyword
   and an unrelated name for the local variable, as is possible with the
   ((:keyword unrelated-var)) syntax in defun* and in Common Lisp. That
   shouldn't matter in practice. */
#if defined(ERROR_CHECK_ANY) && defined (__STDC_VERSION__) && \
  __STDC_VERSION__ >= 199901L
/* */
#define PARSE_KEYWORDS_ASSERT_CORRECT_FUNCTION(func)    \
  assert (!strcmp (__func__, #func))
#else
#define PARSE_KEYWORDS_ASSERT_CORRECT_FUNCTION(func) DO_NOTHING
#endif
#define PARSE_KEYWORDS_DEFUN_NAME(function) function##_lisp_name
#define PARSE_KEYWORDS_MIN_ARGS(function) function##_min_args

#define PARSE_KEYWORDS(function, keywords, keyword_defaults)            \
  PARSE_KEYWORDS_7 (intern (PARSE_KEYWORDS_DEFUN_NAME (function)),      \
                    nargs, args, keywords, keyword_defaults,            \
                    PARSE_KEYWORDS_MIN_ARGS (function), 0);             \
  PARSE_KEYWORDS_ASSERT_CORRECT_FUNCTION (function)

/* Count the number of keywords, thank you Dale Weiler. */
#define PARSE_KEYWORDS_ARGC_COUNTER(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, \
                                    N, ...) N
#define PARSE_KEYWORDS_ARGC(...) \
  PARSE_KEYWORDS_EXPAND (PARSE_KEYWORDS_ARGC_COUNTER (__VA_ARGS__, 10, 9, 8, \
                                                      7, 6, 5, 4, 3, 2, 1, 0))

/* Concatenate */
#define PARSE_KEYWORDS_CAT(X, Y) \
    X ## Y
#define PARSE_KEYWORDS_CONCATENATE(X, Y) \
    PARSE_KEYWORDS_CAT(X, Y)

/* Needed to work around difficulties with __VA_ARGS__ and MSVC. */
#define PARSE_KEYWORDS_EXPAND(X) X

/* PARSE_KEYWORDS_7 is a more fine-grained version of PARSE_KEYWORDS. The
   differences are as follows:

   FUNC_SYM is a symbol reflecting the name of the function for which
   keywords are being parsed.  In PARSE_KEYWORDS, it is the Lisp-visible
   name of C_FUNC, interned as a symbol in obarray.

   KEYWORDS_OFFSET is the offset into ARGS where the keyword arguments
   start.  In PARSE_KEYWORDS, this is the index of the first optional
   argument, determined from the information known about C_FUNC.

   ALLOW_OTHER_KEYS corresponds to the &allow-other-keys argument list entry
   in defun*; it is 1 if other keys are normally allowed, 0 otherwise. This
   may be overridden in the caller by specifying :allow-other-keys t in the
   argument list. In PARSE_KEYWORDS, ALLOW_OTHER_KEYS is always 0. */

#define PARSE_KEYWORDS_7(func_sym, nargs, args, keywords,               \
                         keyword_defaults, keywords_offset,             \
                         allow_other_keys)                              \
  PARSE_KEYWORDS_CONCATENATE (DECLARE_N_KEYWORDS_,                      \
                              PARSE_KEYWORDS_ARGC keywords) keywords;   \
                                                                        \
  do                                                                    \
    {                                                                   \
      Lisp_Object pk_key, pk_value;                                     \
      Elemcount pk_i = nargs - 1, pk_offset = keywords_offset;		\
      Boolint pk_allow_other_keys = allow_other_keys;                   \
                                                                        \
      if ((nargs - pk_offset) & 1 && (nargs > pk_offset))               \
        {                                                               \
          if (!allow_other_keys                                         \
              && !(pk_allow_other_keys                                  \
                   = non_nil_allow_other_keys_p (pk_offset,		\
                                                 nargs, args)))         \
            {                                                           \
              signal_wrong_number_of_arguments_error (func_sym, nargs); \
            }                                                           \
          else                                                          \
            {                                                           \
              /* Ignore the trailing arg; so below always sees an even  \
                 number of arguments. */                                \
              pk_i -= 1;                                                \
            }                                                           \
        }                                                               \
                                                                        \
      (void)(keyword_defaults);                                         \
                                                                        \
      /* Start from the end, because the leftmost element overrides. */ \
      while (pk_i > pk_offset)						\
        {                                                               \
          pk_value = args[pk_i--];                                      \
          pk_key = args[pk_i--];                                        \
                                                                        \
          if (0) {}                                                     \
	  PARSE_KEYWORDS_CONCATENATE (CHECK_N_KEYWORDS_,                \
                                      PARSE_KEYWORDS_ARGC               \
                                      keywords) keywords                \
          else if (allow_other_keys || pk_allow_other_keys)             \
            {                                                           \
              continue;                                                 \
            }                                                           \
          else if ((pk_allow_other_keys                                 \
                    = non_nil_allow_other_keys_p (pk_offset,		\
                                                  nargs, args)))        \
            {                                                           \
              continue;                                                 \
            }                                                           \
          else if (EQ (pk_key, Q_allow_other_keys) &&                   \
                   NILP (pk_value))                                     \
            {                                                           \
              continue;                                                 \
            }                                                           \
          else                                                          \
            {                                                           \
              invalid_keyword_argument (func_sym, pk_key);              \
            }                                                           \
        }                                                               \
    } while (0)

#define DECLARE_N_KEYWORDS_1(a)                 \
    Lisp_Object a = Qnil
#define DECLARE_N_KEYWORDS_2(a,b)               \
  DECLARE_N_KEYWORDS_1(a), b = Qnil
#define DECLARE_N_KEYWORDS_3(a,b,c)             \
  DECLARE_N_KEYWORDS_2(a,b), c = Qnil
#define DECLARE_N_KEYWORDS_4(a,b,c,d)           \
  DECLARE_N_KEYWORDS_3(a,b,c), d = Qnil
#define DECLARE_N_KEYWORDS_5(a,b,c,d,e)         \
  DECLARE_N_KEYWORDS_4(a,b,c,d), e = Qnil
#define DECLARE_N_KEYWORDS_6(a,b,c,d,e,f)       \
  DECLARE_N_KEYWORDS_5(a,b,c,d,e), f = Qnil
#define DECLARE_N_KEYWORDS_7(a,b,c,d,e,f,g)     \
  DECLARE_N_KEYWORDS_6(a,b,c,d,e,f), g = Qnil
#define DECLARE_N_KEYWORDS_8(a,b,c,d,e,f,g,h)	\
  DECLARE_N_KEYWORDS_7(a,b,c,d,e,f,g), h = Qnil
#define DECLARE_N_KEYWORDS_9(a,b,c,d,e,f,g,h,i)	\
  DECLARE_N_KEYWORDS_8(a,b,c,d,e,f,g,h), i = Qnil

#define CHECK_N_KEYWORDS_1(a)                                           \
    else if (EQ (pk_key, Q_##a)) { a = pk_value; }
#define CHECK_N_KEYWORDS_2(a,b)             CHECK_N_KEYWORDS_1(a)       \
    else if (EQ (pk_key, Q_##b)) { b = pk_value; }
#define CHECK_N_KEYWORDS_3(a,b,c)           CHECK_N_KEYWORDS_2(a,b)     \
    else if (EQ (pk_key, Q_##c)) { c = pk_value; }
#define CHECK_N_KEYWORDS_4(a,b,c,d)         CHECK_N_KEYWORDS_3(a,b,c)   \
    else if (EQ (pk_key, Q_##d)) { d = pk_value; }
#define CHECK_N_KEYWORDS_5(a,b,c,d,e)       CHECK_N_KEYWORDS_4(a,b,c,d) \
    else if (EQ (pk_key, Q_##e)) { e = pk_value; }
#define CHECK_N_KEYWORDS_6(a,b,c,d,e,f)     CHECK_N_KEYWORDS_5(a,b,c,d,e) \
    else if (EQ (pk_key, Q_##f)) { f = pk_value; }
#define CHECK_N_KEYWORDS_7(a,b,c,d,e,f,g)   CHECK_N_KEYWORDS_6(a,b,c,d,e,f) \
    else if (EQ (pk_key, Q_##g)) { g = pk_value; }
#define CHECK_N_KEYWORDS_8(a,b,c,d,e,f,g,h)		\
  CHECK_N_KEYWORDS_7(a,b,c,d,e,f,g)			\
  else if (EQ (pk_key, Q_##h)) { h = pk_value; }
#define CHECK_N_KEYWORDS_9(a,b,c,d,e,f,g,h,i)		\
  CHECK_N_KEYWORDS_8(a,b,c,d,e,f,g,h)			\
  else if (EQ (pk_key, Q_##i)) { i = pk_value; }

Boolint non_nil_allow_other_keys_p (Elemcount offset, int nargs,
                                    Lisp_Object *args);


/************************************************************************/
/*			   Checking for QUIT				*/
/************************************************************************/

/* NOTE NOTE NOTE: Invoking QUIT can cause random Lisp code to be executed!
   This can happen in numerous ways.  For example, on many platforms, QUIT
   needs to drain the event queue to see whether there's a C-g in the works.
   A side effect of this is that, if there's a menu-press event, menu filters
   (i.e. Lisp code) will be invoked.  Lisp code could also happen if there's
   an asynchronous timeout, or if the debugger is invoked as a result of
   debug-on-quit and the user returns by hitting `r', etc. etc.

   However, GC CANNOT HAPPEN.  It is forbidden everywhere within the QUIT-
   processing code, because most callers cannot tolerate GC during QUIT
   since it's just too prevalent. */

/* The exact workings of this mechanism are described in detail in signal.c. */

/* Asynchronous events set something_happened, and then are processed
   within the QUIT macro.  At this point, we are guaranteed to not be in
   any sensitive code. */

extern MODULE_API volatile int something_happened;
extern MODULE_API int dont_check_for_quit;
MODULE_API void check_what_happened (void);

extern MODULE_API volatile int quit_check_signal_happened;
extern volatile int quit_check_signal_tick_count;
MODULE_API void check_quit (void);

MODULE_API void signal_quit (void);

int begin_dont_check_for_quit (void);
int begin_do_check_for_quit (void);

/* Nonzero if the values of `quit-flag' and `inhibit-quit' indicate
   that a quit should be signalled. */
#define QUIT_FLAG_SAYS_SHOULD_QUIT				\
  (!NILP (Vquit_flag) &&					\
   (NILP (Vinhibit_quit)					\
    || (EQ (Vquit_flag, Qcritical) && !dont_check_for_quit)))

/* Nonzero if ought to quit now.  This is the "efficient" version, which
   respects the flags set to indicate whether the full quit check should
   be done.  Therefore it may be inaccurate (i.e. lagging reality), esp.
   when poll for quit is used.

   This is defined for code that wants to allow quitting, but needs to
   do some cleanup if that happens. (You could always register the cleanup
   code using record_unwind_protect(), but sometimes it makes more sense
   to do it using QUITP.) To use this macro, just call it at the
   appropriate time, and if its value is non-zero, do your cleanup code
   and then call QUIT.

   A different version (below) is used for the actual QUIT macro.  */
#define QUITP							\
  ((quit_check_signal_happened ? check_quit () : (void) 0),	\
   QUIT_FLAG_SAYS_SHOULD_QUIT)

/* This is the version actually called by QUIT.  The difference
   between it and QUITP is that it also has side effects in that it
   will handle anything else that has recently signalled itself
   asynchronously and wants to be handled now.  Currently this
   includes executing asynchronous timeouts that may have been set
   from Lisp or from the poll-for-quit or poll-for-sigchld
   timers. (#### It seems that, to be slightly more accurate, we
   should also process poll-for-quit timers in the above version.
   However, this mechanism is inherently approximate, so it really
   doesn't matter much.) In the future, it might also include doing a
   thread context switch.  Callers of QUITP generally don't except
   random side effects to happen (#### unfortunately, random side effects
   can happen anyway, e.g. through menu filters -- see comment above),
   so we have this different version. */
#define INTERNAL_QUITP						\
  ((something_happened ? check_what_happened () : (void) 0),	\
   QUIT_FLAG_SAYS_SHOULD_QUIT)

/* Check quit-flag and quit if it is non-nil.  Also do any other things
   that are triggered by asynchronous events and might want to be
   handled. */
#define QUIT do { if (INTERNAL_QUITP) signal_quit (); } while (0)


/************************************************************************/
/*				 hashing				*/
/************************************************************************/

#if SIZEOF_EMACS_INT < 8
#define GOOD_HASH ((Hashcode) 65599) /* prime number just over 2^16;
					Dragon book, p. 435 */

#else
#define GOOD_HASH ((Hashcode) 4294967311UL) /* prime number just over 2^32 */
#endif

#define HASH2(a,b)               (GOOD_HASH * (a)                     + (b))
#define HASH3(a,b,c)             (GOOD_HASH * HASH2 (a,b)             + (c))
#define HASH4(a,b,c,d)           (GOOD_HASH * HASH3 (a,b,c)           + (d))
#define HASH5(a,b,c,d,e)         (GOOD_HASH * HASH4 (a,b,c,d)         + (e))
#define HASH6(a,b,c,d,e,f)       (GOOD_HASH * HASH5 (a,b,c,d,e)       + (f))
#define HASH7(a,b,c,d,e,f,g)     (GOOD_HASH * HASH6 (a,b,c,d,e,f)     + (g))
#define HASH8(a,b,c,d,e,f,g,h)   (GOOD_HASH * HASH7 (a,b,c,d,e,f,g)   + (h))
#define HASH9(a,b,c,d,e,f,g,h,i) (GOOD_HASH * HASH8 (a,b,c,d,e,f,g,h) + (i))

#define LISP_HASH(obj) ((Hashcode) STORE_LISP_IN_VOID (obj))
Hashcode memory_hash (const void *xv, Bytecount size);
Hashcode internal_hash (Lisp_Object obj, int depth, Boolint equalp);
Hashcode internal_array_hash (Lisp_Object *arr, Elemcount size, int depth,
                              Boolint equalp);


/************************************************************************/
/*		     Garbage collection / GC-protection			*/
/************************************************************************/

/* Structure for recording stack slots that need marking */

/* This is a chain of structures, each of which points at a Lisp_Object
   variable whose value should be marked in garbage collection.
   Normally every link of the chain is an automatic variable of a function,
   and its `val' points to some argument or local variable of the function.
   On exit to the function, the chain is set back to the value it had on
   entry.  This way, no link remains in the chain when the stack frame
   containing the link disappears.

   Every function that can call Feval must protect in this fashion all
   Lisp_Object variables whose contents will be used again. */

extern MODULE_API struct gcpro *gcprolist;

END_C_DECLS

/* #### Catching insufficient gcpro:

   The C++ code below catches GCPRO without UNGCPRO or vice-versa.
   Catching cases where there's no GCPRO or UNGCPRO but should be, however,
   is much harder, but could be done:

   1. Lisp_Object becomes a real object.  Its creator and destructor need to
      figure out whether the object is on the stack (by looking at the range
      that `this' is within), and if so, add the pointer to a list of all
      stack-based Lisp_Objects.

   2. The assignment method needs to do reference-counting on actual Lisp
      objects -- in particular, we need to know if there are any references
      to a Lisp object that are *NOT* from stack-based Lisp_Objects.

   3. When we get to a point in the code where we might garbage collect --
      i.e. Ffuncall(), Feval(), or Fgarbage_collect() is called -- we look
      at our list of stack-based Lisp_Objects, and if there are any that
      point to Lisp objects with no non-stack references, see if there are
      any gcpros pointing to the object, and if not, set a flag indicating
      that the object is "destroyed". (Don't abort yet because the function
      might not use the object any more.)

   4. When we detag a pointer using XFOO(), abort if its "destroyed" flag
      is set.

   --ben
*/

struct gcpro
{
  struct gcpro *next;
  const Lisp_Object *var;	/* Address of first protected variable */
  Elemcount nvars;		/* Number of consecutive protected variables */
#if defined (__cplusplus) && defined (ERROR_CHECK_GC)
  /* Try to catch GCPRO without UNGCPRO, or vice-versa.  G++ complains (at
     least with sufficient numbers of warnings enabled, i.e. -Weffc++) if a
     copy constructor or assignment operator is not defined. */
  gcpro () : next (0), var (0), nvars (0) { }
  gcpro (const gcpro& g) : next (g.next), var (g.var), nvars (g.nvars) { }
  gcpro& operator= (const gcpro& g) { next = g.next; var = g.var;
				      nvars = g.nvars;
				      return *this;}
  ~gcpro () { assert (!next); }
#endif /* defined (__cplusplus) && defined (ERROR_CHECK_GC) */
};

/* Normally, you declare variables gcpro1, gcpro2, ... and use the
   GCPROn() macros.  However, if you need to have nested gcpro's,
   declare ngcpro1, ngcpro2, ... and use NGCPROn().  If you need
   to nest another level, use nngcpro1, nngcpro2, ... and use
   NNGCPROn().  If you need to nest yet another level, create
   the appropriate macros. */

/* NOTE: About comments like "This function does not GC": These are there to
   try to track whether GCPROing is necessary.  Strictly speaking, some
   functions that say this might actually GC, but only when it is never
   possible to return (more specifically, in the process of signalling an
   error, the debugger may be invoked, and could GC).  For GCPRO purposes,
   you only have to worry about functions that can GC and then return.
   The QUIT macro cannot GC any more, although this wasn't true at some point,
   and so some "This function can GC" comments may be inaccurate.
*/

BEGIN_C_DECLS

#define XGCDECL1(x) struct gcpro x##cpro1
#define XGCDECL2(x) struct gcpro x##cpro1, x##cpro2
#define XGCDECL3(x) struct gcpro x##cpro1, x##cpro2, x##cpro3
#define XGCDECL4(x) struct gcpro x##cpro1, x##cpro2, x##cpro3, x##cpro4
#define XGCDECL5(x) struct gcpro x##cpro1, x##cpro2, x##cpro3, x##cpro4, x##cpro5

#ifdef DEBUG_GCPRO

MODULE_API void debug_gcpro1 (Ascbyte *, int, struct gcpro *, Lisp_Object *);
MODULE_API void debug_gcpro2 (Ascbyte *, int, struct gcpro *, struct gcpro *,
			      Lisp_Object *, Lisp_Object *);
MODULE_API void debug_gcpro3 (Ascbyte *, int, struct gcpro *, struct gcpro *,
			      struct gcpro *, Lisp_Object *, Lisp_Object *,
			      Lisp_Object *);
MODULE_API void debug_gcpro4 (Ascbyte *, int, struct gcpro *, struct gcpro *,
			      struct gcpro *, struct gcpro *, Lisp_Object *,
			      Lisp_Object *, Lisp_Object *, Lisp_Object *);
MODULE_API void debug_gcpro5 (Ascbyte *, int, struct gcpro *, struct gcpro *,
			      struct gcpro *, struct gcpro *, struct gcpro *,
			      Lisp_Object *, Lisp_Object *, Lisp_Object *,
			      Lisp_Object *, Lisp_Object *);
MODULE_API void debug_ungcpro(Ascbyte *, int, struct gcpro *);

#define XGCPRO1(x,v)							\
 debug_gcpro1 (__FILE__, __LINE__,&x##cpro1,&v)
#define XGCPRO2(x,v1,v2)						\
 debug_gcpro2 (__FILE__, __LINE__,&x##cpro1,&x##cpro2,&v1,&v2)
#define XGCPRO3(x,v1,v2,v3)						\
 debug_gcpro3 (__FILE__, __LINE__,&x##cpro1,&x##cpro2,&x##cpro3,	\
	       &v1,&v2,&v3)
#define XGCPRO4(x,v1,v2,v3,v4)						\
 debug_gcpro4 (__FILE__, __LINE__,&x##cpro1,&x##cpro2,&x##cpro3,	\
	       &x##cpro4,						\
	       &v1,&v2,&v3,&v4)
#define XGCPRO5(x,v1,v2,v3,v4,v5)					\
 debug_gcpro5 (__FILE__, __LINE__,&x##cpro1,&x##cpro2,&x##cpro3,	\
	       &x##cpro4,&x##cpro5,					\
	       &v1,&v2,&v3,&v4,&v5)
#define XUNGCPRO(x) \
 debug_ungcpro(__FILE__, __LINE__,&x##cpro1)

#else /* ! DEBUG_GCPRO */

#define XGCPRO1(x, var1) XGCPRO1_ARRAY (x, &var1, 1)
#define XGCPRO2(x, var1, var2) XGCPRO2_ARRAY (x, &var1, 1, &var2, 1)
#define XGCPRO3(x, var1, var2, var3)                    \
  XGCPRO3_ARRAY (x, &var1, 1, &var2, 1, &var3, 1)
#define XGCPRO4(x, var1, var2, var3, var4)                      \
  XGCPRO4_ARRAY (x, &var1, 1, &var2, 1, &var3, 1, &var4, 1)
#define XGCPRO5(x, var1, var2, var3, var4, var5)                        \
  XGCPRO5_ARRAY (x, &var1, 1, &var2, 1, &var3, 1, &var4, 1, &var5, 1)

#define XGCPRO1_ARRAY(x, array, n)                                      \
  do                                                                    \
    {                                                                   \
      x##cpro1.next = gcprolist, x##cpro1.var = array,                  \
        x##cpro1.nvars = n;                                             \
      PRAGMA_PUSH_DIAGNOSTICS;                                          \
      PRAGMA_IGNORE_DANGLING_POINTER;                                   \
      gcprolist = &x##cpro1;                                            \
      PRAGMA_POP_DIAGNOSTICS;                                           \
    }                                                                   \
  while (0)

#define XGCPRO2_ARRAY(x, array1, n1, array2, n2)                        \
  do                                                                    \
    {                                                                   \
      x##cpro1.next = gcprolist, x##cpro1.var = array1,                 \
        x##cpro1.nvars = n1;                                            \
      x##cpro2.next = &x##cpro1, x##cpro2.var = array2,                 \
        x##cpro2.nvars = n2;                                            \
      PRAGMA_PUSH_DIAGNOSTICS;                                          \
      PRAGMA_IGNORE_DANGLING_POINTER;                                   \
      gcprolist = &x##cpro2;                                            \
      PRAGMA_POP_DIAGNOSTICS;                                           \
    }                                                                   \
  while (0)

#define XGCPRO3_ARRAY(x, array1, n1, array2, n2, array3, n3)            \
  do                                                                    \
    {                                                                   \
      x##cpro1.next = gcprolist, x##cpro1.var = array1,                 \
        x##cpro1.nvars = n1;                                            \
      x##cpro2.next = &x##cpro1, x##cpro2.var = array2,                 \
        x##cpro2.nvars = n2;                                            \
      x##cpro3.next = &x##cpro2, x##cpro3.var = array3,                 \
        x##cpro3.nvars = n3;                                            \
      PRAGMA_PUSH_DIAGNOSTICS;                                          \
      PRAGMA_IGNORE_DANGLING_POINTER;                                   \
      gcprolist = &x##cpro3;                                            \
      PRAGMA_POP_DIAGNOSTICS;                                           \
    }                                                                   \
  while (0)

#define XGCPRO4_ARRAY(x, array1, n1, array2, n2, array3, n3,            \
                      array4, n4)                                       \
  do                                                                    \
    {                                                                   \
      x##cpro1.next = gcprolist, x##cpro1.var = array1,                 \
        x##cpro1.nvars = n1;                                            \
      x##cpro2.next = &x##cpro1, x##cpro2.var = array2,                 \
        x##cpro2.nvars = n2;                                            \
      x##cpro3.next = &x##cpro2, x##cpro3.var = array3,                 \
        x##cpro3.nvars = n3;                                            \
      x##cpro4.next = &x##cpro3, x##cpro4.var = array4,                 \
        x##cpro4.nvars = n4;                                            \
      PRAGMA_PUSH_DIAGNOSTICS;                                          \
      PRAGMA_IGNORE_DANGLING_POINTER;                                   \
      gcprolist = &x##cpro4;                                            \
      PRAGMA_POP_DIAGNOSTICS;                                           \
    }                                                                   \
  while (0)

#define XGCPRO5_ARRAY(x, array1, n1, array2, n2, array3, n3,            \
                      array4, n4, array5, n5)                           \
  do                                                                    \
    {                                                                   \
      x##cpro1.next = gcprolist, x##cpro1.var = array1,                 \
        x##cpro1.nvars = n1;                                            \
      x##cpro2.next = &x##cpro1, x##cpro2.var = array2,                 \
        x##cpro2.nvars = n2;                                            \
      x##cpro3.next = &x##cpro2, x##cpro3.var = array3,                 \
        x##cpro3.nvars = n3;                                            \
      x##cpro4.next = &x##cpro3, x##cpro4.var = array4,                 \
        x##cpro4.nvars = n4;                                            \
      x##cpro5.next = &x##cpro4, x##cpro5.var = array5,                 \
        x##cpro5.nvars = n5;                                            \
      PRAGMA_PUSH_DIAGNOSTICS;                                          \
      PRAGMA_IGNORE_DANGLING_POINTER;                                   \
      gcprolist = &x##cpro5;                                            \
      PRAGMA_POP_DIAGNOSTICS;                                           \
    }                                                                   \
  while (0)

#if defined (__cplusplus) && defined (ERROR_CHECK_GC)
/* We need to reset each gcpro to avoid triggering the assert() in
   ~gcpro().  This happens in UNGCPRO and longjmp(). */
#define UNWIND_GCPRO_TO(val)						   \
do									   \
{									   \
  struct gcpro *__gcpro_stop = (val);					   \
  /* Try to catch UNGCPRO without GCPRO.  We arrange for there to be a	   \
     sentinel at the end of the gcprolist, so it should never be NULL. */  \
  assert (__gcpro_stop);						   \
  while (gcprolist != __gcpro_stop)					   \
    {									   \
      struct gcpro *__gcpro_next = gcprolist->next;			   \
      gcprolist->next = 0;						   \
      gcprolist = __gcpro_next;						   \
      assert (gcprolist);						   \
    }									   \
} while (0)

/* Set GCPROLIST to NULL, avoiding assertion failure when error checking. Used
   within run-emacs-from-temacs before longjmp invalidates the stack. */
#define RESET_GCPROLIST()                       \
  do                                            \
    {                                           \
      struct gcpro *tail = gcprolist;           \
      while (tail && tail->next != NULL)        \
        {                                       \
          tail = tail->next;                    \
        }                                       \
      UNWIND_GCPRO_TO (tail);                   \
    } while (0)
#else
#define UNWIND_GCPRO_TO(val) (gcprolist = (val))
#define RESET_GCPROLIST() (gcprolist = NULL)
#endif /* defined (__cplusplus) && defined (ERROR_CHECK_GC) */

#define XUNGCPRO(x) UNWIND_GCPRO_TO (x##cpro1.next)

#endif /* ! DEBUG_GCPRO */

#define GCDECL1 XGCDECL1 (g)
#define GCDECL2 XGCDECL2 (g)
#define GCDECL3 XGCDECL3 (g)
#define GCDECL4 XGCDECL4 (g)
#define GCDECL5 XGCDECL5 (g)

#define GCPRO1(a) XGCPRO1 (g,a)
#define GCPRO2(a,b) XGCPRO2 (g,a,b)
#define GCPRO3(a,b,c) XGCPRO3 (g,a,b,c)
#define GCPRO4(a,b,c,d) XGCPRO4 (g,a,b,c,d)
#define GCPRO5(a,b,c,d,e) XGCPRO5 (g,a,b,c,d,e)

#define GCPRO1_ARRAY(a1,n1) XGCPRO1_ARRAY(g,a1,n1)
#define GCPRO2_ARRAY(a1,n1,a2,n2) XGCPRO2_ARRAY (g,a1,n1,a2,n2)
#define GCPRO3_ARRAY(a1,n1,a2,n2,a3,n3) XGCPRO3_ARRAY (g,a1,n1,a2,n2,a3,n3)

#define UNGCPRO XUNGCPRO (g)

#define NGCDECL1 XGCDECL1 (ng)
#define NGCDECL2 XGCDECL2 (ng)
#define NGCDECL3 XGCDECL3 (ng)
#define NGCDECL4 XGCDECL4 (ng)
#define NGCDECL5 XGCDECL5 (ng)

#define NGCPRO1(a) XGCPRO1 (ng,a)
#define NGCPRO2(a,b) XGCPRO2 (ng,a,b)
#define NGCPRO3(a,b,c) XGCPRO3 (ng,a,b,c)
#define NGCPRO4(a,b,c,d) XGCPRO4 (ng,a,b,c,d)
#define NGCPRO5(a,b,c,d,e) XGCPRO5 (ng,a,b,c,d,e)

#define NGCPRO1_ARRAY(a1,n1) XGCPRO1_ARRAY(ng,a1,n1)
#define NGCPRO2_ARRAY(a1,n1,a2,n2) XGCPRO2_ARRAY (ng,a1,n1,a2,n2)
#define NGCPRO3_ARRAY(a1,n1,a2,n2,a3,n3) XGCPRO3_ARRAY (ng,a1,n1,a2,n2,a3,n3)

#define NUNGCPRO XUNGCPRO (ng)

#define NNGCDECL1 XGCDECL1 (nng)
#define NNGCDECL2 XGCDECL2 (nng)
#define NNGCDECL3 XGCDECL3 (nng)
#define NNGCDECL4 XGCDECL4 (nng)
#define NNGCDECL5 XGCDECL5 (nng)

#define NNGCPRO1(a) XGCPRO1 (nng,a)
#define NNGCPRO2(a,b) XGCPRO2 (nng,a,b)
#define NNGCPRO3(a,b,c) XGCPRO3 (nng,a,b,c)
#define NNGCPRO4(a,b,c,d) XGCPRO4 (nng,a,b,c,d)
#define NNGCPRO5(a,b,c,d,e) XGCPRO5 (nng,a,b,c,d,e)

#define NNGCPRO1_ARRAY(a1,n1) XGCPRO1_ARRAY(nng,a1,n1)
#define NNGCPRO2_ARRAY(a1,n1,a2,n2) XGCPRO2_ARRAY (nng,a1,n1,a2,n2)
#define NNGCPRO3_ARRAY(a1,n1,a2,n2,a3,n3) XGCPRO3_ARRAY (nng,a1,n1,a2,n2,a3,n3)

#define NNUNGCPRO XUNGCPRO (nng)

/* Evaluate expr, UNGCPRO, and then return the value of expr.  */
#define RETURN_UNGCPRO(expr) do		\
{					\
  Lisp_Object ret_ungc_val = (expr);	\
  UNGCPRO;				\
  RETURN_SANS_WARNINGS ret_ungc_val;	\
} while (0)

/* Evaluate expr, NUNGCPRO, UNGCPRO, and then return the value of expr.  */
#define RETURN_NUNGCPRO(expr) do	\
{					\
  Lisp_Object ret_ungc_val = (expr);	\
  NUNGCPRO;				\
  UNGCPRO;				\
  RETURN_SANS_WARNINGS ret_ungc_val;	\
} while (0)

/* Evaluate expr, NNUNGCPRO, NUNGCPRO, UNGCPRO, and then return the
   value of expr.  */
#define RETURN_NNUNGCPRO(expr) do	\
{					\
  Lisp_Object ret_ungc_val = (expr);	\
  NNUNGCPRO;				\
  NUNGCPRO;				\
  UNGCPRO;				\
  RETURN_SANS_WARNINGS ret_ungc_val;	\
} while (0)

extern Lisp_Object_ptr_dynarr *staticpros;
extern Lisp_Object_ptr_dynarr *staticpros_nodump;

/* Call staticpro (&var) to protect static variable `var'. */
MODULE_API void staticpro (Lisp_Object *);

/* Call staticpro_nodump (&var) to protect static variable `var'. */
/* var will not be saved at dump time */
MODULE_API void staticpro_nodump (Lisp_Object *);

#ifdef HAVE_SHLIB
/* Call unstaticpro_nodump (&var) to stop protecting static variable `var'. */
MODULE_API void unstaticpro_nodump (Lisp_Object *);
#endif

/* Call staticpro_dump_nil (&var) to protect static variable VAR pre-dump.
   Post pdump_load(), ensure that it is protected via STATICPROS but that its
   initial value is Qnil. Useful for variables like Vbuffer_alist where the
   value is guaranteed to be distinct at dump time and at run time. Do not
   call it after pdump_load(), you will crash.  */
void staticpro_dump_nil (Lisp_Object *);

void register_post_gc_action (void (*fun) (void *), void *arg);
int begin_gc_forbidden (void);
void end_gc_forbidden (int count);
extern int gc_currently_forbidden;

END_C_DECLS


/************************************************************************/
/*		              Misc definitions        	                */
/************************************************************************/

/************************************************************************/
/*		             Other numeric types      	                */
/************************************************************************/
#include "number.h"


/************************************************************************/
/*                              prototypes                              */
/************************************************************************/

/* NOTE: Prototypes should go HERE, not in various header files, unless
   they specifically reference a type that's not defined in lisp.h.
   (And even then, you might consider adding the type to lisp.h.)

   The idea is that header files typically contain the innards of objects,
   and we want to minimize the number of "dependencies" of one file on
   the specifics of such objects.  Putting prototypes here minimizes the
   number of header files that need to be included -- good for a number
   of reasons. --ben */

/* Prototypes for all init/syms_of/vars_of initialization functions. */
#include "symsinit.h"

BEGIN_C_DECLS

/* Defined in abbrev.c */
MODULE_API EXFUN (Fexpand_abbrev, 0);

/* Defined in alloc.c */
MODULE_API EXFUN (Fcons, 2);
MODULE_API EXFUN (Flist, MANY);
MODULE_API EXFUN (Facons, 3);
EXFUN (Fbit_vector, MANY);
EXFUN (Fmake_byte_code, MANY);
MODULE_API EXFUN (Fmake_list, 2);
MODULE_API EXFUN (Fmake_string, 2);
EXFUN (Fstring, MANY);
MODULE_API EXFUN (Fmake_symbol, 1);
MODULE_API EXFUN (Fmake_vector, 2);
MODULE_API EXFUN (Fvector, MANY);

void deadbeef_memory (void *ptr, Bytecount size);
void release_breathing_space (void);
Lisp_Object noseeum_cons (Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object make_vector (Elemcount, Lisp_Object);
MODULE_API Lisp_Object vector1 (Lisp_Object);
MODULE_API Lisp_Object vector2 (Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object vector3 (Lisp_Object, Lisp_Object, Lisp_Object);
Lisp_Object make_uninit_vector (Elemcount);
Lisp_Object make_bit_vector (Elemcount, Lisp_Object);
Lisp_Object make_bit_vector_from_byte_vector (unsigned char *, Elemcount);
Lisp_Object clone_bit_vector (Lisp_Object bitvec);
Lisp_Object make_subr (void);
Lisp_Object noseeum_make_marker (void);
void garbage_collect_1 (void);
MODULE_API Lisp_Object cons3 (Lisp_Object, Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object list1 (Lisp_Object);
MODULE_API Lisp_Object list2 (Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object);
MODULE_API Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object list6 (Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object, Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object listn (int numargs, ...);
MODULE_API Lisp_Object listu (Lisp_Object, ...);
DECLARE_DOESNT_RETURN (memory_full (void));
void disksave_object_finalization (void);
void finish_object_memory_usage_stats (void);
extern int purify_flag;

/* ALLOC_SIZED_LISP_OBJECT() takes a signed Bytecount, and so the limitation
   on the size of a vector is that number that would cause a signed Bytecount
   to overflow, when plugged into FLEXIBLE_ARRAY_STRUCT_SIZEOF(). */
#define ARRAY_DIMENSION_LIMIT ((MOST_POSITIVE_FIXNUM / sizeof (Lisp_Object)) \
                               - (offsetof (Lisp_Vector, contents)      \
                                  / sizeof (Lisp_Object)) + 1)

/* String lengths are less restrictive, since there's no multiplication needed
   in the calculation of the Bytecount. This is an exclusive bound. */
#define STRING_BYTE_TOTAL_SIZE_LIMIT (MOST_POSITIVE_FIXNUM + 1)

/* This could be even less restrictive than its string counterpart. We would
   need to allow bignum string indices for that, which we currently reject in
   #'aset, #'aref. */
#define BIT_VECTOR_TOTAL_SIZE_LIMIT (MOST_POSITIVE_FIXNUM + 1)

extern Fixnum Varray_dimension_limit, Vstring_total_size_limit;

extern EMACS_INT gc_generation_number[1];
int c_readonly (Lisp_Object);
int lisp_readonly (Lisp_Object);
MODULE_API Lisp_Object build_istring (const Ibyte *);
MODULE_API Lisp_Object build_cistring (const CIbyte *);
MODULE_API Lisp_Object build_ascstring (const Ascbyte *);
MODULE_API Lisp_Object build_extstring (const Extbyte *, Lisp_Object);
MODULE_API Lisp_Object make_string (const Ibyte *, Bytecount);
MODULE_API Lisp_Object make_extstring (const Extbyte *, EMACS_INT, Lisp_Object);
void init_string_ascii_end (Lisp_Object string);
Lisp_Object make_uninit_string (Bytecount);
void bump_string_modiff (Lisp_Object);
struct extent_info *string_extent_info (Lisp_Object);
MODULE_API Lisp_Object make_float (double);
Lisp_Object make_string_nocopy (const Ibyte *, Bytecount);
void free_cons (Lisp_Object);
void free_list (Lisp_Object);
void free_alist (Lisp_Object);
void free_marker (Lisp_Object);
int object_dead_p (Lisp_Object);
void mark_object (Lisp_Object obj);
int marked_p (Lisp_Object obj);
extern int funcall_allocation_flag;
extern int need_to_garbage_collect;
extern MODULE_API int need_to_check_c_alloca;
extern int need_to_signal_post_gc;
extern Lisp_Object Qpost_gc_hook, Qgarbage_collecting;
void recompute_funcall_allocation_flag (void);

Bytecount malloced_storage_size (void *, Bytecount, struct usage_stats *);


/* Defined in array.c */
extern const struct sized_memory_description int_dynarr_description;
extern const struct sized_memory_description unsigned_char_description;
extern const struct sized_memory_description unsigned_char_dynarr_description;
extern const struct sized_memory_description Lisp_Object_dynarr_description;
extern const struct sized_memory_description Lisp_Object_pair_dynarr_description;


/* Defined in buffer.c */
Lisp_Object get_truename_buffer (Lisp_Object);
Lisp_Object generated_modeline_stringp (Lisp_Object);
void switch_to_buffer (Lisp_Object, Lisp_Object);
extern int find_file_compare_truenames;
extern int find_file_use_truenames;
Ibyte *get_initial_directory (Ibyte *pathname, Bytecount size);
void set_buffer_internal (struct buffer *b);
struct buffer *decode_buffer (Lisp_Object buffer, int allow_string);

void record_buffer (Lisp_Object buf);
Lisp_Object get_buffer (Lisp_Object name,
			int error_if_deleted_or_does_not_exist);
int map_over_sharing_buffers (struct buffer *buf,
			      int (*mapfun) (struct buffer *buf,
					     void *closure),
			      void *closure);
void cleanup_buffer_undo_lists (void);

extern struct buffer *current_buffer;

extern void init_initial_directory (void);   /* initialize initial_directory */

EXFUN (Fbuffer_disable_undo, 1);
MODULE_API EXFUN (Fbuffer_modified_p, 1);
MODULE_API EXFUN (Fbuffer_name, 1);
MODULE_API EXFUN (Fcurrent_buffer, 0);
EXFUN (Ferase_buffer, 1);
EXFUN (Fget_buffer, 1);
EXFUN (Fget_buffer_create, 1);
EXFUN (Fget_file_buffer, 1);
MODULE_API EXFUN (Fkill_buffer, 1);
EXFUN (Fother_buffer, 3);
EXFUN (Frecord_buffer, 1);
MODULE_API EXFUN (Fset_buffer, 1);
EXFUN (Fbarf_if_buffer_read_only, 3);
EXFUN (Fset_buffer_modified_p, 2);

extern Lisp_Object QSscratch, Qafter_change_function, Qafter_change_functions;
extern Lisp_Object Qbefore_change_function, Qbefore_change_functions;
extern Lisp_Object Qbuffer_or_string_p, Qdefault_directory, Qfirst_change_hook;
extern Lisp_Object Qpermanent_local, Vafter_change_function;
extern Lisp_Object Qbuffer_live_p;
extern Lisp_Object Vafter_change_functions, Vbefore_change_function;
extern Lisp_Object Vbefore_change_functions, Vbuffer_alist, Vbuffer_defaults;
extern Lisp_Object Vinhibit_read_only, Vtransient_mark_mode;

/* Defined in bytecode.c */
EXFUN (Fbyte_code, 3);

DECLARE_DOESNT_RETURN (invalid_byte_code
		       (const Ascbyte *reason, Lisp_Object frob));

extern Lisp_Object Qbyte_code, Qinvalid_byte_code;

/* Defined in callint.c */
EXFUN (Fcall_interactively, 3);
extern Lisp_Object Qcall_interactively;
extern Lisp_Object Qmouse_leave_buffer_hook;
extern Lisp_Object Qprefix_numeric_value;
extern Lisp_Object Qread_from_minibuffer;
extern Lisp_Object Vcommand_history;
extern Lisp_Object Vcurrent_prefix_arg;
extern Lisp_Object Vmark_even_if_inactive;

/* Defined in casefiddle.c */
EXFUN (Fdowncase, 2);
EXFUN (Fcanoncase, 2);
EXFUN (Fupcase, 2);
EXFUN (Fupcase_initials, 2);
EXFUN (Fupcase_initials_region, 3);
EXFUN (Fupcase_region, 3);

/* Defined in casetab.c */
EXFUN (Fset_standard_case_table, 1);

/* Defined in chartab.c */
EXFUN (Freset_char_table, 1);
extern Lisp_Object Qcategory_designator_p;

/* Defined in cmdloop.c */
extern Lisp_Object Qdisabled_command_hook;
extern Lisp_Object Qreally_early_error_handler;
extern Lisp_Object Qtop_level;
extern Lisp_Object Vdisabled_command_hook;

/* Defined in cmds.c */
EXFUN (Fpoint_at_bol, 2);
EXFUN (Fpoint_at_eol, 2);
EXFUN (Fforward_char, 2);
EXFUN (Fforward_line, 2);
extern Lisp_Object Qself_insert_command;

/* Defined in console.c */
extern Lisp_Object Qconsole_live_p;
extern Lisp_Object Vconsole_list;

/* Defined in console-stream.c */
extern Lisp_Object Vstdio_str;

/* Defined in data.c */
EXFUN (Fadd1, 1);
EXFUN (Faref, 2);
EXFUN (Faset, 3);
EXFUN (Fcar, 1);
EXFUN (Fcdr, 1);
EXFUN (Fgeq, MANY);
EXFUN (Fgtr, MANY);
EXFUN (Findirect_function, 1);
EXFUN (Fleq, MANY);
EXFUN (Flss, MANY);
EXFUN (Fminus, MANY);
EXFUN (Fnumber_to_string, 3);
EXFUN (Fplus, MANY);
EXFUN (Fquo, MANY);
EXFUN (Frem, 2);
EXFUN (Fsetcar, 2);
EXFUN (Fsetcdr, 2);
EXFUN (Fsub1, 1);
EXFUN (Fsubr_max_args, 1);
EXFUN (Fsubr_min_args, 1);
EXFUN (Ftimes, MANY);
EXFUN (Ftype_of, 1);

DECLARE_DOESNT_RETURN (c_write_error (Lisp_Object));
DECLARE_DOESNT_RETURN (lisp_write_error (Lisp_Object));
DECLARE_DOESNT_RETURN (args_out_of_range (Lisp_Object, Lisp_Object));
DECLARE_DOESNT_RETURN (args_out_of_range_3 (Lisp_Object, Lisp_Object,
					    Lisp_Object));
MODULE_API Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object);
MODULE_API
DECLARE_DOESNT_RETURN (dead_wrong_type_argument (Lisp_Object, Lisp_Object));
void check_integer_range (Lisp_Object, Lisp_Object, Lisp_Object);

EXFUN (Fint_to_char, 1);
EXFUN (Fchar_to_int, 1);

enum arith_comparison {
  arith_equal,
  arith_notequal,
  arith_less,
  arith_grtr,
  arith_less_or_equal,
  arith_grtr_or_equal };
Lisp_Object arithcompare (Lisp_Object, Lisp_Object, enum arith_comparison);

/* Do NOT use UINT_32_BIT_to_lisp to decode time_t's unless you KNOW arg is
   non-negative. They cannot return negative values!  Use make_time. */
Lisp_Object UINT_32_BIT_to_lisp (UINT_32_BIT);
Lisp_Object INT_32_BIT_to_lisp (INT_32_BIT);

/* Use lisp_to_time() for time_t instead of these functions. */
UINT_32_BIT lisp_to_UINT_32_BIT (Lisp_Object);
INT_32_BIT lisp_to_INT_32_BIT (Lisp_Object);

Lisp_Object build_fixnum_to_char_maps (Lisp_Object);
extern Lisp_Object Vdigit_fixnum_calculated_data;

/* Given RADIX_TABLE, a char-table mapping from characters to fixnum weights
   as used by #'parse-integer, #'digit-char, return the greatest radix
   possible, a fixnum one more than the highest weight seen within
   RADIX_TABLE.

   Error if RADIX_TABLE is not a character table or does not otherwise meet
   the criteria for use by those functions (it must have no gaps in the
   weights used, and the maximum radix possible cannot exceed #xFFFF).

   Cache the result (and the related majuscule, minuscule maps) in
   Vdigit_fixnum_calculated_data. */
DECLARE_INLINE_HEADER (
Lisp_Object
get_radix_table_greatest_radix (Lisp_Object radix_table)
)
{
  LIST_LOOP_2 (elt, XWEAK_LIST_LIST (Vdigit_fixnum_calculated_data))
    {
      if (EQ (XCAR (elt), radix_table))
        {
          return XCAR (XCDR (elt));
        }
    }

  return XCAR (XCDR (build_fixnum_to_char_maps (radix_table)));
}

/* See the documentation of get_radix_table_greatest_radix(). Return a Lisp
   string mapping from fixnum weight (when multiplied by MAX_ICHAR_LEN) to an
   uppercase character as described by RADIX_TABLE.

   Error if RADIX_TABLE is not a character table or does not otherwise meet
   the criteria for use by those functions (it must have no gaps in the
   weights used, and the maximum radix possible cannot exceed #xFFFF).

   Cache the result (and the related minuscule map, greatest radix
   information) in Vdigit_fixnum_calculated_data. */
DECLARE_INLINE_HEADER (
Lisp_Object
get_radix_table_fixnum_majuscule_map (Lisp_Object radix_table)
)
{
  LIST_LOOP_2 (elt, XWEAK_LIST_LIST (Vdigit_fixnum_calculated_data))
    {
      if (EQ (XCAR (elt), radix_table))
        {
          return XCAR (XCDR (XCDR (elt)));
        }
    }

  return XCAR (XCDR (XCDR (build_fixnum_to_char_maps (radix_table))));
}

/* See the documentation of get_radix_table_greatest_radix(). Return a Lisp
   string mapping from fixnum weight (when multiplied by MAX_ICHAR_LEN) to an
   lowercase character as described by RADIX_TABLE.

   Error if RADIX_TABLE is not a character table or does not otherwise meet
   the criteria for use by those functions (it must have no gaps in the
   weights used, and the maximum radix possible cannot exceed #xFFFF).

   Cache the result (and the related majuscule map, greatest radix
   information) in Vdigit_fixnum_calculated_data. */
DECLARE_INLINE_HEADER (
Lisp_Object
get_radix_table_fixnum_minuscule_map (Lisp_Object radix_table)
)
{
  LIST_LOOP_2 (elt, XWEAK_LIST_LIST (Vdigit_fixnum_calculated_data))
    {
      if (EQ (XCAR (elt), radix_table))
        {
          return XCAR (XCDR (XCDR (XCDR (elt))));
        }
    }

  return XCAR (XCDR (XCDR (XCDR (build_fixnum_to_char_maps (radix_table)))));
}

enum parse_integer_flags
{
  JUNK_ALLOWED = 1 << 0,
  CHECK_OVERFLOW_SYNTAX = 1 << 1
};

Lisp_Object parse_integer (const Ibyte *buf, Ibyte **buf_end_out,
			   Bytecount len, EMACS_INT base,
			   int flags, Lisp_Object base_table);

extern Lisp_Object Vdigit_fixnum_map, Vdigit_fixnum_ascii;

extern Lisp_Object Qarrayp, Qbitp, Qchar_or_string_p, Qcharacterp,
    Qerror_conditions, Qerror_message, Qinteger_char_or_marker_p,
    Qinteger_or_char_p, Qinteger_or_marker_p, Qlambda, Qlistp, Qnatnump,
    Qnonnegativep, Qnumber_char_or_marker_p, Qnumberp, Qquote;
extern MODULE_API Lisp_Object Qintegerp;

extern Lisp_Object Qargs_out_of_range, Qarith_error, Qbeginning_of_buffer,
    Qbuffer_read_only, Qextent_read_only,
    Qcircular_list, Qcircular_property_list,
    Qconversion_error, Qcyclic_variable_indirection, Qdomain_error,
    Qediting_error, Qend_of_buffer, Qend_of_file, Qerror, Qfile_error,
    Qinternal_error, Qinvalid_change, Qinvalid_constant, Qinvalid_function, 
    Qinvalid_keyword_argument, Qinvalid_operation,
    Qinvalid_read_syntax, Qinvalid_state, Qio_error, Qlist_formation_error,
    Qmalformed_list, Qmalformed_property_list, Qno_catch, Qout_of_memory,
    Qoverflow_error, Qprinting_unreadable_object, Qquit, Qrange_error,
    Qsetting_constant, Qsingularity_error, Qstack_overflow,
    Qstructure_formation_error, Qtext_conversion_error, Qunderflow_error,
    Qvoid_function, Qvoid_variable, Qwrong_number_of_arguments,
    Qwrong_type_argument;

extern Lisp_Object Qcdr;
extern Lisp_Object Qerror_lacks_explanatory_string;
extern Lisp_Object Qfile_error;
extern Lisp_Object Qsequencep;
extern MODULE_API Lisp_Object Qinvalid_argument, Qsyntax_error;

/* Defined in device.c */
Lisp_Object call_critical_lisp_code (struct device *d, Lisp_Object function,
				     Lisp_Object object);

extern Lisp_Object Qdevice_live_p;
EXFUN (Fdevice_system_metric, 3);

/* Defined in device-x.c */
extern Lisp_Object Vx_initial_argv_list;

/* Defined in dired.c */
extern Lisp_Object Qfile_system_ignore_case_p;
Lisp_Object make_directory_hash_table (Lisp_Object);

/* Defined in doc.c */
EXFUN (Fsubstitute_command_keys, 1);

extern Lisp_Object Qfunction_documentation;

Lisp_Object unparesseuxify_doc_string (int fd, OFF_T position,
				       Ibyte *name_nonreloc,
				       Lisp_Object name_reloc,
				       Boolint standard_doc_file);
Lisp_Object get_doc_string (Lisp_Object);
extern Lisp_Object Vinternal_doc_file_name;

/* Defined in doprnt.c */

Bytecount fixnum_to_string (Ibyte *buffer, Bytecount size, Fixnum number,
                            UINT_16_BIT radix, Lisp_Object table_or_nil);

/* The number of bytes required to store the decimal printed representation of
   an integral type.  Add a few bytes for truncation, optional sign prefix,
   and null byte terminator.  2.40824 == log (256) / log (10).  Appropriate
   for sizing a buffer for fixnum_to_string ().

   We don't use floating point since Sun cc (buggily?) cannot use floating
   point computations to define a compile-time integral constant. */
#define DECIMAL_PRINT_SIZE(integral_type) \
  ((((2410824 * sizeof (integral_type)) / 1000000) + 3) * MAX_ICHAR_LEN)

#ifdef HAVE_BIGNUM
Bytecount bignum_to_string (Ibyte **buffer_inout, Bytecount size,
                            bignum number, UINT_16_BIT radix,
                            Lisp_Object table_or_nil);
#endif
#ifdef HAVE_RATIO
Bytecount ratio_to_string (Ibyte **buffer_inout, Bytecount size, ratio number,
                           UINT_16_BIT radix, 
                           Lisp_Object table_or_nil);
#endif

MODULE_API Bytecount format_into (Lisp_Object stream, Lisp_Object format_reloc,
                                  int nargs, const Lisp_Object *largs,
                                  Error_Behavior);

MODULE_API Bytecount write_fmt_string (Lisp_Object stream, const CIbyte *fmt,
				       ...)
  PRINTF_ARGS (2, 3);
MODULE_API Bytecount write_fmt_string_va (Lisp_Object stream,
					  const CIbyte *fmt, va_list);
MODULE_API Bytecount write_fmt_string_lisp (Lisp_Object stream,
					    const CIbyte *fmt, ...);
MODULE_API Bytecount write_fmt_string_lisp_va (Lisp_Object stream,
					       const CIbyte *fmt, va_list);

Bytecount stderr_out (const CIbyte *, ...) PRINTF_ARGS (1, 2);
Bytecount stderr_out_lisp (const CIbyte *, ...);
Bytecount stdout_out (const CIbyte *, ...) PRINTF_ARGS (1, 2);

Lisp_Object emacs_vsprintf_string_lisp (const CIbyte *format_nonreloc,
                                        va_list vargs);
Lisp_Object emacs_sprintf_string_lisp (const CIbyte *format_nonreloc, ...);

Bytecount emacs_vasprintf_lisp (Ibyte **retval_out, const CIbyte *format,
                           va_list vargs);
Bytecount emacs_asprintf_lisp (Ibyte **retval_out, const CIbyte *format, ...)
  PRINTF_ARGS (2, 3);

Lisp_Object emacs_vsprintf_string (const CIbyte *format, va_list vargs);
Lisp_Object emacs_sprintf_string (const CIbyte *format, ...)
     PRINTF_ARGS (1, 2);

Bytecount emacs_vasprintf (Ibyte **retval_out, const CIbyte *format,
                           va_list vargs);
Bytecount emacs_asprintf (Ibyte **retval_out, const CIbyte *format, ...)
  PRINTF_ARGS (2, 3);

Bytecount emacs_vsnprintf (Ibyte *output, Bytecount size,
                           const CIbyte *format, va_list vargs);
Bytecount emacs_snprintf (Ibyte *output, Bytecount size,
                          const CIbyte *format, ...)
  PRINTF_ARGS (3, 4);
Bytecount emacs_snprintf_ascbyte (Ascbyte *output, Bytecount size,
                                  const Ascbyte *format, ...)
  PRINTF_ARGS (3, 4);

Bytecount write_external_fmt_string_va (Lisp_Object stream,
                                        Lisp_Object codesys,
                                        const Extbyte *format_external,
                                        va_list vargs);

/* Defined in editfns.c */
EXFUN (Fbobp, 1);
EXFUN (Fbolp, 1);
EXFUN (Fbuffer_substring, 3);
EXFUN (Fchar_after, 2);
EXFUN (Fchar_before, 2);
EXFUN (Fcurrent_time, 0);
EXFUN (Fdelete_region, 3);
EXFUN (Feobp, 1);
EXFUN (Feolp, 1);
EXFUN (Ffollowing_char, 1);
EXFUN (Fformat_into, MANY);
EXFUN (Fgoto_char, 2);
EXFUN (Finsert, MANY);
EXFUN (Finsert_buffer_substring, 3);
EXFUN (Finsert_char, 4);
EXFUN (Fnarrow_to_region, 3);
EXFUN (Fpoint, 1);
EXFUN (Fpoint_marker, 2);
EXFUN (Fpoint_max, 1);
EXFUN (Fpoint_min, 1);
EXFUN (Fpreceding_char, 1);
EXFUN (Fsystem_name, 0);
EXFUN (Fuser_home_directory, 0);
EXFUN (Fuser_login_name, 1);
EXFUN (Fwiden, 1);

void uncache_home_directory (void);
Ibyte *get_home_directory (void);
Ibyte *user_login_name (uid_t *);
void buffer_insert1 (struct buffer *, Lisp_Object);
Lisp_Object make_string_from_buffer (struct buffer *, Bytebpos, Bytecount);
Lisp_Object make_string_from_buffer_no_extents (struct buffer *, Bytebpos, Bytecount);
Lisp_Object make_time (time_t);
Boolint lisp_to_time (Lisp_Object, time_t *);
Lisp_Object save_excursion_save (void);
Lisp_Object save_restriction_save (struct buffer *buf);
Lisp_Object save_excursion_restore (Lisp_Object);
Lisp_Object save_restriction_restore (Lisp_Object);
void widen_buffer (struct buffer *b, int no_clip);
Lisp_Object save_current_buffer_restore (Lisp_Object);

extern Lisp_Object Qformat;
extern Lisp_Object Qmark;
extern Lisp_Object Qpoint;
extern Lisp_Object Qregion_beginning;
extern Lisp_Object Qregion_end;
extern Lisp_Object Quser_files_and_directories;
extern Lisp_Object Vsystem_name;

/* Defined in emacs.c */
EXFUN_NORETURN (Fkill_emacs, 1);
EXFUN (Frunning_temacs_p, 0);
EXFUN (Fforce_debugging_signal, 1);

SIGTYPE fatal_error_signal (int);
Lisp_Object make_arg_list (int, Wexttext **);
void make_argc_argv (Lisp_Object, int *, Extbyte ***);
void free_argc_argv (Extbyte **);
Lisp_Object split_external_path (const Extbyte *path);
Lisp_Object split_env_path (const CIbyte *evarname, const Ibyte *default_);

/* Nonzero means don't do interactive redisplay and don't change tty modes */
extern int noninteractive, noninteractive1;
extern Boolint inhibit_configured_paths;
extern int inhibit_non_essential_conversion_operations;
extern int preparing_for_armageddon;
extern Fixnum emacs_priority;
extern int suppress_early_error_handler_backtrace;
void debug_break (void);
int debug_can_access_memory (const void *ptr, Bytecount len);
DECLARE_DOESNT_RETURN (really_abort (void));
void zero_out_command_line_status_vars (void);

extern Lisp_Object Qsave_buffers_kill_emacs;
extern Lisp_Object Vcommand_line_args;
extern Lisp_Object Vconfigure_info_directory;
extern Lisp_Object Vconfigure_site_directory;
extern Lisp_Object Vconfigure_site_module_directory;
extern Lisp_Object Vdata_directory;
extern Lisp_Object Vdoc_directory;
extern Lisp_Object Vemacs_major_version;
extern Lisp_Object Vemacs_minor_version;
extern Lisp_Object Vexec_directory;
extern Lisp_Object Vexec_path;
extern Lisp_Object Vinvocation_directory;
extern Lisp_Object Vinvocation_name;
extern Lisp_Object Vmodule_directory;
extern Lisp_Object Vsite_directory;
extern Lisp_Object Vsite_module_directory;
extern Lisp_Object Vlisp_directory;

/* Defined in emodules.c */
#ifdef HAVE_SHLIB
EXFUN (Flist_modules, 0);
EXFUN (Fload_module, 3);

extern Lisp_Object Qmodule_string_coding_system;
extern int emodules_depth;
void add_module_loadhist_elt (Lisp_Object);
#else
#define emodules_depth 0
#define add_module_loadhist_elt(X) DO_NOTHING
#define Qmodule_string_coding_system Qnative
#endif
extern Lisp_Object Qdll_error;
extern Lisp_Object Qmodule;


/* Defined in eval.c */
MODULE_API EXFUN (Fapply, MANY);
EXFUN (Fbacktrace, 2);
EXFUN (Fcommand_execute, 3);
EXFUN (Fcommandp, 1);
EXFUN (Fquote_maybe, 1);
MODULE_API EXFUN (Feval, 1);
MODULE_API EXFUN (Ffuncall, MANY);
EXFUN (Ffunctionp, 1);
EXFUN (Finteractive_p, 0);
EXFUN (Fprogn, UNEVALLED);
MODULE_API EXFUN (Fsignal, 2);
MODULE_API EXFUN_NORETURN (Fthrow, UNEVALLED);
MODULE_API EXFUN (Fcall_with_condition_handler, MANY);
EXFUN (Ffunction_max_args, 1);
EXFUN (Ffunction_min_args, 1);
EXFUN (Fvalues, MANY);

MODULE_API Error_Behavior decode_error_behavior (Lisp_Object);

MODULE_API DECLARE_DOESNT_RETURN (throw_or_bomb_out (Lisp_Object,
                                                     Lisp_Object, int,
                                                     Lisp_Object, Lisp_Object));

MODULE_API DECLARE_DOESNT_RETURN (throw_or_bomb_out_unsafe (Lisp_Object,
							    Lisp_Object, int,
							    Lisp_Object, Lisp_Object));

MODULE_API DECLARE_DOESNT_RETURN (signal_error_1 (Lisp_Object, Lisp_Object));
void maybe_signal_error_1 (Lisp_Object, Lisp_Object, Lisp_Object,
			   Error_Behavior);
Lisp_Object maybe_signal_continuable_error_1 (Lisp_Object, Lisp_Object,
					      Lisp_Object, Error_Behavior);
MODULE_API DECLARE_DOESNT_RETURN (signal_ferror (Lisp_Object, const CIbyte *,
						 ...)) PRINTF_ARGS(2, 3);
void maybe_signal_ferror (Lisp_Object, Lisp_Object, Error_Behavior,
			  const CIbyte *, ...) PRINTF_ARGS (4, 5);
Lisp_Object signal_continuable_ferror (Lisp_Object, const CIbyte *, ...)
     PRINTF_ARGS (2, 3);
Lisp_Object maybe_signal_continuable_ferror (Lisp_Object, Lisp_Object,
					     Error_Behavior,
					     const CIbyte *, ...)
     PRINTF_ARGS (4, 5);

Lisp_Object build_error_data (const Ascbyte *reason, Lisp_Object frob);
DECLARE_DOESNT_RETURN (signal_error (Lisp_Object, const Ascbyte *,
				     Lisp_Object));
void maybe_signal_error (Lisp_Object, const Ascbyte *, Lisp_Object,
			 Lisp_Object, Error_Behavior);
Lisp_Object signal_continuable_error (Lisp_Object, const Ascbyte *,
				      Lisp_Object);
Lisp_Object maybe_signal_continuable_error (Lisp_Object, const Ascbyte *,
					    Lisp_Object,
					    Lisp_Object, Error_Behavior);
DECLARE_DOESNT_RETURN (signal_ferror_with_frob (Lisp_Object, Lisp_Object,
						const Ascbyte *, ...))
       PRINTF_ARGS(3, 4);
void maybe_signal_ferror_with_frob (Lisp_Object, Lisp_Object, Lisp_Object,
				    Error_Behavior,
				    const Ascbyte *, ...) PRINTF_ARGS (5, 6);
Lisp_Object signal_continuable_ferror_with_frob (Lisp_Object, Lisp_Object,
						 const Ascbyte *,
						 ...) PRINTF_ARGS (3, 4);
Lisp_Object maybe_signal_continuable_ferror_with_frob (Lisp_Object,
						       Lisp_Object,
						       Lisp_Object,
						       Error_Behavior,
						       const Ascbyte *, ...)
     PRINTF_ARGS (5, 6);
DECLARE_DOESNT_RETURN (signal_error_2 (Lisp_Object, const Ascbyte *,
				       Lisp_Object, Lisp_Object));
void maybe_signal_error_2 (Lisp_Object, const Ascbyte *, Lisp_Object,
			   Lisp_Object, Lisp_Object, Error_Behavior);
Lisp_Object signal_continuable_error_2 (Lisp_Object, const Ascbyte *,
					Lisp_Object, Lisp_Object);
Lisp_Object maybe_signal_continuable_error_2 (Lisp_Object, const Ascbyte *,
					      Lisp_Object, Lisp_Object,
					      Lisp_Object,
					      Error_Behavior);


MODULE_API DECLARE_DOESNT_RETURN (signal_malformed_list_error (Lisp_Object));
MODULE_API DECLARE_DOESNT_RETURN (signal_malformed_property_list_error
				  (Lisp_Object));
MODULE_API DECLARE_DOESNT_RETURN (signal_circular_list_error (Lisp_Object));
MODULE_API DECLARE_DOESNT_RETURN (signal_circular_property_list_error
				  (Lisp_Object));

DECLARE_DOESNT_RETURN (syntax_error (const Ascbyte *reason,
				     Lisp_Object frob));
DECLARE_DOESNT_RETURN (syntax_error_2 (const Ascbyte *reason,
				       Lisp_Object frob1,
				       Lisp_Object frob2));
void maybe_syntax_error (const Ascbyte *, Lisp_Object, Lisp_Object,
			 Error_Behavior);
DECLARE_DOESNT_RETURN (sferror (const Ascbyte *reason, Lisp_Object frob));
DECLARE_DOESNT_RETURN (sferror_2 (const Ascbyte *reason, Lisp_Object frob1,
				  Lisp_Object frob2));
void maybe_sferror (const Ascbyte *, Lisp_Object, Lisp_Object,
		    Error_Behavior);
MODULE_API DECLARE_DOESNT_RETURN (invalid_argument (const Ascbyte *reason,
						    Lisp_Object frob));
MODULE_API DECLARE_DOESNT_RETURN (invalid_argument_2 (const Ascbyte *reason,
						      Lisp_Object frob1,
						      Lisp_Object frob2));
void maybe_invalid_argument (const Ascbyte *, Lisp_Object, Lisp_Object,
			     Error_Behavior);
MODULE_API DECLARE_DOESNT_RETURN (invalid_keyword_argument (Lisp_Object fun,
                                                            Lisp_Object kw));
MODULE_API DECLARE_DOESNT_RETURN (invalid_operation (const Ascbyte *reason,
						     Lisp_Object frob));
MODULE_API DECLARE_DOESNT_RETURN (invalid_operation_2 (const Ascbyte *reason,
						       Lisp_Object frob1,
						       Lisp_Object frob2));
MODULE_API void maybe_invalid_operation (const Ascbyte *, Lisp_Object,
					 Lisp_Object, Error_Behavior);
DECLARE_DOESNT_RETURN (invalid_state (const Ascbyte *reason,
					 Lisp_Object frob));
DECLARE_DOESNT_RETURN (invalid_state_2 (const Ascbyte *reason,
					   Lisp_Object frob1,
					   Lisp_Object frob2));
void maybe_invalid_state (const Ascbyte *, Lisp_Object, Lisp_Object,
			  Error_Behavior);
DECLARE_DOESNT_RETURN (invalid_change (const Ascbyte *reason,
					 Lisp_Object frob));
DECLARE_DOESNT_RETURN (invalid_change_2 (const Ascbyte *reason,
					   Lisp_Object frob1,
					   Lisp_Object frob2));
void maybe_invalid_change (const Ascbyte *, Lisp_Object, Lisp_Object,
			   Error_Behavior);
MODULE_API DECLARE_DOESNT_RETURN (invalid_constant (const Ascbyte *reason,
						    Lisp_Object frob));
DECLARE_DOESNT_RETURN (invalid_constant_2 (const Ascbyte *reason,
					   Lisp_Object frob1,
					   Lisp_Object frob2));
void maybe_invalid_constant (const Ascbyte *, Lisp_Object, Lisp_Object,
			     Error_Behavior);
DECLARE_DOESNT_RETURN (wtaerror (const Ascbyte *reason, Lisp_Object frob));
MODULE_API DECLARE_DOESNT_RETURN (out_of_memory (const Ascbyte *reason,
						 Lisp_Object frob));
DECLARE_DOESNT_RETURN (stack_overflow (const Ascbyte *reason,
				       Lisp_Object frob));
DECLARE_DOESNT_RETURN (text_conversion_error (const CIbyte *reason,
					      Lisp_Object frob));
DECLARE_DOESNT_RETURN (text_conversion_error_2 (const CIbyte *reason,
						Lisp_Object frob1,
						Lisp_Object frob2));
void maybe_text_conversion_error (const CIbyte *, Lisp_Object, Lisp_Object,
				  Error_Behavior);

Lisp_Object signal_void_function_error (Lisp_Object);
Lisp_Object signal_invalid_function_error (Lisp_Object);
Lisp_Object signal_wrong_number_of_arguments_error (Lisp_Object, int);

Lisp_Object run_hook_with_args_in_buffer (struct buffer *, int, Lisp_Object *,
					  enum run_hooks_condition);
Lisp_Object run_hook_with_args (int, Lisp_Object *, enum run_hooks_condition);
void va_run_hook_with_args (Lisp_Object, int, ...);
void va_run_hook_with_args_in_buffer (struct buffer *, Lisp_Object, int, ...);
Lisp_Object run_hook (Lisp_Object);
MODULE_API Lisp_Object apply1 (Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object call0 (Lisp_Object);
MODULE_API Lisp_Object call1 (Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object);
MODULE_API Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object, Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object);
MODULE_API Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object call8 (Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object, Lisp_Object, Lisp_Object,
			      Lisp_Object, Lisp_Object, Lisp_Object);
Lisp_Object call0_in_buffer (struct buffer *, Lisp_Object);
Lisp_Object call1_in_buffer (struct buffer *, Lisp_Object, Lisp_Object);
Lisp_Object call2_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
			     Lisp_Object);
Lisp_Object call3_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
			     Lisp_Object, Lisp_Object);
Lisp_Object call4_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
			     Lisp_Object, Lisp_Object, Lisp_Object);
Lisp_Object call5_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
			     Lisp_Object, Lisp_Object, Lisp_Object,
			     Lisp_Object);
Lisp_Object call6_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
			     Lisp_Object, Lisp_Object, Lisp_Object,
			     Lisp_Object, Lisp_Object);
Lisp_Object eval_in_buffer (struct buffer *, Lisp_Object);

struct call_trapping_problems_result
{
  int caught_error, caught_throw;
  Lisp_Object error_conditions, data;
  Lisp_Object backtrace;
  Lisp_Object thrown_tag;
  Lisp_Object thrown_value;
};

#define NO_INHIBIT_ERRORS (1<<0)
#define NO_INHIBIT_THROWS (1<<1)
#define INTERNAL_INHIBIT_ERRORS (1<<0)
#define INTERNAL_INHIBIT_THROWS (1<<1)
#define INHIBIT_WARNING_ISSUE (1<<2)
#define ISSUE_WARNINGS_AT_DEBUG_LEVEL (1<<3)
#define INHIBIT_QUIT (1<<4)
#define UNINHIBIT_QUIT (1<<5)
#define INHIBIT_GC (1<<6)
#define INHIBIT_EXISTING_PERMANENT_DISPLAY_OBJECT_DELETION (1<<7)
#define INHIBIT_EXISTING_CODING_SYSTEM_DELETION (1<<8)
#define INHIBIT_EXISTING_CHARSET_DELETION (1<<9)
#define INHIBIT_PERMANENT_DISPLAY_OBJECT_CREATION (1<<10)
#define INHIBIT_CODING_SYSTEM_CREATION (1<<11)
#define INHIBIT_CHARSET_CREATION (1<<12)
#define INHIBIT_EXISTING_BUFFER_TEXT_MODIFICATION (1<<13)
#define INHIBIT_ANY_CHANGE_AFFECTING_REDISPLAY (1<<14)
#define INHIBIT_ENTERING_DEBUGGER (1<<15)
#define CALL_WITH_SUSPENDED_ERRORS (1<<16)
#define POSTPONE_WARNING_ISSUE (1<<17)

enum check_allowed_operation
{
  OPERATION_DELETE_OBJECT,
  OPERATION_CREATE_OBJECT,
  OPERATION_MODIFY_BUFFER_TEXT,
  OPERATION_MODIFY_OBJECT_PROPERTY
};

int get_inhibit_flags (void);
void check_allowed_operation (int what, Lisp_Object obj, Lisp_Object prop);
void note_object_created (Lisp_Object obj);
void note_object_deleted (Lisp_Object obj);
Lisp_Object call_with_condition_handler (Lisp_Object (*handler) (Lisp_Object,
								 Lisp_Object,
								 Lisp_Object),
					 Lisp_Object handler_arg,
					 Lisp_Object (*fun) (Lisp_Object),
					 Lisp_Object arg);
int set_trapping_problems_flags (int flags);
Lisp_Object call_trapping_problems (Lisp_Object warning_class,
				    const Ascbyte *warning_string,
				    int flags,
				    struct call_trapping_problems_result
				    *problem,
				    Lisp_Object (*fun) (void *),
				    void *arg);
Lisp_Object va_call_trapping_problems (Lisp_Object warning_class,
				       const Ascbyte *warning_string,
				       int flags,
				       struct call_trapping_problems_result
				       *problem,
				       lisp_fn_t fun, int nargs, ...);
Lisp_Object call0_trapping_problems (const Ascbyte *, Lisp_Object, int);
Lisp_Object call1_trapping_problems (const Ascbyte *, Lisp_Object, Lisp_Object,
				   int);
Lisp_Object call2_trapping_problems (const Ascbyte *, Lisp_Object, Lisp_Object,
				   Lisp_Object, int);
Lisp_Object call3_trapping_problems (const Ascbyte *, Lisp_Object, Lisp_Object,
				   Lisp_Object, Lisp_Object, int);
Lisp_Object call4_trapping_problems (const Ascbyte *, Lisp_Object, Lisp_Object,
				   Lisp_Object, Lisp_Object, Lisp_Object,
				   int);
Lisp_Object call5_trapping_problems (const Ascbyte *, Lisp_Object, Lisp_Object,
				   Lisp_Object, Lisp_Object, Lisp_Object,
				   Lisp_Object, int);
Lisp_Object eval_in_buffer_trapping_problems (const Ascbyte *, struct buffer *,
					    Lisp_Object, int);
Lisp_Object run_hook_trapping_problems (Lisp_Object, Lisp_Object, int);
Lisp_Object safe_run_hook_trapping_problems (Lisp_Object, Lisp_Object, int);
Lisp_Object run_hook_with_args_in_buffer_trapping_problems (Lisp_Object,
							    struct buffer *,
							    int nargs,
							    Lisp_Object *args,
							    enum
							    run_hooks_condition
							    cond, int flags);
Lisp_Object run_hook_with_args_trapping_problems (Lisp_Object,
						  int nargs,
						  Lisp_Object *args,
						  enum run_hooks_condition
						  cond,
						  int flags);
Lisp_Object va_run_hook_with_args_trapping_problems (Lisp_Object,
						     Lisp_Object hook_var,
						     int nargs, ...);
Lisp_Object va_run_hook_with_args_in_buffer_trapping_problems (Lisp_Object,
							       struct buffer *,
							       Lisp_Object,
							       int nargs, ...);
Lisp_Object call_with_suspended_errors (lisp_fn_t, Lisp_Object,
					Lisp_Object,
					Error_Behavior, int, ...);
/* C Code should be using internal_catch, record_unwind_p, condition_case_1 */
int proper_redisplay_wrapping_in_place (void);
Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object),
			    Lisp_Object, int * volatile,
			    Lisp_Object * volatile,
			    Lisp_Object * volatile);
Lisp_Object condition_case_1 (Lisp_Object,
			      Lisp_Object (*) (Lisp_Object),
			      Lisp_Object,
			      Lisp_Object (*) (Lisp_Object, Lisp_Object),
			      Lisp_Object);
Lisp_Object condition_case_3 (Lisp_Object, Lisp_Object, Lisp_Object);
MODULE_API Lisp_Object unbind_to_1 (int, Lisp_Object);
#define unbind_to(obj) unbind_to_1 (obj, Qnil)
void specbind (Lisp_Object, Lisp_Object);
MODULE_API int record_unwind_protect (Lisp_Object (*) (Lisp_Object),
				      Lisp_Object);
int record_unwind_protect_freeing_dynarr (void *ptr);
int record_unwind_protect_restoring_int (int *addr, int val);
int internal_bind_int (int *addr, int newval);
int internal_bind_lisp_object (Lisp_Object *addr, Lisp_Object newval);
void do_autoload (Lisp_Object, Lisp_Object); /* GCPROs both arguments */
Lisp_Object un_autoload (Lisp_Object);
void warn_when_safe_lispobj (Lisp_Object, Lisp_Object, Lisp_Object);
MODULE_API void warn_when_safe (Lisp_Object, Lisp_Object, const Ascbyte *,
				...) PRINTF_ARGS (3, 4);
extern int backtrace_with_internal_sections;
extern Fixnum multiple_values_limit;

extern Lisp_Object Qand_optional;
extern Lisp_Object Qand_rest;
extern Lisp_Object Qautoload;
extern Lisp_Object Qcommandp;
extern Lisp_Object Qdefun;
extern Lisp_Object Qexit;
extern Lisp_Object Qinhibit_quit;
extern Lisp_Object Qinteractive;
extern Lisp_Object Qmacro;
extern Lisp_Object Qprogn;
extern Lisp_Object Qrun_hooks;
extern Lisp_Object Qvalues;
extern Lisp_Object Vdebug_on_error;
extern Lisp_Object Vstack_trace_on_error;
extern Lisp_Object Vautoload_queue;

extern MODULE_API Lisp_Object Vinhibit_quit, Vquit_flag;

/* Defined in event-stream.c */
EXFUN (Faccept_process_output, 3);
EXFUN (Fadd_timeout, 4);
EXFUN (Fdisable_timeout, 1);
EXFUN (Fdiscard_input, 0);
EXFUN (Fdispatch_event, 1);
EXFUN (Fenqueue_eval_event, 2);
EXFUN (Fnext_event, 2);
EXFUN (Fread_key_sequence, 3);
EXFUN (Fsit_for, 2);
EXFUN (Fsleep_for, 1);

void wait_delaying_user_input (int (*) (void *), void *);
int detect_input_pending (int how_many);
void reset_this_command_keys (Lisp_Object, int);
Lisp_Object enqueue_misc_user_event (Lisp_Object, Lisp_Object, Lisp_Object);
Lisp_Object enqueue_misc_user_event_pos (Lisp_Object, Lisp_Object,
					 Lisp_Object, int, int, int, int);
extern int modifier_keys_are_sticky;

extern Lisp_Object Qdisabled;
extern Lisp_Object Qsans_modifiers;
extern Lisp_Object Qself_insert_defer_undo;
extern Lisp_Object Vcontrolling_terminal;
extern Lisp_Object Vcurrent_mouse_event;
extern Lisp_Object Vlast_command;
extern Lisp_Object Vlast_command_char;
extern Lisp_Object Vlast_command_event;
extern Lisp_Object Vlast_input_event;
extern Lisp_Object Vrecent_keys_ring;
extern Lisp_Object Vthis_command_keys;
extern Lisp_Object Vunread_command_event;

/* Defined in event-Xt.c */
void signal_special_Xt_user_event (Lisp_Object, Lisp_Object, Lisp_Object);


/* Defined in events.c */
EXFUN (Fcopy_event, 2);
EXFUN (Fevent_to_character, 4);

void clear_event_resource (void);
Lisp_Object allocate_event (void);

EXFUN (Fevent_x_pixel, 1);
EXFUN (Fevent_y_pixel, 1);

extern Lisp_Object Qevent_live_p;


/* Defined in extents.c */
extern Lisp_Object Qend_open;
extern Lisp_Object Qextent_live_p;
extern Lisp_Object Qstart_open;

void flush_cached_extent_info (void);

/* Defined in faces.c */
extern Lisp_Object Qforeground;
extern Lisp_Object Qforeback;
extern Lisp_Object Qbackground;
extern Lisp_Object Qbackground_pixmap;
extern Lisp_Object Qblinking;
extern Lisp_Object Qdim;
extern Lisp_Object Qdisplay_table;
extern Lisp_Object Qunderline;
extern Lisp_Object Qshrink;

/* Defined in file-coding.c */
EXFUN (Fcoding_category_list, 0);
EXFUN (Fcoding_category_system, 1);
EXFUN (Fcoding_priority_list, 0);
EXFUN (Fcoding_system_description, 1);
EXFUN (Fcoding_system_documentation, 1);
EXFUN (Fcoding_system_list, 1);
EXFUN (Fcoding_system_name, 1);
EXFUN (Fcoding_system_p, 1);
EXFUN (Fcoding_system_property, 2);
EXFUN (Fcoding_system_type, 1);
EXFUN (Fcopy_coding_system, 2);
EXFUN (Fdecode_coding_region, 4);
EXFUN (Fdecode_shift_jis_char, 1);
EXFUN (Fdefine_coding_system_alias, 2);
EXFUN (Fdetect_coding_region, 3);
EXFUN (Fdefault_encoding_detection_enabled_p, 0);
EXFUN (Fencode_coding_region, 4);
EXFUN (Fencode_shift_jis_char, 1);
EXFUN (Ffind_coding_system, 1);
EXFUN (Fget_coding_system, 1);
EXFUN (Fmake_coding_system, 4);
EXFUN (Fset_coding_category_system, 2);
EXFUN (Fset_coding_priority_list, 1);
EXFUN (Fsubsidiary_coding_system, 2);

extern Lisp_Object Qshift_jis, Qiso2022, Qbig5, Qccl;
extern Lisp_Object Qcharset_g0;
extern Lisp_Object Qcharset_g1, Qcharset_g2, Qcharset_g3, Qcoding_system_error;
extern Lisp_Object Qcoding_systemp, Qcr, Qcrlf, Qdecode, Qencode;
extern Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf, Qeol_type, Qescape_quoted;
extern Lisp_Object Qforce_g0_on_output, Qforce_g1_on_output;
extern Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output;
extern Lisp_Object Qinput_charset_conversion, Qlf, Qlock_shift;
extern Lisp_Object Qmnemonic, Qno_ascii_cntl, Qno_ascii_eol;
extern Lisp_Object Qno_conversion, Qraw_text;
extern Lisp_Object Qno_iso6429, Qoutput_charset_conversion;
extern Lisp_Object Qpost_read_conversion, Qpre_write_conversion, Qseven;
extern Lisp_Object Qshort, Vcoding_system_for_read;
extern Lisp_Object Vcoding_system_for_write;
extern Lisp_Object Vfile_name_coding_system, Vkeyboard_coding_system;
extern Lisp_Object Vterminal_coding_system;
extern Lisp_Object Qcanonicalize_after_coding;
int coding_system_is_for_text_file (Lisp_Object coding_system);
Lisp_Object find_coding_system_for_text_file (Lisp_Object name, int eol_wrap);
MODULE_API Lisp_Object get_coding_system_for_text_file (Lisp_Object name,
							int eol_wrap);
int coding_system_is_binary (Lisp_Object coding_system);


/* Defined in fileio.c */
EXFUN (Fdirectory_file_name, 1);
EXFUN (Fdo_auto_save, 2);
EXFUN (Fexpand_file_name, 2);
EXFUN (Ffile_accessible_directory_p, 1);
EXFUN (Ffile_directory_p, 1);
EXFUN (Ffile_executable_p, 1);
EXFUN (Ffile_exists_p, 1);
EXFUN (Ffile_name_absolute_p, 1);
EXFUN (Ffile_name_as_directory, 1);
EXFUN (Ffile_name_directory, 1);
EXFUN (Ffile_name_nondirectory, 1);
EXFUN (Ffile_readable_p, 1);
EXFUN (Ffile_symlink_p, 1);
EXFUN (Ffile_truename, 2);
EXFUN (Ffind_file_name_handler, 2);
EXFUN (Finsert_file_contents_internal, 7);
EXFUN (Fmake_temp_name, 1);
EXFUN (Fsubstitute_in_file_name, 1);
EXFUN (Funhandled_file_name_directory, 1);
EXFUN (Fverify_visited_file_modtime, 1);

void record_auto_save (void);
void force_auto_save_soon (void);
DECLARE_DOESNT_RETURN (report_error_with_errno (Lisp_Object errtype,
						const Ascbyte *reason,
						Lisp_Object data));
DECLARE_DOESNT_RETURN (report_file_error (const Ascbyte *, Lisp_Object));
Lisp_Object lisp_strerror (int);
Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object);
int internal_delete_file (Lisp_Object);
Ibyte *find_end_of_directory_component (const Ibyte *path,
					Bytecount len);

extern Lisp_Object Qfile_name_sans_extension;
extern Lisp_Object Vdirectory_sep_char;

/* Defined in filelock.c */
EXFUN (Funlock_buffer, 0);

void lock_file (Lisp_Object);
void unlock_file (Lisp_Object);
void unlock_all_files (void);
void unlock_buffer (struct buffer *);

/* Defined in floatfns.c */
EXFUN (Ftruncate, 2);

double extract_float (Lisp_Object);

/* Defined in fns.c */
MODULE_API EXFUN (Fappend, MANY);
EXFUN (Fassq, 2);
EXFUN (Fcanonicalize_lax_plist, 2);
EXFUN (Fcanonicalize_plist, 2);
EXFUN (Fcheck_valid_plist, 1);
EXFUN (Fconcat, MANY);
EXFUN (Fcopy_alist, 1);
EXFUN (Fcopy_list, 1);
EXFUN (Fcopy_tree, 2);
EXFUN (Fdestructive_alist_to_plist, 1);
EXFUN (Felt, 2);
MODULE_API EXFUN (Fequal, 2);
MODULE_API EXFUN (Fget, 3);
MODULE_API EXFUN (Feqlsign, MANY);
MODULE_API EXFUN (Fequalp, 2);
EXFUN (Flast, 2);
EXFUN (Flax_plist_get, 3);
EXFUN (Flax_plist_remprop, 2);
MODULE_API EXFUN (Flength, 1);
EXFUN (Flist_length, 1);
EXFUN (FmapcarX, MANY);
EXFUN (Fmember, 2);
EXFUN (Fmemq, 2);
EXFUN (Fnconc, MANY);
MODULE_API EXFUN (Fnreverse, 1);
EXFUN (Fnthcdr, 2);
EXFUN (Fold_assq, 2);
EXFUN (Fold_equal, 2);
EXFUN (Fold_member, 2);
EXFUN (Fold_memq, 2);
EXFUN (Fplist_get, 3);
EXFUN (Fplist_member, 2);
EXFUN (Fplist_put, 3);
MODULE_API EXFUN (Fprovide, 1);
MODULE_API EXFUN (Fput, 3);
EXFUN (Frassq, 2);
MODULE_API EXFUN (Freverse, 1);
EXFUN (Fstring_lessp, 2);
EXFUN (Fsubseq, 3);
EXFUN (Fvalid_plist_p, 1);

extern void check_sequence_range (Lisp_Object, Lisp_Object, Lisp_Object,
                                  Lisp_Object);

extern Boolint check_eq_nokey (Lisp_Object, Lisp_Object, Lisp_Object,
                               Lisp_Object);
extern Boolint check_lss_key_car (Lisp_Object, Lisp_Object, Lisp_Object,
				  Lisp_Object);
extern Boolint check_string_lessp_nokey (Lisp_Object, Lisp_Object,
					 Lisp_Object, Lisp_Object);

typedef Boolint (*check_test_func_t) (Lisp_Object test, Lisp_Object key,
				      Lisp_Object item, Lisp_Object elt);

typedef struct
{
  Lisp_Object number_table;
  Lisp_Object new_;
  Lisp_Object old;
  Lisp_Object current_object;
  Boolint test_not_unboundp;
} nsubst_structures_info_t;

Lisp_Object nsubst_structures (Lisp_Object new_, Lisp_Object old,
                               Lisp_Object tree, check_test_func_t check_test,
                               Boolint test_not_unboundp,
                               Lisp_Object test, Lisp_Object key);

Lisp_Object list_merge (Lisp_Object org_l1, Lisp_Object org_l2,
			check_test_func_t check_merge,
                        Lisp_Object predicate, Lisp_Object key_func);
Lisp_Object list_sort (Lisp_Object list,
		       check_test_func_t check_merge,
                       Lisp_Object predicate, Lisp_Object key_func);

Lisp_Object memq_no_quit (Lisp_Object, Lisp_Object);
Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object);
Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object);
Lisp_Object rassq_no_quit (Lisp_Object, Lisp_Object);
Lisp_Object delq_no_quit (Lisp_Object, Lisp_Object);
Lisp_Object delq_no_quit_and_free_cons (Lisp_Object, Lisp_Object);
Lisp_Object remassoc_no_quit (Lisp_Object, Lisp_Object);
Lisp_Object remassq_no_quit (Lisp_Object, Lisp_Object);
Lisp_Object remrassq_no_quit (Lisp_Object, Lisp_Object);

int plists_differ (Lisp_Object, Lisp_Object, int, int, int, int);
Lisp_Object internal_plist_get (Lisp_Object, Lisp_Object);
void internal_plist_put (Lisp_Object *, Lisp_Object, Lisp_Object);
int internal_remprop (Lisp_Object *, Lisp_Object);
Lisp_Object external_plist_get (Lisp_Object *, Lisp_Object,
				int, Error_Behavior);
void external_plist_put (Lisp_Object *, Lisp_Object,
			 Lisp_Object, int, Error_Behavior);
int external_remprop (Lisp_Object *, Lisp_Object, int, Error_Behavior);
int internal_equal_trapping_problems (Lisp_Object warning_class,
    				      const Ascbyte *warning_string,
				      int flags,
				      struct call_trapping_problems_result *p,
				      int retval,
				      Lisp_Object obj1, Lisp_Object obj2,
				      int depth);
int internal_equal (Lisp_Object, Lisp_Object, int);
int internal_equalp (Lisp_Object obj1, Lisp_Object obj2, int depth);
Lisp_Object MODULE_API concat2 (Lisp_Object, Lisp_Object);
Lisp_Object MODULE_API concat3 (Lisp_Object, Lisp_Object, Lisp_Object);
Lisp_Object MODULE_API vconcat2 (Lisp_Object, Lisp_Object);
Lisp_Object MODULE_API vconcat3 (Lisp_Object, Lisp_Object, Lisp_Object);
Lisp_Object MODULE_API nconc2 (Lisp_Object, Lisp_Object);
int internal_equal_0 (Lisp_Object, Lisp_Object, int, int);
Lisp_Object bytecode_nconc2 (Lisp_Object *);
int bytecode_arithcompare (Lisp_Object obj1, Lisp_Object obj2);
void check_losing_bytecode (const Ascbyte *, Lisp_Object);

Lisp_Object add_suffix_to_symbol (Lisp_Object symbol,
				  const Ascbyte *ascii_string);
Lisp_Object add_prefix_to_symbol (const Ascbyte *ascii_string,
				  Lisp_Object symbol);

extern Lisp_Object Qidentity;
extern Lisp_Object Qstring_lessp;
extern Lisp_Object Qyes_or_no_p;
extern Lisp_Object Vfeatures;

/* Defined in frame.c */
extern Lisp_Object Qframe_live_p;

/* Defined in gc.c */
extern const struct sized_memory_description int_description;
extern const struct sized_memory_description unsigned_char_description;
extern const struct sized_memory_description lisp_object_description;
extern const struct sized_memory_description Lisp_Object_pair_description;

/* Defined in general.c */
#define SYMBOL(fou) extern Lisp_Object fou
#define SYMBOL_MODULE_API(fou) extern MODULE_API Lisp_Object fou
#define SYMBOL_KEYWORD(la_cle_est_folle) extern Lisp_Object la_cle_est_folle
#define SYMBOL_GENERAL(tout_le_monde, est_fou) \
  extern Lisp_Object tout_le_monde
#define SYMBOL_KEYWORD_GENERAL(y_compris_ben, mais_que_peut_on_faire) \
  extern Lisp_Object y_compris_ben

#include "general-slots.h"

#undef SYMBOL
#undef SYMBOL_MODULE_API
#undef SYMBOL_KEYWORD
#undef SYMBOL_GENERAL
#undef SYMBOL_KEYWORD_GENERAL

extern Lisp_Object Qeq, Qeql, Qequal, Qequalp;
extern Lisp_Object Qeq_hash, Qeql_hash, Qequal_hash, Qequalp_hash;

/* Defined in glyphs.c */
EXFUN (Fmake_glyph_internal, 1);

Error_Behavior decode_error_behavior_flag (Lisp_Object);
Lisp_Object encode_error_behavior_flag (Error_Behavior);

extern Lisp_Object Qbuffer_glyph_p;
extern Lisp_Object Qcolor_pixmap_image_instance_p;
extern Lisp_Object Qicon_glyph_p;
extern Lisp_Object Qmono_pixmap_image_instance_p;
extern Lisp_Object Qnothing_image_instance_p;
extern Lisp_Object Qpointer_glyph_p;
extern Lisp_Object Qpointer_image_instance_p;
extern Lisp_Object Qsubwindow;
extern Lisp_Object Qsubwindow_image_instance_p;
extern Lisp_Object Qtext_image_instance_p;

/* Defined in glyphs-shared.c */
void shared_resource_validate (Lisp_Object instantiator);
Lisp_Object shared_resource_normalize (Lisp_Object inst,
				       Lisp_Object console_type,
				       Lisp_Object dest_mask,
				       Lisp_Object tag);
extern Lisp_Object Q_resource_type, Q_resource_id;

/* Defined in glyphs-widget.c */
extern Lisp_Object Qlayout;
extern Lisp_Object Qnative_layout;

/* Defined in gui.c */
DECLARE_DOESNT_RETURN (gui_error (const Ascbyte *reason,
				  Lisp_Object frob));
DECLARE_DOESNT_RETURN (gui_error_2 (const Ascbyte *reason,
				    Lisp_Object frob0, Lisp_Object frob1));
extern Lisp_Object Qgui_error;

/* Defined in indent.c */
EXFUN (Findent_to, 3);
EXFUN (Fvertical_motion, 3);

Charcount byte_spaces_at_point (struct buffer *, Bytebpos);
Charcount column_at_point (struct buffer *, Bytebpos, Charcount);
Charcount string_column_at_point (Lisp_Object, Bytecount, Charcount);
Charcount current_column (struct buffer *);
void invalidate_current_column (void);
Bytebpos vmotion (struct window *, Bytebpos, Charcount, Charcount *);
Bytebpos vmotion_pixels (Lisp_Object, Bytebpos, int, int, int *);

/* Defined in insdel.c */
void set_buffer_point (struct buffer *buf, Charbpos pos, Bytebpos bipos);

DECLARE_INLINE_HEADER (
void
fixup_internal_substring (const Ibyte *nonreloc, Lisp_Object reloc,
			  Bytecount offset, Bytecount *len)
)
{
  text_checking_assert ((nonreloc && NILP (reloc))
                        || (!nonreloc && STRINGP (reloc)));
  if (*len < 0)
    {
      if (nonreloc)
	*len = (Bytecount) strlen ((const Chbyte *) nonreloc) - offset;
      else
	*len = XSTRING_LENGTH (reloc) - offset;
    }
#ifdef ERROR_CHECK_TEXT
  assert (*len >= 0);
  if (STRINGP (reloc))
    {
      assert (offset >= 0 && offset <= XSTRING_LENGTH (reloc));
      assert (offset + *len <= XSTRING_LENGTH (reloc));
    }
#endif
}

/* Defined in intl.c */
EXFUN (Fgettext, 1);

/* Defined in keymap.c */

EXFUN (Fdefine_key, 3);
EXFUN (Fkey_description, 1);
EXFUN (Flookup_key, 3);
EXFUN (Fmake_sparse_keymap, 1);
EXFUN (Fset_keymap_parents, 2);

Bytecount where_is_to_Ibyte (Lisp_Object, Ibyte *, Bytecount);
Lisp_Object canonicalize_keysym (Lisp_Object, int *modifiers_inout);

/* Defined in lread.c */
EXFUN (Fread, 1);

void ebolify_bytecode_constants (Lisp_Object);
void close_load_descs (void);
int locate_file (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object *, int);
int locate_file_without_hash (Lisp_Object, Lisp_Object, Lisp_Object,
                              Lisp_Object *, int);
EXFUN (Flocate_file_clear_hashing, 1);
int isfloat_string (const char *);
int isratio_string (const char *);

/* Well, I've decided to enable this. -- ben */
/* And I've decided to make it work right.  -- sb */
#define LOADHIST
/* Define the following symbol to enable load history of dumped files */
#define LOADHIST_DUMPED

#ifdef LOADHIST /* this is just a stupid idea */
#define LOADHIST_ATTACH(x) do if (initialized)				\
    {									\
      Vcurrent_load_list = Fcons (x, Vcurrent_load_list);		\
      if (emodules_depth)						\
	{								\
	  add_module_loadhist_elt (XCAR (Vcurrent_load_list));		\
	}								\
    } while (0)
#else /*! LOADHIST */
# define LOADHIST_ATTACH(x)
#endif /*! LOADHIST */

extern Lisp_Object Qfeaturep;
extern Lisp_Object Qload;
extern Lisp_Object Qread_char;
extern Lisp_Object Qstandard_input;
extern Lisp_Object Vcurrent_load_list;
extern Lisp_Object Vfile_domain;
extern Lisp_Object Vload_file_name_internal;
extern Lisp_Object Vload_history;
extern Lisp_Object Vload_path;
extern Lisp_Object Vstandard_input;

/* Defined in macros.c */
EXFUN (Fexecute_kbd_macro, 2);

extern Lisp_Object Vexecuting_macro;

/* Defined in marker.c */
EXFUN (Fcopy_marker, 2);
EXFUN (Fmake_marker, 0);
EXFUN (Fmarker_buffer, 1);
EXFUN (Fmarker_position, 1);
EXFUN (Fset_marker, 3);
EXFUN (Fset_marker_insertion_type, 2);

Charbpos marker_position (Lisp_Object);
Bytebpos marker_byte_position (Lisp_Object);

/* Set the byte position of MARKER, a marker object, to BYTENO in
   BUFFER. MARKER must be a marker object, BUFFER must be a valid buffer, and
   BYTENO must be a valid byte position within BUFFER. MARKER may not be
   BUFFER's point marker. Values for MARKER, BYTENO, and BUFFER are checked
   only if ERROR_CHECK_STRUCTURES is defined, and cause an assertion failure
   if out of range, so callers need to check values themselves. */
Lisp_Object set_marker_byte_position (Lisp_Object marker, Bytebpos byteno,
                                      Lisp_Object buffer);

/* Like set_marker_byte_position, but if BYTENO is outside of the visible
   region for BUFFER, restrict it as does set_marker_restricted(). Values for
   MARKER and BUFFER are checked if ERROR_CHECK_STRUCTURES is defined, and
   cause an assertion failure if ill-formed. */
Lisp_Object set_marker_byte_position_restricted (Lisp_Object marker,
                                                 Bytebpos byteno,
                                                 Lisp_Object buffer);
/* No set_marker_position (); use Fset_marker (). */

void unchain_marker (Lisp_Object);
Lisp_Object noseeum_copy_marker (Lisp_Object, Lisp_Object);
Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object);
#ifdef MEMORY_USAGE_STATS
Bytecount compute_buffer_marker_usage (struct buffer *b);
#endif
void init_buffer_markers (struct buffer *b);
void uninit_buffer_markers (struct buffer *b);

/* Defined in menubar.c */
extern Lisp_Object Qactivate_menubar_hook;
extern Lisp_Object Qcurrent_menubar;
extern Lisp_Object Vactivate_menubar_hook;
extern Lisp_Object Vblank_menubar;
extern Lisp_Object Vmenubar_configuration;

/* Defined in minibuf.c */
extern int minibuf_level;
Charcount scmp_1 (const Ibyte *, const Ibyte *, Charcount, int);
#define scmp(s1, s2, len) scmp_1 (s1, s2, len, completion_ignore_case)
extern int completion_ignore_case;
int regexp_ignore_completion_p (const Ibyte *, Lisp_Object,
				Bytecount, Bytecount);
Lisp_Object clear_echo_area (struct frame *, Lisp_Object, int);
Lisp_Object clear_echo_area_from_print (struct frame *, Lisp_Object, int);
void echo_area_append (struct frame *, const Ibyte *, Lisp_Object,
		       Bytecount, Bytecount, Lisp_Object);
void echo_area_message (struct frame *, const Ibyte *, Lisp_Object,
			Bytecount, Bytecount, Lisp_Object);
Lisp_Object echo_area_status (struct frame *);
int echo_area_active (struct frame *);
Lisp_Object echo_area_contents (struct frame *);
void message_internal (const Ibyte *, Lisp_Object, Bytecount, Bytecount);
void message_append_internal (const Ibyte *, Lisp_Object,
			      Bytecount, Bytecount);
MODULE_API void message (const char *, ...) PRINTF_ARGS (1, 2);
void message_append (const char *, ...) PRINTF_ARGS (1, 2);
void message_no_translate (const char *, ...) PRINTF_ARGS (1, 2);
void clear_message (void);

extern Lisp_Object Qcompletion_ignore_case;
extern Lisp_Object Vecho_area_buffer;
extern Lisp_Object Vminibuf_preprompt;
extern Lisp_Object Vminibuf_prompt;
extern Lisp_Object Vminibuffer_zero;

/* Defined in mule-charset.c */
EXFUN (Fmake_charset, 3);

extern Lisp_Object Ql2r, Qr2l;
extern Lisp_Object Qdirection;
extern Lisp_Object Qfinal;
extern Lisp_Object Qgraphic;
extern Lisp_Object Qlong_name;
extern Lisp_Object Qregistries;
extern Lisp_Object Qreverse_direction_charset;
extern Lisp_Object Qshort_name;

/* Defined in nt.c */
extern Lisp_Object Vmswindows_get_true_file_attributes;

EXFUN (Ffind_charset, 1);
EXFUN (Fget_charset, 1);
EXFUN (Fcharset_list, 0);
EXFUN (Fcharset_name, 1);
EXFUN (Fcharset_id, 1);

extern Lisp_Object Vcharset_ascii;
extern Lisp_Object Vcharset_control_1;
extern Lisp_Object Vcharset_latin_iso8859_1;
extern Lisp_Object Vcharset_latin_iso8859_2;
extern Lisp_Object Vcharset_latin_iso8859_3;
extern Lisp_Object Vcharset_latin_iso8859_4;
extern Lisp_Object Vcharset_thai_tis620;
extern Lisp_Object Vcharset_arabic_iso8859_6;
extern Lisp_Object Vcharset_greek_iso8859_7;
extern Lisp_Object Vcharset_hebrew_iso8859_8;
extern Lisp_Object Vcharset_katakana_jisx0201;
extern Lisp_Object Vcharset_latin_jisx0201;
extern Lisp_Object Vcharset_cyrillic_iso8859_5;
extern Lisp_Object Vcharset_latin_iso8859_9;
extern Lisp_Object Vcharset_latin_iso8859_15;
extern Lisp_Object Vcharset_chinese_sisheng;
extern Lisp_Object Vcharset_japanese_jisx0208_1978;
extern Lisp_Object Vcharset_chinese_gb2312;
extern Lisp_Object Vcharset_japanese_jisx0208;
extern Lisp_Object Vcharset_korean_ksc5601;
extern Lisp_Object Vcharset_japanese_jisx0212;
extern Lisp_Object Vcharset_chinese_cns11643_1;
extern Lisp_Object Vcharset_chinese_cns11643_2;
extern Lisp_Object Vcharset_chinese_big5_1;
extern Lisp_Object Vcharset_chinese_big5_2;
#ifdef UNICODE_INTERNAL
extern Lisp_Object Vcharset_japanese_shift_jis;
#endif /* UNICODE_INTERNAL */
extern Lisp_Object Vcharset_composite;

extern Lisp_Object
  Qlatin_iso8859_1,
  Qlatin_iso8859_2,
  Qlatin_iso8859_3,
  Qlatin_iso8859_4,
  Qthai_tis620,
  Qarabic_iso8859_6,
  Qgreek_iso8859_7,
  Qhebrew_iso8859_8,
  Qkatakana_jisx0201,
  Qlatin_jisx0201,
  Qcyrillic_iso8859_5,
  Qlatin_iso8859_9,
  Qlatin_iso8859_15,
  Qjapanese_jisx0208_1978,
  Qchinese_gb2312,
  Qjapanese_jisx0208,
  Qkorean_ksc5601,
  Qjapanese_jisx0212,
  Qchinese_cns11643_1,
  Qchinese_cns11643_2,
#ifdef UNICODE_INTERNAL
  Qjapanese_shift_jis,
#endif /* UNICODE_INTERNAL */
  Qchinese_big5_1,
  Qchinese_big5_2,
  Qchinese_sisheng,
  Qcomposite;

/* Defined in print.c */
EXFUN (Fdisplay_error, 2);
EXFUN (Ferror_message_string, 1);
EXFUN (Fprin1, 2);
EXFUN (Fprin1_to_string, 2);
EXFUN (Fprinc, 2);
EXFUN (Fprint, 2);

Lisp_Object prin1_to_string (Lisp_Object, int);

/* Lower-level ways to output data: */
void default_object_printer (Lisp_Object, Lisp_Object, int);
void print_internal (Lisp_Object, Lisp_Object, int);
void debug_print (Lisp_Object);
void debug_p4 (Lisp_Object obj);
void debug_p3 (Lisp_Object obj);
void debug_short_backtrace (EMACS_INT);
void debug_backtrace (void);
MODULE_API Bytecount write_lisp_string (Lisp_Object stream, Lisp_Object string,
					Bytecount offset, Bytecount len);

/* NOTE: Do not call the following with the data of a Lisp_String.  Use
   write_lisp_string().

   If you would like a STREAM value of Qt, Qnil to indicate output to the
   selected frame, rather than C's standard output, call
   canonicalize_printcharfun () before calling this function. */
MODULE_API Bytecount write_string_1 (Lisp_Object stream, const Ibyte *str,
				      Bytecount size);

/* Same goes for this function. */
DECLARE_INLINE_MODULE_API (
Bytecount write_istring (Lisp_Object stream, const Ibyte *str)
)
{
  /* This function can GC. We'd like to qxestrlen, but that's not yet
     available in this file. */
  return write_string_1 (stream, str,
			 (Bytecount) strlen ((const char *) str));
}
/* Same goes for this function. */
DECLARE_INLINE_MODULE_API (
Bytecount write_cistring (Lisp_Object stream, const CIbyte *str)
)
{
  /* This function can GC. We'd like to qxestrlen, but that's not yet
     available in this file. */
  return write_string_1 (stream, (const Ibyte *) str,
			 (Bytecount) strlen ((const char *) str));
}
/* Same goes for this function. */
DECLARE_INLINE_MODULE_API (
Bytecount write_ascstring (Lisp_Object stream, const Ascbyte *str)
)
{
  /* This function can GC. */
  return write_string_1 (stream, (const Ibyte *) str,
			 (Bytecount) strlen ((char *) str));
}
Bytecount write_eistring (Lisp_Object stream, const Eistring *ei);

Bytecount external_out (int dest, const CIbyte *fmt, ...) PRINTF_ARGS (2, 3);
Bytecount debug_out (const CIbyte *, ...) PRINTF_ARGS (1, 2);
Bytecount debug_out_lisp (const CIbyte *, ...);
DECLARE_DOESNT_RETURN (fatal (const CIbyte *, ...)) PRINTF_ARGS(1, 2);

/* Internal functions: */
Lisp_Object canonicalize_printcharfun (Lisp_Object printcharfun);
void temp_output_buffer_setup (Lisp_Object);
void temp_output_buffer_show (Lisp_Object, Lisp_Object);
void print_cons (Lisp_Object, Lisp_Object, int);
void print_vector (Lisp_Object, Lisp_Object, int);
void print_string (Lisp_Object, Lisp_Object, int);
void print_symbol (Lisp_Object, Lisp_Object, int);
void print_float (Lisp_Object, Lisp_Object, int);

extern int print_escape_newlines;
extern MODULE_API int print_readably;
extern int in_debug_print;
Lisp_Object internal_with_output_to_temp_buffer (Lisp_Object,
						 Lisp_Object (*) (Lisp_Object),
						 Lisp_Object, Lisp_Object);
Bytecount float_to_string (char *, double);
void internal_object_printer (Lisp_Object obj, Lisp_Object printcharfun,
			      int UNUSED (escapeflag));
void external_object_printer (Lisp_Object obj, Lisp_Object printcharfun,
			      int UNUSED (escapeflag));
MODULE_API DECLARE_DOESNT_RETURN (printing_unreadable_object_fmt (const CIbyte *,
							      ...))
       PRINTF_ARGS (1, 2);
DECLARE_DOESNT_RETURN (printing_unreadable_lisp_object (Lisp_Object obj,
						     const Ibyte *name));

#define PRINT_PREPROCESS(obj, print_number_table, seen_object_count)	\
  do if (LRECORDP (obj)							\
	 && XRECORD_LHEADER_IMPLEMENTATION (obj)->print_preprocess)	\
    {									\
      print_preprocess (obj, print_number_table, seen_object_count);	\
    } while (0)

typedef struct { Lisp_Object table; Elemcount *count; } preprocess_info_t;

void print_preprocess (Lisp_Object obj, Lisp_Object print_number_table,
                       Elemcount *seen_object_count);

/* These is in print.c because they use the print_preprocess
   infrastructure. */
Lisp_Object nsubst_structures_descend (Lisp_Object new_, Lisp_Object old,
                                       Lisp_Object object,
                                       Lisp_Object number_table,
                                       Boolint test_not_unboundp);

Lisp_Object nsubst_structures (Lisp_Object new_, Lisp_Object old,
                               Lisp_Object tree,
                               check_test_func_t check_test,
                               Boolint test_not_unboundp,
                               Lisp_Object test, Lisp_Object key);

extern Lisp_Object Qexternal_debugging_output;
extern Lisp_Object Qprint_length;
extern Lisp_Object Qprint_string_length;
extern Lisp_Object Qstandard_output;
extern Lisp_Object Vprint_length;
extern Lisp_Object Vprint_level;
extern Lisp_Object Vstandard_output;
extern Lisp_Object Vprint_table_nonreadably_length;

/* Defined in process.c */
extern Lisp_Object Qnetwork_error;
extern Lisp_Object Qtls_error;
extern MODULE_API Lisp_Object Qprocess_error;
extern Lisp_Object Vprocess_environment;
extern Lisp_Object Vshell_file_name;

/* Defined in rangetab.c */
EXFUN (Fclear_range_table, 1);
EXFUN (Fget_range_table, 3);
EXFUN (Fmake_range_table, 1);
EXFUN (Fput_range_table, 4);
EXFUN (Fcopy_range_table, 1);

extern Lisp_Object Qstart_closed_end_open;
extern Lisp_Object Qstart_open_end_open;
extern Lisp_Object Qstart_closed_end_closed;
extern Lisp_Object Qstart_open_end_closed;

void put_range_table (Lisp_Object, EMACS_INT, EMACS_INT, Lisp_Object);
int unified_range_table_bytes_needed (Lisp_Object);
int unified_range_table_bytes_used (void *);
void unified_range_table_copy_data (Lisp_Object, void *);
Lisp_Object unified_range_table_lookup (void *, EMACS_INT, Lisp_Object);
int unified_range_table_nentries (void *);
void unified_range_table_get_range (void *, int, EMACS_INT *, EMACS_INT *,
				    Lisp_Object *);

/* Defined in search.c */
EXFUN (Fmatch_beginning, 1);
EXFUN (Fmatch_end, 1);
EXFUN (Fskip_chars_backward, 3);
EXFUN (Fskip_chars_forward, 3);
EXFUN (Fstring_match, 4);
EXFUN (Fregexp_quote, 1);

struct re_pattern_buffer;
struct re_registers;

void flush_unused_lisp_search_registers (void);

Charbpos scan_buffer (struct buffer *, Ichar, Charbpos, Charbpos, EMACS_INT,
		      EMACS_INT *, int);
Bytebpos byte_scan_buffer (struct buffer *, Ichar, Bytebpos, Bytebpos ,
                           EMACS_INT, EMACS_INT *, int);

DECLARE_INLINE_HEADER (
Bytebpos
byte_find_next_newline (struct buffer *buf, Bytebpos from, int count)
)
{
  return byte_scan_buffer (buf, '\n', from, 0, count, 0, 1);
}

DECLARE_INLINE_HEADER (
Bytebpos
byte_find_next_newline_no_quit (struct buffer *buf, Bytebpos from, int count)
)
{
  return byte_scan_buffer (buf, '\n', from, 0, count, 0, 0);
}

DECLARE_INLINE_HEADER (
Charbpos
find_next_newline (struct buffer *buf, Charbpos from, int count)
)
{
  return scan_buffer (buf, '\n', from, 0, count, 0, 1);
}

DECLARE_INLINE_HEADER (
Charbpos
find_next_newline_no_quit (struct buffer *buf, Charbpos from, int count)
)
{
  return scan_buffer (buf, '\n', from, 0, count, 0, 0);
}

Bytecount byte_find_next_ichar_in_string (Lisp_Object, Ichar, Bytecount,
					 EMACS_INT);
struct re_pattern_buffer *compile_pattern (Lisp_Object pattern,
					   struct re_registers *regp,
					   Lisp_Object translate,
					   Lisp_Object searchobj,
					   struct buffer *searchbuf,
					   int posix, Error_Behavior errb);
Bytecount fast_string_match (Lisp_Object, const Ibyte *,
			     Lisp_Object, Bytecount,
			     Bytecount, Boolint, Error_Behavior, Boolint);
Bytecount fast_lisp_string_match (Lisp_Object, Lisp_Object);
extern Fixnum warn_about_possibly_incompatible_back_references;

/* Defined in sequence.c */
EXFUN (Ffill, KEYWORDS);
EXFUN (Fclear_string, 1);
EXFUN (Freplace, KEYWORDS);
EXFUN (Fposition, KEYWORDS);
EXFUN (Fmapconcat, MANY);
EXFUN (FassocX, KEYWORDS);

Lisp_Object concatenate (int nsequences, Lisp_Object *sequences,
                         Lisp_Object result_type, Boolint reuse_last_listp);

/* Defined in signal.c */
void init_interrupts_late (void);

/* Defined in sound.c */
EXFUN (Fding, 3);

void init_device_sound (struct device *);
DECLARE_DOESNT_RETURN (report_sound_error (const Ascbyte *, Lisp_Object));

extern Lisp_Object Qsound_error;
extern Lisp_Object Vsynchronous_sounds;

/* Defined in specifier.c */
DECLARE_DOESNT_RETURN (error_or_quit_failed_instantiator_in_domain
                       (const Ascbyte *, Lisp_Object instantiator,
                        Lisp_Object domain));

EXFUN (Fadd_spec_to_specifier, 5);
EXFUN (Fspecifier_spec_list, 4);

Lisp_Object specifier_instance (Lisp_Object, Lisp_Object, Lisp_Object,
				Error_Behavior, int, int, Lisp_Object);
Lisp_Object specifier_instance_no_quit (Lisp_Object, Lisp_Object, Lisp_Object,
					Error_Behavior, int, Lisp_Object);

/* Defined in symbols.c */
EXFUN (Fboundp, 1);
EXFUN (Fbuilt_in_variable_type, 1);
EXFUN (Fdefault_boundp, 1);
EXFUN (Fdefault_value, 1);
EXFUN (Ffboundp, 1);
EXFUN (Ffset, 2);
EXFUN (Fintern, 2);
EXFUN (Fintern_soft, 3);
EXFUN (Fkill_local_variable, 1);
EXFUN (Fset, 2);
EXFUN (Fset_default, 2);
EXFUN (Fsymbol_function, 1);
EXFUN (Fsymbol_name, 1);
EXFUN (Fsymbol_plist, 1);
EXFUN (Fsymbol_value, 1);

unsigned int hash_string (const Ibyte *, Bytecount);
Lisp_Object intern_istring (const Ibyte *str, Bytecount len,
			    Lisp_Object reloc, Lisp_Object package);
MODULE_API Lisp_Object intern (const CIbyte *str);
Lisp_Object intern_massaging_name (const CIbyte *str);
Lisp_Object oblookup (Lisp_Object, const Ibyte *, Bytecount);
/* Note that the mapper function has the same signature as in elisp_maphash. */
void map_obarray (Lisp_Object, int (*) (Lisp_Object, Lisp_Object, void *),
                  void *);
Lisp_Object indirect_function (Lisp_Object, int);
Lisp_Object symbol_value_in_buffer (Lisp_Object, Lisp_Object);
void kill_buffer_local_variables (struct buffer *);
int symbol_value_buffer_local_info (Lisp_Object, struct buffer *);
Lisp_Object find_symbol_value (Lisp_Object);
Lisp_Object find_symbol_value_quickly (Lisp_Object, int);
Lisp_Object top_level_value (Lisp_Object);
void reject_constant_symbols (Lisp_Object sym, Lisp_Object newval,
			      int function_p,
			      Lisp_Object follow_past_lisp_magic);
MODULE_API Lisp_Object defsubr (const CIbyte *lname, lisp_fn_t Fname, 
                                short min_args, short max_args,
                                const CIbyte *prompt);
MODULE_API Lisp_Object defsubr_macro (const CIbyte *lname, lisp_fn_t Fname,
                                      short min_args, short max_args,
                                      const CIbyte *prompt);

extern Lisp_Object Qconst_specifier;
extern Lisp_Object Qmakunbound;
extern Lisp_Object Qset;
extern Lisp_Object Qvariable_documentation;
extern Lisp_Object Qvariable_domain;
extern MODULE_API Lisp_Object Qt, Qunbound;
extern Lisp_Object Vobarray;

/* Defined in syntax.c */
Charbpos scan_words (struct buffer *, Charbpos, EMACS_INT);
Bytebpos byte_scan_words (struct buffer *, Bytebpos, EMACS_INT);

EXFUN (Fchar_syntax, 2);
EXFUN (Fforward_word, 2);
extern Lisp_Object Vstandard_syntax_table;
void signal_syntax_cache_extent_changed (EXTENT extent);
void signal_syntax_cache_extent_adjust (struct buffer *buf);
void init_buffer_syntax_cache (struct buffer *buf);
void uninit_buffer_syntax_cache (struct buffer *buf);
extern Lisp_Object Qsyntax_table;

/* Defined in sysdep.c */
EMACS_INT get_random (void);
void seed_random (EMACS_INT arg);

/* Defined in text.c */
void find_charsets_in_ibyte_string (Lisp_Object_dynarr *charsets,
				    const Ibyte *str, Bytecount len,
				    struct buffer *buf);
void find_charsets_in_buffer (Lisp_Object_dynarr *charsets,
			      struct buffer *buf, Charbpos pos, Charcount len);
int ibyte_string_displayed_columns (const Ibyte *str, Bytecount len);

Charcount convert_ibyte_string_into_ichar_string (const Ibyte *str,
						     Bytecount len,
						     Ichar *arr);

Bytecount copy_text_between_formats (const Ibyte *src, Bytecount srclen,
				     Internal_Format srcfmt,
				     Lisp_Object srcobj,
				     Ibyte *dst, Bytecount dstlen,
				     Internal_Format dstfmt,
				     Lisp_Object dstobj,
				     Bytecount *src_used);
Bytecount copy_buffer_text_out (struct buffer *buf, Bytebpos pos,
				Bytecount len, Ibyte *dst, Bytecount dstlen,
				Internal_Format dstfmt, Lisp_Object dstobj,
				Bytecount *src_used);

/* flags for get_buffer_pos_char(), get_buffer_range_char(), etc. */
/* At most one of GB_COERCE_RANGE and GB_NO_ERROR_IF_BAD should be
   specified.  At most one of GB_NEGATIVE_FROM_END and GB_NO_ERROR_IF_BAD
   should be specified. */

#define GB_ALLOW_PAST_ACCESSIBLE	(1 << 0)
#define GB_ALLOW_NIL			(1 << 1)
#define GB_CHECK_ORDER			(1 << 2)
#define GB_COERCE_RANGE			(1 << 3)
#define GB_NO_ERROR_IF_BAD		(1 << 4)
#define GB_NEGATIVE_FROM_END		(1 << 5)
#define GB_NEED_CHAR_BEFORE             (1 << 6)
#define GB_NEED_CHAR_AFTER              (1 << 7)
#define GB_HISTORICAL_STRING_BEHAVIOR	(GB_NEGATIVE_FROM_END | GB_ALLOW_NIL)

Charbpos get_buffer_pos_char (struct buffer *b, Lisp_Object pos,
			    unsigned int flags);
Bytebpos get_buffer_pos_byte (struct buffer *b, Lisp_Object pos,
			    unsigned int flags);
void get_buffer_pos_both (struct buffer *, Lisp_Object pos,
                          unsigned int flags, Charbpos *cpos_out,
                          Bytebpos *bpos_out);
void get_buffer_range_char (struct buffer *b, Lisp_Object from, Lisp_Object to,
			    Charbpos *from_out, Charbpos *to_out,
			    unsigned int flags);
void get_buffer_range_byte (struct buffer *b, Lisp_Object from, Lisp_Object to,
			    Bytebpos *from_out, Bytebpos *to_out,
			    unsigned int flags);
Charcount get_string_pos_char (Lisp_Object string, Lisp_Object pos,
			       unsigned int flags);
Bytecount get_string_pos_byte (Lisp_Object string, Lisp_Object pos,
			       unsigned int flags);
void get_string_range_char (Lisp_Object string, Lisp_Object from,
			    Lisp_Object to, Charcount *from_out,
			    Charcount *to_out, unsigned int flags);
void get_string_range_byte (Lisp_Object string, Lisp_Object from,
			    Lisp_Object to, Bytecount *from_out,
			    Bytecount *to_out, unsigned int flags);
Charxpos get_buffer_or_string_pos_char (Lisp_Object object, Lisp_Object pos,
					unsigned int flags);
Bytexpos get_buffer_or_string_pos_byte (Lisp_Object object, Lisp_Object pos,
					unsigned int flags);
void get_buffer_or_string_range_char (Lisp_Object object, Lisp_Object from,
				      Lisp_Object to, Charxpos *from_out,
				      Charxpos *to_out, unsigned int flags);
void get_buffer_or_string_range_byte (Lisp_Object object, Lisp_Object from,
				      Lisp_Object to, Bytexpos *from_out,
				      Bytexpos *to_out, unsigned int flags);
Charxpos buffer_or_string_accessible_begin_char (Lisp_Object object);
Charxpos buffer_or_string_accessible_end_char (Lisp_Object object);
Bytexpos buffer_or_string_accessible_begin_byte (Lisp_Object object);
Bytexpos buffer_or_string_accessible_end_byte (Lisp_Object object);
Charxpos buffer_or_string_absolute_begin_char (Lisp_Object object);
Charxpos buffer_or_string_absolute_end_char (Lisp_Object object);
Bytexpos buffer_or_string_absolute_begin_byte (Lisp_Object object);
Bytexpos buffer_or_string_absolute_end_byte (Lisp_Object object);
Charbpos charbpos_clip_to_bounds (Charbpos lower, Charbpos num,
				  Charbpos upper);
Bytebpos bytebpos_clip_to_bounds (Bytebpos lower, Bytebpos num,
				  Bytebpos upper);
Charxpos charxpos_clip_to_bounds (Charxpos lower, Charxpos num,
				  Charxpos upper);
Bytexpos bytexpos_clip_to_bounds (Bytexpos lower, Bytexpos num,
				  Bytexpos upper);
Charxpos buffer_or_string_clip_to_accessible_char (Lisp_Object object,
						   Charxpos pos);
Bytexpos buffer_or_string_clip_to_accessible_byte (Lisp_Object object,
						   Bytexpos pos);
Charxpos buffer_or_string_clip_to_absolute_char (Lisp_Object object,
						 Charxpos pos);
Bytexpos buffer_or_string_clip_to_absolute_byte (Lisp_Object object,
						 Bytexpos pos);
void internal_to_external_charset_codepoint (Lisp_Object charset,
					     int int_c1, int int_c2,
					     int *ext_c1, int *ext_c2,
					     int munge_codepoints);
Lisp_Object get_external_charset_codepoint (Lisp_Object charset,
					    Lisp_Object arg1, Lisp_Object arg2,
					    int *a1, int *a2,
					    int munge_codepoints);
enum converr decode_handle_error (Lisp_Object err, int allow_private);

#ifdef ENABLE_COMPOSITE_CHARS
Ichar lookup_composite_char (Ibyte *str, int len);
Lisp_Object composite_char_string (Ichar ch);
#endif /* ENABLE_COMPOSITE_CHARS */

EXFUN (Ffind_charset, 1);
EXFUN (Fget_charset, 1);
EXFUN (Fcharset_list, 0);

extern Lisp_Object Vcharset_ascii;
extern Lisp_Object Vcharset_control_1;
extern Lisp_Object Vcharset_latin_iso8859_1;
extern Lisp_Object Vcharset_latin_iso8859_2;
extern Lisp_Object Vcharset_latin_iso8859_3;
extern Lisp_Object Vcharset_latin_iso8859_4;
extern Lisp_Object Vcharset_thai_tis620;
extern Lisp_Object Vcharset_greek_iso8859_7;
extern Lisp_Object Vcharset_arabic_iso8859_6;
extern Lisp_Object Vcharset_hebrew_iso8859_8;
extern Lisp_Object Vcharset_katakana_jisx0201;
extern Lisp_Object Vcharset_latin_jisx0201;
extern Lisp_Object Vcharset_cyrillic_iso8859_5;
extern Lisp_Object Vcharset_latin_iso8859_9;
extern Lisp_Object Vcharset_latin_iso8859_15;
extern Lisp_Object Vcharset_japanese_jisx0208_1978;
extern Lisp_Object Vcharset_chinese_gb2312;
extern Lisp_Object Vcharset_japanese_jisx0208;
extern Lisp_Object Vcharset_korean_ksc5601;
extern Lisp_Object Vcharset_japanese_jisx0212;
extern Lisp_Object Vcharset_chinese_cns11643_1;
extern Lisp_Object Vcharset_chinese_cns11643_2;
extern Lisp_Object Vcharset_chinese_big5_1;
extern Lisp_Object Vcharset_chinese_big5_2;
extern Lisp_Object Vcharset_composite;

Ichar Lstream_get_ichar_1 (Lstream *stream, int first_char);
int Lstream_fput_ichar (Lstream *stream, Ichar ch);
void Lstream_funget_ichar (Lstream *stream, Ichar ch);

DECLARE_INLINE_HEADER (Ibyte *qxestrdup (const Ibyte *s))
{
  return (Ibyte *) xstrdup ((const Chbyte *) s);
}

DECLARE_INLINE_HEADER (Bytecount qxestrlen (const Ibyte *s))
{
  return (Bytecount) strlen ((const Chbyte *) s);
}

DECLARE_INLINE_HEADER (Charcount qxestrcharlen (const Ibyte *s))
{
  return bytecount_to_charcount (s, qxestrlen (s));
}

DECLARE_INLINE_HEADER (int qxestrcmp (const Ibyte *s1,
				      const Ibyte *s2))
{
  return strcmp ((const Chbyte *) s1, (const Chbyte *) s2);
}

DECLARE_INLINE_HEADER (int qxestrcmp_ascii (const Ibyte *s1,
					    const Ascbyte *s2))
{
  return strcmp ((const Chbyte *) s1, s2);
}

DECLARE_INLINE_HEADER (int qxestrncmp (const Ibyte *string1,
				       const Ibyte *string2,
				       Bytecount count))
{
  return strncmp ((const Chbyte *) string1, (const Chbyte *) string2,
		  (size_t) count);
}

DECLARE_INLINE_HEADER (int qxestrncmp_ascii (const Ibyte *string1,
					     const Ascbyte *string2,
					     Bytecount count))
{
  return strncmp ((const Chbyte *) string1, string2, (size_t) count);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrcpy (Ibyte *strDest,
					 const Ibyte *strSource))
{
  return (Ibyte *) strcpy ((Chbyte *) strDest, (const Chbyte *) strSource);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrcpy_ascii (Ibyte *strDest,
					       const Ascbyte *strSource))
{
  return (Ibyte *) strcpy ((Chbyte *) strDest, strSource);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrncpy (Ibyte *strDest,
					  const Ibyte *strSource,
					  Bytecount count))
{
  return (Ibyte *) strncpy ((Chbyte *) strDest, (const Chbyte *) strSource,
			      (size_t) count);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrncpy_ascii (Ibyte *strDest,
						const Ascbyte *strSource,
						Bytecount count))
{
  return (Ibyte *) strncpy ((Chbyte *) strDest, strSource, (size_t) count);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrcat (Ibyte *strDest,
					 const Ibyte *strSource))
{
  return (Ibyte *) strcat ((Chbyte *) strDest, (const Chbyte *) strSource);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrcat_ascii (Ibyte *strDest,
					       const Ascbyte *strSource))
{
  return (Ibyte *) strcat ((Chbyte *) strDest, strSource);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrncat (Ibyte *strDest,
					  const Ibyte *strSource,
					  Bytecount count))
{
  return (Ibyte *) strncat ((Chbyte *) strDest, (const Chbyte *) strSource,
			      (size_t) count);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrncat_ascii (Ibyte *strDest,
						const Ascbyte *strSource,
						Bytecount count))
{
  return (Ibyte *) strncat ((Chbyte *) strDest, strSource, (size_t) count);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrchr (const Ibyte *s, Ichar c))
{
  assert (c >= 0 && c <= 255);
  return (Ibyte *) strchr ((const Chbyte *) s, c);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrrchr (const Ibyte *s, Ichar c))
{
  assert (c >= 0 && c <= 255);
  return (Ibyte *) strrchr ((const Chbyte *) s, c);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrstr (const Ibyte *string1,
					 const Ibyte *string2))
{
  return (Ibyte *) strstr ((const Chbyte *) string1, (const Chbyte *) string2);
}

DECLARE_INLINE_HEADER (Bytecount qxestrcspn (const Ibyte *string,
					     const CIbyte *strCharSet))
{
  return (Bytecount) strcspn ((const Chbyte *) string, strCharSet);
}

DECLARE_INLINE_HEADER (Bytecount qxestrspn (const Ibyte *string,
					    const CIbyte *strCharSet))
{
  return (Bytecount) strspn ((const Chbyte *) string, strCharSet);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrpbrk (const Ibyte *string,
					  const CIbyte *strCharSet))
{
  return (Ibyte *) strpbrk ((const Chbyte *) string, strCharSet);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrtok (Ibyte *strToken,
					 const CIbyte *strDelimit))
{
  return (Ibyte *) strtok ((Chbyte *) strToken, strDelimit);
}

DECLARE_INLINE_HEADER (double qxestrtod (const Ibyte *nptr,
					 Ibyte **endptr))
{
  return strtod ((const Chbyte *) nptr, (Chbyte **) endptr);
}

DECLARE_INLINE_HEADER (long qxestrtol (const Ibyte *nptr, Ibyte **endptr,
				       int base))
{
  return strtol ((const Chbyte *) nptr, (Chbyte **) endptr, base);
}

DECLARE_INLINE_HEADER (unsigned long qxestrtoul (const Ibyte *nptr,
						 Ibyte **endptr,
						 int base))
{
  return strtoul ((const Chbyte *) nptr, (Chbyte **) endptr, base);
}

DECLARE_INLINE_HEADER (int qxeatoi (const Ibyte *string))
{
  return atoi ((const Chbyte *) string);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrupr (Ibyte *s))
{
  return (Ibyte *) strupr ((Chbyte *) s);
}

DECLARE_INLINE_HEADER (Ibyte *qxestrlwr (Ibyte *s))
{
  return (Ibyte *) strlwr ((Chbyte *) s);
}

DECLARE_INLINE_HEADER (int qxesscanf_ascii_1 (Ibyte *buffer,
					      const Ascbyte *format,
					      void *ptr))
{
  /* #### DAMNIT! No vsscanf! */
  return sscanf ((Chbyte *) buffer, format, ptr);
}

/* Do not use POSIX locale routines.  Not Mule-correct. */
#define qxestrcoll DO NOT USE.
#define qxestrxfrm DO NOT USE.

int qxestrcasecmp (const Ibyte *s1, const Ibyte *s2);
int qxestrcasecmp_ascii (const Ibyte *s1, const Ascbyte *s2);
int qxestrcasecmp_i18n (const Ibyte *s1, const Ibyte *s2);
int ascii_strcasecmp (const Ascbyte *s1, const Ascbyte *s2);
int lisp_strcasecmp_ascii (Lisp_Object s1, Lisp_Object s2);
int lisp_strcasecmp_i18n (Lisp_Object s1, Lisp_Object s2);
int qxestrncasecmp (const Ibyte *s1, const Ibyte *s2, Bytecount len);
int qxestrncasecmp_ascii (const Ibyte *s1, const Ascbyte *s2,
			  Bytecount len);
int qxestrncasecmp_i18n (const Ibyte *s1, const Ibyte *s2, Bytecount len);
int ascii_strncasecmp (const Ascbyte *s1, const Ascbyte *s2,
		       Bytecount len);
int qxememcmp (const Ibyte *s1, const Ibyte *s2, Bytecount len);
int qxememcmp4 (const Ibyte *s1, Bytecount len1,
		const Ibyte *s2, Bytecount len2);
int qxememcasecmp (const Ibyte *s1, const Ibyte *s2, Bytecount len);
int qxememcasecmp4 (const Ibyte *s1, Bytecount len1,
		    const Ibyte *s2, Bytecount len2);
int qxetextcmp (const Ibyte *s1, Bytecount len1,
		const Ibyte *s2, Bytecount len2);
int qxetextcmp_matching (const Ibyte *s1, Bytecount len1,
			 const Ibyte *s2, Bytecount len2,
			 Charcount *matching);
int qxetextcasecmp (const Ibyte *s1, Bytecount len1,
		    const Ibyte *s2, Bytecount len2);
int qxetextcasecmp_matching (const Ibyte *s1, Bytecount len1,
			     const Ibyte *s2, Bytecount len2,
			     Charcount *matching);

void buffer_mule_signal_inserted_region (struct buffer *buf, Charbpos start,
					 Bytecount bytelength,
					 Charcount charlength);
void buffer_mule_signal_deleted_region (struct buffer *buf, Charbpos start,
					Charbpos end, Bytebpos byte_start,
					Bytebpos byte_end);

typedef struct
{
  const char *srctext;
  void *dst;
  Bytecount dst_size;
} alloca_convert_vals;

typedef struct
{
  Dynarr_declare (alloca_convert_vals);
} alloca_convert_vals_dynarr;

extern alloca_convert_vals_dynarr *active_alloca_convert;

MODULE_API int find_pos_of_existing_active_alloca_convert (const char *
							   srctext);

#ifdef UNICODE_INTERNAL
extern int firstbyte_mask[];
extern unsigned int utf8_offsets_by_rep_bytes[];
#endif /* UNICODE_INTERNAL */

/* Defined in undo.c */
extern Lisp_Object Qinhibit_read_only;

/* Defined in unicode.c */
extern const struct sized_memory_description to_unicode_description;
extern const struct sized_memory_description from_unicode_description;
void init_charset_unicode_tables (Lisp_Object charset);
void free_charset_unicode_tables (Lisp_Object charset);
Lisp_Object allocate_precedence_array (void);
void reset_precedence_array (Lisp_Object precarray);
void begin_precedence_array_generation (void);
void add_charset_to_precedence_array (Lisp_Object charset,
				     Lisp_Object preclist);
void add_charsets_to_precedence_array (Lisp_Object list,
				       Lisp_Object precarray);
void charset_created_recalculate_unicode_precedence (void);
void disksave_clear_unicode_precedence (void);
Lisp_Object simple_convert_predence_list_to_array (Lisp_Object charsets);
Lisp_Object precedence_array_to_list (Lisp_Object precarray);

Lisp_Object decode_buffer_or_precedence_list (Lisp_Object preclist);
int unicode_precedence_list_changed (Lisp_Object sym, Lisp_Object *val,
				     Lisp_Object in_object, int flags);
extern Lisp_Object Vdefault_unicode_precedence_array;
extern Lisp_Object Qunicode;
extern Lisp_Object Qutf_16, Qutf_8, Qucs_4, Qutf_7, Qutf_32;
#ifdef MEMORY_USAGE_STATS
Bytecount compute_from_unicode_table_size (Lisp_Object charset,
					   struct usage_stats *stats);
Bytecount compute_to_unicode_table_size (Lisp_Object charset,
					 struct usage_stats *stats);
#endif /* MEMORY_USAGE_STATS */
void initialize_ascii_control_1_latin_1_unicode_translation (void);
int decode_unicode (Lisp_Object unicode, enum unicode_allow allow);
void free_precedence_array (Lisp_Object preclist);
void init_charset_unicode_map (Lisp_Object charset, Lisp_Object map);
void autoload_charset_unicode_tables (Lisp_Object charset);

EXFUN (Fset_charset_tags, 2);

/* Defined in undo.c */
EXFUN (Fundo_boundary, 0);

Lisp_Object truncate_undo_list (Lisp_Object, Fixnum, Fixnum);
void record_extent (Lisp_Object, int);
void record_insert (struct buffer *, Charbpos, Charcount);
void record_delete (struct buffer *, Charbpos, Charcount);
void record_change (struct buffer *, Charbpos, Charcount);

#ifdef RUN_TIME_REMAP
int run_time_remap (char *);
#endif

/* Defined in vm-limit.c */
void memory_warnings (void *, void (*) (const char *));

/* Defined in win32.c */
extern Lisp_Object Vmswindows_downcase_file_names;

/* Defined in window.c */
extern Lisp_Object Qwindow_live_p;


/************************************************************************/
/*			 String translation				*/
/************************************************************************/

/* When support for message translation exists, GETTEXT() translates a
   string from English into the language defined by
   `current-language-environment'.  This is done by looking the string
   up in a large predefined table; if no translation is found, the
   original string is returned, and the failure is possibly logged so
   that the translation can later be entered into the table.

   In addition to this, there is a mechanism to snarf message strings
   out of the source code so that they can be entered into the tables.
   This is what make-msgfile.lex does.

   Handling `format' strings is more difficult: The format string
   should get translated, but not under all circumstances.  When the
   format string is a Lisp string, what should happen is that
   Fformat() should format the untranslated args[0] and return that,
   and also call Fgettext() on args[0] and, if that is different,
   format it and store it in the `string-translatable' property of the
   returned string.  See Fgettext().

   The variations IGETTEXT, CIGETTEXT and ASCGETTEXT operate on
   Ibyte *, CIbyte *, and Ascbyte * strings, respectively.  The
   ASCGETTEXT version has an assert check to verify that its string
   really is pure-ASCII.  Plain GETTEXT is defined as ASCGETTEXT, and
   so works the same way. (There are no versions that work for Extbyte *.
   Translate to internal format before working on it.)

   There are similar functions for building a Lisp string from a C
   string and translating in the process.  They again come in three
   variants: build_msg_istring(), build_msg_cistring(), and
   build_msg_ascstring().  Again, build_msg_ascstring() asserts that
   its text is pure-ASCII, and build_msg_string() is the same as
   build_msg_ascstring().
   */

/* Return value NOT Ascbyte, because the result in general will have been
   translated into a foreign language. */
DECLARE_INLINE_HEADER (const CIbyte *ASCGETTEXT (const Ascbyte *s))
{
  ASSERT_ASCTEXT_ASCII (s);
  return s;
}

DECLARE_INLINE_HEADER (const Ibyte *IGETTEXT (const Ibyte *s))
{
  return s;
}

DECLARE_INLINE_HEADER (const CIbyte *CIGETTEXT (const CIbyte *s))
{
  return s;
}

DECLARE_INLINE_HEADER (Lisp_Object LISP_GETTEXT (Lisp_Object s))
{
  return s;
}

#define GETTEXT ASCGETTEXT

MODULE_API Lisp_Object build_msg_istring (const Ibyte *);
MODULE_API Lisp_Object build_msg_cistring (const CIbyte *);
MODULE_API Lisp_Object build_msg_ascstring (const Ascbyte *);
#define build_msg_string build_msg_ascstring


/* DEFER_GETTEXT() and variants are used to identify strings which are not
   meant to be translated immediately, but instead at some later time.
   This is used in strings that are stored somewhere at dump or
   initialization time, at a time when the current language environment is
   not set.  It is the duty of the user of the string to call GETTEXT or
   some variant at the appropriate time.  DEFER_GETTTEXT() serves only as a
   marker that the string is translatable, and will as a result be snarfed
   during message snarfing (see above).

   build_defer_string() and variants are the deferred equivalents of
   build_msg_string() and variants.  Similarly to DEFER_GETTEXT(), they
   don't actually do any translation, but serve as place markers for
   message snarfing.  However, they may do something more than just build
   a Lisp string -- in particular, they may store a string property
   indicating that the string is translatable (see discussion above about
   this property).
*/

DECLARE_INLINE_HEADER (const Ascbyte *DEFER_ASCGETTEXT (const Ascbyte *s))
{
  ASSERT_ASCTEXT_ASCII (s);
  return s;
}

DECLARE_INLINE_HEADER (const Ibyte *DEFER_IGETTEXT (const Ibyte *s))
{
  return s;
}

DECLARE_INLINE_HEADER (const CIbyte *DEFER_CIGETTEXT (const CIbyte *s))
{
  return s;
}

#define DEFER_GETTEXT DEFER_ASCGETTEXT

MODULE_API Lisp_Object build_defer_istring (const Ibyte *);
MODULE_API Lisp_Object build_defer_cistring (const CIbyte *);
MODULE_API Lisp_Object build_defer_ascstring (const Ascbyte *);

#define build_defer_string build_defer_ascstring

DECLARE_INLINE_HEADER (
void
write_msg_istring (Lisp_Object stream, const Ibyte *str)
)
{
  /* This function can GC */
  str = IGETTEXT (str);
  write_string_1 (stream, str, qxestrlen (str));
}

DECLARE_INLINE_HEADER (
void
write_msg_cistring (Lisp_Object stream, const CIbyte *str)
)
{
  /* This function can GC */
  str = CIGETTEXT (str);
  write_string_1 (stream, (const Ibyte *) str,
                  qxestrlen ((const Ibyte *) str));
}

DECLARE_INLINE_HEADER (
void
write_msg_ascstring (Lisp_Object stream, const Ascbyte *str)
)
{
  /* This function can GC */
  str = ASCGETTEXT (str);
  write_string_1 (stream, (const Ibyte *) str,
                  (Bytecount) strlen ((const Ascbyte *) str));
}

#define write_msg_string write_msg_ascstring

END_C_DECLS

#endif /* INCLUDED_lisp_h_ */
