(PVEC_TYPE_MASK): Add the bit for hash tables.
[bpt/emacs.git] / src / lisp.h
index 15f7186..d5e4aad 100644 (file)
@@ -18,6 +18,13 @@ along with GNU Emacs; see the file COPYING.  If not, write to
 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 Boston, MA 02111-1307, USA.  */
 
+/* Declare the prototype for a general external function.  */
+#if defined (__STDC__) || defined (WINDOWSNT)
+#define P_(proto) proto
+#else
+#define P_(proto) ()
+#endif
+
 
 /* These are default choices for the types to use.  */
 #ifndef EMACS_INT
@@ -236,7 +243,8 @@ enum pvec_type
   PVEC_CHAR_TABLE = 0x8000,
   PVEC_BOOL_VECTOR = 0x10000,
   PVEC_BUFFER = 0x20000,
-  PVEC_TYPE_MASK = 0x3fe00,
+  PVEC_HASH_TABLE = 0x40000,
+  PVEC_TYPE_MASK = 0x7fe00,
   PVEC_FLAG = PSEUDOVECTOR_FLAG
 };
 
@@ -545,20 +553,6 @@ struct Lisp_Buffer_Cons
     int bufpos;
   };
 
-#if 0
-
-/* Nonzero if STR is a multibyte string.  */
-#define STRING_MULTIBYTE(STR)  \
-  (XSTRING (STR)->size_byte != XSTRING (STR)->size)
-
-/* Return the length in bytes of STR.  */
-#define STRING_BYTES(STR)  ((STR)->size_byte + 0)
-
-/* Set the length in bytes of STR.  */
-#define SET_STRING_BYTES(STR, SIZE)  ((STR)->size_byte = (SIZE))
-
-#else
-
 /* Nonzero if STR is a multibyte string.  */
 #define STRING_MULTIBYTE(STR)  \
   (XSTRING (STR)->size_byte >= 0)
@@ -570,8 +564,6 @@ struct Lisp_Buffer_Cons
 /* Set the length in bytes of STR.  */
 #define SET_STRING_BYTES(STR, SIZE)  ((STR)->size_byte = (SIZE))
 
-#endif /* 0 */
-
 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
 
 struct Lisp_String
@@ -641,12 +633,25 @@ struct Lisp_Vector
    and 8-bit Europeans characters.  For these characters, do not check
    validity of CT.  Do not follow parent.  */
 #define CHAR_TABLE_REF(CT, IDX)                                \
-  ((IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS                        \
+  ((IDX) >= 0 && (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS  \
    ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])          \
       ? XCHAR_TABLE (CT)->contents[IDX]                        \
       : XCHAR_TABLE (CT)->defalt)                      \
    : Faref (CT, make_number (IDX)))
 
+/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
+   and 8-bit Europeans characters.  However, if the result is nil,
+   return IDX.
+
+   For these characters, do not check validity of CT
+   and do not follow parent.  */
+#define CHAR_TABLE_TRANSLATE(CT, IDX)                  \
+  ((IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS                        \
+   ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])          \
+      ? XINT (XCHAR_TABLE (CT)->contents[IDX])         \
+      : IDX)                                           \
+   : char_table_translate (CT, IDX))
+
 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
    8-bit Europeans characters.  Do not check validity of CT.  */
 #define CHAR_TABLE_SET(CT, IDX, VAL)                   \
@@ -731,6 +736,110 @@ struct Lisp_Subr
     char *prompt;
     char *doc;
   };
