.. _developing_with_eclipse:

=================================
Developing Sunflower With Eclipse
=================================

Assuming that you have followed the documentation for :ref:`configure_eclipse`, this
page will provide an overview of the general workflow for developing Sunflower
Studio within the Eclipse IDE.


--------------------------------
Launching Sunflower from Eclipse
--------------------------------

Presumably you will need to both launch and debug Sunflower Studio from within
the Eclipse IDE. Follow these steps to get Sunflower Studio launched.

1. Locate the ``*.product`` file in *Project Explorer* that defines the specific
   Sunflower Studio product you wish to launch.  In this example we will locate
   the **Sunflower Studio CE** product file, named ``sunflower-studio-ce.product``
   within the **com.sri.sunflower.distrib.core** project.

    .. figure:: ./figs/Sunflower_Product_File.png
       :width: 600
       :alt: Eclipse IDE "Project Explorer" opened to sunflower-studio-ce.product

       Locate the Sunflower Studio ``*.product`` file.

2. Double click to open the product file. This will open the Product editor. On the first
   tab, locate the **Testing** section.

   .. figure:: ./figs/Sunflower_Studio_CE_Product_File.png
      :width: 600
      :alt: Sunflower Studio CE Product file open with "Testing" section highlighted

      Open the product file and locate the **Testing** section on the first tab

3. Within the **Testing** section click the *Synchronize* link.

    .. figure:: ./figs/Product_Synchronize.png
       :width: 600
       :alt: Testing section with arrow pointing at "Synchronize" link

       In the **Testing** section click the *Synchronize* link.

4. After the product has completed synchronizing the workspace. You can choose to
   launch Sunflower or launch Sunflower in Debug mode.  In Debug mode, you can
   set breakpoints within the Sunflower source code to inspect the application
   while it is running. Click *Launch an Eclipse application* to run Sunflower
   normally, or click *Launch an Eclipse application in Debug mode* to run
   Sunflower in debug mode.

   .. figure:: ./figs/Product_launch.png
      :width: 600
      :alt: Testing section with "Launch an Eclipse application" and "Launch an Eclipse application in Debug mode" highlighted.

      Click *Launch an Eclipse application* to run Sunflower normally, or click
      *Launch an Eclipse application in Debug mode* to run Sunflower in debug mode.

5. Sunflower Studio should launch. If you launched in Debug mode and have breakpoints
   set, the application will pause and focus the Eclipse IDE on the debugger and
   breakpoint.