-----------------------------------------------
---------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--          O C A R I N A . E N T I T I E S . P R O P E R T I E S           --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--               Copyright (C) 2004-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 provides functions to create or read property names,
--  types, constants and associations.

with Types;
with Ocarina.AADL_Values;

package Ocarina.Entities.Properties is

   type property_type is
     (pt_boolean,
      pt_boolean_expression,
      pt_integer,
      pt_unsigned_integer,
      pt_float,
      pt_unsigned_float,
      pt_string,
      pt_enumeration,
      pt_reference,
      pt_classifier,
      pt_range,
      pt_list,
      pt_other);

   type property_owner_category is
     (poc_component_category,
      poc_mode,
      poc_port_group,
      poc_flow,

      poc_port,
      poc_event_port,
      poc_data_port,
      poc_event_data_port,

      poc_server_subprogram,

      poc_parameter,

      poc_connections,
      poc_port_group_connections,
      poc_port_connections,
      poc_event_port_connections,
      poc_data_port_connections,
      poc_event_data_port_connections,

      poc_access_connections,

      poc_parameter_connections);

   type referable_element_category is
     (rec_component_category, rec_connections, rec_server_subprogram);

   --
   --  Interrogation functions
   --

   function Value_Of_Property_Association_Is_Undefined
     (Property : Types.node_id) return Boolean;

   function Type_Of_Property_Is_A_List
     (Property : Types.node_id) return Boolean;

   function Get_Type_Of_Property
     (Property             : Types.node_id;
      Use_Evaluated_Values : Boolean := True) return property_type;

   function Get_Type_Of_Property_Value
     (Property_Value       : Types.node_id;
      Use_Evaluated_Values : Boolean := True) return property_type;

   function Get_Integer_Of_Property_Value
     (Property_Value : Types.node_id) return Types.unsigned_long_long;

   function Get_Float_Of_Property_Value
     (Property_Value : Types.node_id) return Long_Long_Float;

   function Get_String_Of_Property_Value
     (Property_Value : Types.node_id) return Types.name_id;

   function Get_String_Of_Property_Value
     (Property_Value : Types.node_id) return String;

   function Get_Enumeration_Of_Property_Value
     (Property_Value : Types.node_id) return Types.name_id;

   function Get_Enumeration_Of_Property_Value
     (Property_Value : Types.node_id) return String;

   function Get_Boolean_Of_Property_Value
     (Property_Value : Types.node_id) return Boolean;

   function Get_Classifier_Of_Property_Value
     (Property_Value : Types.node_id) return Types.node_id;

   function Get_Reference_Of_Property_Value
     (Property_Value : Types.node_id) return Types.node_id;

   function Get_Value_Of_Property_Association
     (Property : Types.node_id) return Ocarina.AADL_Values.value_type;

   function Find_Property_Association_From_Name
     (Property_List : Types.list_id;
      Property_Name : Types.name_id) return Types.node_id;

   function Find_Property_Association_From_Name
     (Property_List : Types.list_id;
      Property_Name : String) return Types.node_id;

end Ocarina.Entities.Properties;