IDE Window: Package Editor

From Free Pascal wiki
Revision as of 12:34, 31 January 2016 by JuhaManninen (talk | contribs)
Jump to navigationJump to search

Deutsch (de) English (en) suomi (fi) français (fr) 日本語 (ja) português (pt)

Package Editor

Save

Save changes to disk. (.lpk file)

Compile

Compiles the package and all dependencies.

Use

  • Add to Project - Add this package as a dependency to the current project.
  • Install - Install this package to the IDE. Should be used only when the package registers components or functions to the IDE.
  • Uninstall - Uninstall this package if it was installed to IDE earlier.

Add

Opens the dialog Add to Package to add a new item (unit, file, dependency, ...) to the package.

Options

Opens the dialog Package Options to setup the Usage options, version information, author and other general information of the package.

Install

Compiles the package and all dependencies, adds it to the list of install packages of the IDE and rebuilds the IDE.

Help

Show this help.

Remove

Remove the currently selected item (e.g. file or dependency) from the package. A dialog will open to confirm.

Options

Opens the Compiler Options of the package.

More

  • Find in Files - open a search dialog with the package's directory preset.
  • Sort Files Permanently - The package's files are sorted alphabetically and the new order is stored in the package. This is different from the "Sort files alphabetically" ToolButton which only sorts the view temporarily.
  • Fix Files Case - ToDo: Explain.
  • Show Missing Files - Shows a list of package's files which do not exist in file-system and lets you remove them.
  • Save Package - Save changes to the .lpk file.
  • Save Package As - Opens a dialog in which you can choose a new filename for the .lpk file. The package (.lpk) will be renamed. The files referenced by the package are not moved or renamed. If you save the renamed package (.lpk) in a new directory, check the paths in the compiler options.
  • Revert Package - Discard any changes you have made, and reload the original package (.lpk) from disk.
  • Publish Package - Opens Publish Project / Package to copy the package and its files to another directory. This is useful for creating a package without compiled files or version files (svn, cvs, ...) as a preliminary to creating a zipped file of the package to send to another computer.
  • Compile - Compile this package. If any required package needs compiling, that package will be rebuilt first.
  • Recompile clean - Normally the compiler checks each unit in case it needs to be rebuilt. This option prevents such compiler checks, causing it to compile every unit in the package. If any required package needs compiling, it will be rebuilt first.
  • Recompile all required - Same as Recompile Clean, but all required packages are also recompiled. Keep in mind that some base packages like the FCL and LCL are set to never compile automatically and thus are never recompiled by this call. ToDo: Check the validity of the statement.
  • Create fpmake.pp - Creates a fpmake.pp for this package, which can be used to compile the package without the IDE. ToDo: Explain more.
  • Create Makefile - Creates a Makefile.fpc and a Makefile for this package, which can be used to compile the package without the IDE. Be aware that the Makefile is simple, and requires that all needed packages are at the same place. This means that if you copy the Makefile to another computer, it will need exactly the same paths for all packages (including Lazarus). So usually you will need to adapt such a copied Makefile yourself to allow it to run successfully on another computer (which is almost certain to have different path configurations).
  • View Package Source - Opens the main source file of the package. This unit is automatically created by the IDE on each compile. So don't waste time editing it manually, since all your changes will be lost.
  • View ToDo List - Opens the ToDo list viewer, restricted just to ToDo items from inside this package. Note, this shows up only if the TodoListLaz IDE package is installed.

File properties

When selecting a file the groupbox below shows some properties for the selected file.

Register unit

Check this if the selected unit contains a procedure Register in the interface which should be called at designtime by the IDE. This is for example needed when the unit registers a new component for the IDE component palette.

Use unit

Check this if the selected unit should automatically be compiled when the package is compiled. This is enabled by default for Pascal units and unchecked for all others. Uncheck this if the unit is only usable under some platforms.