cmds.c 13.5 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Simple built-in editing commands.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17 18 19 20
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


21
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
22 23 24 25
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
#include "syntax.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
26
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
27 28

Lisp_Object Qkill_forward_chars, Qkill_backward_chars, Vblink_paren_function;
29
Lisp_Object Vuse_hard_newlines;
Jim Blandy's avatar
Jim Blandy committed
30

31 32 33
/* A possible value for a buffer's overwrite-mode variable.  */
Lisp_Object Qoverwrite_mode_binary;

34 35 36 37 38 39
/* Non-nil means put this face on the next self-inserting character.  */
Lisp_Object Vself_insert_face;

/* This is the command that set up Vself_insert_face.  */
Lisp_Object Vself_insert_face_command;

40 41 42 43
#ifdef USE_TEXT_PROPERTIES 
Lisp_Object Qhard;
#endif

44
extern Lisp_Object Qface;
Jim Blandy's avatar
Jim Blandy committed
45 46 47 48 49 50 51

DEFUN ("forward-char", Fforward_char, Sforward_char, 0, 1, "p",
  "Move point right ARG characters (left if ARG negative).\n\
On reaching end of buffer, stop and signal error.")
  (n)
     Lisp_Object n;
{
Jim Blandy's avatar
Jim Blandy committed
52
  if (NILP (n))
53
    XSETFASTINT (n, 1);
Jim Blandy's avatar
Jim Blandy committed
54 55 56
  else
    CHECK_NUMBER (n, 0);

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
  /* This used to just set point to point + XINT (n), and then check
     to see if it was within boundaries.  But now that SET_PT can
     potentially do a lot of stuff (calling entering and exiting
     hooks, etcetera), that's not a good approach.  So we validate the
     proposed position, then set point.  */
  {
    int new_point = point + XINT (n);

    if (new_point < BEGV)
      {
	SET_PT (BEGV);
	Fsignal (Qbeginning_of_buffer, Qnil);
      }
    if (new_point > ZV)
      {
	SET_PT (ZV);
	Fsignal (Qend_of_buffer, Qnil);
      }

    SET_PT (new_point);
  }

Jim Blandy's avatar
Jim Blandy committed
79 80 81 82 83 84 85 86 87
  return Qnil;
}

DEFUN ("backward-char", Fbackward_char, Sbackward_char, 0, 1, "p",
  "Move point left ARG characters (right if ARG negative).\n\
On attempt to pass beginning or end of buffer, stop and signal error.")
  (n)
     Lisp_Object n;
{
Jim Blandy's avatar
Jim Blandy committed
88
  if (NILP (n))
89
    XSETFASTINT (n, 1);
Jim Blandy's avatar
Jim Blandy committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
  else
    CHECK_NUMBER (n, 0);

  XSETINT (n, - XINT (n));
  return Fforward_char (n);
}

DEFUN ("forward-line", Fforward_line, Sforward_line, 0, 1, "p",
  "Move ARG lines forward (backward if ARG is negative).\n\
Precisely, if point is on line I, move to the start of line I + ARG.\n\
If there isn't room, go as far as possible (no error).\n\
Returns the count of lines left to move.  If moving forward,\n\
that is ARG - number of lines moved; if backward, ARG + number moved.\n\
With positive ARG, a non-empty line at the end counts as one line\n\
  successfully moved (for the return value).")
  (n)
     Lisp_Object n;
{
  int pos2 = point;
  int pos;
  int count, shortage, negp;

Jim Blandy's avatar
Jim Blandy committed
112
  if (NILP (n))
Jim Blandy's avatar
Jim Blandy committed
113 114 115 116 117 118 119 120
    count = 1;
  else
    {
      CHECK_NUMBER (n, 0);
      count = XINT (n);
    }

  negp = count <= 0;
121
  pos = scan_buffer ('\n', pos2, 0, count - negp, &shortage, 1);
Jim Blandy's avatar
Jim Blandy committed
122 123
  if (shortage > 0
      && (negp
Jim Blandy's avatar
Jim Blandy committed
124 125
	  || (ZV > BEGV
	      && pos != pos2
Jim Blandy's avatar
Jim Blandy committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139
	      && FETCH_CHAR (pos - 1) != '\n')))
    shortage--;
  SET_PT (pos);
  return make_number (negp ? - shortage : shortage);
}