+
+\f
+/***********************************************************************
+                            Hash Tables
+ ***********************************************************************/
+
+/* The structure of a Lisp hash table.  */
+
+struct Lisp_Hash_Table
+{
+  /* Vector fields.  The hash table code doesn't refer to these.  */
+  EMACS_INT size;
+  struct Lisp_Vector *vec_next;
+  
+  /* Function used to compare keys.  */
+  Lisp_Object test;
+
+  /* Nil if table is non-weak.  Otherwise a symbol describing the
+     weakness of the table.  */
+  Lisp_Object weak;
+  
+  /* When the table is resized, and this is an integer, compute the
+     new size by adding this to the old size.  If a float, compute the
+     new size by multiplying the old size with this factor.  */
+  Lisp_Object rehash_size;
+
+  /* Resize hash table when number of entries/ table size is >= this
+     ratio, a float.  */
+  Lisp_Object rehash_threshold;
+
+  /* Number of key/value entries in the table.  */
+  Lisp_Object count;
+
+  /* Vector of keys and values.  The key of item I is found at index
+     2 * I, the value is found at index 2 * I + 1.  */
+  Lisp_Object key_and_value;
+
+  /* Vector of hash codes.. If hash[I] is nil, this means that that
+     entry I is unused.  */
+  Lisp_Object hash;
+
+  /* Vector used to chain entries.  If entry I is free, next[I] is the
+     entry number of the next free item.  If entry I is non-free,
+     next[I] is the index of the next entry in the collision chain.  */
+  Lisp_Object next;
+
+  /* Index of first free entry in free list.  */
+  Lisp_Object next_free;
+
+  /* Bucket vector.  A non-nil entry is the index of the first item in
+     a collision chain.  This vector's size can be larger than the
+     hash table size to reduce collisions.  */
+  Lisp_Object index;
+
+  /* Next weak hash table if this is a weak hash table.  The head
+     of the list is in Vweak_hash_tables.  */
+  Lisp_Object next_weak;
+
+  /* User-supplied hash function, or nil.  */
+  Lisp_Object user_hash_function;
+
+  /* User-supplied key comparison function, or nil.  */
+  Lisp_Object user_cmp_function;
+
+  /* C function to compare two keys.  */
+  int (* cmpfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object,
+                    unsigned, Lisp_Object, unsigned));
+
+  /* C function to compute hash code.  */
+  unsigned (* hashfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object));
+};
+
+
+#define XHASH_TABLE(OBJ) \
+     ((struct Lisp_Hash_Table *) XPNTR (OBJ))
+
+#define XSET_HASH_TABLE(VAR, PTR) \
+     (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
+
+#define HASH_TABLE_P(OBJ)  PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
+#define GC_HASH_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_HASH_TABLE)
+
+#define CHECK_HASH_TABLE(x, i)                                 \
+     do                                                                \
+       {                                                       \
+        if (!HASH_TABLE_P ((x)))                               \
+          x = wrong_type_argument (Qhash_table_p, (x));        \
+       }                                                       \
+     while (0)
+
+/* Default size for hash tables if not specified.  */
+
+#define DEFAULT_HASH_SIZE 65
+
+/* Default threshold specifying when to resize a hash table.  The
+   value gives the ratio of current entries in the hash table and the
+   size of the hash table.  */
+
+#define DEFAULT_REHASH_THRESHOLD 0.8
+
+/* Default factor by which to increase the size of a hash table.  */
+
+#define DEFAULT_REHASH_SIZE 1.5
+
 \f
 /* These structures are used for various misc types.  */
 
@@ -934,6 +1043,10 @@ typedef unsigned char UCHAR;
 #define CHAR_CTL   (0x4000000)
 #define CHAR_META  (0x8000000)
 
+#define CHAR_MODIFIER_MASK \
+  (CHAR_ALT | CHAR_SUPER | CHAR_HYPER  | CHAR_SHIFT | CHAR_CTL | CHAR_META)
+
+
 /* Actually, the current Emacs uses 19 bits for the character value
    itself.  */
 #define CHARACTERBITS 19
@@ -989,7 +1102,6 @@ typedef unsigned char UCHAR;
 /* Mask bits for character code.  */
 #define GLYPH_MASK_CHAR    0x0007FFFF /* The lowest 19 bits */
 
-#ifdef HAVE_FACES
 /* The FAST macros assume that we already know we're in an X window.  */
 
 /* Given a character code and a face ID, return the appropriate glyph.  */
@@ -1002,18 +1114,9 @@ typedef unsigned char UCHAR;
 #define FAST_GLYPH_FACE(glyph) (((glyph) & GLYPH_MASK_FACE) >> CHARACTERBITS)
 
 /* Slower versions that test the frame type first.  */
-#define MAKE_GLYPH(f, char, face) (FRAME_TERMCAP_P (f) ? (char) \
-                                  : FAST_MAKE_GLYPH (char, face))
-#define GLYPH_CHAR(f, g) (FRAME_TERMCAP_P (f) ? (g) : FAST_GLYPH_CHAR (g))
-#define GLYPH_FACE(f, g) (FRAME_TERMCAP_P (f) ? (0) : FAST_GLYPH_FACE (g))
-#else /* not HAVE_FACES */
-#define MAKE_GLYPH(f, char, face) (char)
-#define FAST_MAKE_GLYPH(char, face) (char)
-#define GLYPH_CHAR(f, g) ((g) & GLYPH_MASK_CHAR)
-#define FAST_GLYPH_CHAR(g) ((g) & GLYPH_MASK_CHAR)
-#define GLYPH_FACE(f, g) ((g) & GLYPH_MASK_FACE)
-#define FAST_GLYPH_FACE(g) ((g) & GLYPH_MASK_FACE)
-#endif /* not HAVE_FACES */
+#define MAKE_GLYPH(f, char, face) (FAST_MAKE_GLYPH (char, face))
+#define GLYPH_CHAR(f, g) (FAST_GLYPH_CHAR (g))
+#define GLYPH_FACE(f, g) (FAST_GLYPH_FACE (g))
 
 /* Return 1 iff GLYPH contains valid character code.  */
 #define GLYPH_CHAR_VALID_P(glyph) \
