| | 1 | [[PageOutline]] |
| | 2 | |
| | 3 | [http://http://erlide.org/ ErlIDE] is an Eclipse-based development |
| | 4 | environment, which aims to assist programming of large scale Erlang |
| | 5 | applications. In order to integrate RefactorErl into Eclipse, we are |
| | 6 | engaged in creating an Eclipse plugin based on ErlIDE, which can enable |
| | 7 | access to all the functionality provided by RefactorErl, whilst |
| | 8 | utilising ErlIDE features as well. A prototype of the Eclipse plugin is |
| | 9 | already available. |
| | 10 | |
| | 11 | = Installation = |
| | 12 | |
| | 13 | == Software requirements == |
| | 14 | * The plugin is being developed and tested in [http://www.eclipse.org/ Eclipse 3.5.2]. (It likely works with newer versions as well.) |
| | 15 | * This user interface is built upon [http://erlide.org/ ErlIDE], therefore it is required to have it with Eclipse. Inasmuch as the main structure |
| | 16 | of ErlIDE has been changed in its version |
| | 17 | ''v0.11.6.201107010651'', it is necessary to get the latest version. |
| | 18 | * Finally, you can download the plugin itself from the RefactorErl homepage. |
| | 19 | |
| | 20 | == Deployment == |
| | 21 | To install this plugin you need to download the source code from the |
| | 22 | home page of the [http://plc.inf.elte.hu/erlang/dl/ RefactorErl]. In |
| | 23 | order to generate the binaryes of the plugin you can compile it using |
| | 24 | '''''ant''''' or the compiler of Eclipse. Finally you have to copy the |
| | 25 | generated jar files into your Eclipse plugin directory. In Eclipse 3.5.x: |
| | 26 | {{{ |
| | 27 | <user home>/.eclipse/org.eclipse.platform_3.5.0_155965261/plugin |
| | 28 | }}} |
| | 29 | |
| | 30 | == Compiling the plugin in Eclipse == |
| | 31 | todo |
| | 32 | |
| | 33 | == Compile plugin using Ant == |
| | 34 | todo |
| | 35 | |
| | 36 | == Configuration == |
| | 37 | The plugin, in order to be able to access RefactorErl, has to be set |
| | 38 | up before the first usage. For the configuration dialog, go to |
| | 39 | '''Window/Preferences/RefactorErl'''. |
| | 40 | |
| | 41 | Start background process automatically:: |
| | 42 | If set, the plugin launches a new instance of the tool, otherwise an |
| | 43 | already running RefactorErl process will be used. |
| | 44 | RefactorErl directory:: |
| | 45 | The installation directory of the tool. |
| | 46 | Working directory:: |
| | 47 | A temporary directory, used to store the configuration files of |
| | 48 | RefactorErl. It is assumed to be a writable directory. |
| | 49 | Waiting time:: |
| | 50 | This parameter represents the waiting time (in seconds) after |
| | 51 | starting RefactorErl process (has to be set to greater than 1). The |
| | 52 | slower access is possible to Erlang nodes, the greater value is suggested. |
| | 53 | Synchronize workspace automatically then model changed:: |
| | 54 | If a source file has been changed, the extension automatically updates |
| | 55 | its inner representation within the tool. |
| | 56 | Reset database before full synchronization:: |
| | 57 | Resets the database and erases its contents in the case of a full |
| | 58 | synchronisation. The use of this feature is recommended for RefactorErl |
| | 59 | developers only. |
| | 60 | |
| | 61 | = Database management = |
| | 62 | todo |
| | 63 | |
| | 64 | = Executing refactoring transformations = |
| | 65 | todo |
| | 66 | |
| | 67 | = Executing semantic queries = |
| | 68 | todo |
| | 69 | |
| | 70 | = Clustering = |
| | 71 | todo |
