XEmacs 21.2.38 (Peisino)
[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 COUNT characters (left if COUNT is 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        (count, buffer))
55 {
56   struct buffer *buf = decode_buffer (buffer, 1);
57   EMACS_INT n;
58
59   if (NILP (count))
60     n = 1;
61   else
62     {
63       CHECK_INT (count);
64       n = XINT (count);
65     }
66
67   /* This used to just set point to point + XINT (count), 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) + n;
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 COUNT characters (right if COUNT is 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        (count, buffer))
100 {
101   if (NILP (count))
102     count = make_int (-1);
103   else
104     {
105       CHECK_INT (count);
106       count = make_int (- XINT (count));
107     }
108   return Fforward_char (count, buffer);
109 }
110
111 DEFUN ("forward-line", Fforward_line, 0, 2, "_p", /*
112 Move COUNT lines forward (backward if COUNT is negative).
113 Precisely, if point is on line I, move to the start of line I + COUNT.
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 COUNT - number of lines moved; if backward, COUNT + number moved.
117 With positive COUNT, 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        (count, buffer))
122 {
123   struct buffer *buf = decode_buffer (buffer, 1);
124   Bufpos pos2 = BUF_PT (buf);
125   Bufpos pos;
126   EMACS_INT n, shortage, negp;
127
128   if (NILP (count))
129     n = 1;
130   else
131     {
132       CHECK_INT (count);
133       n = XINT (count);
134     }
135
136   negp = n <= 0;
137   pos = scan_buffer (buf, '\n', pos2, 0, n - 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 COUNT not nil or 1, move forward COUNT - 1 lines first.
151 If scan reaches end of buffer, return that position.
152 This function does not move point.
153 */
154        (count, buffer))
155 {
156   struct buffer *b = decode_buffer (buffer, 1);
157   REGISTER int orig, end;
158
159   XSETBUFFER (buffer, b);
160   if (NILP (count))
161     count = make_int (0);
162   else
163     {
164       CHECK_INT (count);
165       count = make_int (XINT (count) - 1);
166     }
167
168   orig = BUF_PT (b);
169   Fforward_line (count, 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 COUNT not nil or 1, move forward COUNT - 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        (count, buffer))
183 {
184   struct buffer *b = decode_buffer (buffer, 1);
185
186   BUF_SET_PT (b, XINT (Fpoint_at_bol (count, 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 COUNT not nil or 1, move forward COUNT - 1 lines first.
193 If scan reaches end of buffer, return that position.
194 This function does not move point.
195 */
196        (count, buffer))
197 {
198   struct buffer *buf = decode_buffer (buffer, 1);
199   EMACS_INT n;
200
201   if (NILP (count))
202     n = 1;
203   else
204     {
205       CHECK_INT (count);
206       n = XINT (count);
207     }
208
209   return make_int (find_before_next_newline (buf, BUF_PT (buf), 0,
210                                              n - (n <= 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 COUNT not nil or 1, move forward COUNT - 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        (count, buffer))
220 {
221   struct buffer *b = decode_buffer (buffer, 1);
222
223   BUF_SET_PT (b, XINT (Fpoint_at_eol (count, buffer)));
224   return Qnil;
225 }
226
227 DEFUN ("delete-char", Fdelete_char, 0, 2, "*p\nP", /*
228 Delete the following COUNT characters (previous, with negative COUNT).
229 Optional second arg KILLP non-nil means kill instead (save in kill ring).
230 Interactively, COUNT is the prefix arg, and KILLP is set if
231 COUNT was explicitly specified.
232 */
233        (count, killp))
234 {
235   /* This function can GC */
236   Bufpos pos;
237   struct buffer *buf = current_buffer;
238   EMACS_INT n;
239
240   if (NILP (count))
241     n = 1;
242   else
243     {
244       CHECK_INT (count);
245       n = XINT (count);
246     }
247
248   pos = BUF_PT (buf) + n;
249   if (NILP (killp))
250     {
251       if (n < 0)
252         {
253           if (pos < BUF_BEGV (buf))
254             signal_error (Qbeginning_of_buffer, Qnil);
255           else
256             buffer_delete_range (buf, pos, BUF_PT (buf), 0);
257         }
258       else
259         {
260           if (pos > BUF_ZV (buf))
261             signal_error (Qend_of_buffer, Qnil);
262           else
263             buffer_delete_range (buf, BUF_PT (buf), pos, 0);
264         }
265     }
266   else
267     {
268       call1 (Qkill_forward_chars, count);
269     }
270   return Qnil;
271 }
272
273 DEFUN ("delete-backward-char", Fdelete_backward_char, 0, 2, "*p\nP", /*
274 Delete the previous COUNT characters (following, with negative COUNT).
275 Optional second arg KILLP non-nil means kill instead (save in kill ring).
276 Interactively, COUNT is the prefix arg, and KILLP is set if
277 COUNT was explicitly specified.
278 */
279        (count, killp))
280 {
281   /* This function can GC */
282   EMACS_INT n;
283
284   if (NILP (count))
285     n = 1;
286   else
287     {
288       CHECK_INT (count);
289       n = XINT (count);
290     }
291
292   return Fdelete_char (make_int (- n), killp);
293 }
294
295 static void internal_self_insert (Emchar ch, int noautofill);
296
297 DEFUN ("self-insert-command", Fself_insert_command, 1, 1, "*p", /*
298 Insert the character you type.
299 Whichever character you type to run this command is inserted.
300 If a prefix arg COUNT is specified, the character is inserted COUNT times.
301 */
302        (count))
303 {
304   /* This function can GC */
305   Emchar ch;
306   Lisp_Object c;
307   EMACS_INT n;
308
309   CHECK_NATNUM (count);
310   n = XINT (count);
311
312   if (CHAR_OR_CHAR_INTP (Vlast_command_char))
313     c = Vlast_command_char;
314   else
315     c = Fevent_to_character (Vlast_command_event, Qnil, Qnil, Qt);
316
317   if (NILP (c))
318     signal_simple_error ("Last typed character has no ASCII equivalent",
319                          Fcopy_event (Vlast_command_event, Qnil));
320
321   CHECK_CHAR_COERCE_INT (c);
322
323   ch = XCHAR (c);
324
325   while (n--)
326     internal_self_insert (ch, (n != 0));
327
328   return Qnil;
329 }
330
331 /* Insert character C1.  If NOAUTOFILL is nonzero, don't do autofill
332    even if it is enabled.
333
334    FSF:
335
336    If this insertion is suitable for direct output (completely simple),
337    return 0.  A value of 1 indicates this *might* not have been simple.
338    A value of 2 means this did things that call for an undo boundary.  */
339
340 static void
341 internal_self_insert (Emchar c1, int noautofill)
342 {
343   /* This function can GC */
344   /* int hairy = 0; -- unused */
345   REGISTER enum syntaxcode synt;
346   REGISTER Emchar c2;
347   Lisp_Object overwrite;
348   Lisp_Char_Table *syntax_table;
349   struct buffer *buf = current_buffer;
350   int tab_width;
351
352   overwrite = buf->overwrite_mode;
353   syntax_table = XCHAR_TABLE (buf->mirror_syntax_table);
354
355 #if 0
356   /* No, this is very bad, it makes undo *always* undo a character at a time
357      instead of grouping consecutive self-inserts together.  Nasty nasty.
358    */
359   if (!NILP (Vbefore_change_functions) || !NILP (Vafter_change_functions)
360       || !NILP (Vbefore_change_function) || !NILP (Vafter_change_function))
361     hairy = 1;
362 #endif
363
364   if (!NILP (overwrite)
365       && BUF_PT (buf) < BUF_ZV (buf)
366       && (EQ (overwrite, Qoverwrite_mode_binary)
367           || (c1 != '\n' && BUF_FETCH_CHAR (buf, BUF_PT (buf)) != '\n'))
368       && (EQ (overwrite, Qoverwrite_mode_binary)
369           || BUF_FETCH_CHAR (buf, BUF_PT (buf)) != '\t'
370           || ((tab_width = XINT (buf->tab_width), tab_width <= 0)
371           || tab_width > 20
372           || !((current_column (buf) + 1) % tab_width))))
373     {
374       buffer_delete_range (buf, BUF_PT (buf), BUF_PT (buf) + 1, 0);
375       /* hairy = 2; */
376     }
377
378   if (!NILP (buf->abbrev_mode)
379       && !WORD_SYNTAX_P (syntax_table, c1)
380       && NILP (buf->read_only)
381       && BUF_PT (buf) > BUF_BEGV (buf))
382     {
383       c2 = BUF_FETCH_CHAR (buf, BUF_PT (buf) - 1);
384
385       if (WORD_SYNTAX_P (syntax_table, c2))
386         {
387 #if 1
388           Fexpand_abbrev ();
389 #else  /* FSFmacs */
390           Lisp_Object sym = Fexpand_abbrev ();
391
392           /* I think this is too bogus to add.  The function should
393              have a way of examining the character to be inserted, so
394              it can decide whether to insert it or not.  We should
395              design it better than that.  */
396
397           /* Here FSFmacs remembers MODIFF, compares it after
398              Fexpand_abbrev() finishes, and updates HAIRY.  */
399
400           /* NOTE: we cannot simply check for Vlast_abbrev, because
401              Fexpand_abbrev() can bail out before setting it to
402              anything meaningful, leaving us stuck with an old value.
403              Thus Fexpand_abbrev() was extended to return the actual
404              abbrev symbol.  */
405           if (!NILP (sym)
406               && !NILP (symbol_function (XSYMBOL (sym)))
407               && SYMBOLP (symbol_function (XSYMBOL (sym))))
408             {
409               Lisp_Object prop = Fget (symbol_function (XSYMBOL (sym)),
410                                        Qno_self_insert, Qnil);
411               if (!NILP (prop))
412                 return;
413             }
414 #endif /* FSFmacs */
415         }
416     }
417   if ((CHAR_TABLEP (Vauto_fill_chars)
418        ? !NILP (XCHAR_TABLE_VALUE_UNSAFE (Vauto_fill_chars, c1))
419        : (c1 == ' ' || c1 == '\n'))
420       && !noautofill
421       && !NILP (buf->auto_fill_function))
422     {
423       buffer_insert_emacs_char (buf, c1);
424       if (c1 == '\n')
425         /* After inserting a newline, move to previous line and fill */
426         /* that.  Must have the newline in place already so filling and */
427         /* justification, if any, know where the end is going to be. */
428         BUF_SET_PT (buf, BUF_PT (buf) - 1);
429       call0 (buf->auto_fill_function);
430       if (c1 == '\n')
431         BUF_SET_PT (buf, BUF_PT (buf) + 1);
432       /* hairy = 2; */
433     }
434   else
435     buffer_insert_emacs_char (buf, c1);
436
437   /* If previous command specified a face to use, use it.  */
438   if (!NILP (Vself_insert_face)
439       && EQ (Vlast_command, Vself_insert_face_command))
440     {
441       Lisp_Object before = make_int (BUF_PT (buf) - 1);
442       Lisp_Object after  = make_int (BUF_PT (buf));
443       Fput_text_property (before, after, Qface, Vself_insert_face, Qnil);
444       Fput_text_property (before, after, Qstart_open, Qt, Qnil);
445       Fput_text_property (before, after, Qend_open, Qnil, Qnil);
446       /* #### FSFmacs properties are normally closed ("sticky") on the
447          end but not the beginning.  It's the opposite for us. */
448       Vself_insert_face = Qnil;
449     }
450   synt = SYNTAX (syntax_table, c1);
451   if ((synt == Sclose || synt == Smath)
452       && !NILP (Vblink_paren_function) && INTERACTIVE
453       && !noautofill)
454     {
455       call0 (Vblink_paren_function);
456       /* hairy = 2; */
457     }
458
459   /* return hairy; */
460 }
461
462 /* (this comes from Mule but is a generally good idea) */
463
464 DEFUN ("self-insert-internal", Fself_insert_internal, 1, 1, 0, /*
465 Invoke `self-insert-command' as if CHARACTER is entered from keyboard.
466 */
467        (character))
468 {
469   /* This function can GC */
470   CHECK_CHAR_COERCE_INT (character);
471   internal_self_insert (XCHAR (character), 0);
472   return Qnil;
473 }
474 \f
475 /* module initialization */
476
477 void
478 syms_of_cmds (void)
479 {
480   defsymbol (&Qkill_forward_chars, "kill-forward-chars");
481   defsymbol (&Qself_insert_command, "self-insert-command");
482   defsymbol (&Qoverwrite_mode_binary, "overwrite-mode-binary");
483   defsymbol (&Qno_self_insert, "no-self-insert");
484
485   DEFSUBR (Fforward_char);
486   DEFSUBR (Fbackward_char);
487   DEFSUBR (Fforward_line);
488   DEFSUBR (Fbeginning_of_line);
489   DEFSUBR (Fend_of_line);
490
491   DEFSUBR (Fpoint_at_bol);
492   DEFSUBR (Fpoint_at_eol);
493
494   DEFSUBR (Fdelete_char);
495   DEFSUBR (Fdelete_backward_char);
496
497   DEFSUBR (Fself_insert_command);
498   DEFSUBR (Fself_insert_internal);
499 }
500
501 void
502 vars_of_cmds (void)
503 {
504   DEFVAR_LISP ("self-insert-face", &Vself_insert_face /*
505 If non-nil, set the face of the next self-inserting character to this.
506 See also `self-insert-face-command'.
507 */ );
508   Vself_insert_face = Qnil;
509
510   DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command /*
511 This is the command that set up `self-insert-face'.
512 If `last-command' does not equal this value, we ignore `self-insert-face'.
513 */ );
514   Vself_insert_face_command = Qnil;
515
516   DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function /*
517 Function called, if non-nil, whenever a close parenthesis is inserted.
518 More precisely, a char with closeparen syntax is self-inserted.
519 */ );
520   Vblink_paren_function = Qnil;
521
522   DEFVAR_LISP ("auto-fill-chars", &Vauto_fill_chars /*
523 A char-table for characters which invoke auto-filling.
524 Such characters have value t in this table.
525 */);
526   Vauto_fill_chars = Fmake_char_table (Qgeneric);
527   XCHAR_TABLE (Vauto_fill_chars)->ascii[' '] = Qt;
528   XCHAR_TABLE (Vauto_fill_chars)->ascii['\n'] = Qt;
529 }