/****************************************************************************
 *                                                                          *
 *                         GNAT COMPILER COMPONENTS                         *
 *                                                                          *
 *                                A T R E E                                 *
 *                                                                          *
 *                              C Header File                               *
 *                                                                          *
 *          Copyright (C) 1992-2021, Free Software Foundation, Inc.         *
 *                                                                          *
 * GNAT is free software;  you can  redistribute it  and/or modify it 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.  GNAT is distributed in the hope that it will be useful, but WITH- *
 * OUT 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 GNAT; see file COPYING3.  If not, go to *
 * http://www.gnu.org/licenses for a complete copy of the license.          *
 *                                                                          *
 * GNAT was originally developed  by the GNAT team at  New York University. *
 * Extensive contributions were provided by Ada Core Technologies Inc.      *
 *                                                                          *
 ****************************************************************************/

/* This is the C header that corresponds to the Ada package specification for
   Atree.  It also contains the implementation of inlined functions from the
   package body for Atree.  It was created manually from atree.ads and
   atree.adb and must be kept synchronized with changes in these files.

   Note that only routines for reading the tree are included, since the tree
   transformer is not supposed to modify the tree in any way.  */

#ifdef __cplusplus
extern "C" {
#endif

#define Parent atree__parent
extern Node_Id Parent (Node_Id);

#define Original_Node atree__original_node
extern Node_Id Original_Node (Node_Id);

/* Type used for union of Node_Id, List_Id, Elist_Id.  */
typedef Int Tree_Id;

/* These two functions can only be used for Node_Id and List_Id values and
   they work in the C version because Empty = No_List = 0.  */

INLINE Boolean No (Tree_Id);
INLINE Boolean Present (Tree_Id);

INLINE Boolean
No (Tree_Id N)
{
  return N == Empty;
}

INLINE Boolean
Present (Tree_Id N)
{
  return !No (N);
}

#define Current_Error_Node atree__current_error_node
extern Node_Id Current_Error_Node;

/* The following code corresponds to the Get_n_Bit_Field functions (for
   various n) in package Atree.  The low-level getters in sinfo.h call
   these even-lower-level getters.  */

extern Field_Offset *Node_Offsets_Ptr;
extern any_slot *Slots_Ptr;

INLINE unsigned int Get_1_Bit_Field (Node_Id, Field_Offset);
INLINE unsigned int Get_2_Bit_Field (Node_Id, Field_Offset);
INLINE unsigned int Get_4_Bit_Field (Node_Id, Field_Offset);
INLINE unsigned int Get_8_Bit_Field (Node_Id, Field_Offset);
INLINE unsigned int Get_32_Bit_Field (Node_Id, Field_Offset);
INLINE unsigned int Get_32_Bit_Field_With_Default (Node_Id, Field_Offset,
						   unsigned int);
INLINE unsigned int Get_Valid_32_Bit_Field (Node_Id, Field_Offset);

INLINE unsigned int
Get_1_Bit_Field (Node_Id N, Field_Offset Offset)
{
  const Field_Offset L = Slot_Size / 1;
  any_slot slot = *(Slots_Ptr + Node_Offsets_Ptr[N] + Offset / L);
  return (slot >> (Offset % L) * (Slot_Size / L)) & 1;
}

INLINE unsigned int
Get_2_Bit_Field (Node_Id N, Field_Offset Offset)
{
  const Field_Offset L = Slot_Size / 2;
  any_slot slot = *(Slots_Ptr + Node_Offsets_Ptr[N] + Offset / L);
  return (slot >> (Offset % L) * (Slot_Size / L)) & 3;
}

INLINE unsigned int
Get_4_Bit_Field (Node_Id N, Field_Offset Offset)
{
  const Field_Offset L = Slot_Size / 4;
  any_slot slot = *(Slots_Ptr + Node_Offsets_Ptr[N] + Offset / L);
  return (slot >> (Offset % L) * (Slot_Size / L)) & 15;
}

INLINE unsigned int
Get_8_Bit_Field (Node_Id N, Field_Offset Offset)
{
  const Field_Offset L = Slot_Size / 8;
  any_slot slot = *(Slots_Ptr + Node_Offsets_Ptr[N] + Offset / L);
  return (slot >> (Offset % L) * (Slot_Size / L)) & 255;
}

INLINE unsigned int
Get_32_Bit_Field (Node_Id N, Field_Offset Offset)
{
  any_slot slot = *(Slots_Ptr + Node_Offsets_Ptr[N] + Offset);
  return slot;
}

INLINE unsigned int
Get_32_Bit_Field_With_Default (Node_Id N, Field_Offset Offset,
			       unsigned int Default_Value)
{
  any_slot slot = *(Slots_Ptr + Node_Offsets_Ptr[N] + Offset);
  return slot == Empty ? Default_Value : slot;
}

INLINE unsigned int
Get_Valid_32_Bit_Field (Node_Id N, Field_Offset Offset)
{
  any_slot slot = *(Slots_Ptr + Node_Offsets_Ptr[N] + Offset);
  gcc_assert (slot != Empty);
  return slot;
}

#ifdef __cplusplus
}
#endif