.. _Basic Tutorial:

Basic Tutorial
==============

.. rst-class:: lead

   This tutorial provides a step by step walk-through of the e Language development environment.

Switch to the DVT Perspective
-----------------------------

The DVT Perspective provides a workbench layout with many useful views and shortcuts at hand for developing e code, for example the type browser, extensions browser etc.

From menu :menuselection:`Window --> Open Perspective --> Other...` choose :guilabel:`DVT`

.. figure:: ../../images/common/dvt-open-perspective.png
	:align: center



You can customize and save a perspective. In order to further speed-up the development, at any time you can switch between various perspectives with different tool (views) layouts. For example you can use one perspective for writing e code (the editor will take most of the real estate) and another perspective for code navigation (type browser will be a significant component).

The default DVT perspective looks like this: 

.. figure:: ../../images/common/dvt-default-perspective.png
	:align: center



.. _Open a Project:


Open a Project
--------------

A **project** corresponds to a specific directory on the disk. The **project** is presented in the **Navigator View** - a file browser component that helps you browse the project directory contents.

.. seealso::

   :ref:`What is a Project`

Create a New Project
~~~~~~~~~~~~~~~~~~~~

Invoke the New Project Wizard: Choose menu :menuselection:`File --> New --> DVT Project`.

.. figure:: ../../images/common/new-project-wizard.png
	:align: center

#.  **Specify the Project Directory** It can be a directory that already contains sources or a new directory that will be created. 
#.  **Specify the Project Name** By default, the project's name is the last segment of the project's directory path (e.g. **/tmp/path1/path2/p_name > p_name**). You can change this name by selecting **Custom**.

    .. note::

	    If **Project Directory** points to an existing project, you cannot change its name.
#.  **Open a Predefined Project** You may open one of the predefined projects that DVT ships with and continue to explore the DVT features. For more details see :ref:`Predefined Projects`.
#.  **Specify the Project Nature**. If the project does not exist or it does not contain any nature, you must select at least one nature. This way DVT will compile the respective sources. 

Configure the Build
-------------------

As soon as you create a project, you'll be notified there is nothing to build. 

.. figure:: ../../images/common/no-default-build.png
	:align: center




To configure the build **follow the link** in the build notification dialog or open the **.dvt/default.build** file.

In order to provide advanced functionality (like hyperlinks, autocomplete, design and class hierarchy, error signaling, etc.) DVT analyzes the source code files in your project. This analysis process is called build.

By default, DVT doesn't build anything. In order to build, DVT uses the arguments that you specify in one of the <name>.build files located in the .dvt folder of your project.

The default build configuration is .dvt/default.build. Here you list compilation directives in a similar way you would pass arguments to any simulator. 

.. seealso::
   
   :ref:`Build Configurations`.

Build the Project
-----------------

.. |rebuild-icon| image:: ../../images/icons/act16/rebuild.png
   :class: inline

Once you specified the files you want to compile, the specman path to be used and so on, you should rebuild the project. In general, every time you change the .build configuration, you should rebuild.

In order to rebuild you click the **Rebuild button** |rebuild-icon|.

While editing source files, a project is incrementally compiled as soon as you save, unless the menu option :menuselection:`Project --> Build Automatically` is un-checked.

The building progress is reported in the :guilabel:`Progress View`. Depending on your configuration, you may also see detailed information in the :guilabel:`Console View`.

.. figure:: ../../images/edt-get_started-buid-progress.png
	:align: center

Inspect the Compilation Errors
------------------------------

Syntax errors are detected as you type. 

.. figure:: ../../images/edt-get_started-type_err-err.png
	:align: center

They are indicated in the vertical bars of the editor (left - for the visible code, right - for the full file). If you **keep the mouse over the marker** on the left you'll see more details about the error.

.. figure:: ../../images/edt-get_started-type_err-label.png
	:align: center

Same tooltip will appear if you keep the mouse over the marker on the editor right bar. You can also **click on the marker** to jump to the error.

.. figure:: ../../images/edt-get_started-type_err-marker.png
	:align: center

If a project contains errors, for example syntax errors, it will be indicated using **decorators**: 

.. figure:: ../../images/edt-get_started-browse_err-navigator.png
	:align: center

You can use the :guilabel:`Problems View` to inspect the errors. You can show the Problems View from menu :menuselection:`Window --> Show View --> Other... --> General --> Problems`. **Double clicking** on some error will jump to the source location.

