mirrors/IJava
1
0
Fork 0
mirror of https://github.com/SpencerPark/IJava.git synced 2025-04-18 04:16:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Base kernel implementation

Browse Source
This commit is contained in:
SpencerPark 2017-09-30 20:43:43 -04:00
commit 3fcad22106
11 changed files with 643 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
.gradle/
.idea/
build/

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2017 Spencer Park
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

7
README.md Normal file
View File

@ -0,0 +1,7 @@
# Jupyter Java Kernel
A java
### Requirements
* `jdk-9`, **NOT** `jre`. The kernel uses the jshell tool and by extension the java compiler

79
build.gradle Normal file
View File

@ -0,0 +1,79 @@
import org.apache.tools.ant.filters.ReplaceTokens
buildscript {
repositories {
mavenLocal()
}
dependencies {
classpath 'io.github.spencerpark:jupyter-kernel-installer:1.0.1'
}
}
plugins {
id 'com.github.hierynomus.license' version '0.14.0'
}
apply plugin: 'java'
apply plugin: 'maven-publish'
apply plugin: 'io.github.spencerpark.jupyter-kernel-installer'
group 'io.github.spencerpark'
version '1.0-SNAPSHOT'
task wrapper(type: Wrapper) {
gradleVersion = '4.1'
}
compileJava {
sourceCompatibility = 1.9
targetCompatibility = 1.9
}
configurations {
shade
shade.transitive = false
compile.extendsFrom(shade)
}
repositories {
mavenLocal()
mavenCentral()
}
dependencies {
shade group: 'io.github.spencerpark', name: 'jupyter-jvm-basekernel', version: '1.0.3-SNAPSHOT'
testCompile group: 'junit', name: 'junit', version: '4.12'
}
jar {
//Include all shaded dependencies in the jar
from configurations.shade
.collect {it.isDirectory() ? it : zipTree(it)}
manifest {
attributes('Main-class': 'io.github.spencerpark.IJava')
}
}
processResources {
def tokens = [
'version': project.version,
'project': project.name
]
inputs.properties(tokens)
filter ReplaceTokens, tokens: tokens
}
publishing {
publications {
mavenJava(MavenPublication) {
from components.java
}
}
}
jupyter {
kernelDisplayName = 'Java'
kernelLanguage = 'java'
}

BIN
gradle/wrapper/gradle-wrapper.jar vendored Normal file
View File

Binary file not shown.

6
gradle/wrapper/gradle-wrapper.properties vendored Normal file
View File

@ -0,0 +1,6 @@
#Sat Sep 30 20:02:10 EDT 2017
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-all.zip

172
gradlew vendored Normal file
View File

