diff src/term.c @ 83025:c66ebcc29777

Removed %T in mode-line-format. Trivial documentation changes. lisp/bindings.el (mode-line-buffer-identification): Use the conditional formatting feature instead of builtin support. src/buffer.c (Vmode_line_format): Removed %T documentation. src/xdisp.c (decode_mode_spec): Removed %T processing. lib-src/emacsclient.c (pass_signal_to_emacs, init_signals): Added comment. src/cm.c: Cosmetic changes. src/termchar.h: Ditto. src/keyboard.c (interrupt_signal, handle_interrupt): Updated documentation. src/process.c (add_keyboard_wait_descriptor): Added docs. src/sysdep.c (init_all_sys_modes, init_sys_modes) (reset_all_sys_modes): Added docs. src/term.c (tty_ring_bell, tty_set_terminal_modes) (tty_reset_terminal_modes, tty_update_end, set_terminal_window) (tty_set_terminal_window, clear_to_end, tty_clear_to_end) (tty_clear_frame, tty_clear_end_of_line, write_glyphs) (tty_write_glyphs, insert_glyphs, tty_insert_glyphs, delete_glyphs) (tty_delete_glyphs, tty_ins_del_lines, get_named_tty_display) (init_initial_display, delete_tty): Added docs. git-archimport-id: [e-mail]--2004/emacs--multi-tty--0--patch-65

--- a/src/term.c	Sat Jan 24 20:03:33 2004 +0000
+++ b/src/term.c	Sun Jan 25 00:43:38 2004 +0000
@@ -201,6 +201,8 @@
     (*FRAME_DISPLAY (f)->ring_bell_hook) ();
 }
 
+/* Ring the bell on a tty. */
+
 void
 tty_ring_bell ()
 {
@@ -212,7 +214,10 @@
                 : tty->TS_bell));
 }
 
-void tty_set_terminal_modes (struct display *display)
+/* Set up termcap modes for Emacs. */
+
+void
+tty_set_terminal_modes (struct display *display)
 {
   struct tty_display_info *tty = display->display_info.tty;
   
@@ -222,7 +227,10 @@
   losecursor (tty);
 }
 
-void tty_reset_terminal_modes (struct display *display)
+/* Reset termcap modes before exiting Emacs. */
+
+void
+tty_reset_terminal_modes (struct display *display)
 {
   struct tty_display_info *tty = display->display_info.tty;
   
@@ -255,6 +263,8 @@
   updating_frame = NULL;
 }
 
+/* Flag the end of a display update on a termcap display. */
+
 void
 tty_update_end (struct frame *f)
 {
@@ -266,6 +276,11 @@
   background_highlight (tty);
 }
 
+/* Specify how many text lines, from the top of the window,
+   should be affected by insert-lines and delete-lines operations.
+   This, and those operations, are used only within an update
+   that is bounded by calls to update_begin and update_end.  */
+
 void
 set_terminal_window (size)
      int size;
@@ -278,6 +293,8 @@
     (*FRAME_DISPLAY (f)->set_terminal_window_hook) (size);
 }
 
+/* The implementation of set_terminal_window for termcap frames. */
+
 void
 tty_set_terminal_window (int size)
 {
@@ -489,7 +506,7 @@
 
 /* Erase operations */
 
-/* clear from cursor to end of frame */
+/* Clear from cursor to end of frame. */
 void
 clear_to_end ()
 {
@@ -501,6 +518,8 @@
     (*FRAME_DISPLAY (f)->clear_to_end_hook) ();
 }
 
+/* Clear from cursor to end of frame on a termcap device. */
+
 void
 tty_clear_to_end (void)
 {
@@ -536,6 +555,8 @@
     (*FRAME_DISPLAY (f)->clear_frame_hook) ();
 }
 
+/* Clear an entire termcap frame. */
+
 void
 tty_clear_frame ()
 {
@@ -575,6 +596,10 @@
     (*FRAME_DISPLAY (f)->clear_end_of_line_hook) (first_unused_hpos);
 }
 
+/* An implementation of clear_end_of_line for termcap frames.
+
+   Note that the cursor may be moved, on terminals lacking a `ce' string.  */
+
 void
 tty_clear_end_of_line (int first_unused_hpos)
 {
@@ -725,6 +750,9 @@
 }
 
 
+/* Output LEN glyphs starting at STRING at the nominal cursor position.
+   Advance the nominal cursor over the text.  */
+
 void
 write_glyphs (string, len)
      register struct glyph *string;
@@ -738,6 +766,8 @@
     (*FRAME_DISPLAY (f)->write_glyphs_hook) (string, len);
 }
 
