NAME

GBK - Source code filter to escape GBK script

Install and Usage

There are two steps there:

You'll have to download GBK.pm and Egbk.pm and put it in your perl lib directory.
You'll need to write "use GBK;" at head of the script.

SYNOPSIS

use GBK;
use GBK ver.sion;             --- require minimum version
use GBK ver.sion.0;           --- expects version (match or die)
use GBK qw(ord reverse getc); --- demand enhanced feature of ord, reverse, and getc
use GBK ver.sion qw(ord reverse getc);
use GBK ver.sion.0 qw(ord reverse getc);

# "no GBK;" not supported

or

$ perl GBK.pm GBK_script.pl > Escaped_script.pl.e

then

$ perl Escaped_script.pl.e

GBK_script.pl  --- script written in GBK
Escaped_script.pl.e --- escaped script

subroutines:
  GBK::ord(...);
  GBK::reverse(...);
  GBK::getc(...);
  GBK::length(...);
  GBK::substr(...);
  GBK::index(...);
  GBK::rindex(...);
  GBK::eval(...);
functions:
  <*>
  glob(...);
  CORE::chop(...);
  CORE::ord(...);
  CORE::reverse(...);
  CORE::getc(...);
  CORE::index(...);
  CORE::rindex(...);
dummy functions:
  utf8::upgrade(...);
  utf8::downgrade(...);
  utf8::encode(...);
  utf8::decode(...);
  utf8::is_utf8(...);
  utf8::valid(...);
  bytes::chr(...);
  bytes::index(...);
  bytes::length(...);
  bytes::ord(...);
  bytes::rindex(...);
  bytes::substr(...);

ABSTRACT

GBK software is "middleware" between perl interpreter and your Perl script written in GBK.

Perl is optimized for problems which are about 90% working with text and about 10% everything else. Even if this "text" doesn't contain GBK, Perl3 or later can treat GBK as binary data.

By "use GBK;", it automatically interpret your script as GBK. The various functions of perl including a regular expression can treat GBK now. The function length treats length per byte. This software does not use UTF8 flag.

Yet Another Future Of

JPerl is very useful software. -- Oops, note, this "JPerl" means "Japanized Perl" or "Japanese Perl". Therefore, it is unrelated to JPerl of the following.

JPerl is an implementation of Perl written in Java.
http://www.javainc.com/projects/jperl/

jPerl - Perl on the JVM
http://www.dzone.com/links/175948.html

Jamie's PERL scripts for bioinformatics
http://code.google.com/p/jperl/

jperl (Jonathan Perl)
https://github.com/jperl

Now, the last version of JPerl is 5.005_04 and is not maintained now.

Japanization modifier WATANABE Hirofumi said,

"Because WATANABE am tired I give over maintaing JPerl."

at Slide #15: "The future of JPerl" of

ftp://ftp.oreilly.co.jp/pcjp98/watanabe/jperlconf.ppt

in The Perl Confernce Japan 1998.

When I heard it, I thought that someone excluding me would maintain JPerl. And I slept every night hanging a sock. Night and day, I kept having hope. After 10 years, I noticed that white beard exists in the sock :-)

This software is a source code filter to escape Perl script encoded by GBK given from STDIN or command line parameter. The character code is never converted by escaping the script. Neither the value of the character nor the length of the character string change even if it escapes.

I learned the following things from the successful software.

Upper Compatibility like Perl4 to Perl5
Maximum Portability like jcode.pl
Remains One Language Handling Raw GBK, Doesn't Use UTF8 flag like JPerl
Remains One Interpreter like Encode module
Code Set Independent like Ruby
Monolithic Script like cpanminus
There's more than one way to do it like Perl itself

I am excited about this software and Perl's future --- I hope you are too.

JRE: JPerl Runtime Environment

+---------------------------------------+
|        JPerl Application Script       | Your Script
+---------------------------------------+
|  Source Code Filter, Runtime Routine  | ex. GBK.pm, Egbk.pm
+---------------------------------------+
|          PVM 5.00503 or later         | ex. perl 5.00503
+---------------------------------------+

A Perl Virtual Machine (PVM) enables a set of computer software programs and data structures to use a virtual machine model for the execution of other computer programs and scripts. The model used by a PVM accepts a form of computer intermediate language commonly referred to as Perl byteorientedcode. This language conceptually represents the instruction set of a byte-oriented, capability architecture.

Basic Idea of Source Code Filter

I discovered this mail again recently.

[Tokyo.pm] jus Benkyoukai

http://mail.pm.org/pipermail/tokyo-pm/1999-September/001854.html

save as: SJIS.pm

package SJIS;
use Filter::Util::Call;
sub multibyte_filter {
    my $status;
    if (($status = filter_read()) > 0 ) {
        s/([\x81-\x9f\xe0-\xef])([\x40-\x7e\x80-\xfc])/
            sprintf("\\x%02x\\x%02x",ord($1),ord($2))
        /eg;
    }
    $status;
}
sub import {
    filter_add(\&multibyte_filter);
}
1;

I am glad that I could confirm my idea is not so wrong.

Command-line Wildcard Expansion on DOS-like Systems

The default command shells on DOS-like systems (COMMAND.COM or cmd.exe or Win95Cmd.exe) do not expand wildcard arguments supplied to programs. Instead, import of Egbk.pm works well.

in Egbk.pm
#
# @ARGV wildcard globbing
#
sub import {

    if ($^O =~ /\A (?: MSWin32 | NetWare | symbian | dos ) \z/oxms) {
        my @argv = ();
        for (@ARGV) {

            # has space
            if (/\A (?:$q_char)*? [ ] /oxms) {
                if (my @glob = Egbk::glob(qq{"$_"})) {
                    push @argv, @glob;
                }
                else {
                    push @argv, $_;
                }
            }

            # has wildcard metachar
            elsif (/\A (?:$q_char)*? [*?] /oxms) {
                if (my @glob = Egbk::glob($_)) {
                    push @argv, @glob;
                }
                else {
                    push @argv, $_;
                }
            }

            # no wildcard globbing
            else {
                push @argv, $_;
            }
        }
        @ARGV = @argv;
    }
}

Software Composition

GBK.pm               --- source code filter to escape GBK
Egbk.pm              --- run-time routines for GBK.pm

Upper Compatibility by Escaping

This software adds the function by 'Escaping' it always, and nothing of the past is broken. Therefore, 'Possible job' never becomes 'Impossible job'. This approach is effective in the field where the retreat is never permitted. It means incompatible upgrade of Perl should be rewound.

Escaping Your Script (You do)

You need write 'use GBK;' in your script.

---------------------
You do
---------------------
use GBK;
---------------------

Escaping Multiple-Octet Code (GBK software provides)

Insert chr(0x5c) before @ [ \ ] ^ ` { | and } in multiple-octet of

string in single quote ('', q{}, <<'END', and qw{})
string in double quote ("", qq{}, <<END, <<"END", ``, qx{}, and <<`END`)
regexp in single quote (m'', s''', split(''), split(m''), and qr'')
regexp in double quote (//, m//, ??, s///, split(//), split(m//), and qr//)
character in tr/// (tr/// and y///)

 ex. Japanese Katakana "SO" like [ `/ ] code is "\x83\x5C" in SJIS

                 see     hex dump
 -----------------------------------------
 source script   "`/"    [83 5c]
 -----------------------------------------

 Here, use SJIS;
                         hex dump
 -----------------------------------------
 escaped script  "`\/"   [83 [5c] 5c]
 -----------------------------------------
                   ^--- escape by SJIS software

 by the by       see     hex dump
 -----------------------------------------
 your eye's      "`/\"   [83 5c] [5c]
 -----------------------------------------
 perl eye's      "`\/"   [83] \[5c]
 -----------------------------------------

                         hex dump
 -----------------------------------------
 in the perl     "`/"    [83] [5c]
 -----------------------------------------

Multiple-Octet Anchoring of Regular Expression (GBK software provides)

GBK software applies multiple-octet anchoring at beginning of regular expression.

--------------------------------------------------------------------------------
Before                  After
--------------------------------------------------------------------------------
m/regexp/               m/${Egbk::anchor}(?:regexp).../
--------------------------------------------------------------------------------

Escaping Second Octet (GBK software provides)

GBK software escapes second octet of multiple-octet character in regular expression.

--------------------------------------------------------------------------------
Before                  After
--------------------------------------------------------------------------------
m<...`/...>             m<...`/\...>
--------------------------------------------------------------------------------

Multiple-Octet Character Regular Expression (GBK software provides)

GBK software clusters multiple-octet character with quantifier, makes cluster from multiple-octet custom character classes. And makes multiple-octet version metasymbol from classic Perl character class shortcuts and POSIX-style character classes.

