Skip to content

refactoring_tools.md

Latest commit

 

History

History
310 lines (186 loc) · 12.9 KB

refactoring_tools.md

File metadata and controls

310 lines (186 loc) · 12.9 KB

Refactoring Tools

Available Refactorings

Named Parameters

Command name: als-named-parameters

  • Adds the formal parameter name of each actual parameter in the subprogram call.

See /source/ada/lsp-ada_handlers-named_parameters_commands.ads in ALS repository.

Demo source is named_parameters// in Code Samples.

named_parameters

Add Parameter

Command name: als-refactor-add-parameters

  • Adds a new parameter to a subprogram.
  • All subprogram specs are updated.
  • Only parameters with correct syntax are accepted.
  • The new parameter type is inferred when only the name is provided.
  • The new parameter location is inferred from the cursor position.

See src/lal_refactor-subprogram_signature.ads in LAL Refactor repository.

Demo source is add_parameter/ in Code Samples.

add_parameter

Remove Parameter

Command name: als-refactor-remove-parameters

  • Removes a parameter of a subprogram.
  • All subprogram specs are updated.
  • Actual parameter is removed from the subprogram calls.

See src/lal_refactor-subprogram_signature-remove_parameter.ads in LAL Refactor repository.

Demo source is remove_parameter/ in Code Samples.

remove_parameter

Move Parameter

Command name: als-refactor-move-parameters

  • Moves a parameter backward and forward within a subprogram spec.
  • All subprogram specs are updated.
  • Actual parameter are moved in the subprogram calls when needed.

See src/lal_refactor-subprogram_signature.ads in LAL Refactor repository.

Demo source is move_parameter/ in Code Samples.

move_parameter

Change Parameter Mode

Command name: als-refactor-change-parameter-mode

  • Changes the parameter mode within a subprogram spec.
  • All subprogram specs are updated.

See src/lal_refactor-subprogram_signature.ads in LAL Refactor repository.

Demo source is change_parameter_mode/ in Code Samples.

change_parameter_mode

Change Parameter Type

Command name: als-refactor-change_parameters_type

  • Changes the parameter subtype indication within a subprogram spec.
  • Only subtype indications with correct syntax are accepted.
  • All subprogram specs are updated.

See src/lal_refactor-subprogram_signature-change_parameters_type.ads in LAL Refactor repository.

Demo source is change_parameter_type/ in Code Samples.

change_parameter_type

Change Parameter Default Value

Command name: als-refactor-change_parameters_default_value

  • Changes the parameter default value expression within a subprogram spec.
  • Only default value expressions with correct syntax are accepted.
  • All subprogram specs are updated.

See src/lal_refactor-subprogram_signature-change_parameters_default_value.ads in LAL Refactor repository.

Demo source is change_parameter_default_value/ in Code Samples.

change_parameter_default_value

Extract Subprogram

Command name: als-refactor-extract-subprogram

  • Extracts statements to a new subprogram.
  • The new subprogram is created in the nearest declarative part.
  • Local declarations of for loop and exception handlers are passed to the extracted subprogram as new parameters.
  • Extract function is available if the last statement is either an assignment, return, or returning if/else statement.

See src/lal_refactor-extract_subprogram.ads in LAL Refactor repository.

Demo source is extract_subprogram/ in Code Samples.

extract_subprogram

Extract Variable

Command name: als-refactor-extract-variable

  • Extract an expression to the new variable.
  • The new variable is created in the nearest declarative part.
  • The assignment is done as close to the original location as possible.

See src/lal_refactor-extract_variable.ads in LAL Refactor repository.

extract-variable

Generate Package Body

Command name: als-refactor-generate-package-body

  • When package specification declares unimplemented subprograms, generate matching subprogram stubs in package body.
  • Only available when cursor is inside package declaration text: package Spec is, private, or end Spec.
  • Tool checks project locations for package body and offers one of these modes:
    • Generate Package Body when no package body is found
      • Create new file in same directory (e.g. project_dir/spec.ads matched with project_dir/spec.adb)
      • Fill with subprogram body stubs for top-level declarations
    • Update Package Body when package body exists in project
      • Update with new subprogram body stubs
      • Try to insert these in a similar order to package spec declarations.

