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. */
30 #include "dispextern.h"
32 Lisp_Object Qkill_forward_chars
, Qkill_backward_chars
, Vblink_paren_function
;
34 /* A possible value for a buffer's overwrite-mode variable. */
35 Lisp_Object Qoverwrite_mode_binary
;
37 /* Non-nil means put this face on the next self-inserting character. */
38 Lisp_Object Vself_insert_face
;
40 /* This is the command that set up Vself_insert_face. */
41 Lisp_Object Vself_insert_face_command
;
43 extern Lisp_Object Qface
;
45 DEFUN ("forward-point", Fforward_point
, Sforward_point
, 1, 1, 0,
46 "Return buffer position N characters after (before if N negative) point.")
52 return make_number (PT
+ XINT (n
));
55 DEFUN ("forward-char", Fforward_char
, Sforward_char
, 0, 1, "p",
56 "Move point right N characters (left if N is negative).\n\
57 On reaching end of buffer, stop and signal error.")
66 /* This used to just set point to point + XINT (n), and then check
67 to see if it was within boundaries. But now that SET_PT can
68 potentially do a lot of stuff (calling entering and exiting
69 hooks, etcetera), that's not a good approach. So we validate the
70 proposed position, then set point. */
72 int new_point
= PT
+ XINT (n
);
77 Fsignal (Qbeginning_of_buffer
, Qnil
);
82 Fsignal (Qend_of_buffer
, Qnil
);
91 DEFUN ("backward-char", Fbackward_char
, Sbackward_char
, 0, 1, "p",
92 "Move point left N characters (right if N is negative).\n\
93 On attempt to pass beginning or end of buffer, stop and signal error.")
102 XSETINT (n
, - XINT (n
));
103 return Fforward_char (n
);
106 DEFUN ("forward-line", Fforward_line
, Sforward_line
, 0, 1, "p",
107 "Move N lines forward (backward if N is negative).\n\
108 Precisely, if point is on line I, move to the start of line I + N.\n\
109 If there isn't room, go as far as possible (no error).\n\
110 Returns the count of lines left to move. If moving forward,\n\
111 that is N - number of lines moved; if backward, N + number moved.\n\
112 With positive N, a non-empty line at the end counts as one line\n\
113 successfully moved (for the return value).")
117 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
,
155 "Move point to beginning of current line.\n\
156 With argument N not nil or 1, move forward N - 1 lines first.\n\
157 If scan reaches end of buffer, stop there without error.")
166 SET_PT (XINT (Fline_beginning_position (n
)));
171 DEFUN ("end-of-line", Fend_of_line
, Send_of_line
,
173 "Move point to end of current line.\n\
174 With argument N not nil or 1, move forward N - 1 lines first.\n\
175 If scan reaches end of buffer, stop there without error.")
184 SET_PT (XINT (Fline_end_position (n
)));
189 DEFUN ("delete-char", Fdelete_char
, Sdelete_char
, 1, 2, "p\nP",
190 "Delete the following N characters (previous if N is negative).\n\
191 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
192 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
193 N was explicitly specified.")
195 Lisp_Object n
, killflag
;
207 Fsignal (Qbeginning_of_buffer
, Qnil
);
214 Fsignal (Qend_of_buffer
, Qnil
);
221 call1 (Qkill_forward_chars
, n
);
226 DEFUN ("delete-backward-char", Fdelete_backward_char
, Sdelete_backward_char
,
228 "Delete the previous N characters (following if N is negative).\n\
229 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
230 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
231 N was explicitly specified.")
233 Lisp_Object n
, killflag
;
236 int deleted_special
= 0;
237 int pos
, pos_byte
, i
;
241 /* See if we are about to delete a tab or newline backwards. */
244 for (i
= 0; i
< XINT (n
) && pos_byte
> BEGV_BYTE
; i
++)
248 DEC_BOTH (pos
, pos_byte
);
249 c
= FETCH_BYTE (pos_byte
);
250 if (c
== '\t' || c
== '\n')
257 /* In overwrite mode, back over columns while clearing them out,
258 unless at end of line. */
260 && ! NILP (current_buffer
->overwrite_mode
)
262 && ! (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
264 int column
= current_column ();
266 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
267 i
= column
- current_column ();
268 Finsert_char (make_number (' '), make_number (i
), Qnil
);
269 /* Whitespace chars are ASCII chars, so we can simply subtract. */
270 SET_PT_BOTH (PT
- i
, PT_BYTE
- i
);
273 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
278 DEFUN ("self-insert-command", Fself_insert_command
, Sself_insert_command
, 1, 1, "p",
279 "Insert the character you type.\n\
280 Whichever character you type to run this command is inserted.")
284 int character
= XINT (last_command_char
);
288 /* Barf if the key that invoked this was not a character. */
289 if (!INTEGERP (last_command_char
))
291 else if (XINT (n
) >= 2 && NILP (current_buffer
->overwrite_mode
))
293 int modified_char
= character
;
294 /* Add the offset to the character, for Finsert_char.
295 We pass internal_self_insert the unmodified character
296 because it itself does this offsetting. */
297 if (! NILP (current_buffer
->enable_multibyte_characters
))
298 modified_char
= unibyte_char_to_multibyte (modified_char
);
300 XSETFASTINT (n
, XFASTINT (n
) - 2);
301 /* The first one might want to expand an abbrev. */
302 internal_self_insert (character
, 1);
303 /* The bulk of the copies of this char can be inserted simply.
304 We don't have to handle a user-specified face specially
305 because it will get inherited from the first char inserted. */
306 Finsert_char (make_number (modified_char
), n
, Qt
);
307 /* The last one might want to auto-fill. */
308 internal_self_insert (character
, 0);
313 /* Ok since old and new vals both nonneg */
314 XSETFASTINT (n
, XFASTINT (n
) - 1);
315 internal_self_insert (character
, XFASTINT (n
) != 0);
321 /* Insert character C. If NOAUTOFILL is nonzero, don't do autofill
322 even if it is enabled.
324 If this insertion is suitable for direct output (completely simple),
325 return 0. A value of 1 indicates this *might* not have been simple.
326 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 overwrite
= current_buffer
->overwrite_mode
;
346 if (!NILP (Vbefore_change_function
) || !NILP (Vafter_change_function
)
347 || !NILP (Vbefore_change_functions
) || !NILP (Vafter_change_functions
))
350 /* At first, get multi-byte form of C in STR. */
351 if (!NILP (current_buffer
->enable_multibyte_characters
))
353 c
= unibyte_char_to_multibyte (c
);
354 len
= CHAR_STRING (c
, workbuf
, str
);
356 /* If C has modifier bits, this makes C an appropriate
362 workbuf
[0] = (SINGLE_BYTE_CHAR_P (c
)
364 : multibyte_char_to_unibyte (c
, Qnil
));
368 if (!NILP (overwrite
)
371 /* In overwrite-mode, we substitute a character at point (C2,
372 hereafter) by C. For that, we delete C2 in advance. But,
373 just substituting C2 by C may move a remaining text in the
374 line to the right or to the left, which is not preferable.
375 So we insert more spaces or delete more characters in the
376 following cases: if C is narrower than C2, after deleting C2,
377 we fill columns with spaces, if C is wider than C2, we delete
378 C2 and several characters following C2. */
380 /* This is the character after point. */
381 int c2
= FETCH_CHAR (PT_BYTE
);
383 /* Column the cursor should be placed at after this insertion.
384 The correct value should be calculated only when necessary. */
387 /* Overwriting in binary-mode always replaces C2 by C.
388 Overwriting in textual-mode doesn't always do that.
389 It inserts newlines in the usual way,
390 and inserts any character at end of line
391 or before a tab if it doesn't use the whole width of the tab. */
392 if (EQ (overwrite
, Qoverwrite_mode_binary
)
396 && XINT (current_buffer
->tab_width
) > 0
397 && XFASTINT (current_buffer
->tab_width
) < 20
398 && (target_clm
= (current_column ()
399 + XINT (Fchar_width (make_number (c
)))),
400 target_clm
% XFASTINT (current_buffer
->tab_width
)))))
403 int pos_byte
= PT_BYTE
;
409 /* The actual cursor position after the trial of moving
410 to column TARGET_CLM. It is greater than TARGET_CLM
411 if the TARGET_CLM is middle of multi-column
412 character. In that case, the new point is set after
415 = XFASTINT (Fmove_to_column (make_number (target_clm
), Qnil
));
417 chars_to_delete
= PT
- pos
;
419 if (actual_clm
> target_clm
)
421 /* We will delete too many columns. Let's fill columns
422 by spaces so that the remaining text won't move. */
423 spaces_to_insert
= actual_clm
- target_clm
;
426 SET_PT_BOTH (pos
, pos_byte
);
431 if (!NILP (current_buffer
->abbrev_mode
)
432 && SYNTAX (c
) != Sword
433 && NILP (current_buffer
->read_only
)
434 && PT
> BEGV
&& SYNTAX (XFASTINT (Fprevious_char ())) == Sword
)
439 sym
= Fexpand_abbrev ();
441 /* If we expanded an abbrev which has only a hook,
442 and the hook has a non-nil `no-self-insert' property,
443 return right away--don't really self-insert. */
444 if (! NILP (sym
) && ! NILP (XSYMBOL (sym
)->function
)
445 && SYMBOLP (XSYMBOL (sym
)->function
))
448 prop
= Fget (XSYMBOL (sym
)->function
, intern ("no-self-insert"));
453 if (MODIFF
!= modiff
)
459 string
= make_string_from_bytes (str
, 1, len
);
460 if (spaces_to_insert
)
462 tem
= Fmake_string (make_number (spaces_to_insert
),
464 string
= concat2 (tem
, string
);
467 replace_range (PT
, PT
+ chars_to_delete
, string
, 1, 1, 1);
468 Fforward_char (make_number (1 + spaces_to_insert
));
471 insert_and_inherit (str
, len
);
473 if ((CHAR_TABLE_P (Vauto_fill_chars
)
474 ? !NILP (CHAR_TABLE_REF (Vauto_fill_chars
, c
))
475 : (c
== ' ' || c
== '\n'))
477 && !NILP (current_buffer
->auto_fill_function
))
482 /* After inserting a newline, move to previous line and fill
483 that. Must have the newline in place already so filling and
484 justification, if any, know where the end is going to be. */
485 SET_PT_BOTH (PT
- 1, PT_BYTE
- 1);
486 tem
= call0 (current_buffer
->auto_fill_function
);
488 SET_PT_BOTH (PT
+ 1, PT_BYTE
+ 1);
494 /* If previous command specified a face to use, use it. */
495 if (!NILP (Vself_insert_face
)
496 && EQ (current_kboard
->Vlast_command
, Vself_insert_face_command
))
498 Fput_text_property (make_number (PT
- 1), make_number (PT
),
499 Qface
, Vself_insert_face
, Qnil
);
500 Vself_insert_face
= Qnil
;
505 if ((synt
== Sclose
|| synt
== Smath
)
506 && !NILP (Vblink_paren_function
) && INTERACTIVE
509 call0 (Vblink_paren_function
);
515 /* module initialization */
520 Qkill_backward_chars
= intern ("kill-backward-chars");
521 staticpro (&Qkill_backward_chars
);
523 Qkill_forward_chars
= intern ("kill-forward-chars");
524 staticpro (&Qkill_forward_chars
);
526 Qoverwrite_mode_binary
= intern ("overwrite-mode-binary");
527 staticpro (&Qoverwrite_mode_binary
);
529 DEFVAR_LISP ("self-insert-face", &Vself_insert_face
,
530 "If non-nil, set the face of the next self-inserting character to this.\n\
531 See also `self-insert-face-command'.");
532 Vself_insert_face
= Qnil
;
534 DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command
,
535 "This is the command that set up `self-insert-face'.\n\
536 If `last-command' does not equal this value, we ignore `self-insert-face'.");
537 Vself_insert_face_command
= Qnil
;
539 DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function
,
540 "Function called, if non-nil, whenever a close parenthesis is inserted.\n\
541 More precisely, a char with closeparen syntax is self-inserted.");
542 Vblink_paren_function
= Qnil
;
544 defsubr (&Sforward_point
);
545 defsubr (&Sforward_char
);
546 defsubr (&Sbackward_char
);
547 defsubr (&Sforward_line
);
548 defsubr (&Sbeginning_of_line
);
549 defsubr (&Send_of_line
);
551 defsubr (&Sdelete_char
);
552 defsubr (&Sdelete_backward_char
);
554 defsubr (&Sself_insert_command
);
562 initial_define_key (global_map
, Ctl ('I'), "self-insert-command");
563 for (n
= 040; n
< 0177; n
++)
564 initial_define_key (global_map
, n
, "self-insert-command");
566 for (n
= 0200; n
< 0240; n
++)
567 initial_define_key (global_map
, n
, "self-insert-command");
569 for (n
= 0240; n
< 0400; n
++)
570 initial_define_key (global_map
, n
, "self-insert-command");
572 initial_define_key (global_map
, Ctl ('A'), "beginning-of-line");
573 initial_define_key (global_map
, Ctl ('B'), "backward-char");
574 initial_define_key (global_map
, Ctl ('D'), "delete-char");
575 initial_define_key (global_map
, Ctl ('E'), "end-of-line");
576 initial_define_key (global_map
, Ctl ('F'), "forward-char");
577 initial_define_key (global_map
, 0177, "delete-backward-char");