Data::Table::Text - Write data in tabular text format.
use Data::Table::Text;
# Print a table:
my $d = [[qq(a), qq(b\nbb), qq(c\ncc\nccc\n)], [qq(1), qq(1\n22), qq(1\n22\n333\n)], ]; my $t = formatTable($d, [qw(A BB CCC)]); ok $t eq <<END; A BB CCC 1 a b c bb cc ccc 2 1 1 1 22 22 333 END
# Print a table containing tables and make it into a report:
my $D = [[qq(See the\ntable\nopposite), $t], [qq(Or\nthis\none), $t], ]; my $T = formatTable($D, [qw(Description Table)], head=><<END); Table of Tables. Table has NNNN rows each of which contains a table. END ok $T eq <<END; Table of Tables. Table has 2 rows each of which contains a table. Description Table 1 See the A BB CCC table 1 a b c opposite bb cc ccc 2 1 1 1 22 22 333 2 Or A BB CCC this 1 a b c one bb cc ccc 2 1 1 1 22 22 333 END
# Print an array of arrays:
my $aa = formatTable ([[qw(A B C )], [qw(AA BB CC )], [qw(AAA BBB CCC)], [qw(1 22 333)]], [qw (aa bb cc)]); ok $aa eq <<END; aa bb cc 1 A B C 2 AA BB CC 3 AAA BBB CCC 4 1 22 333 END
# Print an array of hashes:
my $ah = formatTable ([{aa=> "A", bb => "B", cc => "C" }, {aa=> "AA", bb => "BB", cc => "CC" }, {aa=> "AAA", bb => "BBB", cc => "CCC" }, {aa=> 1, bb => 22, cc => 333 }]); ok $ah eq <<END; aa bb cc 1 A B C 2 AA BB CC 3 AAA BBB CCC 4 1 22 333 END
# Print a hash of arrays:
my $ha = formatTable ({"" => ["aa", "bb", "cc"], "1" => ["A", "B", "C"], "22" => ["AA", "BB", "CC"], "333" => ["AAA", "BBB", "CCC"], "4444" => [1, 22, 333]}, [qw(Key A B C)] ); ok $ha eq <<END; Key A B C aa bb cc 1 A B C 22 AA BB CC 333 AAA BBB CCC 4444 1 22 333 END
# Print a hash of hashes:
my $hh = formatTable ({a => {aa=>"A", bb=>"B", cc=>"C" }, aa => {aa=>"AA", bb=>"BB", cc=>"CC" }, aaa => {aa=>"AAA", bb=>"BBB", cc=>"CCC" }, aaaa => {aa=>1, bb=>22, cc=>333 }}); ok $hh eq <<END; aa bb cc a A B C aa AA BB CC aaa AAA BBB CCC aaaa 1 22 333 END
# Print an array of scalars:
my $a = formatTable(["a", "bb", "ccc", 4], [q(#), q(Col)]); ok $a eq <<END; # Col 0 a 1 bb 2 ccc 3 4 END
# Print a hash of scalars:
my $h = formatTable({aa=>"AAAA", bb=>"BBBB", cc=>"333"}, [qw(Key Title)]); ok $h eq <<END; Key Title aa AAAA bb BBBB cc 333 END
Write data in tabular text format.
Version 20190204.
The following sections describe the methods in each functional area of this module. For an alphabetic listing of all methods by name see Index.
These methods are the ones most likely to be of immediate use to anyone using this module for the first time:
clearFolder
Remove all the files and folders under and including the specified folder as long as the number of files to be removed is less than the specified limit. Sometimes the folder can be emptied but not removed - perhaps because it a link, in this case a message is produced unless suppressed by the optional $nomsg parameter.
dateTimeStamp
Year-monthNumber-day at hours:minute:seconds
filePathExt
Create a file name from an array of file name components the last of which is an extension. Identical to fpe.
fn
Remove path and extension from file name.
formatTable
Format various data structures as a table with titles as specified by $columnTitles: either a reference to an array of column titles or a string each line of which contains the column title as the first word with the rest of the line describing that column.
Optionally create a report from the table using the following optional report %options:
file=>$file the name of a file to write the report to.
head=>$head a header line in which DDDD will be replaced with the data and time and NNNN will be replaced with the number of rows in the table.
foot=>$foot footer text that will be placed immediately after the table.
summarize=>$summarize if true and $data is an array of arrays, then each column of the will be summarized by printing its distinct values and a count of how often each value occurs in a series of smaller tables following the main table.
wide=>$widewrite a note explaining the need to scroll to the right if true.
msg=>$msg if true a summary of the situation will be written to STDERR including the first line of the header and the file being written to.
zero=>$zero if true the report will be written to the specified file even if the report is empty.
Parameters:
genHash
Return a $blessed hash with the specified $attributes accessible via lvalue method calls. updateDocumentation will generate documentation at "Hash Definitions" for the hash defined by the call to genHash if the call is laid out as in the example below.
newProcessStarter
Create a new process starter with which to start parallel processes up to a specified $maximumNumberOfProcesses maximum number of parallel processes at a time, wait for all the started processes to finish and then optionally retrieve their saved results as an array from the folder named by $transferArea.
readFile
Read a file containing unicode in utf8.
searchDirectoryTreesForMatchingFiles
Search the specified directory trees for the files (not folders) that match the specified extensions. The argument list should include at least one path name to be useful. If no file extension is supplied then all the files below the specified paths are returned.
sumAbsAndRel
Combine zero or more absolute and relative file names
writeFile
Write a unicode utf8 string to a new file that does not already exist after creating a path to the file if necessary and return the name of the file on success else confess if a problem occurred or the file already exists.
xxx
Execute a shell command optionally checking its response. The command to execute is specified as one or more strings which are joined together after removing any new lines. Optionally the last string can be a regular expression that is used to test any non blank output generated by the execution of the command: if the regular expression fails the command and the command output are printed, else it is suppressed as being uninteresting. If such a regular expression is not supplied then the command and its non blank output lines are always printed.
Date and timestamps as used in logs of long running commands.
Example:
ok 𝗱𝗮𝘁𝗲𝗧𝗶𝗺𝗲𝗦𝘁𝗮𝗺𝗽 =~ m(\A\d{4}-\d\d-\d\d at \d\d:\d\d:\d\d\Z);
Date time stamp without white space.
ok 𝗱𝗮𝘁𝗲𝗧𝗶𝗺𝗲𝗦𝘁𝗮𝗺𝗽𝗡𝗮𝗺𝗲 =~ m(\A_on_\d{4}_\d\d_\d\d_at_\d\d_\d\d_\d\d\Z);
Year-monthName-day
ok 𝗱𝗮𝘁𝗲𝗦𝘁𝗮𝗺𝗽 =~ m(\A\d{4}-\w{3}-\d\d\Z);
YYYYmmdd-HHMMSS
ok 𝘃𝗲𝗿𝘀𝗶𝗼𝗻𝗖𝗼𝗱𝗲 =~ m(\A\d{8}-\d{6}\Z);
YYYY-mm-dd-HH:MM:SS
ok 𝘃𝗲𝗿𝘀𝗶𝗼𝗻𝗖𝗼𝗱𝗲𝗗𝗮𝘀𝗵𝗲𝗱 =~ m(\A\d{4}-\d\d-\d\d-\d\d:\d\d:\d\d\Z);
hours:minute:seconds
ok 𝘁𝗶𝗺𝗲𝗦𝘁𝗮𝗺𝗽 =~ m(\A\d\d:\d\d:\d\d\Z);
Micro seconds since unix epoch.
ok 𝗺𝗶𝗰𝗿𝗼𝗦𝗲𝗰𝗼𝗻𝗱𝘀𝗦𝗶𝗻𝗰𝗲𝗘𝗽𝗼𝗰𝗵 > 47*365*24*60*60*1e6;
Various ways of processing commands and writing results.
Confess a message with a line position and a file that Geany will jump to if clicked on.
Parameter Description 1 $line Line 2 $file File 3 @m Messages
𝗳𝗳𝗳 __LINE__, __FILE__, "Hello world";
Log messages including the project name if available. This method is not merged as we need to retain its prototype.
Parameter Description 1 @m Messages
𝗹𝗹𝗹 "Hello world";
Parameter Description 1 @cmd Command to execute followed by an optional regular expression to test the results
{ok 𝘅𝘅𝘅("echo aaa") =~ /aaa/;
Execute a block of shell commands line by line after removing comments - stop if there is a non zero return code from any command.
Parameter Description 1 $cmd Commands to execute separated by new lines
ok !𝘆𝘆𝘆 <<END; echo aaa echo bbb END
Execute lines of commands after replacing new lines with && then check that the pipeline execution results in a return code of zero and that the execution results match the optional regular expression if one has been supplied; confess() to an error if either check fails. To execute remotely, add "ssh ... 'echo start" as the first line and "echo end'" as the last line with the commands to be executed on the lines in between.
Parameter Description 1 $cmd Commands to execute - one per line with no trailing && 2 $success Optional regular expression to check for acceptable results 3 $returnCode Optional regular expression to check the acceptable return codes 4 $message Message of explanation if any of the checks fail
ok 𝘇𝘇𝘇(<<END, qr(aaa\s*bbb)s); echo aaa echo bbb END
Classify the specified array of words referred to by $args into positional and keyword parameters, call the specified sub with a reference to an array of positional parameters followed by a reference to a hash of keywords and their values then return the value returned by this sub. The keywords names will be validated if $valid is either a reference to an array of valid keywords names or a hash of valid keyword names => textual descriptions. Confess with a table of valid keywords definitions if the $valid keywords are specified and an invalid one is presented.
Parameter Description 1 $sub Sub to call 2 $args List of arguments to parse 3 $valid Optional list of valid parameters else all parameters will be accepted
my $r = 𝗽𝗮𝗿𝘀𝗲𝗖𝗼𝗺𝗺𝗮𝗻𝗱𝗟𝗶𝗻𝗲𝗔𝗿𝗴𝘂𝗺𝗲𝗻𝘁𝘀 {[@_]} [qw( aaa bbb -c --dd --eee=EEEE -f=F), q(--gg=g g), q(--hh=h h)]; is_deeply $r, [["aaa", "bbb"], {c=>undef, dd=>undef, eee=>"EEEE", f=>"F", gg=>"g g", hh=>"h h"}, ];
Call the specified sub in a separate process, wait for it to complete, copy back the named our variables, free the memory used.
Parameter Description 1 $sub Sub to call 2 @our Our variable names with preceding sigils to copy back
ˢ{our $a = q(1); our @a = qw(1); our %a = (a=>1); our $b = q(1); for(2..4) { 𝗰𝗮𝗹𝗹 {$a = $_ x 1e3; $a[0] = $_ x 1e2; $a{a} = $_ x 1e1; $b = 2;} qw($a @a %a); ok $a == $_ x 1e3; ok $a[0] == $_ x 1e2; ok $a{a} == $_ x 1e1; ok $b == 1; } };
Operations on files and paths.
Information about each file.
Get the size of a file.
Parameter Description 1 $file File name
my $f = writeFile("zzz.data", "aaa"); ok 𝗳𝗶𝗹𝗲𝗦𝗶𝘇𝗲($f) == 3;
Get the Md5 sum for a file or string
Parameter Description 1 $file File or string
𝗳𝗶𝗹𝗲𝗠𝗱𝟱𝗦𝘂𝗺(q(/etc/hosts)); if (1) { ok 𝗳𝗶𝗹𝗲𝗠𝗱𝟱𝗦𝘂𝗺(join '', 1..100) eq q(ef69caaaeea9c17120821a9eb6c7f1de); ok guidFromString(join '', 1..100) eq q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de); ok guidFromMd5(𝗳𝗶𝗹𝗲𝗠𝗱𝟱𝗦𝘂𝗺(join('', 1..100))) eq q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de); ok md5FromGuid(q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de)) eq q(ef69caaaeea9c17120821a9eb6c7f1de); } if (1) {ok arraySum (1..10) == 55; ok arrayProduct(1..5) == 120; is_deeply[arrayTimes(2, 1..5)], [qw(2 4 6 8 10)]; }
Create a guid from an md5 hash.
Parameter Description 1 $m Md5 hash
if (1) { ok fileMd5Sum(join '', 1..100) eq q(ef69caaaeea9c17120821a9eb6c7f1de); ok guidFromString(join '', 1..100) eq q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de); ok 𝗴𝘂𝗶𝗱𝗙𝗿𝗼𝗺𝗠𝗱𝟱(fileMd5Sum(join('', 1..100))) eq q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de); ok md5FromGuid(q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de)) eq q(ef69caaaeea9c17120821a9eb6c7f1de); } if (1) {ok arraySum (1..10) == 55; ok arrayProduct(1..5) == 120; is_deeply[arrayTimes(2, 1..5)], [qw(2 4 6 8 10)]; }
Recover an md5 sum from a guid.
Parameter Description 1 $G Guid
if (1) { ok fileMd5Sum(join '', 1..100) eq q(ef69caaaeea9c17120821a9eb6c7f1de); ok guidFromString(join '', 1..100) eq q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de); ok guidFromMd5(fileMd5Sum(join('', 1..100))) eq q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de); ok 𝗺𝗱𝟱𝗙𝗿𝗼𝗺𝗚𝘂𝗶𝗱(q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de)) eq q(ef69caaaeea9c17120821a9eb6c7f1de); } if (1) {ok arraySum (1..10) == 55; ok arrayProduct(1..5) == 120; is_deeply[arrayTimes(2, 1..5)], [qw(2 4 6 8 10)]; }
Create a guid from a file or string via an md5 hash.
Parameter Description 1 $string File name or string
if (1) { ok fileMd5Sum(join '', 1..100) eq q(ef69caaaeea9c17120821a9eb6c7f1de); ok 𝗴𝘂𝗶𝗱𝗙𝗿𝗼𝗺𝗦𝘁𝗿𝗶𝗻𝗴(join '', 1..100) eq q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de); ok guidFromMd5(fileMd5Sum(join('', 1..100))) eq q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de); ok md5FromGuid(q(GUID-ef69caaa-eea9-c171-2082-1a9eb6c7f1de)) eq q(ef69caaaeea9c17120821a9eb6c7f1de); } if (1) {ok arraySum (1..10) == 55; ok arrayProduct(1..5) == 120; is_deeply[arrayTimes(2, 1..5)], [qw(2 4 6 8 10)]; }
Get the modified time of a file in seconds since the epoch.
ok 𝗳𝗶𝗹𝗲𝗠𝗼𝗱𝗧𝗶𝗺𝗲($0) =~ m(\A\d+\Z)s;
Calls the specified sub once for each source file that is missing, then calls the sub for the target if there were any missing files or if the target is older than any of the non missing source files or if the target does not exist. The file name is passed to the sub each time in $_. Returns the files to be remade in the order they should be made.
Parameter Description 1 $make Make with this sub 2 $target Target file 3 @source Source files
if (0) { my @Files = qw(a b c); my @files = (@Files, qw(d)); writeFile($_, $_), sleep 1 for @Files; my $a = ''; my @a = 𝗳𝗶𝗹𝗲𝗢𝘂𝘁𝗢𝗳𝗗𝗮𝘁𝗲 {$a .= $_} q(a), @files; ok $a eq 'da'; is_deeply [@a], [qw(d a)]; my $b = ''; my @b = 𝗳𝗶𝗹𝗲𝗢𝘂𝘁𝗢𝗳𝗗𝗮𝘁𝗲 {$b .= $_} q(b), @files; ok $b eq 'db'; is_deeply [@b], [qw(d b)]; my $c = ''; my @c = 𝗳𝗶𝗹𝗲𝗢𝘂𝘁𝗢𝗳𝗗𝗮𝘁𝗲 {$c .= $_} q(c), @files; ok $c eq 'dc'; is_deeply [@c], [qw(d c)]; my $d = ''; my @d = 𝗳𝗶𝗹𝗲𝗢𝘂𝘁𝗢𝗳𝗗𝗮𝘁𝗲 {$d .= $_} q(d), @files; ok $d eq 'd'; is_deeply [@d], [qw(d)]; my @A = 𝗳𝗶𝗹𝗲𝗢𝘂𝘁𝗢𝗳𝗗𝗮𝘁𝗲 {} q(a), @Files; my @B = 𝗳𝗶𝗹𝗲𝗢𝘂𝘁𝗢𝗳𝗗𝗮𝘁𝗲 {} q(b), @Files; my @C = 𝗳𝗶𝗹𝗲𝗢𝘂𝘁𝗢𝗳𝗗𝗮𝘁𝗲 {} q(c), @Files; is_deeply [@A], [qw(a)]; is_deeply [@B], [qw(b)]; is_deeply [@C], []; unlink for @Files; }
Returns the name of the first file that exists or undef if none of the named files exist.
Parameter Description 1 @files Files to check
my $d = temporaryFolder; ok $d eq 𝗳𝗶𝗿𝘀𝘁𝗙𝗶𝗹𝗲𝗧𝗵𝗮𝘁𝗘𝘅𝗶𝘀𝘁𝘀("$d/$d", $d);
Convert a unix file name to windows format
Parameter Description 1 $file File
if (1) {ok 𝗳𝗶𝗹𝗲𝗜𝗻𝗪𝗶𝗻𝗱𝗼𝘄𝘀𝗙𝗼𝗿𝗺𝗮𝘁(fpd(qw(/a b c d))) eq q(\a\b\c\d\\); }
File names and components.
Create file names from file name components.
Create a file name from an array of file name components. If all the components are blank then a blank file name is returned. Identical to fpf.
Parameter Description 1 @file File name components
if (1) { ok 𝗳𝗶𝗹𝗲𝗣𝗮𝘁𝗵 (qw(/aaa bbb ccc ddd.eee)) eq "/aaa/bbb/ccc/ddd.eee"; ok filePathDir(qw(/aaa bbb ccc ddd)) eq "/aaa/bbb/ccc/ddd/"; ok filePathDir('', qw(aaa)) eq "aaa/"; ok filePathDir('') eq ""; ok filePathExt(qw(aaa xxx)) eq "aaa.xxx"; ok filePathExt(qw(aaa bbb xxx)) eq "aaa/bbb.xxx"; ok fpd (qw(/aaa bbb ccc ddd)) eq "/aaa/bbb/ccc/ddd/"; ok fpf (qw(/aaa bbb ccc ddd.eee)) eq "/aaa/bbb/ccc/ddd.eee"; ok fpe (qw(aaa bbb xxx)) eq "aaa/bbb.xxx"; }
fpf is a synonym for filePath.
Create a directory name from an array of file name components. If all the components are blank then a blank file name is returned. Identical to fpd.
Parameter Description 1 @file Directory name components
if (1) { ok filePath (qw(/aaa bbb ccc ddd.eee)) eq "/aaa/bbb/ccc/ddd.eee"; ok 𝗳𝗶𝗹𝗲𝗣𝗮𝘁𝗵𝗗𝗶𝗿(qw(/aaa bbb ccc ddd)) eq "/aaa/bbb/ccc/ddd/"; ok 𝗳𝗶𝗹𝗲𝗣𝗮𝘁𝗵𝗗𝗶𝗿('', qw(aaa)) eq "aaa/"; ok 𝗳𝗶𝗹𝗲𝗣𝗮𝘁𝗵𝗗𝗶𝗿('') eq ""; ok filePathExt(qw(aaa xxx)) eq "aaa.xxx"; ok filePathExt(qw(aaa bbb xxx)) eq "aaa/bbb.xxx"; ok fpd (qw(/aaa bbb ccc ddd)) eq "/aaa/bbb/ccc/ddd/"; ok fpf (qw(/aaa bbb ccc ddd.eee)) eq "/aaa/bbb/ccc/ddd.eee"; ok fpe (qw(aaa bbb xxx)) eq "aaa/bbb.xxx"; }
fpd is a synonym for filePathDir.
Parameter Description 1 @File File name components and extension
if (1) { ok filePath (qw(/aaa bbb ccc ddd.eee)) eq "/aaa/bbb/ccc/ddd.eee"; ok filePathDir(qw(/aaa bbb ccc ddd)) eq "/aaa/bbb/ccc/ddd/"; ok filePathDir('', qw(aaa)) eq "aaa/"; ok filePathDir('') eq ""; ok 𝗳𝗶𝗹𝗲𝗣𝗮𝘁𝗵𝗘𝘅𝘁(qw(aaa xxx)) eq "aaa.xxx"; ok 𝗳𝗶𝗹𝗲𝗣𝗮𝘁𝗵𝗘𝘅𝘁(qw(aaa bbb xxx)) eq "aaa/bbb.xxx"; ok fpd (qw(/aaa bbb ccc ddd)) eq "/aaa/bbb/ccc/ddd/"; ok fpf (qw(/aaa bbb ccc ddd.eee)) eq "/aaa/bbb/ccc/ddd.eee"; ok fpe (qw(aaa bbb xxx)) eq "aaa/bbb.xxx"; }
fpe is a synonym for filePathExt.
Get file name components from file names.
Get path from file name.
ok 𝗳𝗽 (q(a/b/c.d.e)) eq q(a/b/);
Remove extension from file name.
ok 𝗳𝗽𝗻(q(a/b/c.d.e)) eq q(a/b/c.d);
ok 𝗳𝗻 (q(a/b/c.d.e)) eq q(c.d);
Remove path from file name.
ok 𝗳𝗻𝗲(q(a/b/c.d.e)) eq q(c.d.e);
Get extension of file name.
ok 𝗳𝗲 (q(a/b/c.d.e)) eq q(e);
Return the name of the specified file if it exists, else confess the maximum extent of the path that does exist.
Parameter Description 1 $file File to check
my $d = filePath (my @d = qw(a b c d)); my $f = filePathExt(qw(a b c d e x)); my $F = filePathExt(qw(a b c e d)); createEmptyFile($f); ok 𝗰𝗵𝗲𝗰𝗸𝗙𝗶𝗹𝗲($d); ok 𝗰𝗵𝗲𝗰𝗸𝗙𝗶𝗹𝗲($f);
Quote a file name.
ok 𝗾𝘂𝗼𝘁𝗲𝗙𝗶𝗹𝗲(fpe(qw(a "b" c))) eq q("a/\"b\".c");
Removes a file prefix from an array of files.
Parameter Description 1 $prefix File prefix 2 @files Array of file names
is_deeply [qw(a b)], [&𝗿𝗲𝗺𝗼𝘃𝗲𝗙𝗶𝗹𝗲𝗣𝗿𝗲𝗳𝗶𝘅(qw(a/ a/a a/b))]; is_deeply [qw(b)], [&𝗿𝗲𝗺𝗼𝘃𝗲𝗙𝗶𝗹𝗲𝗣𝗿𝗲𝗳𝗶𝘅("a/", "a/b")];
Swaps the start of a file name from a $known name to a $new one if the file does in fact start with the $known name otherwise returns the original file name. The $new prefix is optional, if not supplied the $known prefix is removed.
Parameter Description 1 $file File name 2 $known Existing prefix 3 $new Optional new prefix defaults to q()
ok 𝘀𝘄𝗮𝗽𝗙𝗶𝗹𝗲𝗣𝗿𝗲𝗳𝗶𝘅(q(/aaa/bbb.txt), q(/aaa/), q(/AAA/)) eq q(/AAA/bbb.txt);
Set the extension of a file to a specified value. Removes the extension if no extension is specified.
Parameter Description 1 $file File name 2 $extension Optional new extension
ok 𝘀𝗲𝘁𝗙𝗶𝗹𝗲𝗘𝘅𝘁𝗲𝗻𝘀𝗶𝗼𝗻(q(.c), q(d)) eq q(.d); ok 𝘀𝗲𝘁𝗙𝗶𝗹𝗲𝗘𝘅𝘁𝗲𝗻𝘀𝗶𝗼𝗻(q(b.c), q(d)) eq q(b.d); ok 𝘀𝗲𝘁𝗙𝗶𝗹𝗲𝗘𝘅𝘁𝗲𝗻𝘀𝗶𝗼𝗻(q(/a/b.c), q(d)) eq q(/a/b.d);
Swaps a starting folder of a file name from a known name to a new one if the file does in fact start with the known name and the known name and new name are folders else return the file as is.
Parameter Description 1 $file File name 2 $known Existing prefix 3 $new New prefix
if (1) { my $g = fpd(qw(a b c d)); my $h = fpd(qw(a b cc dd)); my $i = fpe($g, qw(aaa txt)); my $j = 𝘀𝘄𝗮𝗽𝗙𝗼𝗹𝗱𝗲𝗿𝗣𝗿𝗲𝗳𝗶𝘅($i, $g, $h); ok $j =~ m(a/b/cc/dd/)s; }
Position in the file system.
Get the current working directory.
𝗰𝘂𝗿𝗿𝗲𝗻𝘁𝗗𝗶𝗿𝗲𝗰𝘁𝗼𝗿𝘆;
The path to the folder above the current working folder.
𝗰𝘂𝗿𝗿𝗲𝗻𝘁𝗗𝗶𝗿𝗲𝗰𝘁𝗼𝗿𝘆𝗔𝗯𝗼𝘃𝗲;
Parse a file name into (path, name, extension).
Parameter Description 1 $file File name to parse
if (1) {is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "/home/phil/test.data"], ["/home/phil/", "test", "data"]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "/home/phil/test"], ["/home/phil/", "test"]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "phil/test.data"], ["phil/", "test", "data"]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "phil/test"], ["phil/", "test"]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "test.data"], [undef, "test", "data"]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "phil/"], [qw(phil/)]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "/phil"], [qw(/ phil)]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "/"], [qw(/)]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "/var/www/html/translations/"], [qw(/var/www/html/translations/)]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "a.b/c.d.e"], [qw(a.b/ c.d e)]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "./a.b"], [qw(./ a b)]; is_deeply [𝗽𝗮𝗿𝘀𝗲𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲 "./../../a.b"], [qw(./../../ a b)]; }
Full name of a file.
𝗳𝘂𝗹𝗹𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲(fpe(qw(a txt)));
Create an absolute file from an absolute file and a relative file.
Parameter Description 1 $a Absolute file name 2 $f Relative file name
ok "/home/la/perl/aaa.pl" eq 𝗮𝗯𝘀𝗙𝗿𝗼𝗺𝗔𝗯𝘀𝗣𝗹𝘂𝘀𝗥𝗲𝗹("/home/la/perl/bbb", "aaa.pl"); ok "/home/la/perl/aaa.pl" eq 𝗮𝗯𝘀𝗙𝗿𝗼𝗺𝗔𝗯𝘀𝗣𝗹𝘂𝘀𝗥𝗲𝗹("/home/il/perl/bbb.pl", "../../la/perl/aaa.pl");
Derive a relative file name for the first absolute file name relative to the second absolute file name.
Parameter Description 1 $f Absolute file to be made relative 2 $a Absolute file name to make relative to.
ok "bbb.pl" eq 𝗿𝗲𝗹𝗙𝗿𝗼𝗺𝗔𝗯𝘀𝗔𝗴𝗮𝗶𝗻𝘀𝘁𝗔𝗯𝘀("/home/la/perl/bbb.pl", "/home/la/perl/aaa.pl"); ok "../perl/bbb.pl" eq 𝗿𝗲𝗹𝗙𝗿𝗼𝗺𝗔𝗯𝘀𝗔𝗴𝗮𝗶𝗻𝘀𝘁𝗔𝗯𝘀("/home/la/perl/bbb.pl", "/home/la/java/aaa.jv");
Parameter Description 1 @f Absolute and relative file names
ok "aaa/bbb/ccc/ddd.txt" eq 𝘀𝘂𝗺𝗔𝗯𝘀𝗔𝗻𝗱𝗥𝗲𝗹(qw(aaa/AAA/ ../bbb/bbb/BBB/ ../../ccc/ddd.txt));
Temporary files and folders
Create a temporary file that will automatically be unlinked during END processing.
my $f = 𝘁𝗲𝗺𝗽𝗼𝗿𝗮𝗿𝘆𝗙𝗶𝗹𝗲;
Create a temporary folder that will automatically be rmdired during END processing.
my $D = 𝘁𝗲𝗺𝗽𝗼𝗿𝗮𝗿𝘆𝗙𝗼𝗹𝗱𝗲𝗿;
temporaryDirectory is a synonym for temporaryFolder.
Find files and folders below a folder.
Find all the files under a folder and optionally filter the selected files with a regular expression.
Parameter Description 1 $dir Folder to start the search with 2 $filter Optional regular expression to filter files
my $D = temporaryFolder; my $d = fpd($D, q(ddd)); my @f = map {createEmptyFile(fpe($d, $_, qw(txt)))} qw(a b c); is_deeply [sort map {fne $_} 𝗳𝗶𝗻𝗱𝗙𝗶𝗹𝗲𝘀($d, qr(txt\Z))], [qw(a.txt b.txt c.txt)];
Find all the folders under a folder and optionally filter the selected folders with a regular expression.
my $D = temporaryFolder; my $d = fpd($D, q(ddd)); my @f = map {createEmptyFile(fpe($d, $_, qw(txt)))} qw(a b c); is_deeply [𝗳𝗶𝗻𝗱𝗗𝗶𝗿𝘀($D)], [$D, $d];
Files that match a given search pattern handed to bsd_glob.
Parameter Description 1 $pattern Search pattern
my $D = temporaryFolder; my $d = fpd($D, q(ddd)); my @f = map {createEmptyFile(fpe($d, $_, qw(txt)))} qw(a b c); is_deeply [sort map {fne $_} 𝗳𝗶𝗹𝗲𝗟𝗶𝘀𝘁("$d/*.txt")], ["a.txt", "b.txt", "c.txt"];
Parameter Description 1 @foldersandExtensions Mixture of folder names and extensions
my $D = temporaryFolder; my $d = fpd($D, q(ddd)); my @f = map {createEmptyFile(fpe($d, $_, qw(txt)))} qw(a b c); is_deeply [sort map {fne $_} 𝘀𝗲𝗮𝗿𝗰𝗵𝗗𝗶𝗿𝗲𝗰𝘁𝗼𝗿𝘆𝗧𝗿𝗲𝗲𝘀𝗙𝗼𝗿𝗠𝗮𝘁𝗰𝗵𝗶𝗻𝗴𝗙𝗶𝗹𝗲𝘀($d)], ["a.txt", "b.txt", "c.txt"];
Return a hash which counts the file extensions under the specified directories
Parameter Description 1 @folders Folders to search
𝗰𝗼𝘂𝗻𝘁𝗙𝗶𝗹𝗲𝗘𝘅𝘁𝗲𝗻𝘀𝗶𝗼𝗻𝘀(q(/home/phil/perl/));
Return a hash which counts, in parallel, the results of applying the file command to each file under the specified directories.
Parameter Description 1 $maximumNumberOfProcesses Maximum number of processes to run in parallel 2 @folders Folders to search
𝗰𝗼𝘂𝗻𝘁𝗙𝗶𝗹𝗲𝗧𝘆𝗽𝗲𝘀(4, q(/home/phil/perl/));
Given an absolute path find out how much of the path actually exists.
my $d = filePath (my @d = qw(a b c d)); ok 𝗺𝗮𝘁𝗰𝗵𝗣𝗮𝘁𝗵($d) eq $d;
Find the first extension from the specified extensions that produces a file that exists when appended to the specified file.
Parameter Description 1 $file File name minus extensions 2 @ext Possible extensions
my $f = createEmptyFile(fpe(my $d = temporaryFolder, qw(a jpg))); my $F = 𝗳𝗶𝗻𝗱𝗙𝗶𝗹𝗲𝗪𝗶𝘁𝗵𝗘𝘅𝘁𝗲𝗻𝘀𝗶𝗼𝗻(fpf($d, q(a)), qw(txt data jpg)); ok $F eq "jpg";
Parameter Description 1 $folder Folder 2 $limitCount Maximum number of files to remove to limit damage 3 $noMsg No message if the folder cannot be completely removed.
my $D = temporaryFolder; my $d = fpd($D, q(ddd)); my @f = map {createEmptyFile(fpe($d, $_, qw(txt)))} qw(a b c); 𝗰𝗹𝗲𝗮𝗿𝗙𝗼𝗹𝗱𝗲𝗿($D, 5); ok !-e $_ for @f; ok !-d $D;
Read and write strings from and to files creating paths as needed.
Parameter Description 1 $file Name of file to read
my $f = writeFile(undef, "aaa"); my $s = 𝗿𝗲𝗮𝗱𝗙𝗶𝗹𝗲($f); ok $s eq "aaa"; appendFile($f, "bbb"); my $S = 𝗿𝗲𝗮𝗱𝗙𝗶𝗹𝗲($f); ok $S eq "aaabbb"; if (1) { my $f = writeFile(undef, q(aaaa)); ok 𝗿𝗲𝗮𝗱𝗙𝗶𝗹𝗲($f) eq q(aaaa); eval{writeFile($f, q(bbbb))}; ok $@ =~ m(\AFile already exists)s; ok 𝗿𝗲𝗮𝗱𝗙𝗶𝗹𝗲($f) eq q(aaaa); overWriteFile($f, q(bbbb)); ok 𝗿𝗲𝗮𝗱𝗙𝗶𝗹𝗲($f) eq q(bbbb); unlink $f; }
Read a file containing unicode in utf8, evaluate it, confess to any errors and then return any result - an improvement on do which silently ignores any problems.
Parameter Description 1 $file File to read
if (1) { my $f = dumpFile(undef, my $d = [qw(aaa bbb ccc)]); my $s = 𝗲𝘃𝗮𝗹𝗙𝗶𝗹𝗲($f); is_deeply $s, $d; unlink $f; }
Read a file containing compressed utf8, evaluate it, confess to any errors or return any result. This is much slower than using Storable but does use much smaller files, see also: dumpGZipFile.
if (1) { my $d = [1, 2, 3=>{a=>4, b=>5}]; my $file = dumpGZipFile(q(zzz.zip), $d); ok -e $file; my $D = 𝗲𝘃𝗮𝗹𝗚𝗭𝗶𝗽𝗙𝗶𝗹𝗲($file); is_deeply $d, $D; unlink $file; }
Retrieve a file created via Storable. This is much faster than evalFile but the stored data is not easily modified.
if (1) { my $f = storeFile(undef, my $d = [qw(aaa bbb ccc)]); my $s = 𝗿𝗲𝘁𝗿𝗶𝗲𝘃𝗲𝗙𝗶𝗹𝗲($f); is_deeply $s, $d; unlink $f; }
Read binary file - a file whose contents are not to be interpreted as unicode.
my $f = writeBinaryFile(undef, 0xff x 8); my $s = 𝗿𝗲𝗮𝗱𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲($f); ok $s eq 0xff x 8;
Read the specified $file, containing compressed utf8, through gzip
Parameter Description 1 $file File to read.
if (1) { my $s = '𝝰'x1e3; my $file = writeGZipFile(q(zzz.zip), $s); ok -e $file; my $S = 𝗿𝗲𝗮𝗱𝗚𝗭𝗶𝗽𝗙𝗶𝗹𝗲($file); ok $s eq $S; ok length($s) == length($S); unlink $file; }
Make the path for the specified file name or folder.
my $d = fpd(my $D = temporaryDirectory, qw(a)); my $f = fpe($d, qw(bbb txt)); ok !-d $d; 𝗺𝗮𝗸𝗲𝗣𝗮𝘁𝗵($f); ok -d $d;
Write a unicode utf8 string to a file after creating a path to the file if necessary and return the name of the file on success else confess. If the file already exists it is overwritten.
Parameter Description 1 $file File to write to or B<undef> for a temporary file 2 $string Unicode string to write
if (1) { my $f = writeFile(undef, q(aaaa)); ok readFile($f) eq q(aaaa); eval{writeFile($f, q(bbbb))}; ok $@ =~ m(\AFile already exists)s; ok readFile($f) eq q(aaaa); 𝗼𝘃𝗲𝗿𝗪𝗿𝗶𝘁𝗲𝗙𝗶𝗹𝗲($f, q(bbbb)); ok readFile($f) eq q(bbbb); unlink $f; }
owf is a synonym for overWriteFile.
Parameter Description 1 $file New file to write to or B<undef> for a temporary file 2 $string String to write
my $f = 𝘄𝗿𝗶𝘁𝗲𝗙𝗶𝗹𝗲(undef, "aaa"); my $s = readFile($f); ok $s eq "aaa"; appendFile($f, "bbb"); my $S = readFile($f); ok $S eq "aaabbb"; if (1) { my $f = 𝘄𝗿𝗶𝘁𝗲𝗙𝗶𝗹𝗲(undef, q(aaaa)); ok readFile($f) eq q(aaaa); eval{𝘄𝗿𝗶𝘁𝗲𝗙𝗶𝗹𝗲($f, q(bbbb))}; ok $@ =~ m(\AFile already exists)s; ok readFile($f) eq q(aaaa); overWriteFile($f, q(bbbb)); ok readFile($f) eq q(bbbb); unlink $f; }
Write a binary string to a file after creating a path to the file if necessary and return the name of the file on success else confess. If the file already exists it is overwritten.
if (1) {vec(my $a, 0, 8) = 254; vec(my $b, 0, 8) = 255; ok dump($a) eq dump("FE"); ok dump($b) eq dump("FF"); ok length($a) == 1; ok length($b) == 1; my $s = $a.$a.$b.$b; ok length($s) == 4; my $f = eval {writeFile(undef, $s)}; ok fileSize($f) == 8; eval {writeBinaryFile($f, $s)}; ok $@ =~ m(Binary file already exists:)s; eval {𝗼𝘃𝗲𝗿𝗪𝗿𝗶𝘁𝗲𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲($f, $s)}; ok !$@; ok fileSize($f) == 4; ok $s eq eval {readBinaryFile($f)}; copyBinaryFile($f, my $F = temporaryFile); ok $s eq readBinaryFile($F); unlink $f, $F; }
Write a binary string to a new file that does not already exist after creating a path to the file if necessary and return the name of the file on success else confess if a problem occurred or the file does already exist.
my $f = 𝘄𝗿𝗶𝘁𝗲𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲(undef, 0xff x 8); my $s = readBinaryFile($f); ok $s eq 0xff x 8; if (1) {vec(my $a, 0, 8) = 254; vec(my $b, 0, 8) = 255; ok dump($a) eq dump("FE"); ok dump($b) eq dump("FF"); ok length($a) == 1; ok length($b) == 1; my $s = $a.$a.$b.$b; ok length($s) == 4; my $f = eval {writeFile(undef, $s)}; ok fileSize($f) == 8; eval {𝘄𝗿𝗶𝘁𝗲𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲($f, $s)}; ok $@ =~ m(Binary file already exists:)s; eval {overWriteBinaryFile($f, $s)}; ok !$@; ok fileSize($f) == 4; ok $s eq eval {readBinaryFile($f)}; copyBinaryFile($f, my $F = temporaryFile); ok $s eq readBinaryFile($F); unlink $f, $F; }
Dump a data structure to a file
Parameter Description 1 $file File to write to or B<undef> for a temporary file 2 $struct Address of data structure to write
if (1) { my $f = 𝗱𝘂𝗺𝗽𝗙𝗶𝗹𝗲(undef, my $d = [qw(aaa bbb ccc)]); my $s = evalFile($f); is_deeply $s, $d; unlink $f; }
Store a data structure to a file via Storable. This is much faster than dumpFile but the stored results are not easily modified.
if (1) { my $f = 𝘀𝘁𝗼𝗿𝗲𝗙𝗶𝗹𝗲(undef, my $d = [qw(aaa bbb ccc)]); my $s = retrieveFile($f); is_deeply $s, $d; unlink $f; }
Write a unicode utf8 string through gzip to a file.
Parameter Description 1 $file File to write to 2 $string String to write
if (1) { my $s = '𝝰'x1e3; my $file = 𝘄𝗿𝗶𝘁𝗲𝗚𝗭𝗶𝗽𝗙𝗶𝗹𝗲(q(zzz.zip), $s); ok -e $file; my $S = readGZipFile($file); ok $s eq $S; ok length($s) == length($S); unlink $file; }
Write a data structure through gzip to a file. This technique produces files that are a lot more compact files than those produced by Storable, but the execution time is much longer. See also: evalGZipFile.
Parameter Description 1 $file File to write 2 $data Reference to data
if (1) { my $d = [1, 2, 3=>{a=>4, b=>5}]; my $file = 𝗱𝘂𝗺𝗽𝗚𝗭𝗶𝗽𝗙𝗶𝗹𝗲(q(zzz.zip), $d); ok -e $file; my $D = evalGZipFile($file); is_deeply $d, $D; unlink $file; }
Write the values of a hash into files identified by the key of each value using overWriteFile
Parameter Description 1 $hash Hash of key value pairs representing files and data 2 $folder Optional folder to contain files else the current folder
if (1) { my $h = {"aaa/1.txt"=>"1111", "aaa/2.txt"=>"2222", }; clearFolder(q(aaa), 3); clearFolder(q(bbb), 3); 𝘄𝗿𝗶𝘁𝗲𝗙𝗶𝗹𝗲𝘀($h); my $a = readFiles(q(aaa)); is_deeply $h, $a; copyFolder(q(aaa), q(bbb)); my $b = readFiles(q(bbb)); is_deeply [sort values %$a],[sort values %$b]; copyFile(q(aaa/1.txt), q(aaa/2.txt)); my $A = readFiles(q(aaa)); is_deeply(values %$A); clearFolder(q(aaa), 3); clearFolder(q(bbb), 3); }
Read all the files in a folder into a hash
Parameter Description 1 $folder Folder to read
if (1) { my $h = {"aaa/1.txt"=>"1111", "aaa/2.txt"=>"2222", }; clearFolder(q(aaa), 3); clearFolder(q(bbb), 3); writeFiles($h); my $a = 𝗿𝗲𝗮𝗱𝗙𝗶𝗹𝗲𝘀(q(aaa)); is_deeply $h, $a; copyFolder(q(aaa), q(bbb)); my $b = 𝗿𝗲𝗮𝗱𝗙𝗶𝗹𝗲𝘀(q(bbb)); is_deeply [sort values %$a],[sort values %$b]; copyFile(q(aaa/1.txt), q(aaa/2.txt)); my $A = 𝗿𝗲𝗮𝗱𝗙𝗶𝗹𝗲𝘀(q(aaa)); is_deeply(values %$A); clearFolder(q(aaa), 3); clearFolder(q(bbb), 3); }
Append a unicode utf8 string to a file, possibly creating the file and the path to the file if necessary and return the name of the file on success else confess. The file being appended to is locked first with https://perldoc.perl.org/functions/flock.html to allow multiple processes to append linearly to the same file.
Parameter Description 1 $file File to append to 2 $string String to append
my $f = writeFile(undef, "aaa"); my $s = readFile($f); ok $s eq "aaa"; 𝗮𝗽𝗽𝗲𝗻𝗱𝗙𝗶𝗹𝗲($f, "bbb"); my $S = readFile($f); ok $S eq "aaabbb";
Create an empty file - writeFile complains if no data is written to the file - and return the name of the file on success else confess.
Parameter Description 1 $file File to create or B<undef> for a temporary file
my $D = temporaryFolder; my $d = fpd($D, q(ddd)); my @f = map {𝗰𝗿𝗲𝗮𝘁𝗲𝗘𝗺𝗽𝘁𝘆𝗙𝗶𝗹𝗲(fpe($d, $_, qw(txt)))} qw(a b c); is_deeply [sort map {fne $_} findFiles($d, qr(txt\Z))], [qw(a.txt b.txt c.txt)];
The number of lines in a file
my $f = writeFile(undef, "a b "); ok 𝗻𝘂𝗺𝗯𝗲𝗿𝗢𝗳𝗟𝗶𝗻𝗲𝘀𝗜𝗻𝗙𝗶𝗹𝗲($f) == 2;
Copy files and folders. The \Acopy.*Md5Normalized.*\Z methods can be used to ensure that files have collision proof names that collapse duplicate content even when copied to another folder.
Copy a file encoded in utf8 and return the target name
Parameter Description 1 $source Source file 2 $target Target file
if (1) { my $h = {"aaa/1.txt"=>"1111", "aaa/2.txt"=>"2222", }; clearFolder(q(aaa), 3); clearFolder(q(bbb), 3); writeFiles($h); my $a = readFiles(q(aaa)); is_deeply $h, $a; copyFolder(q(aaa), q(bbb)); my $b = readFiles(q(bbb)); is_deeply [sort values %$a],[sort values %$b]; 𝗰𝗼𝗽𝘆𝗙𝗶𝗹𝗲(q(aaa/1.txt), q(aaa/2.txt)); my $A = readFiles(q(aaa)); is_deeply(values %$A); clearFolder(q(aaa), 3); clearFolder(q(bbb), 3); }
Create a readable name from an arbitrary string of text.
Parameter Description 1 $string String
ok q(help) eq 𝗻𝗮𝗺𝗲𝗙𝗿𝗼𝗺𝗦𝘁𝗿𝗶𝗻𝗴(q(!@#$%^help___<>?><?>));
Create a unique name from a file name and the md5 sum of its content
Parameter Description 1 $source Source file
if (1) { my $f = owf(q(test.txt), join "", 1..100); ok 𝘂𝗻𝗶𝗾𝘂𝗲𝗡𝗮𝗺𝗲𝗙𝗿𝗼𝗺𝗙𝗶𝗹𝗲($f) eq q(test_ef69caaaeea9c17120821a9eb6c7f1de.txt); unlink $f; }
Create a name from the last folder in the path of a file name. Return undef if the file does not have a path.
ok 𝗻𝗮𝗺𝗲𝗙𝗿𝗼𝗺𝗙𝗼𝗹𝗱𝗲𝗿(fpe(qw( a b c d e))) eq q(c);
Normalize the name of the specified $source file to the md5 sum of its content, retaining its current extension, while placing the original file name in an companion file if the companion file does not already exist. If no $target folder is supplied the file is renamed to its normalized form in situ, otherwise it is copied to the target folder and renamed there. An companion file for the $source file is created by removing the extension of the normalized file and writing the original $source file name to it unless such a file already exists as we assume that it contains the 'original' original name of the $source file. If the $source file is copied to a new location then the companion file is copied as well to maintain the link back to the original name of the file.
Parameter Description 1 $source Source file 2 $Target Target folder or a file in the target folder
if (1) { my $dir = temporaryFolder; my $a = fpe($dir, qw(a a jpg)); my $b = fpe($dir, qw(b a jpg)); my $c = fpe($dir, qw(c a jpg)); my $content = join '', 1..1e3; my $A = copyFileMd5NormalizedCreate($a, $content, q(jpg), $a); ok readFile($A) eq $content; ok $A eq 𝗰𝗼𝗽𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($A); my $B = 𝗰𝗼𝗽𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($A, $b); ok readFile($B) eq $content; ok $B eq 𝗰𝗼𝗽𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($B); my $C = 𝗰𝗼𝗽𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($B, $c); ok readFile($C) eq $content; ok $C eq 𝗰𝗼𝗽𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($C); ok fne($A) eq fne($_) for $B, $C; ok readFile($_) eq $content for $A, $B, $C; ok copyFileMd5NormalizedGetCompanionContent($_) eq $a for $A, $B, $C; ok 6 == searchDirectoryTreesForMatchingFiles($dir); clearFolder($dir, 10); }
Create a file in the specified $folder whose name is constructed from the md5 sum of the specified $content, whose content is $content, whose extension is $extension and which has an companion file with the same name minus the extension which contains the specified $name. Such a file can be copied multiple times by copyBinaryFileMd5Normalized regardless of the other files in the target folders while retaining the original name information.
Parameter Description 1 $Folder Target folder or a file in that folder 2 $content Content of the file 3 $extension File extension 4 $Name Original file name.
if (1) { my $dir = temporaryFolder; my $a = fpe($dir, qw(a a jpg)); my $b = fpe($dir, qw(b a jpg)); my $c = fpe($dir, qw(c a jpg)); my $content = join '', 1..1e3; my $A = 𝗰𝗼𝗽𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱𝗖𝗿𝗲𝗮𝘁𝗲($a, $content, q(jpg), $a); ok readFile($A) eq $content; ok $A eq copyFileMd5Normalized($A); my $B = copyFileMd5Normalized($A, $b); ok readFile($B) eq $content; ok $B eq copyFileMd5Normalized($B); my $C = copyFileMd5Normalized($B, $c); ok readFile($C) eq $content; ok $C eq copyFileMd5Normalized($C); ok fne($A) eq fne($_) for $B, $C; ok readFile($_) eq $content for $A, $B, $C; ok copyFileMd5NormalizedGetCompanionContent($_) eq $a for $A, $B, $C; ok 6 == searchDirectoryTreesForMatchingFiles($dir); clearFolder($dir, 10); }
Return the original name of the specified $source file after it has been normalized via copyBinaryFileMd5Normalized or undef if the corresponding .imageDef file does not exist.
Parameter Description 1 $source Source file.
if (1) { my $dir = temporaryFolder; my $a = fpe($dir, qw(a a jpg)); my $b = fpe($dir, qw(b a jpg)); my $c = fpe($dir, qw(c a jpg)); my $content = join '', 1..1e3; my $A = copyFileMd5NormalizedCreate($a, $content, q(jpg), $a); ok readFile($A) eq $content; ok $A eq copyFileMd5Normalized($A); my $B = copyFileMd5Normalized($A, $b); ok readFile($B) eq $content; ok $B eq copyFileMd5Normalized($B); my $C = copyFileMd5Normalized($B, $c); ok readFile($C) eq $content; ok $C eq copyFileMd5Normalized($C); ok fne($A) eq fne($_) for $B, $C; ok readFile($_) eq $content for $A, $B, $C; ok 𝗰𝗼𝗽𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱𝗚𝗲𝘁𝗢𝗿𝗶𝗴𝗶𝗻𝗮𝗹𝗡𝗮𝗺𝗲($_) eq $a for $A, $B, $C; ok 6 == searchDirectoryTreesForMatchingFiles($dir); clearFolder($dir, 10); }
Copy a binary file and return the target name,
if (1) {vec(my $a, 0, 8) = 254; vec(my $b, 0, 8) = 255; ok dump($a) eq dump("FE"); ok dump($b) eq dump("FF"); ok length($a) == 1; ok length($b) == 1; my $s = $a.$a.$b.$b; ok length($s) == 4; my $f = eval {writeFile(undef, $s)}; ok fileSize($f) == 8; eval {writeBinaryFile($f, $s)}; ok $@ =~ m(Binary file already exists:)s; eval {overWriteBinaryFile($f, $s)}; ok !$@; ok fileSize($f) == 4; ok $s eq eval {readBinaryFile($f)}; 𝗰𝗼𝗽𝘆𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲($f, my $F = temporaryFile); ok $s eq readBinaryFile($F); unlink $f, $F; }
Normalize the name of the specified $source file to the md5 sum of its content, retaining its current extension, while placing the original file name in an companion file if the companion file does not already exist. If no $target folder is supplied the file is renamed to its normalized form in situ, otherwise it is copied to the target folder and renamed there. An accompanying file for the $source file is created by removing the extension of the normalized file and writing the original $source file name to it unless such a file already exists as we assume that it contains the 'original' original name of the $source file. If the $source file is copied to a new location then the accompanying file is copied as well to maintain the link back to the original name of the file.
if (1) { my $dir = temporaryFolder; my $a = fpe($dir, qw(a a jpg)); my $b = fpe($dir, qw(b a jpg)); my $c = fpe($dir, qw(c a jpg)); my $content = join '', 1..1e3; my $A = copyBinaryFileMd5NormalizedCreate($a, $content, q(jpg), $a); ok readBinaryFile($A) eq $content; ok $A eq 𝗰𝗼𝗽𝘆𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($A); my $B = 𝗰𝗼𝗽𝘆𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($A, $b); ok readBinaryFile($B) eq $content; ok $B eq 𝗰𝗼𝗽𝘆𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($B); my $C = 𝗰𝗼𝗽𝘆𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($B, $c); ok readBinaryFile($C) eq $content; ok $C eq 𝗰𝗼𝗽𝘆𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱($C); ok fne($A) eq fne($_) for $B, $C; ok readBinaryFile($_) eq $content for $A, $B, $C; ok copyBinaryFileMd5NormalizedGetCompanionContent($_) eq $a for $A, $B, $C; ok 6 == searchDirectoryTreesForMatchingFiles($dir); clearFolder($dir, 10); }
Create a file in the specified $folder whose name is constructed from the md5 sum of the specified $content, whose content is $content, whose extension is $extension and which has an accompanying file with the same name minus the extension which contains the specified $name. Such a file can be copied multiple times by copyBinaryFileMd5Normalized regardless of the other files in the target folders while retaining the original name information.
Parameter Description 1 $Folder Target folder or a file in that folder 2 $content Content of the file 3 $extension File extension 4 $name Original file name.
if (1) { my $dir = temporaryFolder; my $a = fpe($dir, qw(a a jpg)); my $b = fpe($dir, qw(b a jpg)); my $c = fpe($dir, qw(c a jpg)); my $content = join '', 1..1e3; my $A = 𝗰𝗼𝗽𝘆𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱𝗖𝗿𝗲𝗮𝘁𝗲($a, $content, q(jpg), $a); ok readBinaryFile($A) eq $content; ok $A eq copyBinaryFileMd5Normalized($A); my $B = copyBinaryFileMd5Normalized($A, $b); ok readBinaryFile($B) eq $content; ok $B eq copyBinaryFileMd5Normalized($B); my $C = copyBinaryFileMd5Normalized($B, $c); ok readBinaryFile($C) eq $content; ok $C eq copyBinaryFileMd5Normalized($C); ok fne($A) eq fne($_) for $B, $C; ok readBinaryFile($_) eq $content for $A, $B, $C; ok copyBinaryFileMd5NormalizedGetCompanionContent($_) eq $a for $A, $B, $C; ok 6 == searchDirectoryTreesForMatchingFiles($dir); clearFolder($dir, 10); }
if (1) { my $dir = temporaryFolder; my $a = fpe($dir, qw(a a jpg)); my $b = fpe($dir, qw(b a jpg)); my $c = fpe($dir, qw(c a jpg)); my $content = join '', 1..1e3; my $A = copyBinaryFileMd5NormalizedCreate($a, $content, q(jpg), $a); ok readBinaryFile($A) eq $content; ok $A eq copyBinaryFileMd5Normalized($A); my $B = copyBinaryFileMd5Normalized($A, $b); ok readBinaryFile($B) eq $content; ok $B eq copyBinaryFileMd5Normalized($B); my $C = copyBinaryFileMd5Normalized($B, $c); ok readBinaryFile($C) eq $content; ok $C eq copyBinaryFileMd5Normalized($C); ok fne($A) eq fne($_) for $B, $C; ok readBinaryFile($_) eq $content for $A, $B, $C; ok 𝗰𝗼𝗽𝘆𝗕𝗶𝗻𝗮𝗿𝘆𝗙𝗶𝗹𝗲𝗠𝗱𝟱𝗡𝗼𝗿𝗺𝗮𝗹𝗶𝘇𝗲𝗱𝗚𝗲𝘁𝗢𝗿𝗶𝗴𝗶𝗻𝗮𝗹𝗡𝗮𝗺𝗲($_) eq $a for $A, $B, $C; ok 6 == searchDirectoryTreesForMatchingFiles($dir); clearFolder($dir, 10); }
Copy a folder
if (1) { my $h = {"aaa/1.txt"=>"1111", "aaa/2.txt"=>"2222", }; clearFolder(q(aaa), 3); clearFolder(q(bbb), 3); writeFiles($h); my $a = readFiles(q(aaa)); is_deeply $h, $a; 𝗰𝗼𝗽𝘆𝗙𝗼𝗹𝗱𝗲𝗿(q(aaa), q(bbb)); my $b = readFiles(q(bbb)); is_deeply [sort values %$a],[sort values %$b]; copyFile(q(aaa/1.txt), q(aaa/2.txt)); my $A = readFiles(q(aaa)); is_deeply(values %$A); clearFolder(q(aaa), 3); clearFolder(q(bbb), 3); }
Image operations.
Return (width, height) of an image obtained via Imagemagick.
Parameter Description 1 $image File containing image
my ($width, $height) = 𝗶𝗺𝗮𝗴𝗲𝗦𝗶𝘇𝗲(fpe(qw(a image jpg)));
Convert an image to jpx format using Imagemagick applying an optional scaling if required.
Parameter Description 1 $Source Source file 2 $target Target folder (as multiple files will be created) 3 $Size Optional size of each tile - defaults to 256 4 $Tiles Optional limit in either direction on the number of tiles
𝗰𝗼𝗻𝘃𝗲𝗿𝘁𝗜𝗺𝗮𝗴𝗲𝗧𝗼𝗝𝗽𝘅(fpe(qw(a image jpg)), fpe(qw(a image jpg)), 256);
Convert a docx file to fodt using unoconv which must not be running elsewhere at the time. Unoconv can be installed via:
sudo apt install sharutils unoconv
Parameter Description 1 $inputFile Input file 2 $outputFile Output file
𝗰𝗼𝗻𝘃𝗲𝗿𝘁𝗗𝗼𝗰𝘅𝗧𝗼𝗙𝗼𝗱𝘁(fpe(qw(a docx)), fpe(qw(a fodt)));
Cut out the images embedded in a fodt file, perhaps produced via convertDocxToFodt, placing them in the specified folder and replacing them in the source file with:
<image href="$imageFile" outputclass="imageType">.
This conversion requires that you have both Imagemagick and unoconv installed on your system:
sudo apt install sharutils imagemagick unoconv
Parameter Description 1 $inputFile Input file 2 $outputFolder Output folder for images 3 $imagePrefix A prefix to be added to image file names
𝗰𝘂𝘁𝗢𝘂𝘁𝗜𝗺𝗮𝗴𝗲𝘀𝗜𝗻𝗙𝗼𝗱𝘁𝗙𝗶𝗹𝗲(fpe(qw(source fodt)), fpd(qw(images)), q(image));
Encode and decode using Json and Mime.
Encode Perl to Json.
Parameter Description 1 $string Data to encode
my $A = 𝗲𝗻𝗰𝗼𝗱𝗲𝗝𝘀𝗼𝗻(my $a = {a=>1,b=>2, c=>[1..2]}); my $b = decodeJson($A); is_deeply $a, $b;
Decode Perl from Json.
Parameter Description 1 $string Data to decode
my $A = encodeJson(my $a = {a=>1,b=>2, c=>[1..2]}); my $b = 𝗱𝗲𝗰𝗼𝗱𝗲𝗝𝘀𝗼𝗻($A); is_deeply $a, $b;
Encode a string in base 64.
Parameter Description 1 $string String to encode
my $A = 𝗲𝗻𝗰𝗼𝗱𝗲𝗕𝗮𝘀𝗲𝟲𝟰(my $a = "Hello World" x 10); my $b = decodeBase64($A); ok $a eq $b;
Decode a string in base 64.
Parameter Description 1 $string String to decode
my $A = encodeBase64(my $a = "Hello World" x 10); my $b = 𝗱𝗲𝗰𝗼𝗱𝗲𝗕𝗮𝘀𝗲𝟲𝟰($A); ok $a eq $b;
Convert a string with unicode points that are not directly representable in ascii into string that replaces these points with their representation on Xml making the string usable in Xml documents.
Parameter Description 1 $s String to convert
ok 𝗰𝗼𝗻𝘃𝗲𝗿𝘁𝗨𝗻𝗶𝗰𝗼𝗱𝗲𝗧𝗼𝗫𝗺𝗹('setenta e três') eq q(setenta e três);
Encode an ascii string as a string of hexadecimal digits.
Parameter Description 1 $ascii Ascii string
if (1) { ok 𝗮𝘀𝗰𝗶𝗶𝗧𝗼𝗛𝗲𝘅𝗦𝘁𝗿𝗶𝗻𝗴("Hello World!") eq "48656c6c6f20576f726c6421"; ok "Hello World!" eq hexToAsciiString("48656c6c6f20576f726c6421"); }
Decode a string of hexadecimal digits as an ascii string.
Parameter Description 1 $hex Hexadecimal string
if (1) { ok asciiToHexString("Hello World!") eq "48656c6c6f20576f726c6421"; ok "Hello World!" eq 𝗵𝗲𝘅𝗧𝗼𝗔𝘀𝗰𝗶𝗶𝗦𝘁𝗿𝗶𝗻𝗴("48656c6c6f20576f726c6421"); }
Numeric operations,
Test whether a number is a power of two, return the power if it is else undef.
Parameter Description 1 $n Number to check
ok 𝗽𝗼𝘄𝗲𝗿𝗢𝗳𝗧𝘄𝗼(1) == 0; ok 𝗽𝗼𝘄𝗲𝗿𝗢𝗳𝗧𝘄𝗼(2) == 1; ok !𝗽𝗼𝘄𝗲𝗿𝗢𝗳𝗧𝘄𝗼(3); ok 𝗽𝗼𝘄𝗲𝗿𝗢𝗳𝗧𝘄𝗼(4) == 2;
Find log two of the lowest power of two greater than or equal to a number.
ok 𝗰𝗼𝗻𝘁𝗮𝗶𝗻𝗶𝗻𝗴𝗣𝗼𝘄𝗲𝗿𝗢𝗳𝗧𝘄𝗼(1) == 0; ok 𝗰𝗼𝗻𝘁𝗮𝗶𝗻𝗶𝗻𝗴𝗣𝗼𝘄𝗲𝗿𝗢𝗳𝗧𝘄𝗼(2) == 1; ok 𝗰𝗼𝗻𝘁𝗮𝗶𝗻𝗶𝗻𝗴𝗣𝗼𝘄𝗲𝗿𝗢𝗳𝗧𝘄𝗼(3) == 2; ok 𝗰𝗼𝗻𝘁𝗮𝗶𝗻𝗶𝗻𝗴𝗣𝗼𝘄𝗲𝗿𝗢𝗳𝗧𝘄𝗼(4) == 2;
Set operations.
Merge the specified hashes by summing their values
Parameter Description 1 @h List of hashes to be summed
if (1) { is_deeply +{a=>1, b=>2, c=>3}, 𝗺𝗲𝗿𝗴𝗲𝗛𝗮𝘀𝗵𝗲𝘀𝗕𝘆𝗦𝘂𝗺𝗺𝗶𝗻𝗴𝗩𝗮𝗹𝘂𝗲𝘀 +{a=>1,b=>1, c=>1}, +{b=>1,c=>1}, +{c=>1}; }
Union of sets represented as arrays of strings and/or the keys of hashes
Parameter Description 1 @s Array of arrays of strings and/or hashes
if (1) { is_deeply [qw(a b c)], [𝘀𝗲𝘁𝗨𝗻𝗶𝗼𝗻(qw(a b c a a b b b))]; is_deeply [qw(a b c d e)], [𝘀𝗲𝘁𝗨𝗻𝗶𝗼𝗻 {a=>1, b=>2, e=>3}, [qw(c d e)], qw(e)]; }
Intersection of sets represented as arrays of strings and/or the keys of hashes
if (1) { is_deeply [qw(a b c)], [𝘀𝗲𝘁𝗜𝗻𝘁𝗲𝗿𝘀𝗲𝗰𝘁𝗶𝗼𝗻[qw(e f g a b c )],[qw(a A b B c C)]]; is_deeply [qw(e)], [𝘀𝗲𝘁𝗜𝗻𝘁𝗲𝗿𝘀𝗲𝗰𝘁𝗶𝗼𝗻 {a=>1, b=>2, e=>3}, [qw(c d e)], qw(e)]; }
Returns the size of the intersection over the size of the union of one or more sets represented as arrays and/or hashes
if (1) { my $f = 𝘀𝗲𝘁𝗜𝗻𝘁𝗲𝗿𝘀𝗲𝗰𝘁𝗶𝗼𝗻𝗢𝘃𝗲𝗿𝗨𝗻𝗶𝗼𝗻 {a=>1, b=>2, e=>3}, [qw(c d e)], qw(e); ok $f > 0.199999 && $f < 2.00001; }
Partition a set of sets so that within each partition the setIntersectionOverUnion of any two sets in the partition is never less than the specified $confidence**2
Parameter Description 1 $confidence Minimum setIntersectionOverUnion 2 @sets Array of arrays of strings and/or hashes representing sets
if (1) { is_deeply [𝘀𝗲𝘁𝗣𝗮𝗿𝘁𝗶𝘁𝗶𝗼𝗻𝗢𝗻𝗜𝗻𝘁𝗲𝗿𝘀𝗲𝗰𝘁𝗶𝗼𝗻𝗢𝘃𝗲𝗿𝗨𝗻𝗶𝗼𝗻 (0.80, [qw(a A b c d e)], [qw(a A B b c d e)], [qw(a A B C b c d)], )], [[["A", "B", "a".."e"], ["A", "a".."e"]], [["A".."C", "a".."d"]], ]; } if (1) { is_deeply [setPartitionOnIntersectionOverUnionOfSetsOfWords (0.80, [qw(a A b c d e)], [qw(a A B b c d e)], [qw(a A B C b c d)], )], [[["a", "A", "B", "C", "b", "c", "d"]], [["a", "A", "B", "b" .. "e"], ["a", "A", "b" .. "e"]], ]; }
Partition a set of sets of words so that within each partition the setIntersectionOverUnion of any two sets of words in the partition is never less than the specified $confidence**2
if (1) { is_deeply [𝘀𝗲𝘁𝗣𝗮𝗿𝘁𝗶𝘁𝗶𝗼𝗻𝗢𝗻𝗜𝗻𝘁𝗲𝗿𝘀𝗲𝗰𝘁𝗶𝗼𝗻𝗢𝘃𝗲𝗿𝗨𝗻𝗶𝗼𝗻𝗢𝗳𝗦𝗲𝘁𝘀𝗢𝗳𝗪𝗼𝗿𝗱𝘀 (0.80, [qw(a A b c d e)], [qw(a A B b c d e)], [qw(a A B C b c d)], )], [[["a", "A", "B", "C", "b", "c", "d"]], [["a", "A", "B", "b" .. "e"], ["a", "A", "b" .. "e"]], ]; }
Partition a set of sets, each set represented by a string containing words and punctuation, each word possibly capitalized, so that within each partition the setPartitionOnIntersectionOverUnionOfSetsOfWords of any two sets of words in the partition is never less than the specified $confidence**2
Parameter Description 1 $confidence Minimum setIntersectionOverUnion 2 @strings Sets represented by strings
if (1) { is_deeply [𝘀𝗲𝘁𝗣𝗮𝗿𝘁𝗶𝘁𝗶𝗼𝗻𝗢𝗻𝗜𝗻𝘁𝗲𝗿𝘀𝗲𝗰𝘁𝗶𝗼𝗻𝗢𝘃𝗲𝗿𝗨𝗻𝗶𝗼𝗻𝗢𝗳𝗦𝘁𝗿𝗶𝗻𝗴𝗦𝗲𝘁𝘀 (0.80, q(The Emu are seen here sometimes.), q(The Emu, Gnu are seen here sometimes.), q(The Emu, Gnu, Colt are seen here.), )], [["The Emu, Gnu, Colt are seen here."], ["The Emu, Gnu are seen here sometimes.", "The Emu are seen here sometimes.", ]]; }
Partition a set of sets represented by a hash, each hash value being a string containing words and punctuation, each word possibly capitalized, so that within each partition the setPartitionOnIntersectionOverUnionOfSetsOfWords of any two sets of words in the partition is never less than the specified $confidence**2 and the partition entries are the hash keys of the string sets.
Parameter Description 1 $confidence Minimum setIntersectionOverUnion 2 $hashSet Sets represented by the hash value strings
if (1) { is_deeply [𝘀𝗲𝘁𝗣𝗮𝗿𝘁𝗶𝘁𝗶𝗼𝗻𝗢𝗻𝗜𝗻𝘁𝗲𝗿𝘀𝗲𝗰𝘁𝗶𝗼𝗻𝗢𝘃𝗲𝗿𝗨𝗻𝗶𝗼𝗻𝗢𝗳𝗛𝗮𝘀𝗵𝗦𝘁𝗿𝗶𝗻𝗴𝗦𝗲𝘁𝘀 (0.80, {e =>q(The Emu are seen here sometimes.), eg =>q(The Emu, Gnu are seen here sometimes.), egc=>q(The Emu, Gnu, Colt are seen here.), } )], [["e", "eg"], ["egc"]]; }
Returns the indices at which an item matches elements of the specified array. If the item is a regular expression then it is matched as one, else it is a number it is matched as a number, else as a string.
Parameter Description 1 $item Item 2 @array Array
is_deeply [1], [𝗰𝗼𝗻𝘁𝗮𝗶𝗻𝘀(1,0..1)]; is_deeply [1,3], [𝗰𝗼𝗻𝘁𝗮𝗶𝗻𝘀(1, qw(0 1 0 1 0 0))]; is_deeply [0, 5], [𝗰𝗼𝗻𝘁𝗮𝗶𝗻𝘀('a', qw(a b c d e a b c d e))]; is_deeply [0, 1, 5], [𝗰𝗼𝗻𝘁𝗮𝗶𝗻𝘀(qr(a+), qw(a baa c d e aa b c d e))];
Returns the number of times the first string occurs in the second string
Parameter Description 1 $inString String to search in 2 $searchFor String to search for.
if (1) {ok 𝗰𝗼𝘂𝗻𝘁𝗢𝗰𝗰𝘂𝗿𝗲𝗻𝗰𝗲𝘀𝗜𝗻𝗦𝘁𝗿𝗶𝗻𝗴(q(a<b>c<b><b>d), q(<b>)) == 3; }
Find the smallest and largest elements of arrays.
Find the minimum number in a list confessing to any ill defined values.
Parameter Description 1 @m Numbers
ok 𝗺𝗶𝗻(1) == 1; ok 𝗺𝗶𝗻(5,4,2,3) == 2;
Find the index of the minimum number in a list confessing to any ill defined values.
ok 𝗶𝗻𝗱𝗲𝘅𝗢𝗳𝗠𝗶𝗻(qw(2 3 1 2)) == 2;
Find the maximum number in a list confessing to any ill defined values.
ok !𝗺𝗮𝘅; ok 𝗺𝗮𝘅(1) == 1; ok 𝗺𝗮𝘅(1,4,2,3) == 4;
Find the index of the maximum number in a list confessing to any ill defined values.
{ok 𝗶𝗻𝗱𝗲𝘅𝗢𝗳𝗠𝗮𝘅(qw(2 3 1 2)) == 1;
Find the sum of any strings that look like numbers in an array
Parameter Description 1 @a Array to sum
{ok 𝗮𝗿𝗿𝗮𝘆𝗦𝘂𝗺 (1..10) == 55;
Find the product of any strings that look like numbers in an array
Parameter Description 1 @a Array to multiply
ok 𝗮𝗿𝗿𝗮𝘆𝗣𝗿𝗼𝗱𝘂𝗰𝘁(1..5) == 120;
Multiply the second and subsequent parameters by the first parameter and return as an array
Parameter Description 1 $multiplier Multiplier 2 @a Array to multiply and return
is_deeply[𝗮𝗿𝗿𝗮𝘆𝗧𝗶𝗺𝗲𝘀(2, 1..5)], [qw(2 4 6 8 10)];
Format data structures as tables.
Find the longest line in a string
Parameter Description 1 $string String of lines of text
ok 3 == 𝗺𝗮𝘅𝗶𝗺𝘂𝗺𝗟𝗶𝗻𝗲𝗟𝗲𝗻𝗴𝘁𝗵(<<END); a bb ccc END
Tabularize an array of arrays of text.
Parameter Description 1 $data Reference to an array of arrays of data to be formatted as a table.
my $d = [[qw(a 1)], [qw(bb 22)], [qw(ccc 333)], [qw(dddd 4444)]]; ok 𝗳𝗼𝗿𝗺𝗮𝘁𝗧𝗮𝗯𝗹𝗲𝗕𝗮𝘀𝗶𝗰($d) eq <<END; a 1 bb 22 ccc 333 dddd 4444 END
Parameter Description 1 $data Data to be formatted 2 $columnTitles Optional reference to an array of titles or string of column descriptions 3 %options Options
ok 𝗳𝗼𝗿𝗺𝗮𝘁𝗧𝗮𝗯𝗹𝗲 ([[qw(A B C D )], [qw(AA BB CC DD )], [qw(AAA BBB CCC DDD )], [qw(AAAA BBBB CCCC DDDD)], [qw(1 22 333 4444)]], [qw(aa bb cc)]) eq <<END; aa bb cc 1 A B C D 2 AA BB CC DD 3 AAA BBB CCC DDD 4 AAAA BBBB CCCC DDDD 5 1 22 333 4444 END ok 𝗳𝗼𝗿𝗺𝗮𝘁𝗧𝗮𝗯𝗹𝗲 ([[qw(1 B C)], [qw(22 BB CC)], [qw(333 BBB CCC)], [qw(4444 22 333)]], [qw(aa bb cc)]) eq <<END; aa bb cc 1 1 B C 2 22 BB CC 3 333 BBB CCC 4 4444 22 333 END ok 𝗳𝗼𝗿𝗺𝗮𝘁𝗧𝗮𝗯𝗹𝗲 ([{aa=>'A', bb=>'B', cc=>'C'}, {aa=>'AA', bb=>'BB', cc=>'CC'}, {aa=>'AAA', bb=>'BBB', cc=>'CCC'}, {aa=>'1', bb=>'22', cc=>'333'} ]) eq <<END; aa bb cc 1 A B C 2 AA BB CC 3 AAA BBB CCC 4 1 22 333 END ok 𝗳𝗼𝗿𝗺𝗮𝘁𝗧𝗮𝗯𝗹𝗲 ({''=>[qw(aa bb cc)], 1=>[qw(A B C)], 22=>[qw(AA BB CC)], 333=>[qw(AAA BBB CCC)], 4444=>[qw(1 22 333)]}) eq <<END; aa bb cc 1 A B C 22 AA BB CC 333 AAA BBB CCC 4444 1 22 333 END ok 𝗳𝗼𝗿𝗺𝗮𝘁𝗧𝗮𝗯𝗹𝗲 ({1=>{aa=>'A', bb=>'B', cc=>'C'}, 22=>{aa=>'AA', bb=>'BB', cc=>'CC'}, 333=>{aa=>'AAA', bb=>'BBB', cc=>'CCC'}, 4444=>{aa=>'1', bb=>'22', cc=>'333'}}) eq <<END; aa bb cc 1 A B C 22 AA BB CC 333 AAA BBB CCC 4444 1 22 333 END ok 𝗳𝗼𝗿𝗺𝗮𝘁𝗧𝗮𝗯𝗹𝗲({aa=>'A', bb=>'B', cc=>'C'}, [qw(aaaa bbbb)]) eq <<END; aaaa bbbb aa A bb B cc C END if (1) { my $file = fpe(qw(report txt)); # Create a report my $t = 𝗳𝗼𝗿𝗺𝗮𝘁𝗧𝗮𝗯𝗹𝗲 ([["a",undef], [undef, "b0ac"]], # Data - please replace 0a with a new line [undef, "BC"], # Column titles file=>$file, # Output file head=><<END); # Header Sample report. Table has NNNN rows. END ok -e $file; ok readFile($file) eq $t; unlink $file; ok nws($t) eq nws(<<END); Sample report. Table has 2 rows. This file: report.txt BC 1 a 2 b c END }
Report of all the reports created. The optional parameters are the same as for formatTable
Parameter Description 1 @options Options
if (1) { @formatTables = (); for my $m(2..8) {formatTable([map {[$_, $_*$m]} 1..$m], [q(Single), qq(* $m)], title=>qq(Multiply by $m)); } ok nws(𝗳𝗼𝗿𝗺𝗮𝘁𝘁𝗲𝗱𝗧𝗮𝗯𝗹𝗲𝘀𝗥𝗲𝗽𝗼𝗿𝘁) eq nws(<<END); Rows Title File 1 2 Multiply by 2 2 3 Multiply by 3 3 4 Multiply by 4 4 5 Multiply by 5 5 6 Multiply by 6 6 7 Multiply by 7 7 8 Multiply by 8 END }
Count the number of unique instances of each value a column in a table assumes.
Parameter Description 1 $data Table == array of arrays 2 $column Column number to summarize.
if (1) { is_deeply [𝘀𝘂𝗺𝗺𝗮𝗿𝗶𝘇𝗲𝗖𝗼𝗹𝘂𝗺𝗻([map {[$_]} qw(A B D B C D C D A C D C B B D)], 0)], [[5, "D"], [4, "B"], [4, "C"], [2, "A"]]; ok nws(formatTable ([map {[split m//, $_]} qw(AA CB CD BC DC DD CD AD AA DC CD CC BB BB BD)], [qw(Col-1 Col-2)], summarize=>1)) eq nws(<<'END'); Summary_of_column - Count of unique values found in each column Use the Geany flick capability by placing your cursor on the first word Comma_Separated_Values_of_column - Comma separated list of the unique values found in each column of these lines and pressing control + down arrow to see each sub report. Col-1 Col-2 1 A A 2 C B 3 C D 4 B C 5 D C 6 D D 7 C D 8 A D 9 A A 10 D C 11 C D 12 C C 13 B B 14 B B 15 B D Summary_of_column_Col-1 Count Col-1 1 5 C 2 4 B 3 3 A 4 3 D Comma_Separated_Values_of_column_Col-1: "C","B","A","D" Summary_of_column_Col-2 Count Col-2 1 6 D 2 4 C 3 3 B 4 2 A Comma_Separated_Values_of_column_Col-2: "D","C","B","A" END }
Count keys down to the specified level.
Parameter Description 1 $maxDepth Maximum depth to count to 2 $ref Reference to an array or a hash
my $a = [[1..3], {map{$_=>1} 1..3}]; my $h = {a=>[1..3], b=>{map{$_=>1} 1..3}}; ok 𝗸𝗲𝘆𝗖𝗼𝘂𝗻𝘁(2, $a) == 6; ok 𝗸𝗲𝘆𝗖𝗼𝘂𝗻𝘁(2, $h) == 6;
Load data structures from lines.
Load an array from lines of text in a string.
Parameter Description 1 $string The string of lines from which to create an array
my $s = 𝗹𝗼𝗮𝗱𝗔𝗿𝗿𝗮𝘆𝗙𝗿𝗼𝗺𝗟𝗶𝗻𝗲𝘀 <<END; a a b b END is_deeply $s, [q(a a), q(b b)]; ok formatTable($s) eq <<END; 0 a a 1 b b END
Load a hash: first word of each line is the key and the rest is the value.
Parameter Description 1 $string The string of lines from which to create a hash
my $s = 𝗹𝗼𝗮𝗱𝗛𝗮𝘀𝗵𝗙𝗿𝗼𝗺𝗟𝗶𝗻𝗲𝘀 <<END; a 10 11 12 b 20 21 22 END is_deeply $s, {a => q(10 11 12), b =>q(20 21 22)}; ok formatTable($s) eq <<END; a 10 11 12 b 20 21 22 END
Load an array of arrays from lines of text: each line is an array of words.
Parameter Description 1 $string The string of lines from which to create an array of arrays
my $s = 𝗹𝗼𝗮𝗱𝗔𝗿𝗿𝗮𝘆𝗔𝗿𝗿𝗮𝘆𝗙𝗿𝗼𝗺𝗟𝗶𝗻𝗲𝘀 <<END; A B C AA BB CC END is_deeply $s, [[qw(A B C)], [qw(AA BB CC)]]; ok formatTable($s) eq <<END; 1 A B C 2 AA BB CC END
Load a hash of arrays from lines of text: the first word of each line is the key, the remaining words are the array contents.
Parameter Description 1 $string The string of lines from which to create a hash of arrays
my $s = 𝗹𝗼𝗮𝗱𝗛𝗮𝘀𝗵𝗔𝗿𝗿𝗮𝘆𝗙𝗿𝗼𝗺𝗟𝗶𝗻𝗲𝘀 <<END; a A B C b AA BB CC END is_deeply $s, {a =>[qw(A B C)], b => [qw(AA BB CC)] }; ok formatTable($s) eq <<END; a A B C b AA BB CC END
Load an array of hashes from lines of text: each line is a hash of words.
my $s = 𝗹𝗼𝗮𝗱𝗔𝗿𝗿𝗮𝘆𝗛𝗮𝘀𝗵𝗙𝗿𝗼𝗺𝗟𝗶𝗻𝗲𝘀 <<END; A 1 B 2 AA 11 BB 22 END is_deeply $s, [{A=>1, B=>2}, {AA=>11, BB=>22}]; ok formatTable($s) eq <<END; A AA B BB 1 1 2 2 11 22 END
Load a hash of hashes from lines of text: the first word of each line is the key, the remaining words are the sub hash contents.
my $s = 𝗹𝗼𝗮𝗱𝗛𝗮𝘀𝗵𝗛𝗮𝘀𝗵𝗙𝗿𝗼𝗺𝗟𝗶𝗻𝗲𝘀 <<END; a A 1 B 2 b AA 11 BB 22 END is_deeply $s, {a=>{A=>1, B=>2}, b=>{AA=>11, BB=>22}}; ok formatTable($s) eq <<END; A AA B BB a 1 2 b 11 22 END
Check the keys in a hash.
Parameter Description 1 $test The hash to test 2 $permitted A hash of the permitted keys and their meanings
eval q{𝗰𝗵𝗲𝗰𝗸𝗞𝗲𝘆𝘀({a=>1, b=>2, d=>3}, {a=>1, b=>2, c=>3})}; ok nws($@) =~ m(\AInvalid options chosen: d Permitted.+?: a 1 b 2 c 3);
Replace $a->{value} = $b with $a->value = $b which reduces the amount of typing required, is easier to read and provides a hard check that {value} is spelled correctly.
Generate lvalue scalar methods in the current package, A method whose value has not yet been set will return a new scalar with value undef. Suffixing X to the scalar name will confess if a value has not been set.
Parameter Description 1 @names List of method names
package Scalars; my $a = bless{}; Data::Table::Text::𝗴𝗲𝗻𝗟𝗩𝗮𝗹𝘂𝗲𝗦𝗰𝗮𝗹𝗮𝗿𝗠𝗲𝘁𝗵𝗼𝗱𝘀(qw(aa bb cc)); $a->aa = 'aa'; Test::More::ok $a->aa eq 'aa'; Test::More::ok !$a->bb; Test::More::ok $a->bbX eq q(); $a->aa = undef; Test::More::ok !$a->aa;
Generate lvalue scalar methods in the current package if they do not already exist. A method whose value has not yet been set will return a new scalar with value undef. Suffixing X to the scalar name will confess if a value has not been set.
my $class = "Data::Table::Text::Test"; my $a = bless{}, $class; 𝗮𝗱𝗱𝗟𝗩𝗮𝗹𝘂𝗲𝗦𝗰𝗮𝗹𝗮𝗿𝗠𝗲𝘁𝗵𝗼𝗱𝘀(qq(${class}::$_)) for qw(aa bb aa bb); $a->aa = 'aa'; ok $a->aa eq 'aa'; ok !$a->bb; ok $a->bbX eq q(); $a->aa = undef; ok !$a->aa;
Generate lvalue scalar methods with default values in the current package. A reference to a method whose value has not yet been set will return a scalar whose value is the name of the method.
package ScalarsWithDefaults; my $a = bless{}; Data::Table::Text::𝗴𝗲𝗻𝗟𝗩𝗮𝗹𝘂𝗲𝗦𝗰𝗮𝗹𝗮𝗿𝗠𝗲𝘁𝗵𝗼𝗱𝘀𝗪𝗶𝘁𝗵𝗗𝗲𝗳𝗮𝘂𝗹𝘁𝗩𝗮𝗹𝘂𝗲𝘀(qw(aa bb cc)); Test::More::ok $a->aa eq 'aa';
Generate lvalue array methods in the current package. A reference to a method that has no yet been set will return a reference to an empty array.
package Arrays; my $a = bless{}; Data::Table::Text::𝗴𝗲𝗻𝗟𝗩𝗮𝗹𝘂𝗲𝗔𝗿𝗿𝗮𝘆𝗠𝗲𝘁𝗵𝗼𝗱𝘀(qw(aa bb cc)); $a->aa->[1] = 'aa'; Test::More::ok $a->aa->[1] eq 'aa';
Generate lvalue hash methods in the current package. A reference to a method that has no yet been set will return a reference to an empty hash.
Parameter Description 1 @names Method names
package Hashes; my $a = bless{}; Data::Table::Text::𝗴𝗲𝗻𝗟𝗩𝗮𝗹𝘂𝗲𝗛𝗮𝘀𝗵𝗠𝗲𝘁𝗵𝗼𝗱𝘀(qw(aa bb cc)); $a->aa->{a} = 'aa'; Test::More::ok $a->aa->{a} eq 'aa';
Parameter Description 1 $bless Package name 2 %attributes Hash of attribute names and values
if (1) { my $o = 𝗴𝗲𝗻𝗛𝗮𝘀𝗵(q(TestHash), # Definition of a blessed hash. a=>q(aa), # Definition of attribute aa. b=>q(bb), # Definition of attribute bb. ); ok $o->a eq q(aa); is_deeply $o, {a=>"aa", b=>"bb"}; my $p = 𝗴𝗲𝗻𝗛𝗮𝘀𝗵(q(TestHash), c=>q(cc), # Definition of attribute cc. ); ok $p->c eq q(cc); ok $p->a = q(aa); ok $p->a eq q(aa); is_deeply $p, {a=>"aa", c=>"cc"}; loadHash($p, a=>11, b=>22); # Load the hash is_deeply $p, {a=>11, b=>22, c=>"cc"}; my $r = eval {loadHash($p, d=>44)}; # Try to load the hash ok $@ =~ m(Cannot load attribute: d); }
Load the specified $hash generated with genHash with %attributes. Confess to any unknown attribute names.
Parameter Description 1 $hash Hash 2 %attributes Hash of attribute names and values to be loaded
if (1) { my $o = genHash(q(TestHash), # Definition of a blessed hash. a=>q(aa), # Definition of attribute aa. b=>q(bb), # Definition of attribute bb. ); ok $o->a eq q(aa); is_deeply $o, {a=>"aa", b=>"bb"}; my $p = genHash(q(TestHash), c=>q(cc), # Definition of attribute cc. ); ok $p->c eq q(cc); ok $p->a = q(aa); ok $p->a eq q(aa); is_deeply $p, {a=>"aa", c=>"cc"}; 𝗹𝗼𝗮𝗱𝗛𝗮𝘀𝗵($p, a=>11, b=>22); # Load the hash is_deeply $p, {a=>11, b=>22, c=>"cc"}; my $r = eval {𝗹𝗼𝗮𝗱𝗛𝗮𝘀𝗵($p, d=>44)}; # Try to load the hash ok $@ =~ m(Cannot load attribute: d); }
Ensures that all the hashes within a tower of data structures have LValue methods to get and set their current keys.
Parameter Description 1 $d Data structure
if (1) {my $a = bless [bless {aaa=>42}, "AAAA"], "BBBB"; eval {$a->[0]->aaa}; ok $@ =~ m(\ACan.t locate object method .aaa. via package .AAAA.); 𝗿𝗲𝗹𝗼𝗮𝗱𝗛𝗮𝘀𝗵𝗲𝘀($a); ok $a->[0]->aaa == 42; } if (1) {my $a = bless [bless {ccc=>42}, "CCCC"], "DDDD"; eval {$a->[0]->ccc}; ok $@ =~ m(\ACan.t locate object method .ccc. via package .CCCC.); 𝗿𝗲𝗹𝗼𝗮𝗱𝗛𝗮𝘀𝗵𝗲𝘀($a); ok $a->[0]->ccc == 42; }
Set a package search order for methods requested in the current package via AUTOLOAD.
Parameter Description 1 $set Package to set 2 @search Package names in search order.
if (1) {if (1) {package AAAA; sub aaaa{q(AAAAaaaa)} sub bbbb{q(AAAAbbbb)} sub cccc{q(AAAAcccc)} } if (1) {package BBBB; sub aaaa{q(BBBBaaaa)} sub bbbb{q(BBBBbbbb)} sub dddd{q(BBBBdddd)} } if (1) {package CCCC; sub aaaa{q(CCCCaaaa)} sub dddd{q(CCCCdddd)} sub eeee{q(CCCCeeee)} } 𝘀𝗲𝘁𝗣𝗮𝗰𝗸𝗮𝗴𝗲𝗦𝗲𝗮𝗿𝗰𝗵𝗢𝗿𝗱𝗲𝗿(__PACKAGE__, qw(CCCC BBBB AAAA)); ok &aaaa eq q(CCCCaaaa); ok &bbbb eq q(BBBBbbbb); ok &cccc eq q(AAAAcccc); ok &aaaa eq q(CCCCaaaa); ok &bbbb eq q(BBBBbbbb); ok &cccc eq q(AAAAcccc); ok &dddd eq q(CCCCdddd); ok &eeee eq q(CCCCeeee); 𝘀𝗲𝘁𝗣𝗮𝗰𝗸𝗮𝗴𝗲𝗦𝗲𝗮𝗿𝗰𝗵𝗢𝗿𝗱𝗲𝗿(__PACKAGE__, qw(AAAA BBBB CCCC)); ok &aaaa eq q(AAAAaaaa); ok &bbbb eq q(AAAAbbbb); ok &cccc eq q(AAAAcccc); ok &aaaa eq q(AAAAaaaa); ok &bbbb eq q(AAAAbbbb); ok &cccc eq q(AAAAcccc); ok &dddd eq q(BBBBdddd); ok &eeee eq q(CCCCeeee); }
Test whether a subroutine is present in a package.
Parameter Description 1 $package Package name 2 $sub Subroutine name
if (1) {sub AAAA::Call {q(AAAA)} sub BBBB::Call {q(BBBB)} sub BBBB::call {q(bbbb)} if (1) {package BBBB; use Test::More; *ok = *Test::More::ok; *𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲 = *Data::Table::Text::𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲; ok 𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲(q(AAAA), q(Call)); ok !𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲(q(AAAA), q(call)); ok 𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲(q(BBBB), q(Call)); ok 𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲(q(BBBB), q(call)); ok Call eq q(BBBB); ok call eq q(bbbb); &Data::Table::Text::overrideMethods(qw(AAAA BBBB Call call)); *𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲 = *Data::Table::Text::𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲; ok 𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲(q(AAAA), q(Call)); ok 𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲(q(AAAA), q(call)); ok 𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲(q(BBBB), q(Call)); ok 𝗶𝘀𝗦𝘂𝗯𝗜𝗻𝗣𝗮𝗰𝗸𝗮𝗴𝗲(q(BBBB), q(call)); ok Call eq q(AAAA); ok call eq q(bbbb); package AAAA; use Test::More; *ok = *Test::More::ok; ok Call eq q(AAAA); ok &call eq q(bbbb); } }
For each method, if it exists in package $from then export it to package $to replacing any existing method in $to, otherwise export the method from package $to to package $from in order to merge the behavior of the $from and $to packages with respect to the named methods with duplicates resolved if favour of package $from.
Parameter Description 1 $from Name of package from which to import methods 2 $to Package into which to import the methods 3 @methods List of methods to try importing.
if (1) {sub AAAA::Call {q(AAAA)} sub BBBB::Call {q(BBBB)} sub BBBB::call {q(bbbb)} if (1) {package BBBB; use Test::More; *ok = *Test::More::ok; *isSubInPackage = *Data::Table::Text::isSubInPackage; ok isSubInPackage(q(AAAA), q(Call)); ok !isSubInPackage(q(AAAA), q(call)); ok isSubInPackage(q(BBBB), q(Call)); ok isSubInPackage(q(BBBB), q(call)); ok Call eq q(BBBB); ok call eq q(bbbb); &Data::Table::Text::𝗼𝘃𝗲𝗿𝗿𝗶𝗱𝗲𝗠𝗲𝘁𝗵𝗼𝗱𝘀(qw(AAAA BBBB Call call)); *isSubInPackage = *Data::Table::Text::isSubInPackage; ok isSubInPackage(q(AAAA), q(Call)); ok isSubInPackage(q(AAAA), q(call)); ok isSubInPackage(q(BBBB), q(Call)); ok isSubInPackage(q(BBBB), q(call)); ok Call eq q(AAAA); ok call eq q(bbbb); package AAAA; use Test::More; *ok = *Test::More::ok; ok Call eq q(AAAA); ok &call eq q(bbbb); } }
This is a static method and so should be invoked as:
Data::Table::Text::overrideMethods
Confirm that the specified references are to the specified package
Parameter Description 1 $package Package 2 @refs References
if (1) { eval q{𝗮𝘀𝘀𝗲𝗿𝘁𝗣𝗮𝗰𝗸𝗮𝗴𝗲𝗥𝗲𝗳𝘀(q(bbb), bless {}, q(aaa))}; ok $@ =~ m(\AWanted reference to bbb, but got aaa); }
Confirm that the specified references are to the package into which this routine has been exported.
Parameter Description 1 @refs References
if (1) { eval q{𝗮𝘀𝘀𝗲𝗿𝘁𝗥𝗲𝗳(bless {}, q(aaa))}; ok $@ =~ m(\AWanted reference to Data::Table::Text, but got aaa); }
Immediately executed inline sub to allow a code block before if.
Parameter Description 1 $sub Sub enclosed in {} without the word "sub"
ok ˢ{1} == 1; ok ˢ{1}; ˢ{my $s = ˢ{if (1) {return q(aa) if 1; q(bb); } }; ok $s eq q(aa); };
Create a hash from an array
Parameter Description 1 @array Array
is_deeply 𝗮𝗿𝗿𝗮𝘆𝗧𝗼𝗛𝗮𝘀𝗵(qw(a b c)), {a=>1, b=>1, c=>1};
Actions on strings.
Indent lines contained in a string or formatted table by the specified string.
Parameter Description 1 $string The string of lines to indent 2 $indent The indenting string
my $t = [qw(aa bb cc)]; my $d = [[qw(A B C)], [qw(AA BB CC)], [qw(AAA BBB CCC)], [qw(1 22 333)]]; ok $s eq <<END; 1 A B C 2 AA BB CC 3 AAA BBB CCC 4 1 22 333 END
Test whether a string is blank.
ok 𝗶𝘀𝗕𝗹𝗮𝗻𝗸(""); ok 𝗶𝘀𝗕𝗹𝗮𝗻𝗸(" ");
Remove any white space from the front and end of a string.
ok 𝘁𝗿𝗶𝗺(" a b ") eq join ' ', qw(a b);
Pad a string with blanks or the specified padding character to a multiple of a specified length.
Parameter Description 1 $string String 2 $length Tab width 3 $pad Padding char
ok 𝗽𝗮𝗱('abc ', 2).'=' eq "abc ="; ok 𝗽𝗮𝗱('abc ', 3).'=' eq "abc="; ok 𝗽𝗮𝗱('abc ', 4, q(.)).'=' eq "abc.=";
First N characters of a string.
Parameter Description 1 $string String 2 $length Length
ok 𝗳𝗶𝗿𝘀𝘁𝗡𝗖𝗵𝗮𝗿𝘀(q(abc), 2) eq q(ab); ok 𝗳𝗶𝗿𝘀𝘁𝗡𝗖𝗵𝗮𝗿𝘀(q(abc), 4) eq q(abc);
Normalize white space in a string to make comparisons easier. Leading and trailing white space is removed; blocks of white space in the interior are reduced to a single space. In effect: this puts everything on one long line with never more than one space at a time. Optionally a maximum length is applied to the normalized string.
Parameter Description 1 $string String to normalize 2 $length Maximum length of result
ok 𝗻𝘄𝘀(qq(a b c)) eq q(a b c);
Return the common start followed by the two non equal tails of two non equal strings or an empty list if the strings are equal.
Parameter Description 1 $a First string 2 $b Second string
if (1) { ok !𝘀𝘁𝗿𝗶𝗻𝗴𝘀𝗔𝗿𝗲𝗡𝗼𝘁𝗘𝗾𝘂𝗮𝗹(q(abc), q(abc)); ok 𝘀𝘁𝗿𝗶𝗻𝗴𝘀𝗔𝗿𝗲𝗡𝗼𝘁𝗘𝗾𝘂𝗮𝗹(q(abc), q(abd)); is_deeply [𝘀𝘁𝗿𝗶𝗻𝗴𝘀𝗔𝗿𝗲𝗡𝗼𝘁𝗘𝗾𝘂𝗮𝗹(q(abc), q(abd))], [qw(ab c d)]; is_deeply [𝘀𝘁𝗿𝗶𝗻𝗴𝘀𝗔𝗿𝗲𝗡𝗼𝘁𝗘𝗾𝘂𝗮𝗹(q(ab), q(abd))], [q(ab), '', q(d)]; }
Extract the package name from a java string or file.
Parameter Description 1 $java Java file if it exists else the string of java
overWriteFile($f, <<END); // Test package com.xyz; END ok 𝗷𝗮𝘃𝗮𝗣𝗮𝗰𝗸𝗮𝗴𝗲($f) eq "com.xyz";
Extract the package name from a java string or file and convert it to a file name.
overWriteFile($f, <<END); // Test package com.xyz; END ok 𝗷𝗮𝘃𝗮𝗣𝗮𝗰𝗸𝗮𝗴𝗲𝗔𝘀𝗙𝗶𝗹𝗲𝗡𝗮𝗺𝗲($f) eq "com/xyz";
Extract the package name from a perl string or file.
Parameter Description 1 $perl Perl file if it exists else the string of perl
overWriteFile($f, <<END); package a::b; END ok 𝗽𝗲𝗿𝗹𝗣𝗮𝗰𝗸𝗮𝗴𝗲($f) eq "a::b";
Print an array of words in qw() format.
Parameter Description 1 @words Array of words
ok 𝗽𝗿𝗶𝗻𝘁𝗤𝘄(qw(a b c)) eq q(qw(a b c));
The number of lines in a string.
ok 𝗻𝘂𝗺𝗯𝗲𝗿𝗢𝗳𝗟𝗶𝗻𝗲𝘀𝗜𝗻𝗦𝘁𝗿𝗶𝗻𝗴("a b ") == 2;
Translate ascii alphanumerics in strings to various Unicode blocks.
Convert alphanumerics in a string to bold.
Parameter Description 1 $string String to convert
ok 𝗯𝗼𝗹𝗱𝗦𝘁𝗿𝗶𝗻𝗴(q(zZ)) eq q(𝘇𝗭);
Undo alphanumerics in a string to bold.
if (1) {my $n = 1234567890; ok 𝗯𝗼𝗹𝗱𝗦𝘁𝗿𝗶𝗻𝗴𝗨𝗻𝗱𝗼 (boldString($n)) == $n; ok enclosedStringUndo (enclosedString($n)) == $n; ok enclosedReversedStringUndo(enclosedReversedString($n)) == $n; ok superScriptStringUndo (superScriptString($n)) == $n; ok subScriptStringUndo (subScriptString($n)) == $n; }
Convert alphanumerics in a string to enclosed alphanumerics.
ok 𝗲𝗻𝗰𝗹𝗼𝘀𝗲𝗱𝗦𝘁𝗿𝗶𝗻𝗴(q(hello world 1234)) eq q(ⓗⓔⓛⓛⓞ ⓦⓞⓡⓛⓓ ①②③④);
Undo alphanumerics in a string to enclosed alphanumerics.
if (1) {my $n = 1234567890; ok boldStringUndo (boldString($n)) == $n; ok 𝗲𝗻𝗰𝗹𝗼𝘀𝗲𝗱𝗦𝘁𝗿𝗶𝗻𝗴𝗨𝗻𝗱𝗼 (enclosedString($n)) == $n; ok enclosedReversedStringUndo(enclosedReversedString($n)) == $n; ok superScriptStringUndo (superScriptString($n)) == $n; ok subScriptStringUndo (subScriptString($n)) == $n; }
Convert alphanumerics in a string to enclosed reversed alphanumerics.
ok 𝗲𝗻𝗰𝗹𝗼𝘀𝗲𝗱𝗥𝗲𝘃𝗲𝗿𝘀𝗲𝗱𝗦𝘁𝗿𝗶𝗻𝗴(q(hello world 1234)) eq q(🅗🅔🅛🅛🅞 🅦🅞🅡🅛🅓 ➊➋➌➍);
Undo alphanumerics in a string to enclosed reversed alphanumerics.
if (1) {my $n = 1234567890; ok boldStringUndo (boldString($n)) == $n; ok enclosedStringUndo (enclosedString($n)) == $n; ok 𝗲𝗻𝗰𝗹𝗼𝘀𝗲𝗱𝗥𝗲𝘃𝗲𝗿𝘀𝗲𝗱𝗦𝘁𝗿𝗶𝗻𝗴𝗨𝗻𝗱𝗼(enclosedReversedString($n)) == $n; ok superScriptStringUndo (superScriptString($n)) == $n; ok subScriptStringUndo (subScriptString($n)) == $n; }
Convert alphanumerics in a string to super scripts
ok 𝘀𝘂𝗽𝗲𝗿𝗦𝗰𝗿𝗶𝗽𝘁𝗦𝘁𝗿𝗶𝗻𝗴(1234567890) eq q(¹²³⁴⁵⁶⁷⁸⁹⁰);
Undo alphanumerics in a string to super scripts
if (1) {my $n = 1234567890; ok boldStringUndo (boldString($n)) == $n; ok enclosedStringUndo (enclosedString($n)) == $n; ok enclosedReversedStringUndo(enclosedReversedString($n)) == $n; ok 𝘀𝘂𝗽𝗲𝗿𝗦𝗰𝗿𝗶𝗽𝘁𝗦𝘁𝗿𝗶𝗻𝗴𝗨𝗻𝗱𝗼 (superScriptString($n)) == $n; ok subScriptStringUndo (subScriptString($n)) == $n; }
Convert alphanumerics in a string to sub scripts
ok 𝘀𝘂𝗯𝗦𝗰𝗿𝗶𝗽𝘁𝗦𝘁𝗿𝗶𝗻𝗴(1234567890) eq q(₁₂₃₄₅₆₇₈₉₀);
Undo alphanumerics in a string to sub scripts
if (1) {my $n = 1234567890; ok boldStringUndo (boldString($n)) == $n; ok enclosedStringUndo (enclosedString($n)) == $n; ok enclosedReversedStringUndo(enclosedReversedString($n)) == $n; ok superScriptStringUndo (superScriptString($n)) == $n; ok 𝘀𝘂𝗯𝗦𝗰𝗿𝗶𝗽𝘁𝗦𝘁𝗿𝗶𝗻𝗴𝗨𝗻𝗱𝗼 (subScriptString($n)) == $n; }
Return the file name quoted if its contents are in utf8 else return undef
Parameter Description 1 $file File to test
if (0) { my $f = writeFile(undef, "aaa"); ok 𝗶𝘀𝗙𝗶𝗹𝗲𝗨𝘁𝗳𝟴 $f; }
Send messages between processes via a unix domain socket.
Create a communications server - a means to communicate between processes on the same machine via Udsr::read and Udsr::write.
Parameter Description 1 @parms Attributes per L<Udsr Definition|/Udsr Definition>
if (1) { my $N = 20; my $s = 𝗻𝗲𝘄𝗨𝗱𝘀𝗿𝗦𝗲𝗿𝘃𝗲𝗿(serverAction=>sub {my ($u) = @_; my $r = $u->read; $u->write(qq(Hello from server $r)); }); my $p = newProcessStarter(min(100, $N)); # Run some clients for my $i(1..$N) {$p->start(sub {my $count = 0; for my $j(1..$N) {my $c = newUdsrClient; my $m = qq(Hello from client $i x $j); $c->write($m); my $r = $c->read; ++$count if $r eq qq(Hello from server $m); } [$count] }); } my $count; for my $r($p->finish) # Consolidate results {my ($c) = @$r; $count += $c; } ok $count == $N*$N; # Check results and kill $s->kill; }
Create a new communications client - a means to communicate between processes on the same machine via Udsr::read and Udsr::write.
if (1) { my $N = 20; my $s = newUdsrServer(serverAction=>sub {my ($u) = @_; my $r = $u->read; $u->write(qq(Hello from server $r)); }); my $p = newProcessStarter(min(100, $N)); # Run some clients for my $i(1..$N) {$p->start(sub {my $count = 0; for my $j(1..$N) {my $c = 𝗻𝗲𝘄𝗨𝗱𝘀𝗿𝗖𝗹𝗶𝗲𝗻𝘁; my $m = qq(Hello from client $i x $j); $c->write($m); my $r = $c->read; ++$count if $r eq qq(Hello from server $m); } [$count] }); } my $count; for my $r($p->finish) # Consolidate results {my ($c) = @$r; $count += $c; } ok $count == $N*$N; # Check results and kill $s->kill; }
Write a communications message to the newUdsrServer or the newUdsrClient.
Parameter Description 1 $u Communicator 2 $msg Message
if (1) { my $N = 20; my $s = newUdsrServer(serverAction=>sub {my ($u) = @_; my $r = $u->read; $u->write(qq(Hello from server $r)); }); my $p = newProcessStarter(min(100, $N)); # Run some clients for my $i(1..$N) {$p->start(sub {my $count = 0; for my $j(1..$N) {my $c = newUdsrClient; my $m = qq(Hello from client $i x $j); $c->write($m); my $r = $c->read; ++$count if $r eq qq(Hello from server $m); } [$count] }); } my $count; for my $r($p->finish) # Consolidate results {my ($c) = @$r; $count += $c; } ok $count == $N*$N; # Check results and kill $s->kill; }
Read a message from the newUdsrServer or the newUdsrClient.
Parameter Description 1 $u Communicator
Kill a communications server.
Useful for operating across the cloud.
Force die to confess where the death occurred.
𝗺𝗮𝗸𝗲𝗗𝗶𝗲𝗖𝗼𝗻𝗳𝗲𝘀𝘀
Get the ip address of a server on the local network by hostname via arp
Parameter Description 1 $hostName Host name
𝗶𝗽𝗔𝗱𝗱𝗿𝗲𝘀𝘀𝗩𝗶𝗮𝗔𝗿𝗽(q(secarias));
Save source code files.
Parameter Description 1 $saveCodeEvery Save every seconds 2 $folder Folder to save 3 $zipFileName Zip file name 4 $bucket Bucket/key 5 $S3Parms Additional S3 parameters like profile or region as a string
𝘀𝗮𝘃𝗲𝗖𝗼𝗱𝗲𝗧𝗼𝗦𝟯(1200, q(.), q(projectName), q(bucket/folder), q(--quiet));
Add a certificate to the current ssh session.
Parameter Description 1 $file File containing certificate
𝗮𝗱𝗱𝗖𝗲𝗿𝘁𝗶𝗳𝗶𝗰𝗮𝘁𝗲(fpf(qw(.ssh cert)));
The name of the host we are running on.
𝗵𝗼𝘀𝘁𝗡𝗮𝗺𝗲;
The userid we are currently running under.
𝘂𝘀𝗲𝗿𝗜𝗱;
Percent encode a url per: https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters
if (1) { ok 𝘄𝘄𝘄𝗘𝗻𝗰𝗼𝗱𝗲(q(a {b} <c>)) eq q(a%20%20%7bb%7d%20%3cc%3e); ok 𝘄𝘄𝘄𝗘𝗻𝗰𝗼𝗱𝗲(q(../)) eq q(%2e%2e/); ok wwwDecode(𝘄𝘄𝘄𝗘𝗻𝗰𝗼𝗱𝗲 $_) eq $_ for q(a {b} <c>), q(a b|c), q(%), q(%%), q(%%.%%); } sub 𝘄𝘄𝘄𝗘𝗻𝗰𝗼𝗱𝗲($) {my ($string) = @_; # String join '', map {$translatePercentEncoding{$_}//$_} split //, $string }
Percent decode a url per: https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters
if (1) { ok wwwEncode(q(a {b} <c>)) eq q(a%20%20%7bb%7d%20%3cc%3e); ok wwwEncode(q(../)) eq q(%2e%2e/); ok 𝘄𝘄𝘄𝗗𝗲𝗰𝗼𝗱𝗲(wwwEncode $_) eq $_ for q(a {b} <c>), q(a b|c), q(%), q(%%), q(%%.%%); } sub 𝘄𝘄𝘄𝗗𝗲𝗰𝗼𝗱𝗲($) {my ($string) = @_; # String my $r = ''; my @s = split //, $string; while(@s) {my $c = shift @s; if ($c eq q(%) and @s >= 2) {$c .= shift(@s).shift(@s); $r .= $TranslatePercentEncoding{$c}//$c; } else {$r .= $c; } } $r }
Translate $text from English to a specified $language using AWS Translate with the specified global $options and return the translated string. Translations are cached in the specified $cacheFolder for reuse were feasible.
Parameter Description 1 $string String to translate 2 $language Language code 3 $cacheFolder Cache folder 4 $Options Aws global options string
ok 𝗮𝘄𝘀𝗧𝗿𝗮𝗻𝘀𝗹𝗮𝘁𝗲𝗧𝗲𝘅𝘁("Hello", "it", ".translations/") eq q(Ciao);
Start processes, wait for them to terminate and retrieve their results
Start new processes while the number of child processes recorded in %$pids is less than the specified $maximum. Use waitForAllStartedProcessesToFinish to wait for all these processes to finish.
Parameter Description 1 $sub Sub to start 2 $pids Hash in which to record the process ids 3 $maximum Maximum number of processes to run at a time
if (0) { my %pids; ˢ{𝘀𝘁𝗮𝗿𝘁𝗣𝗿𝗼𝗰𝗲𝘀𝘀 {} %pids, 1; ok 1 >= keys %pids} for 1..8; waitForAllStartedProcessesToFinish(%pids); ok !keys(%pids) }
Wait until all the processes started by startProcess have finished.
Parameter Description 1 $pids Hash of started process ids
if (0) { my %pids; ˢ{startProcess {} %pids, 1; ok 1 >= keys %pids} for 1..8; 𝘄𝗮𝗶𝘁𝗙𝗼𝗿𝗔𝗹𝗹𝗦𝘁𝗮𝗿𝘁𝗲𝗱𝗣𝗿𝗼𝗰𝗲𝘀𝘀𝗲𝘀𝗧𝗼𝗙𝗶𝗻𝗶𝘀𝗵(%pids); ok !keys(%pids) }
Parameter Description 1 $maximumNumberOfProcesses Maximum number of processes to start 2 $transferArea Optional folder to be used to save and retrieve results.
if (1) {my $N = 100; my $l = q(logFile.txt); unlink $l; my $s = 𝗻𝗲𝘄𝗣𝗿𝗼𝗰𝗲𝘀𝘀𝗦𝘁𝗮𝗿𝘁𝗲𝗿(4, q(processes)); $s->processingTitle = q(Test processes); $s->totalToBeStarted = $N; $s->processingLogFile = $l; for my $i(1..$N) {Data::Table::Text::Starter::start($s, sub{$i*$i}); } is_deeply [sort {$a <=> $b} Data::Table::Text::Starter::finish($s)], [map {$_**2} 1..$N]; ok readFile($l) =~ m(Finished $N processes for: Test processes)s; clearFolder($s->transferArea, 1e3); unlink $l; }
Start a new process to run the specified $sub.
Parameter Description 1 $starter Starter 2 $sub Sub to be run.
if (1) {my $N = 100; my $l = q(logFile.txt); unlink $l; my $s = newProcessStarter(4, q(processes)); $s->processingTitle = q(Test processes); $s->totalToBeStarted = $N; $s->processingLogFile = $l; for my $i(1..$N) {𝗗𝗮𝘁𝗮::𝗧𝗮𝗯𝗹𝗲::𝗧𝗲𝘅𝘁::𝗦𝘁𝗮𝗿𝘁𝗲𝗿::𝘀𝘁𝗮𝗿𝘁($s, sub{$i*$i}); } is_deeply [sort {$a <=> $b} Data::Table::Text::Starter::finish($s)], [map {$_**2} 1..$N]; ok readFile($l) =~ m(Finished $N processes for: Test processes)s; clearFolder($s->transferArea, 1e3); unlink $l; }
Wait for all started processes to finish and return their results as an array.
Parameter Description 1 $starter Starter
if (1) {my $N = 100; my $l = q(logFile.txt); unlink $l; my $s = newProcessStarter(4, q(processes)); $s->processingTitle = q(Test processes); $s->totalToBeStarted = $N; $s->processingLogFile = $l; for my $i(1..$N) {Data::Table::Text::Starter::start($s, sub{$i*$i}); } is_deeply [sort {$a <=> $b} 𝗗𝗮𝘁𝗮::𝗧𝗮𝗯𝗹𝗲::𝗧𝗲𝘅𝘁::𝗦𝘁𝗮𝗿𝘁𝗲𝗿::𝗳𝗶𝗻𝗶𝘀𝗵($s)], [map {$_**2} 1..$N]; ok readFile($l) =~ m(Finished $N processes for: Test processes)s; clearFolder($s->transferArea, 1e3); unlink $l; }
Create a two dimensional square array from a one dimensional linear array.
if (1) { is_deeply [𝘀𝗾𝘂𝗮𝗿𝗲𝗔𝗿𝗿𝗮𝘆 @{[1..4]} ], [[1, 2], [3, 4]]; is_deeply [𝘀𝗾𝘂𝗮𝗿𝗲𝗔𝗿𝗿𝗮𝘆 @{[1..22]}], [[1 .. 5], [6 .. 10], [11 .. 15], [16 .. 20], [21, 22]]; is_deeply [1..$_], [deSquareArray 𝘀𝗾𝘂𝗮𝗿𝗲𝗔𝗿𝗿𝗮𝘆 @{[1..$_]}] for 1..22; ok $_ == countSquareArray 𝘀𝗾𝘂𝗮𝗿𝗲𝗔𝗿𝗿𝗮𝘆 @{[1..$_]} for 222; }
Create a one dimensional array from a two dimensional array of arrays
Parameter Description 1 @square Array of arrays
if (1) { is_deeply [squareArray @{[1..4]} ], [[1, 2], [3, 4]]; is_deeply [squareArray @{[1..22]}], [[1 .. 5], [6 .. 10], [11 .. 15], [16 .. 20], [21, 22]]; is_deeply [1..$_], [𝗱𝗲𝗦𝗾𝘂𝗮𝗿𝗲𝗔𝗿𝗿𝗮𝘆 squareArray @{[1..$_]}] for 1..22; ok $_ == countSquareArray squareArray @{[1..$_]} for 222; }
Create a new service incarnation to record the start up of a new instance of a service and return the description as a Data::Exchange::Service Definition hash.
Parameter Description 1 $service Service name 2 $file Optional details file
if (1) {my $s = 𝗻𝗲𝘄𝗦𝗲𝗿𝘃𝗶𝗰𝗲𝗜𝗻𝗰𝗮𝗿𝗻𝗮𝘁𝗶𝗼𝗻("aaa", q(bbb.txt)); is_deeply $s->check, $s; my $t = 𝗻𝗲𝘄𝗦𝗲𝗿𝘃𝗶𝗰𝗲𝗜𝗻𝗰𝗮𝗿𝗻𝗮𝘁𝗶𝗼𝗻("aaa", q(bbb.txt)); is_deeply $t->check, $t; ok $t->start >= $s->start+1; ok !$s->check(1); unlink q(bbb.txt); }
Check that we are the current incarnation of the named service with details obtained from newServiceIncarnation. If the optional $continue flag has been set then return the service details if this is the current service incarnation else undef. Otherwise if the $continue flag is false confess unless this is the current service incarnation thus bringing the earlier version of this service to an abrupt end.
Parameter Description 1 $service Current service details 2 $continue Return result if B<$continue> is true else confess if the service has been replaced
if (1) {my $s = newServiceIncarnation("aaa", q(bbb.txt)); is_deeply $s->check, $s; my $t = newServiceIncarnation("aaa", q(bbb.txt)); is_deeply $t->check, $t; ok $t->start >= $s->start+1; ok !$s->check(1); unlink q(bbb.txt); }
Extract, format and update documentation for a perl module.
Report the current values of parameterless subs in a $sourceFile that match \Asub\s+(\w+)\s*\{ and optionally write the report to $reportFile. Return the text of the report.
Parameter Description 1 $sourceFile Source file 2 $reportFile Optional report file
𝗿𝗲𝗽𝗼𝗿𝘁𝗦𝗲𝘁𝘁𝗶𝗻𝗴𝘀($0);
Generate a table of contents for some html.
Parameter Description 1 $replace Sub-string within the html to be replaced with the toc 2 $html String of html
ok nws(𝗵𝘁𝗺𝗹𝗧𝗼𝗰("XXXX", <<END)), '𝗵𝘁𝗺𝗹𝗧𝗼𝗰' <h1 id="1" otherprops="1">Chapter 1</h1> <h2 id="11" otherprops="11">Section 1</h1> <h1 id="2" otherprops="2">Chapter 2</h1> XXXX END eq nws(<<END); <h1 id="1" otherprops="1">Chapter 1</h1> <h2 id="11" otherprops="11">Section 1</h1> <h1 id="2" otherprops="2">Chapter 2</h1> <table cellspacing=10 border=0> <tr><td> <tr><td align=right>1<td> <a href="#1">Chapter 1</a> <tr><td align=right>2<td> <a href="#11">Section 1</a> <tr><td> <tr><td align=right>3<td> <a href="#2">Chapter 2</a> </table> END
Update documentation for a Perl module from the comments in its source code. Comments between the lines marked with:
#Dn title # description
and:
#D
where n is either 1, 2 or 3 indicating the heading level of the section and the # is in column 1.
Methods are formatted as:
sub name(signature) #FLAGS comment describing method {my ($parameters) = @_; # comments for each parameter separated by commas.
FLAGS can be chosen from:
method of interest to new users
private method
optionally replaceable method
required replaceable method
static method
die rather than received a returned undef result
Other flags will be handed to the method extractDocumentationFlags(flags to process, method name) found in the file being documented, this method should return [the additional documentation for the method, the code to implement the flag].
Text following 'Example:' in the comment (if present) will be placed after the parameters list as an example. Lines containing comments consisting of '#T'.methodName will also be aggregated and displayed as examples for that method.
Lines formatted as:
BEGIN{*source=*target}
starting in column 1 will define a synonym for a method.
#C emailAddress text
will be aggregated in the acknowledgments section at the end of the documentation.
The character sequence \n in the comment will be expanded to one new line, \m to two new lines and L<$_>,L<confess>,L<die>,L<eval>,L<lvalueMethod> to links to the perl documentation.
Search for '#D1': in https://metacpan.org/source/PRBRENAN/Data-Table-Text-20180810/lib/Data/Table/Text.pm to see more examples of such documentation in action - although it is quite difficult to see as it looks just like normal comments placed in the code.
Parameter Description 1 $perlModule Optional file name with caller's file being the default
{my $s = 𝘂𝗽𝗱𝗮𝘁𝗲𝗗𝗼𝗰𝘂𝗺𝗲𝗻𝘁𝗮𝘁𝗶𝗼𝗻(<<'END' =~ s(#) (#)gsr =~ s(~) ()gsr); package Sample::Module; #D1 Samples # Sample methods. sub sample($@) #R Documentation for the: sample() method. See also L<Data::Table::Text::sample2|/Data::Table::Text::sample2>. #Tsample {my ($node, @context) = @_; # Node, optional context 1 } ~BEGIN{*smpl=*sample} sub Data::Table::Text::sample2(\&@) #PS Documentation for the sample2() method. {my ($sub, @context) = @_; # Sub to call, context. 1 } ok sample(undef, qw(a b c)) == 1; #Tsample if (1) #Tsample {ok sample(q(a), qw(a b c)) == 2; ok sample(undef, qw(a b c)) == 1; } ok sample(<<END2)) == 1; #Tsample sample data END2 ok $s =~ m'=head2 sample28\$\@29';
Service details.
file - The file in which the service start details is being recorded.
service - The name of the service.
start - The time this service was started time plus a minor hack to simplify testing.
Process starter definition.
processingLogFile - Optional: name of a file to which process start and end information should be appended
processingTitle - Optional: title describing the processing being performed.
totalToBeStarted - Optionally: the total number of processes to be started - if this is supplied then an estimate of the finish time for this processing is printed to the log file every time a process starts or finishes.
autoRemoveTransferArea - If true then automatically clear the transfer area at the end of processing.
maximumNumberOfProcesses - The maximum number of processes to start in parallel at one time. If this limit is exceeded, the start of subsequent processes will be delayed until processes started earlier have finished.
pids - A hash of pids representing processes started but not yet completed.
processFinishTime - {pid} == time the process finished.
processStartTime - {pid} == time the process was started.
processingLogFileHandle - Handle for log file if a log file was supplied
resultsArray - Consolidated array of results.
startTime - Start time
transferArea - The name of the folder in which files transferring results from the child to the parent process will be stored.
Definition of a blessed hash.
a - Definition of attribute aa.
b - Definition of attribute bb.
Package name
client - Client socket and connection socket
headerLength - Length of fixed header which carries the length of the following message
serverAction - Server action sub, which receives a communicator every time a client creates a new connection.
serverPid - Server pid which can be used to kill the server via kill q(kill), $pid
socketPath - Socket file
Remove any trailing folder separator from a folder name component.
Parameter Description 1 $name Name
Normalize a folder name component by adding a trailing separator.
Track the existence of files.
Parameter Description 1 $label Label 2 @files Files
Print a file name on a separate line with escaping so it can be used easily from the command line.
Find all the files and folders under a folder.
Parameter Description 1 $dir Folder to start the search with
Read a file containing unicode in utf-16 format.
Set STDOUT and STDERR to accept utf8 without complaint.
𝗯𝗶𝗻𝗠𝗼𝗱𝗲𝗔𝗹𝗹𝗨𝘁𝗳𝟴;
Convert an image to jpx format using versions of Imagemagick version 6.9.0 and above with optional image reduction.
Parameter Description 1 $Source Source file 2 $target Target folder (as multiple files will be created) 3 $Size Optional size of each tile - defaults to 256 4 $Tiles Optional limit on the number of tiles in either dimension
Count the elements in sets represented as arrays of strings and/or the keys of hashes
Tabularize text that has new lines in it.
Parameter Description 1 $data Reference to an array of arrays of data to be formatted as a table 2 $separator Optional line separator to use instead of new line for each row.
Tabularize an array of arrays.
Parameter Description 1 $data Data to be formatted 2 $title Optional reference to an array of titles
Tabularize a hash of arrays.
Parameter Description 1 $data Data to be formatted 2 $title Optional titles
Tabularize an array of hashes.
Parameter Description 1 $data Data to be formatted
Tabularize a hash of hashes.
Tabularize an array.
Parameter Description 1 $data Data to be formatted 2 $title Optional title
Tabularize a hash.
Parameter Description 1 $d Data structure 2 $progress Progress
Create a map of all the keys within all the hashes within a tower of data structures.
Parameter Description 1 $d Data structure 2 $keys Keys found 3 $progress Progress
Create a communicator - a means to communicate between processes on the same machine via Udsr::read and Udsr::write.
Get ip address of server at aws
Save source code.
Parameter Description 1 $aws Aws target file and keywords 2 $saveIntervalInSeconds Save internal
Create a log entry showing progress and eta.
Parameter Description 1 $starter Starter 2 $finish 0 - start; 1 - finish
Average elapsed time spent by each process
Write to the log file if it is available.
Parameter Description 1 $starter Starter 2 @message Text to write to log file.
Wait for at least one process to finish and consolidate its results.
Count the number of elements in a square array
Remove example markers from test code.
Parameter Description 1 $string String containing test line
Generate documentation for a method by calling the extractDocumentationFlags method in the package being documented, passing it the flags for a method and the name of the method. The called method should return the documentation to be inserted for the named method.
Parameter Description 1 $flags Flags 2 $perlModule File containing documentation 3 $package Package containing documentation 4 $name Name of method to be processed
Update the documentation in a perl file and show said documentation in a web browser.
Parameter Description 1 $perlModule File containing the code of the perl module
fpd is a synonym for filePathDir - Create a directory name from an array of file name components.
fpe is a synonym for filePathExt - Create a file name from an array of file name components the last of which is an extension.
fpf is a synonym for filePath - Create a file name from an array of file name components.
owf is a synonym for overWriteFile - Write a unicode utf8 string to a file after creating a path to the file if necessary and return the name of the file on success else confess.
temporaryDirectory is a synonym for temporaryFolder - Create a temporary folder that will automatically be rmdired during END processing.
1 absFromAbsPlusRel - Create an absolute file from an absolute file and a relative file.
2 addCertificate - Add a certificate to the current ssh session.
3 addLValueScalarMethods - Generate lvalue scalar methods in the current package if they do not already exist.
4 appendFile - Append a unicode utf8 string to a file, possibly creating the file and the path to the file if necessary and return the name of the file on success else confess.
5 arrayProduct - Find the product of any strings that look like numbers in an array
6 arraySum - Find the sum of any strings that look like numbers in an array
7 arrayTimes - Multiply the second and subsequent parameters by the first parameter and return as an array
8 arrayToHash - Create a hash from an array
9 asciiToHexString - Encode an ascii string as a string of hexadecimal digits.
10 assertPackageRefs - Confirm that the specified references are to the specified package
11 assertRef - Confirm that the specified references are to the package into which this routine has been exported.
12 awsIp - Get ip address of server at aws
13 awsTranslateText - Translate $text from English to a specified $language using AWS Translate with the specified global $options and return the translated string.
14 binModeAllUtf8 - Set STDOUT and STDERR to accept utf8 without complaint.
15 boldString - Convert alphanumerics in a string to bold.
16 boldStringUndo - Undo alphanumerics in a string to bold.
17 call - Call the specified sub in a separate process, wait for it to complete, copy back the named our variables, free the memory used.
18 checkFile - Return the name of the specified file if it exists, else confess the maximum extent of the path that does exist.
19 checkKeys - Check the keys in a hash.
20 clearFolder - Remove all the files and folders under and including the specified folder as long as the number of files to be removed is less than the specified limit.
21 containingPowerOfTwo - Find log two of the lowest power of two greater than or equal to a number.
22 contains - Returns the indices at which an item matches elements of the specified array.
23 convertDocxToFodt - Convert a docx file to fodt using unoconv which must not be running elsewhere at the time.
24 convertImageToJpx - Convert an image to jpx format using Imagemagick applying an optional scaling if required.
25 convertImageToJpx690 - Convert an image to jpx format using versions of Imagemagick version 6.
26 convertUnicodeToXml - Convert a string with unicode points that are not directly representable in ascii into string that replaces these points with their representation on Xml making the string usable in Xml documents.
27 copyBinaryFile - Copy a binary file and return the target name,
28 copyBinaryFileMd5Normalized - Normalize the name of the specified $source file to the md5 sum of its content, retaining its current extension, while placing the original file name in an accompanying file if the accompanying file does not already exist.
29 copyBinaryFileMd5NormalizedCreate - Create a file in the specified $folder whose name is constructed from the md5 sum of the specified $content, whose content is $content, whose extension is $extension and which has an accompanying file with the same name minus the extension which contains the specified $name.
30 copyBinaryFileMd5NormalizedGetCompanionContent - Return the original name of the specified $source file after it has been normalized via copyBinaryFileMd5Normalized or undef if the corresponding .
31 copyFile - Copy a file encoded in utf8 and return the target name
32 copyFileMd5Normalized - Normalize the name of the specified $source file to the md5 sum of its content, retaining its current extension, while placing the original file name in an accompanying file if the accompanying file does not already exist.
33 copyFileMd5NormalizedCreate - Create a file in the specified $folder whose name is constructed from the md5 sum of the specified $content, whose content is $content, whose extension is $extension and which has an accompanying file with the same name minus the extension which contains the specified $name.
34 copyFileMd5NormalizedGetCompanionContent - Return the original name of the specified $source file after it has been normalized via copyBinaryFileMd5Normalized or undef if the corresponding .
35 copyFolder - Copy a folder
36 countFileExtensions - Return a hash which counts the file extensions under the specified directories
37 countFileTypes - Return a hash which counts, in parallel, the results of applying the file command to each file under the specified directories.
38 countOccurencesInString - Returns the number of times the first string occurs in the second string
39 countSquareArray - Count the number of elements in a square array
40 createEmptyFile - Create an empty file - writeFile complains if no data is written to the file - and return the name of the file on success else confess.
41 currentDirectory - Get the current working directory.
42 currentDirectoryAbove - The path to the folder above the current working folder.
43 cutOutImagesInFodtFile - Cut out the images embedded in a fodt file, perhaps produced via convertDocxToFodt, placing them in the specified folder and replacing them in the source file with:
44 Data::Exchange::Service::check - Check that we are the current incarnation of the named service with details obtained from newServiceIncarnation.
45 Data::Table::Text::Starter::averageProcessTime - Average elapsed time spent by each process
46 Data::Table::Text::Starter::finish - Wait for all started processes to finish and return their results as an array.
47 Data::Table::Text::Starter::logEntry - Create a log entry showing progress and eta.
48 Data::Table::Text::Starter::say - Write to the log file if it is available.
49 Data::Table::Text::Starter::start - Start a new process to run the specified $sub.
50 Data::Table::Text::Starter::waitOne - Wait for at least one process to finish and consolidate its results.
51 dateStamp - Year-monthName-day
52 dateTimeStamp - Year-monthNumber-day at hours:minute:seconds
53 dateTimeStampName - Date time stamp without white space.
54 decodeBase64 - Decode a string in base 64.
55 decodeJson - Decode Perl from Json.
56 denormalizeFolderName - Remove any trailing folder separator from a folder name component.
57 deSquareArray - Create a one dimensional array from a two dimensional array of arrays
58 docUserFlags - Generate documentation for a method by calling the extractDocumentationFlags method in the package being documented, passing it the flags for a method and the name of the method.
59 dumpFile - Dump a data structure to a file
60 dumpGZipFile - Write a data structure through gzip to a file.
61 enclosedReversedString - Convert alphanumerics in a string to enclosed reversed alphanumerics.
62 enclosedReversedStringUndo - Undo alphanumerics in a string to enclosed reversed alphanumerics.
63 enclosedString - Convert alphanumerics in a string to enclosed alphanumerics.
64 enclosedStringUndo - Undo alphanumerics in a string to enclosed alphanumerics.
65 encodeBase64 - Encode a string in base 64.
66 encodeJson - Encode Perl to Json.
67 evalFile - Read a file containing unicode in utf8, evaluate it, confess to any errors and then return any result - an improvement on do which silently ignores any problems.
68 evalGZipFile - Read a file containing compressed utf8, evaluate it, confess to any errors or return any result.
69 extractTest - Remove example markers from test code.
70 fe - Get extension of file name.
71 fff - Confess a message with a line position and a file that Geany will jump to if clicked on.
72 fileInWindowsFormat - Convert a unix file name to windows format
73 fileList - Files that match a given search pattern handed to bsd_glob.
74 fileMd5Sum - Get the Md5 sum for a file or string
75 fileModTime - Get the modified time of a file in seconds since the epoch.
76 fileOutOfDate - Calls the specified sub once for each source file that is missing, then calls the sub for the target if there were any missing files or if the target is older than any of the non missing source files or if the target does not exist.
77 filePath - Create a file name from an array of file name components.
78 filePathDir - Create a directory name from an array of file name components.
79 filePathExt - Create a file name from an array of file name components the last of which is an extension.
80 fileSize - Get the size of a file.
81 findAllFilesAndFolders - Find all the files and folders under a folder.
82 findDirs - Find all the folders under a folder and optionally filter the selected folders with a regular expression.
83 findFiles - Find all the files under a folder and optionally filter the selected files with a regular expression.
84 findFileWithExtension - Find the first extension from the specified extensions that produces a file that exists when appended to the specified file.
85 firstFileThatExists - Returns the name of the first file that exists or undef if none of the named files exist.
86 firstNChars - First N characters of a string.
87 fn - Remove path and extension from file name.
88 fne - Remove path from file name.
89 formatTable - Format various data structures as a table with titles as specified by $columnTitles: either a reference to an array of column titles or a string each line of which contains the column title as the first word with the rest of the line describing that column.
90 formatTableA - Tabularize an array.
91 formatTableAA - Tabularize an array of arrays.
92 formatTableAH - Tabularize an array of hashes.
93 formatTableBasic - Tabularize an array of arrays of text.
94 formatTableH - Tabularize a hash.
95 formatTableHA - Tabularize a hash of arrays.
96 formatTableHH - Tabularize a hash of hashes.
97 formatTableMultiLine - Tabularize text that has new lines in it.
98 formattedTablesReport - Report of all the reports created.
99 fp - Get path from file name.
100 fpn - Remove extension from file name.
101 fullFileName - Full name of a file.
102 genHash - Return a $blessed hash with the specified $attributes accessible via lvalue method calls.
103 genLValueArrayMethods - Generate lvalue array methods in the current package.
104 genLValueHashMethods - Generate lvalue hash methods in the current package.
105 genLValueScalarMethods - Generate lvalue scalar methods in the current package, A method whose value has not yet been set will return a new scalar with value undef.
106 genLValueScalarMethodsWithDefaultValues - Generate lvalue scalar methods with default values in the current package.
107 guidFromMd5 - Create a guid from an md5 hash.
108 guidFromString - Create a guid from a file or string via an md5 hash.
109 hexToAsciiString - Decode a string of hexadecimal digits as an ascii string.
110 hostName - The name of the host we are running on.
111 htmlToc - Generate a table of contents for some html.
112 imageSize - Return (width, height) of an image obtained via Imagemagick.
113 indentString - Indent lines contained in a string or formatted table by the specified string.
114 indexOfMax - Find the index of the maximum number in a list confessing to any ill defined values.
115 indexOfMin - Find the index of the minimum number in a list confessing to any ill defined values.
116 ipAddressViaArp - Get the ip address of a server on the local network by hostname via arp
117 isBlank - Test whether a string is blank.
118 isFileUtf8 - Return the file name quoted if its contents are in utf8 else return undef
119 isSubInPackage - Test whether a subroutine is present in a package.
120 javaPackage - Extract the package name from a java string or file.
121 javaPackageAsFileName - Extract the package name from a java string or file and convert it to a file name.
122 keyCount - Count keys down to the specified level.
123 lll - Log messages including the project name if available.
124 loadArrayArrayFromLines - Load an array of arrays from lines of text: each line is an array of words.
125 loadArrayFromLines - Load an array from lines of text in a string.
126 loadArrayHashFromLines - Load an array of hashes from lines of text: each line is a hash of words.
127 loadHash - Load the specified $hash generated with genHash with %attributes.
128 loadHashArrayFromLines - Load a hash of arrays from lines of text: the first word of each line is the key, the remaining words are the array contents.
129 loadHashFromLines - Load a hash: first word of each line is the key and the rest is the value.
130 loadHashHashFromLines - Load a hash of hashes from lines of text: the first word of each line is the key, the remaining words are the sub hash contents.
131 makeDieConfess - Force die to confess where the death occurred.
132 makePath - Make the path for the specified file name or folder.
133 matchPath - Given an absolute path find out how much of the path actually exists.
134 max - Find the maximum number in a list confessing to any ill defined values.
135 maximumLineLength - Find the longest line in a string
136 md5FromGuid - Recover an md5 sum from a guid.
137 mergeHashesBySummingValues - Merge the specified hashes by summing their values
138 microSecondsSinceEpoch - Micro seconds since unix epoch.
139 min - Find the minimum number in a list confessing to any ill defined values.
140 nameFromFolder - Create a name from the last folder in the path of a file name.
141 nameFromString - Create a readable name from an arbitrary string of text.
142 newProcessStarter - Create a new process starter with which to start parallel processes up to a specified $maximumNumberOfProcesses maximum number of parallel processes at a time, wait for all the started processes to finish and then optionally retrieve their saved results as an array from the folder named by $transferArea.
143 newServiceIncarnation - Create a new service incarnation to record the start up of a new instance of a service and return the description as a Data::Exchange::Service Definition hash.
144 newUdsr - Create a communicator - a means to communicate between processes on the same machine via Udsr::read and Udsr::write.
145 newUdsrClient - Create a new communications client - a means to communicate between processes on the same machine via Udsr::read and Udsr::write.
146 newUdsrServer - Create a communications server - a means to communicate between processes on the same machine via Udsr::read and Udsr::write.
147 numberOfLinesInFile - The number of lines in a file
148 numberOfLinesInString - The number of lines in a string.
149 nws - Normalize white space in a string to make comparisons easier.
150 overrideMethods - For each method, if it exists in package $from then export it to package $to replacing any existing method in $to, otherwise export the method from package $to to package $from in order to merge the behavior of the $from and $to packages with respect to the named methods with duplicates resolved if favour of package $from.
151 overWriteBinaryFile - Write a binary string to a file after creating a path to the file if necessary and return the name of the file on success else confess.
152 overWriteFile - Write a unicode utf8 string to a file after creating a path to the file if necessary and return the name of the file on success else confess.
153 pad - Pad a string with blanks or the specified padding character to a multiple of a specified length.
154 parseCommandLineArguments - Classify the specified array of words referred to by $args into positional and keyword parameters, call the specified sub with a reference to an array of positional parameters followed by a reference to a hash of keywords and their values then return the value returned by this sub.
155 parseFileName - Parse a file name into (path, name, extension).
156 perlPackage - Extract the package name from a perl string or file.
157 powerOfTwo - Test whether a number is a power of two, return the power if it is else undef.
158 printFullFileName - Print a file name on a separate line with escaping so it can be used easily from the command line.
159 printQw - Print an array of words in qw() format.
160 quoteFile - Quote a file name.
161 readBinaryFile - Read binary file - a file whose contents are not to be interpreted as unicode.
162 readFile - Read a file containing unicode in utf8.
163 readFiles - Read all the files in a folder into a hash
164 readGZipFile - Read the specified $file, containing compressed utf8, through gzip
165 readUtf16File - Read a file containing unicode in utf-16 format.
166 relFromAbsAgainstAbs - Derive a relative file name for the first absolute file name relative to the second absolute file name.
167 reloadHashes - Ensures that all the hashes within a tower of data structures have LValue methods to get and set their current keys.
168 reloadHashes2 - Ensures that all the hashes within a tower of data structures have LValue methods to get and set their current keys.
169 removeFilePrefix - Removes a file prefix from an array of files.
170 renormalizeFolderName - Normalize a folder name component by adding a trailing separator.
171 reportSettings - Report the current values of parameterless subs in a $sourceFile that match \Asub\s+(\w+)\s*\{ and optionally write the report to $reportFile.
172 retrieveFile - Retrieve a file created via Storable.
173 saveCodeToS3 - Save source code files.
174 saveSourceToS3 - Save source code.
175 searchDirectoryTreesForMatchingFiles - Search the specified directory trees for the files (not folders) that match the specified extensions.
176 setCombination - Count the elements in sets represented as arrays of strings and/or the keys of hashes
177 setFileExtension - Set the extension of a file to a specified value.
178 setIntersection - Intersection of sets represented as arrays of strings and/or the keys of hashes
179 setIntersectionOverUnion - Returns the size of the intersection over the size of the union of one or more sets represented as arrays and/or hashes
180 setPackageSearchOrder - Set a package search order for methods requested in the current package via AUTOLOAD.
181 setPartitionOnIntersectionOverUnion - Partition a set of sets so that within each partition the setIntersectionOverUnion of any two sets in the partition is never less than the specified $confidence**2
182 setPartitionOnIntersectionOverUnionOfHashStringSets - Partition a set of sets represented by a hash, each hash value being a string containing words and punctuation, each word possibly capitalized, so that within each partition the setPartitionOnIntersectionOverUnionOfSetsOfWords of any two sets of words in the partition is never less than the specified $confidence**2 and the partition entries are the hash keys of the string sets.
183 setPartitionOnIntersectionOverUnionOfSetsOfWords - Partition a set of sets of words so that within each partition the setIntersectionOverUnion of any two sets of words in the partition is never less than the specified $confidence**2
184 setPartitionOnIntersectionOverUnionOfStringSets - Partition a set of sets, each set represented by a string containing words and punctuation, each word possibly capitalized, so that within each partition the setPartitionOnIntersectionOverUnionOfSetsOfWords of any two sets of words in the partition is never less than the specified $confidence**2
185 setUnion - Union of sets represented as arrays of strings and/or the keys of hashes
186 showHashes - Create a map of all the keys within all the hashes within a tower of data structures.
187 showHashes2 - Create a map of all the keys within all the hashes within a tower of data structures.
188 squareArray - Create a two dimensional square array from a one dimensional linear array.
189 startProcess - Start new processes while the number of child processes recorded in %$pids is less than the specified $maximum.
190 storeFile - Store a data structure to a file via Storable.
191 stringsAreNotEqual - Return the common start followed by the two non equal tails of two non equal strings or an empty list if the strings are equal.
192 subScriptString - Convert alphanumerics in a string to sub scripts
193 subScriptStringUndo - Undo alphanumerics in a string to sub scripts
194 sumAbsAndRel - Combine zero or more absolute and relative file names
195 summarizeColumn - Count the number of unique instances of each value a column in a table assumes.
196 superScriptString - Convert alphanumerics in a string to super scripts
197 superScriptStringUndo - Undo alphanumerics in a string to super scripts
198 swapFilePrefix - Swaps the start of a file name from a $known name to a $new one if the file does in fact start with the $known name otherwise returns the original file name.
199 swapFolderPrefix - Swaps a starting folder of a file name from a known name to a new one if the file does in fact start with the known name and the known name and new name are folders else return the file as is.
200 temporaryFile - Create a temporary file that will automatically be unlinked during END processing.
201 temporaryFolder - Create a temporary folder that will automatically be rmdired during END processing.
202 timeStamp - hours:minute:seconds
203 trackFiles - Track the existence of files.
204 trim - Remove any white space from the front and end of a string.
205 Udsr::kill - Kill a communications server.
206 Udsr::read - Read a message from the newUdsrServer or the newUdsrClient.
207 Udsr::write - Write a communications message to the newUdsrServer or the newUdsrClient.
208 uniqueNameFromFile - Create a unique name from a file name and the md5 sum of its content
209 updateDocumentation - Update documentation for a Perl module from the comments in its source code.
210 updatePerlModuleDocumentation - Update the documentation in a perl file and show said documentation in a web browser.
211 userId - The userid we are currently running under.
212 versionCode - YYYYmmdd-HHMMSS
213 versionCodeDashed - YYYY-mm-dd-HH:MM:SS
214 waitForAllStartedProcessesToFinish - Wait until all the processes started by startProcess have finished.
215 writeBinaryFile - Write a binary string to a new file that does not already exist after creating a path to the file if necessary and return the name of the file on success else confess if a problem occurred or the file does already exist.
216 writeFile - Write a unicode utf8 string to a new file that does not already exist after creating a path to the file if necessary and return the name of the file on success else confess if a problem occurred or the file already exists.
217 writeFiles - Write the values of a hash into files identified by the key of each value using overWriteFile
218 writeGZipFile - Write a unicode utf8 string through gzip to a file.
219 wwwDecode - Percent decode a url per: https://en.
220 wwwEncode - Percent encode a url per: https://en.
221 xxx - Execute a shell command optionally checking its response.
222 yyy - Execute a block of shell commands line by line after removing comments - stop if there is a non zero return code from any command.
223 zzz - Execute lines of commands after replacing new lines with && then check that the pipeline execution results in a return code of zero and that the execution results match the optional regular expression if one has been supplied; confess() to an error if either check fails.
224 ˢ - Immediately executed inline sub to allow a code block before if.
This module is written in 100% Pure Perl and, thus, it is easy to read, comprehend, use, modify and install via cpan:
sudo cpan install Data::Table::Text
philiprbrenan@gmail.com
http://www.appaapps.com
Copyright (c) 2016-2019 Philip R Brenan.
This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
Thanks to the following people for their help with this module:
Testing on windows
2 POD Errors
The following errors were encountered while parsing the POD:
Unterminated B<...> sequence
To install Data::Table::Text, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Data::Table::Text
CPAN shell
perl -MCPAN -e shell install Data::Table::Text
For more information on module installation, please visit the detailed CPAN module installation guide.