@@ -1271,13 +1374,6 @@ typedef unsigned char UCHAR;
                         Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
 #endif
 
-/* Declare the prototype for a general external function.  */
-#if defined (__STDC__) || defined (WINDOWSNT)
-#define P_(proto) proto
-#else
-#define P_(proto) ()
-#endif
-
 /* defsubr (Sname);
  is how we define the symbol for function `name' at start-up time.  */
 extern void defsubr P_ ((struct Lisp_Subr *));
@@ -1648,17 +1744,19 @@ EXFUN (Ffind_operation_coding_system, MANY);
 EXFUN (Fencode_coding_string, 3);
 EXFUN (Fdecode_coding_string, 3);
 extern Lisp_Object detect_coding_system P_ ((unsigned char *, int, int));
+extern void init_coding P_ ((void));
 extern void init_coding_once P_ ((void));
 extern void syms_of_coding P_ ((void));
 
 /* Defined in charset.c */
 extern int nonascii_insert_offset;
-extern Lisp_Object Vnonascii_translate_table;
+extern Lisp_Object Vnonascii_translation_table;
 EXFUN (Fchar_bytes, 1);
 EXFUN (Fchar_width, 1);
 extern int chars_in_text P_ ((unsigned char *, int));
 extern int multibyte_chars_in_text P_ ((unsigned char *, int));
 extern int unibyte_char_to_multibyte P_ ((int));
+extern int multibyte_char_to_unibyte P_ ((int, Lisp_Object));
 extern Lisp_Object Qcharset;
 extern void init_charset_once P_ ((void));
 extern void syms_of_charset P_ ((void));
@@ -1676,6 +1774,34 @@ extern void syms_of_syntax P_ ((void));
 /* Defined in fns.c */
 extern Lisp_Object Qstring_lessp;
 extern Lisp_Object Vfeatures;
+unsigned sxhash P_ ((Lisp_Object, int));
+Lisp_Object make_hash_table P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
+                                Lisp_Object, Lisp_Object, Lisp_Object,
+                                Lisp_Object));
+Lisp_Object copy_hash_table P_ ((struct Lisp_Hash_Table *));
+int hash_lookup P_ ((struct Lisp_Hash_Table *, Lisp_Object, unsigned *));
+void hash_put P_ ((struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
+                  unsigned));
+void hash_remove P_ ((struct Lisp_Hash_Table *, Lisp_Object));
+void hash_clear P_ ((struct Lisp_Hash_Table *));
+void remove_hash_entry P_ ((struct Lisp_Hash_Table *, int));
+EXFUN (Fsxhash, 1);
+EXFUN (Fmake_hash_table, MANY);
+EXFUN (Fcopy_hash_table, 1);
+EXFUN (Fhash_table_count, 1);
+EXFUN (Fhash_table_rehash_size, 1);
+EXFUN (Fhash_table_rehash_threshold, 1);
+EXFUN (Fhash_table_size, 1);
+EXFUN (Fhash_table_test, 1);
+EXFUN (Fhash_table_weak, 1);
+EXFUN (Fhash_table_p, 1);
+EXFUN (Fclrhash, 1);
+EXFUN (Fgethash, 3);
+EXFUN (Fputhash, 3);
+EXFUN (Fremhash, 2);
+EXFUN (Fmaphash, 2);
+EXFUN (Fdefine_hash_table_test, 3);
+
 EXFUN (Fidentity, 1);
 EXFUN (Frandom, 1);
 EXFUN (Flength, 1);
@@ -1712,18 +1838,20 @@ EXFUN (Fmapconcat, 3);
 EXFUN (Fy_or_n_p, 1);
 extern Lisp_Object do_yes_or_no_p P_ ((Lisp_Object));
 EXFUN (Ffeaturep, 1);
-EXFUN (Frequire, 2);
+EXFUN (Frequire, 3);
 EXFUN (Fprovide, 1);
 extern Lisp_Object concat2 P_ ((Lisp_Object, Lisp_Object));
 extern Lisp_Object concat3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
 extern Lisp_Object nconc2 P_ ((Lisp_Object, Lisp_Object));
 extern Lisp_Object assq_no_quit P_ ((Lisp_Object, Lisp_Object));
