IDE Window: Unit info: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | The **Unit information dialog** as available from the menu \[Source\|Unit information\] shows various information of the current file in the source editor. | |
| 2 | 2 | ||
| 3 | 3 | ## General | |
| 4 | 4 | ||
| 5 | 5 |  | |
| 6 | 6 | ||
| 7 | 7 | - Name: the unit name as written in the source code. Otherwise it is the filename without the extension and path. | |
| 8 | 8 | - Type: The highlighter type. This can be changed via the popup context menu in the source editor. | |
| 9 | 9 | - In Project: Displays if the file is part of the current project. This can be changed in the [[IDE Window: Project Inspector]] or the [[Main menu|Main Menu]] \> [[Main menu|Project]] \> Add to Editor File to Project or Remove from Project menu items. | |
| 10 | 10 | - Size: The size of the file in bytes | |
| 11 | 11 | - Lines: The number of source code lines. | |
| 12 | 12 | - Path: Full file pathname. | |
| 13 | 13 | - Included by: This file was included last time by this source file. For example via an {\$I filename.inc} include directive. This is automatically set each time the IDE parses the unit containing the include directive. You can clear this with the Clear button. You can use Search -\> Goto include directive to jump to the include directive of the parent file. | |
| 14 | 14 | - Clear include cache: This button clears the 'Included by'. | |
| 15 | 15 | ||
| 16 | 16 | ## Unit paths | |
| 17 | 17 | ||
| 18 | 18 |  | |
| 19 | 19 | ||
| 20 | 20 | These are the unit paths used by the IDE for this file. The unit paths are used to search for .ppu, .pas, .pp, .p files. Normally these paths are given to the compiler, but there are cases where this is not the case and it does not show the unit paths defined in the compiler configuration file (`fpc.cfg`). | |
| 21 | 21 | ||
| 22 | 22 | These paths are created by the rules in the Tools -\> Options -\> CodeTools defines editor. All files in a directory share the same search paths (unit paths, include paths, ...). If this a project directory, all project unit paths are added. If the directory belongs to a package its unit paths will be added. If you put a project and a package into one directory, both paths will be added. That it why it is recommended to give packages and projects directories of their own. | |
| 23 | 23 | ||
| 24 | 24 | Difference between compiler search paths and IDE search paths: | |
| 25 | 25 | ||
| 26 | 26 | Normally the difference does not matter. The compiler is invoked in one directory with a set of search paths. For example: There are 4 packages: | |
| 27 | 27 | ||
| 28 | - | ||
| 29 | - | ||
| 30 | - | ||
| 31 | - | ||
| 28 | + | ```text | |
| 29 | + | /home/user/package1/package1.lpk | |
| 30 | + | /home/user/package2/package2.lpk | |
| 31 | + | /home/user/package3/package3.lpk using package1 and package2 | |
| 32 | + | /home/user/package4/package4.lpk using package1 and package2 | |
| 33 | + | ``` | |
| 32 | 34 | ||
| 33 | 35 | When package3 is compiled in /home/user/package3 with unit path /home/user/package1/;/home/user/package2/. When the compiler finds a unit in /home/user/package2/ and compiles it it applies all unit paths, including path to /home/user/package3/. This is normally unwanted and therefore a standard package defines an output directory. But for this example we assume the package compiles it .ppu files into the source directory. | |
| 34 | 36 | ||
| 35 | 37 | When the compiler is invoked for package4 it will be started in a different directory with different search paths. Here it is invoked in /home/user/package4 with unit path /home/user/package1/;/home/user/package2/. When the compiler finds a unit in /home/user/package2/ and compiles it it applies all unit paths, including the path to package4. This means the compiler compiles the units in package2 with two different unit paths. This is normally a bad idea as the result depends on the order - if you compile first package3 then package4 or the other way round. But in real world (e.g. the Delphi world) this is more common than one would expect. It is clear, that if packages contain the units with the same name the order of the file paths in the search paths becomes important. | |
| 36 | 38 | ||
| 37 | 39 | The IDE solves this by collecting search paths for every directory. That means, for example,the search paths for the Lazarus sources have their own unit paths and do not include the unit paths to your project. A directory, that is not part of your project, does not include the unit paths of your project. This way you can browse Delphi VCL sources and Lazarus LCL sources both containing units with same names. | |
| 38 | 40 | ||
| 39 | 41 | ## Include paths | |
| 40 | 42 | ||
| 41 | 43 |  | |
| 42 | 44 | ||
| 43 | 45 | Same as unit paths, but for the include paths. Search paths for include directives\ | |
| 44 | 46 | `{$I filename.inc}` or `{$INCLUDE filename.inc}`. | |
| 45 | 47 | ||
| 46 | 48 | ||
| 47 | 49 | ||
| 48 | 50 | ## Source paths | |
| 49 | 51 | ||
| 50 | 52 |  | |
| 51 | 53 | ||
| 52 | 54 | This is the unit path plus the compiled source paths. | |
| 53 | 55 | ||
| 54 | 56 | For example: | |
| 55 | 57 | ||
| 56 | - | ||
| 57 | - | ||
| 58 | + | ```text | |
| 59 | + | /home/user/project | |
| 60 | + | /home/user/package/lib | |
| 61 | + | ``` | |
| 58 | 62 | ||
| 59 | 63 | The project uses the package. The package source files are in /home/user/package and the output files (.ppu) of the package are put in /home/user/package/lib. | |
| 60 | 64 | ||
| 61 | 65 | The unit path of the project will contain the path to the output directory of the package - /home/user/package/lib. So when the compiler is invoked to compile the project it finds the .ppu files of the package, but not the source (.pas) of the package. This way it can not recompile the package, which is good, because the compiler options of the project are probably different than for the package. The IDE should find the source files (.pas). It knows, that /home/user/package/lib is the output directory of the package, so it adds the unit path of the package to the source path of the project. This addition is called the compiled source path. | |
| 62 | 66 | ||
| 63 | 67 | ||
| 64 | 68 | ||
| 65 | 69 | ## Show CodeTools Values | |
| 66 | 70 | ||
| 67 | 71 | See [[IDE Window: Codetools Directory Values|Codetools Directory Values]] | |
| 68 | 72 | ||
| 69 | 73 | ## OK | |
| 70 | 74 | ||
| 71 | 75 | The `OK` button dismisses the dialog. | |
| 72 | 76 | ||
| 73 | 77 | --- | |
| 74 | 78 | *From the Free Pascal wiki, page "IDE Window: Unit info", as it stood on 2021-02-01 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |