Google Git
Sign in
eclipse / gerrit / www.eclipse.org / epsilon / 9d743d07b136179bcdfde09d98adbf88fa74de37 / . / doc / articles / picto-xtext / index.html
blob: 67243316d19f2a36c5f6aceac2f52a43a2022dfe [file] [log] [blame]
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" href="../../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.5">
<title>Visualising Xtext Models with Picto - Epsilon</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.bde7dde4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
<meta name="theme-color" content="#000000">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../../assets/stylesheets/mermaid.css">
<link rel="stylesheet" href="../../../assets/javascript/google-code-prettify/prettify.css">
<link rel="stylesheet" href="https://unpkg.com/mermaid@8.5.1/dist/mermaid.css">
<link rel="stylesheet" href="../../../assets/stylesheets/slick.css">
<link rel="stylesheet" href="../../../assets/stylesheets/slick-theme.css">
<link rel="stylesheet" href="../../../assets/stylesheets/extra.css">
<script>
window.ga = window.ga || function() {
(ga.q = ga.q || []).push(arguments)
}
ga.l = +new Date
/* Setup integration and send page view */
ga("create", "UA-184785655-1", "auto")
ga("set", "anonymizeIp", true)
ga("send", "pageview")
/* Register handler to log search on blur */
document.addEventListener("DOMContentLoaded", () => {
if (document.forms.search) {
var query = document.forms.search.query
query.addEventListener("blur", function() {
if (this.value) {
var path = document.location.pathname;
ga("send", "pageview", path + "?q=" + this.value)
}
})
}
})
</script>
<script async src="https://www.google-analytics.com/analytics.js"></script>
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="black" data-md-color-accent="orange">
<script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#visualising-xtext-models-with-picto" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../.." title="Epsilon" class="md-header__button md-logo" aria-label="Epsilon" data-md-component="logo">
<img src="../../../assets/images/epsilon-white-background.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Epsilon
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Visualising Xtext Models with Picto
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://git.eclipse.org/c/epsilon/org.eclipse.epsilon.git/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
Git repository @ Eclipse
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../.." title="Epsilon" class="md-nav__button md-logo" aria-label="Epsilon" data-md-component="logo">
<img src="../../../assets/images/epsilon-white-background.png" alt="logo">
</a>
Epsilon
</label>
<div class="md-nav__source">
<a href="https://git.eclipse.org/c/epsilon/org.eclipse.epsilon.git/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
Git repository @ Eclipse
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
Home
</a>
</li>
<li class="md-nav__item">
<a href="../../../download/" class="md-nav__link">
Download
</a>
</li>
<li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../../live" class="md-nav__link">
Playground
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5">
Documentation
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Documentation" data-md-level="1">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../../emc/" class="md-nav__link">
Model Connectivity
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
<label class="md-nav__link" for="__nav_5_3">
Languages
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Languages" data-md-level="2">
<label class="md-nav__title" for="__nav_5_3">
<span class="md-nav__icon md-icon"></span>
Languages
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../eol/" class="md-nav__link">
Object Language (EOL)
</a>
</li>
<li class="md-nav__item">
<a href="../../egl/" class="md-nav__link">
Code Generation (EGL)
</a>
</li>
<li class="md-nav__item">
<a href="../../evl/" class="md-nav__link">
Model Validation (EVL)
</a>
</li>
<li class="md-nav__item">
<a href="../../etl/" class="md-nav__link">
Model Transformation (ETL)
</a>
</li>
<li class="md-nav__item">
<a href="../../ecl/" class="md-nav__link">
Model Comparison (ECL)
</a>
</li>
<li class="md-nav__item">
<a href="../../eml/" class="md-nav__link">
Model Merging (EML)
</a>
</li>
<li class="md-nav__item">
<a href="../../epl/" class="md-nav__link">
Pattern Matching (EPL)
</a>
</li>
<li class="md-nav__item">
<a href="../../flock/" class="md-nav__link">
Model Migration (Flock)
</a>
</li>
<li class="md-nav__item">
<a href="../../emg/" class="md-nav__link">
Model Generation (EMG)
</a>
</li>
<li class="md-nav__item">
<a href="../../eunit/" class="md-nav__link">
Unit Testing (EUnit)
</a>
</li>
<li class="md-nav__item">
<a href="../../pinset/" class="md-nav__link">
Dataset Extraction (Pinset)
</a>
</li>
<li class="md-nav__item">
<a href="../../ewl/" class="md-nav__link">
Wizard Language (EWL)
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
<label class="md-nav__link" for="__nav_5_4">
Tools
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Tools" data-md-level="2">
<label class="md-nav__title" for="__nav_5_4">
<span class="md-nav__icon md-icon"></span>
Tools
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../picto/" class="md-nav__link">
Picto
</a>
</li>
<li class="md-nav__item">
<a href="../../flexmi/" class="md-nav__link">
Flexmi
</a>
</li>
<li class="md-nav__item">
<a href="../../eugenia/" class="md-nav__link">
Eugenia
</a>
</li>
<li class="md-nav__item">
<a href="../../exeed/" class="md-nav__link">
Exeed
</a>
</li>
<li class="md-nav__item">
<a href="../../modelink/" class="md-nav__link">
Modelink
</a>
</li>
<li class="md-nav__item">
<a href="../../hutn/" class="md-nav__link">
HUTN
</a>
</li>
<li class="md-nav__item">
<a href="../../workflow/" class="md-nav__link">
Workflow (Ant tasks)
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
Articles
</a>
</li>
<li class="md-nav__item">
<a href="../../../examples/" class="md-nav__link">
Examples
</a>
</li>
<li class="md-nav__item">
<a href="https://www.youtube.com/epsilondevs" class="md-nav__link">
Screencasts
</a>
</li>
<li class="md-nav__item">
<a href="https://www.youtube.com/playlist?list=PLRwHao6Ue0YUecg7vEUQTrtySIWwrd_mI" class="md-nav__link">
Lectures
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
<label class="md-nav__link" for="__nav_5_9">
Javadoc
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Javadoc" data-md-level="2">
<label class="md-nav__title" for="__nav_5_9">
<span class="md-nav__icon md-icon"></span>
Javadoc
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="https://download.eclipse.org/epsilon/stable-javadoc/" class="md-nav__link">
Stable
</a>
</li>
<li class="md-nav__item">
<a href="https://download.eclipse.org/epsilon/interim-javadoc/" class="md-nav__link">
Interim
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6">
Issues
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Issues" data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Issues
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?product=epsilon" class="md-nav__link">
Report a new issue
</a>
</li>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/buglist.cgi?product=epsilon&cmdtype=doit&order=Reuse+same+sort+as+last+time&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial" class="md-nav__link">
View open bugs
</a>
</li>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/buglist.cgi?product=epsilon&cmdtype=doit&order=Reuse+same+sort+as+last+time&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=enhancement" class="md-nav__link">
View enhancement requests
</a>
</li>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=RESOLVED&list_id=17694438&product=epsilon&query_format=advanced" class="md-nav__link">
View issues resolved since the last stable release
</a>
</li>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/buglist.cgi?product=epsilon&cmdtype=doit&order=Reuse+same+sort+as+last+time" class="md-nav__link">
View all issues
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7">
Community
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Community" data-md-level="1">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Community
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
<label class="md-nav__link" for="__nav_7_1">
Who is using Epsilon?
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Who is using Epsilon?" data-md-level="2">
<label class="md-nav__title" for="__nav_7_1">
<span class="md-nav__icon md-icon"></span>
Who is using Epsilon?
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../users/" class="md-nav__link">
Industry
</a>
</li>
<li class="md-nav__item">
<a href="../../../users/education/" class="md-nav__link">
Education
</a>
</li>
<li class="md-nav__item">
<a href="../../../users/open-source/" class="md-nav__link">
Open-source Projects
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="https://projects.eclipse.org/projects/modeling.epsilon/who" class="md-nav__link">
Who is developing Epsilon?
</a>
</li>
<li class="md-nav__item">
<a href="https://www.eclipse.org/forums/index.php/f/22/" class="md-nav__link">
Forum
</a>
</li>
<li class="md-nav__item">
<a href="../../../professional-services" class="md-nav__link">
Professional Services
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_5" type="checkbox" id="__nav_7_5" >
<label class="md-nav__link" for="__nav_7_5">
Social Media
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Social Media" data-md-level="2">
<label class="md-nav__title" for="__nav_7_5">
<span class="md-nav__icon md-icon"></span>
Social Media
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="https://twitter.com/eclipseepsilon" class="md-nav__link">
Twitter
</a>
</li>
<li class="md-nav__item">
<a href="https://youtube.com/epsilondevs" class="md-nav__link">
YouTube
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../labs/" class="md-nav__link">
Epsilon Labs
</a>
</li>
<li class="md-nav__item">
<a href="../../../faq/" class="md-nav__link">
Frequently Asked Questions
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../branding/" class="md-nav__link">
Branding
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#setup" class="md-nav__link">
Setup
</a>
</li>
<li class="md-nav__item">
<a href="#the-picto-xtext-integration-plugin-project" class="md-nav__link">
The Picto-Xtext Integration Plugin Project
</a>
<nav class="md-nav" aria-label="The Picto-Xtext Integration Plugin Project">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#the-dmodelpictosource-class" class="md-nav__link">
The DmodelPictoSource class
</a>
</li>
<li class="md-nav__item">
<a href="#the-visualisation-transformation" class="md-nav__link">
The Visualisation Transformation
</a>
</li>
<li class="md-nav__item">
<a href="#interactive-diagrams" class="md-nav__link">
Interactive Diagrams
</a>
</li>
<li class="md-nav__item">
<a href="#lazy-execution" class="md-nav__link">
Lazy Execution
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="visualising-xtext-models-with-picto">Visualising Xtext Models with Picto<a class="headerlink" href="#visualising-xtext-models-with-picto" title="Permanent link">&para;</a></h1>
<p>This article shows how <a href="../../picto">Picto</a> can be used to produce graphical views from Xtext-based models. To demonstrate the Picto/Xtext integration, we use the Entity DSL showcased in the <a href="https://www.eclipse.org/Xtext/documentation/102_domainmodelwalkthrough.html">15' Xtext tutorial</a>.</p>
<p><img alt="" src="picto-xtext.gif" /></p>
<h2 id="setup">Setup<a class="headerlink" href="#setup" title="Permanent link">&para;</a></h2>
<ul>
<li>Import the projects below from the <code>examples</code> folder of the <a href="https://git.eclipse.org/c/epsilon/org.eclipse.epsilon.git/tree/examples">Epsilon Git repository</a><ul>
<li><code>org.eclipse.epsilon.examples.picto.xtext.domainmodel</code></li>
<li><code>org.eclipse.epsilon.examples.picto.xtext.domainmodel.ide</code></li>
<li><code>org.eclipse.epsilon.examples.picto.xtext.domainmodel.ui</code></li>
<li><code>org.eclipse.epsilon.examples.picto.xtext.domainmodel.picto</code></li>
</ul>
</li>
<li>Right-click on <code>Domainmodel.xtext</code> and select <code>Run As</code> &rarr; <code>Generate Xtext Artefacts</code></li>
<li>Run a nested Eclipse instance.</li>
<li>In the nested Eclipse instance workspace, create a new file named <code>blog.dmodel</code> with the content below:</li>
</ul>
<div class="highlight"><pre><span></span><code>datatype String
entity Blog {
title: String
many posts: Post
}
entity HasAuthor {
author: String
}
entity Post extends HasAuthor {
title: String
content: String
many comments: Comment
}
entity Comment extends HasAuthor {
content: String
many responses: Comment
}
</code></pre></div>
<ul>
<li>Open the Picto view from the Window &rarr; Show View menu.</li>
<li>Go through the produced graphical views as shown in the image above.</li>
</ul>
<h2 id="the-picto-xtext-integration-plugin-project">The Picto-Xtext Integration Plugin Project<a class="headerlink" href="#the-picto-xtext-integration-plugin-project" title="Permanent link">&para;</a></h2>
<p>We now dive into the <code>org.eclipse.epsilon.examples.picto.xtext.domainmodel.picto</code> project which contains the Picto-Xtext integration code (the rest of the projects are standard Xtext projects).</p>
<h3 id="the-dmodelpictosource-class">The DmodelPictoSource class<a class="headerlink" href="#the-dmodelpictosource-class" title="Permanent link">&para;</a></h3>
<p>This class extends Picto's built-in <code>EglPictoSource</code> class and produces graphical views in Picto from <code>*.dmodel</code> files edited in an Xtext-based editor. In particular:</p>
<ul>
<li>The <code>supportsEditorType</code> method specifies that this class contributes visualisation capabilities to Xtext-based editors, the title of which ends with <code>.dmodel</code></li>
<li>The <code>getRenderingMetadata</code> method specifies the <a href="../../egl">EGL</a> transformation that produces the graphical views every time an editor of interest is opened, activated or saved.</li>
<li>The <code>getFile</code> and <code>getResource</code> methods extract an <code>IFile</code> and an EMF <code>Resource</code> from the editor of interest and should be reusable without changes for other Xtext-based languages too.</li>
<li>The <code>showElement</code> method reveals and highlights the element with the specified <code>id</code> in the Xtext editor, enabling <a href="#interactive-diagrams">navigation back to the source model</a> of the view.</li>
</ul>
<div class="highlight"><pre><span></span><code><span class="kn">package</span> <span class="nn">org.eclipse.epsilon.examples.picto.xtext.domainmodel.picto</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.core.resources.IFile</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.emf.ecore.resource.Resource</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.epsilon.picto.dom.Picto</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.epsilon.picto.dom.PictoFactory</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.epsilon.picto.source.EglPictoSource</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.jface.text.source.ISourceViewer</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.ui.IEditorInput</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.ui.IEditorPart</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.ui.IFileEditorInput</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.ui.PlatformUI</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.xtext.nodemodel.ICompositeNode</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.xtext.nodemodel.util.NodeModelUtils</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.xtext.resource.XtextResource</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.xtext.ui.editor.XtextEditor</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.xtext.ui.workspace.WorkspaceLockAccess.Result</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">org.eclipse.xtext.util.concurrent.IUnitOfWork</span><span class="p">;</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">DmodelPictoSource</span> <span class="kd">extends</span> <span class="n">EglPictoSource</span> <span class="p">{</span>
<span class="nd">@Override</span>
<span class="kd">protected</span> <span class="n">Picto</span> <span class="nf">getRenderingMetadata</span><span class="p">(</span><span class="n">IEditorPart</span> <span class="n">editorPart</span><span class="p">)</span> <span class="p">{</span>
<span class="n">Picto</span> <span class="n">metadata</span> <span class="o">=</span> <span class="n">PictoFactory</span><span class="p">.</span><span class="na">eINSTANCE</span><span class="p">.</span><span class="na">createPicto</span><span class="p">();</span>
<span class="n">metadata</span><span class="p">.</span><span class="na">setTransformation</span><span class="p">(</span><span class="s">&quot;platform:/plugin/org.eclipse.epsilon.examples.picto.xtext.domainmodel.picto/dmodel.egx&quot;</span><span class="p">);</span>
<span class="k">return</span> <span class="n">metadata</span><span class="p">;</span>
<span class="p">}</span>
<span class="nd">@Override</span>
<span class="kd">protected</span> <span class="n">Resource</span> <span class="nf">getResource</span><span class="p">(</span><span class="n">IEditorPart</span> <span class="n">editorPart</span><span class="p">)</span> <span class="p">{</span>
<span class="n">XtextEditor</span> <span class="n">editor</span> <span class="o">=</span> <span class="p">(</span><span class="n">XtextEditor</span><span class="p">)</span> <span class="n">editorPart</span><span class="p">;</span>
<span class="kd">final</span> <span class="n">XtextResourceHolder</span> <span class="n">holder</span> <span class="o">=</span> <span class="k">new</span> <span class="n">XtextResourceHolder</span><span class="p">();</span>
<span class="n">editor</span><span class="p">.</span><span class="na">getDocument</span><span class="p">().</span><span class="na">readOnly</span><span class="p">(</span><span class="k">new</span> <span class="n">IUnitOfWork</span><span class="o">&lt;</span><span class="n">Result</span><span class="p">,</span> <span class="n">XtextResource</span><span class="o">&gt;</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">public</span> <span class="n">Result</span> <span class="nf">exec</span><span class="p">(</span><span class="n">XtextResource</span> <span class="n">state</span><span class="p">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="p">{</span>
<span class="n">holder</span><span class="p">.</span><span class="na">setResource</span><span class="p">(</span><span class="n">state</span><span class="p">);</span>
<span class="k">return</span> <span class="kc">null</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">});</span>
<span class="k">return</span> <span class="n">holder</span><span class="p">.</span><span class="na">getResource</span><span class="p">();</span>
<span class="p">}</span>
<span class="nd">@Override</span>
<span class="kd">protected</span> <span class="n">IFile</span> <span class="nf">getFile</span><span class="p">(</span><span class="n">IEditorPart</span> <span class="n">editorPart</span><span class="p">)</span> <span class="p">{</span>
<span class="n">IEditorInput</span> <span class="n">editorInput</span> <span class="o">=</span> <span class="p">((</span><span class="n">XtextEditor</span><span class="p">)</span> <span class="n">editorPart</span><span class="p">).</span><span class="na">getEditorInput</span><span class="p">();</span>
<span class="k">if</span> <span class="p">(</span><span class="n">editorInput</span> <span class="k">instanceof</span> <span class="n">IFileEditorInput</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="p">((</span><span class="n">IFileEditorInput</span><span class="p">)</span> <span class="n">editorInput</span><span class="p">).</span><span class="na">getFile</span><span class="p">();</span>
<span class="p">}</span>
<span class="k">return</span> <span class="kc">null</span><span class="p">;</span>
<span class="p">}</span>
<span class="nd">@Override</span>
<span class="kd">protected</span> <span class="kt">boolean</span> <span class="nf">supportsEditorType</span><span class="p">(</span><span class="n">IEditorPart</span> <span class="n">editorPart</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">editorPart</span> <span class="k">instanceof</span> <span class="n">XtextEditor</span> <span class="o">&amp;&amp;</span>
<span class="n">editorPart</span><span class="p">.</span><span class="na">getTitle</span><span class="p">().</span><span class="na">endsWith</span><span class="p">(</span><span class="s">&quot;.dmodel&quot;</span><span class="p">);</span>
<span class="p">}</span>
<span class="nd">@Override</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">showElement</span><span class="p">(</span><span class="n">String</span> <span class="n">id</span><span class="p">,</span> <span class="n">String</span> <span class="n">uri</span><span class="p">,</span> <span class="n">IEditorPart</span> <span class="n">editor</span><span class="p">)</span> <span class="p">{</span>
<span class="n">ICompositeNode</span> <span class="n">node</span> <span class="o">=</span> <span class="n">NodeModelUtils</span><span class="p">.</span><span class="na">getNode</span><span class="p">(</span><span class="n">getResource</span><span class="p">(</span><span class="n">editor</span><span class="p">).</span><span class="na">getEObject</span><span class="p">(</span><span class="n">id</span><span class="p">));</span>
<span class="k">if</span> <span class="p">(</span><span class="n">node</span> <span class="o">!=</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
<span class="n">ISourceViewer</span> <span class="n">textViewer</span> <span class="o">=</span> <span class="p">((</span><span class="n">XtextEditor</span><span class="p">)</span> <span class="n">editor</span><span class="p">).</span><span class="na">getInternalSourceViewer</span><span class="p">();</span>
<span class="kt">int</span> <span class="n">offset</span> <span class="o">=</span> <span class="n">node</span><span class="p">.</span><span class="na">getOffset</span><span class="p">();</span>
<span class="kt">int</span> <span class="n">length</span> <span class="o">=</span> <span class="n">node</span><span class="p">.</span><span class="na">getLength</span><span class="p">();</span>
<span class="n">textViewer</span><span class="p">.</span><span class="na">setRangeIndication</span><span class="p">(</span><span class="n">offset</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="kc">true</span><span class="p">);</span>
<span class="n">textViewer</span><span class="p">.</span><span class="na">revealRange</span><span class="p">(</span><span class="n">offset</span><span class="p">,</span> <span class="n">length</span><span class="p">);</span>
<span class="n">textViewer</span><span class="p">.</span><span class="na">setSelectedRange</span><span class="p">(</span><span class="n">offset</span><span class="p">,</span> <span class="n">length</span><span class="p">);</span>
<span class="n">PlatformUI</span><span class="p">.</span><span class="na">getWorkbench</span><span class="p">().</span><span class="na">getActiveWorkbenchWindow</span><span class="p">().</span><span class="na">getActivePage</span><span class="p">().</span><span class="na">activate</span><span class="p">(</span><span class="n">editor</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<p>Picto is made aware of this class through the <code>org.eclipse.epsilon.picto.pictoSource</code> <a href="../../picto/#extending-picto">extension</a> in the project's <code>plugin.xml</code>.</p>
<div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
<span class="cp">&lt;?eclipse version=&quot;3.4&quot;?&gt;</span>
<span class="nt">&lt;plugin&gt;</span>
<span class="nt">&lt;extension</span>
<span class="na">point=</span><span class="s">&quot;org.eclipse.epsilon.picto.pictoSource&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;pictoSource</span>
<span class="na">class=</span><span class="s">&quot;org.eclipse.epsilon.examples.picto.xtext.domainmodel.picto.DmodelPictoSource&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;/pictoSource&gt;</span>
<span class="nt">&lt;/extension&gt;</span>
<span class="nt">&lt;/plugin&gt;</span>
</code></pre></div>
<h3 id="the-visualisation-transformation">The Visualisation Transformation<a class="headerlink" href="#the-visualisation-transformation" title="Permanent link">&para;</a></h3>
<p>The visualisation transformation has been implemented using Epsilon's <a href="../../egl">EGL model-to-text transformation language</a> and produces Graphviz-based class diagrams from the active entity model. The transformation consists of the <code>dmodel.egx</code> coordination rules, and the <code>entity2graphviz.egl</code> template shown below. The transformation produces one view for each entity in the model, which consists of the entity itself, any super/sub-types it may have, as well as other entities that it is related to. </p>
<div class="tabbed-set" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><label for="__tabbed_1_1">dmodel.egx</label><div class="tabbed-content">
<pre class="prettyprint lang-egx"><code>rule Entity2Graphviz
transform e : Entity {
template : "entity2graphviz.egl"
parameters : Map{
"path" = Sequence{"Model", e.name},
"icon" = "diagram-ffffff",
"format" = "graphviz-dot"
}
}</code></pre>
</div>
<input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><label for="__tabbed_1_2">entity2graphviz.egl</label><div class="tabbed-content">
<pre class="prettyprint lang-egl"><code>digraph G {
graph[splines=ortho]
node[fontname=Arial, fontsize=10, shape=record]
edge[fontname=Arial, fontsize=10]
[%var entities = getVisibleEntities();%]
[%for (e in entities){%]
[%=e.getNodeName()%][shape=none, margin=0, label=&lt;[%=e.getLabel()%]&gt;]
[%}%]
[%for (f in e.features.flatten().select(f|f.type.isTypeOf(Entity) and f.type &lt;&gt; e)){%]
[%=f.eContainer.getNodeName()%]-&gt;[%=f.type.getNodeName()%][arrowhead=[%=f.getArrow()%],arrowtail=none,tooltip="[%=f.name%]"];
[%}%]
[%if (e.superType.isDefined()){%]
[%=e.superType.getNodeName()%]-&gt;[%=e.getNodeName()%][arrowhead=none,arrowtail=empty,dir=back];
[%}%]
[%for (s in Entity.all.select(en|en.superType = e)){%]
[%=e.getNodeName()%]-&gt;[%=s.getNodeName()%][arrowhead=none,arrowtail=empty,dir=back];
[%}%]
}
[%
operation Entity getLabel() {
var onClick = "top.showView(['Model','" + self.name + "'])";
if (self == e) {
onClick = "top.showElement('" + self.id + "', '" + self.eResource.uri + "')";
}
var label = "&lt;table cellspacing='0' cellborder='0' cellpadding='1' bgcolor='" + self.getColour() + "'&gt;";
label += "&lt;tr&gt;&lt;td sides='B' colspan='2' border='1' cellpadding='0'&gt;" +
"&lt;table border='0' cellspacing='0' cellborder='0'&gt;" +
"&lt;tr&gt;&lt;td align='right' valign='middle'&gt;&lt;img src='" + self.getIcon()+ "'&gt;&lt;/img&gt;&lt;/td&gt;" +
"&lt;td align='left' valign='middle' href=\"javascript:" + onClick + "\" tooltip='Go'&gt;" + self.name + " &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;&lt;/td&gt;&lt;/tr&gt;";
label += "&lt;tr&gt;&lt;td&gt;&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt;";
for (f in self.features.sortBy(a|a.name.toLowerCase())) {
label += "&lt;tr&gt;";
label += "&lt;td&gt;&lt;img src='" + f.getIcon() + "'&gt;&lt;/img&gt;&lt;/td&gt;&lt;td align='left'&gt;" + f.getLabel() + "&lt;/td&gt;";
label += "&lt;/tr&gt;";
}
if (self.features.isEmpty()){
label += "&lt;tr&gt;";
label += "&lt;td&gt; &lt;/td&gt;&lt;td&gt; &lt;/td&gt;";
label += "&lt;/tr&gt;";
}
label += "&lt;/table&gt;";
return label;
}
operation Entity getIcon() {
return getImage("icons/entity.gif");
}
operation Feature getLabel() {
return self.name + " : " + self.type?.name + (self.many ? "["+"*"+"]" : "") ;
}
operation Feature getIcon() {
return getImage("icons/attribute.gif");
}
operation Entity getNodeName() {
return "_Entity" + Entity.all.indexOf(self);
}
operation Feature getArrow() {
if (self.many) {
return "crow";
}
else {
return "open";
}
}
operation getVisibleEntities() {
var visibleEntities : Set;
visibleEntities.add(e);
visibleEntities.addAll(e.features.select(f|f.type.isTypeOf(Entity)).collect(f|f.type));
if (e.superType.isDefined()) visibleEntities.add(e.superType);
visibleEntities.addAll(Entity.all.select(en|en.superType = e));
return visibleEntities;
}
operation Entity getColour() {
if (self == e) return "#fff2d2";
else return "#fffcdc";
}
%]</code></pre>
</div>
</div>
<h3 id="interactive-diagrams">Interactive Diagrams<a class="headerlink" href="#interactive-diagrams" title="Permanent link">&para;</a></h3>
<p>As shown below, you can navigate between diagrams and back to the Xtext editor using Picto's built-in <code>showElement</code> and <code>showView</code> <a href="../../picto#interactive-diagrams">JavaScript functions</a>.</p>
<p><img alt="" src="show-element.gif" /></p>
<h3 id="lazy-execution">Lazy Execution<a class="headerlink" href="#lazy-execution" title="Permanent link">&para;</a></h3>
<p>Since Picto executes <a href="../../picto/#scalability">EGL transformations lazily</a> when the entity model is saved, only the view that is currently visible is regenerated immediately, which is useful when working with large models.</p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
<div class="md-footer-copyright__highlight">
Copyright © Eclipse Foundation, Inc. All Rights Reserved.
</div>
powered by
<a href="https://www.mkdocs.org">MkDocs</a>
and
<a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>
</div>
<div class="md-footer-copyright epsilon-eclipse-links">
<ul>
<li><a href="https://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li>
<li><a href="https://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li>
<li><a href="https://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li>
</ul>
</div>
<div class="md-footer-social">
<a href="https://twitter.com/eclipseepsilon" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
</a>
<a href="https://youtube.com/epsilondevs" target="_blank" rel="noopener" title="youtube.com" class="md-footer-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.d351de03.min.js", "version": null}</script>
<script src="../../../assets/javascripts/bundle.a1609d9a.min.js"></script>
<script src="https://unpkg.com/mermaid@8.5.1/dist/mermaid.min.js"></script>
<script src="../../../assets/javascript/mermaid.js"></script>
<script src="../../../assets/javascript/jquery.js"></script>
<script src="../../../assets/javascript/slick.min.js"></script>
<script src="../../../assets/javascript/google-code-prettify/prettify.js"></script>
<script src="../../../assets/javascript/google-code-prettify/lang-emfatic.js"></script>
<script src="../../../assets/javascript/google-code-prettify/lang-epsilon.js"></script>
<script src="../../../assets/javascript/google-code-prettify/prettyprint.js"></script>
<script src="../../../assets/javascript/extra.js"></script>
<script src="https://w.appzi.io/w.js?token=jlv6W"></script>
</body>
</html>