.. figure:: ../../images/edt-get_started-browse_err-fullscreen.png
	:align: center

See Comments in Tooltips
------------------------

When you position the mouse over a type, method, field etc., a tooltip will pop-up showing information on corresponding declaration.

Some examples are presented below. In a similar way you'll see information on fields, events, variables etc., predefined or not. 

.. list-table::
   :widths: 10 90
   :header-rows: 0
   :stub-columns: 1
   :align: center

   * - Type Info
     - .. figure:: ../../images/edt-get_started-tooltips-typeinfo.png
          :align: center

   * - Method Info
     - .. figure:: ../../images/edt-get_started-tooltips-methodinfo.png
          :align: center


The information presented in the tooltip is created using the comment on top of the declaration.

For example, given the following declaration of an event: 

.. figure:: ../../images/edt-get_started-tooltips-event_decl.png
	:align: center


the corresponding tooltip will look like this:

.. figure:: ../../images/edt-get_started-tooltips-event_tooltip.png
	:align: center


For predefined entities, the tooltip presents the description from the e language reference manual.

.. figure:: ../../images/edt-get_started-tooltips-predefined.png
	:align: center


Use Hyperlinks to Move Around in the Code
-----------------------------------------

If you **place the mouse over** a type, method, field etc. and press the :kbd:`Ctrl` key, a hyperlink will be presented. **Click on the hyperlink to jump to definition**.

You can also jump to a definition if you put the cursor on the relevant name and  :kbd:`F3`.

.. figure:: ../../images/edt-get_started-hyperlinks-ex.png
	:align: center


You can hyperlink and jump to an imported file.

Quickly Open a Type (Struct, Unit)
----------------------------------

You can quickly open a specific type definition, just press :kbd:`Ctrl+Shift+T`.

The Quick Types View will pop-up and you can enter any regular expression to locate a type. Select and press :kbd:`Enter` or :kbd:`Click` to jump to its definition. 

.. figure:: ../../images/edt_quick_types_view.png
	:align: center


Quickly Open a File
-------------------

You can quickly open a file imported via the top files. Just press :kbd:`Ctrl+I`.

The Quick Compile Order View will pop-up and you can enter any regular expression to locate a file. Select and press :kbd:`Enter` or :kbd:`Click` to open the file. 

.. figure:: ../../images/edt_quick_compile_order_view.png
	:align: center


You can also see the compile order of the files in your project in the :guilabel:`Compile Order View`. Open the view from menu :menuselection:`Window --> Show View --> Other... --> DVT --> Compile Order`.

.. figure:: ../../images/edt_compile_order_view.png
	:align: center


Quickly Move Inside the Editor
------------------------------

Press :kbd:`Ctrl+O` to open the Quick Outline for an overview of your file. You can enter any regular expression to locate an entity to jump in the current file. 

.. figure:: ../../images/edt-reference-views-quick_outline_view.png
	:align: center


You can also see the outline in the :guilabel:`Outline View`. Open the view from menu :menuselection:`Window --> Show View --> Other... --> General --> Outline`.

.. figure:: ../../images/edt-reference-views-outline_view.png
	:align: center


Browse Through All the Available Types (Structs, Units, Enumerations)
---------------------------------------------------------------------

You can explore all the types (enums, structs, units) defined or extended in your project using the :guilabel:`Types View`.

Go to menu :menuselection:`Window --> Show View --> Other... --> DVT --> Types` to open the :guilabel:`Types View`. 

.. figure:: ../../images/edt_types_view.png
	:align: center


Browse the AOP Extensions
-------------------------

You can view all the extensions (layers) of a specific type, method, event etc. Position the cursor on the relevant name and press :kbd:`Shift+F3` or **right click** and chose :menuselection:`Show --> Layers` from the menu.

The :guilabel:`Layers View` will present information about all the extensions including:

-  extension kind (when subtype, is first or is also etc.)
-  source location (file, line)
-  documentation (extracted from the comment lines above the layer definition)

.. figure:: ../../images/edt-layers-view.png
	:align: center


You can also quickly jump to a specific extension. Press :kbd:`Ctrl+Shift+O` with the cursor positioned on the name.

.. figure:: ../../images/edt_quick_layers_view.png
	:align: center


Inspect the Struct Hierarchy and Struct Members
-----------------------------------------------

Position the cursor on the relevant name and press :kbd:`F4` or **right click** and chose :menuselection:`Show --> Hierarchy` from the menu.

