scripts/Dpkg/BuildEnv.pm

   1 # Copyright © 2012 Guillem Jover <guillem@debian.org>
   2 #
   3 # This program is free software; you can redistribute it and/or modify
   4 # it under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation; either version 2 of the License, or
   6 # (at your option) any later version.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  15
  16 =encoding utf8
  17
  18 =head1 NAME
  19
  20 Dpkg::BuildEnv - track build environment
  21
  22 =head1 DESCRIPTION
  23
  24 The Dpkg::BuildEnv module is used by dpkg-buildflags to track the build
  25 environment variables being used and modified.
  26
  27 B<Note>: This is a private module, its API can change at any time.
  28
  29 =cut
  30
  31 package Dpkg::BuildEnv 0.01;
  32
  33 use strict;
  34 use warnings;
  35
  36 my %env_modified = ();
  37 my %env_accessed = ();
  38
  39 =head1 FUNCTIONS
  40
  41 =over 4
  42
  43 =item set($varname, $value)
  44
  45 Update the build environment variable $varname with value $value. Record
  46 it as being accessed and modified.
  47
  48 =cut
  49
  50 sub set {
  51     my ($varname, $value) = @_;
  52     $env_modified{$varname} = 1;
  53     $env_accessed{$varname} = 1;
  54     $ENV{$varname} = $value;
  55 }
  56
  57 =item get($varname)
  58
  59 Get the build environment variable $varname value. Record it as being
  60 accessed.
  61
  62 =cut
  63
  64 sub get {
  65     my $varname = shift;
  66     $env_accessed{$varname} = 1;
  67     return $ENV{$varname};
  68 }
  69
  70 =item has($varname)
  71
  72 Return a boolean indicating whether the environment variable exists.
  73 Record it as being accessed.
  74
  75 =cut
  76
  77 sub has {
  78     my $varname = shift;
  79     $env_accessed{$varname} = 1;
  80     return exists $ENV{$varname};
  81 }
  82
  83 =item @list = list_accessed()
  84
  85 Returns a list of all environment variables that have been accessed.
  86
  87 =cut
  88
  89 sub list_accessed {
  90     my @list = sort keys %env_accessed;
  91     return @list;
  92 }
  93
  94 =item @list = list_modified()
  95
  96 Returns a list of all environment variables that have been modified.
  97
  98 =cut
  99
 100 sub list_modified {
 101     my @list = sort keys %env_modified;
 102     return @list;
 103 }
 104
 105 =back
 106
 107 =head1 CHANGES
 108
 109 =head2 Version 0.xx
 110
 111 This is a private module.
 112
 113 =cut
 114
 115 1;