+extern void clear_string_char_byte_cache P_ (());
 extern int string_char_to_byte P_ ((Lisp_Object, int));
 extern int string_byte_to_char P_ ((Lisp_Object, int));
 extern Lisp_Object string_make_multibyte P_ ((Lisp_Object));
 extern Lisp_Object string_make_unibyte P_ ((Lisp_Object));
 EXFUN (Fcopy_alist, 1);
 EXFUN (Fplist_get, 2);
+EXFUN (Fplist_put, 3);
 EXFUN (Fset_char_table_parent, 2);
 EXFUN (Fchar_table_extra_slot, 2);
 EXFUN (Fset_char_table_extra_slot, 3);
@@ -1785,19 +1913,32 @@ EXFUN (Fredraw_display, 0);
 EXFUN (Fsleep_for, 2);
 EXFUN (Fsit_for, 3);
 extern Lisp_Object sit_for P_ ((int, int, int, int, int));
-extern void quit_error_check P_ ((void));
 extern void init_display P_ ((void));
 extern void syms_of_display P_ ((void));
 
 /* Defined in xdisp.c */
+extern Lisp_Object Vresize_mini_config;
+extern struct frame *resize_mini_frame;
+extern int resize_mini_initial_height;
+extern Lisp_Object Qinhibit_redisplay;
 extern Lisp_Object Vmessage_log_max;
 extern int message_enable_multibyte;
+extern Lisp_Object echo_area_buffer[2];
+extern void setup_echo_area_for_printing P_ ((int));
+extern int push_message P_ ((void));
+extern void pop_message P_ ((void));
+extern void restore_message P_ ((void));
+extern Lisp_Object current_message P_ ((void));
+extern void set_message P_ ((char *s, Lisp_Object, int, int));
+extern void clear_message P_ ((int, int));
 extern void message P_ ((/* char *, ... */));
 extern void message_nolog P_ ((/* char *, ... */));
 extern void message1 P_ ((char *));
 extern void message1_nolog P_ ((char *));
 extern void message2 P_ ((char *, int, int));
 extern void message2_nolog P_ ((char *, int, int));
+extern void message3 P_ ((Lisp_Object, int, int));
+extern void message3_nolog P_ ((Lisp_Object, int, int));
 extern void message_dolog P_ ((char *, int, int, int));
 extern void message_with_string P_ ((char *, Lisp_Object, int));
 extern void message_log_maybe_newline P_ ((void));
@@ -1815,6 +1956,8 @@ extern void init_xdisp P_ ((void));
 extern void malloc_warning P_ ((char *));
 extern void memory_full P_ ((void));
 extern void buffer_memory_full P_ ((void));
+extern int survives_gc_p P_ ((Lisp_Object));
+extern void mark_object P_ ((Lisp_Object *));
 extern Lisp_Object Vpurify_flag;
 EXFUN (Fcons, 2);
 EXFUN (list2, 2);
@@ -1895,9 +2038,10 @@ EXFUN (Fintern, 2);
 EXFUN (Fintern_soft, 2);
 EXFUN (Fload, 5);
 EXFUN (Fget_file_char, 0);
-EXFUN (Fread_char, 0);
-extern Lisp_Object read_filtered_event P_ ((int, int, int));
-EXFUN (Feval_region, 3);
+EXFUN (Fread_char, 2);
+EXFUN (Fread_event, 2);
+extern Lisp_Object read_filtered_event P_ ((int, int, int, int));
+EXFUN (Feval_region, 4);
 extern Lisp_Object intern P_ ((char *));
 extern Lisp_Object make_symbol P_ ((char *));
 extern Lisp_Object oblookup P_ ((Lisp_Object, char *, int, int));
@@ -1985,6 +2129,7 @@ extern void init_eval P_ ((void));
 extern void syms_of_eval P_ ((void));
 
 /* Defined in editfns.c */
+EXFUN (Fcurrent_message, 0);
 EXFUN (Fgoto_char, 1);
 EXFUN (Fpoint_min_marker, 0);
 EXFUN (Fpoint_max_marker, 0);
@@ -2009,6 +2154,7 @@ EXFUN (Feobp, 0);
 EXFUN (Fbolp, 0);
 EXFUN (Fbobp, 0);
 EXFUN (Fformat, MANY);
