Textual Modeling with Xtext

1

This tutorial presents the [[Xtext>>url:http://www.eclipse.org/Xtext/||shape="rect"]] framework, a toolsuite for the generation of plain text based model editors. Such textual editors provide syntax highlighting, content assist (ctrl-space), an outline, and much more out-of-the-box. You will start by creating a textual syntax for Turing Machines.

2

=== Contents ===

= Creating a Grammar =

10

11

An Xtext grammar is always related to a specific EMF meta model. The grammar defines a concrete syntax in which instances of the meta model (the abstract syntax) can be serialized and stored. Xtext supports two ways of linking a grammar with a meta model: either creating a grammar for an existing meta model, or creating a grammar first and generating a meta model out of it. Here we will use the former approach, reusing the meta model for Turing Machines that you already defined earlier.

12

13

1. //File// → //New// → //Project...// → //Xtext// → //Xtext Project From Existing Meta Models// → //Next// → //Add...// → turing.genmodel → //OK//

14

1. Select your top-level model element as "//Entry rule//", e.g. //TuringMachine// → //Next// → enter the following values:\\

15

1*. //Project name~:// de.cau.cs.rtprak.turing.text

16

1*. //Location~:// your repository path

17

1*. //Name~:// de.cau.cs.rtprak.turing.text.Turing

18

1*. //Extensions~:// tuxt (the file extension under which your text files will be stored)

19

1*. Uncheck //Create SDK feature project// (not required)

20

1. Finish → an editor is opened with a predefined grammar. The fourth line should contain an import statement followed by the namespace URI of your meta model, which is probably marked with an error. The problem here is that the meta model is not loaded in the Eclipse instance you are using for development. Fix this problem by replacing the URI by the workspace path of your Turing Machines ecore model, e.g. {{code language="none"}}"platform:/resource/de.cau.cs.rtprak.turing/model/turing.ecore"{{/code}}

Wiki source code of Textual Modeling with Xtext

Navigation

Quick Links

author	version	line-number	content
		1	This tutorial presents the [[Xtext>>url:http://www.eclipse.org/Xtext/\|\|shape="rect"]] framework, a toolsuite for the generation of plain text based model editors. Such textual editors provide syntax highlighting, content assist (ctrl-space), an outline, and much more out-of-the-box. You will start by creating a textual syntax for Turing Machines.
		2
		3	=== Contents ===
		4
		5
		6
		7	{{toc maxLevel="2"/}}
		8
		9	= Creating a Grammar =
		10
		11	An Xtext grammar is always related to a specific EMF meta model. The grammar defines a concrete syntax in which instances of the meta model (the abstract syntax) can be serialized and stored. Xtext supports two ways of linking a grammar with a meta model: either creating a grammar for an existing meta model, or creating a grammar first and generating a meta model out of it. Here we will use the former approach, reusing the meta model for Turing Machines that you already defined earlier.
		12
		13	1. //File// → //New// → //Project...// → //Xtext// → //Xtext Project From Existing Meta Models// → //Next// → //Add...// → turing.genmodel → //OK//
		14	1. Select your top-level model element as "//Entry rule//", e.g. //TuringMachine// → //Next// → enter the following values:\\
		15	1*. //Project name~:// de.cau.cs.rtprak.turing.text
		16	1*. //Location~:// your repository path
		17	1*. //Name~:// de.cau.cs.rtprak.turing.text.Turing
		18	1*. //Extensions~:// tuxt (the file extension under which your text files will be stored)
		19	1*. Uncheck //Create SDK feature project// (not required)
		20	1. Finish → an editor is opened with a predefined grammar. The fourth line should contain an import statement followed by the namespace URI of your meta model, which is probably marked with an error. The problem here is that the meta model is not loaded in the Eclipse instance you are using for development. Fix this problem by replacing the URI by the workspace path of your Turing Machines ecore model, e.g. {{code language="none"}}"platform:/resource/de.cau.cs.rtprak.turing/model/turing.ecore"{{/code}}