1439 Commits

Author SHA1 Message Date
hsutter
fcb2960793 Closes #1446
This PR affirms that all virtual functions, *including destructors*,
should be declared exactly one of `virtual`, `override`, or `final`, and
takesa pass through the document to make the examples and guidance
consistent with that.

Of course a virtual destructor is a virtual function: It behaves
polymorphically, and it has a vtable entry that can be overwritten ==
overridden in a derived class exactly the same as any other derived
virtual override. See also [class.virtual]/7: "Even though destructors
are not inherited, a destructor in a derived class overrides a base
class destructor declared virtual; see [class.dtor] and [class.free]."

However, the following exception text currently appears in C.128:

> If a base class destructor is declared `virtual`, one should avoid
declaring derived class destructors  `virtual` or `override`. Some code
base and tools might insist on `override` for destructors, but that is
not the recommendation of these guidelines.

... but this exception is (a) not well-founded, and (b) inconsistent
with the Guidelines' practice in other examples and with the rationale a
few lines earlier for C.128 itself.

Re (a):

- The exception is overly broad: The rationale given for this exception
is entirely against marking destructors `override` (not `virtual`). So
clearly the exception to write neither keyword is too broad: At most,
the exception should be to write `virtual` rather than `override`.
- Explicit `virtual` is primarily for class users, not class authors:
The arguments given in #721 favoring this exception are from the
viewpoint of the implementation of the function (even then, the
arguments are debatable and debated). But `virtual`, `override`, and
`final` are primarily for the far larger audience of *class users and
call sites* of the function, for whom of course we should document each
declared function that is polymorphic, *especially* the destructor --
this tells calling code whether the function is safe to call through a
(smart or built-in) pointer or reference to base, which will nearly
always be the case for such types. We should not make the reader of the
code go way to look in the base classes to figure out whether a function
declared in this class is virtual or not -- the reason this Item exists
is primarily to avoid that implicit virtual antipattern via convention
and automated enforcement. For class users, all virtual functions
including destructors are equally polymorphic.

Re (b): The Guidelines already don't follow this. For instance, two
Items later (in C.130) we have this example that correctly uses
`override`:

~~~
virtual ~D() override;
~~~

... though per C.128 it should not also specify `virtual` (also fixed in
this PR).

