From 36a5b14cfa9734dcca307a186cf9bb05559b2a09 Mon Sep 17 00:00:00 2001 From: "john.j.camilleri" Date: Fri, 1 Jun 2012 12:43:44 +0000 Subject: GFEP: Updated readme --- eclipse/images/eclipse-external-libraries.png | Bin 17458 -> 28894 bytes eclipse/index.html | 93 +++++++++++++++++--------- 2 files changed, 62 insertions(+), 31 deletions(-) (limited to 'eclipse') diff --git a/eclipse/images/eclipse-external-libraries.png b/eclipse/images/eclipse-external-libraries.png index 4298694b9..fe9983e8c 100644 Binary files a/eclipse/images/eclipse-external-libraries.png and b/eclipse/images/eclipse-external-libraries.png differ diff --git a/eclipse/index.html b/eclipse/index.html index 9c47699b0..d4325dfd7 100644 --- a/eclipse/index.html +++ b/eclipse/index.html @@ -1,17 +1,7 @@ - - - -GF Eclipse Plugin - - - - - -

The GF Eclipse Plugin

John J. Camilleri
-Updated: 19 April 2012

+Updated: 1 June 2012

The research leading to these results has received funding from the European Union’s Seventh Framework Programme (FP7/2007-2013) under grant agreement no. FP7-ICT-247914 (the MOLTO Project).

@@ -38,13 +28,20 @@ Updated: 19 April 2012

Software update site URL for installing through Eclipse: http://www.grammaticalframework.org/eclipse/release/

Publications

+ +

Poster at EAMT 2012 in Trento, Italy
Paper presented at FreeRBMT 2012 in Gothenburg, Sweden.

Features

Syntax highlighting and error detection
Code folding, quick block-commenting, automatic code formatting
Definition outlining, jump to declaration, find usage
Warnings for problems in module dependancy hierarchy
Warnings for problems in module dependency hierarchy
Launch configurations, i.e. compilation directly from IDE
Use GF Shell from within Eclipse
Auto-completion for declared identifiers

(1.4.3.x) Improvements to the Test Manager. Added support for arbitrary commands in launch. Made the license information clearer.

22/03/12

(1.4.2.x) Added wizard for context-free grammars (no syntax support, though). Context-menu option for toggling the GF Nature and Builder together. Test Manager now parses languages & params, and includes filtering and toggling options.

14/03/12

(1.4.1.x) GF source files can now be anywhere in project, not necessarily at top level.

(1.2.0.x) with support for “Open Declaration” (F3) function, including for external libraries.

18/11/11

Third BETA (1.1.0.x) released, overhauled to take advantage of new compiler features. Tag-based scoping with caching for better performance. Interactive console (GF Shell) for luanch configs.

Third BETA (1.1.0.x) released, overhauled to take advantage of new compiler features. Tag-based scoping with caching for better performance. Interactive console (GF Shell) for launch configs.

11/10/11

Second BETA (1.0.0.x) released, with improved support for qualified names, local variable bindings, selective inheritance, module outlining, and launch configurations. Also new GF Project type.

Add the GF perspective by clicking Window → Open Perspective → Other and choosing GF.
The plugin will try to determine the path to your GF executable automatically. You can check/overwrite it by going to Preferences → Grammatical Framework. -This path should include the name of the GF binary itself, e.g. /home/john/.cabal/bin/gf or C:\Users\John\GF\gf.exe.

/home/john/.cabal/bin/gf

C:\Users\John\GF\gf.exe

By default, the Library path setting is set to .:present:alltenses:prelude. This is passed to GF using the --path flag.
You can also adjust the verbosity level of the GFEP console log in the preferences window.

Create a new GF Project

If you have a folder in your workspace which you want to convert into a GF Project, then you can select it from the dropdown. This folder will then appear as an Eclipse project in your workspace.

If you have a folder in your workspace which you want to convert into a GF Project, then you can select it from the drop-down. This folder will then appear as an Eclipse project in your workspace.

