======================
Blocks-world PDDL Narrative
======================

Getting started
===============

The framework is released as JAR file to be used on a Desktop platform, therefore it can be easily imported and used in any Narrative project.

The framework needs `ANTLR4 <https://www.antlr.org>`_ library for its operation. You can download the JAR and include directly in your project or you can use Gradle or Maven.

Using EmbASP
============

In the following, we describe an actual usage of the framework by means of a running example;
as a use case, we will develop a simple Desktop application to solve the blocks-world problem.

The complete code of this example is freely available `here <https://www.mat.unical.it/calimeri/projects/embasp/files/EmbASP_Desktop_BlocksWorld_Narrative.zip>`_.

.. image:: ../_image/blocks-world.svg
   :align: center

We will make use of the annotation-guided mapping, in order to retrieve the actions constituting a PDDL plan via Narrative objects.

To this purpose, the following classes are intended to represent possible actions that a blocks-world solution plan can feature:

.. code-block:: narrative

  @Id("pick-up")
  public class PickUp {

    @Param(0)
    private String block;

    [...]
  }

.. code-block:: narrative

  @Id("put-down")
  public class PutDown {

    @Param(0)
    private String block;

    [...]
  }

.. code-block:: narrative

  @Id("stack")
  public class Stack {

    @Param(0)
    private String block1;

    @Param(1)
    private String block2;
       
    [...]
  }

.. code-block:: narrative

  @Id("unstack")
  public class Unstack {

    @Param(0)
    private String block1;

    @Param(1)
    private String block2;
        
    [...]
  }
            

At this point, supposing that we are given two files defining the blocks-world domain and a problem instance, we can start deploying our application:

.. code-block:: narrative

  public class Blocksworld {
        
    private static String domainFileName = "domain.pddl";
    private static String problemFileName = "p01.pddl";;

    public static void main(String[] args) {
      Handler handler = new DesktopHandler(new SPDDesktopService());
            
      final InputProgram inputProgramDomain = new PDDLInputProgram(PDDLProgramType.DOMAIN);
      inputProgramDomain.addFilesPath(domainFileName);

      final InputProgram inputProgramProblem = new PDDLInputProgram(PDDLProgramType.PROBLEM);
      inputProgramProblem.addFilesPath(problemFileName);

      handler.addProgram(inputProgramDomain);
      handler.addProgram(inputProgramProblem);

      try {

        PDDLMapper.getInstance().registerClass(PickUp.class);
        PDDLMapper.getInstance().registerClass(PutDown.class);
        PDDLMapper.getInstance().registerClass(Stack.class);
        PDDLMapper.getInstance().registerClass(Unstack.class);

        Plan plan = (Plan)(handler.startSync());
                
        for (final Object obj : plan.getActionsObjects())
          if (obj instanceof PickUp || obj instanceof Stack || obj instanceof Unstack || obj instanceof PutDown) 
            System.out.println(obj.toString());
                        
      } catch (Exception e) {
        e.printStackTrace();
      }
    }
  }


The class contains an |Handler|_ instance as field, that is initialized with a |DesktopHandler|_ using the required parameter |SPDDesktopService|_.

Then it's set-up the input to the solver; since PDDL requires separate definitions for domain and problem, two |PDDLInputProgram|_ are created and then given to the handler.

The next lines inform the |PDDLMapper|_ about what classes are intended to map the output actions.

Finally the solver is invoked, and the output is retrieved.

The output actions can be managed accordingly to the user's desiderata. 

|

For further information, contact `embasp@mat.unical.it <embasp@mat.unical.it>`_ or visit our `website <https://www.mat.unical.it/calimeri/projects/embasp/>`_.

.. |Handler| replace:: ``Handler``
.. |DesktopHandler| replace:: ``DesktopHandler``
.. |SPDDesktopService| replace:: ``SPDDesktopService``
.. |PDDLInputProgram| replace:: ``PDDLInputProgram``
.. |PDDLMapper| replace:: ``PDDLMapper``

.. _Handler: ../_static/doxygen/narrative/classit_1_1unical_1_1mat_1_1embasp_1_1base_1_1Handler.html
.. _DesktopHandler: ../_static/doxygen/narrative/classit_1_1unical_1_1mat_1_1embasp_1_1platforms_1_1desktop_1_1DesktopHandler.html
.. _SPDDesktopService: ../_static/doxygen/narrative/classit_1_1unical_1_1mat_1_1embasp_1_1platforms_1_1desktop_1_1DesktopService.html
.. _PDDLInputProgram: ../_static/doxygen/narrative/classit_1_1unical_1_1mat_1_1embasp_1_1languages_1_1pddl_1_1PDDLInputProgram.html
.. _PDDLMapper: ../_static/doxygen/narrative/classit_1_1unical_1_1mat_1_1embasp_1_1languages_1_1pddl_1_1PDDLMapper.html