-----------------------------------------
---------------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--    O C A R I N A . E X P A N D E R . C O M P O N E N T S . M O D E S     --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--                 Copyright (C) 2007, GET-Telecom Paris.                   --
--                                                                          --
-- Ocarina  is free software;  you  can  redistribute  it and/or  modify    --
-- it under terms of the GNU General Public License as published by the     --
-- Free Software Foundation; either version 2, or (at your option) any      --
-- later version. 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. See the GNU General --
-- Public License for more details. You should have received  a copy of the --
-- GNU General Public License distributed with Ocarina; see file COPYING.   --
-- If not, write to the Free Software Foundation, 51 Franklin Street, Fifth --
-- Floor, Boston, MA 02111-1301, USA.                                       --
--                                                                          --
-- As a special exception,  if other files  instantiate  generics from this --
-- unit, or you link  this unit with other files  to produce an executable, --
-- this  unit  does not  by itself cause  the resulting  executable to be   --
-- covered  by the  GNU  General  Public  License. This exception does not  --
-- however invalidate  any other reasons why the executable file might be   --
-- covered by the GNU Public License.                                       --
--                                                                          --
--                 Ocarina is maintained by the Ocarina team                --
--                       (ocarina-users@listes.enst.fr)                     --
--                                                                          --
------------------------------------------------------------------------------

--  This package contains all the necessary routines to instantiate
--  AADL component modes.

package Ocarina.Expander.Components.Modes is

   function Expand_Mode
     (Instance_Root      : node_id;
      Component_Instance : node_id;
      Mode               : node_id) return node_id;
   --  Create a new mode instance correspodning to the mode
   --  declaration 'Mode' of the corresponding component of
   --  'Component_Instance'.

   function Expand_Mode_Transition
     (Instance_Root      : node_id;
      Component_Instance : node_id;
      Mode_Transition    : node_id) return node_id;
   --  Same as above but for mode transitions

   procedure Expand_In_Modes
     (Component_Instance : node_id;
      Subclause_Instance : node_id);
   --  Resolve the "in modes" clause of the declaration correspoding
   --  to Subclause_Instance basing on the Component_Instance mode
   --  instances. Do nothing if the declaration corresponding to
   --  Subclause_Instance is mode independant.

   procedure Expand_In_Modes
     (Component_Instance : node_id;
      Subclause_List     : list_id);
   --  If Subclause_List is not empty, invoke Expand_In_Modes on each
   --  element of the list. otherwise, do nothing.

end Ocarina.Expander.Components.Modes;