Merge pull request #2374 from mhinz/hl-group-termcursor

[RDY] Add new highlight groups TermCursor and TermCursorNC

4 files changed, 23 insertions, 16 deletions

diff --git a/runtime/doc/nvim_terminal_emulator.txt b/runtime/doc/nvim_terminal_emulator.txt
index 160242a7fa..850391200e 100644
--- a/runtime/doc/nvim_terminal_emulator.txt
+++ b/runtime/doc/nvim_terminal_emulator.txt
@@ -99,16 +99,13 @@ variables (set via the |TermOpen| autocmd):
 - `{g,b}:terminal_color_$NUM`: The terminal color palette, where `$NUM` is the
   color index, between 0 and 255 inclusive. This only affects UIs with RGB
   capabilities; for normal terminals the color index is simply forwarded.
-- `{g,b}:terminal_focused_cursor_highlight`: Highlight group applied to the
-  cursor in a focused terminal. The default equivalent to having a group with
-  `cterm=reverse` `gui=reverse``.
-- `{g,b}:terminal_unfocused_cursor_highlight`: Highlight group applied to the
-  cursor in an unfocused terminal. The default equivalent to having a group with
-  `ctermbg=11` `guibg=#fce94f``.
 
 The configuration variables are only processed when the terminal starts, which
 is why it needs to be done with the |TermOpen| autocmd or setting global
 variables before the terminal is started.
 
+The terminal cursor can be highlighted via |hl-TermCursor| and
+|hl-TermCursorNC|.
+
 ==============================================================================
  vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index c0f1888d84..fad6557eb0 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -3651,17 +3651,19 @@ A jump table for the options with a short description can be found at |Q_op|.
 
 						*'highlight'* *'hl'*
 'highlight' 'hl'	string	(default (as a single string):
-				     "8:SpecialKey,~:EndOfBuffer,@:NonText,i
-				     d:Directory,e:ErrorMsg,i:IncSearch,
-				     l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
+				     "8:SpecialKey,~:EndOfBuffer,z:TermCursor,
+				     Z:TermCursorNC,@:NonText,d:Directory,
+				     e:ErrorMsg,i:IncSearch,l:Search,
+				     m:MoreMsg,M:ModeMsg,n:LineNr,
 				     N:CursorLineNr,r:Question,s:StatusLine,
 				     S:StatusLineNC,c:VertSplit,t:Title,
-				     v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
-				     F:FoldColumn,A:DiffAdd,C:DiffChange,
-				     D:DiffDelete,T:DiffText,>:SignColumn,
-				     B:SpellBad,P:SpellCap,R:SpellRare,
-				     L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
-				     x:PmenuSbar,X:PmenuThumb")
+				     v:Visual,w:WarningMsg,W:WildMenu,
+				     f:Folded,F:FoldColumn,A:DiffAdd,
+				     C:DiffChange,D:DiffDelete,T:DiffText,
+				     >:SignColumn,B:SpellBad,P:SpellCap,
+				     R:SpellRare,L:SpellLocal,-:Conceal,
+				     +:Pmenu,=:PmenuSel,x:PmenuSbar,
+				     X:PmenuThumb")
 			global
 			{not in Vi}
 	This option can be used to set highlighting mode for various
@@ -3670,6 +3672,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 	use for that occasion.  The occasions are:
 	|hl-SpecialKey|	 8  Meta and special keys listed with ":map"
 	|hl-EndOfBuffer|      ~ lines after the last line in the buffer
+	|hl-TermCursor|	 z  Cursor in a focused terminal
+	|hl-TermCursorNC| Z Cursor in an unfocused terminal
 	|hl-NonText|	 @  '@' at the end of the window and
 			    characters from 'showbreak'
 	|hl-Directory|	 d  directories in CTRL-D listing and other special
@@ -3681,7 +3685,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 	|hl-ModeMsg|	 M  Mode (e.g., "-- INSERT --")
 	|hl-LineNr|	 n  line number for ":number" and ":#" commands, and
 			    when 'number' or 'relativenumber' option is set.
-	|hl-CursorLineNr|  N like n for when 'cursorline' or 'relativenumber' is
+	|hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
 			    set.
 	|hl-Question|	 r  |hit-enter| prompt and yes/no questions
 	|hl-StatusLine|	 s  status line of current window |status-line|
diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index 19289dafec..67e8c177f3 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -4763,6 +4763,10 @@ DiffText	diff mode: Changed text within a changed line |diff.txt|
 						 {Nvim} *hl-EndOfBuffer*
 EndOfBuffer	filler lines (~) after the end of the buffer.
 		By default, this is highlighted like |hl-NonText|.
+						 {Nvim} *hl-TermCursor*
+TermCursor	cursor in a focused terminal
+						 {Nvim} *hl-TermCursorNC*
+TermCursorNC	cursor in an unfocused terminal
 							*hl-ErrorMsg*
 ErrorMsg	error messages on the command line
 							*hl-VertSplit*
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index 328e1eda75..94514d7b03 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -68,6 +68,8 @@ Events:
 
 Highlight groups:
 - |hl-EndOfBuffer|
+- |hl-TermCursor|
+- |hl-TermCursorNC|
 
 ==============================================================================
 5. Missing legacy features				 *nvim-features-missing*