forked from beyondgrep/ack1
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAck.pm
1635 lines (1272 loc) · 46.1 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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package App::Ack;
use warnings;
use strict;
use File::Next 0.40;
use App::Ack::Plugin::Basic;
=head1 NAME
App::Ack - A container for functions for the ack program
=head1 VERSION
Version 1.94
=cut
our $VERSION;
our $COPYRIGHT;
BEGIN {
$VERSION = '1.96';
$COPYRIGHT = 'Copyright 2005-2011 Andy Lester.';
}
our $fh;
BEGIN {
$fh = *STDOUT;
}
our %types;
our %type_wanted;
our %mappings;
our %ignore_dirs;
our $input_from_pipe;
our $output_to_pipe;
our $dir_sep_chars;
our $is_cygwin;
our $is_windows;
use File::Spec ();
use File::Glob ':glob';
use Getopt::Long ();
BEGIN {
%ignore_dirs = (
'.bzr' => 'Bazaar',
'.cdv' => 'Codeville',
'~.dep' => 'Interface Builder',
'~.dot' => 'Interface Builder',
'~.nib' => 'Interface Builder',
'~.plst' => 'Interface Builder',
'.git' => 'Git',
'.hg' => 'Mercurial',
'.pc' => 'quilt',
'.svn' => 'Subversion',
_MTN => 'Monotone',
blib => 'Perl module building',
CVS => 'CVS',
RCS => 'RCS',
SCCS => 'SCCS',
_darcs => 'darcs',
_sgbak => 'Vault/Fortress',
'autom4te.cache' => 'autoconf',
'cover_db' => 'Devel::Cover',
_build => 'Module::Build',
);
%mappings = (
actionscript => [qw( as mxml )],
ada => [qw( ada adb ads )],
asm => [qw( asm s )],
batch => [qw( bat cmd )],
binary => q{Binary files, as defined by Perl's -B op (default: off)},
cc => [qw( c h xs )],
cfmx => [qw( cfc cfm cfml )],
clojure => [qw( clj )],
cpp => [qw( cpp cc cxx m hpp hh h hxx )],
csharp => [qw( cs )],
css => [qw( css )],
delphi => [qw( pas int dfm nfm dof dpk dproj groupproj bdsgroup bdsproj )],
elisp => [qw( el )],
erlang => [qw( erl hrl )],
fortran => [qw( f f77 f90 f95 f03 for ftn fpp )],
go => [qw( go )],
groovy => [qw( groovy gtmpl gpp grunit )],
haskell => [qw( hs lhs )],
hh => [qw( h )],
html => [qw( htm html shtml xhtml )],
java => [qw( java properties )],
js => [qw( js )],
jsp => [qw( jsp jspx jhtm jhtml )],
lisp => [qw( lisp lsp )],
lua => [qw( lua )],
make => q{Makefiles (including *.mk and *.mak)},
mason => [qw( mas mhtml mpl mtxt )],
objc => [qw( m h )],
objcpp => [qw( mm h )],
ocaml => [qw( ml mli )],
parrot => [qw( pir pasm pmc ops pod pg tg )],
perl => [qw( pl pm pm6 pod t psgi )],
php => [qw( php phpt php3 php4 php5 phtml)],
plone => [qw( pt cpt metadata cpy py )],
python => [qw( py )],
rake => q{Rakefiles},
ruby => [qw( rb rhtml rjs rxml erb rake spec )],
scala => [qw( scala )],
scheme => [qw( scm ss )],
shell => [qw( sh bash csh tcsh ksh zsh )],
skipped => q{Files, but not directories, normally skipped by ack (default: off)},
smalltalk => [qw( st )],
sql => [qw( sql ctl )],
tcl => [qw( tcl itcl itk )],
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 )],
verilog => [qw( v vh sv )],
vhdl => [qw( vhd vhdl )],
vim => [qw( vim )],
yaml => [qw( yaml yml )],
xml => [qw( xml dtd xsl xslt ent )],
);
while ( my ($type,$exts) = each %mappings ) {
if ( ref $exts ) {
for my $ext ( @{$exts} ) {
push( @{$types{$ext}}, $type );
}
}
}
# add manually Makefile extensions
push @{$types{$_}}, 'make' for qw{ mk mak };
# These have to be checked before any filehandle diddling.
$output_to_pipe = not -t *STDOUT;
$input_from_pipe = -p STDIN;
$is_cygwin = ($^O eq 'cygwin');
$is_windows = ($^O =~ /MSWin32/);
$dir_sep_chars = $is_windows ? quotemeta( '\\/' ) : quotemeta( File::Spec->catfile( '', '' ) );
}
=head1 SYNOPSIS
If you want to know about the F<ack> program, see the F<ack> file itself.
No user-serviceable parts inside. F<ack> is all that should use this.
=head1 FUNCTIONS
=head2 read_ackrc
Reads the contents of the .ackrc file and returns the arguments.
=cut
sub read_ackrc {
my @files = ( $ENV{ACKRC} );
my @dirs =
$is_windows
? ( $ENV{HOME}, $ENV{USERPROFILE} )
: ( '~', $ENV{HOME} );
for my $dir ( grep { defined } @dirs ) {
for my $file ( '.ackrc', '_ackrc' ) {
push( @files, bsd_glob( "$dir/$file", GLOB_TILDE ) );
}
}
for my $filename ( @files ) {
if ( defined $filename && -e $filename ) {
open( my $fh, '<', $filename ) or App::Ack::die( "$filename: $!\n" );
my @lines = grep { /./ && !/^\s*#/ } <$fh>;
chomp @lines;
close $fh or App::Ack::die( "$filename: $!\n" );
# get rid of leading and trailing whitespaces
for ( @lines ) {
s/^\s+//;
s/\s+$//;
}
return @lines;
}
}
return;
}
=head2 get_command_line_options()
Gets command-line arguments and does the Ack-specific tweaking.
=cut
sub get_command_line_options {
my %opt = (
pager => $ENV{ACK_PAGER_COLOR} || $ENV{ACK_PAGER},
);
my $getopt_specs = {
1 => sub { $opt{1} = $opt{m} = 1 },
'A|after-context=i' => \$opt{after_context},
'B|before-context=i' => \$opt{before_context},
'C|context:i' => sub { shift; my $val = shift; $opt{before_context} = $opt{after_context} = ($val || 2) },
'a|all-types' => \$opt{all},
'break!' => \$opt{break},
c => \$opt{count},
'color|colour!' => \$opt{color},
'color-match=s' => \$ENV{ACK_COLOR_MATCH},
'color-filename=s' => \$ENV{ACK_COLOR_FILENAME},
'color-lineno=s' => \$ENV{ACK_COLOR_LINENO},
'column!' => \$opt{column},
count => \$opt{count},
'env!' => sub { }, # ignore this option, it is handled beforehand
f => \$opt{f},
flush => \$opt{flush},
'follow!' => \$opt{follow},
'g=s' => sub { shift; $opt{G} = shift; $opt{f} = 1 },
'G=s' => \$opt{G},
'group!' => sub { shift; $opt{heading} = $opt{break} = shift },
'heading!' => \$opt{heading},
'h|no-filename' => \$opt{h},
'H|with-filename' => \$opt{H},
'i|ignore-case' => \$opt{i},
'invert-file-match' => \$opt{invert_file_match},
'lines=s' => sub { shift; my $val = shift; push @{$opt{lines}}, $val },
'l|files-with-matches' => \$opt{l},
'L|files-without-matches' => sub { $opt{l} = $opt{v} = 1 },
'm|max-count=i' => \$opt{m},
'match=s' => \$opt{regex},
'n|no-recurse' => \$opt{n},
o => sub { $opt{output} = '$&' },
'output=s' => \$opt{output},
'pager=s' => \$opt{pager},
'nopager' => sub { $opt{pager} = undef },
'passthru' => \$opt{passthru},
'print0' => \$opt{print0},
'Q|literal' => \$opt{Q},
'r|R|recurse' => sub { $opt{n} = 0 },
'show-types' => \$opt{show_types},
'smart-case!' => \$opt{smart_case},
'sort-files' => \$opt{sort_files},
'u|unrestricted' => \$opt{u},
'v|invert-match' => \$opt{v},
'w|word-regexp' => \$opt{w},
'ignore-dirs=s' => sub { shift; my $dir = remove_dir_sep( shift ); $ignore_dirs{$dir} = '--ignore-dirs' },
'noignore-dirs=s' => sub { shift; my $dir = remove_dir_sep( shift ); delete $ignore_dirs{$dir} },
'version' => sub { print_version_statement(); exit; },
'help|?:s' => sub { shift; show_help(@_); exit; },
'help-types'=> sub { show_help_types(); exit; },
'man' => sub {
require Pod::Usage;
Pod::Usage::pod2usage({
-verbose => 2,
-exitval => 0,
});
},
'type=s' => sub {
# Whatever --type=xxx they specify, set it manually in the hash
my $dummy = shift;
my $type = shift;
my $wanted = ($type =~ s/^no//) ? 0 : 1; # must not be undef later
if ( exists $type_wanted{ $type } ) {
$type_wanted{ $type } = $wanted;
}
else {
App::Ack::die( qq{Unknown --type "$type"} );
}
}, # type sub
};
# Stick any default switches at the beginning, so they can be overridden
# by the command line switches.
unshift @ARGV, split( ' ', $ENV{ACK_OPTIONS} ) if defined $ENV{ACK_OPTIONS};
# first pass through options, looking for type definitions
def_types_from_ARGV();
for my $i ( filetypes_supported() ) {
$getopt_specs->{ "$i!" } = \$type_wanted{ $i };
}
my $parser = Getopt::Long::Parser->new();
$parser->configure( 'bundling', 'no_ignore_case', );
$parser->getoptions( %{$getopt_specs} ) or
App::Ack::die( 'See ack --help, ack --help-types or ack --man for options.' );
my $to_screen = not output_to_pipe();
my %defaults = (
all => 0,
color => $to_screen,
follow => 0,
break => $to_screen,
heading => $to_screen,
before_context => 0,
after_context => 0,
);
if ( $is_windows && $defaults{color} && not $ENV{ACK_PAGER_COLOR} ) {
if ( $ENV{ACK_PAGER} || not eval { require Win32::Console::ANSI } ) {
$defaults{color} = 0;
}
}
if ( $to_screen && $ENV{ACK_PAGER_COLOR} ) {
$defaults{color} = 1;
}
while ( my ($key,$value) = each %defaults ) {
if ( not defined $opt{$key} ) {
$opt{$key} = $value;
}
}
if ( defined $opt{m} && $opt{m} <= 0 ) {
App::Ack::die( '-m must be greater than zero' );
}
for ( qw( before_context after_context ) ) {
if ( defined $opt{$_} && $opt{$_} < 0 ) {
App::Ack::die( "--$_ may not be negative" );
}
}
if ( defined( my $val = $opt{output} ) ) {
$opt{output} = eval qq[ sub { "$val" } ];
}
if ( defined( my $l = $opt{lines} ) ) {
# --line=1 --line=5 is equivalent to --line=1,5
my @lines = split( /,/, join( ',', @{$l} ) );
# --line=1-3 is equivalent to --line=1,2,3
@lines = map {
my @ret;
if ( /-/ ) {
my ($from, $to) = split /-/, $_;
if ( $from > $to ) {
App::Ack::warn( "ignoring --line=$from-$to" );
@ret = ();
}
else {
@ret = ( $from .. $to );
}
}
else {
@ret = ( $_ );
};
@ret
} @lines;
if ( @lines ) {
my %uniq;
@uniq{ @lines } = ();
$opt{lines} = [ sort { $a <=> $b } keys %uniq ]; # numerical sort and each line occurs only once!
}
else {
# happens if there are only ignored --line directives
App::Ack::die( 'All --line options are invalid.' );
}
}
return \%opt;
}
=head2 def_types_from_ARGV
Go through the command line arguments and look for
I<--type-set foo=.foo,.bar> and I<--type-add xml=.rdf>.
Remove them from @ARGV and add them to the supported filetypes,
i.e. into %mappings, etc.
=cut
sub def_types_from_ARGV {
my @typedef;
my $parser = Getopt::Long::Parser->new();
# pass_through => leave unrecognized command line arguments alone
# no_auto_abbrev => otherwise -c is expanded and not left alone
$parser->configure( 'no_ignore_case', 'pass_through', 'no_auto_abbrev' );
$parser->getoptions(
'type-set=s' => sub { shift; push @typedef, ['c', shift] },
'type-add=s' => sub { shift; push @typedef, ['a', shift] },
) or App::Ack::die( 'See ack --help or ack --man for options.' );
for my $td (@typedef) {
my ($type, $ext) = split /=/, $td->[1];
if ( $td->[0] eq 'c' ) {
# type-set
if ( exists $mappings{$type} ) {
# can't redefine types 'make', 'skipped', 'text' and 'binary'
App::Ack::die( qq{--type-set: Builtin type "$type" cannot be changed.} )
if ref $mappings{$type} ne 'ARRAY';
delete_type($type);
}
}
else {
# type-add
# can't append to types 'make', 'skipped', 'text' and 'binary'
App::Ack::die( qq{--type-add: Builtin type "$type" cannot be changed.} )
if exists $mappings{$type} && ref $mappings{$type} ne 'ARRAY';
App::Ack::warn( qq{--type-add: Type "$type" does not exist, creating with "$ext" ...} )
unless exists $mappings{$type};
}
my @exts = split /,/, $ext;
s/^\.// for @exts;
if ( !exists $mappings{$type} || ref($mappings{$type}) eq 'ARRAY' ) {
push @{$mappings{$type}}, @exts;
for my $e ( @exts ) {
push @{$types{$e}}, $type;
}
}
else {
App::Ack::die( qq{Cannot append to type "$type".} );
}
}
return;
}
=head2 delete_type
Removes a type from the internal structures containing type
information: %mappings, %types and %type_wanted.
=cut
sub delete_type {
my $type = shift;
App::Ack::die( qq{Internal error: Cannot delete builtin type "$type".} )
unless ref $mappings{$type} eq 'ARRAY';
delete $mappings{$type};
delete $type_wanted{$type};
for my $ext ( keys %types ) {
$types{$ext} = [ grep { $_ ne $type } @{$types{$ext}} ];
}
}
=head2 ignoredir_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 ignore.
=cut
sub ignoredir_filter {
return !exists $ignore_dirs{$_} && !exists $ignore_dirs{$File::Next::dir};
}
=head2 remove_dir_sep( $path )
This functions removes a trailing path separator, if there is one, from its argument
=cut
sub remove_dir_sep {
my $path = shift;
$path =~ s/[$dir_sep_chars]$//;
return $path;
}
=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 avoid searching,
even under -a.
=cut
use constant TEXT => 'text';
sub filetypes {
my $filename = shift;
my $basename = $filename;
$basename =~ s{.*[$dir_sep_chars]}{};
return 'skipped' unless is_searchable( $basename );
my $lc_basename = lc $basename;
return ('make',TEXT) if $lc_basename eq 'makefile' || $lc_basename eq 'gnumakefile';
return ('rake','ruby',TEXT) if $lc_basename eq 'rakefile';
# If there's an extension, look it up
if ( $filename =~ m{\.([^\.$dir_sep_chars]+)$}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>;
close $fh;
if ( $header =~ /^#!/ ) {
return ($1,TEXT) if $header =~ /\b(ruby|lua|p(?:erl|hp|ython))-?(\d[\d.]*)?\b/;
return ('shell',TEXT) if $header =~ /\b(?:ba|t?c|k|z)?sh\b/;
}
else {
return ('xml',TEXT) if $header =~ /\Q<?xml /i;
}
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 skip like a coredump or a backup file.
Recognized files:
/~$/ - Unix backup files
/#.+#$/ - Emacs swap files
/[._].*\.swp$/ - Vi(m) swap files
/core\.\d+$/ - core dumps
/[.-]min\.js$/ - Minified javascript files
Note that I<$filename> must be just a file, not a full path.
=cut
sub is_searchable {
my $filename = shift;
# If these are updated, update the --help message
return if $filename =~ /[.]bak$/;
return if $filename =~ /~$/;
return if $filename =~ m{^#.*#$}o;
return if $filename =~ m{^core\.\d+$}o;
return if $filename =~ m{[._].*\.swp$}o;
return if $filename =~ /[.-]min\.js$/;
return 1;
}
=head2 build_regex( $str, \%opts )
Returns a regex object based on a string and command-line options.
Dies when the regex $str is undefinied (i.e. not given on command line).
=cut
sub build_regex {
my $str = shift;
my $opt = shift;
defined $str or App::Ack::die( 'No regular expression found.' );
$str = quotemeta( $str ) if $opt->{Q};
if ( $opt->{w} ) {
$str = "\\b$str" if $str =~ /^\w/;
$str = "$str\\b" if $str =~ /\w$/;
}
my $regex_is_lc = $str eq lc $str;
if ( $opt->{i} || ($opt->{smart_case} && $regex_is_lc) ) {
$str = "(?i)$str";
}
return $str;
}
=head2 check_regex( $regex_str )
Checks that the $regex_str can be compiled into a perl regular expression.
Dies with the error message if this is not the case.
No return value.
=cut
sub check_regex {
my $regex = shift;
return unless defined $regex;
eval { qr/$regex/ };
if ($@) {
(my $error = $@) =~ s/ at \S+ line \d+.*//;
chomp($error);
App::Ack::die( "Invalid regex '$regex':\n $error" );
}
return;
}
=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 _get_thpppt {
my $y = q{_ /|,\\'!.x',=(www)=, U };
$y =~ tr/,x!w/\nOo_/;
return $y;
}
sub _thpppt {
my $y = _get_thpppt();
App::Ack::print( "$y ack $_[0]!\n" );
exit 0;
}
sub _key {
my $str = lc shift;
$str =~ s/[^a-z]//g;
return $str;
}
=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( sort { _key($a) cmp _key($b) } keys %ignore_dirs );
App::Ack::print( <<"END_OF_HELP" );
Usage: ack [OPTION]... PATTERN [FILE]
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 FILE are specified, or if
one of FILES is "-".
Default switches may be specified in ACK_OPTIONS environment variable or
an .ackrc file. If you want no dependency on the environment, turn it
off with --noenv.
Example: ack -i select
Searching:
-i, --ignore-case Ignore case distinctions in PATTERN
--[no]smart-case Ignore case distinctions in PATTERN,
only if PATTERN contains no upper case
Ignored if -i is specified
-v, --invert-match Invert match: select non-matching lines
-w, --word-regexp Force PATTERN to match only whole words
-Q, --literal Quote all metacharacters; PATTERN is literal
Search output:
--line=NUM Only print line(s) NUM of each file
-l, --files-with-matches
Only print filenames containing matches
-L, --files-without-matches
Only print filenames with no matches
-o Show only the part of a line matching PATTERN
(turns off text highlighting)
--passthru Print all lines, whether matching or not
--output=expr Output the evaluation of expr for each line
(turns off text highlighting)
--match PATTERN Specify PATTERN explicitly.
-m, --max-count=NUM Stop searching in each file after NUM matches
-1 Stop searching after one match of any kind
-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
--column Show the column number of the first match
-A NUM, --after-context=NUM
Print NUM lines of trailing context after matching
lines.
-B NUM, --before-context=NUM
Print NUM lines of leading context before matching
lines.
-C [NUM], --context[=NUM]
Print NUM lines (default 2) of output context.
--print0 Print null byte as separator between filenames,
only works with -f, -g, -l, -L or -c.
File presentation:
--pager=COMMAND Pipes all ack output through COMMAND. For example,
--pager="less -R". Ignored if output is redirected.
--nopager Do not send output through a pager. Cancels any
setting in ~/.ackrc, ACK_PAGER or ACK_PAGER_COLOR.
--[no]heading Print a filename heading above each file's results.
(default: on when used interactively)
--[no]break Print a break between results from different files.
(default: on when used interactively)
--group Same as --heading --break
--nogroup Same as --noheading --nobreak
--[no]color Highlight the matching text (default: on unless
output is redirected, or on Windows)
--[no]colour Same as --[no]color
--color-filename=COLOR
--color-match=COLOR
--color-lineno=COLOR Set the color for filenames, matches, and line numbers.
--flush Flush output immediately, even when ack is used
non-interactively (when output goes to a pipe or
file).
File finding:
-f Only print the files found, without searching.
The PATTERN must not be specified.
-g REGEX Same as -f, but only print files matching REGEX.
--sort-files Sort the found files lexically.
--invert-file-match Print/search handle files that do not match -g/-G.
--show-types Show which types each file has.
File inclusion/exclusion:
-a, --all-types All file types searched;
Ignores CVS, .svn and other ignored directories
-u, --unrestricted All files and directories searched
--[no]ignore-dir=name Add/Remove directory from the list of ignored dirs
-r, -R, --recurse Recurse into subdirectories (ack's default behavior)
-n, --no-recurse No descending into subdirectories
-G REGEX Only search files that match REGEX
--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.
--type-set TYPE=.EXTENSION[,.EXT2[,...]]
Files with the given EXTENSION(s) are recognized as
being of type TYPE. This replaces an existing
definition for type TYPE.
--type-add TYPE=.EXTENSION[,.EXT2[,...]]
Files with the given EXTENSION(s) are recognized as
being of (the existing) type TYPE
--[no]follow Follow symlinks. Default is off.
Directories ignored by default:
$ignore_dirs
Files not checked for type:
/~\$/ - Unix backup files
/#.+#\$/ - Emacs swap files
/[._].*\\.swp\$/ - Vi(m) swap files
/core\\.\\d+\$/ - core dumps
/[.-]min\\.js\$/ - Minified javascript files
Miscellaneous:
--noenv Ignore environment variables and ~/.ackrc
--help This help
--man Man page
--version Display version & copyright
--thpppt Bill the Cat
Exit status is 0 if match, 1 if no match.
This is version $VERSION of ack.
END_OF_HELP
return;
}
=head2 show_help_types()
Display the filetypes help subpage.
=cut
sub show_help_types {
App::Ack::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();
my $maxlen = 0;
for ( @types ) {
$maxlen = length if $maxlen < length;
}
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} );
}
App::Ack::print( sprintf( " --[no]%-*.*s %s\n", $maxlen, $maxlen, $type, $ext_list ) );
}
return;
}
sub _listify {
my @whats = @_;
return '' if !@whats;
my $end = pop @whats;
my $str = @whats ? join( ', ', @whats ) . " and $end" : $end;
no warnings 'once';
require Text::Wrap;
$Text::Wrap::columns = 75;
return Text::Wrap::wrap( '', ' ', $str );
}
=head2 get_version_statement
Returns the version information for ack.
=cut
sub get_version_statement {
require Config;
my $copyright = get_copyright();
my $this_perl = $Config::Config{perlpath};
if ($^O ne 'VMS') {
my $ext = $Config::Config{_exe};
$this_perl .= $ext unless $this_perl =~ m/$ext$/i;
}
my $ver = sprintf( '%vd', $^V );
return <<"END_OF_VERSION";
ack $VERSION
Running under Perl $ver at $this_perl
$copyright
This program is free software. You may modify or distribute it
under the terms of the Artistic License v2.0.
END_OF_VERSION
}
=head2 print_version_statement
Prints the version information for ack.
=cut
sub print_version_statement {
App::Ack::print( get_version_statement() );
return;
}
=head2 get_copyright
Return the copyright for ack.
=cut
sub get_copyright {
return $COPYRIGHT;
}
=head2 load_colors
Set default colors, load Term::ANSIColor
=cut
sub load_colors {
eval 'use Term::ANSIColor ()';
$ENV{ACK_COLOR_MATCH} ||= 'black on_yellow';
$ENV{ACK_COLOR_FILENAME} ||= 'bold green';
$ENV{ACK_COLOR_LINENO} ||= 'bold yellow';
return;
}
=head2 is_interesting
File type filter, filtering based on the wanted file types
=cut
sub is_interesting {
return if /^\./;
my $include;
for my $type ( filetypes( $File::Next::name ) ) {
if ( defined $type_wanted{$type} ) {
if ( $type_wanted{$type} ) {
$include = 1;
}
else {
return;
}
}
}
return $include;
}
# print subs added in order to make it easy for a third party
# module (such as App::Wack) to redefine the display methods
# and show the results in a different way.
sub print { print {$fh} @_ }
sub print_first_filename { App::Ack::print( $_[0], "\n" ) }
sub print_blank_line { App::Ack::print( "\n" ) }
sub print_separator { App::Ack::print( "--\n" ) }
sub print_filename { App::Ack::print( $_[0], $_[1] ) }
sub print_line_no { App::Ack::print( $_[0], $_[1] ) }
sub print_column_no { App::Ack::print( $_[0], $_[1] ) }
sub print_count {
my $filename = shift;
my $nmatches = shift;
my $ors = shift;
my $count = shift;
my $show_filename = shift;
if ($show_filename) {
App::Ack::print( $filename );