XEmacs 21.2.32 "Kastor & Polydeukes".
[chise/xemacs-chise.git.1] / src / cmds.c
1 /* Simple built-in editing commands.
2    Copyright (C) 1985, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
3
4 This file is part of XEmacs.
5
6 XEmacs is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
9 later version.
10
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with XEmacs; 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.  */
20
21 /* Synched up with: Mule 2.0, FSF 19.30. */
22
23 #include <config.h>
24 #include "lisp.h"
25 #include "commands.h"
26 #include "buffer.h"
27 #include "syntax.h"
28 #include "insdel.h"
29
30 Lisp_Object Qkill_forward_chars;
31 Lisp_Object Qself_insert_command;
32 Lisp_Object Qno_self_insert;
33
34 Lisp_Object Vblink_paren_function;
35
36 /* A possible value for a buffer's overwrite-mode variable.  */
37 Lisp_Object Qoverwrite_mode_binary;
38
39 /* Non-nil means put this face on the next self-inserting character.  */
40 Lisp_Object Vself_insert_face;
41
42 /* This is the command that set up Vself_insert_face.  */
43 Lisp_Object Vself_insert_face_command;
44
45 /* A char-table for characters which may invoke auto-filling.  */
46 Lisp_Object Vauto_fill_chars;
47 \f
48 DEFUN ("forward-char", Fforward_char, 0, 2, "_p", /*
49 Move point right N characters (left if N negative).
50 On attempt to pass end of buffer, stop and signal `end-of-buffer'.
51 On attempt to pass beginning of buffer, stop and signal `beginning-of-buffer'.
52 On reaching end of buffer, stop and signal error.
53 */
54        (n, buffer))
55 {
56   struct buffer *buf = decode_buffer (buffer, 1);
57   EMACS_INT count;
58
59   if (NILP (n))
60     count = 1;
61   else
62     {
63       CHECK_INT (n);
64       count = XINT (n);
65     }
66
67   /* This used to just set point to point + XINT (n), and then check
68      to see if it was within boundaries.  But now that SET_PT can
69      potentially do a lot of stuff (calling entering and exiting
70      hooks, etcetera), that's not a good approach.  So we validate the
71      proposed position, then set point.  */
72   {
73     Bufpos new_point = BUF_PT (buf) + count;
74
75     if (new_point < BUF_BEGV (buf))
76       {
77         BUF_SET_PT (buf, BUF_BEGV (buf));
78         Fsignal (Qbeginning_of_buffer, Qnil);
79         return Qnil;
80       }
81     if (new_point > BUF_ZV (buf))
82       {
83         BUF_SET_PT (buf, BUF_ZV (buf));
84         Fsignal (Qend_of_buffer, Qnil);
85         return Qnil;
86       }
87
88     BUF_SET_PT (buf, new_point);
89   }
90
91   return Qnil;
92 }
93
94 DEFUN ("backward-char", Fbackward_char, 0, 2, "_p", /*
95 Move point left N characters (right if N negative).
96 On attempt to pass end of buffer, stop and signal `end-of-buffer'.
97 On attempt to pass beginning of buffer, stop and signal `beginning-of-buffer'.
98 */
99        (n, buffer))
100 {
101   if (NILP (n))
102     n = make_int (-1);
103   else
104     {
105       CHECK_INT (n);
106       XSETINT (n, - XINT (n));
107     }
108   return Fforward_char (n, buffer);
109 }
110
111 DEFUN ("forward-line", Fforward_line, 0, 2, "_p", /*
112 Move N lines forward (backward if N is negative).
113 Precisely, if point is on line I, move to the start of line I + N.
114 If there isn't room, go as far as possible (no error).
115 Returns the count of lines left to move.  If moving forward,
116 that is N - number of lines moved; if backward, N + number moved.
117 With positive N, a non-empty line at the end counts as one line
118   successfully moved (for the return value).
119 If BUFFER is nil, the current buffer is assumed.
120 */
121        (n, buffer))
122 {
123   struct buffer *buf = decode_buffer (buffer, 1);
124   Bufpos pos2 = BUF_PT (buf);
125   Bufpos pos;
126   EMACS_INT count, shortage, negp;
127
128   if (NILP (n))
129     count = 1;
130   else
131     {
132       CHECK_INT (n);
133       count = XINT (n);
134     }
135
136   negp = count <= 0;
137   pos = scan_buffer (buf, '\n', pos2, 0, count - negp, &shortage, 1);
138   if (shortage > 0
139       && (negp
140           || (BUF_ZV (buf) > BUF_BEGV (buf)
141               && pos != pos2
142               && BUF_FETCH_CHAR (buf, pos - 1) != '\n')))
143     shortage--;
144   BUF_SET_PT (buf, pos);
145   return make_int (negp ? - shortage : shortage);
146 }
147
148 DEFUN ("point-at-bol", Fpoint_at_bol, 0, 2, 0, /*
149 Return the character position of the first character on the current line.
150 With argument N not nil or 1, move forward N - 1 lines first.
151 If scan reaches end of buffer, return that position.
152 This function does not move point.
153 */
154        (n, buffer))
155 {
156   struct buffer *b = decode_buffer (buffer, 1);
157   REGISTER int orig, end;
158
159   XSETBUFFER (buffer, b);
160   if (NILP (n))
161     n = make_int (0);
162   else
163     {
164       CHECK_INT (n);
165       n = make_int (XINT (n) - 1);
166     }
167
168   orig = BUF_PT (b);
169   Fforward_line (n, buffer);
170   end = BUF_PT (b);
171   BUF_SET_PT (b, orig);
172
173   return make_int (end);
174 }
175
176 DEFUN ("beginning-of-line", Fbeginning_of_line, 0, 2, "_p", /*
177 Move point to beginning of current line.
178 With argument N not nil or 1, move forward N - 1 lines first.
179 If scan reaches end of buffer, stop there without error.
180 If BUFFER is nil, the current buffer is assumed.
181 */
182        (n, buffer))
183 {
184   struct buffer *b = decode_buffer (buffer, 1);
185
186   BUF_SET_PT (b, XINT (Fpoint_at_bol (n, buffer)));
187   return Qnil;
188 }
189
190 DEFUN ("point-at-eol", Fpoint_at_eol, 0, 2, 0, /*
191 Return the character position of the last character on the current line.
192 With argument N not nil or 1, move forward N - 1 lines first.
193 If scan reaches end of buffer, return that position.
194 This function does not move point.
195 */
196        (n, buffer))
197 {
198   struct buffer *buf = decode_buffer (buffer, 1);
199   int count;
200
201   if (NILP (n))
202     count = 1;
203   else
204     {
205       CHECK_INT (n);
206       count = XINT (n);
207     }
208
209   return make_int (find_before_next_newline (buf, BUF_PT (buf), 0,
210                                              count - (count <= 0)));
211 }
212
213 DEFUN ("end-of-line", Fend_of_line, 0, 2, "_p", /*
214 Move point to end of current line.
215 With argument N not nil or 1, move forward N - 1 lines first.
216 If scan reaches end of buffer, stop there without error.
217 If BUFFER is nil, the current buffer is assumed.
218 */
219        (n, buffer))
220 {
221   struct buffer *b = decode_buffer (buffer, 1);
222
223   BUF_SET_PT (b, XINT (Fpoint_at_eol (n, buffer)));
224   return Qnil;
225 }
226
227 DEFUN ("delete-char", Fdelete_char, 1, 2, "*p\nP", /*
228 Delete the following N characters (previous, with negative N).
229 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).
230 Interactively, N is the prefix arg, and KILLFLAG is set if
231 N was explicitly specified.
232 */
233        (n, killflag))
234 {
235   /* This function can GC */
236   Bufpos pos;
237   struct buffer *buf = current_buffer;
238   int count;
239
240   CHECK_INT (n);
241   count = XINT (n);
242
243   pos = BUF_PT (buf) + count;
244   if (NILP (killflag))
245     {
246       if (count < 0)
247         {
248           if (pos < BUF_BEGV (buf))
249             signal_error (Qbeginning_of_buffer, Qnil);
250           else
251             buffer_delete_range (buf, pos, BUF_PT (buf), 0);
252         }
253       else
254         {
255           if (pos > BUF_ZV (buf))
256             signal_error (Qend_of_buffer, Qnil);
257           else
258             buffer_delete_range (buf, BUF_PT (buf), pos, 0);
259         }
260     }
261   else
262     {
263       call1 (Qkill_forward_chars, n);
264     }
265   return Qnil;
266 }
267
268 DEFUN ("delete-backward-char", Fdelete_backward_char, 1, 2, "*p\nP", /*
269 Delete the previous N characters (following, with negative N).
270 Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).
271 Interactively, N is the prefix arg, and KILLFLAG is set if
272 N was explicitly specified.
273 */
274        (n, killflag))
275 {
276   /* This function can GC */
277   CHECK_INT (n);
278   return Fdelete_char (make_int (- XINT (n)), killflag);
279 }
280
281 static void internal_self_insert (Emchar ch, int noautofill);
282
283 DEFUN ("self-insert-command", Fself_insert_command, 1, 1, "*p", /*
284 Insert the character you type.
285 Whichever character you type to run this command is inserted.
286 */
287        (n))
288 {
289   /* This function can GC */
290   Emchar ch;
291   Lisp_Object c;
292   int count;
293
294   CHECK_NATNUM (n);
295   count = XINT (n);
296
297   if (CHAR_OR_CHAR_INTP (Vlast_command_char))
298     c = Vlast_command_char;
299   else
300     c = Fevent_to_character (Vlast_command_event, Qnil, Qnil, Qt);
301
302   if (NILP (c))
303     signal_simple_error ("Last typed character has no ASCII equivalent",
304                          Fcopy_event (Vlast_command_event, Qnil));
305
306   CHECK_CHAR_COERCE_INT (c);
307
308   ch = XCHAR (c);
309
310   while (count--)
311     internal_self_insert (ch, (count != 0));
312
313   return Qnil;
314 }
315
316 /* Insert character C1.  If NOAUTOFILL is nonzero, don't do autofill
317    even if it is enabled.
318
319    FSF:
320
321    If this insertion is suitable for direct output (completely simple),
322    return 0.  A value of 1 indicates this *might* not have been simple.
323    A value of 2 means this did things that call for an undo boundary.  */
324
325 static void
326 internal_self_insert (Emchar c1, int noautofill)
327 {
328   /* This function can GC */
329   /* int hairy = 0; -- unused */
330   REGISTER enum syntaxcode synt;
331   REGISTER Emchar c2;
332   Lisp_Object overwrite;
333   Lisp_Char_Table *syntax_table;
334   struct buffer *buf = current_buffer;
335   int tab_width;
336
337   overwrite = buf->overwrite_mode;
338   syntax_table = XCHAR_TABLE (buf->mirror_syntax_table);
339
340 #if 0
341   /* No, this is very bad, it makes undo *always* undo a character at a time
342      instead of grouping consecutive self-inserts together.  Nasty nasty.
343    */
344   if (!NILP (Vbefore_change_functions) || !NILP (Vafter_change_functions)
345       || !NILP (Vbefore_change_function) || !NILP (Vafter_change_function))
346     hairy = 1;
347 #endif
348
349   if (!NILP (overwrite)
350       && BUF_PT (buf) < BUF_ZV (buf)
351       && (EQ (overwrite, Qoverwrite_mode_binary)
352           || (c1 != '\n' && BUF_FETCH_CHAR (buf, BUF_PT (buf)) != '\n'))
353       && (EQ (overwrite, Qoverwrite_mode_binary)
354           || BUF_FETCH_CHAR (buf, BUF_PT (buf)) != '\t'
355           || ((tab_width = XINT (buf->tab_width), tab_width <= 0)
356           || tab_width > 20
357           || !((current_column (buf) + 1) % tab_width))))
358     {
359       buffer_delete_range (buf, BUF_PT (buf), BUF_PT (buf) + 1, 0);
360       /* hairy = 2; */
361     }
362
363   if (!NILP (buf->abbrev_mode)
364       && !WORD_SYNTAX_P (syntax_table, c1)
365       && NILP (buf->read_only)
366       && BUF_PT (buf) > BUF_BEGV (buf))
367     {
368       c2 = BUF_FETCH_CHAR (buf, BUF_PT (buf) - 1);
369
370       if (WORD_SYNTAX_P (syntax_table, c2))
371         {
372 #if 1
373           Fexpand_abbrev ();
374 #else  /* FSFmacs */
375           Lisp_Object sym = Fexpand_abbrev ();
376
377           /* I think this is too bogus to add.  The function should
378              have a way of examining the character to be inserted, so
379              it can decide whether to insert it or not.  We should
380              design it better than that.  */
381
382           /* Here FSFmacs remembers MODIFF, compares it after
383              Fexpand_abbrev() finishes, and updates HAIRY.  */
384
385           /* NOTE: we cannot simply check for Vlast_abbrev, because
386              Fexpand_abbrev() can bail out before setting it to
387              anything meaningful, leaving us stuck with an old value.
388              Thus Fexpand_abbrev() was extended to return the actual
389              abbrev symbol.  */
390           if (!NILP (sym)
391               && !NILP (symbol_function (XSYMBOL (sym)))
392               && SYMBOLP (symbol_function (XSYMBOL (sym))))
393             {
394               Lisp_Object prop = Fget (symbol_function (XSYMBOL (sym)),
395                                        Qno_self_insert, Qnil);
396               if (!NILP (prop))
397                 return;
398             }
399 #endif /* FSFmacs */
400         }
401     }
402   if ((CHAR_TABLEP (Vauto_fill_chars)
403        ? !NILP (XCHAR_TABLE_VALUE_UNSAFE (Vauto_fill_chars, c1))
404        : (c1 == ' ' || c1 == '\n'))
405       && !noautofill
406       && !NILP (buf->auto_fill_function))
407     {
408       buffer_insert_emacs_char (buf, c1);
409       if (c1 == '\n')
410         /* After inserting a newline, move to previous line and fill */
411         /* that.  Must have the newline in place already so filling and */
412         /* justification, if any, know where the end is going to be. */
413         BUF_SET_PT (buf, BUF_PT (buf) - 1);
414       call0 (buf->auto_fill_function);
415       if (c1 == '\n')
416         BUF_SET_PT (buf, BUF_PT (buf) + 1);
417       /* hairy = 2; */
418     }
419   else
420     buffer_insert_emacs_char (buf, c1);
421
422   /* If previous command specified a face to use, use it.  */
423   if (!NILP (Vself_insert_face)
424       && EQ (Vlast_command, Vself_insert_face_command))
425     {
426       Lisp_Object before = make_int (BUF_PT (buf) - 1);
427       Lisp_Object after  = make_int (BUF_PT (buf));
428       Fput_text_property (before, after, Qface, Vself_insert_face, Qnil);
429       Fput_text_property (before, after, Qstart_open, Qt, Qnil);
430       Fput_text_property (before, after, Qend_open, Qnil, Qnil);
431       /* #### FSFmacs properties are normally closed ("sticky") on the
432          end but not the beginning.  It's the opposite for us. */
433       Vself_insert_face = Qnil;
434     }
435   synt = SYNTAX (syntax_table, c1);
436   if ((synt == Sclose || synt == Smath)
437       && !NILP (Vblink_paren_function) && INTERACTIVE
438       && !noautofill)
439     {
440       call0 (Vblink_paren_function);
441       /* hairy = 2; */
442     }
443
444   /* return hairy; */
445 }
446
447 /* (this comes from Mule but is a generally good idea) */
448
449 DEFUN ("self-insert-internal", Fself_insert_internal, 1, 1, 0, /*
450 Invoke `self-insert-command' as if CH is entered from keyboard.
451 */
452        (ch))
453 {
454   /* This function can GC */
455   CHECK_CHAR_COERCE_INT (ch);
456   internal_self_insert (XCHAR (ch), 0);
457   return Qnil;
458 }
459 \f
460 /* module initialization */
461
462 void
463 syms_of_cmds (void)
464 {
465   defsymbol (&Qkill_forward_chars, "kill-forward-chars");
466   defsymbol (&Qself_insert_command, "self-insert-command");
467   defsymbol (&Qoverwrite_mode_binary, "overwrite-mode-binary");
468   defsymbol (&Qno_self_insert, "no-self-insert");
469
470   DEFSUBR (Fforward_char);
471   DEFSUBR (Fbackward_char);
472   DEFSUBR (Fforward_line);
473   DEFSUBR (Fbeginning_of_line);
474   DEFSUBR (Fend_of_line);
475
476   DEFSUBR (Fpoint_at_bol);
477   DEFSUBR (Fpoint_at_eol);
478
479   DEFSUBR (Fdelete_char);
480   DEFSUBR (Fdelete_backward_char);
481
482   DEFSUBR (Fself_insert_command);
483   DEFSUBR (Fself_insert_internal);
484 }
485
486 void
487 vars_of_cmds (void)
488 {
489   DEFVAR_LISP ("self-insert-face", &Vself_insert_face /*
490 If non-nil, set the face of the next self-inserting character to this.
491 See also `self-insert-face-command'.
492 */ );
493   Vself_insert_face = Qnil;
494
495   DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command /*
496 This is the command that set up `self-insert-face'.
497 If `last-command' does not equal this value, we ignore `self-insert-face'.
498 */ );
499   Vself_insert_face_command = Qnil;
500
501   DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function /*
502 Function called, if non-nil, whenever a close parenthesis is inserted.
503 More precisely, a char with closeparen syntax is self-inserted.
504 */ );
505   Vblink_paren_function = Qnil;
506
507   DEFVAR_LISP ("auto-fill-chars", &Vauto_fill_chars /*
508 A char-table for characters which invoke auto-filling.
509 Such characters has value t in this table.
510 */);
511   Vauto_fill_chars = Fmake_char_table (Qgeneric);
512   XCHAR_TABLE (Vauto_fill_chars)->ascii[' '] = Qt;
513   XCHAR_TABLE (Vauto_fill_chars)->ascii['\n'] = Qt;
514 }