gcc/ada/nmake.adt

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                                N M A K E                                 --
   6 --                                                                          --
   7 --                             T e m p l a t e                              --
   8 --                                                                          --
   9 --                            $Revision: 1.12 $                             --
  10 --                                                                          --
  11 --          Copyright (C) 1992-2001 Free Software Foundation, Inc.          --
  12 --                                                                          --
  13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- GNAT was originally developed  by the GNAT team at  New York University. --
  25 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  26 --                                                                          --
  27 ------------------------------------------------------------------------------
  28
  29 pragma Style_Checks (All_Checks);
  30 --  Turn off subprogram order checking, since the routines here are
  31 --  generated automatically in order.
  32
  33 --  This file is a template used as input to the utility program XNmake,
  34 --  which reads this template, and the spec of Sinfo (sinfo.ads) and
  35 --  generates the body and/or the spec for the Nmake package (files
  36 --  nmake.ads and nmake.adb)
  37
  38 with Atree;  use Atree;       --  body only
  39 with Nlists; use Nlists;      --  spec only
  40 with Sinfo;  use Sinfo;       --  body only
  41 with Snames; use Snames;      --  body only
  42 with Stand;  use Stand;       --  body only
  43 with Types;  use Types;       --  spec only
  44 with Uintp;  use Uintp;       --  spec only
  45 with Urealp; use Urealp;      --  spec only
  46
  47 package Nmake is
  48
  49 --  This package contains a set of routines used to construct tree nodes
  50 --  using a functional style. There is one routine for each node type defined
  51 --  in Sinfo with the general interface:
  52
  53 --    function Make_xxx (Sloc : Source_Ptr,
  54 --                       Field_Name_1 : Field_Name_1_Type [:= default]
  55 --                       Field_Name_2 : Field_Name_2_Type [:= default]
  56 --                       ...)
  57 --    return Node_Id
  58
  59 --  Only syntactic fields are included (i.e. fields marked as "-Sem" or "-Lib"
  60 --  in the Sinfo spec are excluded). In addition, the following four syntactic
  61 --  fields are excluded:
  62
  63 --    Prev_Ids
  64 --    More_Ids
  65 --    Comes_From_Source
  66 --    Paren_Count
  67
  68 --  since they are very rarely set in expanded code. If they need to be set,
  69 --  to other than the default values (False, False, False, zero), then the
  70 --  appropriate Set_xxx procedures must be used on the returned value.
  71
  72 --  Default values are provided only for flag fields (where the default is
  73 --  False), and for optional fields. An optional field is one where the
  74 --  comment line describing the field contains the string "(set to xxx if".
  75 --  For such fields, a default value of xxx is provided."
  76
  77 --  Warning: since calls to Make_xxx routines are normal function calls, the
  78 --  arguments can be evaluated in any order. This means that at most one such
  79 --  argument can have side effects (e.g. be a call to a parse routine).
  80
  81 !!TEMPLATE INSERTION POINT
  82
  83 end Nmake;