Mercurial > emacs
comparison src/minibuf.c @ 43000:c16f32068114
(Fread_from_minibuffer, Fread_command, Fread_function)
(Fread_variable, Fread_buffer, minibuffer-completion-confirm): Fix
doc-strings.
author | Pavel Janík <Pavel@Janik.cz> |
---|---|
date | Sun, 27 Jan 2002 18:20:46 +0000 |
parents | aa810c4a602b |
children | 6502ac0cd978 |
comparison
equal
deleted
inserted
replaced
42999:0dd2c7d849f5 | 43000:c16f32068114 |
---|---|
505 Vminibuffer_history_variable = histvar; | 505 Vminibuffer_history_variable = histvar; |
506 Vhelp_form = Vminibuffer_help_form; | 506 Vhelp_form = Vminibuffer_help_form; |
507 | 507 |
508 if (inherit_input_method) | 508 if (inherit_input_method) |
509 { | 509 { |
510 /* `current-input-method' is buffer local. So, remeber it in | 510 /* `current-input-method' is buffer local. So, remember it in |
511 INPUT_METHOD before changing the current buffer. */ | 511 INPUT_METHOD before changing the current buffer. */ |
512 input_method = Fsymbol_value (Qcurrent_input_method); | 512 input_method = Fsymbol_value (Qcurrent_input_method); |
513 enable_multibyte = current_buffer->enable_multibyte_characters; | 513 enable_multibyte = current_buffer->enable_multibyte_characters; |
514 } | 514 } |
515 | 515 |
606 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method))) | 606 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method))) |
607 call1 (Qactivate_input_method, input_method); | 607 call1 (Qactivate_input_method, input_method); |
608 | 608 |
609 /* Run our hook, but not if it is empty. | 609 /* Run our hook, but not if it is empty. |
610 (run-hooks would do nothing if it is empty, | 610 (run-hooks would do nothing if it is empty, |
611 but it's important to save time here in the usual case). */ | 611 but it's important to save time here in the usual case.) */ |
612 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound) | 612 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound) |
613 && !NILP (Vrun_hooks)) | 613 && !NILP (Vrun_hooks)) |
614 call1 (Vrun_hooks, Qminibuffer_setup_hook); | 614 call1 (Vrun_hooks, Qminibuffer_setup_hook); |
615 | 615 |
616 /* Don't allow the user to undo past this point. */ | 616 /* Don't allow the user to undo past this point. */ |
817 to be inserted into the minibuffer before reading input. | 817 to be inserted into the minibuffer before reading input. |
818 If INITIAL-CONTENTS is (STRING . POSITION), the initial input | 818 If INITIAL-CONTENTS is (STRING . POSITION), the initial input |
819 is STRING, but point is placed at position POSITION in the minibuffer. | 819 is STRING, but point is placed at position POSITION in the minibuffer. |
820 Third arg KEYMAP is a keymap to use whilst reading; | 820 Third arg KEYMAP is a keymap to use whilst reading; |
821 if omitted or nil, the default is `minibuffer-local-map'. | 821 if omitted or nil, the default is `minibuffer-local-map'. |
822 If fourth arg READ is non-nil, then interpret the result as a lisp object | 822 If fourth arg READ is non-nil, then interpret the result as a Lisp object |
823 and return that object: | 823 and return that object: |
824 in other words, do `(car (read-from-string INPUT-STRING))' | 824 in other words, do `(car (read-from-string INPUT-STRING))' |
825 Fifth arg HIST, if non-nil, specifies a history list | 825 Fifth arg HIST, if non-nil, specifies a history list |
826 and optionally the initial position in the list. | 826 and optionally the initial position in the list. |
827 It can be a symbol, which is the history list variable to use, | 827 It can be a symbol, which is the history list variable to use, |
967 !NILP (inherit_input_method)); | 967 !NILP (inherit_input_method)); |
968 } | 968 } |
969 | 969 |
970 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0, | 970 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0, |
971 doc: /* Read the name of a command and return as a symbol. | 971 doc: /* Read the name of a command and return as a symbol. |
972 Prompts with PROMPT. By default, return DEFAULT-VALUE. */) | 972 Prompt with PROMPT. By default, return DEFAULT-VALUE. */) |
973 (prompt, default_value) | 973 (prompt, default_value) |
974 Lisp_Object prompt, default_value; | 974 Lisp_Object prompt, default_value; |
975 { | 975 { |
976 Lisp_Object name, default_string; | 976 Lisp_Object name, default_string; |
977 | 977 |
990 } | 990 } |
991 | 991 |
992 #ifdef NOTDEF | 992 #ifdef NOTDEF |
993 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0, | 993 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0, |
994 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol. | 994 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol. |
995 Prompts with PROMPT. */) | 995 Prompt with PROMPT. */) |
996 (prompt) | 996 (prompt) |
997 Lisp_Object prompt; | 997 Lisp_Object prompt; |
998 { | 998 { |
999 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil), | 999 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil), |
1000 Qnil); | 1000 Qnil); |
1001 } | 1001 } |
1002 #endif /* NOTDEF */ | 1002 #endif /* NOTDEF */ |
1003 | 1003 |
1004 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0, | 1004 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0, |
1005 doc: /* Read the name of a user variable and return it as a symbol. | 1005 doc: /* Read the name of a user variable and return it as a symbol. |
1006 Prompts with PROMPT. By default, return DEFAULT-VALUE. | 1006 Prompt with PROMPT. By default, return DEFAULT-VALUE. |
1007 A user variable is one whose documentation starts with a `*' character. */) | 1007 A user variable is one whose documentation starts with a `*' character. */) |
1008 (prompt, default_value) | 1008 (prompt, default_value) |
1009 Lisp_Object prompt, default_value; | 1009 Lisp_Object prompt, default_value; |
1010 { | 1010 { |
1011 Lisp_Object name, default_string; | 1011 Lisp_Object name, default_string; |
1024 return name; | 1024 return name; |
1025 return Fintern (name, Qnil); | 1025 return Fintern (name, Qnil); |
1026 } | 1026 } |
1027 | 1027 |
1028 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0, | 1028 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0, |
1029 doc: /* One arg PROMPT, a string. Read the name of a buffer and return as a string. | 1029 doc: /* Read the name of a buffer and return as a string. |
1030 Prompts with PROMPT. | 1030 Prompt with PROMPT. |
1031 Optional second arg DEF is value to return if user enters an empty line. | 1031 Optional second arg DEF is value to return if user enters an empty line. |
1032 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed. */) | 1032 If optional third arg REQUIRE-MATCH is non-nil, |
1033 only existing buffer names are allowed. */) | |
1033 (prompt, def, require_match) | 1034 (prompt, def, require_match) |
1034 Lisp_Object prompt, def, require_match; | 1035 Lisp_Object prompt, def, require_match; |
1035 { | 1036 { |
1036 Lisp_Object args[4]; | 1037 Lisp_Object args[4]; |
1037 | 1038 |
2404 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate, | 2405 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate, |
2405 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */); | 2406 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */); |
2406 Vminibuffer_completion_predicate = Qnil; | 2407 Vminibuffer_completion_predicate = Qnil; |
2407 | 2408 |
2408 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm, | 2409 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm, |
2409 doc: /* Non-nil => demand confirmation of completion before exiting minibuffer. */); | 2410 doc: /* Non-nil means to demand confirmation of completion before exiting minibuffer. */); |
2410 Vminibuffer_completion_confirm = Qnil; | 2411 Vminibuffer_completion_confirm = Qnil; |
2411 | 2412 |
2412 DEFVAR_LISP ("minibuffer-completing-file-name", | 2413 DEFVAR_LISP ("minibuffer-completing-file-name", |
2413 &Vminibuffer_completing_file_name, | 2414 &Vminibuffer_completing_file_name, |
2414 doc: /* Non-nil means completing file names. */); | 2415 doc: /* Non-nil means completing file names. */); |