-----------------------------------------------------------
---------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--              O C A R I N A . B U I L D E R . A N N E X E S               --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--               Copyright (C) 2005-2006, 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 provides functions to build annex nodes into the AADL
--  tree.

with Types;
with Locations;

package Ocarina.Builder.Annexes is

   function Set_Annex_Content
     (Annex : Types.Node_Id;
      Text  : Types.Name_Id)
      return  Boolean;
   --  Set the text of the annex. Annex is the Node_Id of the annex
   --  library or subclause, returned by Add_New_Annex_Subclause or
   --  Add_New_Annex_Library. Text is the Name_Id referencing the text
   --  of the annex. Return True is everything went right, else False.

   function Add_New_Annex_Subclause
     (Loc        : Locations.Location;
      Annex_Name : Types.Node_Id;
      Namespace  : Types.Node_Id)
      return       Types.Node_Id;
   --  Create a new annex subclause. An annex subclause can be
   --  inserted into a component declaration (type or implementation)
   --  or a port group declaration. Loc is the location of the annex
   --  in the parsed text. Annex_Name is the name of the annex
   --  subclause. Namespace is the component or the port group where
   --  the annex must be inserted. This functions returns the Node_Id
   --  of the newly created annex subclause node, or No_Node if
   --  something went wrong.

   function Add_New_Annex_Library
     (Loc        : Locations.Location;
      Annex_Name : Types.Node_Id;
      Namespace  : Types.Node_Id;
      Is_Private : Boolean := False)
      return       Types.Node_Id;
   --  Create a new annex library. An annex library can be inserted
   --  into a package or the top level AADL specification (i.e. the
   --  unnamed namespace). Loc is the location of the annex in the
   --  parsed text. Annex_Name is the name of the annex
   --  library. Namespace is the package specification or the top
   --  level AADL specification where the annex must be inserted. This
   --  functions returns the Node_Id of the newly created annex
   --  library node, or No_Node if something went wrong.

end Ocarina.Builder.Annexes;