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;
242 /* See if we are about to delete a tab or newline backwards. */
244 for (i
= 0; i
< XINT (n
) && pos
> BEGV_BYTE
; i
++)
249 c
= FETCH_BYTE (pos
);
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. */
328 internal_self_insert (c
, noautofill
)
332 extern Lisp_Object
Fexpand_abbrev ();
335 register enum syntaxcode synt
;
336 Lisp_Object overwrite
, string
;
337 /* Length of multi-byte form of C. */
339 /* Working buffer and pointer for multi-byte form of C. */
340 unsigned char workbuf
[4], *str
;
341 int chars_to_delete
= 0;
342 int spaces_to_insert
= 0;
344 if (! NILP (current_buffer
->enable_multibyte_characters
))
345 c
= unibyte_char_to_multibyte (c
);
347 overwrite
= current_buffer
->overwrite_mode
;
348 if (!NILP (Vbefore_change_function
) || !NILP (Vafter_change_function
)
349 || !NILP (Vbefore_change_functions
) || !NILP (Vafter_change_functions
))
352 /* At first, get multi-byte form of C in STR. */
353 if (!NILP (current_buffer
->enable_multibyte_characters
))
354 len
= CHAR_STRING (c
, workbuf
, str
);
356 workbuf
[0] = c
, str
= workbuf
, len
= 1;
358 if (!NILP (overwrite
)
361 /* In overwrite-mode, we substitute a character at point (C2,
362 hereafter) by C. For that, we delete C2 in advance. But,
363 just substituting C2 by C may move a remaining text in the
364 line to the right or to the left, which is not preferable.
365 So we insert more spaces or delete more characters in the
366 following cases: if C is narrower than C2, after deleting C2,
367 we fill columns with spaces, if C is wider than C2, we delete
368 C2 and several characters following C2. */
370 /* This is the character after point. */
371 int c2
= FETCH_CHAR (PT_BYTE
);
373 /* Column the cursor should be placed at after this insertion.
374 The correct value should be calculated only when necessary. */
377 /* Overwriting in binary-mode always replaces C2 by C.
378 Overwriting in textual-mode doesn't always do that.
379 It inserts newlines in the usual way,
380 and inserts any character at end of line
381 or before a tab if it doesn't use the whole width of the tab. */
382 if (EQ (overwrite
, Qoverwrite_mode_binary
)
386 && XINT (current_buffer
->tab_width
) > 0
387 && XFASTINT (current_buffer
->tab_width
) < 20
388 && (target_clm
= (current_column ()
389 + XINT (Fchar_width (make_number (c2
)))),
390 target_clm
% XFASTINT (current_buffer
->tab_width
)))))
393 int pos_byte
= PT_BYTE
;
399 /* The actual cursor position after the trial of moving
400 to column TARGET_CLM. It is greater than TARGET_CLM
401 if the TARGET_CLM is middle of multi-column
402 character. In that case, the new point is set after
405 = XFASTINT (Fmove_to_column (make_number (target_clm
), Qnil
));
407 chars_to_delete
= PT
- pos
;
409 if (actual_clm
> target_clm
)
411 /* We will delete too many columns. Let's fill columns
412 by spaces so that the remaining text won't move. */
413 spaces_to_insert
= actual_clm
- target_clm
;
416 SET_PT_BOTH (pos
, pos_byte
);
421 if (!NILP (current_buffer
->abbrev_mode
)
422 && SYNTAX (c
) != Sword
423 && NILP (current_buffer
->read_only
)
424 && PT
> BEGV
&& SYNTAX (XFASTINT (Fprevious_char ())) == Sword
)
429 sym
= Fexpand_abbrev ();
431 /* If we expanded an abbrev which has only a hook,
432 and the hook has a non-nil `no-self-insert' property,
433 return right away--don't really self-insert. */
434 if (! NILP (sym
) && ! NILP (XSYMBOL (sym
)->function
)
435 && SYMBOLP (XSYMBOL (sym
)->function
))
438 prop
= Fget (XSYMBOL (sym
)->function
, intern ("no-self-insert"));
443 if (MODIFF
!= modiff
)
449 string
= make_multibyte_string (str
, 1, len
);
450 if (spaces_to_insert
)
452 tem
= Fmake_string (make_number (spaces_to_insert
),
454 string
= concat2 (tem
, string
);
457 replace_range (PT
, PT
+ chars_to_delete
, string
, 1, 1);
458 SET_PT_BOTH (PT
+ 1 + spaces_to_insert
,
459 PT_BYTE
+ XSTRING (string
)->size
);
462 insert_and_inherit (str
, len
);
464 if ((c
== ' ' || c
== '\n')
466 && !NILP (current_buffer
->auto_fill_function
))
471 /* After inserting a newline, move to previous line and fill
472 that. Must have the newline in place already so filling and
473 justification, if any, know where the end is going to be. */
474 SET_PT_BOTH (PT
- 1, PT_BYTE
- 1);
475 tem
= call0 (current_buffer
->auto_fill_function
);
477 SET_PT_BOTH (PT
+ 1, PT_BYTE
+ 1);
483 /* If previous command specified a face to use, use it. */
484 if (!NILP (Vself_insert_face
)
485 && EQ (current_kboard
->Vlast_command
, Vself_insert_face_command
))
487 Fput_text_property (make_number (PT
- 1), make_number (PT
),
488 Qface
, Vself_insert_face
, Qnil
);
489 Vself_insert_face
= Qnil
;
494 if ((synt
== Sclose
|| synt
== Smath
)
495 && !NILP (Vblink_paren_function
) && INTERACTIVE
498 call0 (Vblink_paren_function
);
504 /* module initialization */
508 Qkill_backward_chars
= intern ("kill-backward-chars");
509 staticpro (&Qkill_backward_chars
);
511 Qkill_forward_chars
= intern ("kill-forward-chars");
512 staticpro (&Qkill_forward_chars
);
514 Qoverwrite_mode_binary
= intern ("overwrite-mode-binary");
515 staticpro (&Qoverwrite_mode_binary
);
517 DEFVAR_LISP ("self-insert-face", &Vself_insert_face
,
518 "If non-nil, set the face of the next self-inserting character to this.\n\
519 See also `self-insert-face-command'.");
520 Vself_insert_face
= Qnil
;
522 DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command
,
523 "This is the command that set up `self-insert-face'.\n\
524 If `last-command' does not equal this value, we ignore `self-insert-face'.");
525 Vself_insert_face_command
= Qnil
;
527 DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function
,
528 "Function called, if non-nil, whenever a close parenthesis is inserted.\n\
529 More precisely, a char with closeparen syntax is self-inserted.");
530 Vblink_paren_function
= Qnil
;
532 defsubr (&Sforward_point
);
533 defsubr (&Sforward_char
);
534 defsubr (&Sbackward_char
);
535 defsubr (&Sforward_line
);
536 defsubr (&Sbeginning_of_line
);
537 defsubr (&Send_of_line
);
539 defsubr (&Sdelete_char
);
540 defsubr (&Sdelete_backward_char
);
542 defsubr (&Sself_insert_command
);
549 initial_define_key (global_map
, Ctl ('I'), "self-insert-command");
550 for (n
= 040; n
< 0177; n
++)
551 initial_define_key (global_map
, n
, "self-insert-command");
553 for (n
= 0200; n
< 0240; n
++)
554 initial_define_key (global_map
, n
, "self-insert-command");
556 for (n
= 0240; n
< 0400; n
++)
557 initial_define_key (global_map
, n
, "self-insert-command");
559 initial_define_key (global_map
, Ctl ('A'), "beginning-of-line");
560 initial_define_key (global_map
, Ctl ('B'), "backward-char");
561 initial_define_key (global_map
, Ctl ('D'), "delete-char");
562 initial_define_key (global_map
, Ctl ('E'), "end-of-line");
563 initial_define_key (global_map
, Ctl ('F'), "forward-char");
564 initial_define_key (global_map
, 0177, "delete-backward-char");