Merge branch 'master' into dev

Author: Neko-Box-Coder

README.md

@@ -78,7 +78,7 @@ You can also check out the website for Micro at https://micro-editor.github.io.
 - Syntax highlighting for over [130 languages](runtime/syntax).
 - Color scheme support.
   - By default, micro comes with 16, 256, and true color themes.
-- True color support (set the `MICRO_TRUECOLOR` environment variable to 1 to enable it).
+- True color support.
 - Copy and paste with the system clipboard.
 - Small and simple.
 - Easily configurable.

cmd/micro/micro.go

@@ -374,11 +374,6 @@ func main() {
 	action.InitBindings()
 	action.InitCommands()
 
-	err = config.InitColorscheme()
-	if err != nil {
-		screen.TermMessage(err)
-	}
-
 	err = config.RunPluginFn("preinit")
 	if err != nil {
 		screen.TermMessage(err)
@@ -407,6 +402,11 @@ func main() {
 		screen.TermMessage(err)
 	}
 
+	err = config.InitColorscheme()
+	if err != nil {
+		screen.TermMessage(err)
+	}
+
 	if clipErr != nil {
 		log.Println(clipErr, " or change 'clipboard' option")
 	}

internal/action/actions.go

@@ -1909,11 +1909,11 @@ func (h *BufPane) ClearInfo() bool {
 	return true
 }
 
-// ForceQuit closes the current tab or view even if there are unsaved changes
+// ForceQuit closes the tab or view even if there are unsaved changes
 // (no prompt)
 func (h *BufPane) ForceQuit() bool {
 	h.Buf.Close()
-	if len(MainTab().Panes) > 1 {
+	if len(h.tab.Panes) > 1 {
 		h.Unsplit()
 	} else if len(Tabs.List) > 1 {
 		Tabs.RemoveTab(h.splitID)

internal/action/bufpane.go

@@ -321,18 +321,16 @@ func (h *BufPane) ResizePane(size int) {
 }
 
 // PluginCB calls all plugin callbacks with a certain name and displays an
-// error if there is one and returns the aggregate boolean response
-func (h *BufPane) PluginCB(cb string) bool {
-	b, err := config.RunPluginFnBool(h.Buf.Settings, cb, luar.New(ulua.L, h))
-	if err != nil {
-		screen.TermMessage(err)
+// error if there is one and returns the aggregate boolean response.
+// The bufpane is passed as the first argument to the callbacks,
+// optional args are passed as the next arguments.
+func (h *BufPane) PluginCB(cb string, args ...interface{}) bool {
+	largs := []lua.LValue{luar.New(ulua.L, h)}
+	for _, a := range args {
+		largs = append(largs, luar.New(ulua.L, a))
 	}
-	return b
-}
 
-// PluginCBRune is the same as PluginCB but also passes a rune to the plugins
-func (h *BufPane) PluginCBRune(cb string, r rune) bool {
-	b, err := config.RunPluginFnBool(h.Buf.Settings, cb, luar.New(ulua.L, h), luar.New(ulua.L, string(r)))
+	b, err := config.RunPluginFnBool(h.Buf.Settings, cb, largs...)
 	if err != nil {
 		screen.TermMessage(err)
 	}
@@ -559,7 +557,7 @@ func (h *BufPane) execAction(action BufAction, name string, te *tcell.EventMouse
 		h.Buf.HasSuggestions = false
 	}
 
-	if !h.PluginCB("pre" + name) {
+	if !h.PluginCB("pre"+name, te) {
 		return false
 	}
 
@@ -570,7 +568,7 @@ func (h *BufPane) execAction(action BufAction, name string, te *tcell.EventMouse
 	case BufMouseAction:
 		success = a(h, te)
 	}
-	success = success && h.PluginCB("on"+name)
+	success = success && h.PluginCB("on"+name, te)
 
 	if _, ok := MultiActions[name]; ok {
 		if recordingMacro {
@@ -626,7 +624,7 @@ func (h *BufPane) DoRuneInsert(r rune) {
 		// Insert a character
 		h.Buf.SetCurCursor(c.Num)
 		h.Cursor = c
-		if !h.PluginCBRune("preRune", r) {
+		if !h.PluginCB("preRune", string(r)) {
 			continue
 		}
 		if c.HasSelection() {
@@ -645,35 +643,35 @@ func (h *BufPane) DoRuneInsert(r rune) {
 			curmacro = append(curmacro, r)
 		}
 		h.Relocate()
-		h.PluginCBRune("onRune", r)
+		h.PluginCB("onRune", string(r))
 	}
 }
 
 // VSplitIndex opens the given buffer in a vertical split on the given side.
 func (h *BufPane) VSplitIndex(buf *buffer.Buffer, right bool) *BufPane {
 	e := NewBufPaneFromBuf(buf, h.tab)
-	e.splitID = MainTab().GetNode(h.splitID).VSplit(right)
-	currentPaneIdx := MainTab().GetPane(h.splitID)
+	e.splitID = h.tab.GetNode(h.splitID).VSplit(right)
+	currentPaneIdx := h.tab.GetPane(h.splitID)
 	if right {
 		currentPaneIdx++
 	}
-	MainTab().AddPane(e, currentPaneIdx)
-	MainTab().Resize()
-	MainTab().SetActive(currentPaneIdx)
+	h.tab.AddPane(e, currentPaneIdx)
+	h.tab.Resize()
+	h.tab.SetActive(currentPaneIdx)
 	return e
 }
 
 // HSplitIndex opens the given buffer in a horizontal split on the given side.
 func (h *BufPane) HSplitIndex(buf *buffer.Buffer, bottom bool) *BufPane {
 	e := NewBufPaneFromBuf(buf, h.tab)
-	e.splitID = MainTab().GetNode(h.splitID).HSplit(bottom)
-	currentPaneIdx := MainTab().GetPane(h.splitID)
+	e.splitID = h.tab.GetNode(h.splitID).HSplit(bottom)
+	currentPaneIdx := h.tab.GetPane(h.splitID)
 	if bottom {
 		currentPaneIdx++
 	}
-	MainTab().AddPane(e, currentPaneIdx)
-	MainTab().Resize()
-	MainTab().SetActive(currentPaneIdx)
+	h.tab.AddPane(e, currentPaneIdx)
+	h.tab.Resize()
+	h.tab.SetActive(currentPaneIdx)
 	return e
 }
 

internal/config/colorscheme.go

@@ -55,6 +55,14 @@ func InitColorscheme() error {
 	c, err := LoadDefaultColorscheme()
 	if err == nil {
 		Colorscheme = c
+	} else {
+		// The colorscheme setting seems broken (maybe because we have not validated
+		// it earlier, see comment in verifySetting()). So reset it to the default
+		// colorscheme and try again.
+		GlobalSettings["colorscheme"] = DefaultGlobalOnlySettings["colorscheme"]
+		if c, err2 := LoadDefaultColorscheme(); err2 == nil {
+			Colorscheme = c
+		}
 	}
 
 	return err

internal/config/settings.go

@@ -36,6 +36,7 @@ var optionValidators = map[string]optionValidator{
 	"scrollmargin":    validateNonNegativeValue,
 	"scrollspeed":     validateNonNegativeValue,
 	"tabsize":         validatePositiveValue,
+	"truecolor":       validateChoice,
 }
 
 // a list of settings with pre-defined choices
@@ -46,6 +47,7 @@ var OptionChoices = map[string][]string{
 	"matchbracestyle": {"underline", "highlight"},
 	"multiopen":       {"tab", "hsplit", "vsplit"},
 	"reload":          {"prompt", "auto", "disabled"},
+	"truecolor":       {"auto", "on", "off"},
 }
 
 // a list of settings that can be globally and locally modified and their
@@ -100,6 +102,7 @@ var defaultCommonSettings = map[string]interface{}{
 	"tabmovement":     false,
 	"tabsize":         float64(4),
 	"tabstospaces":    false,
+	"truecolor":       "auto",
 	"useprimary":      true,
 	"wordwrap":        false,
 	"wrapindent":      float64(-1),
@@ -274,6 +277,12 @@ func verifySetting(option string, value interface{}, def interface{}) error {
 		return fmt.Errorf("Error: setting '%s' has incorrect type (%s), using default value: %v (%s)", option, valType, def, defType)
 	}
 
+	if option == "colorscheme" {
+		// Plugins are not initialized yet, so do not verify if the colorscheme
+		// exists yet, since the colorscheme may be added by a plugin later.
+		return nil
+	}
+
 	if err := OptionIsValid(option, value); err != nil {
 		return err
 	}

internal/screen/screen.go

@@ -188,10 +188,13 @@ func Init() error {
 	drawChan = make(chan bool, 8)
 
 	// Should we enable true color?
-	truecolor := os.Getenv("MICRO_TRUECOLOR") == "1"
-
-	if !truecolor {
+	truecolor := config.GetGlobalOption("truecolor").(string)
+	if truecolor == "on" || (truecolor == "auto" && os.Getenv("MICRO_TRUECOLOR") == "1") {
+		os.Setenv("TCELL_TRUECOLOR", "enable")
+	} else if truecolor == "off" {
 		os.Setenv("TCELL_TRUECOLOR", "disable")
+	} else {
+		// For "auto", tcell already autodetects truecolor by default
 	}
 
 	var oldTerm string

runtime/help/colors.md

@@ -47,10 +47,7 @@ color support comes in three flavors.
   displaying any colorscheme, but it should be noted that the user-configured
   16-color palette is ignored when using true-color mode (this means the
   colors while using the terminal emulator will be slightly off). Not all
-  terminals support true color but at this point most do. True color
-  support in micro is off by default but can be enabled by setting the
-  environment variable `MICRO_TRUECOLOR` to 1.  In addition your terminal
-  must support it (usually indicated by setting `$COLORTERM` to `truecolor`).
+  terminals support true color but at this point most do (see below).
   True-color colorschemes in micro typically end with `-tc`, such as
   `solarized-tc`, `atom-dark`, `material-tc`, etc... If true color is not
   enabled but a true color colorscheme is used, micro will do its best to
@@ -84,11 +81,12 @@ These may vary widely based on the 16 colors selected for your terminal.
 
 ### True color
 
-True color requires your terminal to support it. This means that the
-environment variable `COLORTERM` should have the value `truecolor`, `24bit`,
-or `24-bit`. In addition, to enable true color in micro, the environment
-variable `MICRO_TRUECOLOR` must be set to 1. Note that you have to create
-and set this variable yourself.
+Micro enables true color support by default as long as it detects that the
+terminal supports it (which is usually indicated by the environment variable
+`COLORTERM` being set to `truecolor`, `24bit` or `24-bit`). You can also force
+enabling it unconditionally by setting the option `truecolor` to `on` (or
+alternatively by setting the environment variable `MICRO_TRUECOLOR` to 1, which
+is supported for backward compatibility).
 
 * `solarized-tc`: this is the solarized colorscheme for true color.
 * `atom-dark`: this colorscheme is based off of Atom's "dark" colorscheme.

runtime/help/options.md

@@ -474,6 +474,19 @@ Here are the available options:
 
     default value: `false`
 
+* `truecolor`: controls whether micro will use true colors (24-bit colors) when
+   using a colorscheme with true colors, such as `solarized-tc` or `atom-dark`.
+   * `auto`: enable usage of true color if micro detects that it is supported by
+      the terminal, otherwise disable it.
+   * `on`: force usage of true color even if micro does not detect its support
+      by the terminal (of course this is not guaranteed to work well unless the
+      terminal actually supports true color).
+   * `off`: disable true color usage.
+
+   Note: The change will take effect after the next start of `micro`.
+
+   default value: `auto`
+
 * `useprimary` (only useful on unix): defines whether or not micro will use the
    primary clipboard to copy selections in the background. This does not affect
    the normal clipboard using `Ctrl-c` and `Ctrl-v`.

runtime/plugins/comment/help/comment.md

@@ -96,7 +96,7 @@ Or in your `settings.json`:
 }
 ```
 
-`commenttype` was the previous option name that was replaced by `comment.type`.
-
-While `commenttype` is still supported, we recommend switching to `comment.type` instead as
-`commenttype` can get deprecated in the future.
+`commenttype` (without the dot) is the legacy option that is
+superseded by `comment.type`. `commenttype` is still supported
+but deprecated.
+**Use `comment.type` instead.**