count_lines_of_code.pl

#!/usr/bin/env perl

# File name: count_lines_of_code.pl
# Perl script to count lines of code written in Perl, PHP or HTML
# By Joel Rader  info[at]joelrader[dot]net

=pod

=head1 NAME

	count_lines_of_code.pl - Perl script to count lines of code written in Perl, PHP or HTML
        The script counts lines of code, comments, blank lines and POD ( Plain Old Documentation )	
	The script summarizes the lines of code for all Perl, PHP or HTML files in a directory and all sub directories
	
=head1 SYNOPSIS
	
	$ ./count_lines_of_code.pl --type=(Perl||PHP||HTML)

	# For example, to count all Perl files	
	$ ./count_lines_of_code.pl --type=Perl
	
	# For example, to count all PHP files 
	$ ./count_lines_of_code.pl --type=PHP
		
	# For example, to count all HTML files 
	$ ./count_lines_of_code.pl --type=HTML
	
=head1 AUTHOR

	Joel Rader <https://joelrader.net>

=cut

use warnings;
use strict;
use diagnostics;

my $command;
my $filetype= "";

$filetype = $ARGV[0];

if (!$filetype) { usage(); }

if (($filetype ne "--type=PHP") && ($filetype ne "--type=Perl") && ($filetype ne "--type=HTML")) { usage(); }

my $sumTotal;
my $sumBlock;
my $sumComments;
my $sumBlank;
my $sumLines;

if ( $filetype =~ m/Perl/ ) { $command = "find . -name \"*.pl\" | sort"; }
if ( $filetype =~ m/PHP/ ) { $command = "find . -name \"*.php\" | sort"; }
if ( $filetype =~ m/HTML/ ) { $command = "find . -name \"*.*htm*\" | sort"; }

my @files = `$command`;

my $exist = $filetype;

$exist =~ s/--type=//;

if (!@files) {print "No files of type $exist in this directory.\n"; exit; }

our $file;

foreach $file ( @files ) { 

	if (!$filetype) {
		$filetype = "";
	}

	if (!$file) {
		$file = "";
	}

	if (($filetype eq "") || ($file eq "")) {
  		usage();
	}

	if (($filetype ne "--type=PHP") && ($filetype ne "--type=Perl") && ($filetype ne "--type=HTML"))  {
  		usage(); 
	} 

	if ($filetype eq "--type=PHP") { 
  		php_count(); 
	}

	if ($filetype eq "--type=Perl") { 
  		perl_count(); 
	}
	
	if ($filetype eq "--type=HTML") { 
  		html_count(); 
	}


}







# Subroutine for script usage
sub usage {
	print "Script Usage: \$ ./count_lines_of_code.pl --type=(PHP|Perl|HTML) \n";
        print "Example: \$ ./count_lines_of_code.pl --type=Perl\n";
	print "Example: \$ ./count_lines_of_code.pl --type=PHP\n";
        print "Example: \$ ./count_lines_of_code.pl --type=HTML\n";
	exit;
}








