Adding showchars option

Author: Neko-Box-Coder

internal/config/settings.go

@@ -70,7 +70,7 @@ var defaultCommonSettings = map[string]interface{}{
 	"hltrailingws":    false,
 	"ignorecase":      true,
 	"incsearch":       true,
-	"indentchar":      " ",
+	"indentchar":      " ", // Deprecated
 	"keepautoindent":  false,
 	"matchbrace":      true,
 	"matchbraceleft":  true,
@@ -88,6 +88,7 @@ var defaultCommonSettings = map[string]interface{}{
 	"scrollbar":       false,
 	"scrollmargin":    float64(3),
 	"scrollspeed":     float64(2),
+	"showchars":       "incomplete=@@@@",
 	"smartpaste":      true,
 	"softwrap":        false,
 	"splitbottom":     true,
@@ -210,6 +211,7 @@ func validateParsedSettings() error {
 			}
 			continue
 		}
+
 		if _, ok := defaults[k]; ok {
 			if e := verifySetting(k, v, defaults[k]); e != nil {
 				err = e

internal/display/bufwindow.go

@@ -2,6 +2,7 @@ package display
 
 import (
 	"strconv"
+	"strings"
 
 	runewidth "github.com/mattn/go-runewidth"
 	"github.com/micro-editor/tcell/v2"
@@ -450,6 +451,35 @@ func (w *BufWindow) displayBuffer() {
 	cursors := b.GetCursors()
 
 	curStyle := config.DefStyle
+
+	// Parse showchars which is in the format of option1=val1,option2=val2,...
+	spacechars := " "
+	tabchars := b.Settings["indentchar"].(string)
+	indentspacechars := " "
+	indenttabchars := b.Settings["indentchar"].(string)
+	incompletechars := " "
+
+	charsentries := strings.Split(b.Settings["showchars"].(string), ",")
+	for _, entry := range charsentries {
+		if !strings.Contains(entry, "=") {
+			continue
+		}
+		entrykey := strings.Split(entry, "=")[0]
+		entryval := strings.Split(entry, "=")[1]
+		switch entrykey {
+		case "space":
+			spacechars = entryval
+		case "tab":
+			tabchars = entryval
+		case "ispace":
+			indentspacechars = entryval
+		case "itab":
+			indenttabchars = entryval
+		case "incomplete":
+			incompletechars = entryval
+		}
+	}
+
 	for ; vloc.Y < w.bufHeight; vloc.Y++ {
 		vloc.X = 0
 
@@ -494,7 +524,7 @@ func (w *BufWindow) displayBuffer() {
 		}
 		bloc.X = bslice
 
-		draw := func(r rune, combc []rune, style tcell.Style, highlight bool, showcursor bool) {
+		draw := func(r rune, showoffset int, combc []rune, isplaceholder bool, style tcell.Style, highlight bool, showcursor bool) {
 			if nColsBeforeStart <= 0 && vloc.Y >= 0 {
 				if highlight {
 					if w.Buf.HighlightSearch && w.Buf.SearchMatch(bloc) {
@@ -571,14 +601,30 @@ func (w *BufWindow) displayBuffer() {
 						}
 					}
 
-					if r == '\t' {
-						indentrunes := []rune(b.Settings["indentchar"].(string))
-						// if empty indentchar settings, use space
-						if len(indentrunes) == 0 {
-							indentrunes = []rune{' '}
+					if (r == '\t' || r == ' ') && !isplaceholder {
+						var indentrunes []rune
+						switch r {
+						case '\t':
+							if bloc.X < leadingwsEnd && !b.Settings["tabstospaces"].(bool) {
+								indentrunes = []rune(indenttabchars)
+							} else {
+								indentrunes = []rune(tabchars)
+							}
+						case ' ':
+							if bloc.X%tabsize == 0 && bloc.X < leadingwsEnd && b.Settings["tabstospaces"].(bool) {
+								indentrunes = []rune(indentspacechars)
+							} else {
+								indentrunes = []rune(spacechars)
+							}
+						}
+
+						if showoffset < len(indentrunes) {
+							r = indentrunes[showoffset]
+						} else {
+							// use space if no showchars or after we showed showchars
+							r = ' '
 						}
 
-						r = indentrunes[0]
 						if s, ok := config.Colorscheme["indent-char"]; ok && r != ' ' {
 							fg, _, _ := s.Decompose()
 							style = style.Foreground(fg)
@@ -692,7 +738,7 @@ func (w *BufWindow) displayBuffer() {
 			// If a word (or just a wide rune) does not fit in the window
 			if vloc.X+wordwidth > maxWidth && vloc.X > w.gutterOffset {
 				for vloc.X < maxWidth {
-					draw(' ', nil, config.DefStyle, false, false)
+					draw(' ', 0, nil, true, config.DefStyle, false, false)
 				}
 
 				// We either stop or we wrap to draw the word in the next line
@@ -708,17 +754,20 @@ func (w *BufWindow) displayBuffer() {
 			}
 
 			for _, r := range word {
-				draw(r.r, r.combc, r.style, true, true)
+				draw(r.r, 0, r.combc, false, r.style, true, true)
 
-				// Draw any extra characters either spaces for tabs or @ for incomplete wide runes
+				// Draw any extra characters for tabs or incomplete wide runes
 				if r.width > 1 {
-					char := ' '
-					if r.r != '\t' {
-						char = '@'
-					}
-
 					for i := 1; i < r.width; i++ {
-						draw(char, nil, r.style, true, false)
+						if r.r != '\t' {
+							if i < len(incompletechars) {
+								draw([]rune(incompletechars)[i], i, nil, false, r.style, true, false)
+							} else {
+								draw(' ', i, nil, true, r.style, true, false)
+							}
+						} else {
+							draw('\t', i, nil, false, r.style, true, false)
+						}
 					}
 				}
 				bloc.X++
@@ -764,7 +813,7 @@ func (w *BufWindow) displayBuffer() {
 
 		if vloc.X != maxWidth {
 			// Display newline within a selection
-			draw(' ', nil, config.DefStyle, true, true)
+			draw(' ', 0, nil, true, config.DefStyle, true, true)
 		}
 
 		bloc.X = w.StartCol

runtime/help/options.md

@@ -203,14 +203,22 @@ Here are the available options:
 
     default value: `true`
 
-* `indentchar`: sets the indentation character. This will not be inserted into
-   files; it is only a visual indicator that whitespace is present. If set to a
-   printing character, it functions as a subset of the "show invisibles"
-   setting available in many other text editors. The color of this character is
-   determined by the `indent-char` field in the current theme rather than the
-   default text color.
-
-    default value: ` ` (space)
+* `showchars`: sets what characters to be shown for various inivisible characters
+   in the file. This is similar to `listchars` in vim and the characters shown
+   will not be inserted into files. This option supersedes the `indentchar`
+   option.
+   The color of the shown character is determined by the `indent-char`
+   field in the current theme rather than the default text color.
+   This field is specified in the form of `option1=value1,option2=value2,...`.
+   Here are the list of options:
+   - `ispace`: indent space characters (space before first visible character)
+   - `itab`: indent tab characters (tab before first visible character)
+   - `space`: space characters (space after first visible character)
+   - `tab`: tab characters (tab after first visible character)
+   - `incomplete`: incomplete/broken wide characters
+   An example of this option could be `tab=>,space=.,itab=|>,ispace=|`
+
+    default value: `incomplete=@@@@`
 
 * `infobar`: enables the line at the bottom of the editor where messages are
    printed. This option is `global only`.
@@ -577,6 +585,7 @@ so that you can see what the formatting should look like.
     "scrollbarchar": "|",
     "scrollmargin": 3,
     "scrollspeed": 2,
+    "showchars": " ",
     "smartpaste": true,
     "softwrap": false,
     "splitbottom": true,