mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-30 18:27:49 +08:00
Restructure information on working with projects, remove duplicate information
This commit is contained in:
Dmitry Jemerov
parent
11453efa12
commit
671a98cbe3
@ -52,104 +52,10 @@ From the plugin developer's point of view, a project can be thought of as follow
|
||||
|
||||
A **project** consists of one or several **modules**. Each **module** includes the plugin source code and so called **order entries** that refer to **SDK** and **libraries** the module uses. By default, all modules uses the project SDK. In addition, a **module** can optionally have a set of **facets**.
|
||||
|
||||
This document explains how you can explore and change the structure of projects using API.
|
||||
For more information on each of these entities, see:
|
||||
|
||||
## Working with Projects
|
||||
|
||||
This section explains how to complete some common tasks related to management of projects.
|
||||
The Java classes and interfaces that you can use to explore and change the project contents are discussed.
|
||||
|
||||
### How to Work with Project Files?
|
||||
|
||||
The *IntelliJ Platform* stores the project configuration data in XML files. The list of those files depends on the plugin [project format](https://www.jetbrains.com/help/idea/about-projects.html).
|
||||
|
||||
For _file-based_ format projects, the information core to the project itself (e.g. location of the component modules, compiler settings, etc.) is stored in the `%project_name%.ipr` file.
|
||||
|
||||
The information about modules the project includes is stored in `%module_name%.iml` files. Module files are created for each module.
|
||||
|
||||
For _directory-based_ format projects, the project and workspace settings are stored in a number of XML files under the `%project_home_directory%/.idea` directory. Each XML file is responsible for its own set of settings and can be recognized by its name: `projectCodeStyle.xml`, `encodings.xml`, `vcs.xml` etc.
|
||||
|
||||
As for the file-based format projects, `.iml` files describe modules.
|
||||
|
||||
To work with projects and project files, you can use the following classes and interfaces:
|
||||
|
||||
* [`Project`](upsource:///platform/core-api/src/com/intellij/openapi/project/Project.java) interface.
|
||||
* [`ProjectRootManager`](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectRootManager.java) abstract class.
|
||||
* [`ProjectManager`](upsource:///platform/projectModel-api/src/com/intellij/openapi/project/ProjectManager.java) abstract class.
|
||||
* [`ProjectFileIndex`](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectFileIndex.java) interface.
|
||||
|
||||
Note that you don't need to access project files directly to load or save settings. See [Persisting State of Components](persisting_state_of_components.md) for more information.
|
||||
|
||||
Note that hereafter, the `project` variable is of the `Project` type. For example, for the opened project, you can get it from an action: `Project project = e.getProject();`
|
||||
|
||||
### How do I get a list of source roots for all modules in my project?
|
||||
|
||||
Use the `ProjectRootManager.getContentSourceRoots()` method. To clarify this, consider the following code snippet:
|
||||
|
||||
```java
|
||||
String projectName = project.getName();
|
||||
StringBuilder sourceRootsList = new StringBuilder();
|
||||
VirtualFile[] vFiles = ProjectRootManager.getInstance(project).getContentSourceRoots();
|
||||
for (VirtualFile file : vFiles) {
|
||||
sourceRootsList.append(file.getUrl()).append("\n");
|
||||
}
|
||||
|
||||
Messages.showInfoMessage("Source roots for the " + projectName + " plugin:\n" + sourceRootsList, "Project Properties");
|
||||
```
|
||||
|
||||
### How do I check whether a file is related to a project?
|
||||
|
||||
The *IntelliJ Platform* provides the `ProjectFileIndex` interface you can use to verify whether a file or directory is related to the specified IDEA project. This section explains how you can use this interface.
|
||||
|
||||
#### How do I get an instance of the ProjectFileIndex interface?
|
||||
|
||||
Use the `ProjectRootManager.getFileIndex()` method. For example:
|
||||
`ProjectFileIndex projectFileIndex = ProjectRootManager.getInstance(project).getFileIndex();`
|
||||
|
||||
#### How do I get a module to which a file belongs?
|
||||
|
||||
To determine a module in the project in question to which the specified [virtual file](architectural_overview/virtual_file.md) belongs, use the `ProjectFileIndex.getModuleForFile(virtualFile)` method:
|
||||
|
||||
```java
|
||||
Module module = ProjectRootManager.getInstance(project).getFileIndex().getModuleForFile(virtualFile);
|
||||
```
|
||||
|
||||
Note that this method returns `null` if the file does not belong to any module.
|
||||
|
||||
You can also use the `ProjectFileIndex.getContentRootForFile` method to get the module content root to which the specified file or directory belongs:
|
||||
|
||||
```java
|
||||
VirtualFile moduleContentRoot = ProjectRootManager.getInstance(project).getFileIndex().getContentRootForFile(virtualFileorDirectory);
|
||||
```
|
||||
|
||||
#### How do I get the module source root or library source root to which the specified file or directory belongs?
|
||||
|
||||
Use the `ProjectFileIndex.getSourceRootForFile` method. For example:
|
||||
|
||||
```java
|
||||
VirtualFile moduleSourceRoot = ProjectRootManager.getInstance(project).getFileIndex().getSourceRootForFile(virtualFileorDirectory);
|
||||
```
|
||||
|
||||
Note that this method returns `null` if the file or directory does not belong to any source root of modules in the project.
|
||||
|
||||
#### How do I check whether a file or directory is related to the project libraries?
|
||||
|
||||
The `ProjectFileIndex` interface implements a number of methods you can use to check whether the specified file belongs to the project library classes or library sources.
|
||||
|
||||
You can use the following methods:
|
||||
|
||||
* `ProjectFileIndex.isLibraryClassFile(virtualFile)`: Returns `true` if the specified `virtualFile` is a compiled class file.
|
||||
* `ProjectFileIndex.isInLibraryClasses(virtualFileorDirectory)`: Returns `true` if the specified `virtualFileorDirectory` belongs to library classes.
|
||||
* `ProjectFileIndex.isInLibrarySource(virtualFileorDirectory)`: Returns `true` if the specified `virtualFileorDirectory` belongs to library sources.
|
||||
|
||||
#### How do I get the project SDK?
|
||||
|
||||
* To get the project-level SDK: `Sdk projectSDK = ProjectRootManager.getInstance(project).getProjectSdk();`
|
||||
* To get the project-level SDK name: `String projectSDKName = ProjectRootManager.getInstance(project).getProjectSdkName();`
|
||||
|
||||
#### How do I set the project SDK?
|
||||
|
||||
* To set the project-level SDK: `ProjectRootManager.getInstance(project).setProjectSdk(Sdk jdk);`
|
||||
* To set the project-level SDK name: `ProjectRootManager.getInstance(project).setProjectSdkName(String name);`
|
||||
|
||||
Note that by default, the project modules use the project SDK. Optionally, you can configure individual SDK for each module.
|
||||
- [Project](/reference_guide/project_model/project.md)
|
||||
- [Module](/reference_guide/project_model/module.md)
|
||||
- [SDK](/reference_guide/project_model/sdk.md)
|
||||
- [Library](/reference_guide/project_model/facet.md)
|
||||
- [External system integration](/reference_guide/frameworks_and_external_apis/external_system_integration.md) (for projects imported from Gradle or similar build systems)
|
||||
|
||||
@ -12,34 +12,72 @@ For file based format projects, the information core to the project itself (e.g.
|
||||
|
||||
For directory based format projects, the project and workspace settings are stored in a number of XML files under the `%project_home_directory%/.idea` directory. Each XML file is responsible for its own set of settings and can be recognized by its name: `projectCodeStyle.xml`, `encodings.xml`, `vcs.xml` etc. As for the file-based format projects, `.iml` files describe modules.
|
||||
|
||||
Main classes providing work with the project model are located in the package [projectModel-api.openapi](upsource:///platform/projectModel-api/src/com/intellij/openapi). Basic API classes and interfaces for the concepts of [project](upsource:///platform/core-api/src/com/intellij/openapi/project/Project.java), [module](upsource:///platform/core-api/src/com/intellij/openapi/module/Module.java), [application](upsource:///platform/core-api/src/com/intellij/openapi/application/Application.java), and [component](upsource:///platform/core-api/src/com/intellij/openapi/components/ProjectComponent.java) are placed in the [core-api.openapi](upsource:///platform/core-api/src/com/intellij/openapi) package.
|
||||
Note that you don't need to access project files directly to load or save settings. See [Persisting State of Components](persisting_state_of_components.md) for more information.
|
||||
|
||||
### Finding source roots
|
||||
To work with projects and project files, you can use the following classes and interfaces:
|
||||
|
||||
To get an array of all the source roots for a project use `ProjectRootManager.getContentSourceRoots()` method like this code snippet shows:
|
||||
* [`Project`](upsource:///platform/core-api/src/com/intellij/openapi/project/Project.java) interface.
|
||||
* [`ProjectRootManager`](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectRootManager.java) abstract class.
|
||||
* [`ProjectManager`](upsource:///platform/projectModel-api/src/com/intellij/openapi/project/ProjectManager.java) abstract class.
|
||||
* [`ProjectFileIndex`](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectFileIndex.java) interface.
|
||||
|
||||
Other classes for working with the project model are located in the package [projectModel-api.openapi](upsource:///platform/projectModel-api/src/com/intellij/openapi). Basic API classes and interfaces for the concepts of [project](upsource:///platform/core-api/src/com/intellij/openapi/project/Project.java), [module](upsource:///platform/core-api/src/com/intellij/openapi/module/Module.java), [application](upsource:///platform/core-api/src/com/intellij/openapi/application/Application.java), and [component](upsource:///platform/core-api/src/com/intellij/openapi/components/ProjectComponent.java) are placed in the [core-api.openapi](upsource:///platform/core-api/src/com/intellij/openapi) package.
|
||||
|
||||
### How do I get a list of source roots for all modules in my project?
|
||||
|
||||
Use the `ProjectRootManager.getContentSourceRoots()` method. To clarify this, consider the following code snippet:
|
||||
|
||||
```java
|
||||
String projectName = project.getName();
|
||||
StringBuilder sourceRootsList = new StringBuilder();
|
||||
VirtualFile[] vFiles = ProjectRootManager.getInstance(project).getContentSourceRoots();
|
||||
for (VirtualFile file : vFiles) {
|
||||
sourceRootsList.append(file.getUrl()).append("\n");
|
||||
}
|
||||
|
||||
Messages.showInfoMessage("Source roots for the " + projectName + " plugin:\n" + sourceRootsList, "Project Properties");
|
||||
```
|
||||
|
||||
### Checking if a file belongs to a project
|
||||
|
||||
Use [ProjectFileIndex.java](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectFileIndex.java) to get this information.
|
||||
|
||||
### Getting an Instance of the ProjectFileIndex Interface
|
||||
|
||||
Use the `ProjectRootManager.getFileIndex()` method. For example:
|
||||
|
||||
Use [ProjectFileIndex.java](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectFileIndex.java) to get this information:
|
||||
```java
|
||||
ProjectFileIndex projectFileIndex = ProjectRootManager.getInstance(project).getFileIndex();
|
||||
```
|
||||
|
||||
Note that this method returns `null` if the file does not belong to any module. You can also use the `ProjectFileIndex.getContentRootForFile()` method to get the module content root to which the specified file or directory belongs:
|
||||
### How do I get the content or source root to which the specified file or directory belongs?
|
||||
|
||||
Use the `ProjectFileIndex.getContentRootForFile` and `ProjectFileIndex.getSourceRootForFile` methods. For example:
|
||||
|
||||
```java
|
||||
VirtualFile moduleContentRoot = ProjectRootManager.getInstance(project).getFileIndex().getContentRootForFile(virtualFileOrDirectory);
|
||||
VirtualFile moduleContentRoot = ProjectRootManager.getInstance(project).getFileIndex().getContentRootForFile(virtualFileorDirectory);
|
||||
VirtualFile moduleSourceRoot = ProjectRootManager.getInstance(project).getFileIndex().getSourceRootForFile(virtualFileorDirectory);
|
||||
```
|
||||
|
||||
Note that this method returns `null` if the file or directory does not belong to any source root of modules in the project.
|
||||
|
||||
### How do I check whether a file or directory is related to the project libraries?
|
||||
|
||||
The `ProjectFileIndex` interface implements a number of methods you can use to check whether the specified file belongs to the project library classes or library sources.
|
||||
|
||||
You can use the following methods:
|
||||
|
||||
* `ProjectFileIndex.isLibraryClassFile(virtualFile)`: Returns `true` if the specified `virtualFile` is a compiled class file.
|
||||
* `ProjectFileIndex.isInLibraryClasses(virtualFileorDirectory)`: Returns `true` if the specified `virtualFileorDirectory` belongs to library classes.
|
||||
* `ProjectFileIndex.isInLibrarySource(virtualFileorDirectory)`: Returns `true` if the specified `virtualFileorDirectory` belongs to library sources.
|
||||
|
||||
### How do I get the project SDK?
|
||||
|
||||
* To get the project-level SDK: `Sdk projectSDK = ProjectRootManager.getInstance(project).getProjectSdk();`
|
||||
* To get the project-level SDK name: `String projectSDKName = ProjectRootManager.getInstance(project).getProjectSdkName();`
|
||||
|
||||
### How do I set the project SDK?
|
||||
|
||||
* To set the project-level SDK: `ProjectRootManager.getInstance(project).setProjectSdk(Sdk jdk);`
|
||||
* To set the project-level SDK name: `ProjectRootManager.getInstance(project).setProjectSdkName(String name);`
|
||||
|
||||
Note that by default, the project modules use the project SDK. Optionally, you can configure individual SDK for each module.
|
||||
|
||||
## Changing the project structure
|
||||
|
||||
Utility classes which can be used for modifying a project structure can be found in the package [projectModel-impl.openapi](upsource:///platform/projectModel-impl/src/com/intellij/openapi). It's [roots](upsource:///platform/projectModel-impl/src/com/intellij/openapi/roots/) subpackage contains instances and utilities meant to work with project and module source roots, including [ModuleRootModificationUtil.java](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ModuleRootModificationUtil.java) and [ProjectRootUtil.java](upsource:///platform/projectModel-impl/src/com/intellij/openapi/projectRoots/impl/ProjectRootUtil.java).
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user