.. _f-treegraphlistener:

module ``languages.tree_graph_listener``
========================================





.. inheritance-diagram:: pyensae.languages.tree_graph_listener


Short summary
+++++++++++++

module ``pyensae.languages.tree_graph_listener``

Helpers around language grammar.
This module requires `antlr4 <https://pypi.python.org/pypi/antlr4-python3-runtime/>`_.


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| class                                                                                | truncated documentation                                                       |
+======================================================================================+===============================================================================+
| :class:`TreeGraphListener <pyensae.languages.tree_graph_listener.TreeGraphListener>` | This class is an attempt to run through the tree and to convert into a graph. |
+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+






Properties
++++++++++

+-------------------------------------------------------------------------------------+-------------------------+
| property                                                                            | truncated documentation |
+=====================================================================================+=========================+
| :meth:`Edges <pyensae.languages.tree_graph_listener.TreeGraphListener.Edges>`       | return edges            |
+-------------------------------------------------------------------------------------+-------------------------+
| :meth:`Vertices <pyensae.languages.tree_graph_listener.TreeGraphListener.Vertices>` | return vertices         |
+-------------------------------------------------------------------------------------+-------------------------+






Methods
+++++++

+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| method                                                                                                 | truncated documentation                    |
+========================================================================================================+============================================+
| :py:meth:`__init__ <pyensae.languages.tree_graph_listener.TreeGraphListener.__init__>`                 | constructor                                |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :py:meth:`_get_key_context <pyensae.languages.tree_graph_listener.TreeGraphListener._get_key_context>` |                                            |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :py:meth:`_get_key_node <pyensae.languages.tree_graph_listener.TreeGraphListener._get_key_node>`       |                                            |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`draw <pyensae.languages.tree_graph_listener.TreeGraphListener.draw>`                            | draw the graph with networkx on matplotlib |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`enterEveryRule <pyensae.languages.tree_graph_listener.TreeGraphListener.enterEveryRule>`        | event                                      |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`exitEveryRule <pyensae.languages.tree_graph_listener.TreeGraphListener.exitEveryRule>`          | event                                      |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`to_dot <pyensae.languages.tree_graph_listener.TreeGraphListener.to_dot>`                        | export the graph to DOT format             |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`to_networkx <pyensae.languages.tree_graph_listener.TreeGraphListener.to_networkx>`              | convert the graph into networkx            |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`visitErrorNode <pyensae.languages.tree_graph_listener.TreeGraphListener.visitErrorNode>`        | event                                      |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`visitTerminal <pyensae.languages.tree_graph_listener.TreeGraphListener.visitTerminal>`          | event                                      |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyensae.languages.tree_graph_listener
    :members:
    :special-members: __init__
    :show-inheritance: