The goal of this document is to describe the architecture of IntelliJ IDEA 6.0 from a plugin developer's point of view. It will be organized in a task-based manner: rather than listing all the things that you can do with each object and describing how they are all implemented, it will try to answer questions "what can I do with this object", "how do I get to this object" and so on.
This document assumes that the reader is familiar with the basic concepts of IntelliJ IDEA plugin development. If you don't know anything at all about plugin development, you should start with the live demo and tutorials at http://www.jetbrains.com/idea/plugins/plugin_developers.html, and then return to this document.
General Threading Rules
In general, the data structures of IntelliJ IDEA are covered by a single "multiple readers / single writer" lock. Reading data is allowed from any thread. Reading data from the UI thread does not require any special effort, however, read operations performed from any other thread need to be wrapped in a read action (
ApplicationManager.getApplication().runReadAction()). Writing the data is only allowed from the UI thread, and write operations always need to be wrapped in a write action (
ApplicationManager.getApplication().runWriteAction()). Note that the thread spawned to perform operations with a modal progress indicator (
ProgressManager.getInstance().runProcessWithProgressSynchronously) is also allowed to perform write operations.
A virtual file (
com.intellij.openapi.vfs.VirtualFile) is IntelliJ IDEA's representation of a file in a filesystem (VFS). The most common case of a virtual file is a file on your local filesystem. However, IDEA supports multiple pluggable filesystem implementations, so virtual files can also represent classes in a JAR file, old revisions of files loaded from the CVS repository and so on.
The VFS level deals only with binary content. You can get or set the contents of a VirtualFile as a stream of bytes, but concepts like encodings and line separators are handled by higher levels of the system.
How do I get one?
- From an action:
(VirtualFile) dataContext.getData(DataConstants.VIRTUAL_FILE). If you are interested in multiple selection, you can also query for
- From a path in the local file system:
- From a PSI file:
psiFile.getVirtualFile()(may return null if the PSI file exists only in memory)
- From a document:
Where does it come from?
The VFS is built incrementally, by walking the filesystem up and down starting from the project root. New files appearing in the file system are detected by VFS refreshes. A refresh can be initiated programmatically (
VirtualFile.refresh()). VFS refreshes are also caused by file system change notifications received by file system watchers (on Windows and Mac).
As a plugin developer, you may need to invoke a VFS refresh if you need to access through IDEA's APIs a file which has just been created by an external tool.
How long does it live?
A particular file on disk is represented by the same
VirtualFile instance for the entire lifetime of the IDEA process. If a file is deleted, its corresponding VirtualFile instance becomes invalid (
isValid() returns false and operations cause exceptions).
How do I create one?
Usually you don't: files are created either through the PSI API or through the regular java.io.File API. If you do need to create a file through VFS, you can use
VirtualFile.createChildData() to create a VirtualFile instance and
VirtualFile.setBinaryContent() to write some data to it.
How do I get notified when it changes?
VirtualFileManager.addVirtualFileListener() allows you to receive notifications about all changes happening in the VFS.
What can I do with one?
Traverse the file system, get file contents, rename, move, delete - typical file operations.
How do I extend it?
To provide an alternative filesystem implementation (for example, an FTP filesystem), implement the
VirtualFileSystem interface (most likely you'll also need to implement
VirtualFile), and register your implementation as an application component. To hook into operations performed in the local file system (for example, if you're developing a version control system integration which needs custom rename/move handling), implement
LocalFileOperationsHandler and register it through
What are the threading rules?
The general read action/write action rules are in effect. Note that any operation that can cause a synchronous refresh of the VFS (for example,
LocalFileSystem.refreshAndFindFileByIoFile()) is a write action and can only performed in the UI thread. If you need to refresh VFS from a background thread, use asynchronous refresh operations with a
to be continued