Welcome to the manual page of RefactorErl!

​RefactorErl is a source code analyser and transformer tool for ​Erlang, developed at ​Eötvös Loránd University, ​Budapest, ​Hungary.

This wiki aims to help our users understand the main features of the tool and to guide their everyday use. If you are new to RefactorErl, you can find some installation and configuration instructions.

Getting started

Installation

• ​How to install Erlang
• How to install the tool
• ​How to install Yaws (required for the web UI)

• HowtoConfigureRefactorErl?
• HowtoConfigureEmacs?
• HowtoConfigureEclipse?
• HowtoConfigureVim?
• HowtoSetupWebInterface?

Starting up

• How to start the tool?
• HowtoStartAsStandaloneServer?

Analysing Source Code

• HowtoAddFiles?
• HowtoAddIncludePaths?
• Handling errors at initial loading?

Feature Highlights

• Static Analysis
  • Side effects?
  • Data-flow? and dynamic function calls?
  • Module and function dependencies
  • Interface layer consistency check

• Comprehension (getting syntactic and semantic information about the source code)
  • Custom semantic queries (see the reference of available components?) and metric queries
  • Pre-defined semantic queries (available via the web interface)

• Code refactoring: 24 different refactoring steps

• Module and function clustering

• Multiple storage back-ends: Mnesia and C++ graph based

User Interfaces

• Interactive? and scriptable? Erlang shell interface
• Web interface
• Linux shell interface (CLI)
• Emacs/XEmacs interface
• Eclipse, Vim plugin