DEFUN ("beginning-of-line", Fbeginning_of_line, Sbeginning_of_line,
  0, 1, "p",
  "Move point to beginning of current line.\n\
With argument ARG not nil or 1, move forward ARG - 1 lines first.\n\
If scan reaches end of buffer, stop there without error.")
  (n)
     Lisp_Object n;
{
Jim Blandy's avatar
Jim Blandy committed
140
  if (NILP (n))
141
    XSETFASTINT (n, 1);
Jim Blandy's avatar
Jim Blandy committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
  else
    CHECK_NUMBER (n, 0);

  Fforward_line (make_number (XINT (n) - 1));
  return Qnil;
}

DEFUN ("end-of-line", Fend_of_line, Send_of_line,
  0, 1, "p",
  "Move point to end of current line.\n\
With argument ARG not nil or 1, move forward ARG - 1 lines first.\n\
If scan reaches end of buffer, stop there without error.")
  (n)
     Lisp_Object n;
{
  register int pos;
  register int stop;

Jim Blandy's avatar
Jim Blandy committed
160
  if (NILP (n))
161
    XSETFASTINT (n, 1);
Jim Blandy's avatar
Jim Blandy committed
162 163 164
  else
    CHECK_NUMBER (n, 0);

165
  SET_PT (find_before_next_newline (PT, 0, XINT (n) - (XINT (n) <= 0)));
Jim Blandy's avatar
Jim Blandy committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179

  return Qnil;
}

