1 /* Simple built-in editing commands.
2 Copyright (C) 1985, 93, 94, 95, 96, 97, 1998 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 extern Lisp_Object Qface
;
44 DEFUN ("forward-point", Fforward_point
, Sforward_point
, 1, 1, 0,
45 "Return buffer position N characters after (before if N negative) point.")
51 return make_number (PT
+ XINT (n
));
54 DEFUN ("forward-char", Fforward_char
, Sforward_char
, 0, 1, "p",
55 "Move point right N characters (left if N is negative).\n\
56 On reaching end of buffer, stop and signal error.")
65 /* This used to just set point to point + XINT (n), and then check
66 to see if it was within boundaries. But now that SET_PT can
67 potentially do a lot of stuff (calling entering and exiting
68 hooks, etcetera), that's not a good approach. So we validate the
69 proposed position, then set point. */
71 int new_point
= PT
+ XINT (n
);
76 Fsignal (Qbeginning_of_buffer
, Qnil
);
81 Fsignal (Qend_of_buffer
, Qnil
);
90 DEFUN ("backward-char", Fbackward_char
, Sbackward_char
, 0, 1, "p",
91 "Move point left N characters (right if N is negative).\n\
92 On attempt to pass beginning or end of buffer, stop and signal error.")
101 XSETINT (n
, - XINT (n
));
102 return Fforward_char (n
);
105 DEFUN ("forward-line", Fforward_line
, Sforward_line
, 0, 1, "p",
106 "Move N lines forward (backward if N is negative).\n\
107 Precisely, if point is on line I, move to the start of line I + N.\n\
108 If there isn't room, go as far as possible (no error).\n\
109 Returns the count of lines left to move. If moving forward,\n\
110 that is N - number of lines moved; if backward, N + number moved.\n\
111 With positive N, a non-empty line at the end counts as one line\n\
112 successfully moved (for the return value).")
116 int opoint
= PT
, opoint_byte
= PT_BYTE
;
130 shortage
= scan_newline (PT
, PT_BYTE
, BEGV
, BEGV_BYTE
, count
- 1, 1);
132 shortage
= scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, count
, 1);
134 /* Since scan_newline does TEMP_SET_PT_BOTH,
135 and we want to set PT "for real",
136 go back to the old point and then come back here. */
139 TEMP_SET_PT_BOTH (opoint
, opoint_byte
);
140 SET_PT_BOTH (pos
, pos_byte
);
146 && (FETCH_BYTE (PT_BYTE
- 1) != '\n'))))
149 return make_number (count
<= 0 ? - shortage
: shortage
);
152 DEFUN ("beginning-of-line", Fbeginning_of_line
, Sbeginning_of_line
,
154 "Move point to beginning of current line.\n\
155 With argument N not nil or 1, move forward N - 1 lines first.\n\
156 If scan reaches end of buffer, stop there without error.")
165 SET_PT (XINT (Fline_beginning_position (n
)));
169 DEFUN ("end-of-line", Fend_of_line
, Send_of_line
,
171 "Move point to end of current line.\n\
172 With argument N not nil or 1, move forward N - 1 lines first.\n\
173 If scan reaches end of buffer, stop there without error.")
185 SET_PT (XINT (Fline_end_position (n
)));
190 DEFUN ("delete-char", Fdelete_char
, Sdelete_char
, 1, 2, "p\nP",
191 "Delete the following N characters (previous if N is negative).\n\
192 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
193 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
194 N was explicitly specified.")
196 Lisp_Object n
, killflag
;
208 Fsignal (Qbeginning_of_buffer
, Qnil
);
215 Fsignal (Qend_of_buffer
, Qnil
);
222 call1 (Qkill_forward_chars
, n
);
227 DEFUN ("delete-backward-char", Fdelete_backward_char
, Sdelete_backward_char
,
229 "Delete the previous N characters (following if N is negative).\n\
230 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
231 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
232 N was explicitly specified.")
234 Lisp_Object n
, killflag
;
237 int deleted_special
= 0;
238 int pos
, pos_byte
, i
;
242 /* See if we are about to delete a tab or newline backwards. */
245 for (i
= 0; i
< XINT (n
) && pos_byte
> BEGV_BYTE
; i
++)
249 DEC_BOTH (pos
, pos_byte
);
250 c
= FETCH_BYTE (pos_byte
);
251 if (c
== '\t' || c
== '\n')
258 /* In overwrite mode, back over columns while clearing them out,
259 unless at end of line. */
261 && ! NILP (current_buffer
->overwrite_mode
)
263 && ! (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
265 int column
= current_column ();
267 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
268 i
= column
- current_column ();
269 Finsert_char (make_number (' '), make_number (i
), Qnil
);
270 /* Whitespace chars are ASCII chars, so we can simply subtract. */
271 SET_PT_BOTH (PT
- i
, PT_BYTE
- i
);
274 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
279 DEFUN ("self-insert-command", Fself_insert_command
, Sself_insert_command
, 1, 1, "p",
280 "Insert the character you type.\n\
281 Whichever character you type to run this command is inserted.")
285 int character
= XINT (last_command_char
);
289 /* Barf if the key that invoked this was not a character. */
290 if (!INTEGERP (last_command_char
))
292 else if (XINT (n
) >= 2 && NILP (current_buffer
->overwrite_mode
))
294 int modified_char
= character
;
295 /* Add the offset to the character, for Finsert_char.
296 We pass internal_self_insert the unmodified character
297 because it itself does this offsetting. */
298 if (! NILP (current_buffer
->enable_multibyte_characters
))
299 modified_char
= unibyte_char_to_multibyte (modified_char
);
301 XSETFASTINT (n
, XFASTINT (n
) - 2);
302 /* The first one might want to expand an abbrev. */
303 internal_self_insert (character
, 1);
304 /* The bulk of the copies of this char can be inserted simply.
305 We don't have to handle a user-specified face specially
306 because it will get inherited from the first char inserted. */
307 Finsert_char (make_number (modified_char
), n
, Qt
);
308 /* The last one might want to auto-fill. */
309 internal_self_insert (character
, 0);
314 /* Ok since old and new vals both nonneg */
315 XSETFASTINT (n
, XFASTINT (n
) - 1);
316 internal_self_insert (character
, XFASTINT (n
) != 0);
322 /* Insert character C. If NOAUTOFILL is nonzero, don't do autofill
323 even if it is enabled.
325 If this insertion is suitable for direct output (completely simple),
326 return 0. A value of 1 indicates this *might* not have been simple.
327 A value of 2 means this did things that call for an undo boundary. */
329 internal_self_insert (c
, noautofill
)
333 extern Lisp_Object
Fexpand_abbrev ();
336 register enum syntaxcode synt
;
337 Lisp_Object overwrite
, string
;
338 /* Length of multi-byte form of C. */
340 /* Working buffer and pointer for multi-byte form of C. */
341 unsigned char workbuf
[4], *str
;
342 int chars_to_delete
= 0;
343 int spaces_to_insert
= 0;
345 if (! NILP (current_buffer
->enable_multibyte_characters
))
346 c
= unibyte_char_to_multibyte (c
);
348 overwrite
= current_buffer
->overwrite_mode
;
349 if (!NILP (Vbefore_change_function
) || !NILP (Vafter_change_function
)
350 || !NILP (Vbefore_change_functions
) || !NILP (Vafter_change_functions
))
353 /* At first, get multi-byte form of C in STR. */
354 if (!NILP (current_buffer
->enable_multibyte_characters
))
355 len
= CHAR_STRING (c
, workbuf
, str
);
357 workbuf
[0] = c
, str
= workbuf
, len
= 1;
359 if (!NILP (overwrite
)
362 /* In overwrite-mode, we substitute a character at point (C2,
363 hereafter) by C. For that, we delete C2 in advance. But,
364 just substituting C2 by C may move a remaining text in the
365 line to the right or to the left, which is not preferable.
366 So we insert more spaces or delete more characters in the
367 following cases: if C is narrower than C2, after deleting C2,
368 we fill columns with spaces, if C is wider than C2, we delete
369 C2 and several characters following C2. */
371 /* This is the character after point. */
372 int c2
= FETCH_CHAR (PT_BYTE
);
374 /* Column the cursor should be placed at after this insertion.
375 The correct value should be calculated only when necessary. */
378 /* Overwriting in binary-mode always replaces C2 by C.
379 Overwriting in textual-mode doesn't always do that.
380 It inserts newlines in the usual way,
381 and inserts any character at end of line
382 or before a tab if it doesn't use the whole width of the tab. */
383 if (EQ (overwrite
, Qoverwrite_mode_binary
)
387 && XINT (current_buffer
->tab_width
) > 0
388 && XFASTINT (current_buffer
->tab_width
) < 20
389 && (target_clm
= (current_column ()
390 + XINT (Fchar_width (make_number (c2
)))),
391 target_clm
% XFASTINT (current_buffer
->tab_width
)))))
394 int pos_byte
= PT_BYTE
;
400 /* The actual cursor position after the trial of moving
401 to column TARGET_CLM. It is greater than TARGET_CLM
402 if the TARGET_CLM is middle of multi-column
403 character. In that case, the new point is set after
406 = XFASTINT (Fmove_to_column (make_number (target_clm
), Qnil
));
408 chars_to_delete
= PT
- pos
;
410 if (actual_clm
> target_clm
)
412 /* We will delete too many columns. Let's fill columns
413 by spaces so that the remaining text won't move. */
414 spaces_to_insert
= actual_clm
- target_clm
;
417 SET_PT_BOTH (pos
, pos_byte
);
422 if (!NILP (current_buffer
->abbrev_mode
)
423 && SYNTAX (c
) != Sword
424 && NILP (current_buffer
->read_only
)
425 && PT
> BEGV
&& SYNTAX (XFASTINT (Fprevious_char ())) == Sword
)
430 sym
= Fexpand_abbrev ();
432 /* If we expanded an abbrev which has only a hook,
433 and the hook has a non-nil `no-self-insert' property,
434 return right away--don't really self-insert. */
435 if (! NILP (sym
) && ! NILP (XSYMBOL (sym
)->function
)
436 && SYMBOLP (XSYMBOL (sym
)->function
))
439 prop
= Fget (XSYMBOL (sym
)->function
, intern ("no-self-insert"));
444 if (MODIFF
!= modiff
)
450 string
= make_multibyte_string (str
, 1, len
);
451 if (spaces_to_insert
)
453 tem
= Fmake_string (make_number (spaces_to_insert
),
455 string
= concat2 (tem
, string
);
458 replace_range (PT
, PT
+ chars_to_delete
, string
, 1, 1);
459 SET_PT_BOTH (PT
+ 1 + spaces_to_insert
,
460 PT_BYTE
+ XSTRING (string
)->size
);
463 insert_and_inherit (str
, len
);
465 if ((c
== ' ' || c
== '\n')
467 && !NILP (current_buffer
->auto_fill_function
))
472 /* After inserting a newline, move to previous line and fill
473 that. Must have the newline in place already so filling and
474 justification, if any, know where the end is going to be. */
475 SET_PT_BOTH (PT
- 1, PT_BYTE
- 1);
476 tem
= call0 (current_buffer
->auto_fill_function
);
478 SET_PT_BOTH (PT
+ 1, PT_BYTE
+ 1);
484 /* If previous command specified a face to use, use it. */
485 if (!NILP (Vself_insert_face
)
486 && EQ (current_kboard
->Vlast_command
, Vself_insert_face_command
))
488 Fput_text_property (make_number (PT
- 1), make_number (PT
),
489 Qface
, Vself_insert_face
, Qnil
);
490 Vself_insert_face
= Qnil
;
495 if ((synt
== Sclose
|| synt
== Smath
)
496 && !NILP (Vblink_paren_function
) && INTERACTIVE
499 call0 (Vblink_paren_function
);
505 /* module initialization */
509 Qkill_backward_chars
= intern ("kill-backward-chars");
510 staticpro (&Qkill_backward_chars
);
512 Qkill_forward_chars
= intern ("kill-forward-chars");
513 staticpro (&Qkill_forward_chars
);
515 Qoverwrite_mode_binary
= intern ("overwrite-mode-binary");
516 staticpro (&Qoverwrite_mode_binary
);
518 DEFVAR_LISP ("self-insert-face", &Vself_insert_face
,
519 "If non-nil, set the face of the next self-inserting character to this.\n\
520 See also `self-insert-face-command'.");
521 Vself_insert_face
= Qnil
;
523 DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command
,
524 "This is the command that set up `self-insert-face'.\n\
525 If `last-command' does not equal this value, we ignore `self-insert-face'.");
526 Vself_insert_face_command
= Qnil
;
528 DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function
,
529 "Function called, if non-nil, whenever a close parenthesis is inserted.\n\
530 More precisely, a char with closeparen syntax is self-inserted.");
531 Vblink_paren_function
= Qnil
;
533 defsubr (&Sforward_point
);
534 defsubr (&Sforward_char
);
535 defsubr (&Sbackward_char
);
536 defsubr (&Sforward_line
);
537 defsubr (&Sbeginning_of_line
);
538 defsubr (&Send_of_line
);
540 defsubr (&Sdelete_char
);
541 defsubr (&Sdelete_backward_char
);
543 defsubr (&Sself_insert_command
);
550 initial_define_key (global_map
, Ctl ('I'), "self-insert-command");
551 for (n
= 040; n
< 0177; n
++)
552 initial_define_key (global_map
, n
, "self-insert-command");
554 for (n
= 0200; n
< 0240; n
++)
555 initial_define_key (global_map
, n
, "self-insert-command");
557 for (n
= 0240; n
< 0400; n
++)
558 initial_define_key (global_map
, n
, "self-insert-command");
560 initial_define_key (global_map
, Ctl ('A'), "beginning-of-line");
561 initial_define_key (global_map
, Ctl ('B'), "backward-char");
562 initial_define_key (global_map
, Ctl ('D'), "delete-char");
563 initial_define_key (global_map
, Ctl ('E'), "end-of-line");
564 initial_define_key (global_map
, Ctl ('F'), "forward-char");
565 initial_define_key (global_map
, 0177, "delete-backward-char");