Finally, the exception also contradicts the rationale given earlier in
the same Item.
2019-06-16 13:35:52 -07:00
beinhaerter
4b414458cf I.13: grammar and hint to std::string_view (#1443)
- "a C-style, zero-terminated strings" is wrong, it must be either "C-style, zero-terminated strings" or "a C-style, zero-terminated string"
- added hint to `std::string_view
2019-06-13 08:38:55 -04:00
beinhaerter
040ea419cc I.10: structured bindings is now available (#1442)
- C++17 is already available
- synchronize with F.21:
  - put quotes around "structured bindings"
  - remove link to proposal
2019-06-13 08:38:09 -04:00
alexcamposruiz
2d40c3ac2c Add example code for T.48 (#1422)
* Add example code for T.48

* Fix whitespace in end of line

* Use better syntax for concept constraint

* Revert "Use better syntax for concept constraint"

This reverts commit f071920d7f.
2019-05-30 11:21:43 -07:00
jkorinth
4c35d4c022 Fix C.120 good example (#1426)
C.120 has a good example which violates C.128 by specifying both virtual and override for methods.
closes #1425
2019-05-28 11:11:33 -04:00
Louis Cloete
6c92f514f4 Remove extra asterisk in example in C.60 (#1430)
closes #1429
2019-05-28 09:01:27 -04:00
Louis Cloete
29dedc49af Inserts a missing backtick in C.49 (#1428)
Below heading "Example, better still" there was a missing backtick after gsl::string_span
2019-05-20 08:14:08 +01:00
Sergey Zubkov
dbc554cbc5 update date 2019-05-02 14:53:28 -04:00
Herb Sutter
9948bdc157 Update ES.23 to allow = initialiization (#1416)
* Update ES.23 to allow = initialiization

* Silencing Travis

* Changed title back to original, it's fine

* Add note about explicit
2019-05-02 11:47:00 -07:00
Dave Smith
a9242c8dae Improve A.all (#1413)
* reword the A.1 rule title
* add candidate content for the A.1 rule
* make minor improvements to the A.2 note
* simplify wording in the first bullet of A.4's Reason
2019-05-02 11:18:07 -07:00
hsutter
fc27313b75 Adopting fixes from PR 1411 2019-05-02 11:12:08 -07:00
hsutter
959b556aac Restored cached_computation description 2019-05-02 11:06:03 -07:00
Dave Smith
1a9a35d2d9 Tighten up CP.1 (#1405)
* Tighten up CP.1

* balanced verb usage in first sentence
* changed third sentence to "libraries not using threads", as I
  believe this was the original author's intended meaning.
* clarified "this" in fourth sentence
* cut wordiness of "thanks to the magic of cut-and-paste", as it
  added no value
* changed "Example" heading to "Example, bad"
* added "bad:" comment above statics in the example
* added an explanatory sentence immediately after the example
* changed "works perfectly in a single-threaded" after example to
  "works as intended in a single threaded".  Also balanced the
  structure of the two comma separated phrases inside this sentence.
* strengthened parenthetical explanation in second bullet of "could
  be made safe" section

* Correct grammar mistake pointed out by @cubbimew

* Remove specific cache details in CP.1 per @hsutter's request
2019-05-02 11:05:35 -07:00
hsutter
41b5bac211 Revert "Fixed typo in ES.22"
This reverts commit 976ee508a4.
2019-04-27 07:47:59 -07:00
hsutter
976ee508a4 Fixed typo in ES.22 2019-04-27 07:45:45 -07:00
Florian Thake
385199cc90 Added bad and good example to NR.5 in CppCoreGuidelines.md (#1401)
* Added bad and goof example to NR.5 in CppCoreGuidelines.md

Added bad and good example to NR.5 Don’t: Don’t do substantive work in a constructor; instead use two-phase initialization.
I think it could be suitable.

* adjusted coding style

* removed extra space

* removed one more whitespace

* removed spaces before note to make it a blank line

* made Cleanup method from bad example return void

* some changes after review comments

- removed try catch
- removed defaulted dtor
- changed int to size_t, removed check for even.
- Expects() for invariant check
- typo

* spell check adjustment

* moved comment up for met the line length

* changed variablename in good example

... they were named same after removed the try catch scope

* changed afer comments

- changed check_size() function to a static member function 
- fixed comment mentioning the default contract violation behavior.
2019-04-25 11:21:50 -07:00
Kyle
0f57785d2b C.129 Small fixes (#1406)
* C.129 Fix typos and conjugation

I noticed some grammatical errors in this section and fixed them to match my interpretation of the author's intention.

* One more fix

Pluralization
2019-04-15 14:06:50 -04:00
Aleksander
6a6321fcbf ES.49: added lvalue in std::forward description (#1404) 2019-04-15 14:05:36 -04:00
Aleksander
9f5a67fda7 ES.42: index in an example was not declared (#1403) 2019-04-15 13:22:20 -04:00
Paul Romano
1f6042f66c Fix typo in some of the NL rules, "thus rule" -> "this rule" (#1402) 2019-04-10 10:45:57 -04:00
hsutter
35cfe0c984 Closes #1397 2019-04-04 11:28:59 -07:00
hsutter
9275e7da09 Fixed typo in previous commit, closes #1395 2019-04-04 11:27:40 -07:00
hsutter
85e6aef5d6 Closes #1395 2019-04-04 11:26:37 -07:00
hsutter
274d65818d Closes #1392 2019-04-04 11:16:34 -07:00
hsutter
4b7cd81ad0 Closes #1392 2019-04-04 11:16:05 -07:00
Taewon Park
7ddf721500 Fix wrong <a> tags in Pro.bounds and Pro.lifetime (#1399)
Replaced "href" attribute to "name" of <a> tags in Pro.bounds and Pro.lifetime sections, to make the anchors to them work correctly
2019-04-02 10:11:29 -04:00
Sergey Zubkov
73f37745b1 fix typo 2019-04-01 11:54:39 -04:00
Saad
08659db9e1 MD typo fix (#1396) 2019-03-25 10:06:33 +00:00
hsutter
c072184052 Closes #1370 2019-03-21 11:36:55 -07:00
hsutter
142fc6ad33 Closes #1367 2019-03-21 11:18:21 -07:00
Amir Livneh
e3da8a1fd9 Add example for E.28 (#1385) 2019-03-21 11:06:02 -07:00
Dave Smith
c2a5785d7e Remove elements that don't add value in ES.84 (#1390) 2019-03-21 11:04:49 -07:00
Dave Smith
8301421762 Tighten up the intro to CP (#1391) 2019-03-21 11:03:38 -07:00
Amir Livneh
a8c7b7c5a8 Fix grammar in T.41 (#1389) 2019-03-12 10:48:32 -04:00
Amir Livneh
bd3f3d5d25 Fix grammar in Con.2 (#1388) 2019-03-12 10:47:57 -04:00
Amir Livneh
422a190f57 Fix typo in T.22 (#1387) 2019-03-12 10:47:22 -04:00
Amir Livneh
aa25be7d6b Make sentence in T.41 complete (#1386) 2019-03-12 10:46:43 -04:00
Amir Livneh
ba2dbc5edf Fix calls to malloc() with 2 arguments (#1377)
* Fix calls to malloc() with 2 arguments
2019-03-09 19:17:33 -05:00
Amir Livneh
f67e91d295 Use memoizes instead of mnemonizes in the context of caching (#1383)
* Use `memoizes` instead of `mnemonizes` in the context of caching

While apparently, 'mnemonizes' is a word, I don't think it's the best choice here.

* Update isocpp.dic
2019-03-09 19:15:27 -05:00
Amir Livneh
c1beff1941 Fix grammar in T.11 (#1380) 2019-03-09 17:37:00 -05:00
Amir Livneh
43f4390185 Fix grammar in T.13 (#1379) 2019-03-09 17:36:35 -05:00
Amir Livneh
8ff099d2d2 Fix grammar (#1378) 2019-03-09 17:35:49 -05:00
Amir Livneh
7d092e37aa Remove extra parenthesis (#1375) 2019-03-09 17:32:40 -05:00
Amir Livneh
7511b40996 Use 'an' instead of 'a' where appropriate (#1374) 2019-03-09 17:30:53 -05:00
Amir Livneh
571ab494a8 Use consistent tense and remove repetition in E introduction (#1372) 2019-03-08 09:16:56 -05:00
Amir Livneh
e93462e1d7 Fix capitalization in CP.200 (#1373) 2019-03-08 09:15:50 -05:00
Amir Livneh
6d94ce30dd Fix grammar in E.4 note (#1371) 2019-03-08 09:14:51 -05:00
Sergey Zubkov
1c0ddef508 fix travis CI, update date 2019-03-07 15:14:44 -05:00
hsutter
5d2c09aa48 Closes #1355 2019-03-07 12:00:41 -08:00
hsutter
fcba85fb48 Closes #1332 2019-03-07 11:51:28 -08:00