1 /* Simple built-in editing commands.
2 Copyright (C) 1985, 93, 94, 95, 96, 1997 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 /* Offset to add to a non-ASCII value when inserting it. */
43 int nonascii_insert_offset
;
45 extern Lisp_Object Qface
;
47 /* Return buffer position which is N characters after `point'. */
54 if (!NILP (current_buffer
->enable_multibyte_characters
))
56 /* Simply adding N to `point' doesn't work because of multi-byte
57 form. We had better not use INC_POS and DEC_POS because they
58 check the gap position every time. But, for the moment, we
62 while (pos
< ZV
&& n
--) INC_POS (pos
);
67 while (pos
> BEGV
&& n
++) DEC_POS (pos
);
76 DEFUN ("forward-point", Fforward_point
, Sforward_point
, 1, 1, 0,
77 "Return buffer position N characters after (before if N negative) point.")
83 return make_number (forward_point (XINT (n
)));
86 DEFUN ("forward-char", Fforward_char
, Sforward_char
, 0, 1, "p",
87 "Move point right N characters (left if N is negative).\n\
88 On reaching end of buffer, stop and signal error.")
97 /* This used to just set point to point + XINT (n), and then check
98 to see if it was within boundaries. But now that SET_PT can
99 potentially do a lot of stuff (calling entering and exiting
100 hooks, etcetera), that's not a good approach. So we validate the
101 proposed position, then set point. */
103 int new_point
= forward_point (XINT (n
));
105 if (new_point
< BEGV
)
108 Fsignal (Qbeginning_of_buffer
, Qnil
);
113 Fsignal (Qend_of_buffer
, Qnil
);
122 DEFUN ("backward-char", Fbackward_char
, Sbackward_char
, 0, 1, "p",
123 "Move point left N characters (right if N is negative).\n\
124 On attempt to pass beginning or end of buffer, stop and signal error.")
133 XSETINT (n
, - XINT (n
));
134 return Fforward_char (n
);
137 DEFUN ("forward-line", Fforward_line
, Sforward_line
, 0, 1, "p",
138 "Move N lines forward (backward if N is negative).\n\
139 Precisely, if point is on line I, move to the start of line I + N.\n\
140 If there isn't room, go as far as possible (no error).\n\
141 Returns the count of lines left to move. If moving forward,\n\
142 that is N - number of lines moved; if backward, N + number moved.\n\
143 With positive N, a non-empty line at the end counts as one line\n\
144 successfully moved (for the return value).")
150 int count
, shortage
, negp
;
161 pos
= scan_buffer ('\n', pos2
, 0, count
- negp
, &shortage
, 1);
166 && FETCH_BYTE (pos
- 1) != '\n')))
169 return make_number (negp
? - shortage
: shortage
);
172 DEFUN ("beginning-of-line", Fbeginning_of_line
, Sbeginning_of_line
,
174 "Move point to beginning of current line.\n\
175 With argument N not nil or 1, move forward N - 1 lines first.\n\
176 If scan reaches end of buffer, stop there without error.")
185 SET_PT (XINT (Fline_beginning_position (n
)));
189 DEFUN ("end-of-line", Fend_of_line
, Send_of_line
,
191 "Move point to end of current line.\n\
192 With argument N not nil or 1, move forward N - 1 lines first.\n\
193 If scan reaches end of buffer, stop there without error.")
205 SET_PT (XINT (Fline_end_position (n
)));
210 DEFUN ("delete-char", Fdelete_char
, Sdelete_char
, 1, 2, "p\nP",
211 "Delete the following N characters (previous if N is negative).\n\
212 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
213 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
214 N was explicitly specified.")
216 Lisp_Object n
, killflag
;
222 pos
= forward_point (XINT (n
));
228 Fsignal (Qbeginning_of_buffer
, Qnil
);
235 Fsignal (Qend_of_buffer
, Qnil
);
242 call1 (Qkill_forward_chars
, n
);
247 DEFUN ("delete-backward-char", Fdelete_backward_char
, Sdelete_backward_char
,
249 "Delete the previous N characters (following if N is negative).\n\
250 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
251 Interactively, N is the prefix arg, and KILLFLAG is set if\n\
252 N was explicitly specified.")
254 Lisp_Object n
, killflag
;
257 int deleted_special
= 0;
262 /* See if we are about to delete a tab or newline backwards. */
264 for (i
= 0; i
< XINT (n
) && pos
> BEGV
; i
++)
269 c
= FETCH_BYTE (pos
);
270 if (c
== '\t' || c
== '\n')
277 /* In overwrite mode, back over columns while clearing them out,
278 unless at end of line. */
280 && ! NILP (current_buffer
->overwrite_mode
)
282 && ! (PT
== ZV
|| FETCH_BYTE (PT
) == '\n'))
284 int column
= current_column ();
286 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
287 i
= column
- current_column ();
288 Finsert_char (make_number (' '), make_number (i
), Qnil
);
292 value
= Fdelete_char (make_number (-XINT (n
)), killflag
);
297 DEFUN ("self-insert-command", Fself_insert_command
, Sself_insert_command
, 1, 1, "p",
298 "Insert the character you type.\n\
299 Whichever character you type to run this command is inserted.")
303 int character
= XINT (last_command_char
);
307 /* Barf if the key that invoked this was not a character. */
308 if (!INTEGERP (last_command_char
))
310 else if (XINT (n
) >= 2 && NILP (current_buffer
->overwrite_mode
))
312 int modified_char
= character
;
313 /* Add the offset to the character, for Finsert_char.
314 We pass internal_self_insert the unmodified character
315 because it itself does this offsetting. */
316 if (modified_char
>= 0200 && modified_char
<= 0377
317 && ! NILP (current_buffer
->enable_multibyte_characters
))
318 modified_char
+= nonascii_insert_offset
;
320 XSETFASTINT (n
, XFASTINT (n
) - 2);
321 /* The first one might want to expand an abbrev. */
322 internal_self_insert (character
, 1);
323 /* The bulk of the copies of this char can be inserted simply.
324 We don't have to handle a user-specified face specially
325 because it will get inherited from the first char inserted. */
326 Finsert_char (make_number (modified_char
), n
, Qt
);
327 /* The last one might want to auto-fill. */
328 internal_self_insert (character
, 0);
333 /* Ok since old and new vals both nonneg */
334 XSETFASTINT (n
, XFASTINT (n
) - 1);
335 internal_self_insert (character
, XFASTINT (n
) != 0);
341 /* Insert character C. If NOAUTOFILL is nonzero, don't do autofill
342 even if it is enabled.
344 If this insertion is suitable for direct output (completely simple),
345 return 0. A value of 1 indicates this *might* not have been simple.
346 A value of 2 means this did things that call for an undo boundary. */
348 internal_self_insert (c
, noautofill
)
352 extern Lisp_Object
Fexpand_abbrev ();
355 register enum syntaxcode synt
;
356 Lisp_Object overwrite
, string
;
357 /* Length of multi-byte form of C. */
359 /* Working buffer and pointer for multi-byte form of C. */
360 unsigned char workbuf
[4], *str
;
361 int number_to_delete
= 0;
362 int spaces_to_insert
= 0;
364 if (c
>= 0200 && c
<= 0377
365 && ! NILP (current_buffer
->enable_multibyte_characters
))
366 c
+= nonascii_insert_offset
;
368 overwrite
= current_buffer
->overwrite_mode
;
369 if (!NILP (Vbefore_change_function
) || !NILP (Vafter_change_function
)
370 || !NILP (Vbefore_change_functions
) || !NILP (Vafter_change_functions
))
373 /* At first, get multi-byte form of C in STR. */
374 if (!NILP (current_buffer
->enable_multibyte_characters
))
375 len
= CHAR_STRING (c
, workbuf
, str
);
377 workbuf
[0] = c
, str
= workbuf
, len
= 1;
379 if (!NILP (overwrite
)
382 /* In overwrite-mode, we substitute a character at point (C2,
383 hereafter) by C. For that, we delete C2 in advance. But,
384 just substituting C2 by C may move a remaining text in the
385 line to the right or to the left, which is not preferable.
386 So we insert more spaces or delete more characters in the
387 following cases: if C is narrower than C2, after deleting C2,
388 we fill columns with spaces, if C is wider than C2, we delete
389 C2 and several characters following C2. */
391 /* A code at `point'. Since this is checked only against
392 NEWLINE and TAB, we don't need a character code but only the
393 first byte of multi-byte form. */
394 unsigned char c2
= FETCH_BYTE (PT
);
395 /* A column the cursor should be placed at after this insertion.
396 The correct value should be calculated only when necessary. */
399 /* Overwriting in binary-mode always substitute C2 by C. But,
400 overwriting in textual-mode does this substitution in the
401 case that C is not NEWLINE and C2 is not NEWLINE nor TAB. If
402 C2 is TAB, the substitution is done only when C2 is currently
403 expanded to 0 column, or more than 20 columns, or more than
405 if (EQ (overwrite
, Qoverwrite_mode_binary
)
408 && (target_clm
= current_column() + WIDTH_BY_CHAR_HEAD (str
[0]),
410 || XINT (current_buffer
->tab_width
) <= 0
411 || XFASTINT (current_buffer
->tab_width
) > 20
412 || !(target_clm
% XFASTINT (current_buffer
->tab_width
))))))
417 number_to_delete
= forward_point (1) - PT
;
420 /* The actual cursor position after the trial of moving
421 to column TARGET_CLM. It is greater than TARGET_CLM
422 if the TARGET_CLM is middle of multi-column
423 character. In that case, the new point is set after
426 = XFASTINT (Fmove_to_column (make_number (target_clm
), Qnil
));
428 number_to_delete
= PT
- pos
;
430 if (actual_clm
> target_clm
)
432 /* We will delete too many columns. Let's fill columns
433 by spaces so that the remaining text won't move. */
434 spaces_to_insert
= actual_clm
- target_clm
;
442 if (!NILP (current_buffer
->abbrev_mode
)
443 && SYNTAX (c
) != Sword
444 && NILP (current_buffer
->read_only
)
445 && PT
> BEGV
&& SYNTAX (XFASTINT (Fprevious_char ())) == Sword
)
450 sym
= Fexpand_abbrev ();
452 /* If we expanded an abbrev which has only a hook,
453 and the hook has a non-nil `no-self-insert' property,
454 return right away--don't really self-insert. */
455 if (! NILP (sym
) && ! NILP (XSYMBOL (sym
)->function
)
456 && SYMBOLP (XSYMBOL (sym
)->function
))
459 prop
= Fget (XSYMBOL (sym
)->function
, intern ("no-self-insert"));
464 if (MODIFF
!= modiff
)
468 if (number_to_delete
)
470 string
= make_string (str
, len
);
471 if (spaces_to_insert
)
473 tem
= Fmake_string (make_number (spaces_to_insert
),
475 string
= concat2 (tem
, string
);
478 replace_range (PT
, PT
+ number_to_delete
, string
, 1, 1);
479 SET_PT (PT
+ XSTRING (string
)->size
);
482 insert_and_inherit (str
, len
);
484 if ((c
== ' ' || c
== '\n')
486 && !NILP (current_buffer
->auto_fill_function
))
491 /* After inserting a newline, move to previous line and fill */
492 /* that. Must have the newline in place already so filling and */
493 /* justification, if any, know where the end is going to be. */
495 tem
= call0 (current_buffer
->auto_fill_function
);
503 /* If previous command specified a face to use, use it. */
504 if (!NILP (Vself_insert_face
)
505 && EQ (current_kboard
->Vlast_command
, Vself_insert_face_command
))
507 Lisp_Object before
, after
;
508 XSETINT (before
, PT
- len
);
510 Fput_text_property (before
, after
, Qface
, Vself_insert_face
, Qnil
);
511 Vself_insert_face
= Qnil
;
516 if ((synt
== Sclose
|| synt
== Smath
)
517 && !NILP (Vblink_paren_function
) && INTERACTIVE
520 call0 (Vblink_paren_function
);
526 /* module initialization */
530 Qkill_backward_chars
= intern ("kill-backward-chars");
531 staticpro (&Qkill_backward_chars
);
533 Qkill_forward_chars
= intern ("kill-forward-chars");
534 staticpro (&Qkill_forward_chars
);
536 Qoverwrite_mode_binary
= intern ("overwrite-mode-binary");
537 staticpro (&Qoverwrite_mode_binary
);
539 DEFVAR_LISP ("self-insert-face", &Vself_insert_face
,
540 "If non-nil, set the face of the next self-inserting character to this.\n\
541 See also `self-insert-face-command'.");
542 Vself_insert_face
= Qnil
;
544 DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command
,
545 "This is the command that set up `self-insert-face'.\n\
546 If `last-command' does not equal this value, we ignore `self-insert-face'.");
547 Vself_insert_face_command
= Qnil
;
549 DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function
,
550 "Function called, if non-nil, whenever a close parenthesis is inserted.\n\
551 More precisely, a char with closeparen syntax is self-inserted.");
552 Vblink_paren_function
= Qnil
;
554 DEFVAR_INT ("nonascii-insert-offset", &nonascii_insert_offset
,
555 "Offset to add to a non-ascii code 0200...0377 when inserting it.\n\
556 This applies only when multibyte characters are enabled, and it serves\n\
557 to convert a Latin-1 or similar 8-bit character code to the corresponding\n\
558 Emacs character code.");
559 nonascii_insert_offset
= 0;
561 defsubr (&Sforward_point
);
562 defsubr (&Sforward_char
);
563 defsubr (&Sbackward_char
);
564 defsubr (&Sforward_line
);
565 defsubr (&Sbeginning_of_line
);
566 defsubr (&Send_of_line
);
568 defsubr (&Sdelete_char
);
569 defsubr (&Sdelete_backward_char
);
571 defsubr (&Sself_insert_command
);
578 initial_define_key (global_map
, Ctl ('I'), "self-insert-command");
579 for (n
= 040; n
< 0177; n
++)
580 initial_define_key (global_map
, n
, "self-insert-command");
582 for (n
= 0200; n
< 0240; n
++)
583 initial_define_key (global_map
, n
, "self-insert-command");
585 for (n
= 0240; n
< 0400; n
++)
586 initial_define_key (global_map
, n
, "self-insert-command");
588 initial_define_key (global_map
, Ctl ('A'), "beginning-of-line");
589 initial_define_key (global_map
, Ctl ('B'), "backward-char");
590 initial_define_key (global_map
, Ctl ('D'), "delete-char");
591 initial_define_key (global_map
, Ctl ('E'), "end-of-line");
592 initial_define_key (global_map
, Ctl ('F'), "forward-char");
593 initial_define_key (global_map
, 0177, "delete-backward-char");