Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

straw-man draft for translation-units #79

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 107 additions & 1 deletion sources/modules/compilation-model/translation-units.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,110 @@
_Skeleton descriptions are typeset in italic text,_
_so please don't remove these descriptions when editing the topic._

This topic is currently under construction and will soon be filled with information :)
### Overview

_Provides a short natural language abstract of the module’s contents._
_Specifies the different levels of teaching._

------------------------------------------------------------------------
Level Objective
----------------- ------------------------------------------------------
Foundational

Main ---

Advanced ---

------------------------------------------------------------------------

### Motivation

_Why is this important?_
_Why do we want to learn/teach this topic?_

### Topic introduction

_Very brief introduction to the topic._

_TODO:
_introduce notion of object file

C++ Compilation model allows the developer to seperate their
declarations and definitions into various files so as to:

* organize code logically,
* facilitate reuse,
* reduce rebuild times,
* reduce file sizes and scopes,
* avoid naming collisions,
* and produce compiled libraries.


### Foundational: Building code from multiple files

#### Background/Required Knowledge

A student:

1. Is able to define a variable, function, or class
2. Is able to access declarations from either module import or header inclusion

Questions:
modules and/or functions?


#### Student outcomes

_A list of things "a student should be able to" after the curriculum._
_The next word should be an action word and testable in an exam._
_Max 5 items._

A student should be able to:

1. create a declaration for variables, functions, and classes separate from their definitions
2. compile and link code from multiple implementation files
3. explain how includes or imports work within their translation unit

#### Caveats

_This section mentions subtle points to understand, like anything resulting in
implementation-defined, unspecified, or undefined behavior._

#### Points to cover

_This section lists important details for each point._

Declarations and definitions can be within same file

### Main: Organizing code across multiple translation units

#### Background/Required Knowledge

* All of the above.

#### Student outcomes

A student should be able to:

1. package code into libraries
2. explain trade-offs for placing code in header files vs implementation files
3.
4.
5.

#### Caveats

#### Points to cover

### Advanced

_These are important topics that are not expected to be covered but provide
guidance where one can continue to investigate this topic in more depth._

A student should be able to:

1. explain how an anonymous namespace functions within their translation unit
2. One-definition-rule shennanigans
3. Pimpl pattern
4. Template definitions in translation unit it's used in?