1 /* Simple built-in editing commands.
3 Copyright (C) 1985, 1993-1998, 2001-2015 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
25 #include "character.h"
31 #include "dispextern.h"
34 static int internal_self_insert (int, EMACS_INT
);
36 DEFUN ("forward-point", Fforward_point
, Sforward_point
, 1, 1, 0,
37 doc
: /* Return buffer position N characters after (before if N negative) point. */)
42 return make_number (PT
+ XINT (n
));
45 /* Add N to point; or subtract N if FORWARD is false. N defaults to 1.
46 Validate the new location. Return nil. */
48 move_point (Lisp_Object n
, bool forward
)
50 /* This used to just set point to point + XINT (n), and then check
51 to see if it was within boundaries. But now that SET_PT can
52 potentially do a lot of stuff (calling entering and exiting
53 hooks, etcetera), that's not a good approach. So we validate the
54 proposed position, then set point. */
63 new_point
= PT
+ (forward
? XINT (n
) : - XINT (n
));
68 xsignal0 (Qbeginning_of_buffer
);
73 xsignal0 (Qend_of_buffer
);
80 DEFUN ("forward-char", Fforward_char
, Sforward_char
, 0, 1, "^p",
81 doc
: /* Move point N characters forward (backward if N is negative).
82 On reaching end or beginning of buffer, stop and signal error.
83 Interactively, N is the numeric prefix argument.
84 If N is omitted or nil, move point 1 character forward.
86 Depending on the bidirectional context, the movement may be to the
87 right or to the left on the screen. This is in contrast with
88 \\[right-char], which see. */)
91 return move_point (n
, 1);
94 DEFUN ("backward-char", Fbackward_char
, Sbackward_char
, 0, 1, "^p",
95 doc
: /* Move point N characters backward (forward if N is negative).
96 On attempt to pass beginning or end of buffer, stop and signal error.
97 Interactively, N is the numeric prefix argument.
98 If N is omitted or nil, move point 1 character backward.
100 Depending on the bidirectional context, the movement may be to the
101 right or to the left on the screen. This is in contrast with
102 \\[left-char], which see. */)
105 return move_point (n
, 0);
108 DEFUN ("forward-line", Fforward_line
, Sforward_line
, 0, 1, "^p",
109 doc
: /* Move N lines forward (backward if N is negative).
110 Precisely, if point is on line I, move to the start of line I + N
111 \("start of line" in the logical order).
112 If there isn't room, go as far as possible (no error).
114 Returns the count of lines left to move. If moving forward,
115 that is N minus number of lines moved; if backward, N plus number
118 Exception: With positive N, a non-empty line at the end of the
119 buffer, or of its accessible portion, counts as one line
120 successfully moved (for the return value). This means that the
121 function will move point to the end of such a line and will count
122 it as a line moved across, even though there is no next line to
123 go to its beginning. */)
126 ptrdiff_t opoint
= PT
, pos
, pos_byte
, shortage
, count
;
136 shortage
= scan_newline_from_point (count
, &pos
, &pos_byte
);
138 SET_PT_BOTH (pos
, pos_byte
);
144 && (FETCH_BYTE (PT_BYTE
- 1) != '\n'))))
147 return make_number (count
<= 0 ? - shortage
: shortage
);
150 DEFUN ("beginning-of-line", Fbeginning_of_line
, Sbeginning_of_line
, 0, 1, "^p",
151 doc
: /* Move point to beginning of current line (in the logical order).
152 With argument N not nil or 1, move forward N - 1 lines first.
153 If point reaches the beginning or end of buffer, it stops there.
155 This function constrains point to the current field unless this moves
156 point to a different line than the original, unconstrained result.
157 If N is nil or 1, and a front-sticky field starts at point, the point
158 does not move. To ignore field boundaries bind
159 `inhibit-field-text-motion' to t, or use the `forward-line' function
160 instead. For instance, `(forward-line 0)' does the same thing as
161 `(beginning-of-line)', except that it ignores field boundaries. */)
169 SET_PT (XINT (Fline_beginning_position (n
)));
174 DEFUN ("end-of-line", Fend_of_line
, Send_of_line
, 0, 1, "^p",
175 doc
: /* Move point to end of current line (in the logical order).
176 With argument N not nil or 1, move forward N - 1 lines first.
177 If point reaches the beginning or end of buffer, it stops there.
178 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
180 This function constrains point to the current field unless this moves
181 point to a different line than the original, unconstrained result. If
182 N is nil or 1, and a rear-sticky field ends at point, the point does
183 not move. To ignore field boundaries bind `inhibit-field-text-motion'
196 newpos
= XINT (Fline_end_position (n
));
200 && FETCH_CHAR (PT
- 1) == '\n')
202 /* If we skipped over a newline that follows
203 an invisible intangible run,
204 move back to the last tangible position
210 else if (PT
> newpos
&& PT
< ZV
211 && FETCH_CHAR (PT
) != '\n')
212 /* If we skipped something intangible
213 and now we're not really at eol,
223 DEFUN ("delete-char", Fdelete_char
, Sdelete_char
, 1, 2, "p\nP",
224 doc
: /* Delete the following N characters (previous if N is negative).
225 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).
226 Interactively, N is the prefix arg, and KILLFLAG is set if
227 N was explicitly specified.
229 The command `delete-forward-char' is preferable for interactive use, e.g.
230 because it respects values of `delete-active-region' and `overwrite-mode'. */)
231 (Lisp_Object n
, Lisp_Object killflag
)
237 if (abs (XINT (n
)) < 2)
238 call0 (Qundo_auto__amalgamate
);
246 xsignal0 (Qbeginning_of_buffer
);
253 xsignal0 (Qend_of_buffer
);
260 call1 (Qkill_forward_chars
, n
);
265 /* Note that there's code in command_loop_1 which typically avoids
267 DEFUN ("self-insert-command", Fself_insert_command
, Sself_insert_command
, 1, 1, "p",
268 doc
: /* Insert the character you type.
269 Whichever character you type to run this command is inserted.
270 The numeric prefix argument N says how many times to repeat the insertion.
271 Before insertion, `expand-abbrev' is executed if the inserted character does
272 not have word syntax and the previous character in the buffer does.
273 After insertion, the value of `auto-fill-function' is called if the
274 `auto-fill-chars' table has a non-nil value for the inserted character.
275 At the end, it runs `post-self-insert-hook'. */)
280 if (XFASTINT (n
) < 0)
281 error ("Negative repetition argument %"pI
"d", XFASTINT (n
));
283 if (XFASTINT (n
) < 2)
284 call0 (Qundo_auto__amalgamate
);
286 /* Barf if the key that invoked this was not a character. */
287 if (!CHARACTERP (last_command_event
))
290 int character
= translate_char (Vtranslation_table_for_input
,
291 XINT (last_command_event
));
292 int val
= internal_self_insert (character
, XFASTINT (n
));
294 Fset (Qundo_auto__this_command_amalgamating
, Qnil
);
295 frame_make_pointer_invisible (SELECTED_FRAME ());
301 /* Insert N times character C
303 If this insertion is suitable for direct output (completely simple),
304 return 0. A value of 1 indicates this *might* not have been simple.
305 A value of 2 means this did things that call for an undo boundary. */
308 internal_self_insert (int c
, EMACS_INT n
)
312 register enum syntaxcode synt
;
313 Lisp_Object overwrite
;
314 /* Length of multi-byte form of C. */
316 /* Working buffer and pointer for multi-byte form of C. */
317 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
318 ptrdiff_t chars_to_delete
= 0;
319 ptrdiff_t spaces_to_insert
= 0;
321 overwrite
= BVAR (current_buffer
, overwrite_mode
);
322 if (!NILP (Vbefore_change_functions
) || !NILP (Vafter_change_functions
))
325 /* At first, get multi-byte form of C in STR. */
326 if (!NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
328 len
= CHAR_STRING (c
, str
);
330 /* If C has modifier bits, this makes C an appropriate
336 str
[0] = SINGLE_BYTE_CHAR_P (c
) ? c
: CHAR_TO_BYTE8 (c
);
339 if (!NILP (overwrite
)
342 /* In overwrite-mode, we substitute a character at point (C2,
343 hereafter) by C. For that, we delete C2 in advance. But,
344 just substituting C2 by C may move a remaining text in the
345 line to the right or to the left, which is not preferable.
346 So we insert more spaces or delete more characters in the
347 following cases: if C is narrower than C2, after deleting C2,
348 we fill columns with spaces, if C is wider than C2, we delete
349 C2 and several characters following C2. */
351 /* This is the character after point. */
352 int c2
= FETCH_CHAR (PT_BYTE
);
356 /* Overwriting in binary-mode always replaces C2 by C.
357 Overwriting in textual-mode doesn't always do that.
358 It inserts newlines in the usual way,
359 and inserts any character at end of line
360 or before a tab if it doesn't use the whole width of the tab. */
361 if (EQ (overwrite
, Qoverwrite_mode_binary
))
362 chars_to_delete
= min (n
, PTRDIFF_MAX
);
363 else if (c
!= '\n' && c2
!= '\n'
364 && (cwidth
= XFASTINT (Fchar_width (make_number (c
)))) != 0)
367 ptrdiff_t pos_byte
= PT_BYTE
;
368 ptrdiff_t curcol
= current_column ();
370 if (n
<= (min (MOST_POSITIVE_FIXNUM
, PTRDIFF_MAX
) - curcol
) / cwidth
)
372 /* Column the cursor should be placed at after this insertion.
373 The value should be calculated only when necessary. */
374 ptrdiff_t target_clm
= curcol
+ n
* cwidth
;
376 /* The actual cursor position after the trial of moving
377 to column TARGET_CLM. It is greater than TARGET_CLM
378 if the TARGET_CLM is middle of multi-column
379 character. In that case, the new point is set after
382 = XFASTINT (Fmove_to_column (make_number (target_clm
), Qnil
));
384 chars_to_delete
= PT
- pos
;
386 if (actual_clm
> target_clm
)
388 /* We will delete too many columns. Let's fill columns
389 by spaces so that the remaining text won't move. */
390 ptrdiff_t actual
= PT_BYTE
;
392 if (FETCH_CHAR (actual
) == '\t')
393 /* Rather than add spaces, let's just keep the tab. */
396 spaces_to_insert
= actual_clm
- target_clm
;
399 SET_PT_BOTH (pos
, pos_byte
);
407 if (!NILP (BVAR (current_buffer
, abbrev_mode
))
409 && NILP (BVAR (current_buffer
, read_only
))
411 && (SYNTAX (!NILP (BVAR (current_buffer
, enable_multibyte_characters
))
412 ? XFASTINT (Fprevious_char ())
413 : UNIBYTE_TO_CHAR (XFASTINT (Fprevious_char ())))
416 EMACS_INT modiff
= MODIFF
;
419 sym
= call0 (Qexpand_abbrev
);
421 /* If we expanded an abbrev which has a hook,
422 and the hook has a non-nil `no-self-insert' property,
423 return right away--don't really self-insert. */
424 if (SYMBOLP (sym
) && ! NILP (sym
)
425 && ! NILP (XSYMBOL (sym
)->function
)
426 && SYMBOLP (XSYMBOL (sym
)->function
))
429 prop
= Fget (XSYMBOL (sym
)->function
, intern ("no-self-insert"));
434 if (MODIFF
!= modiff
)
440 int mc
= ((NILP (BVAR (current_buffer
, enable_multibyte_characters
))
441 && SINGLE_BYTE_CHAR_P (c
))
442 ? UNIBYTE_TO_CHAR (c
) : c
);
443 Lisp_Object string
= Fmake_string (make_number (n
), make_number (mc
));
445 if (spaces_to_insert
)
447 tem
= Fmake_string (make_number (spaces_to_insert
),
449 string
= concat2 (string
, tem
);
452 replace_range (PT
, PT
+ chars_to_delete
, string
, 1, 1, 1);
453 Fforward_char (make_number (n
));
459 SAFE_NALLOCA (strn
, len
, n
);
460 for (p
= strn
; n
> 0; n
--, p
+= len
)
461 memcpy (p
, str
, len
);
462 insert_and_inherit (strn
, p
- strn
);
466 insert_and_inherit ((char *) str
, len
);
468 if ((CHAR_TABLE_P (Vauto_fill_chars
)
469 ? !NILP (CHAR_TABLE_REF (Vauto_fill_chars
, c
))
470 : (c
== ' ' || c
== '\n'))
471 && !NILP (BVAR (current_buffer
, auto_fill_function
)))
473 Lisp_Object auto_fill_result
;
476 /* After inserting a newline, move to previous line and fill
477 that. Must have the newline in place already so filling and
478 justification, if any, know where the end is going to be. */
479 SET_PT_BOTH (PT
- 1, PT_BYTE
- 1);
480 auto_fill_result
= call0 (BVAR (current_buffer
, auto_fill_function
));
481 /* Test PT < ZV in case the auto-fill-function is strange. */
482 if (c
== '\n' && PT
< ZV
)
483 SET_PT_BOTH (PT
+ 1, PT_BYTE
+ 1);
484 if (!NILP (auto_fill_result
))
488 /* Run hooks for electric keys. */
489 run_hook (Qpost_self_insert_hook
);
494 /* module initialization */
499 DEFSYM (Qundo_auto__amalgamate
, "undo-auto--amalgamate");
500 DEFSYM (Qundo_auto__this_command_amalgamating
,
501 "undo-auto--this-command-amalgamating");
503 DEFSYM (Qkill_forward_chars
, "kill-forward-chars");
505 /* A possible value for a buffer's overwrite-mode variable. */
506 DEFSYM (Qoverwrite_mode_binary
, "overwrite-mode-binary");
508 DEFSYM (Qexpand_abbrev
, "expand-abbrev");
509 DEFSYM (Qpost_self_insert_hook
, "post-self-insert-hook");
511 DEFVAR_LISP ("post-self-insert-hook", Vpost_self_insert_hook
,
512 doc
: /* Hook run at the end of `self-insert-command'.
513 This is run after inserting the character. */);
514 Vpost_self_insert_hook
= Qnil
;
516 defsubr (&Sforward_point
);
517 defsubr (&Sforward_char
);
518 defsubr (&Sbackward_char
);
519 defsubr (&Sforward_line
);
520 defsubr (&Sbeginning_of_line
);
521 defsubr (&Send_of_line
);
523 defsubr (&Sdelete_char
);
524 defsubr (&Sself_insert_command
);
532 initial_define_key (global_map
, Ctl ('I'), "self-insert-command");
533 for (n
= 040; n
< 0177; n
++)
534 initial_define_key (global_map
, n
, "self-insert-command");
536 for (n
= 0200; n
< 0240; n
++)
537 initial_define_key (global_map
, n
, "self-insert-command");
539 for (n
= 0240; n
< 0400; n
++)
540 initial_define_key (global_map
, n
, "self-insert-command");
542 initial_define_key (global_map
, Ctl ('A'), "beginning-of-line");
543 initial_define_key (global_map
, Ctl ('B'), "backward-char");
544 initial_define_key (global_map
, Ctl ('E'), "end-of-line");
545 initial_define_key (global_map
, Ctl ('F'), "forward-char");