├── .gitignore ├── .idea ├── misc.xml ├── saveactions_settings.xml └── vcs.xml ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src └── main ├── java └── org │ └── tokor │ └── lspmatlab │ ├── Application.java │ ├── MATLABEngineSingleton.java │ ├── MATLABLanguageServer.java │ ├── MATLABTextDocumentService.java │ └── MATLABWorkspaceService.java └── resources └── logback.xml /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | build 3 | package-lock.json 4 | 5 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm 6 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 7 | 8 | # User-specific stuff 9 | .idea/**/workspace.xml 10 | .idea/**/tasks.xml 11 | .idea/**/usage.statistics.xml 12 | .idea/**/dictionaries 13 | .idea/**/shelf 14 | 15 | # Generated files 16 | .idea/**/contentModel.xml 17 | 18 | # Sensitive or high-churn files 19 | .idea/**/dataSources/ 20 | .idea/**/dataSources.ids 21 | .idea/**/dataSources.local.xml 22 | .idea/**/sqlDataSources.xml 23 | .idea/**/dynamic.xml 24 | .idea/**/uiDesigner.xml 25 | .idea/**/dbnavigator.xml 26 | 27 | # Gradle 28 | .idea/**/gradle.xml 29 | .idea/**/libraries 30 | 31 | # Gradle and Maven with auto-import 32 | # When using Gradle or Maven with auto-import, you should exclude module files, 33 | # since they will be recreated, and may cause churn. Uncomment if using 34 | # auto-import. 35 | # .idea/modules.xml 36 | # .idea/*.iml 37 | # .idea/modules 38 | 39 | # CMake 40 | cmake-build-*/ 41 | 42 | # Mongo Explorer plugin 43 | .idea/**/mongoSettings.xml 44 | 45 | # File-based project format 46 | *.iws 47 | 48 | # IntelliJ 49 | out/ 50 | 51 | # mpeltonen/sbt-idea plugin 52 | .idea_modules/ 53 | 54 | # JIRA plugin 55 | atlassian-ide-plugin.xml 56 | 57 | # Cursive Clojure plugin 58 | .idea/replstate.xml 59 | 60 | # Crashlytics plugin (for Android Studio and IntelliJ) 61 | com_crashlytics_export_strings.xml 62 | crashlytics.properties 63 | crashlytics-build.properties 64 | fabric.properties 65 | 66 | # Editor-based Rest Client 67 | .idea/httpRequests 68 | 69 | # Android studio 3.1+ serialized cache file 70 | .idea/caches/build_file_checksums.ser 71 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /.idea/saveactions_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 12 | 14 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # matlab-langserver 2 | Language Server using MATLAB Engine 3 | 4 | ## Build 5 | 6 | 1. Edit `build.gradle` to specify your MATLAB installation path. 7 | For example, if you have R2019a running on Linux with the default path, the following lines should be: 8 | ``` 9 | compileOnly files( 10 | '/usr/local/MATLAB/R2019a/extern/engines/java/jar/engine.jar', 11 | '/usr/local/MATLAB/R2019a/java/jar/mde.jar', 12 | '/usr/local/MATLAB/R2019a/java/jar/mlwidgets.jar', 13 | ) 14 | ``` 15 | 1. Now you can build a jar file with Gradle: 16 | ``` 17 | $ ./gradlew jar 18 | ``` 19 | 20 | ## Usage 21 | 22 | ``` 23 | $ export MATLABROOT=/usr/local/MATLAB/R2019a 24 | $ java -Djava.library.path=$MATLABROOT/bin/glnxa64 -cp $MATLABROOT/extern/engines/java/jar/engine.jar:$MATLABROOT/java/jar/jmi.jar:/path/to/lsp-matlab-x.y.jar org.tokor.lspmatlab.Application 25 | ``` 26 | Do not forget to replace `/path/to/lsp-matlab-x.y.jar` with your path of the jar file. 27 | 28 | ## Note 29 | 30 | This project is experimental and not tested for every platform. 31 | Future updates on MATLAB might break the functionality because the code heavily depends on undocumented functions and APIs. 32 | 33 | If you have any problems or suggestions, please open issues and hopefully contribute by coding. 34 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'java' 3 | } 4 | 5 | group 'org.tokor' 6 | version '0.1' 7 | 8 | sourceCompatibility = 1.8 9 | 10 | repositories { 11 | mavenCentral() 12 | } 13 | 14 | dependencies { 15 | compile( 16 | 'org.eclipse.lsp4j:org.eclipse.lsp4j:0.5.0', 17 | 'org.slf4j:slf4j-api:1.7.25', 18 | 'org.slf4j:jul-to-slf4j:1.7.25', 19 | 'ch.qos.logback:logback-classic:1.2.3', 20 | 'org.json:json:20180813' 21 | ) 22 | compileOnly files( 23 | '/usr/local/MATLAB/R2018b/extern/engines/java/jar/engine.jar', 24 | '/usr/local/MATLAB/R2018b/java/jar/mde.jar', 25 | '/usr/local/MATLAB/R2018b/java/jar/mlwidgets.jar', 26 | ) 27 | testCompile group: 'junit', name: 'junit', version: '4.12' 28 | } 29 | 30 | jar { 31 | manifest { 32 | attributes 'Main-Class': 'org.tokor.lspmatlab.Application' 33 | } 34 | // Fat Jar 35 | from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } } 36 | exclude 'META-INF/*.RSA', 'META-INF/*.SF', 'META-INF/*.DSA' 37 | } -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tokoro10g/matlab-langserver/c8c0ec65624fd1c7bfdab6ac375ca4e1ecdc0e21/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sun Sep 16 10:39:39 JST 2018 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.8-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'lsp-matlab' 2 | 3 | -------------------------------------------------------------------------------- /src/main/java/org/tokor/lspmatlab/Application.java: -------------------------------------------------------------------------------- 1 | package org.tokor.lspmatlab; 2 | 3 | import org.eclipse.lsp4j.jsonrpc.Launcher; 4 | import org.eclipse.lsp4j.launch.LSPLauncher; 5 | import org.eclipse.lsp4j.services.LanguageClient; 6 | import org.slf4j.Logger; 7 | import org.slf4j.LoggerFactory; 8 | import org.slf4j.bridge.SLF4JBridgeHandler; 9 | 10 | public final class Application { 11 | private static final Logger logger = LoggerFactory.getLogger(Application.class); 12 | 13 | public static void main(String[] args) throws Exception { 14 | SLF4JBridgeHandler.removeHandlersForRootLogger(); 15 | SLF4JBridgeHandler.install(); 16 | 17 | logger.info("Starting server"); 18 | 19 | MATLABLanguageServer server = new MATLABLanguageServer(() -> { 20 | }); 21 | Launcher launcher = LSPLauncher.createServerLauncher(server, System.in, System.out); 22 | LanguageClient client = launcher.getRemoteProxy(); 23 | 24 | server.connect(client); 25 | launcher.startListening(); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/org/tokor/lspmatlab/MATLABEngineSingleton.java: -------------------------------------------------------------------------------- 1 | package org.tokor.lspmatlab; 2 | 3 | import com.mathworks.engine.MatlabEngine; 4 | import org.slf4j.Logger; 5 | import org.slf4j.LoggerFactory; 6 | 7 | import java.io.Writer; 8 | import java.util.concurrent.Future; 9 | 10 | public class MATLABEngineSingleton { 11 | private static MATLABEngineSingleton instance = null; 12 | 13 | public static final Logger logger = LoggerFactory.getLogger(MATLABEngineSingleton.class); 14 | public MatlabEngine engine; 15 | private Future future; 16 | 17 | private MATLABEngineSingleton() { 18 | String[] engines = {}; 19 | try { 20 | engines = MatlabEngine.findMatlab(); 21 | } catch (Exception e) { 22 | logger.info("", e); 23 | } 24 | if (engines.length == 0) { 25 | logger.info("Could not find existing sessions. Starting MATLAB Engine..."); 26 | String[] options = {"-r", "matlab.engine.shareEngine"}; 27 | this.future = MatlabEngine.startMatlabAsync(options); 28 | } else { 29 | logger.info("Connecting to MATLAB Engine (" + engines[0] + ")..."); 30 | this.future = MatlabEngine.connectMatlabAsync(engines[0]); 31 | } 32 | this.engine = null; 33 | } 34 | 35 | public boolean isEngineReady() { 36 | if (future.isDone()) { 37 | try { 38 | engine = future.get(); 39 | } catch (Exception e) { 40 | // TODO: handle properly 41 | return false; 42 | } 43 | } 44 | return engine != null; 45 | } 46 | 47 | public Object evalInMATLAB(String statement) { 48 | return evalInMATLAB(statement, null, null, null); 49 | } 50 | 51 | public Object evalInMATLAB(String statement, Writer writer) { 52 | return evalInMATLAB(statement, null, null, null, writer); 53 | } 54 | 55 | public Object evalInMATLAB(String statement, String varIn, Object valueIn, String varOut) { 56 | return evalInMATLAB(statement, varIn, valueIn, varOut, MatlabEngine.NULL_WRITER); 57 | } 58 | 59 | public Object evalInMATLAB(String statement, String varIn, Object valueIn, String varOut, Writer writer) { 60 | if (!isEngineReady()) { 61 | logger.info("MATLAB Engine not ready"); 62 | return null; 63 | } 64 | Object result = null; 65 | try { 66 | if (varIn != null) { 67 | engine.putVariable(varIn, valueIn); 68 | } 69 | engine.eval(statement, writer, writer); 70 | if (varOut != null) { 71 | result = engine.getVariable(varOut); 72 | } 73 | } catch (Exception e) { 74 | logger.info("", e); 75 | return null; 76 | } 77 | return result; 78 | } 79 | 80 | public static MATLABEngineSingleton getInstance() { 81 | if (instance == null) { 82 | instance = new MATLABEngineSingleton(); 83 | } 84 | return instance; 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /src/main/java/org/tokor/lspmatlab/MATLABLanguageServer.java: -------------------------------------------------------------------------------- 1 | package org.tokor.lspmatlab; 2 | 3 | import org.eclipse.lsp4j.*; 4 | import org.eclipse.lsp4j.services.*; 5 | import org.slf4j.Logger; 6 | import org.slf4j.LoggerFactory; 7 | 8 | import java.util.Arrays; 9 | import java.util.concurrent.CompletableFuture; 10 | 11 | public final class MATLABLanguageServer implements LanguageServer, LanguageClientAware { 12 | 13 | private static final Logger logger = LoggerFactory.getLogger(MATLABLanguageServer.class); 14 | 15 | private final Runnable shutdownHandler; 16 | private LanguageClient client; 17 | 18 | @Override 19 | public void initialized(InitializedParams params) { 20 | client.logMessage(new MessageParams(MessageType.Info, "MATLAB Language Server Initialized")); 21 | } 22 | 23 | public MATLABLanguageServer(Runnable shutdownHandler) { 24 | this.shutdownHandler = shutdownHandler; 25 | } 26 | 27 | @Override 28 | public CompletableFuture initialize(InitializeParams params) { 29 | ServerCapabilities capabilities = new ServerCapabilities(); 30 | capabilities.setTextDocumentSync(TextDocumentSyncKind.Full); 31 | 32 | CompletionOptions completionOptions = new CompletionOptions(); 33 | completionOptions.setResolveProvider(true); 34 | capabilities.setCompletionProvider(completionOptions); 35 | 36 | SignatureHelpOptions signatureHelpOptions = new SignatureHelpOptions(); 37 | signatureHelpOptions.setTriggerCharacters(Arrays.asList("(")); 38 | capabilities.setSignatureHelpProvider(signatureHelpOptions); 39 | 40 | capabilities.setDefinitionProvider(true); 41 | 42 | capabilities.setCodeActionProvider(true); 43 | ExecuteCommandOptions executeCommandOptions = new ExecuteCommandOptions( 44 | Arrays.asList( 45 | "engine.run", 46 | "engine.runLine" 47 | ) 48 | ); 49 | capabilities.setExecuteCommandProvider(executeCommandOptions); 50 | 51 | WorkspaceServerCapabilities workspace = new WorkspaceServerCapabilities(); 52 | WorkspaceFoldersOptions foldersOptions = new WorkspaceFoldersOptions(); 53 | foldersOptions.setSupported(true); 54 | foldersOptions.setChangeNotifications(true); 55 | workspace.setWorkspaceFolders(foldersOptions); 56 | capabilities.setWorkspace(workspace); 57 | 58 | InitializeResult result = new InitializeResult(capabilities); 59 | return CompletableFuture.completedFuture(result); 60 | } 61 | 62 | @Override 63 | public CompletableFuture shutdown() { 64 | logger.info("Shutdown Received"); 65 | try { 66 | MATLABEngineSingleton.getInstance().engine.close(); 67 | } catch (Exception e) { 68 | logger.info("", e); 69 | } 70 | shutdownHandler.run(); 71 | return CompletableFuture.completedFuture(null); 72 | } 73 | 74 | @Override 75 | public void exit() { 76 | logger.info("Exit Received"); 77 | try { 78 | MATLABEngineSingleton.getInstance().engine.close(); 79 | } catch (Exception e) { 80 | logger.info("", e); 81 | } 82 | shutdownHandler.run(); 83 | } 84 | 85 | @Override 86 | public TextDocumentService getTextDocumentService() { 87 | MATLABEngineSingleton.getInstance(); 88 | return new MATLABTextDocumentService(); 89 | } 90 | 91 | @Override 92 | public WorkspaceService getWorkspaceService() { 93 | return new MATLABWorkspaceService(); 94 | } 95 | 96 | @Override 97 | public void connect(LanguageClient client) { 98 | this.client = client; 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /src/main/java/org/tokor/lspmatlab/MATLABTextDocumentService.java: -------------------------------------------------------------------------------- 1 | package org.tokor.lspmatlab; 2 | 3 | import com.google.common.collect.ImmutableList; 4 | import com.google.common.collect.ImmutableMap; 5 | import com.google.gson.*; 6 | import org.eclipse.lsp4j.*; 7 | import org.eclipse.lsp4j.jsonrpc.CompletableFutures; 8 | import org.eclipse.lsp4j.jsonrpc.messages.Either; 9 | import org.eclipse.lsp4j.services.TextDocumentService; 10 | import org.slf4j.Logger; 11 | import org.slf4j.LoggerFactory; 12 | 13 | import java.io.File; 14 | import java.util.ArrayList; 15 | import java.util.Arrays; 16 | import java.util.List; 17 | import java.util.Map; 18 | import java.util.concurrent.CompletableFuture; 19 | import java.util.concurrent.atomic.AtomicReference; 20 | import java.util.regex.Matcher; 21 | import java.util.regex.Pattern; 22 | import java.util.stream.Collectors; 23 | 24 | public class MATLABTextDocumentService implements TextDocumentService { 25 | 26 | public static final Logger logger = LoggerFactory.getLogger(MATLABTextDocumentService.class); 27 | 28 | private AtomicReference src = new AtomicReference(ImmutableList.of()); 29 | private String uri; 30 | 31 | private static final Map kindMap = ImmutableMap.builder() 32 | .put("method", CompletionItemKind.Method) 33 | .put("mFile", CompletionItemKind.Function) 34 | .put("pFile", CompletionItemKind.Function) 35 | .put("package", CompletionItemKind.Module) 36 | .put("variable", CompletionItemKind.Variable) 37 | .put("mex", CompletionItemKind.Function) 38 | .put("slxFile", CompletionItemKind.File) 39 | .put("mdlFile", CompletionItemKind.File) 40 | .put("folder", CompletionItemKind.Folder) 41 | .put("filename", CompletionItemKind.File) 42 | .put("pathItem", CompletionItemKind.File) 43 | .put("literal", CompletionItemKind.Property) 44 | .put("logical", CompletionItemKind.Value) 45 | .put("fieldname", CompletionItemKind.Field) 46 | .build(); 47 | 48 | private static int lineNumToByteNum(String str, int lineIndex, int charIndex) { 49 | int pos = 0; 50 | while (lineIndex-- > 0) 51 | pos = str.indexOf('\n', pos + 1); 52 | if (pos == -1) return charIndex; 53 | return pos + charIndex + (pos == 0 ? 0 : 1); 54 | } 55 | 56 | private static boolean isValidMFilePath(String path) { 57 | File file = new File(path); 58 | return file.exists() && path.endsWith(".m"); 59 | } 60 | 61 | @Override 62 | public CompletableFuture, CompletionList>> completion(CompletionParams position) { 63 | return CompletableFutures.computeAsync(checker -> { 64 | String src = this.src.get(); 65 | int currentLineIndex = position.getPosition().getLine(); 66 | int currentCharIndex = position.getPosition().getCharacter(); 67 | 68 | int byteIndex = lineNumToByteNum(src, currentLineIndex, currentCharIndex); 69 | 70 | logger.info("Completion: l" + Integer.toString(currentLineIndex) + ":" + Integer.toString(currentCharIndex) + "/" + Integer.toString(byteIndex)); 71 | 72 | String rs = (String) MATLABEngineSingleton.getInstance().evalInMATLAB("import com.mathworks.jmi.tabcompletion.*;" + 73 | "tc___ = TabCompletionImpl();" + 74 | "f___ = tc___.getJSONCompletions(str___, " + Integer.toString(byteIndex) + ");" + 75 | "while ~f___.isDone(); pause(0.01); end;" + 76 | "result___ = f___.get();", "str___", src, "result___"); 77 | if (rs == null) { 78 | return Either.forLeft(new ArrayList()); 79 | } 80 | 81 | JsonParser parser = new JsonParser(); 82 | JsonElement obj = parser.parse(rs); 83 | JsonArray arr; 84 | List comp = new ArrayList<>(); 85 | if (obj.isJsonNull()) { 86 | return Either.forLeft(new ArrayList()); 87 | } 88 | try { 89 | arr = obj.getAsJsonObject().getAsJsonArray("finalCompletions"); 90 | int cnt = 0; 91 | for (Object o : arr) { 92 | String label = ((JsonObject) o).getAsJsonPrimitive("popupCompletion").getAsString(); 93 | //logger.info("item:" + label); 94 | CompletionItem item = new CompletionItem(label); 95 | item.setLabel(label); 96 | item.setInsertText(label); 97 | CompletionItemKind kind; 98 | try { 99 | kind = kindMap.get(((JsonObject) o).getAsJsonPrimitive("matchType").getAsString()); 100 | } catch (Exception e) { 101 | kind = CompletionItemKind.Text; 102 | } 103 | item.setKind(kind); 104 | item.setData(++cnt); 105 | comp.add(item); 106 | } 107 | } catch (JsonSyntaxException je) { 108 | logger.info("Invalid result", je); 109 | return Either.forLeft(new ArrayList()); 110 | } 111 | return Either.forLeft(comp); 112 | }); 113 | } 114 | 115 | @Override 116 | public CompletableFuture resolveCompletionItem(CompletionItem unresolved) { 117 | return CompletableFuture.completedFuture(null); 118 | } 119 | 120 | @Override 121 | public CompletableFuture hover(TextDocumentPositionParams position) { 122 | return CompletableFuture.completedFuture(null); 123 | } 124 | 125 | @Override 126 | public CompletableFuture signatureHelp(TextDocumentPositionParams position) { 127 | return CompletableFutures.computeAsync(checker -> { 128 | String src = this.src.get(); 129 | int currentLineIndex = position.getPosition().getLine(); 130 | int currentCharIndex = position.getPosition().getCharacter(); 131 | 132 | int byteIndex = lineNumToByteNum(src, currentLineIndex, currentCharIndex); 133 | 134 | logger.info("SignatureHelp: l" + Integer.toString(currentLineIndex) + ":" + Integer.toString(currentCharIndex) + "/" + Integer.toString(byteIndex)); 135 | 136 | String rs = (String) MATLABEngineSingleton.getInstance().evalInMATLAB("import com.mathworks.mlwidgets.help.functioncall.*;" + 137 | "fc___ = MFunctionCall.getInstance(str___);" + 138 | "result___ = char(fc___.createSignatureString());", "str___", src.substring(0, byteIndex), "result___"); 139 | if (rs == null) { 140 | return null; 141 | } 142 | 143 | List items = new ArrayList<>(); 144 | 145 | final Matcher matcher = Pattern.compile("
(.+?)
").matcher(rs); 146 | int activeSignature = 0; 147 | int activeParameter = 0; 148 | while (matcher.find()) { 149 | String item = matcher.group(1); 150 | 151 | int boldIndex = item.indexOf(""); 152 | if (boldIndex > -1) { 153 | int commaIndex = 0, activeArgIndex = -1; 154 | while (commaIndex != -1 && commaIndex < boldIndex) { 155 | commaIndex = item.indexOf(",", commaIndex + 1); 156 | activeArgIndex++; 157 | } 158 | if (activeParameter < activeArgIndex) { 159 | activeParameter = activeArgIndex; 160 | } 161 | } else { 162 | activeParameter = -1; 163 | } 164 | 165 | item = item.replaceAll("\\<[^>]*>", ""); 166 | SignatureInformation info = new SignatureInformation(item); 167 | 168 | final Matcher matcher2 = Pattern.compile("\\((.*?)\\)").matcher(item); 169 | if (matcher2.find()) { 170 | info.setParameters(Arrays.asList(matcher2.group(1).split(",")).stream().map(ParameterInformation::new).collect(Collectors.toList())); 171 | } 172 | items.add(info); 173 | } 174 | 175 | return new SignatureHelp(items, activeSignature, activeParameter); 176 | }); 177 | } 178 | 179 | @Override 180 | public CompletableFuture> definition(TextDocumentPositionParams position) { 181 | return CompletableFutures.computeAsync(checker -> { 182 | String src = this.src.get(); 183 | int currentLineIndex = position.getPosition().getLine(); 184 | int currentCharIndex = position.getPosition().getCharacter(); 185 | 186 | int byteIndex = lineNumToByteNum(src, currentLineIndex, currentCharIndex); 187 | logger.info("Definition: l" + Integer.toString(currentLineIndex) + ":" + Integer.toString(currentCharIndex) + "/" + Integer.toString(byteIndex)); 188 | 189 | String functionName = ""; 190 | final Matcher matcher = Pattern.compile("\\w+").matcher(src); 191 | int start = 0; 192 | int end = 0; 193 | while (matcher.find()) { 194 | start = matcher.start(); 195 | end = matcher.end(); 196 | if (start <= byteIndex && byteIndex <= end) { 197 | functionName = src.subSequence(start, end).toString(); 198 | break; 199 | } 200 | } 201 | 202 | String rs = (String) MATLABEngineSingleton.getInstance().evalInMATLAB("result___ = which(fn___)", "fn___", functionName, "result___"); 203 | if (rs == null) { 204 | return null; 205 | } 206 | logger.info(rs); 207 | if (!isValidMFilePath(rs)) { 208 | Matcher matcher2 = Pattern.compile("built-in \\((.*?)\\)").matcher(rs); 209 | if (matcher2.find()) { 210 | // built-in function 211 | rs = matcher2.group(1) + ".m"; 212 | } else { 213 | return null; 214 | } 215 | } 216 | 217 | Location l = new Location("file://" + rs, new Range(new Position(0, 0), new Position(0, 0))); 218 | return Arrays.asList(l); 219 | }); 220 | } 221 | 222 | @Override 223 | public CompletableFuture> references(ReferenceParams params) { 224 | return CompletableFuture.completedFuture(null); 225 | } 226 | 227 | @Override 228 | public CompletableFuture> documentHighlight(TextDocumentPositionParams position) { 229 | return CompletableFuture.completedFuture(null); 230 | } 231 | 232 | @Override 233 | public CompletableFuture> codeLens(CodeLensParams params) { 234 | return CompletableFuture.completedFuture(null); 235 | } 236 | 237 | @Override 238 | public CompletableFuture resolveCodeLens(CodeLens unresolved) { 239 | return CompletableFuture.completedFuture(null); 240 | } 241 | 242 | @Override 243 | public CompletableFuture> formatting(DocumentFormattingParams params) { 244 | return CompletableFuture.completedFuture(null); 245 | } 246 | 247 | @Override 248 | public CompletableFuture> rangeFormatting(DocumentRangeFormattingParams params) { 249 | return CompletableFuture.completedFuture(null); 250 | } 251 | 252 | @Override 253 | public CompletableFuture> onTypeFormatting(DocumentOnTypeFormattingParams params) { 254 | return CompletableFuture.completedFuture(null); 255 | } 256 | 257 | @Override 258 | public CompletableFuture rename(RenameParams params) { 259 | return CompletableFuture.completedFuture(null); 260 | } 261 | 262 | @Override 263 | public CompletableFuture>> codeAction(CodeActionParams params) { 264 | return CompletableFutures.computeAsync(checker -> { 265 | Position position = params.getRange().getStart(); 266 | int currentLineIndex = position.getLine(); 267 | return Arrays.asList( 268 | Either.forLeft(new Command("Run code on MATLAB Engine", "engine.run", Arrays.asList(src, uri))), 269 | Either.forLeft(new Command("Run this line on MATLAB Engine", "engine.runLine", Arrays.asList(src, uri, currentLineIndex))) 270 | ); 271 | }); 272 | } 273 | 274 | private void changeDirIfChanged(String newUri) { 275 | if (MATLABEngineSingleton.getInstance().isEngineReady() && !newUri.equals(uri)) { 276 | uri = newUri; 277 | String location = new File(uri).getParent(); 278 | MATLABEngineSingleton.getInstance().evalInMATLAB("cd " + location); 279 | } 280 | } 281 | 282 | @Override 283 | public void didOpen(DidOpenTextDocumentParams params) { 284 | String newUri = params.getTextDocument().getUri().replaceAll("file://", ""); 285 | changeDirIfChanged(newUri); 286 | src.set(params.getTextDocument().getText()); 287 | } 288 | 289 | @Override 290 | public void didChange(DidChangeTextDocumentParams params) { 291 | String newUri = params.getTextDocument().getUri().replaceAll("file://", ""); 292 | changeDirIfChanged(newUri); 293 | for (TextDocumentContentChangeEvent changeEvent : params.getContentChanges()) { 294 | // Will be full update because we specified that is all we support 295 | if (changeEvent.getRange() != null) { 296 | throw new UnsupportedOperationException("Range should be null for full document update."); 297 | } 298 | if (changeEvent.getRangeLength() != null) { 299 | throw new UnsupportedOperationException("RangeLength should be null for full document update."); 300 | } 301 | src.set(changeEvent.getText()); 302 | } 303 | } 304 | 305 | @Override 306 | public void didClose(DidCloseTextDocumentParams params) { 307 | 308 | } 309 | 310 | @Override 311 | public void didSave(DidSaveTextDocumentParams params) { 312 | 313 | } 314 | } 315 | -------------------------------------------------------------------------------- /src/main/java/org/tokor/lspmatlab/MATLABWorkspaceService.java: -------------------------------------------------------------------------------- 1 | package org.tokor.lspmatlab; 2 | 3 | import com.google.gson.JsonObject; 4 | import com.google.gson.JsonPrimitive; 5 | import org.eclipse.lsp4j.*; 6 | import org.eclipse.lsp4j.jsonrpc.CompletableFutures; 7 | import org.eclipse.lsp4j.services.WorkspaceService; 8 | import org.slf4j.Logger; 9 | import org.slf4j.LoggerFactory; 10 | 11 | import java.io.StringWriter; 12 | import java.util.List; 13 | import java.util.concurrent.CompletableFuture; 14 | 15 | public class MATLABWorkspaceService implements WorkspaceService { 16 | 17 | public static final Logger logger = LoggerFactory.getLogger(MATLABWorkspaceService.class); 18 | 19 | @Override 20 | public void didChangeConfiguration(DidChangeConfigurationParams params) { 21 | 22 | } 23 | 24 | @Override 25 | public void didChangeWatchedFiles(DidChangeWatchedFilesParams params) { 26 | 27 | } 28 | 29 | @Override 30 | public CompletableFuture executeCommand(ExecuteCommandParams params) { 31 | return CompletableFutures.computeAsync(checker -> { 32 | String command = params.getCommand(); 33 | List args = params.getArguments(); 34 | StringWriter writer = new StringWriter(); 35 | switch (command) { 36 | case "engine.run": 37 | MATLABEngineSingleton.getInstance().evalInMATLAB(((JsonObject) args.get(0)).get("value").getAsString(), writer); 38 | break; 39 | case "engine.runLine": 40 | String src = ((JsonObject) args.get(0)).get("value").getAsString(); 41 | int lineNumber = ((JsonPrimitive) args.get(2)).getAsInt(); 42 | String line = src.split("\n")[lineNumber]; 43 | logger.info("line no:" + Integer.toString(lineNumber) + ", str:" + line); 44 | MATLABEngineSingleton.getInstance().evalInMATLAB(line, writer); 45 | break; 46 | } 47 | String result = writer.toString(); 48 | logger.info("Result:\n" + result); 49 | return result; 50 | }); 51 | } 52 | 53 | @Override 54 | public void didChangeWorkspaceFolders(DidChangeWorkspaceFoldersParams params) { 55 | List newWorkspace = params.getEvent().getAdded(); 56 | String location = newWorkspace.get(0).getUri().replaceAll("file://", ""); 57 | logger.info("Folder changed to: " + location); 58 | if (MATLABEngineSingleton.getInstance().isEngineReady()) { 59 | MATLABEngineSingleton.getInstance().evalInMATLAB("cd " + location); 60 | } 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /src/main/resources/logback.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | System.err 4 | 5 | %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger {%mdc} - %msg%n 6 | 7 | 8 | 9 | 10 | 11 | 12 | --------------------------------------------------------------------------------