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 point reaches the beginning or end of buffer, it stops there.\n\
158 This command does not move point across a field boundary\n\
159 unless it would move beyond there to a different line.\n\
160 If N is nil or 1, and point starts at a field boundary, point does not move.")
169 SET_PT (XINT (Fline_beginning_position (n
)));
174 DEFUN ("end-of-line", Fend_of_line
, Send_of_line
,
176 "Move point to end of current line.\n\
177 With argument N not nil or 1, move forward N - 1 lines first.\n\
178 If point reaches the beginning or end of buffer, it stops there.\n\
179 This command does not move point across a field boundary\n\
180 unless it would move beyond there to a different line.\n\
181 If N is nil or 1, and point starts at a field boundary, point does not move.")
190 SET_PT (XINT (Fline_end_position (n
)));
195 DEFUN ("delete-char", Fdelete_char
, Sdelete_char
, 1, 2, "p\nP",
196 "Delete the following N characters (previous if N is negative).\n\
197 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
198 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
199 N was explicitly specified.")
201 Lisp_Object n
, killflag
;
213 Fsignal (Qbeginning_of_buffer
, Qnil
);
220 Fsignal (Qend_of_buffer
, Qnil
);
227 call1 (Qkill_forward_chars
, n
);
232 DEFUN ("delete-backward-char", Fdelete_backward_char
, Sdelete_backward_char
,
234 "Delete the previous N characters (following if N is negative).\n\
235 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
236 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
237 N was explicitly specified.")
239 Lisp_Object n
, killflag
;
242 int deleted_special
= 0;
243 int pos
, pos_byte
, i
;
247 /* See if we are about to delete a tab or newline backwards. */
250 for (i
= 0; i
< XINT (n
) && pos_byte
> BEGV_BYTE
; i
++)
254 DEC_BOTH (pos
, pos_byte
);
255 c
= FETCH_BYTE (pos_byte
);
256 if (c
== '\t' || c
== '\n')
263 /* In overwrite mode, back over columns while clearing them out,
264 unless at end of line. */
266 && ! NILP (current_buffer
->overwrite_mode
)
268 && ! (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
270 int column
= current_column ();
272 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
273 i
= column
- current_column ();
274 Finsert_char (make_number (' '), make_number (i
), Qnil
);
275 /* Whitespace chars are ASCII chars, so we can simply subtract. */
276 SET_PT_BOTH (PT
- i
, PT_BYTE
- i
);
279 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
284 DEFUN ("self-insert-command", Fself_insert_command
, Sself_insert_command
, 1, 1, "p",
285 "Insert the character you type.\n\
286 Whichever character you type to run this command is inserted.")
290 int character
= XINT (last_command_char
);
294 /* Barf if the key that invoked this was not a character. */
295 if (!INTEGERP (last_command_char
))
297 else if (XINT (n
) >= 2 && NILP (current_buffer
->overwrite_mode
))
299 int modified_char
= character
;
300 /* Add the offset to the character, for Finsert_char.
301 We pass internal_self_insert the unmodified character
302 because it itself does this offsetting. */
303 if (! NILP (current_buffer
->enable_multibyte_characters
))
304 modified_char
= unibyte_char_to_multibyte (modified_char
);
306 XSETFASTINT (n
, XFASTINT (n
) - 2);
307 /* The first one might want to expand an abbrev. */
308 internal_self_insert (character
, 1);
309 /* The bulk of the copies of this char can be inserted simply.
310 We don't have to handle a user-specified face specially
311 because it will get inherited from the first char inserted. */
312 Finsert_char (make_number (modified_char
), n
, Qt
);
313 /* The last one might want to auto-fill. */
314 internal_self_insert (character
, 0);
319 /* Ok since old and new vals both nonneg */
320 XSETFASTINT (n
, XFASTINT (n
) - 1);
321 internal_self_insert (character
, XFASTINT (n
) != 0);
327 /* Insert character C. If NOAUTOFILL is nonzero, don't do autofill
328 even if it is enabled.
330 If this insertion is suitable for direct output (completely simple),
331 return 0. A value of 1 indicates this *might* not have been simple.
332 A value of 2 means this did things that call for an undo boundary. */
335 internal_self_insert (c
, noautofill
)
339 extern Lisp_Object
Fexpand_abbrev ();
342 register enum syntaxcode synt
;
343 Lisp_Object overwrite
, string
;
344 /* Length of multi-byte form of C. */
346 /* Working buffer and pointer for multi-byte form of C. */
347 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
348 int chars_to_delete
= 0;
349 int spaces_to_insert
= 0;
351 overwrite
= current_buffer
->overwrite_mode
;
352 if (!NILP (Vbefore_change_function
) || !NILP (Vafter_change_function
)
353 || !NILP (Vbefore_change_functions
) || !NILP (Vafter_change_functions
))
356 /* At first, get multi-byte form of C in STR. */
357 if (!NILP (current_buffer
->enable_multibyte_characters
))
359 c
= unibyte_char_to_multibyte (c
);
360 len
= CHAR_STRING (c
, str
);
362 /* If C has modifier bits, this makes C an appropriate
368 str
[0] = (SINGLE_BYTE_CHAR_P (c
)
370 : multibyte_char_to_unibyte (c
, Qnil
));
373 if (!NILP (overwrite
)
376 /* In overwrite-mode, we substitute a character at point (C2,
377 hereafter) by C. For that, we delete C2 in advance. But,
378 just substituting C2 by C may move a remaining text in the
379 line to the right or to the left, which is not preferable.
380 So we insert more spaces or delete more characters in the
381 following cases: if C is narrower than C2, after deleting C2,
382 we fill columns with spaces, if C is wider than C2, we delete
383 C2 and several characters following C2. */
385 /* This is the character after point. */
386 int c2
= FETCH_CHAR (PT_BYTE
);
388 /* Column the cursor should be placed at after this insertion.
389 The correct value should be calculated only when necessary. */
392 /* Overwriting in binary-mode always replaces C2 by C.
393 Overwriting in textual-mode doesn't always do that.
394 It inserts newlines in the usual way,
395 and inserts any character at end of line
396 or before a tab if it doesn't use the whole width of the tab. */
397 if (EQ (overwrite
, Qoverwrite_mode_binary
)
401 && XINT (current_buffer
->tab_width
) > 0
402 && XFASTINT (current_buffer
->tab_width
) < 20
403 && (target_clm
= (current_column ()
404 + XINT (Fchar_width (make_number (c
)))),
405 target_clm
% XFASTINT (current_buffer
->tab_width
)))))
408 int pos_byte
= PT_BYTE
;
414 /* The actual cursor position after the trial of moving
415 to column TARGET_CLM. It is greater than TARGET_CLM
416 if the TARGET_CLM is middle of multi-column
417 character. In that case, the new point is set after
420 = XFASTINT (Fmove_to_column (make_number (target_clm
), Qnil
));
422 chars_to_delete
= PT
- pos
;
424 if (actual_clm
> target_clm
)
426 /* We will delete too many columns. Let's fill columns
427 by spaces so that the remaining text won't move. */
428 spaces_to_insert
= actual_clm
- target_clm
;
431 SET_PT_BOTH (pos
, pos_byte
);
436 if (!NILP (current_buffer
->abbrev_mode
)
437 && SYNTAX (c
) != Sword
438 && NILP (current_buffer
->read_only
)
439 && PT
> BEGV
&& SYNTAX (XFASTINT (Fprevious_char ())) == Sword
)
444 sym
= Fexpand_abbrev ();
446 /* If we expanded an abbrev which has a hook,
447 and the hook has a non-nil `no-self-insert' property,
448 return right away--don't really self-insert. */
449 if (! NILP (sym
) && ! NILP (XSYMBOL (sym
)->function
)
450 && SYMBOLP (XSYMBOL (sym
)->function
))
453 prop
= Fget (XSYMBOL (sym
)->function
, intern ("no-self-insert"));
458 if (MODIFF
!= modiff
)
464 string
= make_string_from_bytes (str
, 1, len
);
465 if (spaces_to_insert
)
467 tem
= Fmake_string (make_number (spaces_to_insert
),
469 string
= concat2 (tem
, string
);
472 replace_range (PT
, PT
+ chars_to_delete
, string
, 1, 1, 1);
473 Fforward_char (make_number (1 + spaces_to_insert
));
476 insert_and_inherit (str
, len
);
478 if ((CHAR_TABLE_P (Vauto_fill_chars
)
479 ? !NILP (CHAR_TABLE_REF (Vauto_fill_chars
, c
))
480 : (c
== ' ' || c
== '\n'))
482 && !NILP (current_buffer
->auto_fill_function
))
487 /* After inserting a newline, move to previous line and fill
488 that. Must have the newline in place already so filling and
489 justification, if any, know where the end is going to be. */
490 SET_PT_BOTH (PT
- 1, PT_BYTE
- 1);
491 tem
= call0 (current_buffer
->auto_fill_function
);
493 SET_PT_BOTH (PT
+ 1, PT_BYTE
+ 1);
499 /* If previous command specified a face to use, use it. */
500 if (!NILP (Vself_insert_face
)
501 && EQ (current_kboard
->Vlast_command
, Vself_insert_face_command
))
503 Fput_text_property (make_number (PT
- 1), make_number (PT
),
504 Qface
, Vself_insert_face
, Qnil
);
505 Vself_insert_face
= Qnil
;
510 if ((synt
== Sclose
|| synt
== Smath
)
511 && !NILP (Vblink_paren_function
) && INTERACTIVE
514 call0 (Vblink_paren_function
);
520 /* module initialization */
525 Qkill_backward_chars
= intern ("kill-backward-chars");
526 staticpro (&Qkill_backward_chars
);
528 Qkill_forward_chars
= intern ("kill-forward-chars");
529 staticpro (&Qkill_forward_chars
);
531 Qoverwrite_mode_binary
= intern ("overwrite-mode-binary");
532 staticpro (&Qoverwrite_mode_binary
);
534 DEFVAR_LISP ("self-insert-face", &Vself_insert_face
,
535 "If non-nil, set the face of the next self-inserting character to this.\n\
536 See also `self-insert-face-command'.");
537 Vself_insert_face
= Qnil
;
539 DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command
,
540 "This is the command that set up `self-insert-face'.\n\
541 If `last-command' does not equal this value, we ignore `self-insert-face'.");
542 Vself_insert_face_command
= Qnil
;
544 DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function
,
545 "Function called, if non-nil, whenever a close parenthesis is inserted.\n\
546 More precisely, a char with closeparen syntax is self-inserted.");
547 Vblink_paren_function
= Qnil
;
549 defsubr (&Sforward_point
);
550 defsubr (&Sforward_char
);
551 defsubr (&Sbackward_char
);
552 defsubr (&Sforward_line
);
553 defsubr (&Sbeginning_of_line
);
554 defsubr (&Send_of_line
);
556 defsubr (&Sdelete_char
);
557 defsubr (&Sdelete_backward_char
);
559 defsubr (&Sself_insert_command
);
567 initial_define_key (global_map
, Ctl ('I'), "self-insert-command");
568 for (n
= 040; n
< 0177; n
++)
569 initial_define_key (global_map
, n
, "self-insert-command");
571 for (n
= 0200; n
< 0240; n
++)
572 initial_define_key (global_map
, n
, "self-insert-command");
574 for (n
= 0240; n
< 0400; n
++)
575 initial_define_key (global_map
, n
, "self-insert-command");
577 initial_define_key (global_map
, Ctl ('A'), "beginning-of-line");
578 initial_define_key (global_map
, Ctl ('B'), "backward-char");
579 initial_define_key (global_map
, Ctl ('D'), "delete-char");
580 initial_define_key (global_map
, Ctl ('E'), "end-of-line");
581 initial_define_key (global_map
, Ctl ('F'), "forward-char");
582 initial_define_key (global_map
, 0177, "delete-backward-char");