Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / man1 / perlstyle.1

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PERLSTYLE 1"
.TH PERLSTYLE 1 "2006-01-07" "perl v5.8.8" "Perl Programmers Reference Guide"
.SH "NAME"
perlstyle \- Perl style guide
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Each programmer will, of course, have his or her own preferences in
regards to formatting, but there are some general guidelines that will
make your programs easier to read, understand, and maintain.
.PP
The most important thing is to run your programs under the \fB\-w\fR
flag at all times.  You may turn it off explicitly for particular
portions of code via the \f(CW\*(C`no warnings\*(C'\fR pragma or the \f(CW$^W\fR variable
if you must.  You should also always run under \f(CW\*(C`use strict\*(C'\fR or know the
reason why not.  The \f(CW\*(C`use sigtrap\*(C'\fR and even \f(CW\*(C`use diagnostics\*(C'\fR pragmas
may also prove useful.
.PP
Regarding aesthetics of code lay out, about the only thing Larry
cares strongly about is that the closing curly bracket of
a multi-line \s-1BLOCK\s0 should line up with the keyword that started the construct.
Beyond that, he has other preferences that aren't so strong:
.IP "\(bu" 4
4\-column indent.
.IP "\(bu" 4
Opening curly on same line as keyword, if possible, otherwise line up.
.IP "\(bu" 4
Space before the opening curly of a multi-line \s-1BLOCK\s0.
.IP "\(bu" 4
One-line \s-1BLOCK\s0 may be put on one line, including curlies.
.IP "\(bu" 4
No space before the semicolon.
.IP "\(bu" 4
Semicolon omitted in \*(L"short\*(R" one-line \s-1BLOCK\s0.
.IP "\(bu" 4
Space around most operators.
.IP "\(bu" 4
Space around a \*(L"complex\*(R" subscript (inside brackets).
.IP "\(bu" 4
Blank lines between chunks that do different things.
.IP "\(bu" 4
Uncuddled elses.
.IP "\(bu" 4
No space between function name and its opening parenthesis.
.IP "\(bu" 4
Space after each comma.
.IP "\(bu" 4
Long lines broken after an operator (except \f(CW\*(C`and\*(C'\fR and \f(CW\*(C`or\*(C'\fR).
.IP "\(bu" 4
Space after last parenthesis matching on current line.
.IP "\(bu" 4
Line up corresponding items vertically.
.IP "\(bu" 4
Omit redundant punctuation as long as clarity doesn't suffer.
.PP
Larry has his reasons for each of these things, but he doesn't claim that
everyone else's mind works the same as his does.
.PP
Here are some other more substantive style issues to think about:
.IP "\(bu" 4
Just because you \fI\s-1CAN\s0\fR do something a particular way doesn't mean that
you \fI\s-1SHOULD\s0\fR do it that way.  Perl is designed to give you several
ways to do anything, so consider picking the most readable one.  For
instance
.Sp
.Vb 1
\&    open(FOO,$foo) || die "Can't open $foo: $!";
.Ve
.Sp
is better than
.Sp
.Vb 1
\&    die "Can't open $foo: $!" unless open(FOO,$foo);
.Ve
.Sp
because the second way hides the main point of the statement in a
modifier.  On the other hand
.Sp
.Vb 1
\&    print "Starting analysis\en" if $verbose;
.Ve
.Sp
is better than
.Sp
.Vb 1
\&    $verbose && print "Starting analysis\en";
.Ve
.Sp
because the main point isn't whether the user typed \fB\-v\fR or not.
.Sp
Similarly, just because an operator lets you assume default arguments
doesn't mean that you have to make use of the defaults.  The defaults
are there for lazy systems programmers writing one-shot programs.  If
you want your program to be readable, consider supplying the argument.
.Sp
Along the same lines, just because you \fI\s-1CAN\s0\fR omit parentheses in many
places doesn't mean that you ought to:
.Sp
.Vb 2
\&    return print reverse sort num values %array;
\&    return print(reverse(sort num (values(%array))));
.Ve
.Sp
When in doubt, parenthesize.  At the very least it will let some poor
schmuck bounce on the % key in \fBvi\fR.
.Sp
Even if you aren't in doubt, consider the mental welfare of the person
who has to maintain the code after you, and who will probably put
parentheses in the wrong place.
.IP "\(bu" 4
Don't go through silly contortions to exit a loop at the top or the
bottom, when Perl provides the \f(CW\*(C`last\*(C'\fR operator so you can exit in
the middle.  Just \*(L"outdent\*(R" it a little to make it more visible:
.Sp
.Vb 7
\&    LINE:
\&        for (;;) {
\&            statements;
\&          last LINE if $foo;
\&            next LINE if /^#/;
\&            statements;
\&        }
.Ve
.IP "\(bu" 4
Don't be afraid to use loop labels\*(--they're there to enhance
readability as well as to allow multilevel loop breaks.  See the
previous example.
.IP "\(bu" 4
Avoid using \f(CW\*(C`grep()\*(C'\fR (or \f(CW\*(C`map()\*(C'\fR) or `backticks` in a void context, that is,
when you just throw away their return values.  Those functions all
have return values, so use them.  Otherwise use a \f(CW\*(C`foreach()\*(C'\fR loop or
the \f(CW\*(C`system()\*(C'\fR function instead.
.IP "\(bu" 4
For portability, when using features that may not be implemented on
every machine, test the construct in an eval to see if it fails.  If
you know what version or patchlevel a particular feature was
implemented, you can test \f(CW$]\fR (\f(CW$PERL_VERSION\fR in \f(CW\*(C`English\*(C'\fR) to see if it
will be there.  The \f(CW\*(C`Config\*(C'\fR module will also let you interrogate values
determined by the \fBConfigure\fR program when Perl was installed.
.IP "\(bu" 4
Choose mnemonic identifiers.  If you can't remember what mnemonic means,
you've got a problem.
.IP "\(bu" 4
While short identifiers like \f(CW$gotit\fR are probably ok, use underscores to
separate words in longer identifiers.  It is generally easier to read
\&\f(CW$var_names_like_this\fR than \f(CW$VarNamesLikeThis\fR, especially for
non-native speakers of English. It's also a simple rule that works
consistently with \f(CW\*(C`VAR_NAMES_LIKE_THIS\*(C'\fR.
.Sp
Package names are sometimes an exception to this rule.  Perl informally
reserves lowercase module names for \*(L"pragma\*(R" modules like \f(CW\*(C`integer\*(C'\fR and
\&\f(CW\*(C`strict\*(C'\fR.  Other modules should begin with a capital letter and use mixed
case, but probably without underscores due to limitations in primitive
file systems' representations of module names as files that must fit into a
few sparse bytes.
.IP "\(bu" 4
You may find it helpful to use letter case to indicate the scope
or nature of a variable. For example:
.Sp
.Vb 3
\&    $ALL_CAPS_HERE   constants only (beware clashes with perl vars!)
\&    $Some_Caps_Here  package-wide global/static
\&    $no_caps_here    function scope my() or local() variables
.Ve
.Sp
Function and method names seem to work best as all lowercase.
E.g., \f(CW\*(C`$obj\->as_string()\*(C'\fR.
.Sp
You can use a leading underscore to indicate that a variable or
function should not be used outside the package that defined it.
.IP "\(bu" 4
If you have a really hairy regular expression, use the \f(CW\*(C`/x\*(C'\fR modifier and
put in some whitespace to make it look a little less like line noise.
Don't use slash as a delimiter when your regexp has slashes or backslashes.
.IP "\(bu" 4
Use the new \f(CW\*(C`and\*(C'\fR and \f(CW\*(C`or\*(C'\fR operators to avoid having to parenthesize
list operators so much, and to reduce the incidence of punctuation
operators like \f(CW\*(C`&&\*(C'\fR and \f(CW\*(C`||\*(C'\fR.  Call your subroutines as if they were
functions or list operators to avoid excessive ampersands and parentheses.
.IP "\(bu" 4
Use here documents instead of repeated \f(CW\*(C`print()\*(C'\fR statements.
.IP "\(bu" 4
Line up corresponding things vertically, especially if it'd be too long
to fit on one line anyway.
.Sp
.Vb 4
\&    $IDX = $ST_MTIME;
\&    $IDX = $ST_ATIME       if $opt_u;
\&    $IDX = $ST_CTIME       if $opt_c;
\&    $IDX = $ST_SIZE        if $opt_s;
.Ve
.Sp
.Vb 3
\&    mkdir $tmpdir, 0700 or die "can't mkdir $tmpdir: $!";
\&    chdir($tmpdir)      or die "can't chdir $tmpdir: $!";
\&    mkdir 'tmp',   0777 or die "can't mkdir $tmpdir/tmp: $!";
.Ve
.IP "\(bu" 4
Always check the return codes of system calls.  Good error messages should
go to \f(CW\*(C`STDERR\*(C'\fR, include which program caused the problem, what the failed
system call and arguments were, and (\s-1VERY\s0 \s-1IMPORTANT\s0) should contain the
standard system error message for what went wrong.  Here's a simple but
sufficient example:
.Sp
.Vb 1
\&    opendir(D, $dir)     or die "can't opendir $dir: $!";
.Ve
.IP "\(bu" 4
Line up your transliterations when it makes sense:
.Sp
.Vb 2
\&    tr [abc]
\&       [xyz];
.Ve
.IP "\(bu" 4
Think about reusability.  Why waste brainpower on a one-shot when you
might want to do something like it again?  Consider generalizing your
code.  Consider writing a module or object class.  Consider making your
code run cleanly with \f(CW\*(C`use strict\*(C'\fR and \f(CW\*(C`use warnings\*(C'\fR (or \fB\-w\fR) in
effect.  Consider giving away your code.  Consider changing your whole
world view.  Consider... oh, never mind.
.IP "\(bu" 4
Try to document your code and use Pod formatting in a consistent way. Here
are commonly expected conventions:
.RS 4
.IP "\(bu" 4
use \f(CW\*(C`C<>\*(C'\fR for function, variable and module names (and more
generally anything that can be considered part of code, like filehandles
or specific values). Note that function names are considered more readable
with parentheses after their name, that is \f(CW\*(C`function()\*(C'\fR.
.IP "\(bu" 4
use \f(CW\*(C`B<>\*(C'\fR for commands names like \fBcat\fR or \fBgrep\fR.
.IP "\(bu" 4
use \f(CW\*(C`F<>\*(C'\fR or \f(CW\*(C`C<>\*(C'\fR for file names. \f(CW\*(C`F<>\*(C'\fR should
be the only Pod code for file names, but as most Pod formatters render it
as italic, Unix and Windows paths with their slashes and backslashes may
be less readable, and better rendered with \f(CW\*(C`C<>\*(C'\fR.
.RE
.RS 4
.RE
.IP "\(bu" 4
Be consistent.
.IP "\(bu" 4
Be nice.