#!/usr/bin/env perl

# Full POD documentation may be found below.
# Sample program by Graham Ellis / Well House Consultants

if ($#ARGV != 0) {
        die "Usage: $0 sourcefilename\n";
        }
if (! -r $ARGV[0] or ! -f $ARGV[0]) {
        die "Error 106 - File $ARGV[0] is not plain and readable\n";
        }

## Set queue
@inqueue = @ARGV;
@outqueue = ();

## while queue not empty
while (@inqueue) {

        ## read file
        $file = shift(@inqueue);
        unless (open (FH,$file)) {
                warn "# Warning 107 - Cannot read $file\n";
                next;
                }
        my @modulecontent = <FH>;
        $loaded{$file} = 1;
        close FH;

        ## handle and add to queue any new module needs
        foreach $addn(@modulecontent) {
                if (($modwant) = $addn =~ /^\s*use\s+(\w+)/) {
                        unless ($already{$modwant}) {
                                push @inqueue,"$modwant.pm";
                                $already{$modwant} = 1;
                        }
                }
        }

        ## push source to start of output
        push @modulecontent,"\n\n########## Source code from $file ###########\n\n";
        unshift @outqueue,\@modulecontent;

        }

## display results

foreach $sblock (@outqueue) {
        foreach $line (@$sblock) {
                if (($modcalled) = $line =~ /^\s*use\s+(\w+)/) {
                        if ($loaded{"$modcalled.pm"}) {
                                $line = "##inc: ".$line;
                        }
                }
        print $line;
        }
}

__END__

=head1 Source Code Combiner

This program was written as a demonstration for a
customer who required to combine a whole series of
source files into a single output file for distribution,
with a file named on the command line being included
at the END of the output file and any files called
up internally included above it.

The program must run recursively (i.e. there can be
includes within includes).

For the purpose of this demonstration, I have used
Perl source code and Perl's use 'function' to provide
me with test data - thus allowing me to demonstrate
the comining of multiple Perl sources into a single
source file. In this use, please note:

a) use calls that call up code from directories other
that the current directory will NOT be expanded as the
code called is probably "system" uses - but a warning
is issued.

b) Imports from a module via the use xxxx(yyyy) syntax
are NOT supported.

c) Include statements which are correctly actioned are
commented out of the resultant file to render the code
as close to a working combined application as practical
as it can be in such a short demo.

d) Output is to STDOUT which the user may redirect to
a file. Fatal errors and warnings to STDERR; warnings
are preceeed by a # character to ensure they would be
treated as comments IF the appliaction is uses in such
a way that they get included in the output file!

=cut