PTP/photran/documentation/photran5advanced

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. 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. To enable advanced features,

1. Right-click on your project's folder in the Fortran Projects view
2. Click on Properties
3. Expand Fortran General in the list on the left, and click on Analysis/Refactoring
4. Check the "Enable Fortran analysis/refactoring" check box
5. If you want to enable content assist, the Fortran Declaration view, etc., check those boxes as well
6. You may also want to set module and include paths at this point (see below)
7. Click OK

Setting Up 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,

1. Right-click on your project's folder in the Fortran Projects view
2. Click on Properties
3. Expand Fortran General in the list on the left, and click on Analysis/Refactoring
4. 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.
5. Click OK

The Fortran Analysis/Refactoring Problems View

TODO

Advanced Editing Features

Content Assist

TODO

Fortran Declaration View

TODO

Hover Tips

TODO

Search and Navigation

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