Advanced search (#97)

Advanced Search

Author: MohammadMD1383

build.gradle.kts

@@ -5,7 +5,7 @@ buildscript {
 }
 
 plugins {
-	id("org.jetbrains.intellij") version "1.13.3"
+	id("org.jetbrains.intellij") version "1.14.1"
 	kotlin("jvm") version "1.8.21"
 	java
 }
@@ -26,7 +26,7 @@ fun DependencyHandlerScope.classpath(path: String) {
 }
 
 group = "ir.mmd.intellijDev"
-version = "4.4.0"
+version = "4.5.0"
 
 sourceSets["main"].java.srcDirs("src/main/gen")
 
@@ -49,16 +49,34 @@ kotlin {
 
 tasks {
 	compileKotlin {
-		kotlinOptions {
-			freeCompilerArgs += listOf(
-				"-Xjvm-default=all",
-				"-Xcontext-receivers"
-			)
+		compilerOptions {
+			freeCompilerArgs.add("-Xjvm-default=all")
+			freeCompilerArgs.add("-Xcontext-receivers")
 		}
 	}
 
+	val createOpenApiSourceJar by registering(Jar::class) {
+		from(sourceSets.main.get().java) {
+			include("**/*.java")
+		}
+		
+		from(kotlin.sourceSets.main.get().kotlin) {
+			include("**/*.kt")
+		}
+		
+		destinationDirectory.set(layout.buildDirectory.dir("libs"))
+		archiveClassifier.set("src")
+	}
+	
 	buildPlugin {
+		dependsOn(createOpenApiSourceJar)
+		
 		duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+		
+		from(createOpenApiSourceJar) {
+			into("lib/src")
+		}
+		
 		from("docs/site") {
 			into("docs")
 		}
@@ -84,9 +102,11 @@ tasks {
 		sinceBuild.set("231")
 		untilBuild.set("233.*")
 		changeNotes.set("""
+			<h2>Meet the new Feature: Advanced Search! (since v4.5)</h2>
+			
 			<ul>
-				<li>New Feature<b></b>: #73 add option to specify \n count between duplications</li>
-				<li>New Feature<b></b>: Smart Temporary File (which provides all code insight features)</li>
+				<li>New Feature<b></b>: #96 Advanced Search</li>
+				<li>New Feature<b></b>: advanced search support for java (beta)</li>
 			</ul>
 			<div>
 				To install nightly builds use <b>Download And Install Nightly Build</b> Action

docs/docs/Actions Documetation/Advanced Search.md

@@ -0,0 +1,3 @@
+# Advanced Search <em>(NEW!)</em>
+
+This page is a shortcut! view the main topic at [Advanced Search](Find/advanced/index.md)

docs/docs/Actions Documetation/Find/advanced/For Developers/index.md

@@ -0,0 +1,34 @@
+# For Developers
+
+## Contribute To Actionable
+
+If you're interested in developing and improving actionable plugin, you're welcome!
+
+1. Fork Actionable
+2. add advanced search functionality in package: `ir.mmd.intellijDev.Actionable.find.advanced.agent` by creating a new package representing the
+   language you want to provide advanced search support.
+3. register the new language support in `plugin.xml` like so: `<advancedSearch.providerFactory factoryClass="..." language="..." />`
+4. create a PR.
+5. that's it!
+
+[//]: # (@formatter:off)
+!!! note
+    for examples of how to implement such functionality you can explore the `ir.mmd.intellijDev.Actionable.find.advanced.agent.java` package.
+
+    for Q&A please refer to the discussions page of the actionable repository. feel free to ask any question.
+[//]: # (@formatter:on)
+
+## Separate Plugin
+
+If you're developer of a plugin (especially a custom language), and want to provide advanced search support, you're welcome!
+
+1. add Actionable dependency to your plugin in `build.gradle` (v4.5 onwards, which includes advanced search)
+2. add Actionable dependency to your `plugin.xml`: `<depends optional="true" config-file="...">ir.mmd.intellijDev.Actionable</depends>`
+3. reload project
+4. add actionable extension namespace: `<extensions defaultExtensionNs="ir.mmd.intellijDev.Actionable">`
+5. add advanced search provider: `<advancedSearch.providerFactory factoryClass="..." language="..." />`<br>
+   for `providerFactory` you need to extend `ir.mmd.intellijDev.Actionable.find.advanced.agent.AdvancedSearchProviderFactoryBean`<br>
+   `language` is your language that you want to provide this functionality for.
+6. go with examples inside `ir.mmd.intellijDev.Actionable.find.advanced.agent.java` package
+7. ask any questions in discussions page of the actionable repository.
+8. publish your plugin!

docs/docs/Actions Documetation/Find/advanced/Supported Languages/Java.md

@@ -0,0 +1,65 @@
+For `java` the syntax is as follows:
+
+```AdvancedSearch
+[<entry> [<identifier> [<parameters>]]] [<inner-block>] 
+```
+
+and inside inner block as follows:
+
+```AdvancedSearch
+[<entry> [<identifier> [<parameters>]]] [<inner-block>]
+# or
+[<identifier> [<parameters>]] [<inner-block>]
+```
+
+### Example
+
+```AdvancedSearch
+language: 'java'
+scope: 'all'
+scan-source: 'false'
+
+$class {
+    extends 'java.lang.Runnable'
+    implements 'my.package.Interface'
+    has-method 'doSomething' { has-param 'java.lang.String _' }
+}
+```
+
+This piece of code tells everything! no need to describe what you will find...
+
+[//]: # (@formatter:off)
+!!! note
+    all the variables, identifiers, parameters and properties with their possible values are documented.
+    you can see the documentation right inside the IDE in completion and using quick doc ++ctrl+q++.
+[//]: # (@formatter:on)
+
+## Properties
+
+* `scope`: the search scope: can be `project` or `all`
+* `scan-source`: if set to `false` the search uses stubs only, otherwise full sources will be scanned
+
+## Variables ($...)
+
+* `$type`: any type: class, interface, ...
+* `$class`
+* `$interface`
+* `$annotation`
+* `$method`
+
+## Identifiers
+
+* `has-param`: checks that this method has exactly all the parameters specified
+* `with-param`: like `has-param`, but checks that at least these parameters are present
+* `name-matches`: checks that the name of the entry matches this regexp
+* `super-of`: checks that this type is the super type of all types specified in parameters
+* `extends`: checks that this type extends all the types specified in parameters
+* `implements`: checks that this type implements all the interfaces specified in parameters
+* `direct-super-of`: check that this type is directly the super type of all types specified in parameters
+* `extends-directly`: check that this type directly extends all the types specified in parameters
+* `implements-directly`: check that this type directly implements all the interfaces specified in parameters
+* `has-modifier`: checks that this entry has at least all the modifiers specified in parameters
+* `has-method`: checks that this type has methods with names specified in parameters
+* `has-method-directly`: checks that this type has methods that are defined in the type itself, not just inherited
+* `is-anonymous`: checks that this type is an anonymous class
+* `not-anonymous`: checks that this type is not an anonymous class

docs/docs/Actions Documetation/Find/advanced/Supported Languages/index.md

@@ -0,0 +1,4 @@
+# Supported Languages
+
+In this section you can find all the languages, with detailed description on syntax and usage,
+that are supported.

docs/docs/Actions Documetation/Find/advanced/index.md

@@ -0,0 +1,42 @@
+# Introduction To Advanced Search
+
+As the name shouts, this is a utility feature that helps you search in the project in an advanced level!
+Even better than IDE does!
+
+_(Though this feature is still at ==early== stages... :))_
+
+## Quick Overview
+
+[//]: # (@formatter:off)
+!!! note
+    This feature is currently implemented for java.
+[//]: # (@formatter:on)
+
+1. Create a file _(may be an scratch file, not to mess out your project structure)_ with `.aas` extension.
+2. with the help of ==auto completion== go ahead!
+3. you will find a gutter icon on first statement, click on that, and the search process will start shortly.
+4. you will see your search results in the find toolwindow as soon as one item is found!
+
+Take a look at this example:
+
+```AdvancedSearch title='hello world.aas'
+language: 'Java'
+scope: 'all'
+
+$class extends 'java.lang.Runnable'
+```
+
+with this, you will find all classes that extend `java.lang.Runnable`
+
+To see detailed description about all supported language please visit [here](Supported%20Languages/index.md)
+
+## Basics
+
+1. ==the first thing is to specify the `language` property.== this tells the engine which language you want to do search in.
+2. after that auto completion will be expanded, and all the variables, identifiers, parameters that are supported for that language will become
+   available.
+
+## For Developers
+
+If you're interested in advanced search, and you want to implement this feature for your favorite language,
+you can refer to this [section](For%20Developers/index.md) for more info on how to extend this...

docs/mkdocs.yml

@@ -3,6 +3,7 @@ repo_name: MohammadMD1383/Actionable
 repo_url: https://github.com/MohammadMD1383/Actionable
 theme:
   name: material
+  custom_dir: overrides
 
   features:
     - navigation.tracking

docs/overrides/main.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block announce %}
+<h1 style="text-align: center;">Meet The New Feature! - Advanced Search</h1>
+<div style="text-align: center;">
+    Go to <code>Actions Documentation > Advanced Search</code> to discover this new feature!
+</div>
+{% endblock %}