1 /* Simple built-in editing commands.
2 Copyright (C) 1985, 93, 94, 95, 96, 97, 1998, 2001 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. */
26 #include "character.h"
31 #include "dispextern.h"
33 Lisp_Object Qkill_forward_chars
, Qkill_backward_chars
, Vblink_paren_function
;
35 /* A possible value for a buffer's overwrite-mode variable. */
36 Lisp_Object Qoverwrite_mode_binary
;
38 /* Non-nil means put this face on the next self-inserting character. */
39 Lisp_Object Vself_insert_face
;
41 /* This is the command that set up Vself_insert_face. */
42 Lisp_Object Vself_insert_face_command
;
44 extern Lisp_Object Qface
;
46 DEFUN ("forward-point", Fforward_point
, Sforward_point
, 1, 1, 0,
47 doc
: /* Return buffer position N characters after (before if N negative) point. */)
53 return make_number (PT
+ XINT (n
));
56 DEFUN ("forward-char", Fforward_char
, Sforward_char
, 0, 1, "p",
57 doc
: /* Move point right N characters (left if N is negative).
58 On reaching end of buffer, stop and signal error. */)
67 /* This used to just set point to point + XINT (n), and then check
68 to see if it was within boundaries. But now that SET_PT can
69 potentially do a lot of stuff (calling entering and exiting
70 hooks, etcetera), that's not a good approach. So we validate the
71 proposed position, then set point. */
73 int new_point
= PT
+ XINT (n
);
78 Fsignal (Qbeginning_of_buffer
, Qnil
);
83 Fsignal (Qend_of_buffer
, Qnil
);
92 DEFUN ("backward-char", Fbackward_char
, Sbackward_char
, 0, 1, "p",
93 doc
: /* Move point left N characters (right if N is negative).
94 On attempt to pass beginning or end of buffer, stop and signal error. */)
103 XSETINT (n
, - XINT (n
));
104 return Fforward_char (n
);
107 DEFUN ("forward-line", Fforward_line
, Sforward_line
, 0, 1, "p",
108 doc
: /* Move N lines forward (backward if N is negative).
109 Precisely, if point is on line I, move to the start of line I + N.
110 If there isn't room, go as far as possible (no error).
111 Returns the count of lines left to move. If moving forward,
112 that is N - number of lines moved; if backward, N + number moved.
113 With positive N, a non-empty line at the end counts as one line
114 successfully moved (for the return value). */)
118 int opoint
= PT
, opoint_byte
= PT_BYTE
;
131 shortage
= scan_newline (PT
, PT_BYTE
, BEGV
, BEGV_BYTE
, count
- 1, 1);
133 shortage
= scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, count
, 1);
135 /* Since scan_newline does TEMP_SET_PT_BOTH,
136 and we want to set PT "for real",
137 go back to the old point and then come back here. */
140 TEMP_SET_PT_BOTH (opoint
, opoint_byte
);
141 SET_PT_BOTH (pos
, pos_byte
);
147 && (FETCH_BYTE (PT_BYTE
- 1) != '\n'))))
150 return make_number (count
<= 0 ? - shortage
: shortage
);
153 DEFUN ("beginning-of-line", Fbeginning_of_line
, Sbeginning_of_line
, 0, 1, "p",
154 doc
: /* Move point to beginning of current line.
155 With argument N not nil or 1, move forward N - 1 lines first.
156 If point reaches the beginning or end of buffer, it stops there.
158 This command does not move point across a field boundary unless doing so
159 would move beyond there to a different line; If N is nil or 1, and point
160 starts at a field boundary, point does not move. To ignore field
161 boundaries, either bind `inhibit-field-text-motion' to t, or use the
162 `forward-line' function instead. For instance, `(forward-line 0)' does
163 the same thing as `(beginning-of-line)', except that it ignores field
173 SET_PT (XINT (Fline_beginning_position (n
)));
178 DEFUN ("end-of-line", Fend_of_line
, Send_of_line
, 0, 1, "p",
179 doc
: /* Move point to end of current line.
180 With argument N not nil or 1, move forward N - 1 lines first.
181 If point reaches the beginning or end of buffer, it stops there.
183 This command does not move point across a field boundary unless doing so
184 would move beyond there to a different line; if N is nil or 1, and
185 point starts at a field boundary, point does not move. To ignore field
186 boundaries bind `inhibit-field-text-motion' to t. */)
195 SET_PT (XINT (Fline_end_position (n
)));
200 DEFUN ("delete-char", Fdelete_char
, Sdelete_char
, 1, 2, "p\nP",
201 doc
: /* Delete the following N characters (previous if N is negative).
202 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).
203 Interactively, N is the prefix arg, and KILLFLAG is set if
204 N was explicitly specified. */)
206 Lisp_Object n
, killflag
;
218 Fsignal (Qbeginning_of_buffer
, Qnil
);
225 Fsignal (Qend_of_buffer
, Qnil
);
232 call1 (Qkill_forward_chars
, n
);
237 DEFUN ("delete-backward-char", Fdelete_backward_char
, Sdelete_backward_char
,
239 doc
: /* Delete the previous N characters (following if N is negative).
240 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).
241 Interactively, N is the prefix arg, and KILLFLAG is set if
242 N was explicitly specified. */)
244 Lisp_Object n
, killflag
;
247 int deleted_special
= 0;
248 int pos
, pos_byte
, i
;
252 /* See if we are about to delete a tab or newline backwards. */
255 for (i
= 0; i
< XINT (n
) && pos_byte
> BEGV_BYTE
; i
++)
259 DEC_BOTH (pos
, pos_byte
);
260 c
= FETCH_BYTE (pos_byte
);
261 if (c
== '\t' || c
== '\n')
268 /* In overwrite mode, back over columns while clearing them out,
269 unless at end of line. */
271 && ! NILP (current_buffer
->overwrite_mode
)
273 && ! (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
275 int column
= current_column ();
277 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
278 i
= column
- current_column ();
279 Finsert_char (make_number (' '), make_number (i
), Qnil
);
280 /* Whitespace chars are ASCII chars, so we can simply subtract. */
281 SET_PT_BOTH (PT
- i
, PT_BYTE
- i
);
284 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
289 DEFUN ("self-insert-command", Fself_insert_command
, Sself_insert_command
, 1, 1, "p",
290 doc
: /* Insert the character you type.
291 Whichever character you type to run this command is inserted. */)
295 int character
= XINT (last_command_char
);
299 /* Barf if the key that invoked this was not a character. */
300 if (!CHARACTERP (last_command_char
))
302 else if (XINT (n
) >= 2 && NILP (current_buffer
->overwrite_mode
))
304 int modified_char
= character
;
305 /* Add the offset to the character, for Finsert_char.
306 We pass internal_self_insert the unmodified character
307 because it itself does this offsetting. */
308 if (! NILP (current_buffer
->enable_multibyte_characters
))
309 modified_char
= unibyte_char_to_multibyte (modified_char
);
311 XSETFASTINT (n
, XFASTINT (n
) - 2);
312 /* The first one might want to expand an abbrev. */
313 internal_self_insert (character
, 1);
314 /* The bulk of the copies of this char can be inserted simply.
315 We don't have to handle a user-specified face specially
316 because it will get inherited from the first char inserted. */
317 Finsert_char (make_number (modified_char
), n
, Qt
);
318 /* The last one might want to auto-fill. */
319 internal_self_insert (character
, 0);
324 /* Ok since old and new vals both nonneg */
325 XSETFASTINT (n
, XFASTINT (n
) - 1);
326 internal_self_insert (character
, XFASTINT (n
) != 0);
332 /* Insert character C. If NOAUTOFILL is nonzero, don't do autofill
333 even if it is enabled.
335 If this insertion is suitable for direct output (completely simple),
336 return 0. A value of 1 indicates this *might* not have been simple.
337 A value of 2 means this did things that call for an undo boundary. */
340 internal_self_insert (c
, noautofill
)
344 extern Lisp_Object
Fexpand_abbrev ();
347 register enum syntaxcode synt
;
348 Lisp_Object overwrite
, string
;
349 /* Length of multi-byte form of C. */
351 /* Working buffer and pointer for multi-byte form of C. */
352 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
353 int chars_to_delete
= 0;
354 int spaces_to_insert
= 0;
356 overwrite
= current_buffer
->overwrite_mode
;
357 if (!NILP (Vbefore_change_functions
) || !NILP (Vafter_change_functions
))
360 /* At first, get multi-byte form of C in STR. */
361 if (!NILP (current_buffer
->enable_multibyte_characters
))
363 len
= CHAR_STRING (c
, str
);
365 /* If C has modifier bits, this makes C an appropriate
371 str
[0] = (SINGLE_BYTE_CHAR_P (c
)
373 : multibyte_char_to_unibyte (c
, Qnil
));
376 if (!NILP (overwrite
)
379 /* In overwrite-mode, we substitute a character at point (C2,
380 hereafter) by C. For that, we delete C2 in advance. But,
381 just substituting C2 by C may move a remaining text in the
382 line to the right or to the left, which is not preferable.
383 So we insert more spaces or delete more characters in the
384 following cases: if C is narrower than C2, after deleting C2,
385 we fill columns with spaces, if C is wider than C2, we delete
386 C2 and several characters following C2. */
388 /* This is the character after point. */
389 int c2
= FETCH_CHAR (PT_BYTE
);
391 /* Column the cursor should be placed at after this insertion.
392 The correct value should be calculated only when necessary. */
395 /* Overwriting in binary-mode always replaces C2 by C.
396 Overwriting in textual-mode doesn't always do that.
397 It inserts newlines in the usual way,
398 and inserts any character at end of line
399 or before a tab if it doesn't use the whole width of the tab. */
400 if (EQ (overwrite
, Qoverwrite_mode_binary
)
404 && XINT (current_buffer
->tab_width
) > 0
405 && XFASTINT (current_buffer
->tab_width
) < 20
406 && (target_clm
= (current_column ()
407 + XINT (Fchar_width (make_number (c
)))),
408 target_clm
% XFASTINT (current_buffer
->tab_width
)))))
411 int pos_byte
= PT_BYTE
;
417 /* The actual cursor position after the trial of moving
418 to column TARGET_CLM. It is greater than TARGET_CLM
419 if the TARGET_CLM is middle of multi-column
420 character. In that case, the new point is set after
423 = XFASTINT (Fmove_to_column (make_number (target_clm
), Qnil
));
425 chars_to_delete
= PT
- pos
;
427 if (actual_clm
> target_clm
)
429 /* We will delete too many columns. Let's fill columns
430 by spaces so that the remaining text won't move. */
431 spaces_to_insert
= actual_clm
- target_clm
;
434 SET_PT_BOTH (pos
, pos_byte
);
440 if (NILP (current_buffer
->enable_multibyte_characters
))
441 MAKE_CHAR_MULTIBYTE (c
);
444 if (!NILP (current_buffer
->abbrev_mode
)
446 && NILP (current_buffer
->read_only
)
448 && (!NILP (current_buffer
->enable_multibyte_characters
)
449 ? SYNTAX (XFASTINT (Fprevious_char ())) == Sword
450 : (SYNTAX (unibyte_char_to_multibyte (XFASTINT (Fprevious_char ())))
456 sym
= Fexpand_abbrev ();
458 /* If we expanded an abbrev which has a hook,
459 and the hook has a non-nil `no-self-insert' property,
460 return right away--don't really self-insert. */
461 if (! NILP (sym
) && ! NILP (XSYMBOL (sym
)->function
)
462 && SYMBOLP (XSYMBOL (sym
)->function
))
465 prop
= Fget (XSYMBOL (sym
)->function
, intern ("no-self-insert"));
470 if (MODIFF
!= modiff
)
476 string
= make_string_from_bytes (str
, 1, len
);
477 if (spaces_to_insert
)
479 tem
= Fmake_string (make_number (spaces_to_insert
),
481 string
= concat2 (tem
, string
);
484 replace_range (PT
, PT
+ chars_to_delete
, string
, 1, 1, 1);
485 Fforward_char (make_number (1 + spaces_to_insert
));
488 insert_and_inherit (str
, len
);
490 if ((CHAR_TABLE_P (Vauto_fill_chars
)
491 ? !NILP (CHAR_TABLE_REF (Vauto_fill_chars
, c
))
492 : (c
== ' ' || c
== '\n'))
494 && !NILP (current_buffer
->auto_fill_function
))
499 /* After inserting a newline, move to previous line and fill
500 that. Must have the newline in place already so filling and
501 justification, if any, know where the end is going to be. */
502 SET_PT_BOTH (PT
- 1, PT_BYTE
- 1);
503 tem
= call0 (current_buffer
->auto_fill_function
);
505 SET_PT_BOTH (PT
+ 1, PT_BYTE
+ 1);
510 /* If previous command specified a face to use, use it. */
511 if (!NILP (Vself_insert_face
)
512 && EQ (current_kboard
->Vlast_command
, Vself_insert_face_command
))
514 Fput_text_property (make_number (PT
- 1), make_number (PT
),
515 Qface
, Vself_insert_face
, Qnil
);
516 Vself_insert_face
= Qnil
;
519 if ((synt
== Sclose
|| synt
== Smath
)
520 && !NILP (Vblink_paren_function
) && INTERACTIVE
523 call0 (Vblink_paren_function
);
529 /* module initialization */
534 Qkill_backward_chars
= intern ("kill-backward-chars");
535 staticpro (&Qkill_backward_chars
);
537 Qkill_forward_chars
= intern ("kill-forward-chars");
538 staticpro (&Qkill_forward_chars
);
540 Qoverwrite_mode_binary
= intern ("overwrite-mode-binary");
541 staticpro (&Qoverwrite_mode_binary
);
543 DEFVAR_LISP ("self-insert-face", &Vself_insert_face
,
544 doc
: /* If non-nil, set the face of the next self-inserting character to this.
545 See also `self-insert-face-command'. */);
546 Vself_insert_face
= Qnil
;
548 DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command
,
549 doc
: /* This is the command that set up `self-insert-face'.
550 If `last-command' does not equal this value, we ignore `self-insert-face'. */);
551 Vself_insert_face_command
= Qnil
;
553 DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function
,
554 doc
: /* Function called, if non-nil, whenever a close parenthesis is inserted.
555 More precisely, a char with closeparen syntax is self-inserted. */);
556 Vblink_paren_function
= Qnil
;
558 defsubr (&Sforward_point
);
559 defsubr (&Sforward_char
);
560 defsubr (&Sbackward_char
);
561 defsubr (&Sforward_line
);
562 defsubr (&Sbeginning_of_line
);
563 defsubr (&Send_of_line
);
565 defsubr (&Sdelete_char
);
566 defsubr (&Sdelete_backward_char
);
568 defsubr (&Sself_insert_command
);
576 initial_define_key (global_map
, Ctl ('I'), "self-insert-command");
577 for (n
= 040; n
< 0177; n
++)
578 initial_define_key (global_map
, n
, "self-insert-command");
580 for (n
= 0200; n
< 0240; n
++)
581 initial_define_key (global_map
, n
, "self-insert-command");
583 for (n
= 0240; n
< 0400; n
++)
584 initial_define_key (global_map
, n
, "self-insert-command");
586 initial_define_key (global_map
, Ctl ('A'), "beginning-of-line");
587 initial_define_key (global_map
, Ctl ('B'), "backward-char");
588 initial_define_key (global_map
, Ctl ('D'), "delete-char");
589 initial_define_key (global_map
, Ctl ('E'), "end-of-line");
590 initial_define_key (global_map
, Ctl ('F'), "forward-char");
591 initial_define_key (global_map
, 0177, "delete-backward-char");