App-Greple-charcode
view release on metacpan or search on metacpan
lib/App/Greple/charcode.pm view on Meta::CPAN
package App::Greple::charcode;
use 5.024;
use warnings;
use utf8;
our $VERSION = "0.9909";
=encoding utf-8
=head1 NAME
App::Greple::charcode - greple module to annotate unicode character data
=for html <p>
<img width="566" src="https://raw.githubusercontent.com/kaz-utashiro/greple-charcode/refs/heads/main/images/homoglyph.png">
</p>
=head1 SYNOPSIS
greple -Mcharcode [ module option -- ] [ command option ] ...
COMMAND OPTION
--no-annotate do not print annotation
--[no-]align align annotations
--align-all align to the same column for all lines
--align-side align to the longest line
PATTERNS
--composite find composite character (combining character sequence)
--precomposed find precomposed character
--combined find both composite and precomposed characters
--outstand find --combined and non-ASCII characters
--dt=type specify decomposition type
--surrogate find character in UTF-16 surrogate pair range
--outstand find non-ASCII combining characters
-p/-P prop find \p{prop} or \P{prop} characters
--ansicode find ANSI terminal control sequences
MODULE OPTION
--column[=#] display column number
--visible[=#] display character name
--char[=#] display character itself
--width[=#] display width
--utf8[=#] display UTF-8 encoding
--utf16[=#] display UTF-16 encoding
--code[=#] display Unicode code point
--name[=#] display character name
--nfd[=#] display Unicode Normalization Form D
--nfc[=#] display Unicode Normalization Form C
--nfkd[=#] display Unicode Normalization Form KD
--nfkc[=#] display Unicode Normalization Form KC
--split[=#] put annotattion for each character
--alignto[=#] align annotation to #
--config KEY[=VALUE],...
greple -Mcc [ module option -- ] [ command option ] ...
-Mcc alias module for -Mcharcode
=head1 VERSION
Version 0.9909
=head1 DESCRIPTION
Greple module C<-Mcharcode> (or C<-Mcc> for short) displays
information about the matched characters. It can visualize Unicode
zero-width combining or hidden characters, which can be useful for
examining text containing visually indistinguishable or imperceptible
elements.
The following output, retrieved from this document for non-ASCII
characters (C<\P{ASCII}>), shows that the character C<\N{VARIATION
SELECTOR-15}> is included after the copyright character. The same
character, presumably left over from editing, is also included after a
normal ASCII C<t> character.
$ greple -Mcharcode '\P{ASCII}' charcode.pm
┌─── 12 \x{fe0e} \N{VARIATION SELECTOR-15}
│ ┌─ 14 \x{a9} \N{COPYRIGHT SIGN}
│ ├─ 14 \x{fe0e} \N{VARIATION SELECTOR-15}
Copyright︎ ©︎ 2025 Kazumasa Utashiro.
The nasal sound of the K line (カ行) in Japanese is sometimes
represented by adding a semivoiced dot to the K line character, and
since Unicode does not define a corresponding character, it is
represented by combining the original character with a combining
character. This module allows you to see how it is done.
┌───────── 0 \x{30ab} \N{KATAKANA LETTER KA}
├───────── 0 \x{309a} \N{COMBINING KATAKANA-HIRAGANA SEMI-VOICED SOUND MARK}
│ ┌─────── 2 \x{30ad} \N{KATAKANA LETTER KI}
│ ├─────── 2 \x{309a} \N{COMBINING KATAKANA-HIRAGANA SEMI-VOICED SOUND MARK}
│ │ ┌───── 4 \x{30af} \N{KATAKANA LETTER KU}
│ │ ├───── 4 \x{309a} \N{COMBINING KATAKANA-HIRAGANA SEMI-VOICED SOUND MARK}
│ │ │ ┌─── 6 \x{30b1} \N{KATAKANA LETTER KE}
│ │ │ ├─── 6 \x{309a} \N{COMBINING KATAKANA-HIRAGANA SEMI-VOICED SOUND MARK}
│ │ │ │ ┌─ 8 \x{30b3} \N{KATAKANA LETTER KO}
│ │ │ │ ├─ 8 \x{309a} \N{COMBINING KATAKANA-HIRAGANA SEMI-VOICED SOUND MARK}
ã‚«ã‚šã‚゚ク゚ケ゚コ゚
=for html <p>
<img width="750" src="https://raw.githubusercontent.com/kaz-utashiro/greple-charcode/refs/heads/main/images/ka-ko.png">
</p>
=head1 COMMAND OPTIONS
=over 7
=item B<--annotate>, B<--no-annotate>
Print annotation or not. Enabled by default, so use C<--no-annotate>
to disable it.
=item B<-->[B<no->]B<align>
Align annotation or not.
Default true.
=item B<--align-all>
Align to the same column for all lines
=item B<--align-side>
Align to the longest line length, regardless of match position.
=back
=head1 PATTERN OPTIONS
If multiple patterns are given to B<greple>, it normally prints only
the lines that match all of the patterns. However, for the purposes
of this module, it is desirable to display lines that match any of
them, so the C<--need=1> option is specified by default.
If multiple patterns are specified, the strings matching each pattern
will be displayed in a different color.
=over 7
=item B<--composite>
Search for composite characters (combining character sequence)
composed of base and combining characters.
=item B<--precomposed>
Search for precomposed characters (C<\p{Dt=Canonical}>).
=item B<--combined>
Find both B<composite> and B<precomposed> characters.
=item B<--dt>=I<type>, B<--decomposition-type>=I<type>
Specifies the C<Decomposition_Type>. It can take three values:
C<Canonical>, C<Non_Canonical> (C<NonCanon>), or C<None>.
=item B<--outstand>
Matches outstanding characters, those are non-ASCII combining
characters.
=item B<--surrogate>
Matches to characters in UTF-16 surragate pair range (U+10000 to
U+10FFFF).
=item B<-p> I<prop>, B<-P> I<prop>
Short cut for C<-E '\p{prop}'> and C<-E '\P{prop}'>.
You will not be able to use greple's C<-p> option, but it probably
won't be a problem. If you must use it, use C<--pargraph>.
=item B<--ansicode>
Search ANSI terminal control sequence. Automatically disables C<name>
and C<code> parameter and activates C<visible>. Colorized output is
disabled too.
To be precise, it searches for CSI Control sequences defined in
ECMA-48. Pattern is defined as this.
(?x)
# see ECMA-48 5.4 Control sequences
(?: \e\[ | \x9b ) # csi
[\x30-\x3f]* # parameter bytes
[\x20-\x2f]* # intermediate bytes
[\x40-\x7e] # final byte
=for html <p>
<img width="750" src="https://raw.githubusercontent.com/kaz-utashiro/greple-charcode/refs/heads/main/images/ansicode.png">
</p>
=back
=head1 MODULE OPTIONS and PARAMS
Module-specific options are specified between C<-Mcharcode> and C<-->.
greple -Mcharcode --config width,name=0 -- ...
Parameters can be set in two ways, one using the C<--config> option
and the other using dedicated options. See the L</CONFIGURATION>
section for more information.
=over 7
=item B<--config>=I<params>
Set configuration parameters.
=item B<column>
=item B<--column>[=I<#>]
Show column number.
Default C<1>.
=item B<visible>
=item B<--visible>[=I<#>]
Display invisible characters in a visible string representation.
Default C<0>.
=item B<char>
=item B<--char>[=I<#>]
Show the character itself.
Default C<0>.
=item B<width>
=item B<--width>[=I<#>]
Show the width.
Default C<0>.
=item B<utf8>
=item B<--utf8>[=I<#>]
Show the UTF-8 encoding in hex.
Default C<0>.
=item B<utf16>
=item B<--utf16>[=I<#>]
Show the UTF-16 encoding in hex.
lib/App/Greple/charcode.pm view on Meta::CPAN
Show the Unicode name of the character.
Default C<1>.
=item B<split>
=item B<--split>[=I<#>]
If a pattern matching multiple characters is given, annotate each
character independently.
=item B<alignto>=I<column>
=item B<--alignto>=I<column>
Align annotation messages. Defaults to C<1>, which aligns to the
rightmost column; C<0> means no align; if a value of C<2> or greater
is given, it aligns to that numbered column.
I<column> can be negative; if C<-1> is specified, align to the same
column for all lines. If C<-2> is specified, align to the longest
line length, regardless of match position.
=back
=head1 CONFIGURATION
Configuration parameters can be set in several ways.
=head2 MODULE START FUNCTION
The start function of a module can be specified at the same time as
the module declaration.
greple -Mcharcode::config(alignto=0)
greple -Mcharcode::config=alignto=80
=head2 PRIVATE MODULE OPTION
Module-specific options are specified between C<-Mcharcode> and C<-->.
greple -Mcharcode --config alignto=80 -- ...
greple -Mcharcode --alignto=80 -- ...
=head2 GENERIC MODULE OPTION
Module-specific C<---config> option can be called by normal command
line option C<--charcode::config>.
greple -Mcharcode --charcode::config alignto=80 ...
=head1 EXAMPLES
=head2 HOMOGLYPH
greple -Mcc -P ASCII --align-side --cm=S t/homoglyph
=for html <p>
<img width="750" src="https://raw.githubusercontent.com/kaz-utashiro/greple-charcode/refs/heads/main/images/homoglyph.png">
</p>
=head2 BOX DRAWINGS
perldoc -m App::ansicolumn::Border | greple -Mcc --code -- --outstand --mc=10,
=for html <p>
<img width="750" src="https://raw.githubusercontent.com/kaz-utashiro/greple-charcode/refs/heads/main/images/box-drawing.png">
</p>
=head2 AYNU ITAK
greple -Mcc --outstand --split t/ainu.txt
=for html <p>
<img width="750" src="https://raw.githubusercontent.com/kaz-utashiro/greple-charcode/refs/heads/main/images/aynu.png">
</p>
=head1 INSTALL
cpanm -n App::Greple::charcode
=head1 SEE ALSO
L<App::Greple>
L<App::Greple::charcode>
L<App::Greple::annotate>
=head1 LICENSE
Copyright︎ ©︎ 2025 Kazumasa Utashiro.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHOR
Kazumasa Utashiro
=cut
use Exporter qw(import);
our @EXPORT_OK = qw(config);
our %EXPORT_TAGS = (alias => \@EXPORT_OK);
use Encode ();
use Getopt::EX::Config;
use Hash::Util qw(lock_keys);
use Data::Dumper;
use Text::ANSI::Fold::Util qw(ansi_width);
use App::Greple::annotate;
our $config = Getopt::EX::Config->new(
column => 1,
visible => 1,
char => 0,
width => 0,
utf8 => 0,
utf16 => 0,
nfd => 0,
nfc => 0,
nfkd => 0,
nfkc => 0,
code => 0,
name => 1,
split => \$App::Greple::annotate::config->{split},
alignto => \$App::Greple::annotate::config->{alignto},
);
lock_keys %{$config};
my %type = ( '*' => ':1' );
sub optspec { $_[0] . ( $type{$_[0]} // $type{'*'} // '' ) }
our %CONFIG_TAGS = (
( run in 1.974 second using v1.01-cache-2.11-cpan-df04353d9ac )