New project wizard

Clone module wizard

If you want to clone an existing module into a new language, you can now do so via the Clone GF Module wizard. This is also available as a context menu option in the Project Explorer, via <Richt click> → Grammatical Framework → Compile for new language:

If you want to clone an existing module into a new language, you can now do so via the Clone GF Module wizard. This is also available as a context menu option in the Project Explorer, via <Right click> → Grammatical Framework → Compile for new language:

Clone GF module to new language wizard

Workbench editor layout

Use Eclipes’ own features to drag and drop your editor tabs to suit your needs.

Use Eclipse’ own features to drag and drop your editor tabs to suit your needs.

The editor and outline view

Builder

For validation to work correctly, the project’s Build Automatically option should be turned on. -Each time you save a file (or some other change occurs in your project), the builder should get triggered which recompiles any GF files which have changed. If the builder does not seem to get triggered, try to run a clean via Project → Clean…

clean

Project → Clean…

Code formatting

If the process associated with a console window has terminated, it will be indicated in the upper-left corner as below. Such console windows can then be closed using the gray cross button:

If the process associated with a console window has terminated, it will be indicated in the upper-left corner as below. Such console windows can then be closed using the grey cross button:

Close terminated console icon

This view is automatically populated with a list of all the external modules referenced by the current file. Double-clicking on any item provides a quick way of opening GF files which are imported into your grammar from outside your Eclipse project, for example the GF Resource Grammar Library.

External libraries view

This view also provides a text box for searching within the current module’s scope, as shown in the image below. Clicking the small arrow on the right-hand side of the view provides options for case sensitive and/or regular-expression based search.

Future versions of this view will contain a full tree of all identifiers available in the current scope.

External libraries view

Test Manager view

Common issues and fixes

No identifiers are resolved and my log contains messages saying “File Syntax.gf does not exist.”

In general, this means that something is wrong with your library path setting.

GFEP attempts to compile all of your files individually with GF, which is not the usual way in which you would compile your grammar. +As a result, when looking for the RGL files, GF needs a little help via the path argument.

The normal way to do this is to specify the Library path setting from Preferences → Grammatical Framework, setting it to something like .:present:alltenses:prelude (this is the default setting). Note that these paths are relative to the true RGL directory, which GF should already be aware of. The value of this setting is passed to GF from GFEP using the --path flag.

The Library path setting is the same for all your GF projects. If you want finer-grain control over the path compiler option then you should use compiler pragmas in your source files, e.g.:

--# -path=.:present:alltenses:prelude
+

The advantage of this method is that the information is bound to the file, so you can freely compile your modules outside of GFEP without having to specify the path as a command line option to GF. +The disadvantage is that you need to specify such a pragma in every single file (at least if you want to continue to use the GFEP).

Other strange behaviour

When things seem strange, the very first step is always to clean the project via Project → Clean…. +I only support the latest version of the plugin, so make sure you are up to date too.

If problems persist, please contact me or better yet file an issue on the GitHub issue tracker (see below).

Evaluation & feedback

Please try to use the plugin for developing your own GF projects and report any issues you come up against. @@ -435,39 +461,44 @@ Feedback (both negative and positive) on the following would be appreciated:

abstract Foods = ...

abstract Foods = {...}

concrete FoodsEng of Foods = ...

concrete FoodsEng of Foods = {...}

resource ResFoods = ...

resource ResFoods = {...}

interface LexFoods = ...

interface LexFoods = {...}

instance LexFoodsEng of LexFoods = ...

instance LexFoodsEng of LexFoods = {...}

incomplete concrete FoodsI of Foods = ...

incomplete concrete FoodsI of Foods = {...}

concrete FoodsEng of Foods = FoodsI with (...) ...

concrete FoodsEng of Foods = FoodsI with (...) {...}

Build command

This is the GF command run by the builder:

gf --v=0 --tags --output-dir=.gfbuild [--path=PATH] FILE
+