AppCode 2023.1 Help

Built-in IDE macros

AppCode provides a number of built-in macros, which are variables that you can use to specify various paths, options, and other command-line arguments for external tools and run configurations. Their values depend on the current context. For example, if you need to pass the name of the directory that contains the current file, you can use $FileDirName$. Or if you need the full path: $FileDir$.

Macro

Description

$Classpath$

The complete classpath of the project.

$ClasspathEntry$

The entry in the classpath related to the current file.

$ClipboardContent$

The current contents of the system clipboard.

$ContentRoot$

The path to the content root to which the current file belongs.

$FileClass$

The name of the class defined by the current file.

$FileDir$

The absolute path to the directory that contains the current file.

$FileDirName$

The name of the directory that contains the current file.

$FileDirPathFromParent(dir)$

The path to the directory that contains the current file relative to a parent directory specified as the parameter dir.

$FileDirRelativeToProjectRoot$

The path to the directory that contains the current file relative to the module's content root.

$FileEncoding$

The encoding of the current file.

$FileExt$

The extension of the current file.

$FileFQPackage$

The fully qualified package name of the current file.

For example, in the case of com.example.mypackage.MyClass, the fully qualified name of the package is com.example.mypackage.

$FileName$

The name of the current file (including all extensions).

$FileNameWithoutAllExtensions$

The name of the current file without any extensions. This is useful when the file's extension got duplicated. It will remove any periods and everything that follows.

For example, if the file is hello.txt.txt, the $FileNameWithoutAllExtensions$ macro will return hello.

$FileNameWithoutExtension$

The name of the file without the extension. This removes only one occurrence of a period followed by an extension.

For example, if the file is hello.txt.txt, the $FileNameWithoutExtension$ macro will return hello.txt.

$FilePackage$

The immediate package name (not fully qualified) of the current file.

For example, in the case of com.example.mypackage.MyClass, the name of the package is mypackage.

$FileParentDir$

The name of the parent directory to the directory where the current file is located.

$FilePath$

The absolute path to the current file.

$FilePathRelativeToProjectRoot$

The path to the current file relative to the module's content root.

$FilePrompt$

Shows the file system dialog to select the file.

$FileRelativeDir$

The path to the directory where the current file is located relative to the module's content root.

$FileRelativePath$

The path to the current file relative to the module's content root.

$JavaDocPath$

The JavaDoc output directory.

$ModuleFileDir$

The absolute path to the directory where the current module file is located.

$ModuleFilePath$

The absolute path to the current module file.

$ModuleName$

The name of the current module file without the extension.

$ModuleSourcePath$

The current module's source path.

$OutputPath$

The current module's output path.

$ProjectFileDir$

The absolute path to the current project directory.

$ProjectName$

The name of the current project directory.

$Projectpath$

The current project's source path.

$Prompt$

Shows a dialog to pass an arbitrary string.

$RemoteProjectFileDir$

The absolute path to the project directory on a remote server.

$UnixSeparators(path)$

Takes a path as the parameter and converts all separators to forward slashes.

For example, $UnixSeparators(\foo\bar)$ will return /foo/bar.

Paths to resources outside the project

You can use path variables to point to resources outside the project. Add configured path variables the same way as you add macros – with ampersands before and after the variable: $MY_VAR$.

Create a new path variable

  1. Press Ctrl+Alt+S to open the IDE settings and select Appearance & Behavior | Path Variables.

  2. Click the Add button, enter the name and value of the variable, and click OK to apply the changes.

Custom macros

You can define a custom macro for your plugin by using the com.intellij.ide.macro.Macro extension point. After that, register the macro in plugin.xml:

<macro implementation="full.macro.class.Name"/>

For more information about the available extension points, see IntelliJ Platform Plugin SDK documentation.

Last modified: 13 December 2022