]> git.lizzy.rs Git - micro.git/blobdiff - cmd/micro/highlighter.go
Add cd and pwd commands to change the working dir
[micro.git] / cmd / micro / highlighter.go
index 7d4df09d64c34af24de7fa59a906ba8c9d253581..c71870e50f4ae7da7e653e3ddf1f100d21d399ef 100644 (file)
@@ -1,18 +1,17 @@
 package main
 
 import (
-       "github.com/gdamore/tcell"
-       "github.com/mitchellh/go-homedir"
-       "io/ioutil"
-       "path/filepath"
        "regexp"
        "strings"
+
+       "github.com/zyedidia/tcell"
 )
 
 // FileTypeRules represents a complete set of syntax rules for a filetype
 type FileTypeRules struct {
        filetype string
-       rules    []SyntaxRule
+       filename string
+       text     string
 }
 
 // SyntaxRule represents a regex to highlight in a certain style
@@ -29,125 +28,16 @@ type SyntaxRule struct {
 
 var syntaxFiles map[[2]*regexp.Regexp]FileTypeRules
 
-var preInstalledSynFiles = []string{
-       "Dockerfile",
-       "apacheconf",
-       "arduino",
-       "asciidoc",
-       "asm",
-       "awk",
-       "c",
-       "cmake",
-       "coffeescript",
-       "colortest",
-       "conf",
-       "conky",
-       "csharp",
-       "css",
-       "cython",
-       "d",
-       "dot",
-       "erb",
-       "fish",
-       "fortran",
-       "gentoo",
-       "git",
-       "glsl",
-       "go",
-       "groff",
-       "haml",
-       "haskell",
-       "html",
-       "ini",
-       "inputrc",
-       "java",
-       "javascript",
-       "json",
-       "keymap",
-       "kickstart",
-       "ledger",
-       "lisp",
-       "lua",
-       "makefile",
-       "man",
-       "markdown",
-       "mpdconf",
-       "nanorc",
-       "nginx",
-       "ocaml",
-       "patch",
-       "peg",
-       "perl",
-       "perl6",
-       "php",
-       "pkg-config",
-       "pkgbuild",
-       "po",
-       "pov",
-       "privoxy",
-       "puppet",
-       "python",
-       "reST",
-       "rpmspec",
-       "ruby",
-       "rust",
-       "scala",
-       "sed",
-       "sh",
-       "sls",
-       "sql",
-       "swift",
-       "systemd",
-       "tcl",
-       "tex",
-       "vala",
-       "vi",
-       "xml",
-       "xresources",
-       "yaml",
-       "yum",
-       "zsh",
-}
-
-// LoadSyntaxFiles loads the syntax files from the default directory ~/.micro
+// LoadSyntaxFiles loads the syntax files from the default directory (configDir)
 func LoadSyntaxFiles() {
-       home, err := homedir.Dir()
-       if err != nil {
-               TermMessage("Error finding your home directory\nCan't load syntax files")
-               return
-       }
-       LoadSyntaxFilesFromDir(home + "/.micro/syntax")
-
-       for _, filetype := range preInstalledSynFiles {
-               data, err := Asset("runtime/syntax/" + filetype + ".micro")
-               if err != nil {
-                       TermMessage("Unable to load pre-installed syntax file " + filetype)
-                       continue
-               }
-
-               LoadSyntaxFile(string(data), filetype+".micro")
-       }
-}
-
-// LoadSyntaxFilesFromDir loads the syntax files from a specified directory
-// To load the syntax files, we must fill the `syntaxFiles` map
-// This involves finding the regex for syntax and if it exists, the regex
-// for the header. Then we must get the text for the file and the filetype.
-func LoadSyntaxFilesFromDir(dir string) {
        InitColorscheme()
-
        syntaxFiles = make(map[[2]*regexp.Regexp]FileTypeRules)
-       files, _ := ioutil.ReadDir(dir)
-       for _, f := range files {
-               if filepath.Ext(f.Name()) == ".micro" {
-                       filename := dir + "/" + f.Name()
-                       text, err := ioutil.ReadFile(filename)
-
-                       if err != nil {
-                               TermMessage("Error loading syntax file " + filename + ": " + err.Error())
-                               return
-                       }
-                       LoadSyntaxFile(string(text), filename)
+       for _, f := range ListRuntimeFiles(RTSyntax) {
+               data, err := f.Data()
+               if err != nil {
+                       TermMessage("Error loading syntax file " + f.Name() + ": " + err.Error())
+               } else {
+                       LoadSyntaxFile(string(data), f.Name())
                }
        }
 }
@@ -161,12 +51,10 @@ func JoinRule(rule string) string {
        return joined
 }
 
-// LoadSyntaxFile loads the specified syntax file
-// A syntax file is a list of syntax rules, explaining how to color certain
-// regular expressions
-// Example: color comment "//.*"
-// This would color all strings that match the regex "//.*" in the comment color defined
-// by the colorscheme
+// LoadSyntaxFile simply gets the filetype of a the syntax file and the source for the
+// file and creates FileTypeRules out of it. If this filetype is the one opened by the user
+// the rules will be loaded and compiled later
+// In this function we are only concerned with loading the syntax and header regexes
 func LoadSyntaxFile(text, filename string) {
        var err error
        lines := strings.Split(string(text), "\n")
@@ -176,16 +64,20 @@ func LoadSyntaxFile(text, filename string) {
        // Regex for parsing header statements
        headerParser := regexp.MustCompile(`header "(.*)"`)
 
-       // Regex for parsing standard syntax rules
-       ruleParser := regexp.MustCompile(`color (.*?)\s+(?:\((.*?)\)\s+)?"(.*)"`)
-       // Regex for parsing syntax rules with start="..." end="..."
-       ruleStartEndParser := regexp.MustCompile(`color (.*?)\s+(?:\((.*?)\)\s+)?start="(.*)"\s+end="(.*)"`)
+       // Is there a syntax definition in this file?
+       hasSyntax := syntaxParser.MatchString(text)
+       // Is there a header definition in this file?
+       hasHeader := headerParser.MatchString(text)
 
        var syntaxRegex *regexp.Regexp
        var headerRegex *regexp.Regexp
        var filetype string
-       var rules []SyntaxRule
        for lineNum, line := range lines {
+               if (hasSyntax == (syntaxRegex != nil)) && (hasHeader == (headerRegex != nil)) {
+                       // We found what we we're supposed to find
+                       break
+               }
+
                if strings.TrimSpace(line) == "" ||
                        strings.TrimSpace(line)[0] == '#' {
                        // Ignore this line
@@ -197,11 +89,8 @@ func LoadSyntaxFile(text, filename string) {
                        syntaxMatches := syntaxParser.FindSubmatch([]byte(line))
                        if len(syntaxMatches) == 3 {
                                if syntaxRegex != nil {
-                                       // Add the current rules to the syntaxFiles variable
-                                       regexes := [2]*regexp.Regexp{syntaxRegex, headerRegex}
-                                       syntaxFiles[regexes] = FileTypeRules{filetype, rules}
+                                       TermError(filename, lineNum, "Syntax statement redeclaration")
                                }
-                               rules = rules[:0]
 
                                filetype = string(syntaxMatches[1])
                                extensions := JoinRule(string(syntaxMatches[2]))
@@ -230,177 +119,224 @@ func LoadSyntaxFile(text, filename string) {
                                TermError(filename, lineNum, "Header statement is not valid: "+line)
                                continue
                        }
-               } else {
-                       // Syntax rule, but it could be standard or start-end
-                       if ruleParser.MatchString(line) {
-                               // Standard syntax rule
-                               // Parse the line
-                               submatch := ruleParser.FindSubmatch([]byte(line))
-                               var color string
-                               var regexStr string
-                               var flags string
-                               if len(submatch) == 4 {
-                                       // If len is 4 then the user specified some additional flags to use
-                                       color = string(submatch[1])
-                                       flags = string(submatch[2])
-                                       regexStr = "(?" + flags + ")" + JoinRule(string(submatch[3]))
-                               } else if len(submatch) == 3 {
-                                       // If len is 3, no additional flags were given
-                                       color = string(submatch[1])
-                                       regexStr = JoinRule(string(submatch[2]))
-                               } else {
-                                       // If len is not 3 or 4 there is a problem
-                                       TermError(filename, lineNum, "Invalid statement: "+line)
-                                       continue
-                               }
-                               // Compile the regex
-                               regex, err := regexp.Compile(regexStr)
-                               if err != nil {
-                                       TermError(filename, lineNum, err.Error())
-                                       continue
-                               }
+               }
+       }
+       if syntaxRegex != nil {
+               // Add the current rules to the syntaxFiles variable
+               regexes := [2]*regexp.Regexp{syntaxRegex, headerRegex}
+               syntaxFiles[regexes] = FileTypeRules{filetype, filename, text}
+       }
+}
 
-                               // Get the style
-                               // The user could give us a "color" that is really a part of the colorscheme
-                               // in which case we should look that up in the colorscheme
-                               // They can also just give us a straight up color
-                               st := defStyle
-                               if _, ok := colorscheme[color]; ok {
-                                       st = colorscheme[color]
-                               } else {
-                                       st = StringToStyle(color)
-                               }
-                               // Add the regex, flags, and style
-                               // False because this is not start-end
-                               rules = append(rules, SyntaxRule{regex, flags, false, st})
-                       } else if ruleStartEndParser.MatchString(line) {
-                               // Start-end syntax rule
-                               submatch := ruleStartEndParser.FindSubmatch([]byte(line))
-                               var color string
-                               var start string
-                               var end string
-                               // Use m and s flags by default
-                               flags := "ms"
-                               if len(submatch) == 5 {
-                                       // If len is 5 the user provided some additional flags
-                                       color = string(submatch[1])
-                                       flags += string(submatch[2])
-                                       start = string(submatch[3])
-                                       end = string(submatch[4])
-                               } else if len(submatch) == 4 {
-                                       // If len is 4 the user did not provide additional flags
-                                       color = string(submatch[1])
-                                       start = string(submatch[2])
-                                       end = string(submatch[3])
-                               } else {
-                                       // If len is not 4 or 5 there is a problem
-                                       TermError(filename, lineNum, "Invalid statement: "+line)
-                                       continue
-                               }
+// LoadRulesFromFile loads just the syntax rules from a given file
+// Only the necessary rules are loaded when the buffer is opened.
+// If we load all the rules for every filetype when micro starts, there's a bit of lag
+// A rule just explains how to color certain regular expressions
+// Example: color comment "//.*"
+// This would color all strings that match the regex "//.*" in the comment color defined
+// by the colorscheme
+func LoadRulesFromFile(text, filename string) []SyntaxRule {
+       lines := strings.Split(string(text), "\n")
 
-                               // Compile the regex
-                               regex, err := regexp.Compile("(?" + flags + ")" + "(" + start + ").*?(" + end + ")")
-                               if err != nil {
-                                       TermError(filename, lineNum, err.Error())
-                                       continue
-                               }
+       // Regex for parsing standard syntax rules
+       ruleParser := regexp.MustCompile(`color (.*?)\s+(?:\((.*?)\)\s+)?"(.*)"`)
+       // Regex for parsing syntax rules with start="..." end="..."
+       ruleStartEndParser := regexp.MustCompile(`color (.*?)\s+(?:\((.*?)\)\s+)?start="(.*)"\s+end="(.*)"`)
+
+       var rules []SyntaxRule
+       for lineNum, line := range lines {
+               if strings.TrimSpace(line) == "" ||
+                       strings.TrimSpace(line)[0] == '#' ||
+                       strings.HasPrefix(line, "syntax") ||
+                       strings.HasPrefix(line, "header") {
+                       // Ignore this line
+                       continue
+               }
+
+               // Syntax rule, but it could be standard or start-end
+               if ruleParser.MatchString(line) {
+                       // Standard syntax rule
+                       // Parse the line
+                       submatch := ruleParser.FindSubmatch([]byte(line))
+                       var color string
+                       var regexStr string
+                       var flags string
+                       if len(submatch) == 4 {
+                               // If len is 4 then the user specified some additional flags to use
+                               color = string(submatch[1])
+                               flags = string(submatch[2])
+                               regexStr = "(?" + flags + ")" + JoinRule(string(submatch[3]))
+                       } else if len(submatch) == 3 {
+                               // If len is 3, no additional flags were given
+                               color = string(submatch[1])
+                               regexStr = JoinRule(string(submatch[2]))
+                       } else {
+                               // If len is not 3 or 4 there is a problem
+                               TermError(filename, lineNum, "Invalid statement: "+line)
+                               continue
+                       }
+                       // Compile the regex
+                       regex, err := regexp.Compile(regexStr)
+                       if err != nil {
+                               TermError(filename, lineNum, err.Error())
+                               continue
+                       }
 
-                               // Get the style
-                               // The user could give us a "color" that is really a part of the colorscheme
-                               // in which case we should look that up in the colorscheme
-                               // They can also just give us a straight up color
-                               st := defStyle
-                               if _, ok := colorscheme[color]; ok {
-                                       st = colorscheme[color]
-                               } else {
-                                       st = StringToStyle(color)
+                       // Get the style
+                       // The user could give us a "color" that is really a part of the colorscheme
+                       // in which case we should look that up in the colorscheme
+                       // They can also just give us a straight up color
+                       st := defStyle
+                       groups := strings.Split(color, ".")
+                       if len(groups) > 1 {
+                               curGroup := ""
+                               for i, g := range groups {
+                                       if i != 0 {
+                                               curGroup += "."
+                                       }
+                                       curGroup += g
+                                       if style, ok := colorscheme[curGroup]; ok {
+                                               st = style
+                                       }
                                }
-                               // Add the regex, flags, and style
-                               // True because this is start-end
-                               rules = append(rules, SyntaxRule{regex, flags, true, st})
+                       } else if style, ok := colorscheme[color]; ok {
+                               st = style
+                       } else {
+                               st = StringToStyle(color)
+                       }
+                       // Add the regex, flags, and style
+                       // False because this is not start-end
+                       rules = append(rules, SyntaxRule{regex, flags, false, st})
+               } else if ruleStartEndParser.MatchString(line) {
+                       // Start-end syntax rule
+                       submatch := ruleStartEndParser.FindSubmatch([]byte(line))
+                       var color string
+                       var start string
+                       var end string
+                       // Use m and s flags by default
+                       flags := "ms"
+                       if len(submatch) == 5 {
+                               // If len is 5 the user provided some additional flags
+                               color = string(submatch[1])
+                               flags += string(submatch[2])
+                               start = string(submatch[3])
+                               end = string(submatch[4])
+                       } else if len(submatch) == 4 {
+                               // If len is 4 the user did not provide additional flags
+                               color = string(submatch[1])
+                               start = string(submatch[2])
+                               end = string(submatch[3])
+                       } else {
+                               // If len is not 4 or 5 there is a problem
+                               TermError(filename, lineNum, "Invalid statement: "+line)
+                               continue
+                       }
+
+                       // Compile the regex
+                       regex, err := regexp.Compile("(?" + flags + ")" + "(" + start + ").*?(" + end + ")")
+                       if err != nil {
+                               TermError(filename, lineNum, err.Error())
+                               continue
+                       }
+
+                       // Get the style
+                       // The user could give us a "color" that is really a part of the colorscheme
+                       // in which case we should look that up in the colorscheme
+                       // They can also just give us a straight up color
+                       st := defStyle
+                       if _, ok := colorscheme[color]; ok {
+                               st = colorscheme[color]
+                       } else {
+                               st = StringToStyle(color)
                        }
+                       // Add the regex, flags, and style
+                       // True because this is start-end
+                       rules = append(rules, SyntaxRule{regex, flags, true, st})
                }
        }
-       if syntaxRegex != nil {
-               // Add the current rules to the syntaxFiles variable
-               regexes := [2]*regexp.Regexp{syntaxRegex, headerRegex}
-               syntaxFiles[regexes] = FileTypeRules{filetype, rules}
+       return rules
+}
+
+// FindFileType finds the filetype for the given buffer
+func FindFileType(buf *Buffer) string {
+       for r := range syntaxFiles {
+               if r[1] != nil && r[1].MatchString(buf.Line(0)) {
+                       // The header statement matches the first line
+                       return syntaxFiles[r].filetype
+               }
+       }
+       for r := range syntaxFiles {
+               if r[0] != nil && r[0].MatchString(buf.Path) {
+                       // The syntax statement matches the extension
+                       return syntaxFiles[r].filetype
+               }
        }
+       return "Unknown"
 }
 
 // GetRules finds the syntax rules that should be used for the buffer
 // and returns them. It also returns the filetype of the file
-func GetRules(buf *Buffer) ([]SyntaxRule, string) {
+func GetRules(buf *Buffer) []SyntaxRule {
        for r := range syntaxFiles {
-               if r[0] != nil && r[0].MatchString(buf.path) {
-                       return syntaxFiles[r].rules, syntaxFiles[r].filetype
-               } else if r[1] != nil && r[1].MatchString(buf.lines[0]) {
-                       return syntaxFiles[r].rules, syntaxFiles[r].filetype
+               if syntaxFiles[r].filetype == buf.FileType() {
+                       return LoadRulesFromFile(syntaxFiles[r].text, syntaxFiles[r].filename)
                }
        }
-       return nil, "Unknown"
+       return nil
 }
 
 // SyntaxMatches is an alias to a map from character numbers to styles,
 // so map[3] represents the style of the third character
 type SyntaxMatches [][]tcell.Style
 
-// Match takes a buffer and returns the syntax matches a map specifying how it should be syntax highlighted
-// We need to check the start-end regexes for the entire buffer every time Match is called, but for the
-// non start-end rules, we only have to update the updateLines provided by the view
+// Match takes a buffer and returns the syntax matches: a 2d array specifying how it should be syntax highlighted
+// We match the rules from up `synLinesUp` lines and down `synLinesDown` lines
 func Match(v *View) SyntaxMatches {
-       buf := v.buf
-       rules := v.buf.rules
+       buf := v.Buf
+       rules := v.Buf.rules
 
-       viewStart := v.topline
-       viewEnd := v.topline + v.height
-       if viewEnd > len(buf.lines) {
-               viewEnd = len(buf.lines)
+       viewStart := v.Topline
+       viewEnd := v.Topline + v.height
+       if viewEnd > buf.NumLines {
+               viewEnd = buf.NumLines
        }
 
-       // updateStart := v.updateLines[0]
-       // updateEnd := v.updateLines[1]
-       //
-       // if updateEnd > len(buf.lines) {
-       //      updateEnd = len(buf.lines)
-       // }
-       // if updateStart < 0 {
-       //      updateStart = 0
-       // }
-       lines := buf.lines[viewStart:viewEnd]
-       // updateLines := buf.lines[updateStart:updateEnd]
+       lines := buf.Lines(viewStart, viewEnd)
        matches := make(SyntaxMatches, len(lines))
 
        for i, line := range lines {
                matches[i] = make([]tcell.Style, len(line)+1)
+               for j := range matches[i] {
+                       matches[i][j] = defStyle
+               }
        }
 
        // We don't actually check the entire buffer, just from synLinesUp to synLinesDown
-       totalStart := v.topline - synLinesUp
-       totalEnd := v.topline + v.height + synLinesDown
+       totalStart := v.Topline - synLinesUp
+       totalEnd := v.Topline + v.height + synLinesDown
        if totalStart < 0 {
                totalStart = 0
        }
-       if totalEnd > len(buf.lines) {
-               totalEnd = len(buf.lines)
+       if totalEnd > buf.NumLines {
+               totalEnd = buf.NumLines
        }
 
-       str := strings.Join(buf.lines[totalStart:totalEnd], "\n")
-       startNum := ToCharPos(0, totalStart, v.buf)
-
-       toplineNum := ToCharPos(0, v.topline, v.buf)
+       str := strings.Join(buf.Lines(totalStart, totalEnd), "\n")
+       startNum := ToCharPos(Loc{0, totalStart}, v.Buf)
 
        for _, rule := range rules {
                if rule.startend {
                        if indicies := rule.regex.FindAllStringIndex(str, -1); indicies != nil {
                                for _, value := range indicies {
-                                       value[0] += startNum
-                                       value[1] += startNum
-                                       for i := value[0]; i < value[1]; i++ {
-                                               if i < toplineNum {
+                                       value[0] = runePos(value[0], str) + startNum
+                                       value[1] = runePos(value[1], str) + startNum
+                                       startLoc := FromCharPos(value[0], buf)
+                                       endLoc := FromCharPos(value[1], buf)
+                                       for curLoc := startLoc; curLoc.LessThan(endLoc); curLoc = curLoc.Move(1, buf) {
+                                               if curLoc.Y < v.Topline {
                                                        continue
                                                }
-                                               colNum, lineNum := FromCharPosStart(toplineNum, 0, v.topline, i, buf)
+                                               colNum, lineNum := curLoc.X, curLoc.Y
                                                if lineNum == -1 || colNum == -1 {
                                                        continue
                                                }
@@ -415,8 +351,9 @@ func Match(v *View) SyntaxMatches {
                        for lineN, line := range lines {
                                if indicies := rule.regex.FindAllStringIndex(line, -1); indicies != nil {
                                        for _, value := range indicies {
-                                               for i := value[0]; i < value[1]; i++ {
-                                                       // matches[lineN+updateStart][i] = rule.style
+                                               start := runePos(value[0], line)
+                                               end := runePos(value[1], line)
+                                               for i := start; i < end; i++ {
                                                        matches[lineN][i] = rule.style
                                                }
                                        }