Merge pull request MicrosoftDocs#4723 from Xazax-hun/optionals_split_checks

v-stsavell · web-flow · commit 464b093f6e31 · 2022-12-15T16:22:07.000-06:00
26829 and 26830 were split into two warnings
diff --git a/docs/code-quality/c26829.md b/docs/code-quality/c26829.md
@@ -11,7 +11,7 @@ helpviewer_keywords: ["C26829"]
 
 ## Remarks
 
-Unwrapping empty `std::optional` values is undefined behavior. Such operation is considered a security vulnerability as it can result in a crash, reading uninitialized memory, or other unexpected behavior. This check will attempt to find cases where the value of the `std::optional` is known to be empty and unwrapped. You can also enable [C26830](../code-quality/c26830.md) for a stricter analysis.
+Unwrapping empty `std::optional` values is undefined behavior. Such operation is considered a security vulnerability as it can result in a crash, reading uninitialized memory, or other unexpected behavior. This check will attempt to find cases where a `std::optional` is known to be empty and unwrapped. You can also enable [C26830](../code-quality/c26830.md), [C26859](../code-quality/c26859.md), and [C26860](../code-quality/c26860.md) for a stricter analysis.
 
 ## Example
 
@@ -27,4 +27,4 @@ void f(std::optional<int> maybeEmpty)
 }
 ```
 
-To solve this problem, make sure the code never unwraps an empty optional.
+To solve this problem, make sure the code never unwraps an empty optional. Alternatively, use the `value` method and make sure you handle the `std::bad_optional_access` exception.
diff --git a/docs/code-quality/c26830.md b/docs/code-quality/c26830.md
@@ -11,7 +11,7 @@ helpviewer_keywords: ["C26830"]
 
 ## Remarks
 
-Unwrapping empty `std::optional` values is undefined behavior. Such operation is considered a security vulnerability as it can result in a crash, reading uninitialized memory, or other unexpected behavior. This check will attempt to find cases where the value of the `std::optional` isn't checked for emptiness before unwrap operations. You can enable [C26829](../code-quality/c26829.md) only for a more permissive analysis.
+Unwrapping empty `std::optional` values is undefined behavior. Such operation is considered a security vulnerability as it can result in a crash, reading uninitialized memory, or other unexpected behavior. This check will attempt to find cases where a `std::optional` isn't checked for emptiness before unwrap operations. You can enable [C26829](../code-quality/c26829.md) only for a more permissive analysis.
 
 ## Example
 
@@ -28,4 +28,4 @@ void f(std::optional<int> maybeEmpty)
 }
 ```
 
-To solve this problem, make sure the code never unwraps an empty optional.
+To solve this problem, make sure the code never unwraps an empty optional. Alternatively, use the `value` method and make sure you handle the `std::bad_optional_access` exception.
diff --git a/docs/code-quality/c26859.md b/docs/code-quality/c26859.md
@@ -0,0 +1,30 @@
+---
+title: Warning C26859
+description: "Describes the Microsoft C/C++ code analysis warning C26859, its causes, and how to address it."
+ms.date: 12/15/2022
+f1_keywords: ["C26859", "UNWRAP_EMPTY_OPTIONAL_VALUE"]
+helpviewer_keywords: ["C26859"]
+---
+# Warning C26859
+
+> Empty optional '*variable*' is unwrapped, will throw exception
+
+## Remarks
+
+Unwrapping empty `std::optional` values via the `value` method will throw an exception. Such operation can result in a crash when the exception isn't handled. This check will attempt to find cases where a `std::optional` is known to be empty and unwrapped using the `value` method. You can also enable [C26829](../code-quality/c26829.md), [C26830](../code-quality/c26830.md), and [C26860](../code-quality/c26860.md) for a stricter analysis.
+
+## Example
+
+```cpp
+void f(std::optional<int> maybeEmpty)
+{
+    std::optional<int> empty;
+    std::optional<int> nonEmpty{5};
+    nonEmpty.value() = 42; // No warning
+    empty.value() = 42; // warning: C26859
+    if (!maybeEmpty)
+        maybeEmpty.value() = 42; // warning: C26859
+}
+```
+
+To solve this problem, make sure the code never unwraps an empty optional.
diff --git a/docs/code-quality/c26860.md b/docs/code-quality/c26860.md
@@ -0,0 +1,31 @@
+---
+title: Warning C26860
+description: "Describes the Microsoft C/C++ code analysis warning C26860, its causes, and how to address it."
+ms.date: 12/15/2022
+f1_keywords: ["C26860", "UNWRAP_EMPTY_OPTIONAL_VALUE_MAYBE"]
+helpviewer_keywords: ["C26860"]
+---
+# Warning C26860
+
+> Potentially empty optional '*variable*' is unwrapped, may throw exception
+
+## Remarks
+
+Unwrapping empty `std::optional` values via the `value` method will throw an exception. Such operation can result in a crash when the exception isn't handled. This check will attempt to find cases where a `std::optional` isn't checked for emptiness before unwrapping it via the `value` method. You can enable [C26829](../code-quality/c26829.md), and [C26859](../code-quality/c26859.md) only for a more permissive analysis.
+
+## Example
+
+```cpp
+std::optional<int> getOptional();
+
+void f(std::optional<int> maybeEmpty)
+{
+    if (maybeEmpty)
+        maybeEmpty.value() = 42; // No warning
+    maybeEmpty.value() = 5; // warning: C26860
+    std::optional<int> o = getOptional();
+    o.value() = 42; // warning: C26860
+}
+```
+
+To solve this problem, make sure the code never unwraps an empty optional.
diff --git a/docs/code-quality/toc.yml b/docs/code-quality/toc.yml
@@ -607,6 +607,10 @@ items:
     href: ../code-quality/c26829.md
   - name: Warning C26830
     href: ../code-quality/c26830.md
+  - name: Warning C26859
+    href: ../code-quality/c26859.md
+  - name: Warning C26860
+    href: ../code-quality/c26860.md
   - name: Warning C28020
     href: ../code-quality/c28020.md
   - name: Warning C28021

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ helpviewer_keywords: ["C26829"]`
`11`	`11`
`12`	`12`	`## Remarks`
`13`	`13`
`14`		-Unwrapping empty `std::optional` values is undefined behavior. Such operation is considered a security vulnerability as it can result in a crash, reading uninitialized memory, or other unexpected behavior. This check will attempt to find cases where the value of the `std::optional` is known to be empty and unwrapped. You can also enable [C26830](../code-quality/c26830.md) for a stricter analysis.
	`14`	+Unwrapping empty `std::optional` values is undefined behavior. Such operation is considered a security vulnerability as it can result in a crash, reading uninitialized memory, or other unexpected behavior. This check will attempt to find cases where a `std::optional` is known to be empty and unwrapped. You can also enable [C26830](../code-quality/c26830.md), [C26859](../code-quality/c26859.md), and [C26860](../code-quality/c26860.md) for a stricter analysis.
`15`	`15`
`16`	`16`	`## Example`
`17`	`17`
`@@ -27,4 +27,4 @@ void f(std::optional<int> maybeEmpty)`
`27`	`27`	`}`
`28`	`28`	```
`29`	`29`
`30`		`-To solve this problem, make sure the code never unwraps an empty optional.`
	`30`	+To solve this problem, make sure the code never unwraps an empty optional. Alternatively, use the `value` method and make sure you handle the `std::bad_optional_access` exception.