MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-26 15:33:54 +01:00
Code Issues Releases Wiki Activity

doc: Update STYLE.

Browse source
This commit is contained in:
Jason Volk 2017-12-23 16:07:40 -07:00
parent 9f75f80c21
commit 5e9fbe78f3
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/STYLE.md
View file

@ -93,7 +93,6 @@ If the compiler can't figure out the auto, that's when you indicate the type.
#### RAII will be in full force #### RAII will be in full force
All variables, whether they're function-local, class-members, even globals, All variables, whether they're function-local, class-members, even globals,
must always be under some protection at all times. There must be the must always be under some protection at all times. There must be the
expectation at *absolutely any point* including *between those points* expectation at *absolutely any point* including *between those points*
@ -111,6 +110,24 @@ This means when a variable, or member (a **resource**) first comes into scope,
i.e. it is declared or accessible (**acquired**), it must be **initialized** i.e. it is declared or accessible (**acquired**), it must be **initialized**
to a completely consistent state at that point. to a completely consistent state at that point.
* Window shade analogy:
>
> Imagine pulling down a window shade to hide the sun. As you pull down, the canvas
> unrolls from its spool at the top. Your goal is to hook the shade on to the nail
> at the bottom of the window: that is a commitment. If you slip and let go, the
> shade will roll back up into the spool at the top: that is an exception.
>
> What you can't do is prepare work on the way down which needs _any_ further pulling
> to be in a consistent state and not leak. You might slip and let go at any time for
> any reason. A `malloc()` on one line and a `free()` following it is an example of
> requiring more pulling.
>
> Indeed slipping and letting go is an accident -- but the point is that *accidents
> happen*. They're not always your fault, and many times are outside of your control.
> This is a good approach for robust and durable code over long-lived large-scale
> projects.
>
#### Exceptions will be used #### Exceptions will be used