File Coverage

blib/lib/App/Greple/type.pm

Criterion	Covered	Total	%
statement	8	17	47.0
branch	0	6	0.0
condition			n/a
subroutine	3	6	50.0
pod	1	3	33.3
total	12	32	37.5

=encoding utf-8

=head1 NAME

App::Greple::type - file type filter module for greple

=head1 SYNOPSIS

    greple -Mdig -Mtype --type-xxxx ... --dig .

=head1 DESCRIPTION

This module filters search target files by given rule.  It is
convenient to use with other B module which support recursive
or multi-file search such as B<-Mfind>, B<-Mdig> or B<-Mgit>.

For example, option for Perl is defined as this:

    option --type-perl \
           --suffix=pl,PL,pm,pod,t,psgi \
           --shebang=perl

Using this option, only files those name end with B<--suffix> option
or files which contains string C in the first C<#!> (shebang)
line will be searched.

Option B<--suffix> and B<--shebang> are defined in
L module.

=head1 CONFIGURATION

=over 7

=item B<-Mtype::config>(I[=I])

B<-Mtype> module can be called with B function to control
module behavior.

=over 4

=item B

Calling as B<-Mtype::config(short)> or B<-Mtype::config=short>
introduce short name for rule options.  When short name mode is
activated, all B<--type-xxxx> options can be used as B<--xxxx> as
well.

=back

=back

=head1 OPTIONS

  option --type-actionscript  --suffix=as,mxml
  option --type-ada           --suffix=ada,adb,ads
  option --type-asm           --suffix=asm,s
  option --type-asp           --suffix=asp
  option --type-aspx          --suffix=master,ascx,asmx,aspx,svc
  option --type-batch         --suffix=bat,cmd
  option --type-cc            --suffix=c,h,xs
  option --type-cfmx          --suffix=cfc,cfm,cfml
  option --type-clojure       --suffix=clj
  option --type-cmake         --suffix=cmake --select-name=^CMakeLists.txt$
  option --type-coffeescript  --suffix=coffee
  option --type-cpp           --suffix=cpp,cc,cxx,m,hpp,hh,h,hxx,c++,h++
  option --type-csharp        --suffix=cs
  option --type-css           --suffix=css
  option --type-dart          --suffix=dart
  option --type-delphi        --suffix=pas,int,dfm,nfm,dof,dpk,dproj,groupproj,bdsgroup,bdsproj
  option --type-elisp         --suffix=el
  option --type-elixir        --suffix=ex,exs
  option --type-erlang        --suffix=erl,hrl
  option --type-fortran       --suffix=f,f77,f90,f95,f03,for,ftn,fpp
  option --type-go            --suffix=go
  option --type-groovy        --suffix=groovy,gtmpl,gpp,grunit,gradle
  option --type-haskell       --suffix=hs,lhs
  option --type-hh            --suffix=h
  option --type-html          --suffix=htm,html
  option --type-java          --suffix=java,properties
  option --type-js            --suffix=js
  option --type-json          --suffix=json
  option --type-jsp           --suffix=jsp,jspx,jhtm,jhtml
  option --type-less          --suffix=less
  option --type-lisp          --suffix=lisp,lsp
  option --type-lua           --suffix=lua --shebng=lua
  option --type-markdown      --suffix=md
  option --type-md            --type-markdown
  option --type-make          --suffix=mak,mk --select-name=^(GNUmakefile|Makefile|makefile)$
  option --type-matlab        --suffix=m
  option --type-objc          --suffix=m,h
  option --type-objcpp        --suffix=mm,h
  option --type-ocaml         --suffix=ml,mli
  option --type-parrot        --suffix=pir,pasm,pmc,ops,pod,pg,tg
  option --type-perl          --suffix=pl,PL,pm,pod,t,psgi --shebang=perl
  option --type-perltest      --suffix=t
  option --type-php           --suffix=php,phpt,php3,php4,php5,phtml --shebang=php
  option --type-plone         --suffix=pt,cpt,metadata,cpy,py
  option --type-python        --suffix=py --shebang=python
  option --type-rake          --select-name=^Rakefile$
  option --type-rr            --suffix=R
  option --type-ruby          --suffix=rb,rhtml,rjs,rxml,erb,rake,spec \
                              --select-name=^Rakefile$ --shebang=ruby
  option --type-rust          --suffix=rs
  option --type-sass          --suffix=sass,scss
  option --type-scala         --suffix=scala
  option --type-scheme        --suffix=scm,ss
  option --type-shell         --suffix=sh,bash,csh,tcsh,ksh,zsh,fish \
                              --shebang=sh,bash,csh,tcsh,ksh,zsh,fish
  option --type-smalltalk     --suffix=st
  option --type-sql           --suffix=sql,ctl
  option --type-tcl           --suffix=tcl,itcl,itk
  option --type-tex           --suffix=tex,cls,sty
  option --type-tt            --suffix=tt,tt2,ttml
  option --type-vb            --suffix=bas,cls,frm,ctl,vb,resx
  option --type-verilog       --suffix=v,vh,sv
  option --type-vim           --suffix=vim
  option --type-xml           --suffix=xml,dtd,xsl,xslt,ent --select-data='\A.*<[?]xml'
  option --type-yaml          --suffix=yaml,yml

=head1 BACKGROUND

This module is inspired by L command, and original matching
rule is taken from it.

Filename matching can be done with B<-Mfind> module, but to know file
type from its content, different mechanism was required.  So I made
the B<--begin> function can die to stop the file processing, and
introduced new B<-Mselect> module.

=head1 SEE ALSO

L, L

L

=head1 AUTHOR

Kazumasa Utashiro

=head1 LICENSE

Copyright 2021-2022 Kazumasa Utashiro.

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut

package App::Greple::type;
our $VERSION = "0.01";

use v5.14;
use warnings;
use Data::Dumper;

my($module, $argv);
my %opt;

sub initialize {
    ($module, $argv) = @_;
}

sub config {
    while (my($k, $v) = splice @_, 0, 2) {
	$opt{$k} = $v;
    }
}

sub finalize {
    if ($opt{short}) {
	my @options = $module->options;
	for my $opt (@options) {
	    $opt =~ /^--type-(.+)/ or next;
	    $module->setopt("--$1", $opt);
	}
    }
    warn Dumper $module if $opt{dump};
}

1;

__DATA__