------------------------------------------------------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--                     O C A R I N A . B A C K E N D S                      --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--    Copyright (C) 2008-2009 Telecom ParisTech, 2010-2020 ESA & ISAE.      --
--                                                                          --
-- Ocarina  is free software; you can redistribute it and/or modify under   --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion. Ocarina is distributed in the hope that it will be useful, but     --
-- WITHOUT ANY WARRANTY; without even the implied warranty of               --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     --
--                                                                          --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception,   --
-- version 3.1, as published by the Free Software Foundation.               --
--                                                                          --
-- You should have received a copy of the GNU General Public License and    --
-- a copy of the GCC Runtime Library Exception along with this program;     --
-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
-- <http://www.gnu.org/licenses/>.                                          --
--                                                                          --
--                 Ocarina is maintained by the TASTE project               --
--                      (taste-users@lists.tuxfamily.org)                   --
--                                                                          --
------------------------------------------------------------------------------

--  This package is the root of all the source code generators of
--  Ocarina. It provides routines to register and select a code
--  generators. All the code generators should be implemented as child
--  packages of Ocarina.Backends. All the calls to these generators
--  have to be done through the procedure Generate exported by this
--  package. After selecting the wanted code generator.

with Ocarina.Types; use Ocarina.Types;

package Ocarina.Backends is

   type Backend_Subprogram is access procedure (Instance : Node_Id);
   --  Each code generator has to define such a subprogram. Instance
   --  is the root of the AADL instance tree from which the user wants
   --  to generate the code.

   type Backend_Kind is
     (Invalid_Backend,
      AADL,
      AADL_Min,
      AADL_Annex,
      SpaceStudio,
      AADLXML,
      ASN1_Deployment,
      Behavior_PP,
      Bound_T,
      Cheddar_XML,
      Deos_XML,
      Vxworks653_XML,
      Connection_Matrix_Analysis,
      Functions_Matrix_Analysis,
      Lnt_S,
      MAST_Scheduling,
      Petri_Nets,
      PolyORB_HI_Ada,
      PolyORB_HI_C,
      PolyORB_Kernel_C,
      Statistics,
      Subprograms_Generator,
      Xtratum_Configuration,
      REAL_PP,
      REAL_Theorem,
      FT_Replication,
      Alloy_Backend,
      AIR_Configuration_Backend
     );
   --  Supported code generators. For each kind, at most one generator
   --  must be implemented.

   procedure Register_Backend
     (Name    : String;
      Process : Backend_Subprogram;
      Kind    : Backend_Kind);
   --  Register a new backend.

   function Get_Current_Backend_Kind return Backend_Kind;
   procedure Set_Current_Backend_Name (Name : String);
   function Get_Current_Backend_Name return Name_Id;

   procedure Generate_Code (Root : Node_Id; Backend_Name : Name_Id := No_Name);
   --  Call the backend name if it is set or the current backend name
   --  set in the command line. If the backend name and the current
   --  backend name are set, backend name has the priority.

   function Get_Backend (Backend_Name : Name_Id := No_Name) return Natural;
   --  Return the index of the backend corresponding to the given
   --  name. 0 means no backend was found.

   procedure Init;
   --  Initialize the Backends module by registering the several
   --  implemented code generators.

   procedure Reset;
   --  Resets the Backends module by resetting the node entries of
   --  the several trees.

   procedure Write_Backends (Indent : Natural);
   --  Displays the list of registered generators each one on a new
   --  line indented by 'Indent'.

   Generated_Sources_Directory : Name_Id := No_Name;
   --  Generated code will be in this directory

   Scenario_Dir : String_Ptr;
   --  Path to scenario directory, required to get source path to user code

   SCM_Version : String_Ptr;

   Compile_Generated_Sources : aliased Boolean := False;
   Remove_Generated_Sources  : aliased Boolean := False;
   Do_Coverage_Test          : aliased Boolean := False;
   Do_Regression_Test        : aliased Boolean := False;
   Generate_ASN1_Deployment  : aliased Boolean := False;
   Add_Performance_Analysis  : aliased Boolean := False;

end Ocarina.Backends;