"Cody" is a Lazarus design time package extending the IDE with some advanced code tools for power users. It is located in the Lazarus sources components/codetools/ide/cody.lpk since Lazarus 0.9.31.
Cody adds the following items to the IDE:
- PPU files of project - a dialog showing stats about all used ppu files
- Insert file at cursor - a dialog to select a file to replace the current selection
- Add call inherited - adds a statement "inherited FunctionName(params);"
- Add Assign method - a dialog to add an Assign method to a class
- Explode a "With" block - removes a "With" block and fixes all identifiers
- Add a "With" block - add a "With" block and remove identifiers
- Declare Variable - dialog to declare a new variable
PPU files of project
- Menu item: Project / Show ppu files of project
- Requires: A compiled project
- Key name: Show used .ppu files ... (in the IDE under options Editor / Key mapping)
This dialog provides statistics about all the current project's used .ppu and .o files.
Note: The codetools will try to parse all used .ppu files. The codetools uses its own ppu parser (not the compiler's parser). The advantage of this is that codetools can read many different versions of ppu. The drawback is that it might not be able to read the very latest version. Cody uses the sources as fallback.
The first page Units shows which unit uses what other units, and where they are used. Note: If a .ppu file cannot be parsed the source (.pas, .pp) will be parsed instead of the .ppu.
You can sort the list by double-clicking on a column header.
- Source: the full file name of the unit source file
- PPU: the full file name of the unit ppu file.
- Uses: This lists all units used by that unit.
- Used by: This lists all units that use the current unit directly.
- Uses path: This gives one path from the project main source to the unit. This is not necessarily the shortest path.
The second page Linked Files shows what files, libraries and frameworks are used by the project and what unit links them in.
- Hint: Double click on an unit to jump to the unit on the Units page.
- Note: If a .ppu file cannot be parsed, there is no fallback. There will be no information displayed about that unit's linked files.
Insert file at cursor
- Requires: a file in the source editor
- Menu item: Source Editor / popup / Source / Insert file at cursor ...
- Shortcut name: Insert file at cursor (in the IDE under options Editor / Key mapping)
This opens a file dialog. Select a file, which will be inserted at the current source editor position. If some text was selected, it will be replaced.
Add call inherited
- Requires: cursor in a method implementation
- Menu item: Source Editor / popup / Source / Add call inherited
- Shortcut name: Add call inherited (in the IDE under options Editor / Key mapping)
This adds a call to the inherited method with all parameters. For example:
TMyClass = class(TComponent) public constructor Create(AOwner: TComponent); override; end;
constructor TMyClass.Create(AOwner: TComponent); begin
This will add inherited Create(AOwner);:
<Delphi> constructor TMyClass.Create(AOwner: TComponent); begin
If the method is a function and the current line is empty it will prepend a Result:=.
<Delphi> function TMyClass.ExecuteAction(Action: TBasicAction): Boolean; begin
Add Assign method
- Requires: cursor in a class
- Menu item: Source Editor / popup / Refactor / Add Assign method ...
- Shortcut name: Add Assign method (in the IDE under options Editor / Key mapping)
If you are using Object Pascal, then you often need to copy an object and so you will probably often write an Assign method. This tool generates the method automatically for you and gives you a dialog to quickly select the members to copy. Here is an example of a produced method code:
TMyClass = class(TComponent) private FMyInt: integer; public procedure Assign(Source: TPersistent); override; property MyInt: integer read FMyInt write FMyInt; end;
procedure TMyClass.Assign(Source: TPersistent); var
if Source is TMyClass then begin aSource:=TMyClass(Source); MyInt:=aSource.MyInt; end else inherited Assign(Source);
- Method name: type in the name of the new method. It is automatically checked if there is already such a method or if an ancestor has inherited one.
- Parameter name: the parameter name is taken from the inherited method, otherwise Source.
- Parameter type: the parameter type is taken from the inherited method, otherwise TObject. If this type is different than the current class an if-then-else block is added.
- If there is an inherited method:
- Check 'Override' to override it. This appends the override method modifier.
- Check 'Call inherited' to add a line 'inherited'.
- Check 'Call inherited only if wrong class' to call the inherited method only in the else part. This is needed for all direct descendants of TPersistent.
- Select members to assign:
- This lists all variables and all properties that are assignable (readable and writable).
- It also shows if a variable is written by a property.
- You can select/unselect by clicking on a member.
Explode a "With" block
This tool removes a With and inserts the with expression in front of each identifier needing it.
- Requires: cursor on a With expression (e.g. the variable between the keywords With and Do)
- Menu item: Source Editor / popup / Refactoring / Remove With block
- Shortcut name: Remove With block (in the IDE under options Editor / Key mapping)
<Delphi> with Button1 do begin
<Delphi> Button1.Name:='Button1'; Button1.Caption:='Ok'; </Delphi>
This tool is an interactive version of Variable Declaration Completion. It tries to guess the type and context of the identifier at cursor and gives you a list of possible places to declare the variable.
- Requires: cursor on an undeclared identifier in a statement.
- Menu item: Source Editor / popup / Refactoring / Declare Variable
- Shortcut name: Declare Variable (in the IDE under options Editor / Key mapping)
<Delphi> procedure DoSomething; begin
Place the cursor on the i and invoke the dialog. Select "local variable" and click Ok. The result is
<Delphi> procedure DoSomething; var
You can declare member variables:
<Delphi> procedure DoSomething(A: TMyClass); begin
A.Identifier:='Declare a variable in TMyClass';
You can declare variables on the clipboard. This gives you superior control where the new variable is declared. Move the source editor cursor to the destination and paste (e.g.+ ). Cody will automatically create a new var section if needed.
- keeps the cursor. You can quickly define a variable without moving/changing your source editor.
- Guesses type of assignments: identifier:=<expression>, this includes for i:=0 to
- Guesses type of for in: for identifier in <list type>
- nested procedures: allows to define a variable on every level
- with blocks: every with adds its contexts
- class sections: private, protected, public, published
- interface, implementation, program, package, library
- checks if identifier is already declared
- automatically adds the needed unit for the type
- it can create the declaration on the clipboard. This creates a special format on the clipboard containing all needed information so that a paste will add the needed unit to the uses section. Or you can paste it into another application.