Headers module #74

rwdougla · 2022-02-23T04:14:21Z

resolves #3

uvic-frodo · 2022-02-23T15:40:31Z

sources/modules/compilation-model/headers.md

+
+#### Background/Required Knowledge
+
+* All of the above.


Is "All of the above" on line 77 referring to all of the foundational background? I think that it would be clearer to say this explicitly. Incidentally, is it implied that all background for a topic at the foundational level is also required for the main level? If so, then perhaps such a statement is unnecessary?

Issue cplusplus#3

Would like to get cross-references in advance section to other modules which are coupled to headers, such as classes, templates, modules, etc.

vulder · 2022-07-08T06:49:27Z

/ok-to-test

feeling of small-group was to omit advanced section, as each advanced topic seemed more relevant to a different module

diehlpk · 2024-07-26T16:48:29Z

sources/modules/compilation-model/headers.md

+* Usage of standard library code requires inclusion of various header files
+* Give examples of various header files and when they may be needed for inclusion
+* Include links to reference materials for finding out what headers are used for various feature sets
+* When using standard library facilities, can either use `using std::vector; vector<int> v;`, or `std::vector<int> v;`, or `using namespace std; vector<int> v;`, though modern practice strongly discourages invoking `using namespace std;`


That is a nice example but that does not relates to headers. I think it relates to templates and I am not sure if we should mention it there.

Thoughts?

vulder

Nice, work.

@rwdougla What's the status of this topic, should we table it for a SG20 discussion? It seems quite ready.

vulder · 2024-10-04T08:03:32Z

sources/modules/compilation-model/headers.md

@@ -0,0 +1,106 @@
+## Module name: Headers


Suggested change

## Module name: Headers

## C++ compilation model: Headers {#headers}

vulder · 2024-10-04T08:03:48Z

sources/modules/compilation-model/headers.md

+multiple distinct source files to share a single source of common 
+declarations. 
+
+### Foundational: Including code through standard library headers


Suggested change

### Foundational: Including code through standard library headers

### Foundational: Including code through standard library headers {#headers-found}

vulder · 2024-10-04T08:03:57Z

sources/modules/compilation-model/headers.md

+* Include links to reference materials for finding out what headers are used for various feature sets
+* When using standard library facilities, can either use `using std::vector; vector<int> v;`, or `std::vector<int> v;`, or `using namespace std; vector<int> v;`, though modern practice strongly discourages invoking `using namespace std;`
+
+### Main: Organizing function and class declarations for reuse


Suggested change

### Main: Organizing function and class declarations for reuse

### Main: Organizing function and class declarations for reuse {#headers-main}

vulder · 2024-10-04T08:04:49Z

sources/modules/compilation-model/headers.md

+
+A student should be able to:
+
+1. Include common standard library headers to get access to standard library features


Suggested change

1. Include common standard library headers to get access to standard library features

1. include common standard library headers to get access to standard library features

vulder · 2024-10-04T08:06:05Z

sources/modules/compilation-model/headers.md

+1. Create a declaration for an existing function, placed in a separate file
+2. Utilize double-quote inclusion to include a header from the same directory
+3. Utilize angular-bracket inclusion to include a header from standard library
+4. Explain the meaning of the one-definition rule and how it applies to headers
+5. Protect a header with include guards and explain why they are necessary


Suggested change

1. Create a declaration for an existing function, placed in a separate file

2. Utilize double-quote inclusion to include a header from the same directory

3. Utilize angular-bracket inclusion to include a header from standard library

4. Explain the meaning of the one-definition rule and how it applies to headers

5. Protect a header with include guards and explain why they are necessary

1. create a declaration for an existing function, placed in a separate file

2. utilize double-quote inclusion to include a header from the same directory

3. utilize angular-bracket inclusion to include a header from standard library

4. explain the meaning of the one-definition rule and how it applies to headers

5. protect a header with include guards and explain why they are necessary

alignment with other topic spellings

vulder · 2024-10-04T08:07:55Z

sources/modules/compilation-model/headers.md

+implementation-defined, unspecified, or undefined behavior._
+


Suggested change

implementation-defined, unspecified, or undefined behavior._

implementation-defined, unspecified, or undefined behavior._

* The include directly actually copies the header file into the file it is included in.

WIP: Straw-man "Headers" for small-group session

4101af5

Issue cplusplus#3

uvic-frodo reviewed Feb 23, 2022

View reviewed changes

rwdougla added 2 commits February 23, 2022 10:57

WIP: progress from small group session

370dedd

Issue cplusplus#3

Progress from March US Small Group session

b7d8028

Would like to get cross-references in advance section to other modules which are coupled to headers, such as classes, templates, modules, etc.

vulder linked an issue Apr 29, 2022 that may be closed by this pull request

[TOPIC] Headers #3

Open

Merge branch 'master' into Issue3

7fa5628

Update headers.md

5aff11c

feeling of small-group was to omit advanced section, as each advanced topic seemed more relevant to a different module

rwdougla marked this pull request as ready for review January 17, 2023 16:12

rwdougla changed the title ~~WIP: Straw-man "Headers" for small-group session~~ Straw-man "Headers" for small-group session Jan 17, 2023

rwdougla changed the title ~~Straw-man "Headers" for small-group session~~ Headers module Jan 17, 2023

VictorEijkhout approved these changes Jan 24, 2023

View reviewed changes

Merge branch 'master' into Issue3

5082bea

diehlpk reviewed Jul 26, 2024

View reviewed changes

Merge branch 'master' into Issue3

bf04222

vulder requested changes Oct 4, 2024

View reviewed changes

vulder force-pushed the master branch from 9758a39 to ea5bb4a Compare November 4, 2024 20:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Headers module #74

Headers module #74

rwdougla commented Feb 23, 2022 •

edited by vulder

Loading

uvic-frodo Feb 23, 2022

vulder commented Jul 8, 2022

diehlpk Jul 26, 2024

vulder left a comment

vulder Oct 4, 2024

vulder Oct 4, 2024

vulder Oct 4, 2024

vulder Oct 4, 2024

vulder Oct 4, 2024

vulder Oct 4, 2024

	## Module name: Headers
	## C++ compilation model: Headers {#headers}

	### Foundational: Including code through standard library headers
	### Foundational: Including code through standard library headers {#headers-found}

	### Main: Organizing function and class declarations for reuse
	### Main: Organizing function and class declarations for reuse {#headers-main}


		A student should be able to:

		1. Include common standard library headers to get access to standard library features

		implementation-defined, unspecified, or undefined behavior._

Headers module #74

Are you sure you want to change the base?

Headers module #74

Conversation

rwdougla commented Feb 23, 2022 • edited by vulder Loading

Choose a reason for hiding this comment

vulder commented Jul 8, 2022

Choose a reason for hiding this comment

vulder left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rwdougla commented Feb 23, 2022 •

edited by vulder

Loading