ACGtk: an ACG development toolkit

ACGtk is a software package (2008-2021 INRIA©) for the development of abstract categorial grammars. This distribution provides two executables file: acgc and acg.

It is distributed with the CeCILL license (see the LICENSE file or http://www.cecill.info). Contributors are listed in the AUTHORS.md file.

A list of related publications is available at the ACG web page.

acgc

acgc is a "compiler" of ACG source code, i.e. files containing definitions of signatures and lexicons. It basically checks whether they are correctly written (syntactically and wrt types and constant typing) and outputs a .acgo object file. An interactive mode is available to parse terms according to signatures.

Run

./acgc --help

to get help.

acg

acg is an interpreter of command meant to be useful when using ACGs. To get a list of command, run

./acg

then, on the prompt, type

	help;

Example files are given in the examples directory. Read the README.md file.

Basic usage

Let's assume you defined a file my_acg.acg in directory my_dir. A basic usage of the acgc and acg commands could be:

$ acgc -o my_acg.acgo my_acg.acg

This will produce a my_acg.acgo file (note that this is the default name and location if the -o option is not provided).

Then, running :

$ acg

will open a prompt in which you can type:

# load o my_acg.acgo;

to load the data contained in the my_acg.acg file. Assuming you have defined the signature Sig and the lexicon Lex, you can then run the following commands:

# Sig check lambda x.some_cst x: NP ->S;

to check whether lambda x.some_cst x is a term of type NP ->S according to Sig.

You can type:

# Lex realize lambda x.cst x: NP ->S;

to compute the image of lambda x.cst x by Lex (assuming this term and this type are correct according to the abstract signature of Lex).

You can type:

# Lex parse John+loves+Mary: S;

to check whether the term John+loves+Mary has an antecend of type S by Lex, assuming that John+loves+Mary is a term of type Lex (S) in the object signature of Lex.

Type CTRL-D to exit from the program, or type:

# exit;

SVG output

If the --nsvg option is not set when running acg, a file realize.svg (default name) is generated in the current directory whenever a realize command is invoked. In order to set another file name, use the option --svg other_filename.

This files contains a representation as a tree of the operations described by the term to realize (applications, abstractions). Each node contains the abstract term and its realizations by each of the lexicons specified on the command line. The graphic file can for instance been observed through a web browser.

Four rendering engines are available so far to render the terms in each node:

The association between the name of a signature and a rendering engine is declared in a configuration file that can be loaded through the --realize option and that looks like:

$ cat config.json
{
    "signatures": [
	{ "name": "TAG", "engine": "trees" },
	{ "name": "DSTAG", "engine": "trees" },
	{ "name": "CoTAG", "engine": "trees" },
	{ "name": "derivations", "engine": "trees" },
	{ "name": "strings", "engine" : "strings"},
	{ "name": "Strings", "engine" : "strings"},
	{ "name": "logic", "engine" : "logic"},
	{ "name": "low_logic", "engine" : "logic"},
	{ "name": "derived_trees", "engine" : "unranked trees"},
	{ "name": "Derived_trees", "engine" : "unranked trees"},
	{ "name": "trees", "engine" : "unranked trees"}
    ],
  "colors": {
      "node-background": (239, 239, 239),
      "background": (255,255,255)
  }
}

An example file is given in examples/config.json

ACG emacs mode

There is an ACG emacs mode acg.el in the emacs directory.

Look at the INSTALL.md file to see how to install it and where you can find the acg.el file if automatically installed (in particular using opam).

It's main feature is to be loaded when editing an acg data file (with signatures and lexicons). It is automatically loaded for files with a .acg extension

It basically contains compilation directives and next-error searching.

  1. First load an acg file
  2. then run M-x compile (or C-c C-c) to call the compiler (acgc)
  3. then run M-x next-error (or ``C-x ) to search for the next error (if any) and highlights it

Syntax of signature and lexicons

(See the examples/tag.acg file for an example).

Signatures are defined by:

signature my_sig_name=
	sig_entries
end

sig_entries is a list of sig_entry, separated with a ;. A sig_entry can be:

Lexicons

There are two ways to define a lexicon:

  1. By using the keyword lexicon or nl_lexicon as in :

        lexicon my_lex_name(abstract_sig_name) : object_sig_name =
    	lex_entries
    end
    ```
    or
    ```
    nl_lexicon my_lex_name(abstract_sig_name) : object_sig_name =
    	lex_entries
    end
    ```
    With the `lexicon` keyword, `lambda` (resp. `->`) is interpreted as `lambda` (resp. `->`), whereas with `nl_lexicon`, `lambda` (resp. `->`) is interpreted as `Lambda` (resp. `=>`). I.e., everything is interpreted non linearly. It is useful when not interested in linear constraints in the object signature (as, for instance, in the context-free lambda grammars).
    
    `Lex_entries` is a list of `lex_entry`, separated with a `;`. A `lex_entry` can be of the following forms:
    * `abstract_atomic_type1, abstract_atomic_type2 := object_type;`
    * `abstract_const1, abstract_const2 := object_term;`
  2. By lexicon composition as in:

    lexicon my_new_lex = lex_2 << lex_1

Keywords

The keywords are signature, lexicon, nl_lexicon, end, type, prefix, infix, binder, lambda, and Lambda.

The reserved symbols are =, <<, ;, :, ,, (, ), ., ->, =>, and :=.

Inside a signature or a lexicon, signature, lexicon and nl_lexicon are not considered as keywords and can be used as identifier.

Other keywords can be used as identifier when escaped with \ (e.g., \end).