+EXFUN (Fmessage, MANY);
 extern Lisp_Object format1 P_ ((/* char *, ... */));
 extern Lisp_Object make_buffer_string P_ ((int, int, int));
 EXFUN (Fbuffer_substring, 2);
@@ -2031,6 +2177,7 @@ extern void syms_of_editfns P_ ((void));
 
 /* defined in buffer.c */
 extern void nsberror P_ ((Lisp_Object));
+EXFUN (Fset_buffer_multibyte, 1);
 EXFUN (Foverlay_start, 1);
 EXFUN (Foverlay_end, 1);
 extern void adjust_overlays_for_insert P_ ((int, int));
@@ -2048,7 +2195,7 @@ EXFUN (Fbarf_if_buffer_read_only, 0);
 EXFUN (Fcurrent_buffer, 0);
 EXFUN (Fswitch_to_buffer, 2);
 EXFUN (Fpop_to_buffer, 3);
-EXFUN (Fother_buffer, 2);
+EXFUN (Fother_buffer, 3);
 EXFUN (Foverlay_get, 2);
 EXFUN (Fbuffer_modified_p, 1);
 EXFUN (Fset_buffer_modified_p, 1);
@@ -2187,10 +2334,11 @@ EXFUN (Frecursive_edit, 0);
 EXFUN (Fcommand_execute, 4);
 EXFUN (Finput_pending_p, 0);
 extern Lisp_Object menu_bar_items P_ ((Lisp_Object));
+extern Lisp_Object toolbar_items P_ ((Lisp_Object, int *));
 extern Lisp_Object Qvertical_scroll_bar;
 extern void discard_mouse_events ();
 EXFUN (Fevent_convert_list, 1);
-EXFUN (Fread_key_sequence, 4);
+EXFUN (Fread_key_sequence, 5);
 EXFUN (Fset_input_mode, 4);
 extern int detect_input_pending P_ ((void));
 extern int detect_input_pending_run_timers P_ ((int));
@@ -2244,6 +2392,7 @@ extern void syms_of_indent P_ ((void));
 
 /* defined in window.c */
 extern Lisp_Object Qwindowp, Qwindow_live_p;
+EXFUN (Fwindow_end, 2);
 EXFUN (Fselected_window, 0);
 EXFUN (Fnext_window, 3);
 EXFUN (Fdelete_window, 1);
@@ -2275,7 +2424,7 @@ extern void store_frame_param P_ ((struct frame *, Lisp_Object, Lisp_Object));
 extern void store_in_alist P_ ((Lisp_Object *, Lisp_Object, Lisp_Object));
 extern Lisp_Object do_switch_frame P_ ((Lisp_Object, Lisp_Object, int));
 extern Lisp_Object get_frame_param P_ ((struct frame *, Lisp_Object));
-extern Lisp_Object frame_buffer_predicate P_ ((void));
+extern Lisp_Object frame_buffer_predicate P_ ((Lisp_Object));
 EXFUN (Fframep, 1);
 EXFUN (Fselect_frame, 2);
 EXFUN (Fselected_frame, 0);
@@ -2301,9 +2450,9 @@ EXFUN (Fset_frame_position, 3);
 EXFUN (Fraise_frame, 1);
 EXFUN (Fredirect_frame_focus, 2);
 EXFUN (Fset_frame_selected_window, 2);
-extern Lisp_Object frame_buffer_list P_ ((void));
+extern Lisp_Object frame_buffer_list P_ ((Lisp_Object));
 extern void frames_discard_buffer P_ ((Lisp_Object));
-extern void set_frame_buffer_list P_ ((Lisp_Object));
+extern void set_frame_buffer_list P_ ((Lisp_Object, Lisp_Object));
 extern void frames_bury_buffer P_ ((Lisp_Object));
 extern void syms_of_frame P_ ((void));
 extern void keys_of_frame P_ ((void));
@@ -2356,6 +2505,7 @@ EXFUN (Fsubstitute_command_keys, 1);
 EXFUN (Fdocumentation, 2);
 EXFUN (Fdocumentation_property, 3);
 extern Lisp_Object read_doc_string P_ ((Lisp_Object));
+extern Lisp_Object get_doc_string P_ ((Lisp_Object, int, int));
 extern void syms_of_doc P_ ((void));
 
 /* defined in bytecode.c */
@@ -2455,6 +2605,7 @@ extern void syms_of_term P_ ((void));
 #ifdef HAVE_X_WINDOWS
 /* Defined in fontset.c */
 extern void syms_of_fontset P_ ((void));
+EXFUN (Fset_fontset_font, 4);
 #endif
 
 /* Defined in xfaces.c */