--------------------------------------------------------------------------------
Before                  After
--------------------------------------------------------------------------------
m/...MULTIOCT+.../      m/...(?:MULTIOCT)+.../
m/...[AN-EM].../        m/...(?:A[N-Z]|[B-D][A-Z]|E[A-M]).../
m/...\D.../             m/...(?:${Egbk::eD}).../
m/...[[:^digit:]].../   m/...(?:${Egbk::not_digit}).../
--------------------------------------------------------------------------------

Calling 'Egbk::ignorecase()' (GBK software provides)

GBK software applies calling 'Egbk::ignorecase()' instead of /i modifier.

--------------------------------------------------------------------------------
Before                  After
--------------------------------------------------------------------------------
m/...$var.../i          m/...@{[Egbk::ignorecase($var)]}.../
--------------------------------------------------------------------------------

Character-Oriented Regular Expression

Regular expression works as character-oriented that has no /b modifier.

 --------------------------------------------------------------------------------
 Before                  After
 --------------------------------------------------------------------------------
 /regexp/                /ditto$Egbk::matched/
 m/regexp/               m/ditto$Egbk::matched/
 ?regexp?                m?ditto$Egbk::matched?
 m?regexp?               m?ditto$Egbk::matched?

 $_ =~                   ($_ =~ m/ditto$Egbk::matched/) ?
 s/regexp/replacement/   CORE::eval{ Egbk::s_matched(); local $^W=0; my $__r=qq/replacement/; $_="${1}$__r$'"; 1 } :
                         undef

 $_ !~                   ($_ !~ m/ditto$Egbk::matched/) ?
 s/regexp/replacement/   1 :
                         CORE::eval{ Egbk::s_matched(); local $^W=0; my $__r=qq/replacement/; $_="${1}$__r$'"; undef }

 split(/regexp/)         Egbk::split(qr/regexp/)
 split(m/regexp/)        Egbk::split(qr/regexp/)
 split(qr/regexp/)       Egbk::split(qr/regexp/)
 qr/regexp/              qr/ditto$Egbk::matched/
 --------------------------------------------------------------------------------

Byte-Oriented Regular Expression

Regular expression works as byte-oriented that has /b modifier.

 --------------------------------------------------------------------------------
 Before                  After
 --------------------------------------------------------------------------------
 /regexp/b               /(?:regexp)$Egbk::matched/
 m/regexp/b              m/(?:regexp)$Egbk::matched/
 ?regexp?b               m?regexp$Egbk::matched?
 m?regexp?b              m?regexp$Egbk::matched?

 $_ =~                   ($_ =~ m/(\G[\x00-\xFF]*?)(?:regexp)$Egbk::matched/) ?
 s/regexp/replacement/b  CORE::eval{ Egbk::s_matched(); local $^W=0; my $__r=qq/replacement/; $_="${1}$__r$'"; 1 } :
                         undef

 $_ !~                   ($_ !~ m/(\G[\x00-\xFF]*?)(?:regexp)$Egbk::matched/) ?
 s/regexp/replacement/b  1 :
                         CORE::eval{ Egbk::s_matched(); local $^W=0; my $__r=qq/replacement/; $_="${1}$__r$'"; undef }

 split(/regexp/b)        split(qr/regexp/)
 split(m/regexp/b)       split(qr/regexp/)
 split(qr/regexp/b)      split(qr/regexp/)
 qr/regexp/b             qr/(?:regexp)$Egbk::matched/
 --------------------------------------------------------------------------------

Escaping Character Classes (Egbk.pm provides)

The character classes are redefined as follows to backward compatibility.

---------------------------------------------------------------
Before        After
---------------------------------------------------------------
 .            ${Egbk::dot}
              ${Egbk::dot_s}    (/s modifier)
\d            [0-9]              (universally)
\s            \s
\w            [0-9A-Z_a-z]       (universally)
\D            ${Egbk::eD}
\S            ${Egbk::eS}
\W            ${Egbk::eW}
\h            [\x09\x20]
\v            [\x0A\x0B\x0C\x0D]
\H            ${Egbk::eH}
\V            ${Egbk::eV}
\C            [\x00-\xFF]
\X            X                  (so, just 'X')
\R            ${Egbk::eR}
\N            ${Egbk::eN}
---------------------------------------------------------------

Also POSIX-style character classes.

---------------------------------------------------------------
Before        After
---------------------------------------------------------------
[:alnum:]     [\x30-\x39\x41-\x5A\x61-\x7A]
[:alpha:]     [\x41-\x5A\x61-\x7A]
[:ascii:]     [\x00-\x7F]
[:blank:]     [\x09\x20]
[:cntrl:]     [\x00-\x1F\x7F]
[:digit:]     [\x30-\x39]
[:graph:]     [\x21-\x7F]
[:lower:]     [\x61-\x7A]
              [\x41-\x5A\x61-\x7A]     (/i modifier)
[:print:]     [\x20-\x7F]
[:punct:]     [\x21-\x2F\x3A-\x3F\x40\x5B-\x5F\x60\x7B-\x7E]
[:space:]     [\s\x0B]
[:upper:]     [\x41-\x5A]
              [\x41-\x5A\x61-\x7A]     (/i modifier)
[:word:]      [\x30-\x39\x41-\x5A\x5F\x61-\x7A]
[:xdigit:]    [\x30-\x39\x41-\x46\x61-\x66]
[:^alnum:]    ${Egbk::not_alnum}
[:^alpha:]    ${Egbk::not_alpha}
[:^ascii:]    ${Egbk::not_ascii}
[:^blank:]    ${Egbk::not_blank}
[:^cntrl:]    ${Egbk::not_cntrl}
[:^digit:]    ${Egbk::not_digit}
[:^graph:]    ${Egbk::not_graph}
[:^lower:]    ${Egbk::not_lower}
              ${Egbk::not_lower_i}    (/i modifier)
[:^print:]    ${Egbk::not_print}
[:^punct:]    ${Egbk::not_punct}
[:^space:]    ${Egbk::not_space}
[:^upper:]    ${Egbk::not_upper}
              ${Egbk::not_upper_i}    (/i modifier)
[:^word:]     ${Egbk::not_word}
[:^xdigit:]   ${Egbk::not_xdigit}
---------------------------------------------------------------

\b and \B are redefined as follows to backward compatibility.

---------------------------------------------------------------
Before      After
---------------------------------------------------------------
\b          ${Egbk::eb}
\B          ${Egbk::eB}
---------------------------------------------------------------

Definitions in Egbk.pm.

---------------------------------------------------------------------------------------------------------------------------------------------------------
After                    Definition
---------------------------------------------------------------------------------------------------------------------------------------------------------
${Egbk::anchor}         qr{\G(?>[^\x81-\xFE]|[\x81-\xFE][\x00-\xFF])*?}
                         for over 32766 octets string on ActivePerl5.6 and Perl5.10 or later
                         qr{\G(?(?=.{0,32766}\z)\G(?>[^\x81-\xFE]|[\x81-\xFE][\x00-\xFF])*?|(?(?=[$sbcs]+\z).*?|(?:.*?[$sbcs](?:[^$sbcs][^$sbcs])*?)))}oxms
