Clafer
v0.3.6
Clafer is a general-purpose lightweight structural modeling language developed by
GSD Lab, University of Waterloo, and
MODELS group at IT University of Copenhagen.
Clafer can be used for modeling of static hierarchical structures but has no support for modeling the change of the structures over time (behavior).
The main goal of Clafer is to make modeling more accessible to a wider range of users and domains.
There are many possible applications of Clafer; however, three are prominent:
-
Product-Line Modeling - aims at representing and managing commonality and variability of assets in product lines and creating and verifying product configurations.
Clafer naturally supports multi-staged configuration.
-
Multi-Objective Product Optimization - aims at finding a set of products in a given product line that are optimal with respect to a set of objectives.
Clafer multi-objective optimizer generates a Pareto front of optimal product configurations.
-
Domain Modeling - aims at improving the understanding of the problem domain in the early stages of software development and determining the requirements with fewer defects.
This is also known as Concept Modeling or Ontology Modeling.
Clafer Compiler
Clafer compiler provides a reference language implementation.
It translates models in Clafer to other formats (e.g. Alloy, XML, Python, JS, HTML, DOT) to allow for reasoning and processing with existing tools (Alloy Analyzer, Choco3, and Z3 SMT solver).
Currently, the compiler is used by
- Backends
- Alloy-based Instance Generator (ClaferIG),
- Alloy-based Multi-Objective Optimizer (ClaferMOO),
- Choco3-based Instance Generator and Multi-Objective Optimizer (ChocoIG), and
- Z3-based Instance Generator and Multi-Objective Optimizer (ClaferZ3),
- Frontends
Contributors
- Kacper Bak, Original developer.
- Jimmy Liang, Main developer.
- Michał Antkiewicz, Requirements, development, architecture, testing, technology transfer.
- Ed Zulkoski, Python IR Generator.
- Luke Michael Brown, co-op student May-Aug 2013. Many improvements.
- Rafael Olaechea, Multi-Objective Optimization extensions.
Getting the Clafer Compiler
Clafer can be installed from a binary distribution (preferred), from Hackage, and from the source code.
Dependencies for running
Regardless of the installation method, the following are
Required:
Optional:
Installation of GLPK
On Linux
- libglpk-dev v4.52
- execute
sudo apt-get install libglpk-dev on Ubuntu
- libgmp-dev
- execute
sudo apt-get install libgmp-dev on Ubuntu
On Windows
- The binary distribution already includes the GNU Linear Programming Kit DLL
glpk_4_52.dll.
- Install WinGLPK v4.52
- inside the
w32 folder, copy glpk_4_52.dll to glpk.dll so that it can be found when building Haskell package glpk-hs
- from
w32 folder, copy glpk_4_52.dll to <user>\AppData\Roaming\cabal\bin
On Mac
- install GPLK 4.52 from MacPorts
- execute
sudo port install glpk +universal
Installation from binaries
Binary distributions of the release 0.3.6 of Clafer Tools for Windows, Mac, and Linux,
can be downloaded from
Clafer Tools - Binary Distributions.
- download the binaries and unpack
<target directory> of your choice
- add the
<target directory> to your system path so that the executables can be found
Installation from Hackage
Dependencies
Clafer is now available on Hackage and it can be installed using
cabal update
cabal install clafer
cd <cabal's lib or share folder> (C:\Users\<user>\AppData\Roaming\cabal\i386-windows-ghc-7.6.3\clafer-0.3.6 on Windows or .cabal/share/x86_64-linux-ghc-7.6.3/clafer-0.3.6/ on Linux)
- to automatically download Alloy jars
On Windows
- copy GLPK's dll
glpk-0.4.52.dll to the C:\Users\<user>\AppData\Roaming\cabal\bin folder or any other folder on the system PATH
Installation from the source code
Dependencies
On Windows
- MinGW+MSYS
- download mingw-get-setup.exe
- since the Haskell Platform already contains MinGW, only install MSYS. Installing another MinGW causes problems as it contains different versions of tools as compared to the MinGW in the Haskell Platform
- choose the existing MinGW location, e.g.,
c:\...\HaskellPlatform\2013.2.0.0\MinGw
- ensure
wget and unzip are selected to be installed
- add the
bin folder of MSYS (MinGW\MSYS\1.0\bin) to your system path
Important: Branches must correspond
All related projects are following the simultaneous release model.
The branch master contains releases, whereas the branch develop contains code under development.
When building the tools, the branches should match.
Releases from branches 'masterare guaranteed to work well together.
Development versions from branchesdevelop` should work well together but this might not always be the case.
Building
- install the dependencies
- open the command line terminal. On Windows, open MinGW.
- in some
<source directory> of your choice, execute
git clone git://github.com/gsdlab/clafer.git
- in
<source directory>/clafer, execute
- On Linux and Mac execute
- On Windows (in MinGW), execute
make glpk=/c/<your WinGLPK install dir>
Installation
- On Linux and Mac execute
make install to=<target directory>
- On Windows (in MinGW), execute
make glpk=/c/<your WinGLPK instal dir> to=/c/Users/<your user name>/AppData/Roaming/cabal/bin
Note:
On Windows, use / with the make command instead of \.
Integration with Sublime Text 2
See IDEs/clafer-README.md
Usage
Clafer Compiler
(As printed by clafer --help)
Clafer 0.3.6
clafer [OPTIONS] [FILE]
Common flags:
-m --mode=CLAFERMODE Generated output type. Available
CLAFERMODEs are: 'alloy' (default,
Alloy 4.1); 'alloy42' (Alloy 4.2);
'xml' (intermediate representation of
Clafer model); 'clafer' (analyzed and
desugared clafer model); 'html'
(original model in HTML); 'graph'
(graphical representation written in
DOT language); 'cvlgraph' (cvl
notation representation written in
DOT language); 'python' (generates IR
in python); 'choco' (Choco constraint
programming solver). Multiple modes
can be specified at the same time,
e.g., '-m alloy -m html'.
-o --console-output Output code on console.
-i --flatten-inheritance Flatten inheritance ('alloy' and
'alloy42' modes only).
--timeout-analysis=INT Timeout for analysis.
-l --no-layout Don't resolve off-side rule layout.
--nl --new-layout Use new fast layout resolver
(experimental).
-c --check-duplicates Check duplicated clafer names in
the entire model.
-f --skip-resolver Skip name resolution.
-k --keep-unused Keep uninstantated abstract clafers
('alloy' and 'alloy42' modes only).
-s --no-stats Don't print statistics.
--schema Show Clafer IR (intermediate
representation) XML schema.
-v --validate Validate outputs of all modes. Uses
'tools/XsdCheck.class' for XML,
'tools/alloy4.jar' and
'tools/alloy4.2.jar' for Alloy
models, and Clafer translator for
desugared Clafer models. Use
'--tooldir' to override the default
location of these tools.
--nr --noalloyruncommand For usage with partial instances:
Don't generate the alloy 'run show
for ... ' command, and rename @.ref
with unique names ('alloy' and
'alloy42' modes only).
--tooldir=DIR Specify the tools directory
('validate' only). Default: 'tools/'.
-a --alloy-mapping Generate mapping to Alloy source
code ('alloy' and 'alloy42' modes
only).
--self-contained Generate a self-contained html
document ('html' mode only).
--add-graph Add a graph to the generated html
model ('html' mode only). Requires
the "dot" executable to be on the
system path.
--sr --show-references Whether the links for references
should be rendered. ('html' and
'graph' modes only).
--add-comments Include comments from the source
file in the html output ('html' mode
only).
-e --ecore2clafer Translate an ECore model into
Clafer.
--ss=SCOPESTRATEGY --scope-strategy Use scope computation strategy:
none, simple (default), or full.
--check-afm --afm Throws an error if the cardinality
of any of the clafers is above 1.
--sg --skip-goals Skip generation of Alloy code for
goals. Useful for all tools working
with standard Alloy.
--meta-data Generate a 'fully qualified
name'-'least-partially-qualified
name'-'unique ID' map ('.cfr-map').
In Alloy, Alloy42, and Choco modes,
generate the scopes map
('.cfr-scope').
-? --help Display help message
-V --version Print version information
The dependencies among the command line arguments are described on the model wiki.
Multiple modes can be used at the same time. For example,
clafer model.cfr -m alloy -m xml -m html -m graph --self-contained --show-references --no-stats
The mode -m alloy is only a default mode if no other modes are given. When other modes are given, the mode -m alloy must be added explicitly if needed.
Additionally, [OPTIONS] can also be specified directly in the model file by inserting the following compiler directive as the first line of the file:
//# [OPTIONS]
for example
//# --keep-unused -m=alloy42
Options given at command line override the options given in the file using //# which, in turn, override the defaults.
Using compiler directives
Compiler directives are comments of the form
//# <directive name>
The following directives are markers of locations in the input files for different purposes:
//# FRAGMENT - marks the beginning of the new module fragment.
//# GRAPH - marks the insertion point for a graph rendering. The graph is only produced in HTML mode with the argument --add-graph.
//# STATS - marks the insertion point for module statistics. The statistics can be omitted using the argument --no-stats.
//# SUMMARY - shorthand for //# GRAPH and //# STATS
//# QUALITY_ATTRIBUTE - is used by ClaferMooVisualizer and ClaferConfigurator to distinguish quality attributes, which should be filtered out, from other clafers.
Need help?