[英]How does Vim guess background color on xterm?
Vim has the ability to correctly guess the background color of an Xterm in order to set its internal option bg
to either dark
or white
according to the terminal's one. Vim能够正确猜测Xterm的背景颜色,以便根据终端的选项将其内部选项
bg
设置为dark
或white
。 Vim is able to do that correctly only when TERM
is set to either xterm
{, -color
, -256color
} or linux
but no others like tmux
or screen
. 如果Vim能够正确地仅做
TERM
被设置为xterm
{, -color
, -256color
}或linux
,但没有其他人一样tmux
或screen
。
How does Vim to guess that? Vim如何猜测?
I've found that most people forces setting up the background
option to either dark
or light
in their .vimrc
file; 我发现大多数人都强制在
.vimrc
文件中将background
选项设置为dark
或light
; but I'd like a way to guess the same way Vim does, independently of the terminal being xterm
, tmux
, screen
. 但是我想要一种方式来猜测Vim的方式,与终端是
xterm
, tmux
, screen
无关。
The default setting is defined (hard-coded) in Vim source code (written in the C programming language). 默认设置在Vim源代码中定义(硬编码)(用C编程语言编写)。 There was a fix to not use "dark" in GUI variants of Vim with "linux" TERM since version 6.1.136, and it helps me to find actual code:
自版本6.1.136以来,修复了不使用Vim的GUI变体和“linux”TERM的“黑暗”,它帮助我找到实际的代码:
http://ftp.twaren.net/vim/patches/6.1.136 http://ftp.twaren.net/vim/patches/6.1.136
Patch 6.1.136
Problem: When $TERM is "linux" the default for 'background' is "dark", even
though the GUI uses a light background. (Hugh Allen)
Solution: Don't mark the option as set when defaulting to "dark" for the
linux console. Also reset 'background' to "light" when the GUI
has a light background.
Files: src/option.c
The logic is here, default values: https://fossies.org/dox/vim-7.4/option_8c_source.html#l00566 逻辑在这里,默认值: https : //fossies.org/dox/vim-7.4/option_8c_source.html#l00566
563 {"background", "bg", P_STRING|P_VI_DEF|P_RCLR,
564 (char_u *)&p_bg, PV_NONE,
565 {
566 #if (defined(MSDOS) || defined(OS2) || defined(WIN3264)) && !defined(FEAT_GUI)
567 (char_u *)"dark",
568 #else
569 (char_u *)"light",
570 #endif
Detect terminal background: https://fossies.org/dox/vim-7.4/option_8c_source.html#l03754 检测终端背景: https : //fossies.org/dox/vim-7.4/option_8c_source.html#l03754
3725 /* For DOS console the default is always black. */
3726 #if !((defined(MSDOS) || defined(OS2) || defined(WIN3264)) && !defined(FEAT_GUI))
3727 /*
3728 * If 'background' wasn't set by the user, try guessing the value,
3729 * depending on the terminal name. Only need to check for terminals
3730 * with a dark background, that can handle color.
3731 */
3732 idx = findoption((char_u *)"bg");
3733 if (idx >= 0 && !(options[idx].flags & P_WAS_SET)
3734 && *term_bg_default() == 'd')
3735 {
3736 set_string_option_direct(NULL, idx, (char_u *)"dark", OPT_FREE, 0);
3737 /* don't mark it as set, when starting the GUI it may be
3738 * changed again */
3739 options[idx].flags &= ~P_WAS_SET;
3740 }
3741 #endif
3754 /*
3755 * Return "dark" or "light" depending on the kind of terminal.
3756 * This is just guessing! Recognized are:
3757 * "linux" Linux console
3758 * "screen.linux" Linux console with screen
3759 * "cygwin" Cygwin shell
3760 * "putty" Putty program
3761 * We also check the COLORFGBG environment variable, which is set by
3762 * rxvt and derivatives. This variable contains either two or three
3763 * values separated by semicolons; we want the last value in either
3764 * case. If this value is 0-6 or 8, our background is dark.
3765 */
3766 static char_u *
3767 term_bg_default()
3768 {
3769 #if defined(MSDOS) || defined(OS2) || defined(WIN3264)
3770 /* DOS console nearly always black */
3771 return (char_u *)"dark";
3772 #else
3773 char_u *p;
3774
3775 if (STRCMP(T_NAME, "linux") == 0
3776 || STRCMP(T_NAME, "screen.linux") == 0
3777 || STRCMP(T_NAME, "cygwin") == 0
3778 || STRCMP(T_NAME, "putty") == 0
3779 || ((p = mch_getenv((char_u *)"COLORFGBG")) != NULL
3780 && (p = vim_strrchr(p, ';')) != NULL
3781 && ((p[1] >= '0' && p[1] <= '6') || p[1] == '8')
3782 && p[2] == NUL))
3783 return (char_u *)"dark";
3784 return (char_u *)"light";
3785 #endif
3786 }
GUI fix: GUI修复:
4044 gui_bg_default()
4045 {
4046 if (gui_get_lightness(gui.back_pixel) < 127)
4047 return (char_u *)"dark";
4048 return (char_u *)"light";
4049 }
UPDATE: For vim-7.4.1689 (debian/ubuntu) I rebuilt Vim package with debugging info ( -O2 -g
default option; before strip and pack into deb) and ran TERM=xterm gdb --args vim-7.4.1689/src/vim-basic/vim -e
with watch p_bg
. 更新:对于vim-7.4.1689(debian / ubuntu)我用调试信息重建了Vim包(
-O2 -g
默认选项;在剥离和打包到deb之前)并运行TERM=xterm gdb --args vim-7.4.1689/src/vim-basic/vim -e
with watch p_bg
。 First change of p_bg
was by term_bg_default()
to light
, and second is from ... main
: may_req_termresponse()
(if FEAT_TERMRESPONSE was defined) -> vpeekc_nomap
-> vpeekc
-> vgetorpeek
-> check_termcode
-> set_option_value("bg",..)
-> set_string_option
. 第一次更改
p_bg
是通过term_bg_default()
来light
,第二次是来自... main
: may_req_termresponse()
(如果定义了FEAT_TERMRESPONSE) - > vpeekc_nomap
- > vpeekc
- > vgetorpeek
- > check_termcode
- > set_option_value("bg",..)
- > set_string_option
。
https://github.com/vim/vim/blob/54c10ccf9274880e83093a99690e7bfa9a2d2fa8/src/term.c https://github.com/vim/vim/blob/54c10ccf9274880e83093a99690e7bfa9a2d2fa8/src/term.c
Line 3302 - may_req_bg_color()
color, called from main.c
just after starttermcap()
/ log message "start termcap"; 第3302行 -
may_req_bg_color()
颜色,在starttermcap()
/ log消息“start termcap”之后从main.c
调用; I added preprocessed definition of the request: 我添加了预处理的请求定义:
/*
* Similar to requesting the version string: Request the terminal background
* color when it is the right moment.
*/
void
may_req_bg_color(void)
...
{(int)KS_RBG, "\033]11;?\007",
{(int)KS_RBG, "[RBG]"},
Line 4286 - handle response from termcap request: 第4286行 - 处理来自termcap请求的响应:
check_termcode( ....
/* Check for background color response from the terminal:
*
* {lead}11;rgb:{rrrr}/{gggg}/{bbbb}{tail}
*
* {lead} can be <Esc>] or OSC
* {tail} can be '\007', <Esc>\ or STERM.
*
* Consume any code that starts with "{lead}11;", it's also
* possible that "rgba" is following.
*/
if (i - j >= 21 && STRNCMP(tp + j + 3, "rgb:", 4) == 0
&& tp[j + 11] == '/' && tp[j + 16] == '/'
&& !option_was_set((char_u *)"bg"))
{/* TODO: don't set option when already the right value */
LOG_TR("Received RBG");
rbg_status = RBG_GOT;
set_option_value((char_u *)"bg", 0L, (char_u *)(
(3 * '6' < tp[j+7] + tp[j+12] + tp[j+17])
? "light" : "dark"), 0);
reset_option_was_set((char_u *)"bg");
Added by 7.4.757 patch http://ftp.vim.org/vim/patches/7.4/7.4.757 由7.4.757补丁http://ftp.vim.org/vim/patches/7.4/7.4.757添加
Patch 7.4.757
Problem: Cannot detect the background color of a terminal.
Solution: Add T_RBG to request the background color if possible. (Lubomir
Rintel)
Files: src/main.c, src/term.c, src/term.h, src/proto/term.pro
#define T_RBG (term_str(KS_RBG)) /* request background RGB */
Your tmux/screen may not implement '[RBG]' request; 你的tmux / screen可能没有实现'[RBG]'请求; check by running in xterm and in tmux and compare outputs:
通过在xterm和tmux中运行来检查并比较输出:
echo -e '\033]11;?\007'
You may define COLORFGBG (and there were bugs about it in neovim: https://github.com/neovim/neovim/issues/2764 ) There is bug report for gnome-terminal to set it https://bugzilla.gnome.org/show_bug.cgi?id=733423 您可以定义COLORFGBG(neovim中有关于它的错误: https : //github.com/neovim/neovim/issues/2764 )gnome-terminal有错误报告来设置它https://bugzilla.gnome.org /show_bug.cgi?id=733423
Various terminals, including urxvt and konsole, set an environment variable "COLORFGBG" to allow applications to detect the foreground and background colors.
各种终端,包括urxvt和konsole,设置环境变量“COLORFGBG”,以允许应用程序检测前景色和背景色。 Various programs, such as Vim, use this to determine whether to use a color scheme that works best on a light or dark background.
各种程序,例如Vim,使用它来确定是否使用在浅色或深色背景上效果最佳的配色方案。 Please consider setting this variable in gnome-terminal as well.
请考虑在gnome-terminal中设置此变量。
Egmont has some option in the bug https://bugzilla.gnome.org/show_bug.cgi?id=733423 to set COLORFGBG
with .bashrc
. Egmont在bug https://bugzilla.gnome.org/show_bug.cgi?id=733423中有一些选项可以用
.bashrc
设置COLORFGBG
。
You may change this in your "vimrc" ( ~/.vimrc
), or globally on your OS by changing /usr/share/vim/vimrc
or in vim sources by recompiling custom version or in Vim sources by reporting a bug to Vim authors / sending them patches. 您可以在“vimrc”(
~/.vimrc
)中更改此项,或者通过更改/usr/share/vim/vimrc
或在vim源中通过重新编译自定义版本或在Vim源中通过向Vim作者报告错误来更改此操作系统/发送补丁。
The documentation of "bg" describes part of logic and gives solutions for vimrc: “bg”的文档描述了逻辑的一部分,并为vimrc提供了解决方案:
When setting 'background' to the default value with:
将“背景”设置为默认值时:
:set background&
Vim will guess the value.
Vim会猜测这个值。 In the GUI this should work correctly, in other cases Vim might not be able to guess the right value.
在GUI中,这应该可以正常工作,在其他情况下,Vim可能无法猜出正确的值。
When starting the GUI, the default value for '
background
' will be"light"
.启动GUI时,“
background
”的默认值为"light"
。 When the value is not set in the.gvimrc
, and Vim detects that the background is actually quite dark, 'background
' is set to"dark"
.如果未在
.gvimrc
设置该值,并且Vim检测到背景实际上非常暗,则“background
”设置为"dark"
。 ........
Normally this option would be set in the
.vimrc
file.通常,此选项将在
.vimrc
文件中设置。 Possibly depending on the terminal name.可能取决于终端名称。 Example:
例:
:if &term == "pcterm" : set background=dark :endif
When this option is set, the default settings for the highlight groups will change.
设置此选项后,突出显示组的默认设置将更改。 To use other settings, place "
:highlight
" commands AFTER the setting of the 'background' option.要使用其他设置,请在设置“背景”选项后放置“
:highlight
”命令。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.