${Egbk::dot}            qr{(?>[^\x81-\xFE\x0A]|[\x81-\xFE][\x00-\xFF])};
${Egbk::dot_s}          qr{(?>[^\x81-\xFE]|[\x81-\xFE][\x00-\xFF])};
${Egbk::eD}             qr{(?>[^\x81-\xFE0-9]|[\x81-\xFE][\x00-\xFF])};
${Egbk::eS}             qr{(?>[^\x81-\xFE\s]|[\x81-\xFE][\x00-\xFF])};
${Egbk::eW}             qr{(?>[^\x81-\xFE0-9A-Z_a-z]|[\x81-\xFE][\x00-\xFF])};
${Egbk::eH}             qr{(?>[^\x81-\xFE\x09\x20]|[\x81-\xFE][\x00-\xFF])};
${Egbk::eV}             qr{(?>[^\x81-\xFE\x0A\x0B\x0C\x0D]|[\x81-\xFE][\x00-\xFF])};
${Egbk::eR}             qr{(?>\x0D\x0A|[\x0A\x0D])};
${Egbk::eN}             qr{(?>[^\x81-\xFE\x0A]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_alnum}      qr{(?>[^\x81-\xFE\x30-\x39\x41-\x5A\x61-\x7A]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_alpha}      qr{(?>[^\x81-\xFE\x41-\x5A\x61-\x7A]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_ascii}      qr{(?>[^\x81-\xFE\x00-\x7F]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_blank}      qr{(?>[^\x81-\xFE\x09\x20]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_cntrl}      qr{(?>[^\x81-\xFE\x00-\x1F\x7F]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_digit}      qr{(?>[^\x81-\xFE\x30-\x39]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_graph}      qr{(?>[^\x81-\xFE\x21-\x7F]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_lower}      qr{(?>[^\x81-\xFE\x61-\x7A]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_lower_i}    qr{(?>[^\x81-\xFE\x41-\x5A\x61-\x7A]|[\x81-\xFE][\x00-\xFF])}; # Perl 5.16 compatible
# ${Egbk::not_lower_i}    qr{(?>[^\x81-\xFE]|[\x81-\xFE][\x00-\xFF])};                   # older Perl compatible
${Egbk::not_print}      qr{(?>[^\x81-\xFE\x20-\x7F]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_punct}      qr{(?>[^\x81-\xFE\x21-\x2F\x3A-\x3F\x40\x5B-\x5F\x60\x7B-\x7E]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_space}      qr{(?>[^\x81-\xFE\s\x0B]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_upper}      qr{(?>[^\x81-\xFE\x41-\x5A]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_upper_i}    qr{(?>[^\x81-\xFE\x41-\x5A\x61-\x7A]|[\x81-\xFE][\x00-\xFF])}; # Perl 5.16 compatible
# ${Egbk::not_upper_i}    qr{(?>[^\x81-\xFE]|[\x81-\xFE][\x00-\xFF])};                   # older Perl compatible
${Egbk::not_word}       qr{(?>[^\x81-\xFE\x30-\x39\x41-\x5A\x5F\x61-\x7A]|[\x81-\xFE][\x00-\xFF])};
${Egbk::not_xdigit}     qr{(?>[^\x81-\xFE\x30-\x39\x41-\x46\x61-\x66]|[\x81-\xFE][\x00-\xFF])};

# This solution is not perfect. I beg better solution from you who are reading this.
${Egbk::eb}             qr{(?:\A(?=[0-9A-Z_a-z])|(?<=[\x00-\x2F\x40\x5B-\x5E\x60\x7B-\xFF])(?=[0-9A-Z_a-z])|(?<=[0-9A-Z_a-z])(?=[\x00-\x2F\x40\x5B-\x5E\x60\x7B-\xFF]|\z))};
${Egbk::eB}             qr{(?:(?<=[0-9A-Z_a-z])(?=[0-9A-Z_a-z])|(?<=[\x00-\x2F\x40\x5B-\x5E\x60\x7B-\xFF])(?=[\x00-\x2F\x40\x5B-\x5E\x60\x7B-\xFF]))};
---------------------------------------------------------------------------------------------------------------------------------------------------------

Un-Escaping \ of \b{}, \B{}, \N{}, \p{}, \P{}, and \X (GBK software provides)

GBK software removes '\' at head of alphanumeric regexp metasymbols \b{}, \B{}, \N{}, \p{}, \P{} and \X. By this method, you can avoid the trap of the abstraction.

See also, Deprecate literal unescaped "{" in regexes. http://perl5.git.perl.org/perl.git/commit/2a53d3314d380af5ab5283758219417c6dfa36e9

------------------------------------
Before           After
------------------------------------
\b{...}          b\{...}
\B{...}          B\{...}
\N{CHARNAME}     N\{CHARNAME}
\p{L}            p\{L}
\p{^L}           p\{^L}
\p{\^L}          p\{\^L}
\pL              pL
\P{L}            P\{L}
\P{^L}           P\{^L}
\P{\^L}          P\{\^L}
\PL              PL
\X               X
------------------------------------

Escaping Built-in Functions (GBK software provides)

Insert 'Egbk::' at head of function name. Egbk.pm provides your script Egbk::* subroutines.

-------------------------------------------
Before      After            Works as
-------------------------------------------
length      length           Byte
substr      substr           Byte
pos         pos              Byte
split       Egbk::split     Character
tr///       Egbk::tr        Character
tr///b      tr///            Byte
tr///B      tr///            Byte
y///        Egbk::tr        Character
y///b       tr///            Byte
y///B       tr///            Byte
chop        Egbk::chop      Character
index       Egbk::index     Character
rindex      Egbk::rindex    Character
lc          Egbk::lc        Character
lcfirst     Egbk::lcfirst   Character
uc          Egbk::uc        Character
ucfirst     Egbk::ucfirst   Character
fc          Egbk::fc        Character
chr         Egbk::chr       Character
glob        Egbk::glob      Character
lstat       Egbk::lstat     Character
opendir     Egbk::opendir   Character
stat        Egbk::stat      Character
unlink      Egbk::unlink    Character
chdir       Egbk::chdir     Character
do          Egbk::do        Character
require     Egbk::require   Character
-------------------------------------------

------------------------------------------------------------------------------------------------------------------------
Before                   After
------------------------------------------------------------------------------------------------------------------------
use Perl::Module;        BEGIN { Egbk::require 'Perl/Module.pm'; Perl::Module->import() if Perl::Module->can('import'); }
use Perl::Module @list;  BEGIN { Egbk::require 'Perl/Module.pm'; Perl::Module->import(@list) if Perl::Module->can('import'); }
use Perl::Module ();     BEGIN { Egbk::require 'Perl/Module.pm'; }
no Perl::Module;         BEGIN { Egbk::require 'Perl/Module.pm'; Perl::Module->unimport() if Perl::Module->can('unimport'); }
no Perl::Module @list;   BEGIN { Egbk::require 'Perl/Module.pm'; Perl::Module->unimport(@list) if Perl::Module->can('unimport'); }
no Perl::Module ();      BEGIN { Egbk::require 'Perl/Module.pm'; }
------------------------------------------------------------------------------------------------------------------------

Escaping File Test Operators (GBK software provides)

Insert 'Egbk::' instead of '-' of operator.

Available in MSWin32, MacOS, and UNIX-like systems
--------------------------------------------------------------------------
Before   After      Meaning
--------------------------------------------------------------------------
-r       Egbk::r   File or directory is readable by this (effective) user or group
-w       Egbk::w   File or directory is writable by this (effective) user or group
-e       Egbk::e   File or directory name exists
-x       Egbk::x   File or directory is executable by this (effective) user or group
-z       Egbk::z   File exists and has zero size (always false for directories)
-f       Egbk::f   Entry is a plain file
-d       Egbk::d   Entry is a directory
-t       -t         The filehandle is a TTY (as reported by the isatty() system function;
                    filenames can't be tested by this test)
-T       Egbk::T   File looks like a "text" file
-B       Egbk::B   File looks like a "binary" file
-M       Egbk::M   Modification age (measured in days)
-A       Egbk::A   Access age (measured in days)
-C       Egbk::C   Inode-modification age (measured in days)
-s       Egbk::s   File or directory exists and has nonzero size
                    (the value is the size in bytes)
--------------------------------------------------------------------------

Available in MacOS and UNIX-like systems
--------------------------------------------------------------------------
Before   After      Meaning
--------------------------------------------------------------------------
-R       Egbk::R   File or directory is readable by this real user or group
-W       Egbk::W   File or directory is writable by this real user or group
-X       Egbk::X   File or directory is executable by this real user or group
-l       Egbk::l   Entry is a symbolic link
-S       Egbk::S   Entry is a socket
--------------------------------------------------------------------------

Not available in MSWin32 and MacOS
--------------------------------------------------------------------------
Before   After      Meaning
--------------------------------------------------------------------------
-o       Egbk::o   File or directory is owned by this (effective) user
-O       Egbk::O   File or directory is owned by this real user
-p       Egbk::p   Entry is a named pipe (a "fifo")
-b       Egbk::b   Entry is a block-special file (like a mountable disk)
-c       Egbk::c   Entry is a character-special file (like an I/O device)
-u       Egbk::u   File or directory is setuid
-g       Egbk::g   File or directory is setgid
-k       Egbk::k   File or directory has the sticky bit set
--------------------------------------------------------------------------

-w only inspects the read-only file attribute (FILE_ATTRIBUTE_READONLY), which determines whether the directory can be deleted, not whether it can be written to. Directories always have read and write access unless denied by discretionary access control lists (DACLs). (MSWin32) -R, -W, -X, -O are indistinguishable from -r, -w, -x, -o. (MSWin32) -g, -k, -l, -u, -A are not particularly meaningful. (MSWin32) -x (or -X) determine if a file ends in one of the executable suffixes. -S is meaningless. (MSWin32)

As of Perl 5.00503, as a form of purely syntactic sugar, you can stack file test operators, in a way that -w -x $file is equivalent to -x $file && -w _ .

if ( -w -r $file ) {
    print "The file is both readable and writable!\n";
}

Escaping Function Name (You do)

You need write 'GBK::' at head of function name when you want character- oriented subroutine. See 'Character-Oriented Subroutines'.

--------------------------------------------------------
Function   Character-Oriented   Description
--------------------------------------------------------
ord        GBK::ord
reverse    GBK::reverse
getc       GBK::getc
length     GBK::length
substr     GBK::substr
index      GBK::index          See 'About Indexes'
rindex     GBK::rindex         See 'About Rindexes'
eval       GBK::eval
--------------------------------------------------------

About Indexes
-------------------------------------------------------------------------
Function       Works as    Returns as   Description
-------------------------------------------------------------------------
index          Character   Byte         JPerl semantics (most useful)
(same as Egbk::index)
GBK::index    Character   Character    Character-oriented semantics
CORE::index    Byte        Byte         Byte-oriented semantics
(nothing)      Byte        Character    (most useless)
-------------------------------------------------------------------------

About Rindexes
-------------------------------------------------------------------------
Function       Works as    Returns as   Description
-------------------------------------------------------------------------
rindex         Character   Byte         JPerl semantics (most useful)
(same as Egbk::rindex)
GBK::rindex   Character   Character    Character-oriented semantics
CORE::rindex   Byte        Byte         Byte-oriented semantics
(nothing)      Byte        Character    (most useless)
-------------------------------------------------------------------------

Character-Oriented Subsroutines

Ordinal Value of Character

$ord = GBK::ord($string);

This subroutine returns the numeric value (ASCII or GBK character) of the
first character of $string, not Unicode. If $string is omitted, it uses $_.
The return value is always unsigned.

If you import ord "use GBK qw(ord);", ord of your script will be rewritten in
GBK::ord. GBK::ord is not compatible with ord of JPerl.

Reverse List or String

@reverse = GBK::reverse(@list);
$reverse = GBK::reverse(@list);

In list context, this subroutine returns a list value consisting of the elements
of @list in the opposite order.

In scalar context, the subroutine concatenates all the elements of @list and
then returns the reverse of that resulting string, character by character.

If you import reverse "use GBK qw(reverse);", reverse of your script will be
rewritten in GBK::reverse. GBK::reverse is not compatible with reverse of
JPerl.

Even if you do not know this subroutine, there is no problem. This subroutine
can be created with

$rev = join('', reverse(split(//, $jstring)));

as before.

See:
P.558 JPerl (Japanese Perl)
Appendix C Supplement the Japanese version
ISBN 4-89052-384-7 PERL PUROGURAMINGU

Returns Next Character

$getc = GBK::getc(FILEHANDLE);
$getc = GBK::getc($filehandle);
$getc = GBK::getc;

This subroutine returns the next character from the input file attached to
FILEHANDLE. It returns undef at end-of-file, or if an I/O error was encountered.
If FILEHANDLE is omitted, the subroutine reads from STDIN.

This subroutine is somewhat slow, but it's occasionally useful for
single-character input from the keyboard -- provided you manage to get your
keyboard input unbuffered. This subroutine requests unbuffered input from the
standard I/O library. Unfortunately, the standard I/O library is not so standard
as to provide a portable way to tell the underlying operating system to supply
unbuffered keyboard input to the standard I/O system. To do that, you have to
be slightly more clever, and in an operating-system-dependent fashion. Under
Unix you might say this:

if ($BSD_STYLE) {
    system "stty cbreak </dev/tty >/dev/tty 2>&1";
}
else {
    system "stty", "-icanon", "eol", "\001";
}

$key = GBK::getc;

if ($BSD_STYLE) {
    system "stty -cbreak </dev/tty >/dev/tty 2>&1";
}
else {
    system "stty", "icanon", "eol", "^@"; # ASCII NUL
}
print "\n";

This code puts the next character typed on the terminal in the string $key. If
your stty program has options like cbreak, you'll need to use the code where
$BSD_STYLE is true. Otherwise, you'll need to use the code where it is false.

If you import getc "use GBK qw(getc);", getc of your script will be rewritten
in GBK::getc. GBK::getc is not compatible with getc of JPerl.

Length by GBK Character

$length = GBK::length($string);
$length = GBK::length();

This subroutine returns the length in characters (programmer-visible characters)
of the scalar value $string. If $string is omitted, it returns the GBK::length
of $_.

Do not try to use GBK::length to find the size of an array or hash. Use scalar
@array for the size of an array, and scalar keys %hash for the number of key/value
pairs in a hash. (The scalar is typically omitted when redundant.)

To find the length of a string in bytes rather than characters, say simply:

$bytes = length($string);

Even if you do not know this subroutine, there is no problem. This subroutine
can be created with

$len = split(//, $jstring);

as before.

See:
P.558 JPerl (Japanese Perl)
Appendix C Supplement the Japanese version
ISBN 4-89052-384-7 PERL PUROGURAMINGU

Substr by GBK Character

$substr = GBK::substr($string,$offset,$length,$replacement);
$substr = GBK::substr($string,$offset,$length);
$substr = GBK::substr($string,$offset);

This subroutine extracts a substring out of the string given by $string and returns
it. The substring is extracted starting at $offset characters from the front of
the string. First character is at offset zero. If $offset is negative, starts that
far back from the end of the string.
If $length is omitted, returns everything through the end of the string. If $length
is negative, leaves that many characters off the end of the string. Otherwise,
$length indicates the length of the substring to extract, which is sort of what
you'd expect.

my $s = "The black cat climbed the green tree";
my $color  = GBK::substr $s, 4, 5;      # black
my $middle = GBK::substr $s, 4, -11;    # black cat climbed the
my $end    = GBK::substr $s, 14;        # climbed the green tree
my $tail   = GBK::substr $s, -4;        # tree
my $z      = GBK::substr $s, -4, 2;     # tr

If Perl version 5.14 or later, you can use the GBK::substr() subroutine as an
lvalue. In its case $string must itself be an lvalue. If you assign something
shorter than $length, the string will shrink, and if you assign something longer
than $length, the string will grow to accommodate it. To keep the string the
same length, you may need to pad or chop your value using sprintf.

If $offset and $length specify a substring that is partly outside the string,
only the part within the string is returned. If the substring is beyond either
end of the string, GBK::substr() returns the undefined value and produces a
warning. When used as an lvalue, specifying a substring that is entirely outside
the string raises an exception. Here's an example showing the behavior for
boundary cases:

my $name = 'fred';
GBK::substr($name, 4) = 'dy';         # $name is now 'freddy'
my $null = GBK::substr $name, 6, 2;   # returns "" (no warning)
my $oops = GBK::substr $name, 7;      # returns undef, with warning
GBK::substr($name, 7) = 'gap';        # raises an exception

An alternative to using GBK::substr() as an lvalue is to specify the replacement
string as the 4th argument. This allows you to replace parts of the $string and
return what was there before in one operation, just as you can with splice().

my $s = "The black cat climbed the green tree";
my $z = GBK::substr $s, 14, 7, "jumped from";    # climbed
# $s is now "The black cat jumped from the green tree"

Note that the lvalue returned by the three-argument version of GBK::substr() acts
as a 'magic bullet'; each time it is assigned to, it remembers which part of the
original string is being modified; for example:

$x = '1234';
for (GBK::substr($x,1,2)) {
    $_ = 'a';   print $x,"\n";    # prints 1a4
    $_ = 'xyz'; print $x,"\n";    # prints 1xyz4
    $x = '56789';
    $_ = 'pq';  print $x,"\n";    # prints 5pq9
}

With negative offsets, it remembers its position from the end of the string when
the target string is modified:

$x = '1234';
for (GBK::substr($x, -3, 2)) {
    $_ = 'a';   print $x,"\n";    # prints 1a4, as above
    $x = 'abcdefg';
    print $_,"\n";                # prints f
}

Prior to Perl version 5.10, the result of using an lvalue multiple times was
unspecified. Prior to 5.16, the result with negative offsets was unspecified.

Index by GBK Character

$index = GBK::index($string,$substring,$offset);
$index = GBK::index($string,$substring);

This subroutine searches for one string within another. It returns the character
position of the first occurrence of $substring in $string. The $offset, if
specified, says how many characters from the start to skip before beginning to
look. Positions are based at 0. If the substring is not found, the subroutine
returns one less than the base, ordinarily -1. To work your way through a string,
you might say:

$pos = -1;
while (($pos = GBK::index($string, $lookfor, $pos)) > -1) {
    print "Found at $pos\n";
    $pos++;
}

Rindex by GBK Character

$rindex = GBK::rindex($string,$substring,$offset);
$rindex = GBK::rindex($string,$substring);

This subroutine works just like GBK::index except that it returns the character
position of the last occurrence of $substring in $string (a reverse GBK::index).
The subroutine returns -1 if $substring is not found. $offset, if specified, is
the rightmost character position that may be returned. To work your way through
a string backward, say:

$pos = GBK::length($string);
while (($pos = GBK::rindex($string, $lookfor, $pos)) >= 0) {
    print "Found at $pos\n";
    $pos--;
}

Eval GBK Script

$eval = GBK::eval { block };
$eval = GBK::eval $expr;
$eval = GBK::eval;

The GBK::eval keyword serves two distinct but related purposes in JPerl.
These purposes are represented by two forms of syntax, GBK::eval { block }
and GBK::eval $expr. The first form traps runtime exceptions (errors)
that would otherwise prove fatal, similar to the "try block" construct in
C++ or Java. The second form compiles and executes little bits of code on
the fly at runtime, and also (conveniently) traps any exceptions just like
the first form. But the second form runs much slower than the first form,
since it must parse the string every time. On the other hand, it is also
more general. Whichever form you use, GBK::eval is the preferred way to do
all exception handling in JPerl.

For either form of GBK::eval, the value returned from an GBK::eval is
the value of the last expression evaluated, just as with subroutines.
Similarly, you may use the return operator to return a value from the
middle of the eval. The expression providing the return value is evaluated
in void, scalar, or list context, depending on the context of the
GBK::eval itself. See wantarray for more on how the evaluation context
can be determined.

If there is a trappable error (including any produced by the die operator),
GBK::eval returns undef and puts the error message (or object) in $@. If
there is no error, $@ is guaranteed to be set to the null string, so you
can test it reliably afterward for errors. A simple Boolean test suffices:

    GBK::eval { ... }; # trap runtime errors
    if ($@) { ... }     # handle error

(Prior to Perl 5.16, a bug caused undef to be returned in list context for
syntax errors, but not for runtime errors.)

The GBK::eval { block } form is syntax checked and compiled at compile time,
so it is just as efficient at runtime as any other block. (People familiar
with the slow GBK::eval $expr form are occasionally confused on this issue.)
Because the { block } is compiled when the surrounding code is, this form of
GBK::eval cannot trap syntax errors.

The GBK::eval $expr form can trap syntax errors because it parses the code
at runtime. (If the parse is unsuccessful, it places the parse error in $@,
as usual.) If $expr is omitted, evaluates $_ .

Otherwise, it executes the value of $expr as though it were a little JPerl
script. The code is executed in the context of the current of the current
JPerl script, which means that it can see any enclosing lexicals from a
surrounding scope, and that any nonlocal variable settings remain in effect
after the GBK::eval is complete, as do any subroutine or format definitions.
The code of the GBK::eval is treated as a block, so any locally scoped
variables declared within the GBK::eval last only until the GBK::eval is
done. (See my and local.) As with any code in a block, a final semicolon is
not required.

GBK::eval will be escaped as follows:

-------------------------------------------------
Before                  After
-------------------------------------------------
GBK::eval { block }    eval { block }
GBK::eval $expr        eval GBK::escape $expr
GBK::eval              eval GBK::escape
-------------------------------------------------

To tell the truth, the subroutine GBK::eval does not exist. If it exists,
you will troubled, when GBK::eval has a parameter that is single quoted
string included my variables. GBK::escape is a subroutine that makes Perl
script from JPerl script.

Here is a simple JPerl shell. It prompts the user to enter a string of
arbitrary JPerl code, compiles and executes that string, and prints whatever
error occurred:

    #!/usr/bin/perl
    # jperlshell.pl - simple JPerl shell
    use GBK;
    print "\nEnter some JPerl code: ";
    while (<STDIN>) {
        GBK::eval;
        print $@;
        print "\nEnter some more JPerl code: ";
    }

Here is a rename.pl script to do a mass renaming of files using a JPerl
expression:

    #!/usr/bin/perl
    # rename.pl - change filenames
    use GBK;
    $op = shift;
    for (@ARGV) {
        $was = $_;
        GBK::eval $op;
        die if $@;
        # next line calls the built-in function, not
        # the script by the same name
        if ($was ne $_) {
            print STDERR "rename $was --> $_\n";
            rename($was,$_);
        }
    }

You'd use that script like this:

    C:\WINDOWS> perl rename.pl 's/\.orig$//' *.orig
    C:\WINDOWS> perl rename.pl 'y/A-Z/a-z/ unless /^Make/' *
    C:\WINDOWS> perl rename.pl '$_ .= ".bad"' *.f

Since GBK::eval traps errors that would otherwise prove fatal, it is useful
for determining whether particular features (such as fork or symlink) are
implemented.

Because GBK::eval { block } is syntax checked at compile time, any syntax
error is reported earlier. Therefore, if your code is invariant and both
GBK::eval $expr and GBK::eval { block } will suit your purposes equally
well, the { block } form is preferred. For example:

    # make divide-by-zero nonfatal
    GBK::eval { $answer = $a / $b; };
    warn $@ if $@;

    # same thing, but less efficient if run multiple times
    GBK::eval '$answer = $a / $b';
    warn $@ if $@;

    # a compile-time syntax error (not trapped)
    GBK::eval { $answer = }; # WRONG

    # a runtime syntax error
    GBK::eval '$answer =';   # sets $@

Here, the code in the { block } has to be valid JPerl code to make it past
the compile phase. The code in the $expr doesn't get examined until runtime,
so it doesn't cause an error until runtime.

Using the GBK::eval { block } form as an exception trap in libraries does
have some issues. Due to the current arguably broken state of __DIE__ hooks,
you may wish not to trigger any __DIE__ hooks that user code may have
installed. You can use the local $SIG{__DIE__} construct for this purpose,
as this example shows:

    # a private exception trap for divide-by-zero
    GBK::eval { local $SIG{'__DIE__'}; $answer = $a / $b; };
    warn $@ if $@;

This is especially significant, given that __DIE__ hooks can call die again,
which has the effect of changing their error messages:

    # __DIE__ hooks may modify error messages
    {
        local $SIG{'__DIE__'} =
            sub { (my $x = $_[0]) =~ s/foo/bar/g; die $x };
        GBK::eval { die "foo lives here" };
        print $@ if $@;                # prints "bar lives here"
    }

Because this promotes action at a distance, this counterintuitive behavior
may be fixed in a future release.

With an GBK::eval, you should be especially careful to remember what's being
looked at when:

    GBK::eval $x;        # CASE 1
    GBK::eval "$x";      # CASE 2

    GBK::eval '$x';      # CASE 3
    GBK::eval { $x };    # CASE 4

    GBK::eval "\$$x++";  # CASE 5
    $$x++;                # CASE 6

CASEs 1 and 2 above behave identically: they run the code contained in the
variable $x. (Although CASE 2 has misleading double quotes making the reader
wonder what else might be happening (nothing is).) CASEs 3 and 4 likewise
behave in the same way: they run the code '$x' , which does nothing but return
the value of $x. (CASE 4 is preferred for purely visual reasons, but it also
has the advantage of compiling at compile-time instead of at run-time.) CASE 5
is a place where normally you would like to use double quotes, except that in
this particular situation, you can just use symbolic references instead, as
in CASE 6.

Before Perl 5.14, the assignment to $@ occurred before restoration of
localized variables, which means that for your code to run on older versions,
a temporary is required if you want to mask some but not all errors:

    # alter $@ on nefarious repugnancy only
    {
        my $e;
        {
            local $@; # protect existing $@
            GBK::eval { test_repugnancy() };
            # $@ =~ /nefarious/ and die $@; # Perl 5.14 and higher only
            $@ =~ /nefarious/ and $e = $@;
        }
        die $e if defined $e
    }

The block of GBK::eval { block } does not count as a loop, so the loop
control statements next, last, or redo cannot be used to leave or restart the
block.

Filename Globbing

@glob = glob($expr);
$glob = glob($expr);
@glob = glob;
$glob = glob;
@glob = <*>;
$glob = <*>;

Performs filename expansion (globbing) on $expr, returning the next successive
name on each call. If $expr is omitted, $_ is globbed instead.

This operator is implemented via the Egbk::glob() subroutine. See Egbk::glob
of Egbk.pm for details.

Byte-Oriented Functions

Chop Byte String

$byte = CORE::chop($string);
$byte = CORE::chop(@list);
$byte = CORE::chop;

This function chops off the last byte of a string variable and returns the
byte chopped. The CORE::chop operator is used primarily to remove the newline
from the end of an input record, and is more efficient than using a
substitution (s/\n$//). If that's all you're doing, then it would be safer to
use chomp, since CORE::chop always shortens the string no matter what's there,
and chomp is more selective.

You cannot CORE::chop a literal, only a variable.

If you CORE::chop a @list of variables, each string in the list is chopped:

@lines = `cat myfile`;
CORE::chop @lines;

You can CORE::chop anything that is an lvalue, including an assignment:

CORE::chop($cwd = `pwd`);
CORE::chop($answer = <STDIN>);

This is different from:

$answer = CORE::chop($temp = <STDIN>); # WRONG

which puts a newline into $answer because CORE::chop returns the byte chopped,
not the remaining string (which is in $tmp). One way to get the result
intended here is with substr:

$answer = substr <STDIN>, 0, -1;

But this is more commonly written as:

CORE::chop($answer = <STDIN>);

In the most general case, CORE::chop can be expressed in terms of substr:

$last_byte = CORE::chop($var);
$last_byte = substr($var, -1, 1, ""); # same thing

Once you understand this equivalence, you can use it to do bigger chops. To
CORE::chop more than one byte, use substr as an lvalue, assigning a null
string. The following removes the last five bytes of $caravan:

substr($caravan, -5) = "";

The negative subscript causes substr to count from the end of the string
instead of the beginning. If you wanted to save the bytes so removed, you
could use the four-argument form of substr, creating something of a quintuple
CORE::chop:

$tail = substr($caravan, -5, 5, "");

If no argument is given, the function chops the $_ variable.

Ordinal Value of Byte

$ord = CORE::ord($expr);

This function returns the numeric value of the first byte of $expr, regardless
of "use GBK qw(ord);" exists or not. If $expr is omitted, it uses $_.
The return value is always unsigned.

If you want a signed value, use unpack('c',$expr). If you want all the bytes of
the string converted to a list of numbers, use unpack('C*',$expr) instead.

Reverse List or Byte String

@reverse = CORE::reverse(@list);
$reverse = CORE::reverse(@list);

In list context, this function returns a list value consisting of the elements
of @list in the opposite order.

In scalar context, the function concatenates all the elements of @list and then
returns the reverse of that resulting string, byte by byte, regardless of
"use GBK qw(reverse);" exists or not.

Returns Next Byte

$getc = CORE::getc(FILEHANDLE);
$getc = CORE::getc($filehandle);
$getc = CORE::getc;

This function returns the next byte from the input file attached to FILEHANDLE.
It returns undef at end-of-file, or if an I/O error was encountered. If
FILEHANDLE is omitted, the function reads from STDIN.

This function is somewhat slow, but it's occasionally useful for single-byte
input from the keyboard -- provided you manage to get your keyboard input
unbuffered. This function requests unbuffered input from the standard I/O library.
Unfortunately, the standard I/O library is not so standard as to provide a portable
way to tell the underlying operating system to supply unbuffered keyboard input to
the standard I/O system. To do that, you have to be slightly more clever, and in
an operating-system-dependent fashion. Under Unix you might say this:

if ($BSD_STYLE) {
    system "stty cbreak </dev/tty >/dev/tty 2>&1";
}
else {
    system "stty", "-icanon", "eol", "\001";
}

$key = CORE::getc;

if ($BSD_STYLE) {
    system "stty -cbreak </dev/tty >/dev/tty 2>&1";
}
else {
    system "stty", "icanon", "eol", "^@"; # ASCII NUL
}
print "\n";

This code puts the next single-byte typed on the terminal in the string $key.
If your stty program has options like cbreak, you'll need to use the code where
$BSD_STYLE is true. Otherwise, you'll need to use the code where it is false.

Index by Byte String

$index = CORE::index($string,$substring,$offset);
$index = CORE::index($string,$substring);

This function searches for one byte string within another. It returns the position
of the first occurrence of $substring in $string. The $offset, if specified, says
how many bytes from the start to skip before beginning to look. Positions are based
at 0. If the substring is not found, the function returns one less than the base,
ordinarily -1. To work your way through a string, you might say:

$pos = -1;
while (($pos = CORE::index($string, $lookfor, $pos)) > -1) {
    print "Found at $pos\n";
    $pos++;
}

Rindex by Byte String

$rindex = CORE::rindex($string,$substring,$offset);
$rindex = CORE::rindex($string,$substring);

This function works just like CORE::index except that it returns the position of
the last occurrence of $substring in $string (a reverse CORE::index). The function
returns -1 if not $substring is found. $offset, if specified, is the rightmost
position that may be returned. To work your way through a string backward, say:

$pos = CORE::length($string);
while (($pos = CORE::rindex($string, $lookfor, $pos)) >= 0) {
    print "Found at $pos\n";
    $pos--;
}

Yada Yada Operator (GBK software provides)

The yada yada operator (noted ...) is a placeholder for code. Perl parses it
without error, but when you try to execute a yada yada, it throws an exception
with the text Unimplemented:

sub unimplemented { ... }
eval { unimplemented() };
if ( $@ eq 'Unimplemented' ) {
    print "I found the yada yada!\n";
}

You can only use the yada yada to stand in for a complete statement. These
examples of the yada yada work:

{ ... }
sub foo { ... }
...;
eval { ... };
sub foo {
    my( $self ) = shift;
    ...;
}
do { my $n; ...; print 'Hurrah!' };

The yada yada cannot stand in for an expression that is part of a larger statement
since the ... is also the three-dot version of the range operator
(see "Range Operators"). These examples of the yada yada are still syntax errors:

print ...;
open my($fh), '>', '/dev/passwd' or ...;
if ( $condition && ... ) { print "Hello\n" };

There are some cases where Perl can't immediately tell the difference between an
expression and a statement. For instance, the syntax for a block and an anonymous
hash reference constructor look the same unless there's something in the braces that
give Perl a hint. The yada yada is a syntax error if Perl doesn't guess that the
{ ... } is a block. In that case, it doesn't think the ... is the yada yada because
it's expecting an expression instead of a statement:

my @transformed = map { ... } @input;  # syntax error

You can use a ; inside your block to denote that the { ... } is a block and not a
hash reference constructor. Now the yada yada works:

my @transformed = map {; ... } @input; # ; disambiguates
my @transformed = map { ...; } @input; # ; disambiguates

Un-Escaping bytes::* Subroutines (GBK software provides)

GBK software removes 'bytes::' at head of subroutine name.

---------------------------------------
Before           After     Works as
---------------------------------------
bytes::chr       chr       Byte
bytes::index     index     Byte
bytes::length    length    Byte
bytes::ord       ord       Byte
bytes::rindex    rindex    Byte
bytes::substr    substr    Byte
---------------------------------------

Ignore Pragmas and Modules

-----------------------------------------------------------
Before                    After
-----------------------------------------------------------
use strict;               use strict; no strict qw(refs);
use 5.12.0;               use 5.12.0; no strict qw(refs);
require utf8;             # require utf8;
require bytes;            # require bytes;
require charnames;        # require charnames;
require I18N::Japanese;   # require I18N::Japanese;
require I18N::Collate;    # require I18N::Collate;
require I18N::JExt;       # require I18N::JExt;
require File::DosGlob;    # require File::DosGlob;
require Wild;             # require Wild;
require Wildcard;         # require Wildcard;
require Japanese;         # require Japanese;
use utf8;                 # use utf8;
use bytes;                # use bytes;
use charnames;            # use charnames;
use I18N::Japanese;       # use I18N::Japanese;
use I18N::Collate;        # use I18N::Collate;
use I18N::JExt;           # use I18N::JExt;
use File::DosGlob;        # use File::DosGlob;
use Wild;                 # use Wild;
use Wildcard;             # use Wildcard;
use Japanese;             # use Japanese;
no utf8;                  # no utf8;
no bytes;                 # no bytes;
no charnames;             # no charnames;
no I18N::Japanese;        # no I18N::Japanese;
no I18N::Collate;         # no I18N::Collate;
no I18N::JExt;            # no I18N::JExt;
no File::DosGlob;         # no File::DosGlob;
no Wild;                  # no Wild;
no Wildcard;              # no Wildcard;
no Japanese;              # no Japanese;
-----------------------------------------------------------

Comment out pragma to ignore utf8 environment, and Egbk.pm provides these
functions.

Dummy utf8::upgrade

$num_octets = utf8::upgrade($string);

Returns the number of octets necessary to represent the string.

Dummy utf8::downgrade

$success = utf8::downgrade($string[, FAIL_OK]);

Returns true always.

Dummy utf8::encode

utf8::encode($string);

Returns nothing.

Dummy utf8::decode

$success = utf8::decode($string);

Returns true always.

Dummy utf8::is_utf8

$flag = utf8::is_utf8(STRING);

Returns false always.

Dummy utf8::valid

$flag = utf8::valid(STRING);

Returns true always.

Dummy bytes::chr
```
This subroutine is same as chr.
```
Dummy bytes::index
```
This subroutine is same as index.
```
Dummy bytes::length
```
This subroutine is same as length.
```
Dummy bytes::ord
```
This subroutine is same as ord.
```
Dummy bytes::rindex
```
This subroutine is same as rindex.
```
Dummy bytes::substr
```
This subroutine is same as substr.
```

Environment Variable

This software uses the flock function for exclusive control. The execution of the
program is blocked until it becomes possible to read or write the file.
You can have it not block in the flock function by defining environment variable
CHAR_NONBLOCK.

Example:

  SET CHAR_NONBLOCK=1

(The value '1' doesn't have the meaning)

BUGS, LIMITATIONS, and COMPATIBILITY

I have tested and verified this software using the best of my ability. However, a software containing much regular expression is bound to contain some bugs. Thus, if you happen to find a bug that's in GBK software and not your own program, you can try to reduce it to a minimal test case and then report it to the following author's address. If you have an idea that could make this a more useful tool, please let everyone share it.

(dummy item to avoid Test::Pod error)
format

Function "format" can't handle multiple-octet code same as original Perl.
cloister of regular expression

The cloister (?s) and (?i) of a regular expression will not be implemented for the time being. Cloister (?s) can be substituted with the .(dot) and \N on /s modifier. Cloister (?i) can be substituted with \F...\E.
chdir

Function chdir() can always be executed with perl5.005.

There are the following limitations for DOS-like system(any of MSWin32, NetWare, symbian, dos).

On perl5.006 or perl5.00800, if path is ended by chr(0x5C), it needs jacode.pl library.

On perl5.008001 or later, perl5.010, perl5.012, perl5.014, perl5.016, perl5.018, perl5.020, perl5.022, perl5.024, perl5.026, perl5.028 if path is ended by chr(0x5C), chdir succeeds when a short path name (8dot3name) can be acquired according to COMMAND.COM or cmd.exe or Win95Cmd.exe. However, leaf-subdirectory of the current directory is a short path name (8dot3name).
```
see also,
Bug #81839
chdir does not work with chr(0x5C) at end of path
http://bugs.activestate.com/show_bug.cgi?id=81839
```
GBK::substr as Lvalue

If Perl version is older than 5.14, GBK::substr differs from CORE::substr, and cannot be used as a lvalue. To change part of a string, you need use the optional fourth argument which is the replacement string.

GBK::substr($string, 13, 4, "JPerl");

Special Variables $` and $& need /( Capture All )/

Because $` and $& use $1.

-------------------------------------------------------------------------------------------
Before          After                Works as
-------------------------------------------------------------------------------------------
$`              Egbk::PREMATCH()    CORE::substr($&,0,CORE::length($&)-CORE::length($1))
${`}            Egbk::PREMATCH()    CORE::substr($&,0,CORE::length($&)-CORE::length($1))
$PREMATCH       Egbk::PREMATCH()    CORE::substr($&,0,CORE::length($&)-CORE::length($1))
${^PREMATCH}    Egbk::PREMATCH()    CORE::substr($&,0,CORE::length($&)-CORE::length($1))
$&              Egbk::MATCH()       $1
${&}            Egbk::MATCH()       $1
$MATCH          Egbk::MATCH()       $1
${^MATCH}       Egbk::MATCH()       $1
$'              $'                   $'
${'}            ${'}                 $'
$POSTMATCH      Egbk::POSTMATCH()   $'
${^POSTMATCH}   Egbk::POSTMATCH()   $'
-------------------------------------------------------------------------------------------

Limitation of Regular Expression

This software has limitation from \G in multibyte anchoring. Only the following Perl can treat the character string which exceeds 32766 octets with a regular expression.

perl 5.6 or later --- ActivePerl on MSWin32

perl 5.10.1 or later --- other Perl

see also,

In 5.10.0, the * quantifier in patterns was sometimes treated as {0,32767}
http://perldoc.perl.org/perl5101delta.html

[perl #116379] \G can't treat over 32767 octet
http://www.nntp.perl.org/group/perl.perl5.porters/2013/01/msg197320.html

perlre - Perl regular expressions
http://perldoc.perl.org/perlre.html

perlre length limit
http://stackoverflow.com/questions/4592467/perlre-length-limit

Japanese Document
GBK/JA.pm

Empty Variable in Regular Expression

Unlike literal null string, an interpolated variable evaluated to the empty string can't use the most recent pattern from a previous successful regular expression.
Limitation of ?? and m??

Multibyte character needs ( ) which is before {n,m}, {n,}, {n}, *, and + in ?? or m??. As a result, you need to rewrite a script about $1,$2,$3,... You cannot use (?: ) ?, {n,m}?, {n,}?, and {n}? in ?? and m??, because delimiter of m?? is '?'.
Look-behind Assertion

The look-behind assertion like (?<=[A-Z]) is not prevented from matching trail octet of the previous multiple-octet code.
Modifier /a /d /l and /u of Regular Expression

The concept of this software is not to use two or more encoding methods as literal string and literal of regexp in one Perl script. Therefore, modifier /a, /d, /l, and /u are not supported. \d means [0-9] universally.
Named Character

A named character, such \N{GREEK SMALL LETTER EPSILON}, \N{greek:epsilon}, or \N{epsilon} is not supported.
Unicode Properties (aka Character Properties) of Regular Expression

Unicode properties (aka character properties) of regexp are not available. Also (?[]) in regexp of Perl 5.18 is not available. There is no plans to currently support these.
${^WIN32_SLOPPY_STAT} is ignored

Even if ${^WIN32_SLOPPY_STAT} is set to a true value, file test functions Egbk::*(), Egbk::lstat(), and Egbk::stat() on Microsoft Windows open the file for the path which has chr(0x5c) at end.
Delimiter of String and Regexp

qq//, q//, qw//, qx//, qr//, m//, s///, tr///, and y/// can't use a wide character as the delimiter.

\b{...} Boundaries in Regular Expressions

Following \b{...} available starting in v5.22 are not supported.

\b{gcb} or \b{g}   Unicode "Grapheme Cluster Boundary"
\b{sb}             Unicode "Sentence Boundary"
\b{wb}             Unicode "Word Boundary"
\B{gcb} or \B{g}   Unicode "Grapheme Cluster Boundary" doesn't match
\B{sb}             Unicode "Sentence Boundary" doesn't match
\B{wb}             Unicode "Word Boundary" doesn't match

AUTHOR

INABA Hitoshi <ina@cpan.org>

This project was originated by INABA Hitoshi.

LICENSE AND COPYRIGHT

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

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

My Goal

P.401 See chapter 15: Unicode of ISBN 0-596-00027-8 Programming Perl Third Edition.

Before the introduction of Unicode support in perl, The eq operator just compared the byte-strings represented by two scalars. Beginning with perl 5.8, eq compares two byte-strings with simultaneous consideration of the UTF8 flag.

/* You are not expected to understand this */

 Information processing model beginning with perl 5.8

   +----------------------+---------------------+
   |     Text strings     |                     |
   +----------+-----------|    Binary strings   |
   |  UTF-8   |  Latin-1  |                     |
   +----------+-----------+---------------------+
   | UTF8     |            Not UTF8             |
   | Flagged  |            Flagged              |
   +--------------------------------------------+
   http://perl-users.jp/articles/advent-calendar/2010/casual/4

 Confusion of Perl string model is made from double meanings of
 "Binary string."
 Meanings of "Binary string"
 1. Non-Text string
 2. Digital octet string

 Let's draw again using those term.

   +----------------------+---------------------+
   |     Text strings     |                     |
   +----------+-----------|   Non-Text strings  |
   |  UTF-8   |  Latin-1  |                     |
   +----------+-----------+---------------------+
   | UTF8     |            Not UTF8             |
   | Flagged  |            Flagged              |
   +--------------------------------------------+
   |            Digital octet string            |
   +--------------------------------------------+

There are people who don't agree to change in the character string processing model of Perl 5.8. It is impossible to get to agree it to majority of Perl user who hardly ever use Perl. How to solve it by returning to a original method, let's drag out page 402 of the old dusty Programming Perl, 3rd ed. again.

Information processing model beginning with perl3 or this software
of UNIX/C-ism.

  +--------------------------------------------+
  |    Text string as Digital octet string     |
  |    Digital octet string as Text string     |
  +--------------------------------------------+
  |       Not UTF8 Flagged, No Mojibake        |
  +--------------------------------------------+

In UNIX Everything is a File
- In UNIX everything is a stream of bytes
- In UNIX the filesystem is used as a universal name space

Native Encoding Scripting
- native encoding of file contents
- native encoding of file name on filesystem
- native encoding of command line
- native encoding of environment variable
- native encoding of API
- native encoding of network packet
- native encoding of database

Ideally, I'd like to achieve these five Goals:

Goal #1:

Old byte-oriented programs should not spontaneously break on the old byte-oriented data they used to work on.

This goal has been achieved by that this software is additional code for perl like utf8 pragma. Perl should work same as past Perl if added nothing.

Goal #2:

Old byte-oriented programs should magically start working on the new character-oriented data when appropriate.

Still now, 1 octet is counted with 1 by built-in functions length, substr, index, rindex, and pos that handle length and position of string. In this part, there is no change. The length of 1 character of 2 octet code is 2.

On the other hand, the regular expression in the script is added the multibyte anchoring processing with this software, instead of you.

figure of Goal #1 and Goal #2.

                         GOAL#1  GOAL#2
                  (a)     (b)     (c)     (d)     (e)
+--------------+-------+-------+-------+-------+-------+
| data         |  Old  |  Old  |  New  |  Old  |  New  |
+--------------+-------+-------+-------+-------+-------+
| script       |  Old  |      Old      |      New      |
+--------------+-------+---------------+---------------+
| interpreter  |  Old  |              New              |
+--------------+-------+-------------------------------+
Old --- Old byte-oriented
New --- New character-oriented

There is a combination from (a) to (e) in data, script, and interpreter of old and new. Let's add the Encode module and this software did not exist at time of be written this document and JPerl did exist.

                  (a)     (b)     (c)     (d)     (e)
                                JPerl,japerl    Encode,GBK
+--------------+-------+-------+-------+-------+-------+
| data         |  Old  |  Old  |  New  |  Old  |  New  |
+--------------+-------+-------+-------+-------+-------+
| script       |  Old  |      Old      |      New      |
+--------------+-------+---------------+---------------+
| interpreter  |  Old  |              New              |
+--------------+-------+-------------------------------+
Old --- Old byte-oriented
New --- New character-oriented

The reason why JPerl is very excellent is that it is at the position of (c). That is, it is not necessary to do a special description to the script to process new character-oriented string. (May the japerl take over JPerl!)

Goal #3:

Programs should run just as fast in the new character-oriented mode as in the old byte-oriented mode.

It is impossible. Because the following time is necessary.

(1) Time of escape script for old byte-oriented perl.

(2) Time of processing regular expression by escaped script while multibyte anchoring.

Someday, I want to ask Larry Wall about this goal in the elevator.
Goal #4:

Perl should remain one language, rather than forking into a byte-oriented Perl and a character-oriented Perl.

JPerl remains one Perl language by forking to two interpreters. However, the Perl core team did not desire fork of the interpreter. As a result, Perl language forked contrary to goal #4.

A character-oriented perl is not necessary to make it specially, because a byte-oriented perl can already treat the binary data. This software is only an application program of byte-oriented Perl, a filter program.

And you will get support from the Perl community, when you solve the problem by the Perl script.

GBK software remains one language and one interpreter.
Goal #5:

JPerl users will be able to maintain JPerl by Perl.

May the JPerl be with you, always.

Back when Programming Perl, 3rd ed. was written, UTF8 flag was not born and Perl is designed to make the easy jobs easy. This software provides programming environment like at that time.

Perl's motto

  Some computer scientists (the reductionists, in particular) would
 like to deny it, but people have funny-shaped minds. Mental geography
 is not linear, and cannot be mapped onto a flat surface without
 severe distortion. But for the last score years or so, computer
 reductionists have been first bowing down at the Temple of Orthogonality,
 then rising up to preach their ideas of ascetic rectitude to any who
 would listen.

  Their fervent but misguided desire was simply to squash your mind to
 fit their mindset, to smush your patterns of thought into some sort of
 Hyperdimensional Flatland. It's a joyless existence, being smushed.
 --- Learning Perl on Win32 Systems

 If you think this is a big headache, you're right. No one likes
 this situation, but Perl does the best it can with the input and
 encodings it has to deal with. If only we could reset history and
 not make so many mistakes next time.
 --- Learning Perl 6th Edition

  The most important thing for most people to know about handling
 Unicode data in Perl, however, is that if you don't ever use any Uni-
 code data -- if none of your files are marked as UTF-8 and you don't
 use UTF-8 locales -- then you can happily pretend that you're back in
 Perl 5.005_03 land; the Unicode features will in no way interfere with
 your code unless you're explicitly using them. Sometimes the twin
 goals of embracing Unicode but not disturbing old-style byte-oriented
 scripts has led to compromise and confusion, but it's the Perl way to
 silently do the right thing, which is what Perl ends up doing.
 --- Advanced Perl Programming, 2nd Edition

ACKNOWLEDGEMENTS

This software was made referring to software and the document that the following hackers or persons had made. I am thankful to all persons.

Rick Yamashita, Shift_JIS
ttp://furukawablog.spaces.live.com/Blog/cns!1pmWgsL289nm7Shn7cS0jHzA!2225.entry (dead link)
ttp://shino.tumblr.com/post/116166805/1981-us-jis
(add 'h' at head)
http://www.wdic.org/w/WDIC/%E3%82%B7%E3%83%95%E3%83%88JIS

Larry Wall, Perl
http://www.perl.org/

Kazumasa Utashiro, jcode.pl
http://search.cpan.org/~utashiro/
ftp://ftp.iij.ad.jp/pub/IIJ/dist/utashiro/perl/
http://log.utashiro.com/pub/2006/07/jkondo_a580.html

Jeffrey E. F. Friedl, Mastering Regular Expressions
http://regex.info/

SADAHIRO Tomoyuki, The right way of using Shift_JIS
http://homepage1.nifty.com/nomenclator/perl/shiftjis.htm
http://search.cpan.org/~sadahiro/

Yukihiro "Matz" Matsumoto, YAPC::Asia2006 Ruby on Perl(s)
http://www.rubyist.net/~matz/slides/yapc2006/

jscripter, For jperl users
http://homepage1.nifty.com/kazuf/jperl.html

Bruce., Unicode in Perl
http://www.rakunet.org/tsnet/TSabc/18/546.html

Hiroaki Izumi, Perl5.8/Perl5.10 is not useful on the Windows.
http://dl.dropbox.com/u/23756062/perlwin.html
https://sites.google.com/site/hiroa63iz/perlwin

TSUKAMOTO Makio, Perl memo/file path of Windows
http://digit.que.ne.jp/work/wiki.cgi?Perl%E3%83%A1%E3%83%A2%2FWindows%E3%81%A7%E3%81%AE%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%83%91%E3%82%B9

chaichanPaPa, Matching Shift_JIS file name
http://d.hatena.ne.jp/chaichanPaPa/20080802/1217660826

SUZUKI Norio, Jperl
http://homepage2.nifty.com/kipp/perl/jperl/

WATANABE Hirofumi, Jperl
http://www.cpan.org/src/5.0/jperl/
http://search.cpan.org/~watanabe/
ftp://ftp.oreilly.co.jp/pcjp98/watanabe/jperlconf.ppt

Chuck Houpt, Michiko Nozu, MacJPerl
http://habilis.net/macjperl/index.j.html

Kenichi Ishigaki, Pod-PerldocJp, Welcome to modern Perl world
http://search.cpan.org/dist/Pod-PerldocJp/
http://gihyo.jp/dev/serial/01/modern-perl/0031
http://gihyo.jp/dev/serial/01/modern-perl/0032
http://gihyo.jp/dev/serial/01/modern-perl/0033

Fuji, Goro (gfx), Perl Hackers Hub No.16
http://gihyo.jp/dev/serial/01/perl-hackers-hub/001602

Dan Kogai, Encode module
http://search.cpan.org/dist/Encode/
http://www.archive.org/details/YAPCAsia2006TokyoPerl58andUnicodeMythsFactsandChanges (video)
http://yapc.g.hatena.ne.jp/jkondo/ (audio)

Takahashi Masatuyo, JPerl Wiki
http://ja.jperl.wikia.com/wiki/JPerl_Wiki

Juerd, Perl Unicode Advice
http://juerd.nl/site.plp/perluniadvice

daily dayflower, 2008-06-25 perluniadvice
http://d.hatena.ne.jp/dayflower/20080625/1214374293

Unicode issues in Perl
http://www.i-programmer.info/programming/other-languages/1973-unicode-issues-in-perl.html

Jesse Vincent, Compatibility is a virtue
http://www.nntp.perl.org/group/perl.perl5.porters/2010/05/msg159825.html

Tokyo-pm archive
http://mail.pm.org/pipermail/tokyo-pm/
http://mail.pm.org/pipermail/tokyo-pm/1999-September/001844.html
http://mail.pm.org/pipermail/tokyo-pm/1999-September/001854.html

Error: Runtime exception on jperl 5.005_03
http://www.rakunet.org/tsnet/TSperl/12/374.html
http://www.rakunet.org/tsnet/TSperl/12/375.html
http://www.rakunet.org/tsnet/TSperl/12/376.html
http://www.rakunet.org/tsnet/TSperl/12/377.html
http://www.rakunet.org/tsnet/TSperl/12/378.html
http://www.rakunet.org/tsnet/TSperl/12/379.html
http://www.rakunet.org/tsnet/TSperl/12/380.html
http://www.rakunet.org/tsnet/TSperl/12/382.html

ruby-list
http://blade.nagaokaut.ac.jp/ruby/ruby-list/index.shtml
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/2440
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/2446
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/2569
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/9427
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/9431
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/10500
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/10501
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/10502
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/12385
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/12392
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/12393
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/19156

Object-oriented with Perl
http://www.freeml.com/perl-oo/486
http://www.freeml.com/perl-oo/487
http://www.freeml.com/perl-oo/490
http://www.freeml.com/perl-oo/491
http://www.freeml.com/perl-oo/492
http://www.freeml.com/perl-oo/494
http://www.freeml.com/perl-oo/514

To install GBK, copy and paste the appropriate command in to your terminal.

cpanm

cpanm GBK

CPAN shell

perl -MCPAN -e shell
install GBK

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)