diff options
Diffstat (limited to 'src/misc1.c')
| -rw-r--r-- | src/misc1.c | 2811 |
1 files changed, 2811 insertions, 0 deletions
diff --git a/src/misc1.c b/src/misc1.c new file mode 100644 index 0000000..a03c405 --- /dev/null +++ b/src/misc1.c @@ -0,0 +1,2811 @@ +/* vi:set ts=8 sts=4 sw=4 noet: + * + * VIM - Vi IMproved by Bram Moolenaar + * + * Do ":help uganda" in Vim to read copying and usage conditions. + * Do ":help credits" in Vim to see a list of people who contributed. + * See README.txt for an overview of the Vim source code. + */ + +/* + * misc1.c: functions that didn't seem to fit elsewhere + */ + +#include "vim.h" +#include "version.h" + +#if defined(__HAIKU__) +# include <storage/FindDirectory.h> +#endif + +#if defined(MSWIN) +# include <lm.h> +#endif + +#define URL_SLASH 1 // path_is_url() has found "://" +#define URL_BACKSLASH 2 // path_is_url() has found ":\\" + +// All user names (for ~user completion as done by shell). +static garray_T ga_users; + +/* + * get_leader_len() returns the length in bytes of the prefix of the given + * string which introduces a comment. If this string is not a comment then + * 0 is returned. + * When "flags" is not NULL, it is set to point to the flags of the recognized + * comment leader. + * "backward" must be true for the "O" command. + * If "include_space" is set, include trailing whitespace while calculating the + * length. + */ + int +get_leader_len( + char_u *line, + char_u **flags, + int backward, + int include_space) +{ + int i, j; + int result; + int got_com = FALSE; + int found_one; + char_u part_buf[COM_MAX_LEN]; // buffer for one option part + char_u *string; // pointer to comment string + char_u *list; + int middle_match_len = 0; + char_u *prev_list; + char_u *saved_flags = NULL; + + result = i = 0; + while (VIM_ISWHITE(line[i])) // leading white space is ignored + ++i; + + /* + * Repeat to match several nested comment strings. + */ + while (line[i] != NUL) + { + /* + * scan through the 'comments' option for a match + */ + found_one = FALSE; + for (list = curbuf->b_p_com; *list; ) + { + // Get one option part into part_buf[]. Advance "list" to next + // one. Put "string" at start of string. + if (!got_com && flags != NULL) + *flags = list; // remember where flags started + prev_list = list; + (void)copy_option_part(&list, part_buf, COM_MAX_LEN, ","); + string = vim_strchr(part_buf, ':'); + if (string == NULL) // missing ':', ignore this part + continue; + *string++ = NUL; // isolate flags from string + + // If we found a middle match previously, use that match when this + // is not a middle or end. + if (middle_match_len != 0 + && vim_strchr(part_buf, COM_MIDDLE) == NULL + && vim_strchr(part_buf, COM_END) == NULL) + break; + + // When we already found a nested comment, only accept further + // nested comments. + if (got_com && vim_strchr(part_buf, COM_NEST) == NULL) + continue; + + // When 'O' flag present and using "O" command skip this one. + if (backward && vim_strchr(part_buf, COM_NOBACK) != NULL) + continue; + + // Line contents and string must match. + // When string starts with white space, must have some white space + // (but the amount does not need to match, there might be a mix of + // TABs and spaces). + if (VIM_ISWHITE(string[0])) + { + if (i == 0 || !VIM_ISWHITE(line[i - 1])) + continue; // missing white space + while (VIM_ISWHITE(string[0])) + ++string; + } + for (j = 0; string[j] != NUL && string[j] == line[i + j]; ++j) + ; + if (string[j] != NUL) + continue; // string doesn't match + + // When 'b' flag used, there must be white space or an + // end-of-line after the string in the line. + if (vim_strchr(part_buf, COM_BLANK) != NULL + && !VIM_ISWHITE(line[i + j]) && line[i + j] != NUL) + continue; + + // We have found a match, stop searching unless this is a middle + // comment. The middle comment can be a substring of the end + // comment in which case it's better to return the length of the + // end comment and its flags. Thus we keep searching with middle + // and end matches and use an end match if it matches better. + if (vim_strchr(part_buf, COM_MIDDLE) != NULL) + { + if (middle_match_len == 0) + { + middle_match_len = j; + saved_flags = prev_list; + } + continue; + } + if (middle_match_len != 0 && j > middle_match_len) + // Use this match instead of the middle match, since it's a + // longer thus better match. + middle_match_len = 0; + + if (middle_match_len == 0) + i += j; + found_one = TRUE; + break; + } + + if (middle_match_len != 0) + { + // Use the previously found middle match after failing to find a + // match with an end. + if (!got_com && flags != NULL) + *flags = saved_flags; + i += middle_match_len; + found_one = TRUE; + } + + // No match found, stop scanning. + if (!found_one) + break; + + result = i; + + // Include any trailing white space. + while (VIM_ISWHITE(line[i])) + ++i; + + if (include_space) + result = i; + + // If this comment doesn't nest, stop here. + got_com = TRUE; + if (vim_strchr(part_buf, COM_NEST) == NULL) + break; + } + return result; +} + +/* + * Return the offset at which the last comment in line starts. If there is no + * comment in the whole line, -1 is returned. + * + * When "flags" is not null, it is set to point to the flags describing the + * recognized comment leader. + */ + int +get_last_leader_offset(char_u *line, char_u **flags) +{ + int result = -1; + int i, j; + int lower_check_bound = 0; + char_u *string; + char_u *com_leader; + char_u *com_flags; + char_u *list; + int found_one; + char_u part_buf[COM_MAX_LEN]; // buffer for one option part + + /* + * Repeat to match several nested comment strings. + */ + i = (int)STRLEN(line); + while (--i >= lower_check_bound) + { + /* + * scan through the 'comments' option for a match + */ + found_one = FALSE; + for (list = curbuf->b_p_com; *list; ) + { + char_u *flags_save = list; + + /* + * Get one option part into part_buf[]. Advance list to next one. + * put string at start of string. + */ + (void)copy_option_part(&list, part_buf, COM_MAX_LEN, ","); + string = vim_strchr(part_buf, ':'); + if (string == NULL) // If everything is fine, this cannot actually + // happen. + continue; + *string++ = NUL; // Isolate flags from string. + com_leader = string; + + /* + * Line contents and string must match. + * When string starts with white space, must have some white space + * (but the amount does not need to match, there might be a mix of + * TABs and spaces). + */ + if (VIM_ISWHITE(string[0])) + { + if (i == 0 || !VIM_ISWHITE(line[i - 1])) + continue; + while (VIM_ISWHITE(*string)) + ++string; + } + for (j = 0; string[j] != NUL && string[j] == line[i + j]; ++j) + /* do nothing */; + if (string[j] != NUL) + continue; + + /* + * When 'b' flag used, there must be white space or an + * end-of-line after the string in the line. + */ + if (vim_strchr(part_buf, COM_BLANK) != NULL + && !VIM_ISWHITE(line[i + j]) && line[i + j] != NUL) + continue; + + if (vim_strchr(part_buf, COM_MIDDLE) != NULL) + { + // For a middlepart comment, only consider it to match if + // everything before the current position in the line is + // whitespace. Otherwise we would think we are inside a + // comment if the middle part appears somewhere in the middle + // of the line. E.g. for C the "*" appears often. + for (j = 0; VIM_ISWHITE(line[j]) && j <= i; j++) + ; + if (j < i) + continue; + } + + /* + * We have found a match, stop searching. + */ + found_one = TRUE; + + if (flags) + *flags = flags_save; + com_flags = flags_save; + + break; + } + + if (found_one) + { + char_u part_buf2[COM_MAX_LEN]; // buffer for one option part + int len1, len2, off; + + result = i; + /* + * If this comment nests, continue searching. + */ + if (vim_strchr(part_buf, COM_NEST) != NULL) + continue; + + lower_check_bound = i; + + // Let's verify whether the comment leader found is a substring + // of other comment leaders. If it is, let's adjust the + // lower_check_bound so that we make sure that we have determined + // the comment leader correctly. + + while (VIM_ISWHITE(*com_leader)) + ++com_leader; + len1 = (int)STRLEN(com_leader); + + for (list = curbuf->b_p_com; *list; ) + { + char_u *flags_save = list; + + (void)copy_option_part(&list, part_buf2, COM_MAX_LEN, ","); + if (flags_save == com_flags) + continue; + string = vim_strchr(part_buf2, ':'); + ++string; + while (VIM_ISWHITE(*string)) + ++string; + len2 = (int)STRLEN(string); + if (len2 == 0) + continue; + + // Now we have to verify whether string ends with a substring + // beginning the com_leader. + for (off = (len2 > i ? i : len2); off > 0 && off + len1 > len2;) + { + --off; + if (!STRNCMP(string + off, com_leader, len2 - off)) + { + if (i - off < lower_check_bound) + lower_check_bound = i - off; + } + } + } + } + } + return result; +} + +/* + * Return the number of window lines occupied by buffer line "lnum". + * Includes any filler lines. + */ + int +plines(linenr_T lnum) +{ + return plines_win(curwin, lnum, TRUE); +} + + int +plines_win( + win_T *wp, + linenr_T lnum, + int winheight) // when TRUE limit to window height +{ +#if defined(FEAT_DIFF) || defined(PROTO) + // Check for filler lines above this buffer line. When folded the result + // is one line anyway. + return plines_win_nofill(wp, lnum, winheight) + diff_check_fill(wp, lnum); +} + +/* + * Return the number of window lines occupied by buffer line "lnum". + * Does not include filler lines. + */ + int +plines_nofill(linenr_T lnum) +{ + return plines_win_nofill(curwin, lnum, TRUE); +} + + int +plines_win_nofill( + win_T *wp, + linenr_T lnum, + int winheight) // when TRUE limit to window height +{ +#endif + int lines; + + if (wp->w_width == 0) + return 1; + +#ifdef FEAT_FOLDING + // Folded lines are handled just like an empty line. + // NOTE: Caller must handle lines that are MAYBE folded. + if (lineFolded(wp, lnum) == TRUE) + return 1; +#endif + + if (!wp->w_p_wrap) + lines = 1 +#ifdef FEAT_PROP_POPUP + // add a line for each "above" and "below" aligned text property + + prop_count_above_below(wp->w_buffer, lnum) +#endif + ; + else + lines = plines_win_nofold(wp, lnum); + + if (winheight > 0 && lines > wp->w_height) + return wp->w_height; + return lines; +} + +/* + * Return number of window lines physical line "lnum" will occupy in window + * "wp". Does not care about folding, 'wrap' or 'diff'. + */ + int +plines_win_nofold(win_T *wp, linenr_T lnum) +{ + char_u *s; + long col; + int width; + chartabsize_T cts; + + s = ml_get_buf(wp->w_buffer, lnum, FALSE); + init_chartabsize_arg(&cts, wp, lnum, 0, s, s); + if (*s == NUL +#ifdef FEAT_PROP_POPUP + && !cts.cts_has_prop_with_text +#endif + ) + return 1; // be quick for an empty line + win_linetabsize_cts(&cts, (colnr_T)MAXCOL); + clear_chartabsize_arg(&cts); + col = (int)cts.cts_vcol; + + // If list mode is on, then the '$' at the end of the line may take up one + // extra column. + if (wp->w_p_list && wp->w_lcs_chars.eol != NUL) + col += 1; + + /* + * Add column offset for 'number', 'relativenumber' and 'foldcolumn'. + */ + width = wp->w_width - win_col_off(wp); + if (width <= 0) + return 32000; + if (col <= width) + return 1; + col -= width; + width += win_col_off2(wp); + return (col + (width - 1)) / width + 1; +} + +/* + * Like plines_win(), but only reports the number of physical screen lines + * used from the start of the line to the given column number. + */ + int +plines_win_col(win_T *wp, linenr_T lnum, long column) +{ + long col; + int lines = 0; + int width; + char_u *line; + chartabsize_T cts; + +#ifdef FEAT_DIFF + // Check for filler lines above this buffer line. When folded the result + // is one line anyway. + lines = diff_check_fill(wp, lnum); +#endif + + if (!wp->w_p_wrap) + return lines + 1; + + if (wp->w_width == 0) + return lines + 1; + + line = ml_get_buf(wp->w_buffer, lnum, FALSE); + + init_chartabsize_arg(&cts, wp, lnum, 0, line, line); + while (*cts.cts_ptr != NUL && --column >= 0) + { + cts.cts_vcol += win_lbr_chartabsize(&cts, NULL); + MB_PTR_ADV(cts.cts_ptr); + } + + /* + * If *cts.cts_ptr is a TAB, and the TAB is not displayed as ^I, and we're + * not in MODE_INSERT state, then col must be adjusted so that it + * represents the last screen position of the TAB. This only fixes an + * error when the TAB wraps from one screen line to the next (when + * 'columns' is not a multiple of 'ts') -- webb. + */ + col = cts.cts_vcol; + if (*cts.cts_ptr == TAB && (State & MODE_NORMAL) + && (!wp->w_p_list || wp->w_lcs_chars.tab1)) + col += win_lbr_chartabsize(&cts, NULL) - 1; + clear_chartabsize_arg(&cts); + + /* + * Add column offset for 'number', 'relativenumber', 'foldcolumn', etc. + */ + width = wp->w_width - win_col_off(wp); + if (width <= 0) + return 9999; + + lines += 1; + if (col > width) + lines += (col - width) / (width + win_col_off2(wp)) + 1; + return lines; +} + + int +plines_m_win(win_T *wp, linenr_T first, linenr_T last) +{ + int count = 0; + + while (first <= last) + { +#ifdef FEAT_FOLDING + int x; + + // Check if there are any really folded lines, but also included lines + // that are maybe folded. + x = foldedCount(wp, first, NULL); + if (x > 0) + { + ++count; // count 1 for "+-- folded" line + first += x; + } + else +#endif + { +#ifdef FEAT_DIFF + if (first == wp->w_topline) + count += plines_win_nofill(wp, first, TRUE) + wp->w_topfill; + else +#endif + count += plines_win(wp, first, TRUE); + ++first; + } + } + return (count); +} + + int +gchar_pos(pos_T *pos) +{ + char_u *ptr; + + // When searching columns is sometimes put at the end of a line. + if (pos->col == MAXCOL) + return NUL; + ptr = ml_get_pos(pos); + if (has_mbyte) + return (*mb_ptr2char)(ptr); + return (int)*ptr; +} + + int +gchar_cursor(void) +{ + if (has_mbyte) + return (*mb_ptr2char)(ml_get_cursor()); + return (int)*ml_get_cursor(); +} + +/* + * Write a character at the current cursor position. + * It is directly written into the block. + */ + void +pchar_cursor(int c) +{ + *(ml_get_buf(curbuf, curwin->w_cursor.lnum, TRUE) + + curwin->w_cursor.col) = c; +} + +/* + * Skip to next part of an option argument: Skip space and comma. + */ + char_u * +skip_to_option_part(char_u *p) +{ + if (*p == ',') + ++p; + while (*p == ' ') + ++p; + return p; +} + +/* + * check_status: called when the status bars for the buffer 'buf' + * need to be updated + */ + void +check_status(buf_T *buf) +{ + win_T *wp; + + FOR_ALL_WINDOWS(wp) + if (wp->w_buffer == buf && wp->w_status_height) + { + wp->w_redr_status = TRUE; + set_must_redraw(UPD_VALID); + } +} + +/* + * Ask for a reply from the user, a 'y' or a 'n', with prompt "str" (which + * should have been translated already). + * No other characters are accepted, the message is repeated until a valid + * reply is entered or CTRL-C is hit. + * If direct is TRUE, don't use vgetc() but ui_inchar(), don't get characters + * from any buffers but directly from the user. + * + * return the 'y' or 'n' + */ + int +ask_yesno(char_u *str, int direct) +{ + int r = ' '; + int save_State = State; + + if (exiting) // put terminal in raw mode for this question + settmode(TMODE_RAW); + ++no_wait_return; +#ifdef USE_ON_FLY_SCROLL + dont_scroll = TRUE; // disallow scrolling here +#endif + State = MODE_CONFIRM; // mouse behaves like with :confirm + setmouse(); // disables mouse for xterm + ++no_mapping; + ++allow_keys; // no mapping here, but recognize keys + + while (r != 'y' && r != 'n') + { + // same highlighting as for wait_return() + smsg_attr(HL_ATTR(HLF_R), "%s (y/n)?", str); + if (direct) + r = get_keystroke(); + else + r = plain_vgetc(); + if (r == Ctrl_C || r == ESC) + r = 'n'; + msg_putchar(r); // show what you typed + out_flush(); + } + --no_wait_return; + State = save_State; + setmouse(); + --no_mapping; + --allow_keys; + + return r; +} + +#if defined(FEAT_EVAL) || defined(PROTO) + +/* + * Returns the current mode as a string in "buf[MODE_MAX_LENGTH]", NUL + * terminated. + * The first character represents the major mode, the following ones the minor + * ones. + */ + void +get_mode(char_u *buf) +{ + int i = 0; + + if (time_for_testing == 93784) + { + // Testing the two-character code. + buf[i++] = 'x'; + buf[i++] = '!'; + } +#ifdef FEAT_TERMINAL + else if (term_use_loop()) + buf[i++] = 't'; +#endif + else if (VIsual_active) + { + if (VIsual_select) + buf[i++] = VIsual_mode + 's' - 'v'; + else + { + buf[i++] = VIsual_mode; + if (restart_VIsual_select) + buf[i++] = 's'; + } + } + else if (State == MODE_HITRETURN || State == MODE_ASKMORE + || State == MODE_SETWSIZE + || State == MODE_CONFIRM) + { + buf[i++] = 'r'; + if (State == MODE_ASKMORE) + buf[i++] = 'm'; + else if (State == MODE_CONFIRM) + buf[i++] = '?'; + } + else if (State == MODE_EXTERNCMD) + buf[i++] = '!'; + else if (State & MODE_INSERT) + { + if (State & VREPLACE_FLAG) + { + buf[i++] = 'R'; + buf[i++] = 'v'; + } + else + { + if (State & REPLACE_FLAG) + buf[i++] = 'R'; + else + buf[i++] = 'i'; + } + + if (ins_compl_active()) + buf[i++] = 'c'; + else if (ctrl_x_mode_not_defined_yet()) + buf[i++] = 'x'; + } + else if ((State & MODE_CMDLINE) || exmode_active) + { + buf[i++] = 'c'; + if (exmode_active == EXMODE_VIM) + buf[i++] = 'v'; + else if (exmode_active == EXMODE_NORMAL) + buf[i++] = 'e'; + } + else + { + buf[i++] = 'n'; + if (finish_op) + { + buf[i++] = 'o'; + // to be able to detect force-linewise/blockwise/characterwise + // operations + buf[i++] = motion_force; + } + else if (restart_edit == 'I' || restart_edit == 'R' + || restart_edit == 'V') + { + buf[i++] = 'i'; + buf[i++] = restart_edit; + } +#ifdef FEAT_TERMINAL + else if (term_in_normal_mode()) + buf[i++] = 't'; +#endif + } + + buf[i] = NUL; +} + +/* + * "mode()" function + */ + void +f_mode(typval_T *argvars, typval_T *rettv) +{ + char_u buf[MODE_MAX_LENGTH]; + + if (in_vim9script() && check_for_opt_bool_arg(argvars, 0) == FAIL) + return; + + get_mode(buf); + + // Clear out the minor mode when the argument is not a non-zero number or + // non-empty string. + if (!non_zero_arg(&argvars[0])) + buf[1] = NUL; + + rettv->vval.v_string = vim_strsave(buf); + rettv->v_type = VAR_STRING; +} + + static void +may_add_state_char(garray_T *gap, char_u *include, int c) +{ + if (include == NULL || vim_strchr(include, c) != NULL) + ga_append(gap, c); +} + +/* + * "state()" function + */ + void +f_state(typval_T *argvars, typval_T *rettv) +{ + garray_T ga; + char_u *include = NULL; + int i; + + if (in_vim9script() && check_for_opt_string_arg(argvars, 0) == FAIL) + return; + + ga_init2(&ga, 1, 20); + if (argvars[0].v_type != VAR_UNKNOWN) + include = tv_get_string(&argvars[0]); + + if (!(stuff_empty() && typebuf.tb_len == 0 && scriptin[curscript] == NULL)) + may_add_state_char(&ga, include, 'm'); + if (op_pending()) + may_add_state_char(&ga, include, 'o'); + if (autocmd_busy) + may_add_state_char(&ga, include, 'x'); + if (ins_compl_active()) + may_add_state_char(&ga, include, 'a'); + +# ifdef FEAT_JOB_CHANNEL + if (channel_in_blocking_wait()) + may_add_state_char(&ga, include, 'w'); +# endif + if (!get_was_safe_state()) + may_add_state_char(&ga, include, 'S'); + for (i = 0; i < get_callback_depth() && i < 3; ++i) + may_add_state_char(&ga, include, 'c'); + if (msg_scrolled > 0) + may_add_state_char(&ga, include, 's'); + + rettv->v_type = VAR_STRING; + rettv->vval.v_string = ga.ga_data; +} + +#endif // FEAT_EVAL + +/* + * Get a key stroke directly from the user. + * Ignores mouse clicks and scrollbar events, except a click for the left + * button (used at the more prompt). + * Doesn't use vgetc(), because it syncs undo and eats mapped characters. + * Disadvantage: typeahead is ignored. + * Translates the interrupt character for unix to ESC. + */ + int +get_keystroke(void) +{ + char_u *buf = NULL; + int buflen = 150; + int maxlen; + int len = 0; + int n; + int save_mapped_ctrl_c = mapped_ctrl_c; + int waited = 0; + + mapped_ctrl_c = FALSE; // mappings are not used here + for (;;) + { + cursor_on(); + out_flush(); + + // Leave some room for check_termcode() to insert a key code into (max + // 5 chars plus NUL). And fix_input_buffer() can triple the number of + // bytes. + maxlen = (buflen - 6 - len) / 3; + if (buf == NULL) + buf = alloc(buflen); + else if (maxlen < 10) + { + char_u *t_buf = buf; + + // Need some more space. This might happen when receiving a long + // escape sequence. + buflen += 100; + buf = vim_realloc(buf, buflen); + if (buf == NULL) + vim_free(t_buf); + maxlen = (buflen - 6 - len) / 3; + } + if (buf == NULL) + { + do_outofmem_msg((long_u)buflen); + return ESC; // panic! + } + + // First time: blocking wait. Second time: wait up to 100ms for a + // terminal code to complete. + n = ui_inchar(buf + len, maxlen, len == 0 ? -1L : 100L, 0); + if (n > 0) + { + // Replace zero and CSI by a special key code. + n = fix_input_buffer(buf + len, n); + len += n; + waited = 0; + } + else if (len > 0) + ++waited; // keep track of the waiting time + + // Incomplete termcode and not timed out yet: get more characters + if ((n = check_termcode(1, buf, buflen, &len)) < 0 + && (!p_ttimeout || waited * 100L < (p_ttm < 0 ? p_tm : p_ttm))) + continue; + + if (n == KEYLEN_REMOVED) // key code removed + { + if (must_redraw != 0 && !need_wait_return && (State + & (MODE_CMDLINE | MODE_HITRETURN | MODE_ASKMORE)) == 0) + { + // Redrawing was postponed, do it now. + update_screen(0); + setcursor(); // put cursor back where it belongs + } + continue; + } + if (n > 0) // found a termcode: adjust length + len = n; + if (len == 0) // nothing typed yet + continue; + + // Handle modifier and/or special key code. + n = buf[0]; + if (n == K_SPECIAL) + { + n = TO_SPECIAL(buf[1], buf[2]); + if (buf[1] == KS_MODIFIER + || n == K_IGNORE + || (is_mouse_key(n) && n != K_LEFTMOUSE) +#ifdef FEAT_GUI + || n == K_VER_SCROLLBAR + || n == K_HOR_SCROLLBAR +#endif + ) + { + if (buf[1] == KS_MODIFIER) + mod_mask = buf[2]; + len -= 3; + if (len > 0) + mch_memmove(buf, buf + 3, (size_t)len); + continue; + } + break; + } + if (has_mbyte) + { + if (MB_BYTE2LEN(n) > len) + continue; // more bytes to get + buf[len >= buflen ? buflen - 1 : len] = NUL; + n = (*mb_ptr2char)(buf); + } +#ifdef UNIX + if (n == intr_char) + n = ESC; +#endif + break; + } + vim_free(buf); + + mapped_ctrl_c = save_mapped_ctrl_c; + return n; +} + +/* + * Get a number from the user. + * When "mouse_used" is not NULL allow using the mouse. + */ + int +get_number( + int colon, // allow colon to abort + int *mouse_used) +{ + int n = 0; + int c; + int typed = 0; + + if (mouse_used != NULL) + *mouse_used = FALSE; + + // When not printing messages, the user won't know what to type, return a + // zero (as if CR was hit). + if (msg_silent != 0) + return 0; + +#ifdef USE_ON_FLY_SCROLL + dont_scroll = TRUE; // disallow scrolling here +#endif + ++no_mapping; + ++allow_keys; // no mapping here, but recognize keys + for (;;) + { + windgoto(msg_row, msg_col); + c = safe_vgetc(); + if (VIM_ISDIGIT(c)) + { + n = n * 10 + c - '0'; + msg_putchar(c); + ++typed; + } + else if (c == K_DEL || c == K_KDEL || c == K_BS || c == Ctrl_H) + { + if (typed > 0) + { + msg_puts("\b \b"); + --typed; + } + n /= 10; + } + else if (mouse_used != NULL && c == K_LEFTMOUSE) + { + *mouse_used = TRUE; + n = mouse_row + 1; + break; + } + else if (n == 0 && c == ':' && colon) + { + stuffcharReadbuff(':'); + if (!exmode_active) + cmdline_row = msg_row; + skip_redraw = TRUE; // skip redraw once + do_redraw = FALSE; + break; + } + else if (c == Ctrl_C || c == ESC || c == 'q') + { + n = 0; + break; + } + else if (c == CAR || c == NL ) + break; + } + --no_mapping; + --allow_keys; + return n; +} + +/* + * Ask the user to enter a number. + * When "mouse_used" is not NULL allow using the mouse and in that case return + * the line number. + */ + int +prompt_for_number(int *mouse_used) +{ + int i; + int save_cmdline_row; + int save_State; + + // When using ":silent" assume that <CR> was entered. + if (mouse_used != NULL) + msg_puts(_("Type number and <Enter> or click with the mouse (q or empty cancels): ")); + else + msg_puts(_("Type number and <Enter> (q or empty cancels): ")); + + // Set the state such that text can be selected/copied/pasted and we still + // get mouse events. redraw_after_callback() will not redraw if cmdline_row + // is zero. + save_cmdline_row = cmdline_row; + cmdline_row = 0; + save_State = State; + State = MODE_CMDLINE; + // May show different mouse shape. + setmouse(); + + i = get_number(TRUE, mouse_used); + if (KeyTyped) + { + // don't call wait_return() now + if (msg_row > 0) + cmdline_row = msg_row - 1; + need_wait_return = FALSE; + msg_didany = FALSE; + msg_didout = FALSE; + } + else + cmdline_row = save_cmdline_row; + State = save_State; + // May need to restore mouse shape. + setmouse(); + + return i; +} + + void +msgmore(long n) +{ + long pn; + + if (global_busy // no messages now, wait until global is finished + || !messaging()) // 'lazyredraw' set, don't do messages now + return; + + // We don't want to overwrite another important message, but do overwrite + // a previous "more lines" or "fewer lines" message, so that "5dd" and + // then "put" reports the last action. + if (keep_msg != NULL && !keep_msg_more) + return; + + if (n > 0) + pn = n; + else + pn = -n; + + if (pn > p_report) + { + if (n > 0) + vim_snprintf(msg_buf, MSG_BUF_LEN, + NGETTEXT("%ld more line", "%ld more lines", pn), pn); + else + vim_snprintf(msg_buf, MSG_BUF_LEN, + NGETTEXT("%ld line less", "%ld fewer lines", pn), pn); + if (got_int) + vim_strcat((char_u *)msg_buf, (char_u *)_(" (Interrupted)"), + MSG_BUF_LEN); + if (msg(msg_buf)) + { + set_keep_msg((char_u *)msg_buf, 0); + keep_msg_more = TRUE; + } + } +} + +/* + * flush map and typeahead buffers and give a warning for an error + */ + void +beep_flush(void) +{ + if (emsg_silent == 0) + { + flush_buffers(FLUSH_MINIMAL); + vim_beep(BO_ERROR); + } +} + +/* + * Give a warning for an error. "val" is one of the BO_ values, e.g., BO_OPER. + */ + void +vim_beep(unsigned val) +{ +#ifdef FEAT_EVAL + called_vim_beep = TRUE; +#endif + + if (emsg_silent != 0 || in_assert_fails) + return; + + if (!((bo_flags & val) || (bo_flags & BO_ALL))) + { +#ifdef ELAPSED_FUNC + static int did_init = FALSE; + static elapsed_T start_tv; + + // Only beep once per half a second, otherwise a sequence of beeps + // would freeze Vim. + if (!did_init || ELAPSED_FUNC(start_tv) > 500) + { + did_init = TRUE; + ELAPSED_INIT(start_tv); +#endif + if (p_vb +#ifdef FEAT_GUI + // While the GUI is starting up the termcap is set for + // the GUI but the output still goes to a terminal. + && !(gui.in_use && gui.starting) +#endif + ) + { + out_str_cf(T_VB); +#ifdef FEAT_VTP + // No restore color information, refresh the screen. + if (has_vtp_working() != 0 +# ifdef FEAT_TERMGUICOLORS + && (p_tgc || (!p_tgc && t_colors >= 256)) +# endif + ) + { + redraw_later(UPD_CLEAR); + update_screen(0); + redrawcmd(); + } +#endif + } + else + out_char(BELL); +#ifdef ELAPSED_FUNC + } +#endif + } + + // When 'debug' contains "beep" produce a message. If we are sourcing + // a script or executing a function give the user a hint where the beep + // comes from. + if (vim_strchr(p_debug, 'e') != NULL) + { + msg_source(HL_ATTR(HLF_W)); + msg_attr(_("Beep!"), HL_ATTR(HLF_W)); + } +} + +/* + * To get the "real" home directory: + * - get value of $HOME + * For Unix: + * - go to that directory + * - do mch_dirname() to get the real name of that directory. + * This also works with mounts and links. + * Don't do this for MS-DOS, it will change the "current dir" for a drive. + * For Windows: + * This code is duplicated in init_homedir() in dosinst.c. Keep in sync! + */ + void +init_homedir(void) +{ + char_u *var; + + // In case we are called a second time (when 'encoding' changes). + VIM_CLEAR(homedir); + +#ifdef VMS + var = mch_getenv((char_u *)"SYS$LOGIN"); +#else + var = mch_getenv((char_u *)"HOME"); +#endif + +#ifdef MSWIN + /* + * Typically, $HOME is not defined on Windows, unless the user has + * specifically defined it for Vim's sake. However, on Windows NT + * platforms, $HOMEDRIVE and $HOMEPATH are automatically defined for + * each user. Try constructing $HOME from these. + */ + if (var == NULL || *var == NUL) + { + char_u *homedrive, *homepath; + + homedrive = mch_getenv((char_u *)"HOMEDRIVE"); + homepath = mch_getenv((char_u *)"HOMEPATH"); + if (homepath == NULL || *homepath == NUL) + homepath = (char_u *)"\\"; + if (homedrive != NULL + && STRLEN(homedrive) + STRLEN(homepath) < MAXPATHL) + { + sprintf((char *)NameBuff, "%s%s", homedrive, homepath); + if (NameBuff[0] != NUL) + var = NameBuff; + } + } + + if (var == NULL) + var = mch_getenv((char_u *)"USERPROFILE"); + + /* + * Weird but true: $HOME may contain an indirect reference to another + * variable, esp. "%USERPROFILE%". Happens when $USERPROFILE isn't set + * when $HOME is being set. + */ + if (var != NULL && *var == '%') + { + char_u *p; + char_u *exp; + + p = vim_strchr(var + 1, '%'); + if (p != NULL) + { + vim_strncpy(NameBuff, var + 1, p - (var + 1)); + exp = mch_getenv(NameBuff); + if (exp != NULL && *exp != NUL + && STRLEN(exp) + STRLEN(p) < MAXPATHL) + { + vim_snprintf((char *)NameBuff, MAXPATHL, "%s%s", exp, p + 1); + var = NameBuff; + } + } + } + + if (var != NULL && *var == NUL) // empty is same as not set + var = NULL; + + if (enc_utf8 && var != NULL) + { + int len; + char_u *pp = NULL; + + // Convert from active codepage to UTF-8. Other conversions are + // not done, because they would fail for non-ASCII characters. + acp_to_enc(var, (int)STRLEN(var), &pp, &len); + if (pp != NULL) + { + homedir = pp; + return; + } + } + + /* + * Default home dir is C:/ + * Best assumption we can make in such a situation. + */ + if (var == NULL) + var = (char_u *)"C:/"; +#endif + + if (var != NULL) + { +#ifdef UNIX + /* + * Change to the directory and get the actual path. This resolves + * links. Don't do it when we can't return. + */ + if (mch_dirname(NameBuff, MAXPATHL) == OK + && mch_chdir((char *)NameBuff) == 0) + { + if (!mch_chdir((char *)var) && mch_dirname(IObuff, IOSIZE) == OK) + var = IObuff; + if (mch_chdir((char *)NameBuff) != 0) + emsg(_(e_cannot_go_back_to_previous_directory)); + } +#endif + homedir = vim_strsave(var); + } +} + +#if defined(EXITFREE) || defined(PROTO) + void +free_homedir(void) +{ + vim_free(homedir); +} + + void +free_users(void) +{ + ga_clear_strings(&ga_users); +} +#endif + +#if defined(MSWIN) || defined(PROTO) +/* + * Initialize $VIM and $VIMRUNTIME when 'enc' is updated. + */ + void +init_vimdir(void) +{ + int mustfree; + char_u *p; + + mch_get_exe_name(); + + mustfree = FALSE; + didset_vim = FALSE; + p = vim_getenv((char_u *)"VIM", &mustfree); + if (mustfree) + vim_free(p); + + mustfree = FALSE; + didset_vimruntime = FALSE; + p = vim_getenv((char_u *)"VIMRUNTIME", &mustfree); + if (mustfree) + vim_free(p); +} +#endif + +/* + * Call expand_env() and store the result in an allocated string. + * This is not very memory efficient, this expects the result to be freed + * again soon. + */ + char_u * +expand_env_save(char_u *src) +{ + return expand_env_save_opt(src, FALSE); +} + +/* + * Idem, but when "one" is TRUE handle the string as one file name, only + * expand "~" at the start. + */ + char_u * +expand_env_save_opt(char_u *src, int one) +{ + char_u *p; + + p = alloc(MAXPATHL); + if (p != NULL) + expand_env_esc(src, p, MAXPATHL, FALSE, one, NULL); + return p; +} + +/* + * Expand environment variable with path name. + * "~/" is also expanded, using $HOME. For Unix "~user/" is expanded. + * Skips over "\ ", "\~" and "\$" (not for Win32 though). + * If anything fails no expansion is done and dst equals src. + */ + void +expand_env( + char_u *src, // input string e.g. "$HOME/vim.hlp" + char_u *dst, // where to put the result + int dstlen) // maximum length of the result +{ + expand_env_esc(src, dst, dstlen, FALSE, FALSE, NULL); +} + + void +expand_env_esc( + char_u *srcp, // input string e.g. "$HOME/vim.hlp" + char_u *dst, // where to put the result + int dstlen, // maximum length of the result + int esc, // escape spaces in expanded variables + int one, // "srcp" is one file name + char_u *startstr) // start again after this (can be NULL) +{ + char_u *src; + char_u *tail; + int c; + char_u *var; + int copy_char; + int mustfree; // var was allocated, need to free it later + int at_start = TRUE; // at start of a name + int startstr_len = 0; +#if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA) + char_u *save_dst = dst; +#endif + + if (startstr != NULL) + startstr_len = (int)STRLEN(startstr); + + src = skipwhite(srcp); + --dstlen; // leave one char space for "\," + while (*src && dstlen > 0) + { +#ifdef FEAT_EVAL + // Skip over `=expr`. + if (src[0] == '`' && src[1] == '=') + { + size_t len; + + var = src; + src += 2; + (void)skip_expr(&src, NULL); + if (*src == '`') + ++src; + len = src - var; + if (len > (size_t)dstlen) + len = dstlen; + vim_strncpy(dst, var, len); + dst += len; + dstlen -= (int)len; + continue; + } +#endif + copy_char = TRUE; + if ((*src == '$' +#ifdef VMS + && at_start +#endif + ) +#if defined(MSWIN) + || *src == '%' +#endif + || (*src == '~' && at_start)) + { + mustfree = FALSE; + + /* + * The variable name is copied into dst temporarily, because it may + * be a string in read-only memory and a NUL needs to be appended. + */ + if (*src != '~') // environment var + { + tail = src + 1; + var = dst; + c = dstlen - 1; + +#ifdef UNIX + // Unix has ${var-name} type environment vars + if (*tail == '{' && !vim_isIDc('{')) + { + tail++; // ignore '{' + while (c-- > 0 && *tail && *tail != '}') + *var++ = *tail++; + } + else +#endif + { + while (c-- > 0 && *tail != NUL && ((vim_isIDc(*tail)) +#if defined(MSWIN) + || (*src == '%' && *tail != '%') +#endif + )) + *var++ = *tail++; + } + +#if defined(MSWIN) || defined(UNIX) +# ifdef UNIX + if (src[1] == '{' && *tail != '}') +# else + if (*src == '%' && *tail != '%') +# endif + var = NULL; + else + { +# ifdef UNIX + if (src[1] == '{') +# else + if (*src == '%') +#endif + ++tail; +#endif + *var = NUL; + var = vim_getenv(dst, &mustfree); +#if defined(MSWIN) || defined(UNIX) + } +#endif + } + // home directory + else if ( src[1] == NUL + || vim_ispathsep(src[1]) + || vim_strchr((char_u *)" ,\t\n", src[1]) != NULL) + { + var = homedir; + tail = src + 1; + } + else // user directory + { +#if defined(UNIX) || (defined(VMS) && defined(USER_HOME)) + /* + * Copy ~user to dst[], so we can put a NUL after it. + */ + tail = src; + var = dst; + c = dstlen - 1; + while ( c-- > 0 + && *tail + && vim_isfilec(*tail) + && !vim_ispathsep(*tail)) + *var++ = *tail++; + *var = NUL; +# ifdef UNIX + /* + * If the system supports getpwnam(), use it. + * Otherwise, or if getpwnam() fails, the shell is used to + * expand ~user. This is slower and may fail if the shell + * does not support ~user (old versions of /bin/sh). + */ +# if defined(HAVE_GETPWNAM) && defined(HAVE_PWD_H) + { + // Note: memory allocated by getpwnam() is never freed. + // Calling endpwent() apparently doesn't help. + struct passwd *pw = (*dst == NUL) + ? NULL : getpwnam((char *)dst + 1); + + var = (pw == NULL) ? NULL : (char_u *)pw->pw_dir; + } + if (var == NULL) +# endif + { + expand_T xpc; + + ExpandInit(&xpc); + xpc.xp_context = EXPAND_FILES; + var = ExpandOne(&xpc, dst, NULL, + WILD_ADD_SLASH|WILD_SILENT, WILD_EXPAND_FREE); + mustfree = TRUE; + } + +# else // !UNIX, thus VMS + /* + * USER_HOME is a comma-separated list of + * directories to search for the user account in. + */ + { + char_u test[MAXPATHL], paths[MAXPATHL]; + char_u *path, *next_path, *ptr; + stat_T st; + + STRCPY(paths, USER_HOME); + next_path = paths; + while (*next_path) + { + for (path = next_path; *next_path && *next_path != ','; + next_path++); + if (*next_path) + *next_path++ = NUL; + STRCPY(test, path); + STRCAT(test, "/"); + STRCAT(test, dst + 1); + if (mch_stat(test, &st) == 0) + { + var = alloc(STRLEN(test) + 1); + STRCPY(var, test); + mustfree = TRUE; + break; + } + } + } +# endif // UNIX +#else + // cannot expand user's home directory, so don't try + var = NULL; + tail = (char_u *)""; // for gcc +#endif // UNIX || VMS + } + +#ifdef BACKSLASH_IN_FILENAME + // If 'shellslash' is set change backslashes to forward slashes. + // Can't use slash_adjust(), p_ssl may be set temporarily. + if (p_ssl && var != NULL && vim_strchr(var, '\\') != NULL) + { + char_u *p = vim_strsave(var); + + if (p != NULL) + { + if (mustfree) + vim_free(var); + var = p; + mustfree = TRUE; + forward_slash(var); + } + } +#endif + + // If "var" contains white space, escape it with a backslash. + // Required for ":e ~/tt" when $HOME includes a space. + if (esc && var != NULL && vim_strpbrk(var, (char_u *)" \t") != NULL) + { + char_u *p = vim_strsave_escaped(var, (char_u *)" \t"); + + if (p != NULL) + { + if (mustfree) + vim_free(var); + var = p; + mustfree = TRUE; + } + } + + if (var != NULL && *var != NUL + && (STRLEN(var) + STRLEN(tail) + 1 < (unsigned)dstlen)) + { + STRCPY(dst, var); + dstlen -= (int)STRLEN(var); + c = (int)STRLEN(var); + // if var[] ends in a path separator and tail[] starts + // with it, skip a character + if (after_pathsep(dst, dst + c) +#if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA) + && (dst == save_dst || dst[-1] != ':') +#endif + && vim_ispathsep(*tail)) + ++tail; + dst += c; + src = tail; + copy_char = FALSE; + } + if (mustfree) + vim_free(var); + } + + if (copy_char) // copy at least one char + { + /* + * Recognize the start of a new name, for '~'. + * Don't do this when "one" is TRUE, to avoid expanding "~" in + * ":edit foo ~ foo". + */ + at_start = FALSE; + if (src[0] == '\\' && src[1] != NUL) + { + *dst++ = *src++; + --dstlen; + } + else if ((src[0] == ' ' || src[0] == ',') && !one) + at_start = TRUE; + if (dstlen > 0) + { + *dst++ = *src++; + --dstlen; + + if (startstr != NULL && src - startstr_len >= srcp + && STRNCMP(src - startstr_len, startstr, + startstr_len) == 0) + at_start = TRUE; + } + } + + } + *dst = NUL; +} + +/* + * If the string between "p" and "pend" ends in "name/", return "pend" minus + * the length of "name/". Otherwise return "pend". + */ + static char_u * +remove_tail(char_u *p, char_u *pend, char_u *name) +{ + int len = (int)STRLEN(name) + 1; + char_u *newend = pend - len; + + if (newend >= p + && fnamencmp(newend, name, len - 1) == 0 + && (newend == p || after_pathsep(p, newend))) + return newend; + return pend; +} + +/* + * Check if the directory "vimdir/<version>" or "vimdir/runtime" exists. + * Return NULL if not, return its name in allocated memory otherwise. + */ + static char_u * +vim_version_dir(char_u *vimdir) +{ + char_u *p; + + if (vimdir == NULL || *vimdir == NUL) + return NULL; + p = concat_fnames(vimdir, (char_u *)VIM_VERSION_NODOT, TRUE); + if (p != NULL && mch_isdir(p)) + return p; + vim_free(p); + p = concat_fnames(vimdir, (char_u *)RUNTIME_DIRNAME, TRUE); + if (p != NULL && mch_isdir(p)) + { + char_u *fname = concat_fnames(p, (char_u *)"defaults.vim", TRUE); + + // Check that "defaults.vim" exists in this directory, to avoid picking + // up a stray "runtime" directory, it would make many tests fail in + // mysterious ways. + if (fname != NULL) + { + int exists = file_is_readable(fname); + + vim_free(fname); + if (exists) + return p; + } + } + vim_free(p); + return NULL; +} + +/* + * Vim's version of getenv(). + * Special handling of $HOME, $VIM and $VIMRUNTIME. + * Also does ACP to 'enc' conversion for Win32. + * "mustfree" is set to TRUE when the returned string is allocated. It must be + * initialized to FALSE by the caller. + */ + char_u * +vim_getenv(char_u *name, int *mustfree) +{ + char_u *p = NULL; + char_u *pend; + int vimruntime; +#ifdef MSWIN + WCHAR *wn, *wp; + + // use "C:/" when $HOME is not set + if (STRCMP(name, "HOME") == 0) + return homedir; + + // Use Wide function + wn = enc_to_utf16(name, NULL); + if (wn == NULL) + return NULL; + + wp = _wgetenv(wn); + vim_free(wn); + + if (wp != NULL && *wp == NUL) // empty is the same as not set + wp = NULL; + + if (wp != NULL) + { + p = utf16_to_enc(wp, NULL); + if (p == NULL) + return NULL; + + *mustfree = TRUE; + return p; + } +#else + p = mch_getenv(name); + if (p != NULL && *p == NUL) // empty is the same as not set + p = NULL; + + if (p != NULL) + return p; + +# ifdef __HAIKU__ + // special handling for user settings directory... + if (STRCMP(name, "BE_USER_SETTINGS") == 0) + { + static char userSettingsPath[MAXPATHL]; + + if (find_directory(B_USER_SETTINGS_DIRECTORY, 0, false, + userSettingsPath, MAXPATHL) == B_OK) + return (char_u *)userSettingsPath; + else + return NULL; + } +# endif +#endif + + // handling $VIMRUNTIME and $VIM is below, bail out if it's another name. + vimruntime = (STRCMP(name, "VIMRUNTIME") == 0); + if (!vimruntime && STRCMP(name, "VIM") != 0) + return NULL; + + /* + * When expanding $VIMRUNTIME fails, try using $VIM/vim<version> or $VIM. + * Don't do this when default_vimruntime_dir is non-empty. + */ + if (vimruntime +#ifdef HAVE_PATHDEF + && *default_vimruntime_dir == NUL +#endif + ) + { +#ifdef MSWIN + // Use Wide function + wp = _wgetenv(L"VIM"); + if (wp != NULL && *wp == NUL) // empty is the same as not set + wp = NULL; + if (wp != NULL) + { + char_u *q = utf16_to_enc(wp, NULL); + if (q != NULL) + { + p = vim_version_dir(q); + *mustfree = TRUE; + if (p == NULL) + p = q; + } + } +#else + p = mch_getenv((char_u *)"VIM"); + if (p != NULL && *p == NUL) // empty is the same as not set + p = NULL; + if (p != NULL) + { + p = vim_version_dir(p); + if (p != NULL) + *mustfree = TRUE; + else + p = mch_getenv((char_u *)"VIM"); + } +#endif + } + + /* + * When expanding $VIM or $VIMRUNTIME fails, try using: + * - the directory name from 'helpfile' (unless it contains '$') + * - the executable name from argv[0] + */ + if (p == NULL) + { + if (p_hf != NULL && vim_strchr(p_hf, '$') == NULL) + p = p_hf; +#ifdef USE_EXE_NAME + /* + * Use the name of the executable, obtained from argv[0]. + */ + else + p = exe_name; +#endif + if (p != NULL) + { + // remove the file name + pend = gettail(p); + + // remove "doc/" from 'helpfile', if present + if (p == p_hf) + pend = remove_tail(p, pend, (char_u *)"doc"); + +#ifdef USE_EXE_NAME +# ifdef MACOS_X + // remove "MacOS" from exe_name and add "Resources/vim" + if (p == exe_name) + { + char_u *pend1; + char_u *pnew; + + pend1 = remove_tail(p, pend, (char_u *)"MacOS"); + if (pend1 != pend) + { + pnew = alloc(pend1 - p + 15); + if (pnew != NULL) + { + STRNCPY(pnew, p, (pend1 - p)); + STRCPY(pnew + (pend1 - p), "Resources/vim"); + p = pnew; + pend = p + STRLEN(p); + } + } + } +# endif + // remove "src/" from exe_name, if present + if (p == exe_name) + pend = remove_tail(p, pend, (char_u *)"src"); +#endif + + // for $VIM, remove "runtime/" or "vim54/", if present + if (!vimruntime) + { + pend = remove_tail(p, pend, (char_u *)RUNTIME_DIRNAME); + pend = remove_tail(p, pend, (char_u *)VIM_VERSION_NODOT); + } + + // remove trailing path separator + if (pend > p && after_pathsep(p, pend)) + --pend; + +#ifdef MACOS_X + if (p == exe_name || p == p_hf) +#endif + // check that the result is a directory name + p = vim_strnsave(p, pend - p); + + if (p != NULL && !mch_isdir(p)) + VIM_CLEAR(p); + else + { +#ifdef USE_EXE_NAME + // may add "/vim54" or "/runtime" if it exists + if (vimruntime && (pend = vim_version_dir(p)) != NULL) + { + vim_free(p); + p = pend; + } +#endif + *mustfree = TRUE; + } + } + } + +#ifdef HAVE_PATHDEF + // When there is a pathdef.c file we can use default_vim_dir and + // default_vimruntime_dir + if (p == NULL) + { + // Only use default_vimruntime_dir when it is not empty + if (vimruntime && *default_vimruntime_dir != NUL) + { + p = default_vimruntime_dir; + *mustfree = FALSE; + } + else if (*default_vim_dir != NUL) + { + if (vimruntime && (p = vim_version_dir(default_vim_dir)) != NULL) + *mustfree = TRUE; + else + { + p = default_vim_dir; + *mustfree = FALSE; + } + } + } +#endif + + /* + * Set the environment variable, so that the new value can be found fast + * next time, and others can also use it (e.g. Perl). + */ + if (p != NULL) + { + if (vimruntime) + { + vim_setenv((char_u *)"VIMRUNTIME", p); + didset_vimruntime = TRUE; + } + else + { + vim_setenv((char_u *)"VIM", p); + didset_vim = TRUE; + } + } + return p; +} + + void +vim_unsetenv(char_u *var) +{ +#ifdef HAVE_UNSETENV + unsetenv((char *)var); +#else + vim_setenv(var, (char_u *)""); +#endif +} + +/* + * Removes environment variable "name" and take care of side effects. + */ + void +vim_unsetenv_ext(char_u *var) +{ + vim_unsetenv(var); + + // "homedir" is not cleared, keep using the old value until $HOME is set. + if (STRICMP(var, "VIM") == 0) + didset_vim = FALSE; + else if (STRICMP(var, "VIMRUNTIME") == 0) + didset_vimruntime = FALSE; +} + +#if defined(FEAT_EVAL) || defined(PROTO) +/* + * Set environment variable "name" and take care of side effects. + */ + void +vim_setenv_ext(char_u *name, char_u *val) +{ + vim_setenv(name, val); + if (STRICMP(name, "HOME") == 0) + init_homedir(); + else if (didset_vim && STRICMP(name, "VIM") == 0) + didset_vim = FALSE; + else if (didset_vimruntime && STRICMP(name, "VIMRUNTIME") == 0) + didset_vimruntime = FALSE; +} +#endif + +/* + * Our portable version of setenv. + */ + void +vim_setenv(char_u *name, char_u *val) +{ +#ifdef HAVE_SETENV + mch_setenv((char *)name, (char *)val, 1); +#else + char_u *envbuf; + + /* + * Putenv does not copy the string, it has to remain + * valid. The allocated memory will never be freed. + */ + envbuf = alloc(STRLEN(name) + STRLEN(val) + 2); + if (envbuf != NULL) + { + sprintf((char *)envbuf, "%s=%s", name, val); + putenv((char *)envbuf); + } +#endif +#ifdef FEAT_GETTEXT + /* + * When setting $VIMRUNTIME adjust the directory to find message + * translations to $VIMRUNTIME/lang. + */ + if (*val != NUL && STRICMP(name, "VIMRUNTIME") == 0) + { + char_u *buf = concat_str(val, (char_u *)"/lang"); + + if (buf != NULL) + { + bindtextdomain(VIMPACKAGE, (char *)buf); + vim_free(buf); + } + } +#endif +} + +/* + * Function given to ExpandGeneric() to obtain an environment variable name. + */ + char_u * +get_env_name( + expand_T *xp UNUSED, + int idx) +{ +#if defined(AMIGA) + // No environ[] on the Amiga. + return NULL; +#else +# ifndef __WIN32__ + // Borland C++ 5.2 has this in a header file. + extern char **environ; +# endif + char_u *str; + int n; + + str = (char_u *)environ[idx]; + if (str == NULL) + return NULL; + + for (n = 0; n < EXPAND_BUF_LEN - 1; ++n) + { + if (str[n] == '=' || str[n] == NUL) + break; + xp->xp_buf[n] = str[n]; + } + xp->xp_buf[n] = NUL; + return xp->xp_buf; +#endif +} + +/* + * Add a user name to the list of users in ga_users. + * Do nothing if user name is NULL or empty. + */ + static void +add_user(char_u *user, int need_copy) +{ + char_u *user_copy = (user != NULL && need_copy) + ? vim_strsave(user) : user; + + if (user_copy == NULL || *user_copy == NUL || ga_grow(&ga_users, 1) == FAIL) + { + if (need_copy) + vim_free(user); + return; + } + ((char_u **)(ga_users.ga_data))[ga_users.ga_len++] = user_copy; +} + +/* + * Find all user names for user completion. + * Done only once and then cached. + */ + static void +init_users(void) +{ + static int lazy_init_done = FALSE; + + if (lazy_init_done) + return; + + lazy_init_done = TRUE; + ga_init2(&ga_users, sizeof(char_u *), 20); + +# if defined(HAVE_GETPWENT) && defined(HAVE_PWD_H) + { + struct passwd* pw; + + setpwent(); + while ((pw = getpwent()) != NULL) + add_user((char_u *)pw->pw_name, TRUE); + endpwent(); + } +# elif defined(MSWIN) + { + DWORD nusers = 0, ntotal = 0, i; + PUSER_INFO_0 uinfo; + + if (NetUserEnum(NULL, 0, 0, (LPBYTE *) &uinfo, MAX_PREFERRED_LENGTH, + &nusers, &ntotal, NULL) == NERR_Success) + { + for (i = 0; i < nusers; i++) + add_user(utf16_to_enc(uinfo[i].usri0_name, NULL), FALSE); + + NetApiBufferFree(uinfo); + } + } +# endif +# if defined(HAVE_GETPWNAM) + { + char_u *user_env = mch_getenv((char_u *)"USER"); + + // The $USER environment variable may be a valid remote user name (NIS, + // LDAP) not already listed by getpwent(), as getpwent() only lists + // local user names. If $USER is not already listed, check whether it + // is a valid remote user name using getpwnam() and if it is, add it to + // the list of user names. + + if (user_env != NULL && *user_env != NUL) + { + int i; + + for (i = 0; i < ga_users.ga_len; i++) + { + char_u *local_user = ((char_u **)ga_users.ga_data)[i]; + + if (STRCMP(local_user, user_env) == 0) + break; + } + + if (i == ga_users.ga_len) + { + struct passwd *pw = getpwnam((char *)user_env); + + if (pw != NULL) + add_user((char_u *)pw->pw_name, TRUE); + } + } + } +# endif +} + +/* + * Function given to ExpandGeneric() to obtain an user names. + */ + char_u* +get_users(expand_T *xp UNUSED, int idx) +{ + init_users(); + if (idx < ga_users.ga_len) + return ((char_u **)ga_users.ga_data)[idx]; + return NULL; +} + +/* + * Check whether name matches a user name. Return: + * 0 if name does not match any user name. + * 1 if name partially matches the beginning of a user name. + * 2 is name fully matches a user name. + */ + int +match_user(char_u *name) +{ + int i; + int n = (int)STRLEN(name); + int result = 0; + + init_users(); + for (i = 0; i < ga_users.ga_len; i++) + { + if (STRCMP(((char_u **)ga_users.ga_data)[i], name) == 0) + return 2; // full match + if (STRNCMP(((char_u **)ga_users.ga_data)[i], name, n) == 0) + result = 1; // partial match + } + return result; +} + + static void +prepare_to_exit(void) +{ +#if defined(SIGHUP) && defined(SIG_IGN) + // Ignore SIGHUP, because a dropped connection causes a read error, which + // makes Vim exit and then handling SIGHUP causes various reentrance + // problems. + signal(SIGHUP, SIG_IGN); +#endif + +#ifdef FEAT_GUI + if (gui.in_use) + { + gui.dying = TRUE; + out_trash(); // trash any pending output + } + else +#endif + { + windgoto((int)Rows - 1, 0); + + /* + * Switch terminal mode back now, so messages end up on the "normal" + * screen (if there are two screens). + */ + settmode(TMODE_COOK); + stoptermcap(); + out_flush(); + } +} + +/* + * Preserve files and exit. + * When called IObuff must contain a message. + * NOTE: This may be called from deathtrap() in a signal handler, avoid unsafe + * functions, such as allocating memory. + */ + void +preserve_exit(void) +{ + buf_T *buf; + + prepare_to_exit(); + + // Setting this will prevent free() calls. That avoids calling free() + // recursively when free() was invoked with a bad pointer. + really_exiting = TRUE; + + out_str(IObuff); + screen_start(); // don't know where cursor is now + out_flush(); + + ml_close_notmod(); // close all not-modified buffers + + FOR_ALL_BUFFERS(buf) + { + if (buf->b_ml.ml_mfp != NULL && buf->b_ml.ml_mfp->mf_fname != NULL) + { + OUT_STR("Vim: preserving files...\r\n"); + screen_start(); // don't know where cursor is now + out_flush(); + ml_sync_all(FALSE, FALSE); // preserve all swap files + break; + } + } + + ml_close_all(FALSE); // close all memfiles, without deleting + + OUT_STR("Vim: Finished.\r\n"); + + getout(1); +} + +/* + * Check for CTRL-C pressed, but only once in a while. + * Should be used instead of ui_breakcheck() for functions that check for + * each line in the file. Calling ui_breakcheck() each time takes too much + * time, because it can be a system call. + */ + +#ifndef BREAKCHECK_SKIP +# define BREAKCHECK_SKIP 1000 +#endif + +static int breakcheck_count = 0; + + void +line_breakcheck(void) +{ + if (++breakcheck_count >= BREAKCHECK_SKIP) + { + breakcheck_count = 0; + ui_breakcheck(); + } +} + +/* + * Like line_breakcheck() but check 10 times less often. + */ + void +fast_breakcheck(void) +{ + if (++breakcheck_count >= BREAKCHECK_SKIP * 10) + { + breakcheck_count = 0; + ui_breakcheck(); + } +} + +# if defined(FEAT_SPELL) || defined(PROTO) +/* + * Like line_breakcheck() but check 100 times less often. + */ + void +veryfast_breakcheck(void) +{ + if (++breakcheck_count >= BREAKCHECK_SKIP * 100) + { + breakcheck_count = 0; + ui_breakcheck(); + } +} +#endif + +#if defined(VIM_BACKTICK) || defined(FEAT_EVAL) \ + || (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \ + || defined(PROTO) + +#ifndef SEEK_SET +# define SEEK_SET 0 +#endif +#ifndef SEEK_END +# define SEEK_END 2 +#endif + +/* + * Get the stdout of an external command. + * If "ret_len" is NULL replace NUL characters with NL. When "ret_len" is not + * NULL store the length there. + * Returns an allocated string, or NULL for error. + */ + char_u * +get_cmd_output( + char_u *cmd, + char_u *infile, // optional input file name + int flags, // can be SHELL_SILENT + int *ret_len) +{ + char_u *tempname; + char_u *command; + char_u *buffer = NULL; + int len; + int i = 0; + FILE *fd; + + if (check_restricted() || check_secure()) + return NULL; + + // get a name for the temp file + if ((tempname = vim_tempname('o', FALSE)) == NULL) + { + emsg(_(e_cant_get_temp_file_name)); + return NULL; + } + + // Add the redirection stuff + command = make_filter_cmd(cmd, infile, tempname); + if (command == NULL) + goto done; + + /* + * Call the shell to execute the command (errors are ignored). + * Don't check timestamps here. + */ + ++no_check_timestamps; + call_shell(command, SHELL_DOOUT | SHELL_EXPAND | flags); + --no_check_timestamps; + + vim_free(command); + + /* + * read the names from the file into memory + */ +# ifdef VMS + // created temporary file is not always readable as binary + fd = mch_fopen((char *)tempname, "r"); +# else + fd = mch_fopen((char *)tempname, READBIN); +# endif + + // Not being able to seek means we can't read the file. + if (fd == NULL + || fseek(fd, 0L, SEEK_END) == -1 + || (len = ftell(fd)) == -1 // get size of temp file + || fseek(fd, 0L, SEEK_SET) == -1) // back to the start + { + semsg(_(e_cannot_read_from_str_2), tempname); + if (fd != NULL) + fclose(fd); + goto done; + } + + buffer = alloc(len + 1); + if (buffer != NULL) + i = (int)fread((char *)buffer, (size_t)1, (size_t)len, fd); + fclose(fd); + mch_remove(tempname); + if (buffer == NULL) + goto done; +#ifdef VMS + len = i; // VMS doesn't give us what we asked for... +#endif + if (i != len) + { + semsg(_(e_cant_read_file_str), tempname); + VIM_CLEAR(buffer); + } + else if (ret_len == NULL) + { + // Change NUL into SOH, otherwise the string is truncated. + for (i = 0; i < len; ++i) + if (buffer[i] == NUL) + buffer[i] = 1; + + buffer[len] = NUL; // make sure the buffer is terminated + } + else + *ret_len = len; + +done: + vim_free(tempname); + return buffer; +} + +# if defined(FEAT_EVAL) || defined(PROTO) + + static void +get_cmd_output_as_rettv( + typval_T *argvars, + typval_T *rettv, + int retlist) +{ + char_u *res = NULL; + char_u *p; + char_u *infile = NULL; + int err = FALSE; + FILE *fd; + list_T *list = NULL; + int flags = SHELL_SILENT; + + rettv->v_type = VAR_STRING; + rettv->vval.v_string = NULL; + if (check_restricted() || check_secure()) + goto errret; + + if (in_vim9script() + && (check_for_string_arg(argvars, 0) == FAIL + || check_for_opt_string_or_number_or_list_arg(argvars, 1) + == FAIL)) + return; + + if (argvars[1].v_type != VAR_UNKNOWN) + { + /* + * Write the text to a temp file, to be used for input of the shell + * command. + */ + if ((infile = vim_tempname('i', TRUE)) == NULL) + { + emsg(_(e_cant_get_temp_file_name)); + goto errret; + } + + fd = mch_fopen((char *)infile, WRITEBIN); + if (fd == NULL) + { + semsg(_(e_cant_open_file_str), infile); + goto errret; + } + if (argvars[1].v_type == VAR_NUMBER) + { + linenr_T lnum; + buf_T *buf; + + buf = buflist_findnr(argvars[1].vval.v_number); + if (buf == NULL) + { + semsg(_(e_buffer_nr_does_not_exist), argvars[1].vval.v_number); + fclose(fd); + goto errret; + } + + for (lnum = 1; lnum <= buf->b_ml.ml_line_count; lnum++) + { + for (p = ml_get_buf(buf, lnum, FALSE); *p != NUL; ++p) + if (putc(*p == '\n' ? NUL : *p, fd) == EOF) + { + err = TRUE; + break; + } + if (putc(NL, fd) == EOF) + { + err = TRUE; + break; + } + } + } + else if (argvars[1].v_type == VAR_LIST) + { + if (write_list(fd, argvars[1].vval.v_list, TRUE) == FAIL) + err = TRUE; + } + else + { + size_t len; + char_u buf[NUMBUFLEN]; + + p = tv_get_string_buf_chk(&argvars[1], buf); + if (p == NULL) + { + fclose(fd); + goto errret; // type error; errmsg already given + } + len = STRLEN(p); + if (len > 0 && fwrite(p, len, 1, fd) != 1) + err = TRUE; + } + if (fclose(fd) != 0) + err = TRUE; + if (err) + { + emsg(_(e_error_writing_temp_file)); + goto errret; + } + } + + // Omit SHELL_COOKED when invoked with ":silent". Avoids that the shell + // echoes typeahead, that messes up the display. + if (!msg_silent) + flags += SHELL_COOKED; + + if (retlist) + { + int len; + listitem_T *li; + char_u *s = NULL; + char_u *start; + char_u *end; + int i; + + res = get_cmd_output(tv_get_string(&argvars[0]), infile, flags, &len); + if (res == NULL) + goto errret; + + list = list_alloc(); + if (list == NULL) + goto errret; + + for (i = 0; i < len; ++i) + { + start = res + i; + while (i < len && res[i] != NL) + ++i; + end = res + i; + + s = alloc(end - start + 1); + if (s == NULL) + goto errret; + + for (p = s; start < end; ++p, ++start) + *p = *start == NUL ? NL : *start; + *p = NUL; + + li = listitem_alloc(); + if (li == NULL) + { + vim_free(s); + goto errret; + } + li->li_tv.v_type = VAR_STRING; + li->li_tv.v_lock = 0; + li->li_tv.vval.v_string = s; + list_append(list, li); + } + + rettv_list_set(rettv, list); + list = NULL; + } + else + { + res = get_cmd_output(tv_get_string(&argvars[0]), infile, flags, NULL); +#ifdef USE_CRNL + // translate <CR><NL> into <NL> + if (res != NULL) + { + char_u *s, *d; + + d = res; + for (s = res; *s; ++s) + { + if (s[0] == CAR && s[1] == NL) + ++s; + *d++ = *s; + } + *d = NUL; + } +#endif + rettv->vval.v_string = res; + res = NULL; + } + +errret: + if (infile != NULL) + { + mch_remove(infile); + vim_free(infile); + } + if (res != NULL) + vim_free(res); + if (list != NULL) + list_free(list); +} + +/* + * "system()" function + */ + void +f_system(typval_T *argvars, typval_T *rettv) +{ + get_cmd_output_as_rettv(argvars, rettv, FALSE); +} + +/* + * "systemlist()" function + */ + void +f_systemlist(typval_T *argvars, typval_T *rettv) +{ + get_cmd_output_as_rettv(argvars, rettv, TRUE); +} +# endif // FEAT_EVAL + +#endif + +/* + * Return TRUE when need to go to Insert mode because of 'insertmode'. + * Don't do this when still processing a command or a mapping. + * Don't do this when inside a ":normal" command. + */ + int +goto_im(void) +{ + return (p_im && stuff_empty() && typebuf_typed()); +} + +/* + * Returns the isolated name of the shell in allocated memory: + * - Skip beyond any path. E.g., "/usr/bin/csh -f" -> "csh -f". + * - Remove any argument. E.g., "csh -f" -> "csh". + * But don't allow a space in the path, so that this works: + * "/usr/bin/csh --rcfile ~/.cshrc" + * But don't do that for Windows, it's common to have a space in the path. + * Returns NULL when out of memory. + */ + char_u * +get_isolated_shell_name(void) +{ + char_u *p; + +#ifdef MSWIN + p = gettail(p_sh); + p = vim_strnsave(p, skiptowhite(p) - p); +#else + p = skiptowhite(p_sh); + if (*p == NUL) + { + // No white space, use the tail. + p = vim_strsave(gettail(p_sh)); + } + else + { + char_u *p1, *p2; + + // Find the last path separator before the space. + p1 = p_sh; + for (p2 = p_sh; p2 < p; MB_PTR_ADV(p2)) + if (vim_ispathsep(*p2)) + p1 = p2 + 1; + p = vim_strnsave(p1, p - p1); + } +#endif + return p; +} + +/* + * Check if the "://" of a URL is at the pointer, return URL_SLASH. + * Also check for ":\\", which MS Internet Explorer accepts, return + * URL_BACKSLASH. + */ + int +path_is_url(char_u *p) +{ + if (STRNCMP(p, "://", (size_t)3) == 0) + return URL_SLASH; + else if (STRNCMP(p, ":\\\\", (size_t)3) == 0) + return URL_BACKSLASH; + return 0; +} + +/* + * Check if "fname" starts with "name://" or "name:\\". + * Return URL_SLASH for "name://", URL_BACKSLASH for "name:\\". + * Return zero otherwise. + */ + int +path_with_url(char_u *fname) +{ + char_u *p; + + // We accept alphabetic characters and a dash in scheme part. + // RFC 3986 allows for more, but it increases the risk of matching + // non-URL text. + + // first character must be alpha + if (!ASCII_ISALPHA(*fname)) + return 0; + + // check body: alpha or dash + for (p = fname + 1; (ASCII_ISALPHA(*p) || (*p == '-')); ++p) + ; + + // check last char is not a dash + if (p[-1] == '-') + return 0; + + // "://" or ":\\" must follow + return path_is_url(p); +} + +#if defined(FEAT_EVAL) || defined(PROTO) +/* + * Return the dictionary of v:event. + * Save and clear the value in case it already has items. + */ + dict_T * +get_v_event(save_v_event_T *sve) +{ + dict_T *v_event = get_vim_var_dict(VV_EVENT); + + if (v_event->dv_hashtab.ht_used > 0) + { + // recursive use of v:event, save, make empty and restore later + sve->sve_did_save = TRUE; + sve->sve_hashtab = v_event->dv_hashtab; + hash_init(&v_event->dv_hashtab); + } + else + sve->sve_did_save = FALSE; + return v_event; +} + + void +restore_v_event(dict_T *v_event, save_v_event_T *sve) +{ + dict_free_contents(v_event); + if (sve->sve_did_save) + v_event->dv_hashtab = sve->sve_hashtab; + else + hash_init(&v_event->dv_hashtab); +} +#endif + +/* + * Fires a ModeChanged autocmd event if appropriate. + */ + void +may_trigger_modechanged(void) +{ +#ifdef FEAT_EVAL + dict_T *v_event; + save_v_event_T save_v_event; + char_u curr_mode[MODE_MAX_LENGTH]; + char_u pattern_buf[2 * MODE_MAX_LENGTH]; + + // Skip this when got_int is set, the autocommand will not be executed. + // Better trigger it next time. + if (!has_modechanged() || got_int) + return; + + get_mode(curr_mode); + if (STRCMP(curr_mode, last_mode) == 0) + return; + + v_event = get_v_event(&save_v_event); + (void)dict_add_string(v_event, "new_mode", curr_mode); + (void)dict_add_string(v_event, "old_mode", last_mode); + dict_set_items_ro(v_event); + + // concatenate modes in format "old_mode:new_mode" + vim_snprintf((char *)pattern_buf, sizeof(pattern_buf), "%s:%s", last_mode, + curr_mode); + + apply_autocmds(EVENT_MODECHANGED, pattern_buf, NULL, FALSE, curbuf); + STRCPY(last_mode, curr_mode); + + restore_v_event(v_event, &save_v_event); +#endif +} |