-
Notifications
You must be signed in to change notification settings - Fork 95
/
Ack.pm
424 lines (313 loc) · 10.9 KB
/
Ack.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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
package App::Ack;
use warnings;
use strict;
=head1 NAME
App::Ack - A container for functions for the ack program
=head1 VERSION
Version 1.63_01
=cut
our $VERSION;
BEGIN {
$VERSION = '1.63_01';
}
our %types;
our %mappings;
our @ignore_dirs;
our %ignore_dirs;
our $path_sep;
our $is_cygwin;
BEGIN {
@ignore_dirs = qw( blib CVS RCS SCCS .svn _darcs .git );
%ignore_dirs = map { ($_,1) } @ignore_dirs;
%mappings = (
asm => [qw( s S )],
binary => q{Binary files, as defined by Perl's -B op (default: off)},
cc => [qw( c h xs )],
cpp => [qw( cpp m h C H )],
csharp => [qw( cs )],
css => [qw( css )],
elisp => [qw( el )],
haskell => [qw( hs lhs )],
html => [qw( htm html shtml )],
skipped => q{Files, but not directories, normally skipped by ack (default: off)},
lisp => [qw( lisp )],
java => [qw( java properties )],
js => [qw( js )],
jsp => [qw( jsp jspx jhtm jhtml )],
make => q{Makefiles},
mason => [qw( mas mhtml mpl mtxt )],
ocaml => [qw( ml mli )],
parrot => [qw( pir pasm pmc ops pod pg tg )],
perl => [qw( pl pm pod t )],
php => [qw( php phpt php3 php4 php5 )],
python => [qw( py )],
ruby => [qw( rb rhtml rjs rxml )],
scheme => [qw( scm )],
shell => [qw( sh bash csh ksh zsh )],
sql => [qw( sql ctl )],
tcl => [qw( tcl )],
tex => [qw( tex cls sty )],
text => q{Text files, as defined by Perl's -T op (default: off)},
tt => [qw( tt tt2 ttml )],
vb => [qw( bas cls frm ctl vb resx )],
vim => [qw( vim )],
yaml => [qw( yaml yml )],
xml => [qw( xml dtd xslt )],
);
use File::Spec ();
$path_sep = File::Spec->catfile( '', '' );
$path_sep = quotemeta( $path_sep );
while ( my ($type,$exts) = each %mappings ) {
if ( ref $exts ) {
for my $ext ( @{$exts} ) {
push( @{$types{$ext}}, $type );
}
}
}
$is_cygwin = ($^O eq 'cygwin');
}
=head1 SYNOPSIS
If you want to know about the F<ack> program
No user-serviceable parts inside. F<ack> is all that should use this.
=head1 FUNCTIONS
=head2 skipdir_filter
Standard filter to pass as a L<File::Next> descend_filter. It
returns true if the directory is any of the ones we know we want
to skip.
=cut
sub skipdir_filter {
return !exists $ignore_dirs{$_};
}
=head2 filetypes( $filename )
Returns a list of types that I<$filename> could be. For example, a file
F<foo.pod> could be "perl" or "parrot".
The filetype will be C<undef> if we can't determine it. This could
be if the file doesn't exist, or it can't be read.
It will be 'skipped' if it's something that ack should always ignore,
even under -a.
=cut
use constant TEXT => 'text';
sub filetypes {
my $filename = shift;
return 'skipped' unless is_searchable( $filename );
return ('make',TEXT) if $filename =~ m{$path_sep?Makefile$}io;
# If there's an extension, look it up
if ( $filename =~ m{\.([^\.$path_sep]+)$}o ) {
my $ref = $types{lc $1};
return (@{$ref},TEXT) if $ref;
}
# At this point, we can't tell from just the name. Now we have to
# open it and look inside.
return unless -e $filename;
# From Elliot Shank:
# I can't see any reason that -r would fail on these-- the ACLs look
# fine, and no program has any of them open, so the busted Windows
# file locking model isn't getting in there. If I comment the if
# statement out, everything works fine
# So, for cygwin, don't bother trying to check for readability.
if ( !$is_cygwin ) {
if ( !-r $filename ) {
App::Ack::warn( "$filename: Permission denied" );
return;
}
}
return 'binary' if -B $filename;
# If there's no extension, or we don't recognize it, check the shebang line
my $fh;
if ( !open( $fh, '<', $filename ) ) {
App::Ack::warn( "$filename: $!" );
return;
}
my $header = <$fh>;
if ( not close $fh ) {
App::Ack::warn( "$filename: $!" );
return;
}
if ( $header =~ /^#!/ ) {
return ($1,TEXT) if $header =~ /\b(ruby|p(erl|hp|ython))\b/;
return ('shell','text') if $header =~ /\b(?:ba|c|k|z)?sh\b/;
}
return ('xml',TEXT) if $header =~ /<\?xml /;
return (TEXT);
}
=head2 is_searchable( $filename )
Returns true if the filename is one that we can search, and false
if it's one that we should ignore like a coredump or a backup file.
=cut
sub is_searchable {
my $filename = shift;
return if $filename =~ /~$/;
return if $filename =~ m{$path_sep?(?:#.+#|core\.\d+)$}o;
return 1;
}
=head2 options_sanity_check( %opts )
Checks for sane command-line options. For example, I<-l> doesn't
make sense with I<-C>.
=cut
sub options_sanity_check {
my %opts = @_;
my $ok = 1;
# List mode doesn't make sense with any of these
$ok = 0 if _option_conflict( \%opts, 'l', [qw( A B C o group )] );
# XXX This should work, I would think.
$ok = 0 if _option_conflict( \%opts, 'l', [qw( m )] );
# File-searching is definitely irrelevant on these
$ok = 0 if _option_conflict( \%opts, 'f', [qw( A B C o m group )] );
return $ok;
}
sub _option_conflict {
my $opts = shift;
my $used = shift;
my $exclusives = shift;
return if not defined $opts->{$used};
my $bad = 0;
for my $opt ( @{$exclusives} ) {
if ( defined $opts->{$opt} ) {
print 'The ', _opty($opt), ' option cannot be used with the ', _opty($used), " option.\n";
$bad = 1;
}
}
return $bad;
}
sub _opty {
my $opt = shift;
return length($opt)>1 ? "--$opt" : "-$opt";
}
=head2 warn( @_ )
Put out an ack-specific warning.
=cut
sub warn { ## no critic (ProhibitBuiltinHomonyms)
return CORE::warn( _my_program(), ': ', @_, "\n" );
}
=head2 die( @_ )
Die in an ack-specific way.
=cut
sub die { ## no critic (ProhibitBuiltinHomonyms)
return CORE::die( _my_program(), ': ', @_, "\n" );
}
sub _my_program {
require File::Basename;
return File::Basename::basename( $0 );
}
=head2 filetypes_supported()
Returns a list of all the types that we can detect.
=cut
sub filetypes_supported {
return keys %mappings;
}
sub _thpppt {
my $y = q{_ /|,\\'!.x',=(www)=, U };
$y =~ tr/,x!w/\nOo_/;
print "$y ack $_[0]!\n";
exit 0;
}
=head2 show_help()
Dumps the help page to the user.
=cut
sub show_help {
my $help_arg = shift || 0;
return show_help_types() if $help_arg =~ /^types?/;
my $ignore_dirs = _listify( @ignore_dirs );
print <<"END_OF_HELP";
Usage: ack [OPTION]... PATTERN [FILES]
Search for PATTERN in each source file in the tree from cwd on down.
If [FILES] is specified, then only those files/directories are checked.
ack may also search STDIN, but only if no FILES are specified, or if
one of FILES is "-".
Default switches may be specified in ACK_OPTIONS environment variable.
Example: ack -i select
Searching:
-i, --ignore-case Ignore case distinctions
-v, --invert-match Invert match: select non-matching lines
-w, --word-regexp Force PATTERN to match only whole words
-Q, --literal Quote all metacharacters; expr is literal
Search output:
-l, --files-with-matches
Only print filenames containing matches
-L, --files-without-match
Only print filenames with no match
-o Show only the part of a line matching PATTERN
(turns off text highlighting)
--output=expr Output the evaluation of expr for each line
(turns off text highlighting)
-m, --max-count=NUM Stop after NUM matches
-H, --with-filename Print the filename for each match
-h, --no-filename Suppress the prefixing filename on output
-c, --count Show number of lines matching per file
--group Group matches by file name.
(default: on when used interactively)
--nogroup One result per line, including filename, like grep
(default: on when the output is redirected)
--[no]color Highlight the matching text (default: on unless
output is redirected, or on Windows)
Context control:
-B, --before-context=NUM
-A, --after-context=NUM
-C, --context=NUM
Print NUM lines of context before and/or after
matching lines
File finding:
-f Only print the files found, without searching.
The PATTERN must not be specified.
--sort-files Sort the found files lexically.
File inclusion/exclusion:
-n No descending into subdirectories
-a, --all All files, regardless of extension (but still skips
$ignore_dirs dirs)
--perl Include only Perl files.
--type=perl Include only Perl files.
--noperl Exclude Perl files.
--type=noperl Exclude Perl files.
See "ack --help type" for supported filetypes.
--[no]follow Follow symlinks. Default is off.
Miscellaneous:
--help This help
--man Man page
--version Display version & copyright
--thpppt Bill the Cat
END_OF_HELP
return;
}
=head2 show_help_types()
Display the filetypes help subpage.
=cut
sub show_help_types {
print <<'END_OF_HELP';
Usage: ack [OPTION]... PATTERN [FILES]
The following is the list of filetypes supported by ack. You can
specify a file type with the --type=TYPE format, or the --TYPE
format. For example, both --type=perl and --perl work.
Note that some extensions may appear in multiple types. For example,
.pod files are both Perl and Parrot.
END_OF_HELP
my @types = filetypes_supported();
for my $type ( sort @types ) {
next if $type =~ /^-/; # Stuff to not show
my $ext_list = $mappings{$type};
if ( ref $ext_list ) {
$ext_list = join( ' ', map { ".$_" } @{$ext_list} );
}
printf( " --[no]%-9.9s %s\n", $type, $ext_list );
}
return;
}
sub _listify {
my @whats = @_;
return '' if !@whats;
my $end = pop @whats;
return @whats ? join( ', ', @whats ) . " and $end" : $end;
}
=head2 version_statement( $copyright )
Prints the version information for ack.
=cut
sub version_statement {
my $copyright = shift;
print <<"END_OF_VERSION";
ack $App::Ack::VERSION
$copyright
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
END_OF_VERSION
return;
}
1; # End of App::Ack