Perl Best Practices

Table of Contents......Page 7
Preface......Page 17
Contents of This Book......Page 18
Conventions Used in This Book......Page 20
Feedback......Page 21
Acknowledgments......Page 22
Best Practices......Page 25
Robustness......Page 27
Maintainability......Page 28
This Book......Page 29
Rehabiting......Page 31
Code Layout......Page 32
Bracketing......Page 33
Keywords......Page 35
Subroutines and Variables......Page 36
Builtins......Page 37
Operators......Page 38
Semicolons......Page 39
Commas......Page 41
Line Lengths......Page 42
Indentation......Page 43
Tabs......Page 44
Blocks......Page 46
Chunking......Page 47
Elses......Page 48
Vertical Alignment......Page 50
Breaking Long Lines......Page 51
Breaking by Precedence......Page 53
Assignments......Page 54
Ternaries......Page 55
Lists......Page 56
Automated Layout......Page 57
Naming Conventions......Page 60
Identifiers......Page 61
Booleans......Page 64
Reference Variables......Page 65
Arrays and Hashes......Page 67
Underscores......Page 68
Capitalization......Page 69
Abbreviations......Page 70
Ambiguous Abbreviations......Page 71
Ambiguous Names......Page 72
Utility Subroutines......Page 73
String Delimiters......Page 75
Single-Character Strings......Page 77
Escaped Characters......Page 78
Constants......Page 79
Leading Zeros......Page 82
Long Numbers......Page 83
Multiline Strings......Page 84
Heredoc Indentation......Page 85
Heredoc Terminators......Page 86
Heredoc Quoters......Page 88
Barewords......Page 89
Fat Commas......Page 90
Thin Commas......Page 92
Low-Precedence Operators......Page 94
List Membership......Page 95
Lexical Variables......Page 97
Package Variables......Page 99
Localization......Page 101
Initialization......Page 102
Punctuation Variables......Page 103
Localizing Punctuation Variables......Page 105
Match Variables......Page 106
Dollar-Underscore......Page 109
Array Indices......Page 112
Slicing......Page 113
Slice Factoring......Page 114
If Blocks......Page 117
Postfix Selectors......Page 118
Other Postfix Modifiers......Page 120
Negative Control Statements......Page 121
C-Style Loops......Page 124
Unnecessary Subscripting......Page 125
Necessary Subscripting......Page 127
Iterator Variables......Page 129
Non-Lexical Loop Iterators......Page 132
List Generation......Page 134
List Selections......Page 135
List Transformation......Page 136
Complex Mappings......Page 137
List Processing Side Effects......Page 138
Multipart Selections......Page 141
Value Switches......Page 142
Tabular Ternaries......Page 145
do-while Loops......Page 147
Linear Coding......Page 149
Distributed Control......Page 150
Redoing......Page 152
Loop Labels......Page 153
Types of Documentation......Page 156
Boilerplates......Page 157
Extended Boilerplates......Page 162
Location......Page 163
Position......Page 164
Comments......Page 165
Algorithmic Documentation......Page 166
Elucidating Documentation......Page 167
Defensive Documentation......Page 168
Discursive Documentation......Page 169
Proofreading......Page 172
Sorting......Page 173
Reversing Lists......Page 176
Reversing Scalars......Page 177
Fixed-Width Data......Page 178
Separated Data......Page 181
Variable-Width Data......Page 182
String Evaluations......Page 185
Automating Sorts......Page 188
Substrings......Page 189
Hash Values......Page 190
Globbing......Page 191
Sleeping......Page 192
Mapping and Grepping......Page 193
Utilities......Page 194
Call Syntax......Page 199
Homonyms......Page 201
Argument Lists......Page 202
Named Arguments......Page 206
Missing Arguments......Page 208
Default Argument Values......Page 209
Scalar Return Values......Page 210
Contextual Return Values......Page 212
Multi-Contextual Return Values......Page 215
Prototypes......Page 218
Implicit Returns......Page 221
Returning Failure......Page 223
Filehandles......Page 226
Indirect Filehandles......Page 228
Localizing Filehandles......Page 229
Opening Cleanly......Page 231
Error Checking......Page 232
Cleanup......Page 233
Input Loops......Page 235
Line-Based Input......Page 236
Simple Slurping......Page 237
Power Slurping......Page 238
Standard Input......Page 240
Simple Prompting......Page 241
Interactivity......Page 242
Power Prompting......Page 244
Progress Indicators......Page 246
Autoflushing......Page 248
Dereferencing......Page 251
Braced References......Page 252
Symbolic References......Page 254
Cyclic References......Page 256
Regular Expressions......Page 259
Extended Formatting......Page 260
Line Boundaries......Page 261
String Boundaries......Page 263
Matching Anything......Page 264
Brace Delimiters......Page 266
Other Delimiters......Page 270
Named Characters......Page 271
Properties......Page 272
Whitespace......Page 273
Unconstrained Repetitions......Page 274
Capturing Parentheses......Page 276
Captured Values......Page 277
Capture Variables......Page 278
Piecewise Matching......Page 281
Tabular Regexes......Page 283
Constructing Regexes......Page 285
Canned Regexes......Page 287
Alternations......Page 289
Factoring Alternations......Page 290
Backtracking......Page 293
String Comparisons......Page 295
Error Handling......Page 297
Exceptions......Page 298
Builtin Failures......Page 302
Contextual Failure......Page 303
Systemic Failure......Page 304
Recoverable Failure......Page 305
Reporting Failure......Page 307
Error Messages......Page 308
Documenting Errors......Page 310
OO Exceptions......Page 311
Volatile Error Messages......Page 314
Exception Hierarchies......Page 315
Processing Exceptions......Page 316
Exception Classes......Page 317
Unpacking Exceptions......Page 320
Command-Line Processing......Page 323
Command-Line Structure......Page 324
Command-Line Conventions......Page 325
Meta-options......Page 327
In-situ Arguments......Page 328
Command-Line Processing......Page 330
Interface Consistency......Page 335
Interapplication Consistency......Page 338
Objects......Page 342
Using OO......Page 343
Criteria......Page 344
Restricted Hashes......Page 346
Encapsulation......Page 347
Constructors......Page 357
Cloning......Page 358
Destructors......Page 360
Methods......Page 362
Accessors......Page 364
Lvalue Accessors......Page 370
Indirect Objects......Page 373
Class Interfaces......Page 375
Operator Overloading......Page 378
Coercions......Page 380
Class Hierarchies......Page 383
Inheritance......Page 384
Objects......Page 385
Blessing Objects......Page 389
Constructor Arguments......Page 391
Base Class Initialization......Page 395
Construction and Destruction......Page 400
Automating Class Hierarchies......Page 407
Attribute Demolition......Page 408
Attribute Building......Page 411
Coercions......Page 412
Cumulative Methods......Page 413
Autoloading......Page 417
Interfaces......Page 421
Refactoring......Page 425
Version Numbers......Page 428
Version Requirements......Page 429
Exporting......Page 431
Declarative Exporting......Page 433
Interface Variables......Page 435
Creating Modules......Page 439
The Standard Library......Page 441
CPAN......Page 442
Test Cases......Page 444
Modular Testing......Page 445
Test Suites......Page 448
Failure......Page 449
What to Test......Page 450
Debugging and Testing......Page 451
Strictures......Page 453
Warnings......Page 455
Correctness......Page 456
Overriding Strictures......Page 457
The Debugger......Page 460
Manual Debugging......Page 461
Semi-Automatic Debugging......Page 463
Revision Control......Page 465
Other Languages......Page 466
Configuration Files......Page 469
Formats......Page 473
Ties......Page 475
Cleverness......Page 477
Encapsulated Cleverness......Page 478
Benchmarking......Page 480
Memory......Page 483
Caching......Page 484
Memoization......Page 486
Caching for Optimization......Page 487
Profiling......Page 488
Enbugging......Page 490
Essential Perl Best Practices......Page 493
Chapter2, Code Layout......Page 496
Chapter4, Values and Expressions......Page 497
Chapter6, Control Structures......Page 498
Chapter8, Built-in Functions......Page 499
Chapter10, I/O......Page 500
Chapter12, Regular Expressions......Page 501
Chapter13, Error Handling......Page 502
Chapter15, Objects......Page 503
Chapter17, Modules......Page 504
Chapter19, Miscellanea......Page 505
vim......Page 506
Emacs......Page 507
BBEdit......Page 509
TextWrangler......Page 510
Recommended Core Modules......Page 511
Recommended CPAN Modules......Page 512
Utility Subroutines......Page 514
Algorithms and Efficiency......Page 517
Text Editors......Page 518
Index......Page 519