Adding indenttabchar, indentspacechar and spacechar options

Author: Neko-Box-Coder

internal/config/settings.go

@@ -70,7 +70,9 @@ var defaultCommonSettings = map[string]interface{}{
 	"hltrailingws":    false,
 	"ignorecase":      true,
 	"incsearch":       true,
-	"indentchar":      " ",
+	"indenttabchar":   " ",
+	"indentspacechar": " ",
+	"spacechar":       " ",
 	"keepautoindent":  false,
 	"matchbrace":      true,
 	"matchbraceleft":  true,
@@ -164,12 +166,23 @@ func init() {
 	VolatileSettings = make(map[string]bool)
 }
 
+func checkDeprecatedSettings(checkmap map[string]interface{}) {
+	indentchar, hasindentchar := checkmap["indentchar"]
+	_, hasindenttabchar := checkmap["indenttabchar"]
+	if hasindentchar && !hasindenttabchar {
+		checkmap["indenttabchar"] = indentchar
+	}
+}
+
 func validateParsedSettings() error {
 	var err error
 	defaults := DefaultAllSettings()
+
+	checkDeprecatedSettings(parsedSettings)
 	for k, v := range parsedSettings {
 		if strings.HasPrefix(reflect.TypeOf(v).String(), "map") {
 			if strings.HasPrefix(k, "ft:") {
+				checkDeprecatedSettings(v.(map[string]interface{}))
 				for k1, v1 := range v.(map[string]interface{}) {
 					if _, ok := defaults[k1]; ok {
 						if e := verifySetting(k1, v1, defaults[k1]); e != nil {
@@ -185,6 +198,7 @@ func validateParsedSettings() error {
 					delete(parsedSettings, k)
 					continue
 				}
+				checkDeprecatedSettings(v.(map[string]interface{}))
 				for k1, v1 := range v.(map[string]interface{}) {
 					if _, ok := defaults[k1]; ok {
 						if e := verifySetting(k1, v1, defaults[k1]); e != nil {
@@ -210,6 +224,7 @@ func validateParsedSettings() error {
 			}
 			continue
 		}
+
 		if _, ok := defaults[k]; ok {
 			if e := verifySetting(k, v, defaults[k]); e != nil {
 				err = e
@@ -295,6 +310,7 @@ func InitGlobalSettings() error {
 // based on whether the path matches a glob
 // Must be called after ReadSettings
 func UpdatePathGlobLocals(settings map[string]interface{}, path string) {
+	checkDeprecatedSettings(settings)
 	for k, v := range parsedSettings {
 		if strings.HasPrefix(reflect.TypeOf(v).String(), "map") && !strings.HasPrefix(k, "ft:") {
 			g, _ := glob.Compile(k)
@@ -311,6 +327,7 @@ func UpdatePathGlobLocals(settings map[string]interface{}, path string) {
 // based on whether the filetype matches to "ft:"
 // Must be called after ReadSettings
 func UpdateFileTypeLocals(settings map[string]interface{}, filetype string) {
+	checkDeprecatedSettings(settings)
 	for k, v := range parsedSettings {
 		if strings.HasPrefix(reflect.TypeOf(v).String(), "map") && strings.HasPrefix(k, "ft:") {
 			if filetype == k[3:] {

internal/display/bufwindow.go

@@ -494,7 +494,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, combc []rune, validrune 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,9 +571,20 @@ func (w *BufWindow) displayBuffer() {
 						}
 					}
 
-					if r == '\t' {
-						indentrunes := []rune(b.Settings["indentchar"].(string))
-						// if empty indentchar settings, use space
+					if r == '\t' || (r == ' ' && bloc.X < blineLen && validrune) {
+						var indentrunes []rune
+						switch r {
+						case '\t':
+							indentrunes = []rune(b.Settings["indenttabchar"].(string))
+						case ' ':
+							if bloc.X%tabsize == 0 && bloc.X < leadingwsEnd {
+								indentrunes = []rune(b.Settings["indentspacechar"].(string))
+							} else {
+								indentrunes = []rune(b.Settings["spacechar"].(string))
+							}
+						}
+
+						// if no override for current character, use space
 						if len(indentrunes) == 0 {
 							indentrunes = []rune{' '}
 						}
@@ -692,7 +703,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(' ', nil, false, config.DefStyle, false, false)
 				}
 
 				// We either stop or we wrap to draw the word in the next line
@@ -708,7 +719,7 @@ func (w *BufWindow) displayBuffer() {
 			}
 
 			for _, r := range word {
-				draw(r.r, r.combc, r.style, true, true)
+				draw(r.r, r.combc, true, r.style, true, true)
 
 				// Draw any extra characters either spaces for tabs or @ for incomplete wide runes
 				if r.width > 1 {
@@ -718,7 +729,7 @@ func (w *BufWindow) displayBuffer() {
 					}
 
 					for i := 1; i < r.width; i++ {
-						draw(char, nil, r.style, true, false)
+						draw(char, nil, false, r.style, true, false)
 					}
 				}
 				bloc.X++
@@ -764,7 +775,7 @@ func (w *BufWindow) displayBuffer() {
 
 		if vloc.X != maxWidth {
 			// Display newline within a selection
-			draw(' ', nil, config.DefStyle, true, true)
+			draw(' ', nil, false, config.DefStyle, true, true)
 		}
 
 		bloc.X = w.StartCol

runtime/help/options.md

@@ -203,12 +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.
+* `indenttabchar`: sets the indentation character for tabs. 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)
+
+* `indentspacechar`: same as `indenttabchar` except for spaces that are at
+   locations that are divisible by `tabsize`.
+
+    default value: ` ` (space)
+
+* `spacechar`: same as `indenttabchar` but for all spaces. `indentspacechar`
+   takes precedence over this option.
 
     default value: ` ` (space)