@ -0,0 +1,172 @@
#!/usr/bin/env sh
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn () {
echo "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"

84
gradlew.bat vendored Normal file
View File

@ -0,0 +1,84 @@
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS=
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

1
settings.gradle Normal file
View File

@ -0,0 +1 @@
rootProject.name = 'jupyter-java-kernel'

58
src/main/java/io/github/spencerpark/IJava.java Normal file
View File

@ -0,0 +1,58 @@
/**
* The MIT License (MIT)
*
* Copyright (c) 2017 Spencer Park
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package io.github.spencerpark;
import io.github.spencerpark.jupyter.channels.JupyterConnection;
import io.github.spencerpark.jupyter.channels.JupyterSocket;
import io.github.spencerpark.jupyter.kernel.KernelConnectionProperties;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.logging.Level;
public class IJava {
public static void main(String[] args) throws Exception {
if (args.length < 1)
throw new IllegalArgumentException("Missing connection file argument");
Path connectionFile = Paths.get(args[0]);
if (!Files.isRegularFile(connectionFile))
throw new IllegalArgumentException("Connection file '" + connectionFile + "' isn't a file.");
String contents = new String(Files.readAllBytes(connectionFile));
JupyterSocket.JUPYTER_LOGGER.setLevel(Level.WARNING);
KernelConnectionProperties connProps = KernelConnectionProperties.parse(contents);
JupyterConnection connection = new JupyterConnection(connProps);
JavaKernel kernel = new JavaKernel();
kernel.becomeHandlerForConnection(connection);
connection.connect();
connection.waitUntilClose();
}
}

212
src/main/java/io/github/spencerpark/JavaKernel.java Normal file
View File

@ -0,0 +1,212 @@
/**
* The MIT License (MIT)
*
* Copyright (c) 2017 Spencer Park
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package io.github.spencerpark;
import io.github.spencerpark.jupyter.kernel.BaseKernel;
import io.github.spencerpark.jupyter.kernel.LanguageInfo;
import io.github.spencerpark.jupyter.kernel.ReplacementOptions;
import io.github.spencerpark.jupyter.kernel.util.CharPredicate;
import io.github.spencerpark.jupyter.messages.MIMEBundle;
import jdk.jshell.JShell;
import jdk.jshell.JShellException;
import jdk.jshell.SnippetEvent;
import jdk.jshell.SourceCodeAnalysis;
import java.io.OutputStream;
import java.io.PrintStream;
import java.util.List;
import java.util.stream.Collectors;
public class JavaKernel extends BaseKernel {
private static OutputStream stdout = new OutputStream() {
@Override
public void write(int b) {
System.out.write(b);
}
};
private static OutputStream stderr = new OutputStream() {
@Override
public void write(int b) {
System.err.write(b);
}
};
private static final CharPredicate IDENTIFIER_CHAR = CharPredicate.builder()
.inRange('a', 'z')
.inRange('A', 'Z')
.inRange('0', '9')
.match('_')
.build();
private static final CharPredicate WS = CharPredicate.anyOf(" \t\n\r");
private final JShell shell;
private final SourceCodeAnalysis sourceAnalyzer;
private final LanguageInfo languageInfo;
private final String banner;
private final List<LanguageInfo.Help> helpLinks;
public JavaKernel() {
this.shell = JShell.builder()
.out(new PrintStream(stdout))
.err(new PrintStream(stderr))
.build();
this.sourceAnalyzer = this.shell.sourceCodeAnalysis();
this.languageInfo = new LanguageInfo.Builder("Java")
.version(Runtime.version().toString())
.mimetype("text/x-java-source")
.fileExtension(".java")
.pygments("java")
.codemirror("java")
.build();
this.banner = String.format("Java %s", Runtime.version());
this.helpLinks = List.of(
new LanguageInfo.Help("Java", "https://docs.oracle.com/javase/tutorial/java/nutsandbolts/index.html")
);
}
@Override
public LanguageInfo getLanguageInfo() {
return this.languageInfo;
}
@Override
public String getBanner() {
return this.banner;
}
@Override
public List<LanguageInfo.Help> getHelpLinks() {
return this.helpLinks;
}
private SourceCodeAnalysis.CompletionInfo analyzeCompletion(String source) {
return this.sourceAnalyzer.analyzeCompletion(source);
}
@Override
public MIMEBundle eval(String expr) throws Exception {
String lastEvalResult = null;
SourceCodeAnalysis.CompletionInfo info;
for (info = analyzeCompletion(expr); info.completeness().isComplete(); info = analyzeCompletion(info.remaining())) {
String src = info.source();
for (SnippetEvent event : this.shell.eval(src)) {
if (event.causeSnippet() == null) {
// Fresh snippet
JShellException e = event.exception();
if (e != null)
throw e;
if (!event.status().isDefined()) {
throw new IllegalArgumentException("Cannot compile '" + event.snippet().source() + "'");
}
lastEvalResult = event.value();
}
}
}
if (info.completeness() != SourceCodeAnalysis.Completeness.EMPTY) {
// There is source that was not evaluated because it was not complete
// TODO raise a better exception
throw new IllegalArgumentException(String.format("Incomplete source code: '%s'", info.remaining()));
}
return lastEvalResult == null || lastEvalResult.isEmpty() ? null : new MIMEBundle(lastEvalResult);
}
@Override
public MIMEBundle inspect(String code, int at, boolean extraDetail) {
// Move the code position to the end of the identifier to make the inspection work at any
// point in the identifier. i.e "System.o|ut" or "System.out|" will return the same result.
while (at + 1 < code.length() && IDENTIFIER_CHAR.test(code.charAt(at + 1))) at++;
// If the next non-whitespace character is an opening paren '(' then this must be included
// in the documentation search to ensure it searches for a method call.
int parenIdx = at;
while (parenIdx + 1 < code.length() && WS.test(code.charAt(parenIdx + 1))) parenIdx++;
if (parenIdx + 1 < code.length() && code.charAt(parenIdx + 1) == '(') at = parenIdx + 1;
List<SourceCodeAnalysis.Documentation> documentations = this.sourceAnalyzer.documentation(code, at, extraDetail);
if (documentations == null || documentations.isEmpty()) {
return null;
}
MIMEBundle fmtDocs = new MIMEBundle(
documentations.stream()
.map(doc -> {
String formatted = doc.signature();
String javadoc = doc.javadoc();
if (javadoc != null) formatted += '\n' + javadoc;
return formatted;
}).collect(Collectors.joining("\n\n")
)
);
fmtDocs.putHTML(
documentations.stream()
.map(doc -> {
String formatted = doc.signature();
// TODO consider compiling the javadoc to html for pretty printing
String javadoc = doc.javadoc();
if (javadoc != null) formatted += "<br/>" + javadoc;
return formatted;
}).collect(Collectors.joining("<br/><br/>")
)
);
return fmtDocs;
}
@Override
public ReplacementOptions complete(String code, int at) {
int[] end = new int[1]; // As of now this is always the same as the cursor...
List<SourceCodeAnalysis.Suggestion> suggestions = this.sourceAnalyzer.completionSuggestions(code, at, end);
if (suggestions == null || suggestions.isEmpty()) return null;
List<String> options = suggestions.stream()
.sorted((s1, s2) ->
s1.matchesType()
? s2.matchesType() ? 0 : -1
: s2.matchesType() ? 1 : 0
)
.map(SourceCodeAnalysis.Suggestion::continuation)
.collect(Collectors.toList());
return new ReplacementOptions(options, at, end[0]);
}
@Override
public String isComplete(String code) {
return super.isComplete(code);
}
@Override
public void onShutdown(boolean isRestarting) {
this.shell.close();
}
}