1 # autoconf -- create 'configure' using m4 macros
2 # Copyright (C) 2003, 2006, 2009-2017, 2020-2023 Free Software
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <https://www.gnu.org/licenses/>.
18 package Autom4te
::C4che
;
22 Autom4te::C4che - a single m4 run request
30 This Perl module handles the cache of M4 runs used by autom4te.
36 use warnings FATAL
=> 'all';
41 use Autom4te
::Request
;
49 Must be a package global so it can be accessed by code evaluated via
56 =item C<$req = Autom4te::C4che-E<gt>retrieve (%attr)>
58 Find a request with the same path and input.
64 my ($self, %attr) = @_;
70 if join ("\n", @
{$_->path}) ne join ("\n", @
{$attr{path
}});
74 if join ("\n", @
{$_->input}) ne join ("\n", @
{$attr{input
}});
83 =item C<$req = Autom4te::C4che-E<gt>register (%attr)>
85 Create and register a request for these path and input.
90 # register ($SELF, %ATTR)
91 # -----------------------
92 # NEW should not be called directly.
96 my ($self, %attr) = @_;
98 # path and input are the only ID for a request object.
99 my $obj = new Autom4te
::Request
('path' => $attr{path
},
100 'input' => $attr{input
});
103 # Assign an id for cache file.
104 $obj->id ("$#request");
110 =item C<$req = Autom4te::C4che-E<gt>request (%request)>
112 Get (retrieve or create) a request for the path C<$request{path}> and
113 the input C<$request{input}>.
118 # request($SELF, %REQUEST)
119 # ------------------------
122 my ($self, %request) = @_;
125 Autom4te
::C4che
->retrieve (%request)
126 || Autom4te
::C4che
->register (%request);
128 # If there are new traces to produce, then we are not valid.
129 foreach (@
{$request{'macro'}})
131 if (! exists ${$req->macro}{$_})
133 ${$req->macro}{$_} = 1;
138 # It would be great to have $REQ check that it is up to date wrt
139 # its dependencies, but that requires getting traces (to fetch the
140 # included files), which is out of the scope of Request (currently?).
146 =item C<$string = Autom4te::C4che-E<gt>marshall ()>
148 Serialize all the current requests.
160 my $marshall = Data
::Dumper
->new ([\
@request], [qw
(*request
)]);
161 $marshall->Indent(2)->Terse(0)->Sortkeys(1);
162 $res = $marshall->Dump . "\n";
168 =item C<Autom4te::C4che-E<gt>save ($file, $version)>
170 Save the cache in the C<$file> file object.
174 # SAVE ($FILE, $VERSION)
175 # ----------------------
178 my ($self, $file, $version) = @_;
180 confess
"cannot save a single request\n"
186 "# This file was generated by Autom4te $version.\n",
187 "# It contains the lists of macros which have been traced.\n",
188 "# It can be safely removed.\n",
194 =item C<Autom4te::C4che-E<gt>good_version ($file, $version)>
196 Succeed if the cache from the C<$file> file object is of the given version.
200 # GOOD_VERSION ($FILE, $VERSION)
201 # ------------------------------
202 sub good_version
($$)
204 my ($self, $file, $version) = @_;
205 my ($line) = $file->getline;
206 return defined ($line) && $line eq "# This file was generated by Autom4te $version.\n";
209 =item C<Autom4te::C4che-E<gt>load ($file)>
211 Load the cache from the C<$file> file object.
219 my ($self, $file) = @_;
220 my $fname = $file->name;
222 confess
"cannot load a single request\n"
225 my $contents = join "", $file->getlines;
229 confess
"cannot eval $fname: $@\n" if $@
;
239 Written by Akim Demaille E<lt>F<akim@freefriends.org>E<gt>.
245 ### Setup "GNU" style for perl-mode and cperl-mode.
247 ## perl-indent-level: 2
248 ## perl-continued-statement-offset: 2
249 ## perl-continued-brace-offset: 0
250 ## perl-brace-offset: 0
251 ## perl-brace-imaginary-offset: 0
252 ## perl-label-offset: -2
253 ## cperl-indent-level: 2
254 ## cperl-brace-offset: 0
255 ## cperl-continued-brace-offset: 0
256 ## cperl-label-offset: -2
257 ## cperl-extra-newline-before-brace: t
258 ## cperl-merge-trailing-else: nil
259 ## cperl-continued-statement-offset: 2