The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

PERLANCAR / Text-Head-0.001 / lib / Text / Head.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
—
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

              
package Text::Head;
our $DATE = '2016-04-01'; # DATE
our $VERSION = '0.001'; # VERSION
use 5.010001;
use strict;
use warnings;
use Exporter::Rinci qw(import);
our %SPEC;
# TODO: accept filehandle in addition to string
# TODO: mode characters/bytes
# TODO: record separator option
# TODO: accept negative number (-N), which means all but last N lines of file
$SPEC{head_text} = {
    v => 1.1,
    summary => 'Output the first part of text',
    args => {
        text => {
            schema => 'str*',
            req => 1,
        },
        lines => {
            schema => 'int*',
            default => 10,
        },
        hint => {
            schema => 'bool',
        },
    },
    result_naked => 1,
    examples => [
        {
            args => {text=>"line 1\nline 2\nline 3\nline 4\n", lines=>2},
            result => "line 1\nline 2\n",
        }
    ],
};
sub head_text {
    my %args = @_;
    my $lines = $args{lines} // 10;
    my @lines = split /^/, $args{text};
    if ($lines >= @lines) {
        return $args{text};
    } else {
        my $remaining = @lines - $lines;
        my $res = join("", @lines[0..$lines-1]);
        if ($args{hint}) {
            $res .= "\n" unless $res =~ /\R\z/;
            $res .= "(... $remaining more line(s) not shown ...)\n";
        }
        return $res;
    }
}
1;
# ABSTRACT: Output the first part of text
__END__
=pod
=encoding UTF-8
=head1 NAME
Text::Head - Output the first part of text
=head1 VERSION
This document describes version 0.001 of Text::Head (from Perl distribution Text-Head), released on 2016-04-01.
=head1 FUNCTIONS
=head2 head_text(%args) -> any
Output the first part of text.
Examples:
=over
=item * Example #1:
 head_text(lines => 2, text => "line 1\nline 2\nline 3\nline 4\n"); # -> "line 1\nline 2\n"
=back
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
=over 4
=item * B<hint> => I<bool>
=item * B<lines> => I<int> (default: 10)
=item * B<text>* => I<str>
=back
Return value:  (any)
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Text-Head>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Text-Head>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Text-Head>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 SEE ALSO
The L<head> Unix command.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2016 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut