StarMirror/CppCoreGuidelines
1
0
Fork 0
mirror of https://github.com/isocpp/CppCoreGuidelines.git synced 2024-03-22 13:30:58 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #44 from whoshuu/master

Browse Source 
Fix links to the Guideline Support Library. Close #44
This commit is contained in:
Gabriel Dos Reis 2015-09-20 09:53:48 -07:00
commit 2f6ec186fd
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CppCoreGuidelines.md
View File

@ -42,7 +42,7 @@ You can [Read an explanation of the scope and structure of this Guide](#S-abstra
* [SF: Source files](#S-source) * [SF: Source files](#S-source)
* [CPL: C-style programming](#S-cpl) * [CPL: C-style programming](#S-cpl)
* [PRO: Profiles](#S-profile) * [PRO: Profiles](#S-profile)
* [GSL: Guideline support library](#S-support) * [GSL: Guideline support library](#S-gsl)
Supporting sections: Supporting sections:
@ -174,7 +174,7 @@ Take the time to understand the implications of a guideline rule on your program
These guidelines are designed according to the "subset of a superset" principle ([Stroustrup,2005](#BS2005)). These guidelines are designed according to the "subset of a superset" principle ([Stroustrup,2005](#BS2005)).
They do not simply define a subset of C++ to be used (for reliability, safety, performance, or whatever). They do not simply define a subset of C++ to be used (for reliability, safety, performance, or whatever).
Instead, they strongly recommend the use of a few simple "extensions" ([library components](#S-support)) Instead, they strongly recommend the use of a few simple "extensions" ([library components](#S-gsl))
that make the use of the most error-prone features of C++ redundant, so that they can be banned (in our set of rules). that make the use of the most error-prone features of C++ redundant, so that they can be banned (in our set of rules).
The rules emphasize static type safety and resource safety. The rules emphasize static type safety and resource safety.
@ -317,7 +317,7 @@ Recommended information sources can be found in [the references](#S-references).
* [SF: Source files](#S-source) * [SF: Source files](#S-source)
* [CPL: C-style programming](#S-cpl) * [CPL: C-style programming](#S-cpl)
* [PRO: Profiles](#S-profile) * [PRO: Profiles](#S-profile)
* [GSL: Guideline support library](#S-support) * [GSL: Guideline support library](#S-gsl)
Supporting sections: Supporting sections:
@ -408,7 +408,7 @@ A well-designed library expresses intent (what is to be done, rather than just h
A C++ programmer should know the basics of the STL, and use it where appropriate. A C++ programmer should know the basics of the STL, and use it where appropriate.
Any programmer should know the basics of the foundation libraries of the project being worked on, and use it appropriate. Any programmer should know the basics of the foundation libraries of the project being worked on, and use it appropriate.
Any programmer using these guidelines should know the [Guidelines Support Library](#S-GSL), and use it appropriate. Any programmer using these guidelines should know the [Guidelines Support Library](#S-gsl), and use it appropriate.
**Example**: **Example**:
@ -479,7 +479,7 @@ The last variant makes it clear that we are not interested in the order in which
A programmer should be familiar with A programmer should be familiar with
* [The guideline support library](#S-support) * [The guideline support library](#S-gsl)
* [The ISO C++ standard library](#S-stdlib) * [The ISO C++ standard library](#S-stdlib)
* Whatever foundation libraries are used for the current project(s) * Whatever foundation libraries are used for the current project(s)
@ -796,7 +796,7 @@ Prefer [RAII](#Rr-raii):
* Look at pointers: classify them into non-owners (the default) and owners. * Look at pointers: classify them into non-owners (the default) and owners.
Where feasible, replace owners with standard-library resource handles (as in the example above). Where feasible, replace owners with standard-library resource handles (as in the example above).
Alternatively, mark an owner as such using `owner` from [the GSL](#S-support). Alternatively, mark an owner as such using `owner` from [the GSL](#S-gsl).
* Look for naked `new` and `delete` * Look for naked `new` and `delete`
* look for known resource allocating functions returning raw pointers (such as `fopen`, `malloc`, and `strdup`) * look for known resource allocating functions returning raw pointers (such as `fopen`, `malloc`, and `strdup`)
@ -1070,7 +1070,7 @@ Some preconditions can be expressed as assertions. For example:
Ideally, that `Expects(x>=0)` should be part of the interface of `sqrt()` but that's not easily done. For now, we place it in the definition (function body). Ideally, that `Expects(x>=0)` should be part of the interface of `sqrt()` but that's not easily done. For now, we place it in the definition (function body).
**Reference**: `Expects()` is described in [GSL](S-Support). **Reference**: `Expects()` is described in [GSL](#S-gsl).
**Note**: Prefer a formal specification of requirements, such as `Expects(p!=nullptr);` If that is infeasible, use English text in comments, such as **Note**: Prefer a formal specification of requirements, such as `Expects(p!=nullptr);` If that is infeasible, use English text in comments, such as
`// the sequence [p:q) is ordered using <` `// the sequence [p:q) is ordered using <`
@ -1322,7 +1322,7 @@ That is, its value must be `delete`d or transferred to another owner, as is done
`owner` is used similarly in the implementation of resource handles. `owner` is used similarly in the implementation of resource handles.
`owner` is defined in the [Guideline Support Library](#S-GSL). `owner` is defined in the [Guideline Support Library](#S-gsl).
**Note**: Every object passed as a raw pointer (or iterator) is assumed to be owned by the caller, so that its lifetime is handled by the caller. **Note**: Every object passed as a raw pointer (or iterator) is assumed to be owned by the caller, so that its lifetime is handled by the caller.
@ -2023,7 +2023,7 @@ When I call `length(r)` should I test for `r==nullptr` first? Should the impleme
**Also**: Assume that a `T*` obtained from a smart pointer to `T` (e.g., unique_ptr<`T`>) pointes to a single element. **Also**: Assume that a `T*` obtained from a smart pointer to `T` (e.g., unique_ptr<`T`>) pointes to a single element.
**See also**: [Support library](#S-support). **See also**: [Support library](#S-gsl).
**Enforcement**: **Enforcement**:
@ -2074,7 +2074,7 @@ When I call `length(r)` should I test for `r==nullptr` first? Should the impleme
**Note**: Passing an `array_view` object as an argument is exactly as efficient as passing a pair of pointer arguments or passing a pointer and an integer count. **Note**: Passing an `array_view` object as an argument is exactly as efficient as passing a pair of pointer arguments or passing a pointer and an integer count.
**See also**: [Support library](#S-support). **See also**: [Support library](#S-gsl).
**Enforcement**: (Complex) Warn where accesses to pointer parameters are bounded by other parameters that are integral types and suggest they could use `array_view` instead. **Enforcement**: (Complex) Warn where accesses to pointer parameters are bounded by other parameters that are integral types and suggest they could use `array_view` instead.
@ -2098,7 +2098,7 @@ When I call `length(s)` should I test for `s==nullptr` first? Should the impleme
**Note**: `zstring` do not represent ownership. **Note**: `zstring` do not represent ownership.
**See also**: [Support library](#S-support). **See also**: [Support library](#S-gsl).
<a name="Rf-const-T-ref"></a> <a name="Rf-const-T-ref"></a>
@ -5574,7 +5574,7 @@ What is `Port`? A handy wrapper that encapsulates the resource:
Port& operator=(const Port&) =delete; Port& operator=(const Port&) =delete;
}; };
**Note**: Where a resource is "ill-behaved" in that it isn't represented as a class with a destructor, wrap it in a class or use [`finally`](#S-GSL) **Note**: Where a resource is "ill-behaved" in that it isn't represented as a class with a destructor, wrap it in a class or use [`finally`](#S-gsl)
**See also**: [RAII](#Rr-raii). **See also**: [RAII](#Rr-raii).
@ -11292,7 +11292,7 @@ These functions all have bounds-safe overloads that take `array_view`. Standard
<a name="S-support"></a> <a name="S-gsl"></a>
# GSL: Guideline support library # GSL: Guideline support library
The GSL is a small library of facilities designed to support this set of guidelines. The GSL is a small library of facilities designed to support this set of guidelines.
@ -11792,7 +11792,7 @@ Here are some (very general) ideas:
* The ideal is "just upgrade everything." That gives the most benefits for the shortest total time. * The ideal is "just upgrade everything." That gives the most benefits for the shortest total time.
In most circumstances, it is also impossible. In most circumstances, it is also impossible.
* We could convert a code base module for module, but any rules that affects interfaces (especially ABIs), such as [use `array_view`](#S-GSL), cannot be done on a per-module basis. * We could convert a code base module for module, but any rules that affects interfaces (especially ABIs), such as [use `array_view`](#SS-views), cannot be done on a per-module basis.
* We could convert code "botton up" starting with the rules we estimate will give the greatest benefits and/or the least trouble in a given code base. * We could convert code "botton up" starting with the rules we estimate will give the greatest benefits and/or the least trouble in a given code base.
* We could start by focusing on the interfaces, e.g., make sure that no resources are lost and no pointer is misused. * We could start by focusing on the interfaces, e.g., make sure that no resources are lost and no pointer is misused.
This would be a set of changes across the whole code base, but would most likely have huge benefits. This would be a set of changes across the whole code base, but would most likely have huge benefits.