# Subroutine for Perl script line count
sub perl_count {

	if ($file !~ m/(\.pl)/) {	
		print "Script --type flag was set for counting Perl file lines of code. \nThe file should end in .pl for a Perl script\n";
		exit
	}
	
	open FILE, $file or die "Could not open file! $!";
 	
	my $count = my $slurp_lines = my $block = my $number_of_comment_lines = my $pod_line = my $total = my $blank = 0;
	my @comment_lines;

	while (<FILE>) {
		$total++;	
		$slurp_lines .= $_;

                if ($slurp_lines =~ m/(=\S+[\s\S]*?\=cut\n)/) {
                        @comment_lines = split(/\n/,$1);
			foreach $pod_line (@comment_lines) {
				if ($pod_line =~ m/\S+/){ $block++; }	
			}
			$slurp_lines = "";
		}

		 
		if (($_ =~ m/^\s*$/) || (($_ =~ m/^\s*#/) && ($_ !~ m/\#\!\/usr/))) {
			if ($_ =~ m/^\s*#/){$number_of_comment_lines++;}
			if ($_ =~ /^\s*$/){$blank++;}
			next;
                }
		
		$count++;
        }
	
	close(FILE);

        my $lines = $count - $block;
	
	$file =~ s/\.\///;

print "Lines of Code for $file";	
print
"  Total:    $total
  POD:      $block
  Comments: $number_of_comment_lines
  Blank:    $blank
  Code:     $lines\n";

 $sumTotal += $total;
 $sumBlock += $block;
 $sumComments += $number_of_comment_lines;
 $sumBlank += $blank;
 $sumLines += $lines;

}







# Subroutine for PHP script line count
sub php_count {
	if ($file !~ m/(\.php)/) {
		print "Script --type flag was set for counting PHP file lines of code.\nThe file should end in .php for a PHP script\n";
		exit;
	}

	open FILE, $file or die "Could not open file! $!";

	my $count = my $slurp_lines = my $block = my $total = my $blank = my $number_of_comment_lines = my $pod_line = 0;
	my @comment_lines;

	while (<FILE>) {
		$total++;
		$slurp_lines .= $_;

		if ($slurp_lines =~ m/(\/\*[\s\S]*?\*\/)/) {
			@comment_lines = split(/\n/,$1);
			
                        foreach $pod_line (@comment_lines) {
			        if ($pod_line =~ m/\S+/){ $block++; }
			}
                        $slurp_lines = "";
		}

		if (($_ =~ m/^\s*$/) || ($_ =~ m/\/\//) || ($_ =~ m/^\s*#/)) {
			if($_ =~ m/^\s*$/){$blank++;}
			if (($_ =~ m/\/\//) || ($_ =~ m/^\s*#/)) {
				$number_of_comment_lines++;	
			} 
			next; 
		} 
	
		$count++;
	}
	
	close(FILE);
	
	$number_of_comment_lines += $block;
	my $lines = $count - $block;
	
	$file =~ s/\.\///;

	print "Lines of Code for $file";

print 
" Total:    $total
 Comments: $number_of_comment_lines
 Blank:    $blank
 Code:     $lines\n";



 $sumTotal += $total;
 $sumComments += $number_of_comment_lines;
 $sumBlank += $blank;
 $sumLines += $lines;



} 










# Subroutine for HTML file line count
sub html_count {
	if ($file !~ m/(\.*htm*)/) {
		print "Script --type flag was set for counting HTML file lines of code.\nThe file should end in .html, .htm or .shtml \n";
		exit;
	}

	open FILE, $file or die "Could not open file! $!";

	my $count = my $slurp_lines = my $total = my $blank = my $number_of_comment_lines = my $comment = 0;
	my @comment_lines;
	my $comment_number;

	while (<FILE>) {
		
		$total++;
		$slurp_lines .= $_;	
		
		if ($_ =~ m/^\s*$/){ $blank++; next; }
		$count++;

	}	
	
	while ( $slurp_lines =~ /(<!--(?!-?>).*?--\s*>)/sg ) {

    		$comment = $1;

    		@comment_lines = split /\n/, $comment;

    		$number_of_comment_lines += @comment_lines;
			
	}

	  my $lines = $count - $number_of_comment_lines;

	close(FILE);
	
	$file =~ s/\.\///;

	print "Lines of Code for $file";

print 
" Total:    $total
 Comments: $number_of_comment_lines
 Blank:    $blank
 Code:     $lines\n";



 $sumTotal += $total;
 $sumComments += $number_of_comment_lines;
 $sumBlank += $blank;
 $sumLines += $lines;



	
} 


if ( $filetype eq "--type=PHP") {
	print "~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
	print "Summary for all PHP files: \n";
	print "~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
	print 
 " Total:    $sumTotal
 Comments: $sumComments
 Blank:    $sumBlank
 Code:     $sumLines\n";

}


if ( $filetype eq "--type=Perl") {
	print "~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
	print "Summary for all Perl files: \n";
	print "~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
	print 
 " Total:     $sumTotal
 POD:       $sumBlock 
 Comments:  $sumComments
 Blank:     $sumBlank
 Code:      $sumLines\n";

}


if ( $filetype eq "--type=HTML") {

	print "~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
	print "Summary for all HTML files: \n";
	print "~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
print	
 " Total:    $sumTotal
 Comments: $sumComments
 Blank:    $sumBlank
 Code:     $sumLines\n";

}