diff --git a/action_basics/build.gradle b/action_basics/build.gradle new file mode 100644 index 000000000..7cb52ea20 --- /dev/null +++ b/action_basics/build.gradle @@ -0,0 +1,33 @@ +plugins { + id 'java' + id 'org.jetbrains.intellij' version '0.4.7' +} + +group 'org.intellij.sdk' +version '2.0.0' + +sourceCompatibility = 1.8 + +repositories { + mavenCentral() +} + +dependencies { + testCompile group: 'junit', name: 'junit', version: '4.12' +} + +// See https://github.com/JetBrains/gradle-intellij-plugin/ +intellij { + version '2019.1' +} +patchPluginXml { +} + +// Define javadoc paths, force rebuild before jar is built +javadoc { + // Set of source files to include + source = sourceSets.main.java.srcDirs + // Include all class files, e.g. from libraries + classpath = sourceSets.main.compileClasspath +} +jar.dependsOn javadoc diff --git a/action_basics/gradle/wrapper/gradle-wrapper.jar b/action_basics/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..94336fcae Binary files /dev/null and b/action_basics/gradle/wrapper/gradle-wrapper.jar differ diff --git a/action_basics/gradle/wrapper/gradle-wrapper.properties b/action_basics/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..290541c73 --- /dev/null +++ b/action_basics/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/action_basics/gradlew b/action_basics/gradlew new file mode 100755 index 000000000..cccdd3d51 --- /dev/null +++ b/action_basics/gradlew @@ -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" "$@" diff --git a/action_basics/gradlew.bat b/action_basics/gradlew.bat new file mode 100644 index 000000000..f9553162f --- /dev/null +++ b/action_basics/gradlew.bat @@ -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 diff --git a/action_basics/settings.gradle b/action_basics/settings.gradle new file mode 100644 index 000000000..45b6826e6 --- /dev/null +++ b/action_basics/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'action_basics' + diff --git a/action_basics/src/main/java/icons/ActionBasicsIcons.java b/action_basics/src/main/java/icons/ActionBasicsIcons.java new file mode 100644 index 000000000..bfd0e4392 --- /dev/null +++ b/action_basics/src/main/java/icons/ActionBasicsIcons.java @@ -0,0 +1,12 @@ +// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. + +package icons; + +import com.intellij.openapi.util.IconLoader; + +import javax.swing.*; + +public class ActionBasicsIcons { +public static final Icon Sdk_default_icon = IconLoader.getIcon("/icons/sdk_16.svg"); + +} diff --git a/action_basics/src/main/java/org/intellij/sdk/action/CustomDefaultActionGroup.java b/action_basics/src/main/java/org/intellij/sdk/action/CustomDefaultActionGroup.java new file mode 100644 index 000000000..52af8cd1d --- /dev/null +++ b/action_basics/src/main/java/org/intellij/sdk/action/CustomDefaultActionGroup.java @@ -0,0 +1,35 @@ +// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. + +package org.intellij.sdk.action; + +import com.intellij.openapi.actionSystem.AnActionEvent; +import com.intellij.openapi.actionSystem.CommonDataKeys; +import com.intellij.openapi.actionSystem.DefaultActionGroup; +import com.intellij.openapi.editor.Editor; +import icons.ActionBasicsIcons; + +/** + * Creates an action group to contain menu actions. See plugin.xml declarations. + * @author Anna Bulenkova + * @author jhake + */ +public class CustomDefaultActionGroup extends DefaultActionGroup { + + /** + * Given CustomDefaultActionGroup is derived from ActionGroup, in this context + * update() determines whether the action group itself should be enabled or disabled. + * Requires an editor to be active in order to enable the group functionality. + * @see com.intellij.openapi.actionSystem.AnAction#update(AnActionEvent) + * @param event Event received when the associated group-id menu is chosen. + */ + @Override + public void update(AnActionEvent event) { + // Enable/disable depending on whether user is editing + Editor editor = event.getData(CommonDataKeys.EDITOR); + event.getPresentation().setEnabled(editor != null); + // Always make visible. + event.getPresentation().setVisible(true); + // Take this opportunity to set an icon for the menu entry. + event.getPresentation().setIcon(ActionBasicsIcons.Sdk_default_icon); + } +} diff --git a/action_basics/src/main/java/org/intellij/sdk/action/DynamicActionGroup.java b/action_basics/src/main/java/org/intellij/sdk/action/DynamicActionGroup.java new file mode 100644 index 000000000..8db9fddbd --- /dev/null +++ b/action_basics/src/main/java/org/intellij/sdk/action/DynamicActionGroup.java @@ -0,0 +1,40 @@ +// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. + +package org.intellij.sdk.action; + +import com.intellij.icons.AllIcons; +import com.intellij.openapi.actionSystem.ActionGroup; +import com.intellij.openapi.actionSystem.AnAction; +import com.intellij.openapi.actionSystem.AnActionEvent; +import icons.ActionBasicsIcons; +import org.jetbrains.annotations.NotNull; + +/** + * Demonstrates adding an action group to a menu statically in plugin.xml, and then creating a menu item + * within the group at runtime. See plugin.xml for the declaration of DynamicActionGroup, + * and note the group declaration does not contain an action. + * DynamicActionGroup is based on ActionGroup because menu children are determined + * on rules other than just positional constraints. + * + * @author Anna Bulenkova + * @see ActionGroup + */ +public class DynamicActionGroup extends ActionGroup { + + /** + * Returns an array of menu actions for the group. + * + * @param anActionEvent Event received when the associated group-id menu is chosen. + * @return AnAction[] An instance of AnAction, in this case containing a single instance of the + * PopDialogAction class. + */ + @NotNull + @Override + public AnAction[] getChildren(AnActionEvent anActionEvent) { + return new AnAction[]{ new PopDialogAction("Action Added at Runtime", + "Dynamic Action Demo", + ActionBasicsIcons.Sdk_default_icon) + }; + } + +} diff --git a/action_basics/src/main/java/org/intellij/sdk/action/PopDialogAction.java b/action_basics/src/main/java/org/intellij/sdk/action/PopDialogAction.java new file mode 100644 index 000000000..12e45a515 --- /dev/null +++ b/action_basics/src/main/java/org/intellij/sdk/action/PopDialogAction.java @@ -0,0 +1,78 @@ +// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. + +package org.intellij.sdk.action; + +import com.intellij.openapi.actionSystem.AnAction; +import com.intellij.openapi.actionSystem.AnActionEvent; +import com.intellij.openapi.actionSystem.CommonDataKeys; +import com.intellij.openapi.project.Project; +import com.intellij.openapi.ui.Messages; +import com.intellij.pom.Navigatable; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import javax.swing.*; + +/** + * Action class to demonstrate how to interact with the IntelliJ Platform. + * The only action this class performs is to provide the user with a popup dialog as feedback. + * Typically this class is instantiated by the IntelliJ Platform framework based on declarations + * in the plugin.xml file. But when added at runtime this class is instantiated by an action group. + */ +public class PopDialogAction extends AnAction { + + /** + * This default constructor is used by the IntelliJ Platform framework to + * instantiate this class based on plugin.xml declarations. Only needed in PopDialogAction + * class because a second constructor is overridden. + * @see AnAction#AnAction() + */ + public PopDialogAction() { + super(); + } + + /** + * This constructor is used to support dynamically added menu actions. + * It sets the text, description to be displayed for the menu item. + * Otherwise, the default AnAction constructor is used by the IntelliJ Platform. + * @param menuText The text to be displayed as a menu item. + * @param menuDescription The description of the menu item. + * @param menuIcon The icon to be used with the menu item. + */ + public PopDialogAction(@Nullable String menuText, @Nullable String menuDescription, @Nullable Icon menuIcon) { + super(menuText, menuDescription, menuIcon); + } + + /** + * Gives the user feedback when the dynamic action menu is chosen. + * Pops a simple message dialog. See the psi_demo plugin for an + * example of how to use AnActionEvent to access data. + * @param event Event received when the associated menu item is chosen. + */ + @Override + public void actionPerformed(@NotNull AnActionEvent event) { + // Using the event, create and show a dialog + Project currentProject = event.getProject(); + StringBuffer dlgMsg = new StringBuffer(event.getPresentation().getText() + " Selected!"); + String dlgTitle = event.getPresentation().getDescription(); + // If an element is selected in the editor, add info about it. + Navigatable nav = event.getData(CommonDataKeys.NAVIGATABLE); + if (nav != null) { + dlgMsg.append(String.format("\nSelected Element: %s", nav.toString())); + } + Messages.showMessageDialog(currentProject, dlgMsg.toString(), dlgTitle, Messages.getInformationIcon()); + } + + /** + * Determines whether this menu item is available for the current context. + * Requires a project to be open. + * @param evnt Event received when the associated group-id menu is chosen. + */ + @Override + public void update(AnActionEvent evnt) { + // Set the availability based on whether a project is open + Project project = evnt.getProject(); + evnt.getPresentation().setEnabledAndVisible(project != null); + } + +} diff --git a/action_basics/src/main/resources/META-INF/plugin.xml b/action_basics/src/main/resources/META-INF/plugin.xml new file mode 100644 index 000000000..13793426a --- /dev/null +++ b/action_basics/src/main/resources/META-INF/plugin.xml @@ -0,0 +1,108 @@ + + + + + org.intellij.sdk.action + + + SDK Action Sample Project + + + 2.0.0 + + + + + + + Adds entries to the Tools menu. + ]]> + + + +
  • 2.0.0 Renamed from register_actions and converted to Gradle project.
    • +
  • 1.1 Refactor to give users feedback when menu items are selected.
    • +
  • 1.0 Release 2018.3 and earlier.
    • + + ]]> +     + + + IntelliJ Platform SDK + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +     \ No newline at end of file diff --git a/action_basics/src/main/resources/META-INF/pluginIcon.svg b/action_basics/src/main/resources/META-INF/pluginIcon.svg new file mode 100644 index 000000000..613290897 --- /dev/null +++ b/action_basics/src/main/resources/META-INF/pluginIcon.svg @@ -0,0 +1,58 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/action_basics/src/main/resources/icons/sdk_16.svg b/action_basics/src/main/resources/icons/sdk_16.svg new file mode 100644 index 000000000..011462b8a --- /dev/null +++ b/action_basics/src/main/resources/icons/sdk_16.svg @@ -0,0 +1,7 @@ + + + + + + +