Skip to content

Commit

Permalink
Changes to files:
Browse files Browse the repository at this point in the history 
doc/Type/IO/Handle.pod6
  + add brief description of 'printf'; reference
    format details in 'doc/Type/Str.pod6'

doc/Type/Str.pod6
  + move 'printf' format details to 'sprintf'
  + remove 'printf' function and move it to 'doc/Type/IO/Handle.pod6'

xt/trailing-whitespace.t
  + add line number for the affected file
  • Loading branch information
@tbrowder
tbrowder committed Aug 23, 2016
1 parent 2ff9fbc commit b9e4c2a
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 101 deletions.
28 changes: 28 additions & 0 deletions doc/Type/IO/Handle.pod6
View file
Expand Up @@ -116,6 +116,34 @@ $fh.print("some text");
$fh.print-nl; # \r\n
$fh.close;
=head2 method printf
This method is mostly identical to the C library C<printf> and
sprintf functions. The only difference between the two functions is
that C<sprintf> returns a string while the C<printf> function writes
to a file. See L<sub sprintf|https://docs.perl6.org/type/Str#sub_sprintf> for details about
the Perl 6 C<$format> implementation
Note that currently C<printf> is not a method for C<IO::Handle>, but
its effect may be duplicated with a work-around using C<sub sprintf>.
For example:
=for code :skip-test
my $fh = open 'path/to/file', :w;
$fh.say(printf("%d\n", 32));
$fh.close;
The C<say> method (see below) may be used for an automatic ending
newline:
=for code :skip-test
my $fh = open 'path/to/file', :w;
$fh.say(printf("%d\n", 32));
$fh.close;
See L<sub sprintf|https://docs.perl6.org/type/Str#sub_sprintf>
for details about formatting and more examples.
=head2 method say
method say(IO::Handle:D: |)
Expand Down
115 changes: 16 additions & 99 deletions doc/Type/Str.pod6
View file
Expand Up @@ -312,104 +312,14 @@ Examples:
"Perl".flip; # lreP
"ABBA".flip; # ABBA
=head2 sub printf
multi sub printf(Str:D $format, *@args)
This function is mostly identical to the C library printf function.
The C<$format> is scanned for C<%> characters. Any C<%> introduces a
format token. Format tokens have the following grammar:
grammar Str::PrintfFormat {
regex format_token { '%': <index>? <precision>? <modifier>? <directive> }
token index { \d+ '$' }
token precision { <flags>? <vector>? <precision_count> }
token flags { <[ \x20 + 0 \# \- ]>+ }
token precision_count { [ <[1..9]>\d* | '*' ]? [ '.' [ \d* | '*' ] ]? }
token vector { '*'? v }
token modifier { < ll l h V q L > }
token directive { < % c s d u o x e f g X E G b p n i D U O F > }
}
Directives guide the use (if any) of the arguments. When a directive
(other than C<%>) is used, it indicates how the next argument
passed is to be formatted into the string to be printed.
The directives are:
=begin table
% a literal percent sign
c a character with the given codepoint
s a string
d a signed integer, in decimal
u an unsigned integer, in decimal
o an unsigned integer, in octal
x an unsigned integer, in hexadecimal
e a floating-point number, in scientific notation
f a floating-point number, in fixed decimal notation
g a floating-point number, in %e or %f notation
X like x, but using uppercase letters
E like e, but using an uppercase "E"
G like g, but with an uppercase "E" (if applicable)
b an unsigned integer, in binary
=end table
Compatibility:
=begin table
i a synonym for %d
D a synonym for %ld
U a synonym for %lu
O a synonym for %lo
F a synonym for %f
=end table
Perl 5 (non-)compatibility:
=begin table
n produces a runtime exception
p produces a runtime exception
=end table
Modifiers change the meaning of format directives, but are largely
no-ops (the semantics are still being determined).
=begin table
h interpret integer as native "short" (typically int16)
l interpret integer as native "long" (typically int32 or int64)
ll interpret integer as native "long long" (typically int64)
L interpret integer as native "long long" (typically uint64)
q interpret integer as native "quads" (typically int64 or larger)
=end table
Examples:
printf('%c', 97); # a
printf("%.2f", 1.969); # 1.97
printf("%+.3f", 3.141592); # +3.142
printf('%2$d %1$d', 12, 34); # 34 12
printf("%x", 255); # ff
Special case: printf("<b>%s</b>\n", "Perl 6") will not work use either of the following:
printf Q:b "<b>%s</b>\n", "Perl 6";
printf "<b>\%s</b>\n", "Perl 6";
printf "<b>%s\</b>\n", "Perl 6";
=head2 sub sprintf
multi sub sprintf( Str:D $format, *@args) returns Str:D
This function is mostly identical to the C library sprintf function.
This function is mostly identical to the C library C<sprintf> and
C<printf> functions. The only difference between the two
functions is that C<sprintf> returns a string while the C<printf> function
writes to a file.
The C<$format> is scanned for C<%> characters. Any C<%> introduces a
format token. Format tokens have the following grammar:
Expand All @@ -427,7 +337,7 @@ format token. Format tokens have the following grammar:
Directives guide the use (if any) of the arguments. When a directive
(other than C<%>) is used, it indicates how the next argument
passed is to be formatted into the string.
passed is to be formatted into the string to be printed.
The directives are:
Expand Down Expand Up @@ -488,12 +398,19 @@ Examples:
=for code :skip-test
sprintf "%ld a big number, %lld a bigger number\n", 4294967295, 4294967296;
sprintf('%c', 97); # a
sprintf("%.2f", 1.969); # 1.97
sprintf("%+.3f", 3.141592); # +3.142
sprintf('%2$d %1$d', 12, 34); # 34 12
sprintf("%x", 255); # ff
Special case: sprintf("<b>%s</b>\n", "Perl 6") will not work use either of the following:
Special case: 'sprintf("<b>%s</b>\n", "Perl 6")' will not work, but
one of the following will:
sprintf Q:b "<b>%s</b>\n", "Perl 6";
sprintf "<b>\%s</b>\n", "Perl 6";
sprintf "<b>%s\</b>\n", "Perl 6";
=for code :skip-test
sprintf Q:b "<b>%s</b>\n", "Perl 6";
sprintf "<b>\%s</b>\n", "Perl 6";
sprintf "<b>%s\</b>\n", "Perl 6";
=head2 method starts-with
Expand Down
8 changes: 6 additions & 2 deletions xt/trailing-whitespace.t
View file
Expand Up @@ -18,12 +18,16 @@ plan +@files;

for @files -> $file {
my $ok = True;
my $row = 0;
for $file.IO.lines -> $line {
if $line ~~ / \s $/ {
++$row;
if $line ~~ / \s $/ {
$ok = False; last;
}
}
ok $ok, "must not have any trailing whitespace in $file";
my $error = $file;
$error ~= " (line $row)" if !$ok;
ok $ok, "$error: Must not have any trailing whitespace.";
}

# vim: expandtab shiftwidth=4 ft=perl6

0 comments on commit b9e4c2a

Please sign in to comment.