mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-28 01:07:49 +08:00
4e802980f2
* [webhelp] Fixes for TXP00152, TXP00002, test build 27 Jul 22:26 * [webhelp] Fixes for Part #4 TXP00010, EXCEPT decimal numbers in section titles * [webhelp] Fixes for Part #5 TXP00017 * [webhelp] Fixes for Part #4 TXP00010 - removed numbers from page section titles in "Custom Language Support Tutorial" and "Testing a Custom Language Plugin". * [webhelp] Removed numbers from page section titles in rest of project *.md files. * [new webhelp] Build #44 changes * [new webhelp] Maintenance merge from master * [new webhelp] Add placeholder file for webhelp import. * [webhelp] Correct redirects for file name changes * [webhelp] TOC not needed in webhelp * [format] {:toc} not needed for webhelp * add {:disable-links} to ensure demo links are not interpreted as real links. * Put all badges on the same line to simplify composition. * formatter.md: fix upsource link * fix some links * api_changes_list.md: remove note * migrate to webhelp - initial * fix GH edit URL * remove sdkdocs-template setup in VCS config * remove recently_updated.md * restore COC/CONTRIBUTING.md * api_changes_list.md: remove note * useful_links.md: IPE Co-authored-by: JohnHake <john.hake@jetbrains.com> Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>
93 lines
6.8 KiB
Markdown
93 lines
6.8 KiB
Markdown
[//]: # (title: Project)
|
|
|
|
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
|
|
|
|
In the *IntelliJ Platform*, a project encapsulates all the source code, libraries, and build instructions into a single organizational unit.
|
|
Everything done in the IDE is accomplished within the context of a project.
|
|
A project defines some collections referred to as modules and libraries.
|
|
Depending on the logical and functional requirements for the project, a single-module or a multi-module project is possible.
|
|
|
|
## Working with Projects
|
|
|
|
The *IntelliJ Platform* stores the project configuration data in XML files.
|
|
The list of those files depends on the chosen [project](https://www.jetbrains.com/help/idea/about-projects.html) format.
|
|
|
|
For file-based format projects (legacy), 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.
|
|
|
|
Note that direct access to project files isn't required to load or save settings.
|
|
See [Persisting State of Components](persisting_state_of_components.md) for more information.
|
|
|
|
To work with projects and project files, use the following classes and interfaces:
|
|
* [`Project`](upsource:///platform/core-api/src/com/intellij/openapi/project/Project.java)
|
|
* [`ProjectRootManager`](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectRootManager.java)
|
|
* [`ProjectManager`](upsource:///platform/projectModel-api/src/com/intellij/openapi/project/ProjectManager.java)
|
|
* [`ProjectFileIndex`](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectFileIndex.java)
|
|
|
|
Other classes for working with the project model are located in the [`projectModel-api.openapi`](upsource:///platform/projectModel-api/src/com/intellij/openapi) package.
|
|
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) and [`Application`](upsource:///platform/core-api/src/com/intellij/openapi/application/Application.java) are placed in the [`core-api.openapi`](upsource:///platform/core-api/src/com/intellij/openapi) package.
|
|
|
|
### Getting a List of Source Roots for All Modules in a Project
|
|
Use the `ProjectRootManager.getContentSourceRoots()` method.
|
|
To clarify this, consider the following code snippet:
|
|
|
|
```java
|
|
String projectName = project.getName();
|
|
VirtualFile[] vFiles = ProjectRootManager.getInstance(project).getContentSourceRoots();
|
|
String sourceRootsList = Arrays.stream(vFiles).map(VirtualFile::getUrl).collect(Collectors.joining("\n"));
|
|
Messages.showInfoMessage("Source roots for the " + projectName + " plugin:\n" + sourceRootsList, "Project Properties");
|
|
```
|
|
|
|
### Checking if a File Belongs to a Project
|
|
Use [`ProjectFileIndex`](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectFileIndex.java) to get this information:
|
|
|
|
```java
|
|
ProjectFileIndex projectFileIndex = ProjectRootManager.getInstance(project).getFileIndex();
|
|
```
|
|
|
|
### Getting the Content or Source Root to Which the a File or Directory Belongs
|
|
Use the `ProjectFileIndex.getContentRootForFile()` and `ProjectFileIndex.getSourceRootForFile()` methods.
|
|
For example:
|
|
|
|
```java
|
|
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.
|
|
|
|
### Checking Whether a File or Directory Is Related to the Project Libraries
|
|
The [`ProjectFileIndex`](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ProjectFileIndex.java) interface implements a number of methods you can use to check whether the specified file belongs to the project library classes or library sources:
|
|
* `isLibraryClassFile()`: Returns `true` if the specified `virtualFile` is a compiled class file.
|
|
* `isInLibraryClasses()`: Returns `true` if the specified `virtualFileOrDirectory` belongs to library classes.
|
|
* `isInLibrarySource()`: Returns `true` if the specified `virtualFileOrDirectory` belongs to library sources.
|
|
|
|
### Getting the Project SDK
|
|
Note that by default, the project modules use the project SDK.
|
|
Optionally, you can configure an individual SDK for each module.
|
|
See [SDK](sdk.md) for more details.
|
|
|
|
## Changing the Project Structure
|
|
Utility classes used for modifying the project structure can be found in the package [`projectModel-impl.openapi`](upsource:///platform/projectModel-impl/src/com/intellij/openapi).
|
|
Its [`roots`](upsource:///platform/projectModel-impl/src/com/intellij/openapi/roots/) subpackage contains instances and utilities intended for work with project and module source roots, including [`ModuleRootModificationUtil`](upsource:///platform/projectModel-api/src/com/intellij/openapi/roots/ModuleRootModificationUtil.java) and [`ProjectRootUtil`](upsource:///platform/projectModel-impl/src/com/intellij/openapi/projectRoots/impl/ProjectRootUtil.java).
|
|
Project structure changes need to be performed in a [write action](general_threading_rules.md#read-write-lock).
|
|
|
|
Refer to the [project_model](https://github.com/JetBrains/intellij-sdk-code-samples/blob/master/project_model/src/main/java/org/intellij/sdk/project/model/ModificationAction.java) code sample to learn how project structure modification can be implemented.
|
|
|
|
## Receiving Notifications About Project Structure Changes
|
|
To receive notifications about changes in project structure (modules or libraries being added or removed, module dependencies being changed, and so on), use the [message bus](messaging_infrastructure.md) and the `ProjectTopics.PROJECT_ROOTS` topic:
|
|
|
|
```java
|
|
project.getMessageBus().connect().subscribe(ProjectTopics.PROJECT_ROOTS, new ModuleRootListener() {
|
|
@Override
|
|
public void rootsChanged(ModuleRootEvent event) {
|
|
}
|
|
});
|
|
```
|
|
|
|
The event only notifies that something has changed; if more details are needed about what changes have occurred, keep a copy of the state of the project structure model which is relevant, and to compare it with the state after the change. |