DEFUN ("delete-char", Fdelete_char, Sdelete_char, 1, 2, "p\nP",
  "Delete the following ARG characters (previous, with negative arg).\n\
Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
Interactively, ARG is the prefix arg, and KILLFLAG is set if\n\
ARG was explicitly specified.")
  (n, killflag)
     Lisp_Object n, killflag;
{
  CHECK_NUMBER (n, 0);

Jim Blandy's avatar
Jim Blandy committed
180
  if (NILP (killflag))
Jim Blandy's avatar
Jim Blandy committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
    {
      if (XINT (n) < 0)
	{
	  if (point + XINT (n) < BEGV)
	    Fsignal (Qbeginning_of_buffer, Qnil);
	  else
	    del_range (point + XINT (n), point);
	}
      else
	{
	  if (point + XINT (n) > ZV)
	    Fsignal (Qend_of_buffer, Qnil);
	  else
	    del_range (point, point + XINT (n));
	}
    }
  else
    {
      call1 (Qkill_forward_chars, n);
    }
  return Qnil;
}

DEFUN ("delete-backward-char", Fdelete_backward_char, Sdelete_backward_char,
  1, 2, "p\nP",
  "Delete the previous ARG characters (following, with negative ARG).\n\
Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
Interactively, ARG is the prefix arg, and KILLFLAG is set if\n\
ARG was explicitly specified.")
  (n, killflag)
     Lisp_Object n, killflag;
{
  CHECK_NUMBER (n, 0);
  return Fdelete_char (make_number (-XINT (n)), killflag);
}

DEFUN ("self-insert-command", Fself_insert_command, Sself_insert_command, 1, 1, "p",
  "Insert the character you type.\n\
Whichever character you type to run this command is inserted.")
  (arg)
     Lisp_Object arg;
{
  CHECK_NUMBER (arg, 0);

  /* Barf if the key that invoked this was not a character.  */
226
  if (!INTEGERP (last_command_char))
Jim Blandy's avatar
Jim Blandy committed
227 228 229 230
    bitch_at_user ();
  else
    while (XINT (arg) > 0)
      {
231 232
	/* Ok since old and new vals both nonneg */
	XSETFASTINT (arg, XFASTINT (arg) - 1);
Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237 238 239 240 241 242 243 244
	internal_self_insert (XINT (last_command_char), XFASTINT (arg) != 0);
      }

  return Qnil;
}

DEFUN ("newline", Fnewline, Snewline, 0, 1, "P",
  "Insert a newline.  With arg, insert that many newlines.\n\
In Auto Fill mode, if no numeric arg, break the preceding line if it's long.")
  (arg1)
     Lisp_Object arg1;
{
245
  int flag, i;
Jim Blandy's avatar
Jim Blandy committed
246 247 248 249 250
  Lisp_Object arg;
  char c1 = '\n';

  arg = Fprefix_numeric_value (arg1);

Jim Blandy's avatar
Jim Blandy committed
251
  if (!NILP (current_buffer->read_only))
252
    Fbarf_if_buffer_read_only ();
Jim Blandy's avatar
Jim Blandy committed
253

Jim Blandy's avatar
Jim Blandy committed
254
  /* Inserting a newline at the end of a line produces better
255
     redisplay in try_window_id than inserting at the beginning of a
Jim Blandy's avatar
Jim Blandy committed
256 257 258 259 260 261
     line, and the textual result is the same.  So, if we're at
     beginning of line, pretend to be at the end of the previous line.  

     We can't use internal_self_insert in that case since it won't do
     the insertion correctly.  Luckily, internal_self_insert's special
     features all do nothing in that case.  */
Jim Blandy's avatar
Jim Blandy committed
262 263

  flag = point > BEGV && FETCH_CHAR (point - 1) == '\n';
Richard M. Stallman's avatar
Richard M. Stallman committed
264 265 266 267 268
  /* Don't do this if at the beginning of the window.  */
  if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer
      && marker_position (XWINDOW (selected_window)->start) == PT)
    flag = 0;

269
#ifdef USE_TEXT_PROPERTIES
270 271 272 273 274 275
  /* We cannot use this optimization if properties change
     in the vicinity.
     ??? We need to check for change hook properties, etc.  */
  if (flag)
    if (! (point - 1 > BEGV && ! property_change_between_p (point - 2, point)))
      flag = 0;
276
#endif
277 278 279

  if (flag)
    SET_PT (point - 1);
Jim Blandy's avatar
Jim Blandy committed
280

281
  for (i = XINT (arg); i > 0; i--)
Jim Blandy's avatar
Jim Blandy committed
282 283
    {
      if (flag)
284
	insert_and_inherit (&c1, 1);
Jim Blandy's avatar
Jim Blandy committed
285
      else
Jim Blandy's avatar
Jim Blandy committed
286
	internal_self_insert ('\n', !NILP (arg1));
Jim Blandy's avatar
Jim Blandy committed
287 288
    }

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
#ifdef USE_TEXT_PROPERTIES
  if (Vuse_hard_newlines)
    {
      Lisp_Object from, to, sticky;
      XSETFASTINT (from, PT - arg);
      XSETFASTINT (to, PT);
      Fput_text_property (from, to, Qhard, Qt, Qnil);
      /* If rear_nonsticky is not "t", locally add Qhard to the list. */
      sticky = Fget_text_property (from, Qrear_nonsticky, Qnil);
      if (NILP (sticky)
	  || (CONSP (sticky) && NILP (Fmemq (Qhard, sticky))))
	{
	  sticky = Fcons (Qhard, sticky);
	  Fput_text_property (from, to, Qrear_nonsticky, sticky, Qnil);
	}
    }
#endif


Jim Blandy's avatar
Jim Blandy committed
308 309 310 311 312 313
  if (flag)
    SET_PT (point + 1);

  return Qnil;
}

314 315 316 317
/* Insert character C1.  If NOAUTOFILL is nonzero, don't do autofill
   even if it is enabled.

   If this insertion is suitable for direct output (completely simple),
318 319
   return 0.  A value of 1 indicates this *might* not have been simple.
   A value of 2 means this did things that call for an undo boundary.  */
320

Jim Blandy's avatar
Jim Blandy committed
321 322 323 324 325 326 327 328 329
internal_self_insert (c1, noautofill)
     char c1;
     int noautofill;
{
  extern Lisp_Object Fexpand_abbrev ();
  int hairy = 0;
  Lisp_Object tem;
  register enum syntaxcode synt;
  register int c = c1;
330
  Lisp_Object overwrite;
Jim Blandy's avatar
Jim Blandy committed
331

332
  overwrite = current_buffer->overwrite_mode;
333 334
  if (!NILP (Vbefore_change_function) || !NILP (Vafter_change_function)
      || !NILP (Vbefore_change_functions) || !NILP (Vafter_change_functions))
Jim Blandy's avatar
Jim Blandy committed
335 336
    hairy = 1;

337
  if (!NILP (overwrite)
Jim Blandy's avatar
Jim Blandy committed
338
      && point < ZV
339 340 341
      && (EQ (overwrite, Qoverwrite_mode_binary)
	  || (c != '\n' && FETCH_CHAR (point) != '\n'))
      && (EQ (overwrite, Qoverwrite_mode_binary)
342
	  || FETCH_CHAR (point) != '\t'
Jim Blandy's avatar
Jim Blandy committed
343
	  || XINT (current_buffer->tab_width) <= 0
344
	  || XFASTINT (current_buffer->tab_width) > 20
Jim Blandy's avatar
Jim Blandy committed
345 346 347
	  || !((current_column () + 1) % XFASTINT (current_buffer->tab_width))))
    {
      del_range (point, point + 1);
348
      hairy = 2;
Jim Blandy's avatar
Jim Blandy committed
349
    }
Jim Blandy's avatar
Jim Blandy committed
350
  if (!NILP (current_buffer->abbrev_mode)
Jim Blandy's avatar
Jim Blandy committed
351
      && SYNTAX (c) != Sword
Jim Blandy's avatar
Jim Blandy committed
352
      && NILP (current_buffer->read_only)
Jim Blandy's avatar
Jim Blandy committed
353 354
      && point > BEGV && SYNTAX (FETCH_CHAR (point - 1)) == Sword)
    {
355
      int modiff = MODIFF;
356 357
      Fexpand_abbrev ();
      /* We can't trust the value of Fexpand_abbrev,
358 359 360
	 but if Fexpand_abbrev changed the buffer,
	 assume it expanded something.  */
      if (MODIFF != modiff)
361
	hairy = 2;
Jim Blandy's avatar
Jim Blandy committed
362 363 364
    }
  if ((c == ' ' || c == '\n')
      && !noautofill
365
      && !NILP (current_buffer->auto_fill_function))
Jim Blandy's avatar
Jim Blandy committed
366 367
    {
      if (c1 != '\n')
368
	insert_and_inherit (&c1, 1);
Jim Blandy's avatar
Jim Blandy committed
369 370
      call0 (current_buffer->auto_fill_function);
      if (c1 == '\n')
371
	insert_and_inherit (&c1, 1);
372
      hairy = 2;
Jim Blandy's avatar
Jim Blandy committed
373 374
    }
  else
375
    insert_and_inherit (&c1, 1);
376 377 378 379 380 381 382 383 384 385 386

  /* If previous command specified a face to use, use it.  */
  if (!NILP (Vself_insert_face)
      && EQ (last_command, Vself_insert_face_command))
    {
      Lisp_Object before, after;
      XSETINT (before, PT - 1);
      XSETINT (after, PT);
      Fput_text_property (before, after, Qface, Vself_insert_face, Qnil);
      Vself_insert_face = Qnil;
    }
Jim Blandy's avatar
Jim Blandy committed
387 388
  synt = SYNTAX (c);
  if ((synt == Sclose || synt == Smath)
Jim Blandy's avatar
Jim Blandy committed
389
      && !NILP (Vblink_paren_function) && INTERACTIVE)
Jim Blandy's avatar
Jim Blandy committed
390 391
    {
      call0 (Vblink_paren_function);
392
      hairy = 2;
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396 397 398 399 400 401 402 403 404 405 406
    }
  return hairy;
}

/* module initialization */

syms_of_cmds ()
{
  Qkill_backward_chars = intern ("kill-backward-chars");
  staticpro (&Qkill_backward_chars);

  Qkill_forward_chars = intern ("kill-forward-chars");
  staticpro (&Qkill_forward_chars);

407 408
  Qoverwrite_mode_binary = intern ("overwrite-mode-binary");
  staticpro (&Qoverwrite_mode_binary);
409

410 411 412 413
  Qhard = intern ("hard");
  staticpro (&Qhard);

  DEFVAR_BOOL ("use-hard-newlines", &Vuse_hard_newlines,
414 415 416 417 418 419
    "Non-nil means to distinguish hard and soft newlines.\n\
When this is non-nil, the functions `newline' and `open-line' add the\n\
text-property `hard' to newlines that they insert.  Also, a line is\n\
only considered as a candidate to match `paragraph-start' or\n\
`paragraph-separate' if it follows a hard newline.  Newlines not\n\
marked hard are called \"soft\", and are always internal to\n\
420 421 422
paragraphs.  The fill functions always insert soft newlines.");
  Vuse_hard_newlines = 0;

423 424 425 426 427 428 429 430 431 432
  DEFVAR_LISP ("self-insert-face", &Vself_insert_face,
    "If non-nil, set the face of the next self-inserting character to this.\n\
See also `self-insert-face-command'.");
  Vself_insert_face = Qnil;

  DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command,
    "This is the command that set up `self-insert-face'.\n\
If `last-command' does not equal this value, we ignore `self-insert-face'.");
  Vself_insert_face_command = Qnil;

Jim Blandy's avatar
Jim Blandy committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
  DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function,
    "Function called, if non-nil, whenever a close parenthesis is inserted.\n\
More precisely, a char with closeparen syntax is self-inserted.");
  Vblink_paren_function = Qnil;

  defsubr (&Sforward_char);
  defsubr (&Sbackward_char);
  defsubr (&Sforward_line);
  defsubr (&Sbeginning_of_line);
  defsubr (&Send_of_line);

  defsubr (&Sdelete_char);
  defsubr (&Sdelete_backward_char);

  defsubr (&Sself_insert_command);
  defsubr (&Snewline);
}

keys_of_cmds ()
{
  int n;

455 456
  initial_define_key (global_map, Ctl ('M'), "newline");
  initial_define_key (global_map, Ctl ('I'), "self-insert-command");
Jim Blandy's avatar
Jim Blandy committed
457 458
  for (n = 040; n < 0177; n++)
    initial_define_key (global_map, n, "self-insert-command");
459 460 461 462
#ifdef MSDOS
  for (n = 0200; n < 0240; n++)
    initial_define_key (global_map, n, "self-insert-command");
#endif
463
  for (n = 0240; n < 0400; n++)
464
    initial_define_key (global_map, n, "self-insert-command");
Jim Blandy's avatar
Jim Blandy committed
465 466 467 468 469 470 471 472

  initial_define_key (global_map, Ctl ('A'), "beginning-of-line");
  initial_define_key (global_map, Ctl ('B'), "backward-char");
  initial_define_key (global_map, Ctl ('D'), "delete-char");
  initial_define_key (global_map, Ctl ('E'), "end-of-line");
  initial_define_key (global_map, Ctl ('F'), "forward-char");
  initial_define_key (global_map, 0177, "delete-backward-char");
}