The :guilabel:`Type Hierarchy View` will present information about a struct including:

-  parents
-  children
-  members

.. figure:: ../../images/edt_type_hierarchy_view.png
	:align: center


You can also quickly jump to a specific parent or child. Press :kbd:`Ctrl+T` with the cursor positioned on the name.

.. figure:: ../../images/edt_quick_type_hierarchy_view.png
	:align: center


Inspect the Verification Hierarchy
----------------------------------

Position the cursor on a unit name and press :kbd:`Shift+F6` or **right click** and chose :menuselection:`Show --> Verification Hierarchy` from the menu.

The :guilabel:`Verification Hierarchy View` opens with the chosen unit set as the top of the hierarchy.

.. figure:: ../../images/common/e-verification-hierarchy-presentation.png
	:align: center


Search for Entities
-------------------

You can search for a specific type, method etc. in the current project or whole workspace. Press :kbd:`Ctrl+H` to pop-up the search dialog. 

.. figure:: ../../images/edt-get_started-search-window.png
	:align: center

The results are presented in the :guilabel:`Search View`.

.. figure:: ../../images/edt-get_started-search-view.png
	:align: center


Use Content Assist (Autocomplete)
---------------------------------

.. include:: ../content-assist-autocomplete/content-assist-common.rst


Use Code Templates
------------------

When you trigger autocomplete using :kbd:`Ctrl+Space`, template suggestions may appear in the proposal list. 

.. figure:: ../../images/common/global-code-templates-e-proposal.png
	:align: center


To define templates go to the :menuselection:`DVT --> Code Templates` preference page (via menu :menuselection:`Window --> Preferences`) and select **e Language** from :guilabel:`Select Nature`.

.. figure:: ../../images/common/global-code-templates-pref-page.png
	:align: center


Click the :guilabel:`New` button to define a new template. The template name is important for proposal filtering based on already typed text.

.. figure:: ../../images/common/code-templates-edit-template.png
	:align: center


Track Tasks using TODO Markers
------------------------------

If you place TODO markers in your code they are recognized and presented in the :guilabel:`Tasks View`. This is a mean to insert reminders, preserve, track and share them with your team.

You can use TODO markers inside comments. **FIXME** (high priority), **TODO** and **XXX** (low priority) are recognized. 

Go to menu :menuselection:`Window --> Show View --> Other... --> General --> Tasks` to open the :guilabel:`Tasks View`.

**Double click** on a task to jump to the marker definition.

.. figure:: ../../images/edt-reminders-CodeTasksView.png
	:align: center


Format the Source Code
----------------------

You can format the selected code or the whole current file, if no selection, from the right click menu :menuselection:`Source --> Format Source`.

Quickly See the Current Scope in the Status Bar
-----------------------------------------------

The scope (method or struct) at the cursor is always presented in the **status bar**.

.. figure:: ../../images/edt-get_started-scope.png
	:align: center

	Current Scope in Status Bar


Locate the Matching Bracket
---------------------------

Position the cursor after the bracket and press :kbd:`Ctrl+Shift+P` to jump to the pair bracket.

**Double click** after the bracket to highlight the code section up/down to the matching bracket. 

.. figure:: ../../images/edt-get_started-brackets-selection.png
	:align: center


Fold Code Regions in Order to Improve Readability
-------------------------------------------------

.. |expand-icon| image:: ../../../../../common/images/generic_icons/expand_tree.png
    :class: inline

.. |collapse-icon| image:: ../../../../../common/images/generic_icons/collapse_tree.png
    :class: inline

Use the :guilabel:`Expand All` |expand-icon| button or the :guilabel:`Collapse All` |collapse-icon| button from the toolbar or from right click menu :menuselection:`Source --> Folding` to unfold/fold the current file.

.. figure:: ../../images/edt-get_started-brackets-expand.png
	:align: center


Load in Specman
---------------

Quick Launch
~~~~~~~~~~~~

Right click on a file in Navigator (usually top or test) and from menu :guilabel:`Run As` choose :guilabel:`Load in Specman`.

.. figure:: ../../images/edt-concepts-run_configurations-load_in_Specman.png
	:align: center


Explore Output
~~~~~~~~~~~~~~

The invocation output is dumped to the :guilabel:`Console View`.

Click on **hyperlinks** in the :guilabel:`Console View` to jump directly to the to source location. 

.. figure:: ../../images/edt-console-hyperlinks.png
	:align: center
