06 Feb 2021 00:47:00 UTC
- Distribution: SourceCode-LineCounter-Perl
- Module version: 1.022
- Source (raw)
- Browse (raw)
- How to Contribute
- Testers (777 / 0 / 2)
- KwaliteeBus factor: 1
- 98.26% Coverage
- License: artistic_2
- Perl: v5.10.0
- Activity24 month
- Download (11.74KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version
SourceCode::LineCounter::Perl - Count lines in Perl source code
use SourceCode::LineCounter::Perl; my $counter = SourceCode::LineCounter::Perl->new; $counter->count( $file ); my $total_lines = $counter->total; my $pod_lines = $counter->documentation; my $code_lines = $counter->code; my $comment_lines = $counter->comment; my $comment_lines = $counter->blank;
This module counts the lines in Perl source code and tries to classify them as code lines, documentation lines, and blank lines.
Read a line
If it's a blank line, record it and move on to the next line
If it is the start of pod, mark that we are in pod, and count it as a pod line and move on
If we are in pod and the line is blank, record it as a blank line and a pod line, and move on.
If we are ending pod (with
=cut, record it as a pod line and move on.
If we are in pod and it is not blank, record it as a pod line and move on.
If we are not in pod, guess if the line has a comment. If the line has a comment, record it.
Removing comments, see if there is anything left. If there is, record it as a code line.
Move on to the next line.
Reset everything the object counted so you can use the same object with another file.
- accumulate( [ BOOLEAN ] )
With no argument, returns the current setting as true or false.
With one argument, sets the value for accumulation. If that's true, the counter will add to the count from previous calls to
counter. If false,
counterstarts fresh each time.
- count( FILE )
Counts the lines in FILE. The optional second argument, if true, adds those counts to the counts from the last run. By default, previous results are cleared.
Returns the total number of lines in the file
Returns the total number of Pod lines in the file, including and blank lines in Pod.
Add to the documentation line counter if the line is documentation.
Returns the number of non-blank lines, whether documentation or code.
- add_to_code( LINE )
Add to the code line counter if the line is a code line.
The number of lines with comments. These are the things that start with #. That might be lines that are all comments or code lines that have comments.
Add to the comment line counter if the line has a comment. A line might be counted as both code and comments.
The number of blank lines. By default, these are lines that match the regex qr/^\s*$/. You can change this in
new()by specifying the
Add to the blank line counter if the line is blank.
Generalized LineCounter that can dispatch to language delegates.
This source is in Github
brian d foy,
Copyright © 2008-2021, brian d foy <email@example.com>. All rights reserved.
You may redistribute this under the terms of the Artistic License 2.0.
Module Install Instructions
To install SourceCode::LineCounter::Perl, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install SourceCode::LineCounter::Perl
For more information on module installation, please visit the detailed CPAN module installation guide.