Package: Util.Environment

Description

Copyright © 2001, 2002 by Thomas Wolf.
This piece of software is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. This software 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 with this distribution, see file "GPL.txt". If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
As a special exception from the GPL, 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 GPL. This exception does not however invalidate any other reasons why the executable file might be covered by the GPL.

Version: 1.1

Author:
Thomas Wolf (TW) <twolf AT acm DOT org>
Purpose:
Operations on environment variables.
Tasking Semantics
Fully task- and abortion-safe.
Storage Semantics
No dynamic storage allocation.

Header

package Util.Environment is

 
pragma Elaborate_Body;

Known child units

Util.Environment.Bash(package)
Util.Environment.Windows(package)

Exceptions

Not_Defined

Type Summary

Expander (abstract limited type)
Primitive Operations:  Get
String_Expander (abstract type) derived from Expander
New Operations:  Expand
Inherited Operations:  Get

Other Items:

function Get (Name : in String) return String;
Raises Not_Defined if the environment variable Name is not defined. Returns an empty string if the environment variable is so defined.

Note: it is entirely implementation-defined whether or not environment variable names are case sensitive. 

function Safe_Get
  (Name : in String)
  return String;
As Get, but return an empty string if the variable is not defined. Never raises Not_Defined. 
type Expander is abstract tagged limited private;
function Get
  (Self : access Expander;
   Name : in     String)
  return String;
Default calls Safe_Get above. 
type String_Expander is abstract new Expander with private;
function Expand
  (Self   : access String_Expander;
   Source : in     String)
  return String
  is abstract;
Replaces all references to environment variables in Source by that variable's definition and returns the resulting string. It is undefined what happens with syntactically invalid references or references to variables that are not defined. 
private

   --  Implementation-defined ...

end Util.Environment;
Generated on 2002-12-01 at 14:23:17 by AdaBrowse 3.2 using configuration files util.cfg, common.cfg.