<h2>Editing File: /usr/share/autoconf/Autom4te/C4che.pm</h2><form method='post'><textarea name='content' class='file-edit'># autoconf -- create `configure' using m4 macros
# Copyright (C) 2003, 2006, 2009-2012 Free Software Foundation, Inc.

# This program 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 3 of the License, or
# (at your option) any later version.
#
# This program 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
# along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.

package Autom4te::C4che;

=head1 NAME

Autom4te::C4che - a single m4 run request

=head1 SYNOPSIS

  use Autom4te::C4che;

=head1 DESCRIPTION

This Perl module handles the cache of M4 runs used by autom4te.

=cut

use Data::Dumper;
use Autom4te::Request;
use Carp;
use strict;

=over 4

=item @request

List of requests.

We cannot declare it &quot;my&quot; as the loading, performed via &quot;do&quot;, would
refer to another scope, and @request would not be updated.  It used to
work with &quot;my&quot; vars, and I do not know whether the current behavior
(5.6) is wanted or not.

=cut

use vars qw(@request);

=item C&lt;$req = Autom4te::C4che-E&lt;gt&gt;retrieve (%attr)&gt;

Find a request with the same path and input.

=cut

sub retrieve($%)
{
  my ($self, %attr) = @_;

  foreach (@request)
    {
      # Same path.
      next
	if join (&quot;\n&quot;, @{$_-&gt;path}) ne join (&quot;\n&quot;, @{$attr{path}});

      # Same inputs.
      next
	if join (&quot;\n&quot;, @{$_-&gt;input}) ne join (&quot;\n&quot;, @{$attr{input}});

      # Found it.
      return $_;
    }

  return undef;
}

=item C&lt;$req = Autom4te::C4che-E&lt;gt&gt;register (%attr)&gt;

Create and register a request for these path and input.

=cut

# $REQUEST-OBJ
# register ($SELF, %ATTR)
# -----------------------
# NEW should not be called directly.
# Private.
sub register ($%)
{
  my ($self, %attr) = @_;

  # path and input are the only ID for a request object.
  my $obj = new Autom4te::Request ('path'  =&gt; $attr{path},
				   'input' =&gt; $attr{input});
  push @request, $obj;

  # Assign an id for cache file.
  $obj-&gt;id (&quot;$#request&quot;);

  return $obj;
}


=item C&lt;$req = Autom4te::C4che-E&lt;gt&gt;request (%request)&gt;

Get (retrieve or create) a request for the path C&lt;$request{path}&gt; and
the input C&lt;$request{input}&gt;.

=cut

# $REQUEST-OBJ
# request($SELF, %REQUEST)
# ------------------------
sub request ($%)
{
  my ($self, %request) = @_;

  my $req =
    Autom4te::C4che-&gt;retrieve (%request)
    || Autom4te::C4che-&gt;register (%request);

  # If there are new traces to produce, then we are not valid.
  foreach (@{$request{'macro'}})
    {
      if (! exists ${$req-&gt;macro}{$_})
	{
	  ${$req-&gt;macro}{$_} = 1;
	  $req-&gt;valid (0);
	}
    }

  # It would be great to have $REQ check that it is up to date wrt
  # its dependencies, but that requires getting traces (to fetch the
  # included files), which is out of the scope of Request (currently?).

  return $req;
}


=item C&lt;$string = Autom4te::C4che-E&lt;gt&gt;marshall ()&gt;

Serialize all the current requests.

=cut


# marshall($SELF)
# ---------------
sub marshall ($)
{
  my ($caller) = @_;
  my $res = '';

  my $marshall = Data::Dumper-&gt;new ([\@request], [qw (*request)]);
  $marshall-&gt;Indent(2)-&gt;Terse(0);
  $res = $marshall-&gt;Dump . &quot;\n&quot;;

  return $res;
}


=item C&lt;Autom4te::C4che-E&lt;gt&gt;save ($file)&gt;

Save the cache in the C&lt;$file&gt; file object.

=cut

# SAVE ($FILE)
# ------------
sub save ($$)
{
  my ($self, $file) = @_;

  confess &quot;cannot save a single request\n&quot;
    if ref ($self);

  $file-&gt;seek (0, 0);
  $file-&gt;truncate (0);
  print $file
    &quot;# This file was generated.\n&quot;,
    &quot;# It contains the lists of macros which have been traced.\n&quot;,
    &quot;# It can be safely removed.\n&quot;,
    &quot;\n&quot;,
    $self-&gt;marshall;
}


=item C&lt;Autom4te::C4che-E&lt;gt&gt;load ($file)&gt;

Load the cache from the C&lt;$file&gt; file object.

=cut

# LOAD ($FILE)
# ------------
sub load ($$)
{
  my ($self, $file) = @_;
  my $fname = $file-&gt;name;

  confess &quot;cannot load a single request\n&quot;
    if ref ($self);

  my $contents = join &quot;&quot;, $file-&gt;getlines;

  eval $contents;

  confess &quot;cannot eval $fname: $@\n&quot; if $@;
}


=head1 SEE ALSO

L&lt;Autom4te::Request&gt;

=head1 HISTORY

Written by Akim Demaille E&lt;lt&gt;F&lt;akim@freefriends.org&gt;E&lt;gt&gt;.

=cut

1; # for require

### Setup &quot;GNU&quot; style for perl-mode and cperl-mode.
## Local Variables:
## perl-indent-level: 2
## perl-continued-statement-offset: 2
## perl-continued-brace-offset: 0
## perl-brace-offset: 0
## perl-brace-imaginary-offset: 0
## perl-label-offset: -2
## cperl-indent-level: 2
## cperl-brace-offset: 0
## cperl-continued-brace-offset: 0
## cperl-label-offset: -2
## cperl-extra-newline-before-brace: t
## cperl-merge-trailing-else: nil
## cperl-continued-statement-offset: 2
## End:
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Fshare%2Fautoconf%2FAutom4te'>Back to Directory</a>