gcc/ada/s-trafor-default.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                 GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS                 --
   4 --                                                                          --
   5 --                  S Y S T E M . T R A C E S . F O R M A T                 --
   6 --                                                                          --
   7 --                                  S p e c                                 --
   8 --                                                                          --
   9 --           Copyright (C) 2001-2005 Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- GNARL is free software; you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  14 -- sion. GNARL is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNARL; see file COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  This package implements functions to format run-time traces
  35
  36 package System.Traces.Format is
  37    pragma Preelaborate;
  38
  39    Max_Size : constant Integer := 128;
  40    --  Event messages' maximum size.
  41
  42    subtype String_Trace is String (1 .. Max_Size);
  43    --  Specific type in which trace information is stored. An ASCII.NUL
  44    --  character ends the string so that it is compatible with C strings
  45    --  which is useful on some targets (eg. VxWorks)
  46
  47    --  These private functions handles String_Trace formatting
  48
  49    function Format_Trace (Source : String) return String_Trace;
  50    --  Put a String in a String_Trace, truncates the string if necessary.
  51    --  Similar to Head( .. ) found in Ada.Strings.Bounded
  52
  53    function Append
  54      (Source : String_Trace;
  55       Annex  : String)
  56       return   String_Trace;
  57    pragma Inline (Append);
  58    --  Concatenates two string, similar to & operator from Ada.String.Unbounded
  59
  60    procedure Send_Trace (Id : Trace_T; Info : String);
  61    --  This function (which is a subunit) send messages to external programs
  62
  63 end System.Traces.Format;