]> git.lizzy.rs Git - micro.git/blobdiff - cmd/micro/micro.go
Fix draw ordering
[micro.git] / cmd / micro / micro.go
index 23818c67a56bc4a678b63d8b280675bee8a1d25d..1e9a31b27bc739deda0b44902d97e2d8ac5a5e2c 100644 (file)
@@ -7,6 +7,7 @@ import (
        "os"
        "runtime"
 
+       "github.com/atotto/clipboard"
        "github.com/go-errors/errors"
        "github.com/layeh/gopher-luar"
        "github.com/mattn/go-isatty"
@@ -17,14 +18,10 @@ import (
 )
 
 const (
-       // How many lines up to look to do syntax highlighting
-       synLinesUp = 75
-       // How many lines down to look to do syntax highlighting
-       synLinesDown = 75
-       // How many milliseconds to wait before a second click is not a double click
-       doubleClickThreshold = 400
-       // If two events are less than n milliseconds apart, undo both of them
-       undoThreshold = int(settings["undothreshold"].(float64))
+       synLinesUp           = 75  // How many lines up to look to do syntax highlighting
+       synLinesDown         = 75  // How many lines down to look to do syntax highlighting
+       doubleClickThreshold = 400 // How many milliseconds to wait before a second click is not a double click
+       undoThreshold        = 500 // If two events are less than n milliseconds apart, undo both of them
 )
 
 var (
@@ -34,7 +31,8 @@ var (
        // Object to send messages and prompts to the user
        messenger *Messenger
 
-       // The default style
+       // The default highlighting style
+       // This simply defines the default foreground and background colors
        defStyle tcell.Style
 
        // Where the user's configuration is
@@ -42,21 +40,32 @@ var (
        // If $XDG_CONFIG_HOME is not set, it is ~/.config/micro
        configDir string
 
-       // Version is the version number.
-       // This should be set by the linker
+       // Version is the version number or commit hash
+       // This should be set by the linker when compiling
        Version = "Unknown"
 
-       // Is the help screen open
-       helpOpen = false
-
        // L is the lua state
+       // This is the VM that runs the plugins
        L *lua.LState
+
+       // The list of views
+       tabs []*Tab
+       // This is the currently open tab
+       // It's just an index to the tab in the tabs array
+       curTab int
+
+       // Channel of jobs running in the background
+       jobs chan JobFunction
+       // Event channel
+       events chan tcell.Event
 )
 
-// LoadInput loads the file input for the editor
-func LoadInput() (string, []byte, error) {
+// LoadInput determines which files should be loaded into buffers
+// based on the input stored in os.Args
+func LoadInput() []*Buffer {
        // There are a number of ways micro should start given its input
-       // 1. If it is given a file in os.Args, it should open that
+
+       // 1. If it is given a files in os.Args, it should open those
 
        // 2. If there is no input file and the input is not a terminal, that means
        // something is being piped in and the stdin should be opened in an
@@ -65,39 +74,51 @@ func LoadInput() (string, []byte, error) {
        // 3. If there is no input file and the input is a terminal, an empty buffer
        // should be opened
 
-       // These are empty by default so if we get to option 3, we can just returns the
-       // default values
        var filename string
        var input []byte
        var err error
+       var buffers []*Buffer
 
        if len(os.Args) > 1 {
                // Option 1
-               filename = os.Args[1]
-               // Check that the file exists
-               if _, e := os.Stat(filename); e == nil {
-                       input, err = ioutil.ReadFile(filename)
+               // We go through each file and load it
+               for i := 1; i < len(os.Args); i++ {
+                       filename = os.Args[i]
+                       // Check that the file exists
+                       if _, e := os.Stat(filename); e == nil {
+                               // If it exists we load it into a buffer
+                               input, err = ioutil.ReadFile(filename)
+                               if err != nil {
+                                       TermMessage(err)
+                                       continue
+                               }
+                       }
+                       // If the file didn't exist, input will be empty, and we'll open an empty buffer
+                       buffers = append(buffers, NewBuffer(input, filename))
                }
        } else if !isatty.IsTerminal(os.Stdin.Fd()) {
                // Option 2
                // The input is not a terminal, so something is being piped in
                // and we should read from stdin
                input, err = ioutil.ReadAll(os.Stdin)
+               buffers = append(buffers, NewBuffer(input, filename))
+       } else {
+               // Option 3, just open an empty buffer
+               buffers = append(buffers, NewBuffer(input, filename))
        }
 
-       // Option 3, or just return whatever we got
-       return filename, input, err
+       return buffers
 }
 
-// InitConfigDir finds the configuration directory for micro according to the
-// XDG spec.
+// InitConfigDir finds the configuration directory for micro according to the XDG spec.
 // If no directory is found, it creates one.
 func InitConfigDir() {
        xdgHome := os.Getenv("XDG_CONFIG_HOME")
        if xdgHome == "" {
+               // The user has not set $XDG_CONFIG_HOME so we should act like it was set to ~/.config
                home, err := homedir.Dir()
                if err != nil {
-                       TermMessage("Error finding your home directory\nCan't load syntax files")
+                       TermMessage("Error finding your home directory\nCan't load config files")
                        return
                }
                xdgHome = home + "/.config"
@@ -105,6 +126,7 @@ func InitConfigDir() {
        configDir = xdgHome + "/micro"
 
        if _, err := os.Stat(xdgHome); os.IsNotExist(err) {
+               // If the xdgHome doesn't exist we should create it
                err = os.Mkdir(xdgHome, os.ModePerm)
                if err != nil {
                        TermMessage("Error creating XDG_CONFIG_HOME directory: " + err.Error())
@@ -112,6 +134,7 @@ func InitConfigDir() {
        }
 
        if _, err := os.Stat(configDir); os.IsNotExist(err) {
+               // If the micro specific config directory doesn't exist we should create that too
                err = os.Mkdir(configDir, os.ModePerm)
                if err != nil {
                        TermMessage("Error creating configuration directory: " + err.Error())
@@ -148,65 +171,60 @@ func InitScreen() {
                os.Setenv("TERM", oldTerm)
        }
 
-       // Default style
-       defStyle = tcell.StyleDefault.
-               Foreground(tcell.ColorDefault).
-               Background(tcell.ColorDefault)
-
-       // There may be another default style defined in the colorscheme
-       if style, ok := colorscheme["default"]; ok {
-               defStyle = style
-       }
-
        screen.SetStyle(defStyle)
        screen.EnableMouse()
 }
 
-// Redraw redraws the screen and the given view
-func Redraw(view *View) {
-       screen.Clear()
-       view.Display()
+// RedrawAll redraws everything -- all the views and the messenger
+func RedrawAll() {
+       messenger.Clear()
+       for _, v := range tabs[curTab].views {
+               v.Display()
+       }
+       DisplayTabs()
        messenger.Display()
        screen.Show()
 }
 
-var flagVersion = flag.Bool("version", false, "Show version number")
+// Passing -version as a flag will have micro print out the version number
+var flagVersion = flag.Bool("version", false, "Show the version number")
 
 func main() {
        flag.Parse()
        if *flagVersion {
+               // If -version was passed
                fmt.Println("Micro version:", Version)
                os.Exit(0)
        }
 
-       filename, input, err := LoadInput()
-       if err != nil {
-               fmt.Println(err)
-               os.Exit(1)
-       }
-
+       // Start the Lua VM for running plugins
        L = lua.NewState()
        defer L.Close()
 
+       // Some encoding stuff in case the user isn't using UTF-8
        encoding.Register()
        tcell.SetEncodingFallback(tcell.EncodingFallbackASCII)
 
        // Find the user's configuration directory (probably $XDG_CONFIG_HOME/micro)
        InitConfigDir()
+
        // Load the user's settings
        InitSettings()
+       InitCommands()
        InitBindings()
+
        // Load the syntax files, including the colorscheme
        LoadSyntaxFiles()
+
        // Load the help files
        LoadHelp()
 
-       buf := NewBuffer(string(input), filename)
-
+       // Start the screen
        InitScreen()
 
        // This is just so if we have an error, we can exit cleanly and not completely
        // mess up the terminal being worked in
+       // In other words we need to shut down tcell before the program crashes
        defer func() {
                if err := recover(); err != nil {
                        screen.Fini()
@@ -217,67 +235,109 @@ func main() {
                }
        }()
 
+       // Create a new messenger
+       // This is used for sending the user messages in the bottom of the editor
        messenger = new(Messenger)
-       view := NewView(buf)
+       messenger.history = make(map[string][]string)
+
+       // Now we load the input
+       buffers := LoadInput()
+       for _, buf := range buffers {
+               // For each buffer we create a new tab and place the view in that tab
+               tab := NewTabFromView(NewView(buf))
+               tab.SetNum(len(tabs))
+               tabs = append(tabs, tab)
+               for _, t := range tabs {
+                       for _, v := range t.views {
+                               v.Resize(screen.Size())
+                       }
+               }
+       }
 
+       // Load all the plugin stuff
+       // We give plugins access to a bunch of variables here which could be useful to them
        L.SetGlobal("OS", luar.New(L, runtime.GOOS))
-       L.SetGlobal("view", luar.New(L, view))
+       L.SetGlobal("tabs", luar.New(L, tabs))
+       L.SetGlobal("curTab", luar.New(L, curTab))
        L.SetGlobal("messenger", luar.New(L, messenger))
        L.SetGlobal("GetOption", luar.New(L, GetOption))
        L.SetGlobal("AddOption", luar.New(L, AddOption))
+       L.SetGlobal("BindKey", luar.New(L, BindKey))
+       L.SetGlobal("MakeCommand", luar.New(L, MakeCommand))
+       L.SetGlobal("CurView", luar.New(L, CurView))
+       L.SetGlobal("IsWordChar", luar.New(L, IsWordChar))
+
+       // Used for asynchronous jobs
+       L.SetGlobal("JobStart", luar.New(L, JobStart))
+       L.SetGlobal("JobSend", luar.New(L, JobSend))
+       L.SetGlobal("JobStop", luar.New(L, JobStop))
 
        LoadPlugins()
 
+       jobs = make(chan JobFunction, 100)
+       events = make(chan tcell.Event)
+
+       // Here is the event loop which runs in a separate thread
+       go func() {
+               for {
+                       events <- screen.PollEvent()
+               }
+       }()
+
        for {
                // Display everything
-               Redraw(view)
+               RedrawAll()
 
-               // Wait for the user's action
-               event := screen.PollEvent()
+               var event tcell.Event
 
-               if searching {
-                       HandleSearchEvent(event, view)
-               } else {
-                       // Check if we should quit
-                       switch e := event.(type) {
-                       case *tcell.EventKey:
-                               switch e.Key() {
-                               case tcell.KeyCtrlQ:
-                                       // Make sure not to quit if there are unsaved changes
-                                       if helpOpen {
-                                               view.OpenBuffer(buf)
-                                               helpOpen = false
-                                       } else {
-                                               if view.CanClose("Quit anyway? (yes, no, save) ") {
-                                                       screen.Fini()
-                                                       os.Exit(0)
-                                               }
-                                       }
-                               case tcell.KeyCtrlE:
-                                       input, canceled := messenger.Prompt("> ")
-                                       if !canceled {
-                                               HandleCommand(input, view)
-                                       }
-                               case tcell.KeyCtrlB:
-                                       input, canceled := messenger.Prompt("$ ")
-                                       if !canceled {
-                                               HandleShellCommand(input, view, true)
-                                       }
-                               case tcell.KeyCtrlG:
-                                       if !helpOpen {
-                                               helpBuffer := NewBuffer(helpTxt, "help.md")
-                                               helpBuffer.Name = "Help"
-                                               helpOpen = true
-                                               view.OpenBuffer(helpBuffer)
-                                       } else {
-                                               view.OpenBuffer(buf)
-                                               helpOpen = false
+               // Check for new events
+               select {
+               case f := <-jobs:
+                       // If a new job has finished while running in the background we should execute the callback
+                       f.function(f.output, f.args...)
+                       continue
+               case event = <-events:
+               }
+
+               switch e := event.(type) {
+               case *tcell.EventMouse:
+                       if e.Buttons() == tcell.Button1 {
+                               // If the user left clicked we check a couple things
+                               _, h := screen.Size()
+                               x, y := e.Position()
+                               if y == h-1 && messenger.message != "" {
+                                       // If the user clicked in the bottom bar, and there is a message down there
+                                       // we copy it to the clipboard.
+                                       // Often error messages are displayed down there so it can be useful to easily
+                                       // copy the message
+                                       clipboard.WriteAll(messenger.message)
+                                       continue
+                               }
+
+                               // We loop through each view in the current tab and make sure the current view
+                               // it the one being clicked in
+                               for _, v := range tabs[curTab].views {
+                                       if x >= v.x && x < v.x+v.width && y >= v.y && y < v.y+v.height {
+                                               tabs[curTab].curView = v.Num
                                        }
                                }
                        }
+               }
+
+               // This function checks the mouse event for the possibility of changing the current tab
+               // If the tab was changed it returns true
+               if TabbarHandleMouseEvent(event) {
+                       continue
+               }
 
+               if searching {
+                       // Since searching is done in real time, we need to redraw every time
+                       // there is a new event in the search bar so we need a special function
+                       // to run instead of the standard HandleEvent.
+                       HandleSearchEvent(event, CurView())
+               } else {
                        // Send it to the view
-                       view.HandleEvent(event)
+                       CurView().HandleEvent(event)
                }
        }
 }