Merge pull request #13 from montegoulding/refactor/livecodescript

Refactor to merge LiveCode Script and iRev

Author: peter-b

README.md

@@ -42,15 +42,16 @@ for Atom.
 
 ## Script Error Checking
 
-This package provides a linter for LiveCode Script and Server to highlight and describe
-script compilation errors on the fly.
+This package provides a linter for LiveCode Script, LiveCode Server and LiveCode
+Builder to highlight and describe script compilation errors on the fly.
 
 ![Linter In Action](http://ecove.on-rev.com/linter.gif)
 
 Dependencies:
 
  * The [linter package](https://atom.io/packages/linter) needs to be installed
- * LiveCode 7.1+ Server engine for the platform it is being run on must be accessible
+ * LiveCode 7.1+ Server engine for the platform it is being run on must be
+ accessible
 
 The default setting assumes you have installed the LiveCode Server engine somewhere
 on the current `$PATH` with the name `livecode-server`. However, you can enter any
@@ -63,6 +64,27 @@ by the inclusion of another file that error won't be detected.
 The linter supports an optional explicit variables mode which can be turned on
 via the package settings.
 
+### LiveCode Builder Linting
+
+Linting of LiveCode Builder files should be considered experimental. This is
+particularly the case for projects that have complex interdependencies between
+files.
+
+In order to lint LiveCode Builder files ensure the following:
+
+ * lc-compile can be found at the location specified in settings
+ * You have appropriately set the module paths to a directory with the standard
+`*.lci` files provided by LiveCode. You may add further paths delimited by `;`
+
+The default settings assume you have a clone of the LiveCode repo in
+your home directory named livecode and you have built a debug build.
+
+In the process of linting the LiveCode Builder file a `*.lci` file is created in
+a directory named `.lci` next to the file being edited. In the case of files
+that have dependencies you may receive a dependency error if you edit a
+file with the dependency before those it depends on because it won't be able to
+fine the appropriate `*.lci` file in the `.lci` directory.
+
 ## Authors
 
 * Ralf Bitter

grammars/irev.cson

@@ -6,7 +6,7 @@
 'fileTypes': [
   'livecodescript'
 ]
-'firstLineMatch': '^#!.*\\b(livecode)|^#\\s*-\\*-[^*]*mode:\\s*livecodescript[^*]*-\\*-'
+'firstLineMatch': '^#!.*\\b(livecode)|^#\\s*-\\*-[^*]*mode:\\s*livecodescript[^*]*-\\*-|script \"([A-Za-z_0-9]*)\"'
 'patterns': [
   {
     include: "#language"
@@ -31,25 +31,28 @@ repository:
         name: "comment.block.livecodescript"
       }
       {
-        captures:
-          "1":
-            name: "punctuation.definition.comment.livecodescript"
-        match: "(--).*?($\\n?)"
-        name: "comment.line.double-dash.livecodescript"
+        'begin': '--'
+        'beginCaptures':
+          '0':
+            'name': 'punctuation.definition.comment.double-dash.livecodescript'
+        'end': '\\n'
+        'name': 'comment.line.livecodescript'
       }
       {
-        captures:
-          "1":
-            name: "punctuation.definition.comment.livecodescript"
-        match: "(#).*?($\\n?)"
-        name: "comment.line.number-sign.livecodescript"
+          'begin': '#'
+          'beginCaptures':
+            '0':
+              'name': 'punctuation.definition.comment.number-sign.livecodescript'
+          'end': '\\n'
+          'name': 'comment.line.livecodescript'
       }
       {
-        captures:
-          "1":
-            name: "punctuation.definition.comment.livecodescript"
-        match: "(//).*?($\\n?)"
-        name: "comment.line.number-sign.livecodescript"
+        'begin': '//'
+        'beginCaptures':
+          '0':
+            'name': 'punctuation.definition.comment.double-slash.livecodescript'
+        'end': '\\n'
+        'name': 'comment.line.livecodescript'
       }
       {
         match: "\\b(after|byte(s)*|codepoint(s)*|codeunit(s)*|english|segment(s)*|sentence(s)*|paragraph|the|trueWord(s)*|until|word(s)*|http|forever|descending|using|line|real8|with|seventh|for|stdout|finally|element|word|fourth|before|black|ninth|sixth|characters|chars|stderr|uInt(1|1s|2|2s)|stdin|string|lines|relative|rel|any|fifth|items|from|middle|mid|at|else|of|catch|then|third|it|file|milli(seconds|second|secs|sec)|int(1|1s|4|4s|ernet|2|2s)|normal|text|item|last|long|detailed|effective|uInt4|uInt4s|se(conds|cond|cs|c)|repeat|end\\s+repeat|URL|in|end\\s+try|into|switch|end\\s+switch|to|words|https|token|binfile|each|tenth|as|ticks|tick|system|real4|by|dateItems|without|cha(r|racter)|ascending|eighth|whole|dateTime|numeric|short|first|ftp|integer|abbreviated|abb(r|rev)|private|case|while|if|end\\s+if)\\b"
@@ -71,10 +74,12 @@ repository:
           "1":
             name: "storage.type.function.livecodescript"
           "2":
-            name: "entity.name.function.livecodescript"
+            name: "storage.type.function.livecodescript"
           "3":
-            name: "variable.parameter.livecodescript"
-        match: "((?i)function)\\s+([A-Za-z_0-9-]+)(\\s+[A-Za-z_0-9-]+,*?\\s+.*)*"
+            name: "entity.name.function.livecodescript"
+          "4":
+            name: "punctuation.definition.variable.livecodescript"
+        match: "(private\\s+)*((?i)function|on|command|before|after)\\s+([A-Za-z_0-9-]+)(\\s+@*[A-Za-z_0-9-]+,*?\\s+.*)*"
         name: "meta.function.livecodescript"
       }
       {
@@ -86,30 +91,6 @@ repository:
         match: "((?i)end){1}\\s+?([A-Za-z_0-9-]+)?"
         name: "meta.function.end.livecodescript"
       }
-      {
-        captures:
-          "1":
-            name: "storage.type.command.livecodescript"
-          "2":
-            name: "entity.name.command.livecodescript"
-          "3":
-            name: "variable.parameter.livecodescript"
-        match: "((?i)before|after|command|on)\\s+([A-Za-z_0-9-]+)(\\s+[A-Za-z_0-9-]+,*?\\s+.*)*"
-        name: "meta.command.livecodescript"
-      }
-      {
-        captures:
-          "1":
-            name: "storage.type.test.livecodescript"
-          "2":
-            name: "entity.name.test.livecodescript"
-        match: "((?i)blah){1}\\s+?([A-Za-z_0-9-]+)?"
-        name: "meta.test.livecodescript"
-      }
-      {
-        match: "((command|on)\\s+([A-Za-z_0-9-]+))"
-        name: "meta.testA.livecodescript"
-      }
       {
         match: "(\\-|\\+|\\*|/|%)"
         name: "keyword.operator.arithmetic.livecodescript"

grammars/livecodescript.cson

@@ -13,6 +13,31 @@ module.exports =
       title: 'Explicit Variables'
       default: 'false'
       description: 'Get errors on undeclared variables'
+    lcCompilePath:
+      type: 'string'
+      title: 'Compiler Path For LiveCode Builder'
+      default: switch
+        when process.platform == 'darwin'
+        then '~/livecode/_build/mac/Debug/lc-compile'
+        when process.platform == 'linux'
+        then '~/livecode/build-linux-x86_64/livecode/out/Debug/lc-compile'
+        when process.platform == 'win32'
+        then '~/livecode/_build/Win32/Debug/lc-compile.exe'
+      description: 'Where is your lc-compile installed? ' +
+        'Default assumes it\'s on $PATH'
+    modulePaths:
+      type: 'string'
+      title: 'Module Paths For LiveCode Builder'
+      default: switch
+        when process.platform == 'darwin'
+        then '~/livecode/_build/mac/Debug/modules/lci/'
+        when process.platform == 'linux'
+        then '~/livecode/build-linux-x86_64/livecode/out/Debug/modules/lci/'
+        when process.platform == 'win32'
+        then '~/livecode/_build/Win32/Debug/modules/lci/'
+      description: 'Where are the modules installed? ' +
+        'Default is where they should be after building ' +
+        'a debug build of LiveCode. Delimit paths with `;`.'
 
   activate: ->
     @subscriptions = new CompositeDisposable
@@ -22,6 +47,12 @@ module.exports =
     @subscriptions.add atom.config.observe 'language-livecode.explicitVars',
       (explicitVars) =>
         @explicitVars = explicitVars
+    @subscriptions.add atom.config.observe 'language-livecode.lcCompilePath',
+      (lcCompilePath) =>
+        @lcCompilePath = lcCompilePath
+    @subscriptions.add atom.config.observe 'language-livecode.modulePaths',
+      (modulePaths) =>
+        @modulePaths = modulePaths
     path = require 'path'
     @linterPath = path.join(__dirname, '..', 'tools', 'Linter.lc')
     @notified = false
@@ -31,7 +62,7 @@ module.exports =
 
   provideLinter: ->
     provider =
-      grammarScopes: ['source.livecodescript', 'source.iRev']
+      grammarScopes: ['source.livecodescript', 'source.lcb']
       scope: 'file'
       lintOnFly: true
       lint: (textEditor) =>
@@ -44,6 +75,12 @@ module.exports =
         parameters.push(scope)
         explicitVariables = '-explicitVariables=' + @explicitVars
         parameters.push(explicitVariables)
+        lcCompile = '-lcCompile=' + @lcCompilePath
+        parameters.push(lcCompile)
+        lcCompileModulePaths = '-modulePaths=' + @modulePaths
+        parameters.push(lcCompileModulePaths)
+        editorFilePath = '-filepath=' + filePath
+        parameters.push(editorFilePath)
         text = textEditor.getText()
         return @exec(command, parameters, {stdin: text}).then (output) ->
           regex = /(\d+),(\d+),(.*)/g