Source: src/lal_refactor-generate_package.ads in LAL Refactor.

generate-package-body

Generate Subprogram Body

Command name: als-refactor-generate-subprogram-body

  • Action title: Generate Procedure Body or Generate Function Body
  • Identifies subprogram declaration without an implementation in the same scope
  • Generates new empty subprogram body and tries to insert near similarly declared subprograms
  • Available for nested or top-level package subprogram declarations.
  • Not available for generic subprograms.

Source: src/lal_refactor-generate_subprogram.ads in LAL Refactor.

generate-subprogram-body

Pull Up Declaration

Command name: als-refactor-pull_up_declaration

  • Moves a declaration and its dependent declarations to their parent declarative part.
  • When pulling up a subprogram, object declaration are not pulled up. Instead, they're added as formal parameters to the subprogram specification and as actual parameters to the subprogram calls.

See src/lal_refactor-pull_up_declaration.ads in LAL Refactor repository.

Demo source is pull_up_declaration/ in Code Samples.

pull_up_declaration

Sort Case

Command names: als-refactor-sort-case-alphabetical als-refactor-sort-case-declaration

  • Sort when and literals inside when alphabetically or according to the declaration order.

See src/lal_refactor-sort_case.ads in LAL Refactor repository.

sort-case-alphabetical

Suppress Separate

Command name: als-suppress-separate

  • Moves a separate subunit to its stub in the parent package.
  • Use clauses in the separate subunit are moved to the subprogram's declarative part to avoid namespace collisions.
  • .bak is added to the separate subunit source filename.

See src/lal_refactor-suppress_separate.ads in LAL Refactor repository.

Demo source is suppress_separate/ in Code Samples.

suppress_separate

Delete Entity

Command name: als-refactor-delete-entiry

  • Currently works only for procedures.
  • Any procedure call is also deleted.
  • If call statement is the only one in the statement list, then
    • if it is inside a declare/block/end then the block statement is deleted even if there are exception handlers and declarations in it.
    • otherwise it will be replaced with null; to keep source correct.
  • Non-call references will be reported and prevent the deletion.

See src/lal_refactor-delete_entity.ads in LAL Refactor repository.

Demo source is delete_entity/ in Code Samples.

delete_entity

Inline Variable

Command name: als-refactor-inline_variable

  • Delete the variable with the initialization expression and replace all references to this expression.

See src/lal_refactor-inline_variable.ads in LAL Refactor repository.

inline_variable

Introduce Parameter

Command name: als-refactor-introduce-parameter

  • Introduces a formal parameter based on an object declaration or expression inside a subprogram.
  • All references of the object declaration or expression are replaced by the introduced parameter.
  • The user must mannually fix the calls to the subprogram that was refactored by addings the corresponding actual parameter.

See src/lal_refactor-introduce_parameter.ads in LAL Refactor repository.

Demo source is introduce_parameter/ in Code Samples.

introduce_parameter

Replace Type

Command name: als-refactor-replace-type

  • Replaces a type in the intire project by another type provided by the user.

See src/lal_refactor-replace_type.ads in LAL Refactor repository.

Demo source is replace_type/ in Code Samples.

replace_type

Auto Import

Command name: als-auto-import

  • For an unresolved name, suggests all packages that can be imported and prefix to be added so that that the name gets resolved.

Source in LAL Refactor repository.

Demo source is auto_import/ in Code Samples.

auto_import

Sort Dependencies

Command name: als-refactor-sort_dependencies

  • Sorts all with and use clauses and their associated pragmas.

See src/lal_refactor-sort_dependencies.ads in LAL Refactor repository.

Demo source is sort_dependencies/ in Code Samples.

replace_type

Swap If/else statements

Command name: als-refactor-swap_if_else

  • Swap If and else code branches and invert condition.

See src/lal_refactor-swap_if_else in LAL Refactor repository.

swap_if_else