1 /* Simple built-in editing commands.
2 Copyright (C) 1985, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
31 Lisp_Object Qkill_forward_chars
, Qkill_backward_chars
, Vblink_paren_function
;
33 /* A possible value for a buffer's overwrite-mode variable. */
34 Lisp_Object Qoverwrite_mode_binary
;
36 /* Non-nil means put this face on the next self-inserting character. */
37 Lisp_Object Vself_insert_face
;
39 /* This is the command that set up Vself_insert_face. */
40 Lisp_Object Vself_insert_face_command
;
42 /* Offset to add to a non-ASCII value when inserting it. */
43 int nonascii_insert_offset
;
45 extern Lisp_Object Qface
;
47 DEFUN ("forward-point", Fforward_point
, Sforward_point
, 1, 1, 0,
48 "Return buffer position N characters after (before if N negative) point.")
54 return make_number (PT
+ XINT (n
));
57 DEFUN ("forward-char", Fforward_char
, Sforward_char
, 0, 1, "p",
58 "Move point right N characters (left if N is negative).\n\
59 On reaching end of buffer, stop and signal error.")
68 /* This used to just set point to point + XINT (n), and then check
69 to see if it was within boundaries. But now that SET_PT can
70 potentially do a lot of stuff (calling entering and exiting
71 hooks, etcetera), that's not a good approach. So we validate the
72 proposed position, then set point. */
74 int new_point
= PT
+ XINT (n
);
79 Fsignal (Qbeginning_of_buffer
, Qnil
);
84 Fsignal (Qend_of_buffer
, Qnil
);
93 DEFUN ("backward-char", Fbackward_char
, Sbackward_char
, 0, 1, "p",
94 "Move point left N characters (right if N is negative).\n\
95 On attempt to pass beginning or end of buffer, stop and signal error.")
104 XSETINT (n
, - XINT (n
));
105 return Fforward_char (n
);
108 DEFUN ("forward-line", Fforward_line
, Sforward_line
, 0, 1, "p",
109 "Move N lines forward (backward if N is negative).\n\
110 Precisely, if point is on line I, move to the start of line I + N.\n\
111 If there isn't room, go as far as possible (no error).\n\
112 Returns the count of lines left to move. If moving forward,\n\
113 that is N - number of lines moved; if backward, N + number moved.\n\
114 With positive N, a non-empty line at the end counts as one line\n\
115 successfully moved (for the return value).")
119 int opoint
= PT
, opoint_byte
= PT_BYTE
;
133 shortage
= scan_newline (PT
, PT_BYTE
, BEGV
, BEGV_BYTE
, count
- 1, 1);
135 shortage
= scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, count
, 1);
137 /* Since scan_newline does TEMP_SET_PT_BOTH,
138 and we want to set PT "for real",
139 go back to the old point and then come back here. */
142 TEMP_SET_PT_BOTH (opoint
, opoint_byte
);
143 SET_PT_BOTH (pos
, pos_byte
);
149 && (FETCH_BYTE (PT_BYTE
- 1) != '\n'))))
152 return make_number (count
<= 0 ? - shortage
: shortage
);
155 DEFUN ("beginning-of-line", Fbeginning_of_line
, Sbeginning_of_line
,
157 "Move point to beginning of current line.\n\
158 With argument N not nil or 1, move forward N - 1 lines first.\n\
159 If scan reaches end of buffer, stop there without error.")
168 SET_PT (XINT (Fline_beginning_position (n
)));
172 DEFUN ("end-of-line", Fend_of_line
, Send_of_line
,
174 "Move point to end of current line.\n\
175 With argument N not nil or 1, move forward N - 1 lines first.\n\
176 If scan reaches end of buffer, stop there without error.")
188 SET_PT (XINT (Fline_end_position (n
)));
193 DEFUN ("delete-char", Fdelete_char
, Sdelete_char
, 1, 2, "p\nP",
194 "Delete the following N characters (previous if N is negative).\n\
195 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
196 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
197 N was explicitly specified.")
199 Lisp_Object n
, killflag
;
211 Fsignal (Qbeginning_of_buffer
, Qnil
);
218 Fsignal (Qend_of_buffer
, Qnil
);
225 call1 (Qkill_forward_chars
, n
);
230 DEFUN ("delete-backward-char", Fdelete_backward_char
, Sdelete_backward_char
,
232 "Delete the previous N characters (following if N is negative).\n\
233 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
234 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
235 N was explicitly specified.")
237 Lisp_Object n
, killflag
;
240 int deleted_special
= 0;
245 /* See if we are about to delete a tab or newline backwards. */
247 for (i
= 0; i
< XINT (n
) && pos
> BEGV_BYTE
; i
++)
252 c
= FETCH_BYTE (pos
);
253 if (c
== '\t' || c
== '\n')
260 /* In overwrite mode, back over columns while clearing them out,
261 unless at end of line. */
263 && ! NILP (current_buffer
->overwrite_mode
)
265 && ! (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
267 int column
= current_column ();
269 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
270 i
= column
- current_column ();
271 Finsert_char (make_number (' '), make_number (i
), Qnil
);
272 /* Whitespace chars are ASCII chars, so we can simply subtract. */
273 SET_PT_BOTH (PT
- i
, PT_BYTE
- i
);
276 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
281 DEFUN ("self-insert-command", Fself_insert_command
, Sself_insert_command
, 1, 1, "p",
282 "Insert the character you type.\n\
283 Whichever character you type to run this command is inserted.")
287 int character
= XINT (last_command_char
);
291 /* Barf if the key that invoked this was not a character. */
292 if (!INTEGERP (last_command_char
))
294 else if (XINT (n
) >= 2 && NILP (current_buffer
->overwrite_mode
))
296 int modified_char
= character
;
297 /* Add the offset to the character, for Finsert_char.
298 We pass internal_self_insert the unmodified character
299 because it itself does this offsetting. */
300 if (modified_char
>= 0200 && modified_char
<= 0377
301 && ! NILP (current_buffer
->enable_multibyte_characters
))
302 modified_char
+= nonascii_insert_offset
;
304 XSETFASTINT (n
, XFASTINT (n
) - 2);
305 /* The first one might want to expand an abbrev. */
306 internal_self_insert (character
, 1);
307 /* The bulk of the copies of this char can be inserted simply.
308 We don't have to handle a user-specified face specially
309 because it will get inherited from the first char inserted. */
310 Finsert_char (make_number (modified_char
), n
, Qt
);
311 /* The last one might want to auto-fill. */
312 internal_self_insert (character
, 0);
317 /* Ok since old and new vals both nonneg */
318 XSETFASTINT (n
, XFASTINT (n
) - 1);
319 internal_self_insert (character
, XFASTINT (n
) != 0);
325 /* Insert character C. If NOAUTOFILL is nonzero, don't do autofill
326 even if it is enabled.
328 If this insertion is suitable for direct output (completely simple),
329 return 0. A value of 1 indicates this *might* not have been simple.
330 A value of 2 means this did things that call for an undo boundary. */
332 internal_self_insert (c
, noautofill
)
336 extern Lisp_Object
Fexpand_abbrev ();
339 register enum syntaxcode synt
;
340 Lisp_Object overwrite
, string
;
341 /* Length of multi-byte form of C. */
343 /* Working buffer and pointer for multi-byte form of C. */
344 unsigned char workbuf
[4], *str
;
345 int chars_to_delete
= 0;
346 int spaces_to_insert
= 0;
348 if (c
>= 0200 && c
<= 0377
349 && ! NILP (current_buffer
->enable_multibyte_characters
))
350 c
+= nonascii_insert_offset
;
352 overwrite
= current_buffer
->overwrite_mode
;
353 if (!NILP (Vbefore_change_function
) || !NILP (Vafter_change_function
)
354 || !NILP (Vbefore_change_functions
) || !NILP (Vafter_change_functions
))
357 /* At first, get multi-byte form of C in STR. */
358 if (!NILP (current_buffer
->enable_multibyte_characters
))
359 len
= CHAR_STRING (c
, workbuf
, str
);
361 workbuf
[0] = c
, str
= workbuf
, len
= 1;
363 if (!NILP (overwrite
)
366 /* In overwrite-mode, we substitute a character at point (C2,
367 hereafter) by C. For that, we delete C2 in advance. But,
368 just substituting C2 by C may move a remaining text in the
369 line to the right or to the left, which is not preferable.
370 So we insert more spaces or delete more characters in the
371 following cases: if C is narrower than C2, after deleting C2,
372 we fill columns with spaces, if C is wider than C2, we delete
373 C2 and several characters following C2. */
375 /* A code at `point'. Since this is checked only against
376 NEWLINE and TAB, we don't need a character code but only the
377 first byte of multi-byte form. */
378 unsigned char c2
= FETCH_BYTE (PT_BYTE
);
379 /* A column the cursor should be placed at after this insertion.
380 The correct value should be calculated only when necessary. */
383 /* Overwriting in binary-mode always replaces C2 by C.
384 Overwriting in textual-mode doesn't always do that.
385 It inserts newlines in the usual way,
386 and inserts any character at end of line
387 or before a tab if it doesn't use the whole width of the tab. */
388 if (EQ (overwrite
, Qoverwrite_mode_binary
)
392 && XINT (current_buffer
->tab_width
) > 0
393 && XFASTINT (current_buffer
->tab_width
) < 20
394 && ((NILP (current_buffer
->enable_multibyte_characters
)
395 ? (target_clm
= current_column () + 1)
396 : (target_clm
= current_column () + WIDTH_BY_CHAR_HEAD (str
[0]))),
397 target_clm
% XFASTINT (current_buffer
->tab_width
)))))
400 int pos_byte
= PT_BYTE
;
406 /* The actual cursor position after the trial of moving
407 to column TARGET_CLM. It is greater than TARGET_CLM
408 if the TARGET_CLM is middle of multi-column
409 character. In that case, the new point is set after
412 = XFASTINT (Fmove_to_column (make_number (target_clm
), Qnil
));
414 chars_to_delete
= PT
- pos
;
416 if (actual_clm
> target_clm
)
418 /* We will delete too many columns. Let's fill columns
419 by spaces so that the remaining text won't move. */
420 spaces_to_insert
= actual_clm
- target_clm
;
423 SET_PT_BOTH (pos
, pos_byte
);
428 if (!NILP (current_buffer
->abbrev_mode
)
429 && SYNTAX (c
) != Sword
430 && NILP (current_buffer
->read_only
)
431 && PT
> BEGV
&& SYNTAX (XFASTINT (Fprevious_char ())) == Sword
)
436 sym
= Fexpand_abbrev ();
438 /* If we expanded an abbrev which has only a hook,
439 and the hook has a non-nil `no-self-insert' property,
440 return right away--don't really self-insert. */
441 if (! NILP (sym
) && ! NILP (XSYMBOL (sym
)->function
)
442 && SYMBOLP (XSYMBOL (sym
)->function
))
445 prop
= Fget (XSYMBOL (sym
)->function
, intern ("no-self-insert"));
450 if (MODIFF
!= modiff
)
456 string
= make_string (str
, len
);
457 if (spaces_to_insert
)
459 tem
= Fmake_string (make_number (spaces_to_insert
),
461 string
= concat2 (tem
, string
);
464 replace_range (PT
, PT
+ chars_to_delete
, string
, 1, 1);
465 SET_PT_BOTH (PT
+ 1 + spaces_to_insert
,
466 PT_BYTE
+ XSTRING (string
)->size
);
469 insert_and_inherit (str
, len
);
471 if ((c
== ' ' || c
== '\n')
473 && !NILP (current_buffer
->auto_fill_function
))
478 /* After inserting a newline, move to previous line and fill
479 that. Must have the newline in place already so filling and
480 justification, if any, know where the end is going to be. */
481 SET_PT_BOTH (PT
- 1, PT_BYTE
- 1);
482 tem
= call0 (current_buffer
->auto_fill_function
);
484 SET_PT_BOTH (PT
+ 1, PT_BYTE
+ 1);
490 /* If previous command specified a face to use, use it. */
491 if (!NILP (Vself_insert_face
)
492 && EQ (current_kboard
->Vlast_command
, Vself_insert_face_command
))
494 Fput_text_property (make_number (PT
- 1), make_number (PT
),
495 Qface
, Vself_insert_face
, Qnil
);
496 Vself_insert_face
= Qnil
;
501 if ((synt
== Sclose
|| synt
== Smath
)
502 && !NILP (Vblink_paren_function
) && INTERACTIVE
505 call0 (Vblink_paren_function
);
511 /* module initialization */
515 Qkill_backward_chars
= intern ("kill-backward-chars");
516 staticpro (&Qkill_backward_chars
);
518 Qkill_forward_chars
= intern ("kill-forward-chars");
519 staticpro (&Qkill_forward_chars
);
521 Qoverwrite_mode_binary
= intern ("overwrite-mode-binary");
522 staticpro (&Qoverwrite_mode_binary
);
524 DEFVAR_LISP ("self-insert-face", &Vself_insert_face
,
525 "If non-nil, set the face of the next self-inserting character to this.\n\
526 See also `self-insert-face-command'.");
527 Vself_insert_face
= Qnil
;
529 DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command
,
530 "This is the command that set up `self-insert-face'.\n\
531 If `last-command' does not equal this value, we ignore `self-insert-face'.");
532 Vself_insert_face_command
= Qnil
;
534 DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function
,
535 "Function called, if non-nil, whenever a close parenthesis is inserted.\n\
536 More precisely, a char with closeparen syntax is self-inserted.");
537 Vblink_paren_function
= Qnil
;
539 DEFVAR_INT ("nonascii-insert-offset", &nonascii_insert_offset
,
540 "Offset to add to a non-ascii code 0200...0377 when inserting it.\n\
541 This applies only when multibyte characters are enabled, and it serves\n\
542 to convert a Latin-1 or similar 8-bit character code to the corresponding\n\
543 Emacs character code.");
544 nonascii_insert_offset
= 0;
546 defsubr (&Sforward_point
);
547 defsubr (&Sforward_char
);
548 defsubr (&Sbackward_char
);
549 defsubr (&Sforward_line
);
550 defsubr (&Sbeginning_of_line
);
551 defsubr (&Send_of_line
);
553 defsubr (&Sdelete_char
);
554 defsubr (&Sdelete_backward_char
);
556 defsubr (&Sself_insert_command
);
563 initial_define_key (global_map
, Ctl ('I'), "self-insert-command");
564 for (n
= 040; n
< 0177; n
++)
565 initial_define_key (global_map
, n
, "self-insert-command");
567 for (n
= 0200; n
< 0240; n
++)
568 initial_define_key (global_map
, n
, "self-insert-command");
570 for (n
= 0240; n
< 0400; n
++)
571 initial_define_key (global_map
, n
, "self-insert-command");
573 initial_define_key (global_map
, Ctl ('A'), "beginning-of-line");
574 initial_define_key (global_map
, Ctl ('B'), "backward-char");
575 initial_define_key (global_map
, Ctl ('D'), "delete-char");
576 initial_define_key (global_map
, Ctl ('E'), "end-of-line");
577 initial_define_key (global_map
, Ctl ('F'), "forward-char");
578 initial_define_key (global_map
, 0177, "delete-backward-char");