API Design for C++

Dr. Martin Reddy holds a Ph.D. in Computer Science and has over 30 years of experience in the software industry. He is a Fellow of the IEEE, a Fellow of the AAIA, and a Distinguished Member of the ACM. He has published 10 patents, over 40 professional articles, and 2 books. Martin was co-founder and CTO of the AI startup, PullString, where he oversaw the development of the company's technology until it was acquired by Apple in 2019. While at Apple, Martin was a software architect responsible for the architecture and APIs of major components of the Siri virtual assistant. Before that, Dr. Reddy worked for 6 years at Pixar Animation Studios where he was a lead engineer for the studio's in-house animation system. He worked on several Academy Award Winning and Nominated films, such as "Finding Nemo", "The Incredibles", "Cars", "Ratatouille", and "Wall-E". He was also the hair model for Mr Incredible. Martin began his career at SRI International where he worked on a distributed 3D terrain visualization system and co-authored the geospatial functionality in the VRML and X3D ISO standards. Martin was awarded Alumnus of the Year by his alma mater, Strathclyde University.

"Martin Reddy draws from his experience on large scale, collaborative software projects to present patterns and practices that provide real value to individual developers as well as organizations. API Design for C++ explores often overlooked issues, both technical and non-technical, contributing to successful design decisions that product high quality, robust, and long-lived APIs." --Eric Gregory, Software Architect, Pixar Animation Studios

• 1. Introduction What Are APIs? What's Different about API Design? Why Should You Use APIs? When Should You Avoid APIs? API Examples File Formats and Network Protocols About This Book2. Qualities Model the Problem Domain Hide Implementation Details Minimally Complete Easy to Use Loosely coupled Stable, Documented, and Tested3. Patterns Pimpl Idiom Singleton Factory Methods API Wrapping Patterns Observer Pattern4. Design A Case for Good Design Gathering Functional Requirements Creating Use Cases Elements of API Design Architecture Design Class Design Function Design5. Styles Flat C APIs Object-Oriented C++ APIs Template-Based APIs Data-Driven APIs6. C++ Usage Namespaces Constructors and Assignment Const Correctness Templates Operator Overloading Function Parameters Avoid #define for Constants Avoid Using Friends Exporting Symbols Coding Conventions7. C++ Revisions Which C++ Revision to Use C++11 API Features Smart Pointers Explicit Member Functions Explicit Overrides and Final Enum Classes Function Objects Tuples Hash Tables Constant Expressions Null pointer constant Type aliases with using Unicode String Literals C++14 API Features The deprecated Attribute More Relaxed Const Expressions Binary Literals and Digit Separators C++17 API Features Nested Namespace Definitions Inline Variables Check for Header Availability Function Exception Specifications String Views Optionals Any Type Variant Container Byte Type C++20 API Features Modules Template Constraints and Concepts The Spaceship Operator The consteval Specifier Coroutines Version Header C++23 API Features Conditional Preprocessor Directives Multidimensional Subscript Operator Expected Values8. Performance Pass Input Arguments by Const Reference Minimize #include Dependencies Declaring Constants Initialization Lists Memory Optimization Don't Inline Until You Need To Copy on Write Iterating over Elements Performance Analysis9. Concurrency Thread Safety Avoiding Global Data Returning Data by Value The Use of static Initialization of Data Mutex Locking for Data Access Using Async Functions Promises and Futures Producer Consumer API10. Versioning Version Numbers Software Branching Strategies Life Cycle of an API Levels of Compatibility How to Maintain Backward Compatibility API Reviews11. Documentation Reasons to Write Documentation Types of Documentation Documentation Usability Inclusive Language Using Doxygen12. Testing Reasons to Write Tests Types of API Testing Writing Good Tests Writing Testable Code Automated Testing Tools13. Objective C++ and Swift Using Objective C++ within a C++ API Objective C++ wrapper for C++ API Using os_log and signposts Accessing an Objective C++ API in Swift14. Scripting Adding Script Bindings Script Wrapping Technologies Adding Python Bindings with Boost Python Adding Ruby Bindings with SWIG15. Extensibility Extending via Plugins Extending via Inheritance Extending via Templates