Ada Programming/Libraries/Ada.Text_IO.Editing

From Wikibooks, open books for an open world
Jump to navigation Jump to search
Ada. Time-tested, safe and secure.
Ada. Time-tested, safe and secure.

This language feature is available from Ada 95 on.

Ada.Text_IO.Editing is a unit of the Predefined Language Environment since Ada 95.

This package is used for the generation and printing of strings from numbers representing amounts in some currency. The inclusion of a currency can be simply avoided by passing "" as parameter.

Example[edit | edit source]

Example representing the use of Ada.Text_IO.Editing. 
with Ada.Text_IO.Editing;

procedure Example_Euros is

   type Euro_Price_Type is delta 0.01 digits 6;

   package Euros_IO is new Ada.Text_IO.Editing.Decimal_Output
     (Num                => Euro_Price_Type,
      Default_Currency   => "EUR ",
      Default_Fill       => ' ',
      Default_Separator  => ',',
      Default_Radix_Mark => '.');

   A_Price : constant Euro_Price_Type := 5873.26;
begin

   Ada.Text_IO.Put_Line ("Price with cents: ");

   --  We generate a string image and print it using Text_IO
   Ada.Text_IO.Put_Line
     (Euros_IO.Image
        (Item => A_Price,
         Pic  => Ada.Text_IO.Editing.To_Picture
           ("#_###_###_##9.99")));

   Ada.Text_IO.Put_Line ("Integer price: ");

   --  Let's use now the Put procedure from Euros_IO
   Euros_IO.Put
     (Item => A_Price,
      Pic  => Ada.Text_IO.Editing.To_Picture
        ("#_###_###_##9"));

end Example_Euros;

Code: 

Price with cents:
    EUR 5,873.26
Integer price: 
    EUR 5,873

Specification[edit | edit source]

--                     Standard Ada library specification
--   Copyright (c) 2003-2018 Maxim Reznik <reznikmm@gmail.com>
--   Copyright (c) 2004-2016 AXE Consultants
--   Copyright (c) 2004, 2005, 2006 Ada-Europe
--   Copyright (c) 2000 The MITRE Corporation, Inc.
--   Copyright (c) 1992, 1993, 1994, 1995 Intermetrics, Inc.
--   SPDX-License-Identifier: BSD-3-Clause and LicenseRef-AdaReferenceManual
-- -------------------------------------------------------------------------

package Ada.Text_IO.Editing is

   type Picture is private;

   function Valid (Pic_String      : in String;
                   Blank_When_Zero : in Boolean := False) return Boolean;

   function To_Picture (Pic_String      : in String;
                        Blank_When_Zero : in Boolean := False)
                       return Picture;

   function Pic_String      (Pic : in Picture) return String;
   function Blank_When_Zero (Pic : in Picture) return Boolean;

   Max_Picture_Length  : constant := implementation_defined;

   Picture_Error       : exception;

   Default_Currency    : constant String    := "$";
   Default_Fill        : constant Character := '*';
   Default_Separator   : constant Character := ',';
   Default_Radix_Mark  : constant Character := '.';

   generic
      type Num is delta <> digits <>;

      Default_Currency   : in String    := Text_IO.Editing.Default_Currency;
      Default_Fill       : in Character := Text_IO.Editing.Default_Fill;
      Default_Separator  : in Character := Text_IO.Editing.Default_Separator;
      Default_Radix_Mark : in Character := Text_IO.Editing.Default_Radix_Mark;
   package Decimal_Output is
      function Length (Pic      : in Picture;
                       Currency : in String := Default_Currency)
                      return Natural;

      function Valid (Item     : in Num;
                      Pic      : in Picture;
                      Currency : in String := Default_Currency)
                     return Boolean;

      function Image (Item       : in Num;
                      Pic        : in Picture;
                      Currency   : in String    := Default_Currency;
                      Fill       : in Character := Default_Fill;
                      Separator  : in Character := Default_Separator;
                      Radix_Mark : in Character := Default_Radix_Mark)
                     return String;

      procedure Put (File       : in File_Type;
                     Item       : in Num;
                     Pic        : in Picture;
                     Currency   : in String    := Default_Currency;
                     Fill       : in Character := Default_Fill;
                     Separator  : in Character := Default_Separator;
                     Radix_Mark : in Character := Default_Radix_Mark);

      procedure Put (Item       : in Num;
                     Pic        : in Picture;
                     Currency   : in String    := Default_Currency;
                     Fill       : in Character := Default_Fill;
                     Separator  : in Character := Default_Separator;
                     Radix_Mark : in Character := Default_Radix_Mark);

      procedure Put (To         : out String;
                     Item       : in Num;
                     Pic        : in Picture;
                     Currency   : in String    := Default_Currency;
                     Fill       : in Character := Default_Fill;
                     Separator  : in Character := Default_Separator;
                     Radix_Mark : in Character := Default_Radix_Mark);
   end Decimal_Output;

private
   pragma Import (Ada, Picture);
end Ada.Text_IO.Editing;

See also[edit | edit source]

Wikibook[edit | edit source]

Ada Style Guide[edit | edit source]

External examples[edit source]

Ada Reference Manual[edit | edit source]

Ada 95[edit | edit source]

Ada 2005[edit | edit source]

Ada 2012[edit | edit source]

Open-Source Implementations[edit | edit source]

FSF GNAT

drake

Retrieved from "https://en.wikibooks.org/w/index.php?title=Ada_Programming/Libraries/Ada.Text_IO.Editing&oldid=4387452"