+/* An implementation of write_glyphs for termcap frames. */
+
 void
 tty_write_glyphs (struct glyph *string, int len)
 {
@@ -833,7 +863,9 @@
   cmcheckmagic (tty);
 }
 
-/* If start is zero, insert blanks instead of a string at start */
+/* Insert LEN glyphs from START at the nominal cursor position.
+
+   If start is zero, insert blanks instead of a string at start */
 
 void
 insert_glyphs (start, len)
@@ -851,6 +883,8 @@
     (*FRAME_DISPLAY (f)->insert_glyphs_hook) (start, len);
 }
 
+/* An implementation of insert_glyphs for termcap frames. */
+
 void
 tty_insert_glyphs (struct glyph *start, int len)
 {
@@ -934,6 +968,8 @@
   cmcheckmagic (tty);
 }
 
+/* Delete N glyphs at the nominal cursor position. */
+
 void
 delete_glyphs (n)
      register int n;
@@ -946,6 +982,8 @@
     (*FRAME_DISPLAY (f)->delete_glyphs_hook) (n);
 }
 
+/* An implementation of delete_glyphs for termcap frames. */
+
 void
 tty_delete_glyphs (int n)
 {
@@ -994,6 +1032,8 @@
     (*FRAME_DISPLAY (f)->ins_del_lines_hook) (vpos, n);
 }
 
+/* An implementation of ins_del_lines for termcap frames. */
+
 void
 tty_ins_del_lines (int vpos, int n)
 {
@@ -2082,6 +2122,11 @@
 
 
 
+/* Return the termcap display with the given name.  If NAME is null,
+   return the display corresponding to our controlling terminal.
+
+   Returns NULL if the named terminal device is not opened.  */
+ 
 struct display *
 get_named_tty_display (name)
      char *name;
@@ -2159,8 +2204,8 @@
  ***********************************************************************/
 
 /* Create the bootstrap display device for the initial frame.
-
-Returns a display of type output_initial. */
+   Returns a display of type output_initial. */
+
 struct display *
 init_initial_display (void)
 {
@@ -2180,6 +2225,7 @@
 
 /* Deletes the bootstrap display device.
    Called through delete_display_hook. */
+
 void
 delete_initial_display (struct display *display)
 {
@@ -2200,6 +2246,7 @@
    TERMINAL_TYPE is the termcap type of the device, e.g. "vt100".
 
    If MUST_SUCCEED is true, then all errors are fatal. */
+
 struct display *
 term_init (char *name, char *terminal_type, int must_succeed)
 {
@@ -2734,8 +2781,8 @@
 
 /* Auxiliary error-handling function for term_init.
    Free BUFFER and delete DISPLAY, then call error or fatal
-   with str1 or str2, respectively, according to MUST_SUCCEED.
-*/
+   with str1 or str2, respectively, according to MUST_SUCCEED.  */
+
 static void
 maybe_fatal (must_succeed, buffer, display, str1, str2, arg1, arg2)
      int must_succeed;
@@ -2802,6 +2849,9 @@
 
 static int deleting_tty = 0;
 
+
+/* Delete the given terminal device, closing all frames on it. */
+
 void
 delete_tty (struct display *display)
 {
@@ -2904,6 +2954,7 @@
 
 /* Initialize the tty-dependent part of frame F.  The frame must
    already have its display initialized. */
+
 void
 create_tty_output (struct frame *f)
 {
@@ -2921,6 +2972,7 @@
 }
 
 /* Delete the tty-dependent part of frame F. */
+
 void
 delete_tty_output (struct frame *f)
 {
@@ -2935,6 +2987,7 @@
 
 /* Mark the pointers in the tty_display_info objects.
    Called by the Fgarbage_collector.  */
+
 void
 mark_ttys ()
 {
@@ -2950,6 +3003,7 @@
 
 
 /* Create a new display object and add it to the display list. */
+
 struct display *
 create_display (void)
 {
@@ -2963,6 +3017,7 @@
 }
 
 /* Remove a display from the display list and free its memory. */
+
 void
 delete_display (struct display *dev)
 {