Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "PTP/photran/documentation/photran5advanced"
(→Enabling Advanced Features) |
m (→Enabling Advanced Features) |
||
| Line 19: | Line 19: | ||
<p><b>In order to use any of the advanced features described in this document, | <p><b>In order to use any of the advanced features described in this document, | ||
| − | you must specifically enable them.</b> After you do this, Photran will | + | you must specifically enable them as described below.</b> After you do this, Photran will |
<i>index</i> your project; that is, it will build a database of what modules, subprograms, etc. | <i>index</i> your project; that is, it will build a database of what modules, subprograms, etc. | ||
are declared in every file in your project. This information will be updated incrementally every time | are declared in every file in your project. This information will be updated incrementally every time | ||
you save a file. Although this process is reasonably fast in most cases, | you save a file. Although this process is reasonably fast in most cases, | ||
it may become disruptive when working on very large projects, so it has been disabled by default. | it may become disruptive when working on very large projects, so it has been disabled by default. | ||
| − | + | Note that the first time your project is indexed, it may take a while, because Photran must | |
| + | analyze every file in your project; after that, it will only index files that have changed | ||
| + | (or that depend on a file that has changed), so it will generally be much faster.</p> | ||
| + | |||
| + | ===How to Enable Advanced Features=== | ||
<ol> | <ol> | ||
<li> Right-click on your project's folder in the Fortran Projects view | <li> Right-click on your project's folder in the Fortran Projects view | ||
| Line 36: | Line 40: | ||
</ol> | </ol> | ||
| − | ===Setting | + | ===Setting Module and Include Paths=== |
<p>If your source code contains INCLUDE lines or USE lines referencing modules in other files, | <p>If your source code contains INCLUDE lines or USE lines referencing modules in other files, | ||
Photran needs to know where to look in order to find these. <i>It will not figure this out | Photran needs to know where to look in order to find these. <i>It will not figure this out | ||
Revision as of 02:28, 9 July 2009
You are here: PTP > Photran > Documentation > Photran 5.0 Advanced Features
Photran 5.0 Advanced Features
IMPORTANT: For the time being, this is just an outline of the
documentation we intend to write before the release of Photran 5.0
in September, 2009. It is not useful yet. Of course, you are
welcome to fill in any sections you wish... this is a wiki!
Introduction
TODO
- Indexing
- Problems view (cf. below)
Enabling Advanced Features
In order to use any of the advanced features described in this document, you must specifically enable them as described below. After you do this, Photran will index your project; that is, it will build a database of what modules, subprograms, etc. are declared in every file in your project. This information will be updated incrementally every time you save a file. Although this process is reasonably fast in most cases, it may become disruptive when working on very large projects, so it has been disabled by default. Note that the first time your project is indexed, it may take a while, because Photran must analyze every file in your project; after that, it will only index files that have changed (or that depend on a file that has changed), so it will generally be much faster.
How to Enable Advanced Features
- Right-click on your project's folder in the Fortran Projects view
- Click on Properties
- Expand Fortran General in the list on the left, and click on Analysis/Refactoring
- Check the "Enable Fortran analysis/refactoring" check box
- If you want to enable content assist, the Fortran Declaration view, etc., check those boxes as well
- You may also want to set module and include paths at this point (see below)
- Click OK
Setting Module and Include Paths
If your source code contains INCLUDE lines or USE lines referencing modules in other files, Photran needs to know where to look in order to find these. It will not figure this out automatically. For each project in which you plan to use refactoring support,
- Right-click on your project's folder in the Fortran Projects view
- Click on Properties
- Expand Fortran General in the list on the left, and click on Analysis/Refactoring
- List the folders in which Photran should search for INCLUDE files and modules when refactoring. They will be searched in order from the first folder listed to the last. Subfolders are not searched automatically; you must include them explicitly.
- Click OK
The Fortran Analysis/Refactoring Problems View
TODO
Advanced Editing Features
Content Assist
TODO
Fortran Declaration View
TODO
Hover Tips
TODO
TODO
Open Declaration
TODO
Fortran Search
TODO
- Fortran Search dialog
- Find References
Refactoring
TODO
Introduction
- What is refactoring
- Note fixed form not supported
- How to activate
- Refactor menu (if in editor)
- Editor context menu (if in editor)
- Fortran Projects View context menu (multiple files)
Rename
TODO
Introduce Implicit None
TODO
Move Saved Variables to Common Block
TODO
Replace Obsolete Operators
TODO
Extract Procedure
TODO