Lakos, John

CERN Document Server

Large-Scale C++ Software DesignJohn LakosATVADDISON-WESLEYBoston • San Francisco • New York • Toronto • MontrealLondon • Munich • Paris • MadridCapetown • Sydney • Tokyo • Singapore • Mexico CityContentsFigure List	 xiiiPreface 	 xxvChapter 0: Introduction	 10.1 From C to C++ 	 20.2 Using C++ to Develop Large Projects 	 20.2.1 Cyclic Dependencies 	 30.2.2 Excessive Link-Time Dependencies 	 50.2.3 Excessive Compile-Time Dependencies 	70.2.4 The Global Name Space 	 100.2.5 Logical vs. Physical Design 	 120.3 Reuse 	 140.4 Quality 	 150.4.1 Quality Assurance 	 160.4.2 Quality Ensurance 	 170.5 Software Development Tools 	 170.6 Summary 	 18PART I: BASICS	19Chapter 1: Preliminaries	211.1 Multi-File C++ Programs 	 211.1.1 Declaration versus Definition 	 221.1.2 Internal versus External Linkage 	 23vvi Contents1.1.3 Header ( . h) Files 	 271.1.4 Implementation ( . c) Files 	 291.2 typedef Declarations 	 301.3 Assert Statements 	 321.4 A Few Matters of Style 	 331.4.1 Identifier Names 	 341.4.1.1 Type Names 	 341.4.1.2 Multi-Word Identifier Names 	 351.4.1.3 Data Member Names 	 361.4.2 Class Member Layout 	 381.5 Iterators 	 401.6 Logical Design Notation 	 471.6.1 The IsA Relation 	 481.6.2 The Uses-In-The-Interface Relation 	 501.6.3 The Uses-In-The-Implementation Relation 	 521.6.3.1 Uses 	 551.6.3.2 HasA and HoldsA 	 561.6.3.3 WasA 	 571.7 Inheritance versus Layering 	581.8 Minimality 	 591.9 Summary 	 61Chapter 2: Ground Rules	632.1 Overview 	 632.2 Member Data Access	652.3 The Global Name Space	692.3.1 Global Data	692.3.2 Free Functions 	722.3.3 Enumerations, Typedefs, and Constant Data	732.3.4 Preprocessor Macros 	752.3.5 Names in Header Files 	772.4 Include Guards 	802.5 Redundant Include Guards 	822.6 Documentation 	 882.7 Identifier-Naming Conventions 	912.8 Summary 	 93Contents viiPART II: PHYSICAL DESIGN CONCEPTS	 97Chapter 3: Components 	 993.1 Components versus Classes 	 993.2 Physical Design Rules 	 1083.3 The DependsOn Relation 	 1203.4 Implied Dependency 	 1273.5 Extracting Actual Dependencies 	 1343.6 Friendship 	 1363.6.1 Long-Distance Friendship and Implied Dependency 	 1413.6.2 Friendship and Fraud	 1443.7 Summary 	 147Chapter 4: Physical Hierarchy 	 1494.1 A Metaphor for Software Testing 	 1494.2 A Complex Subsystem 	 1514.3 The Difficulty in Testing "Good" Interfaces 	 1554.4 Design for Testability 	 1574.5 Testing in Isolation 	 1614.6 Acyclic Physical Dependencies 	 1644.7 Level Numbers 	 1664.7.1 The Origin of Level Numbers 	1674.7.2 Using Level Numbers in Software 	1694.8 Hierarchical and Incremental Testing 	1744.9 Testing a Complex Subsystem	 1814.10 Testability versus Testing 	 1834.11 Cyclic Physical Dependencies 	 1844.12 Cumulative Component Dependency 	 1874.13 Physical Design Quality 	 1934.14 Summary 	 201Chapter 5: Levelization	2035.1 Some Causes of Cyclic Physical Dependencies 	2045.1.1 Enhancement 	 2045.1.2 Convenience 	 2085.1.3 Intrinsic Interdependency 	 213viii Contents5.2 Escalation 	 2155.3 Demotion 	 2295.4 Opaque Pointers 	 2475.5 Dumb Data 	 2575.6 Redundancy 	 2695.7 Callbacks 	 2755.8 Manager Class 	 2885.9 Factoring 	 2945.10 Escalating Encapsulation 	 3125.11 Summary 	 324Chapter 6: Insulation 	 3276.1 From Encapsulation to Insulation 	 3286.1.1 The Cost of Compile-Time Coupling 	 3336.2 C++ Constructs and Compile-Time Coupling 	 3356.2.1 Inheritance (IsA) and Compile-Time Coupling 	 3366.2.2 Layering (HasAIHoldsA) and Compile-Time Coupling 	 3376.2.3 Inline Functions and Compile-Time Coupling 	 3396.2.4 Private Members and Compile-Time Coupling 	 3416.2.5 Protected Members and Compile-Time Coupling 	 3426.2.6 Compiler-Generated Member Functions and Compile-Time Coupling 	 3426.2.7 Include Directives and Compile-Time Coupling	 3446.2.8 Default Arguments and Compile-Time Coupling 	 3466.2.9 Enumerations and Compile-Time Coupling 	 3476.3 Partial Insulation Techniques 	 3496.3.1 Removing Private Inheritance 	 3496.3.2 Removing Embedded Data Members	 3526.3.3 Removing Private Member Functions 	 3536.3.4 Removing Protected Members 	 3636.3.5 Removing Private Member Data 	 3756.3.6 Removing Compiler-Generated Functions 	 3786.3.7 Removing Include Directives 	 3796.3.8 Removing Default Arguments 	 3816.3.9 Removing Enumerations 	 3826.4 Total Insulation Techniques 	 3856.4.1 The Protocol Class	 3866.4.2 The Fully Insulating Concrete Class 	 3986.4.3 The Insulating Wrapper	 4056.4.3.1 Single-Component Wrappers 	 4066.4.3.2 Multi-Component Wrappers 	415Contents ix6.5 The Procedural Interface 	 4256.5.1 The Procedural Interface Architecture 	 4266.5.2 Creating and Destroying Opaque Objects 	 4286.5.3 Handles 	 4296.5.4 Accessing and Manipulating Opaque Objects	 4356.5.5 Inheritance and Opaque Objects 	 4416.6 To Insulate or Not to Insulate 	 4456.6.1 The Cost of Insulation 	 4456.6.2 When Not to Insulate 	 4486.6.3 How to Insulate 	 4536.6.4 How Much to Insulate 	 4606.7 Summary 	 468Chapter 7: Packages	 4737.1 From Components to Packages 	 4747.2 Registered Package Prefixes 	 4837.2.1 The Need for Prefixes 	 4837.2.2 Namespaces 	 4867.2.3 Preserving Prefix Integrity 	 4917.3 Package Levelization 	 4937.3.1 The Importance of Levelizing Packages 	 4947.3.2 Package Levelization Techinques 	 4967.3.3 Partitioning a System 	 4987.3.4 Multi-Site Development 	 5007.4 Package Insulation 	 5037.5 Package Groups 	 5067.6 The Release Process 	 5127.6.1 The Release Structure 	 5147.6.2 Patches 	 5207.7 The main Program 	 5237.8 Start-Up 	 5317.8.1 Initialization Strategies 	 5347.8.1.1 The Wake-Up Initialized Technique 	 5347.8.1.2 The Explicit i n i t Function Technique 	 5357.8.1.3 The Nifty Counter Technique 	 5377.8.1.4 The Check-Every-Time Technique 	 5437.8.2 Clean-Up 	 5457.8.3 Review 	 5467.9 Summary 	 546x ContentsPART III: LOGICAL DESIGN ISSUES	 551Chapter 8: Architecting a Component 	 5538.1 Abstractions and Components 	 5548.2 Component Interface Design 	 5558.3 Degrees of Encapsulation 	 5608.4 Auxiliary Implementation Classes 	 5728.5 Summary 	 579Chapter 9: Designing a Function	 5839.1 Function Interface Specification 	 5849.1.1 Operator or Non-Operator Function 	 5849.1.2 Free or Member Operator 	 5919.1.3 Virtual or Non-Virtual Function 	 5979.1.4 Pure or Non-Pure Virtual Member Function 	 6039.1.5 Static or Non-Static Member Function 	 6049.1.6 const Member or Non-con s t Member Function 	 6059.1.7 Public, Protected, or Private Member Function 	 6129.1.8 Return by Value, Reference, or Pointer 	 6149.1.9 Return con st or Non- con st 	 6189.1.10 Argument Optional or Required 	 6199.1.11 Pass Argument by Value, Reference, or Pointer 	 6219.1.12 Pass Argument as con s t or Non-con s t 	 6299.1.13 Friend or Non-Friend Function 	 6309.1.14 Inline or Non-Inline Function 	 6319.2 Fundamental Types Used in the Interface 	 6339.2.1 Using short in the Interface 	 6339.2.2 Using unsi gned in the Interface 	 6379.2.3 Using 1 ong in the Interface 	 6429.2.4 Using fl oat, double, and 1 ong double in the Interface 	 6449.3 Special-Case Functions 	 6459.3.1 Conversion Operators 	 6469.3.2 Compiler-Generated Value Semantics 	 6509.3.3 The Destructor 	 6519.4 Summary 	 655Chapter 10: Implementing an Object	 66110.1 Member Data 	 66210.1.1 Natural Alignment 	 662Contents xi10.1.2 Fundamental Types Used in the Implementation 	 66510.1.3 Using typedef in the Implementation 	 66710.2 Function Definitions 	 66910.2.1 Assert Yourself! 	 66910.2.2 Avoid Special Casing	 67010.2.3 Factor Instead of Duplicate 	 67310.2.4 Don't Be Too Clever	 68010.3 Memory Management 	 68110.3.1 Logical versus Physical State Values	 68110.3.2 Physical Parameters 	 68510.3.3 Memory Allocators 	 69110.3.4 Class-Specific Memory Management 	 69810.3.4.1 Adding Custom Memory Management 	 70210.3.4.2 Hogging Memory 	 70510.3.5 Object-Specific Memory Management 	 71110.4 Using C++ Templates in Large Projects 	 71810.4.1 Compiler Implementations 	 71810.4.2 Managing Memory in Templates 	 71910.4.3 Patterns versus Templates 	 73010.5 Summary 	 733Appendix AThe Protocol Hierarchy	 737Intent	 739Also Known As 	 739Motivation 	 739Applicability 	 744Structure 	 744Participants 	 745Collaborations 	 746Consequences 	 746Implementation 	 747Sample Code 	 761Known Uses	 766Related Patterns 	 767xii ContentsAppendix BImplementing an ANSI C—Compatible C++ Interface 	 769B.1 Memory Allocation Error Detection 	 769B.2 Providing a Main Procedure (ANSI C Only) 	 778Appendix CA Dependency Extractor/Analyzer Package 	 779C.1 Using adep, cdep, and ldep 	 780C.2 Command-Line Documentation 	 793C.3 Idep Package Architecture 	 810C.4 Source Code 	 813Appendix DQuick Reference	 815D.1 Definitions 	 815D.2 Major Design Rules 	 820D.3 Minor Design Rules 	 821D.4 Guidelines 	 822D.5 Principles 	 824Bibliography	 833Index	 835

Large-scale C++ software design

Abstract

Similar works

Full text

Available Versions

CERN Document Server