Differential D130181 Diff 449048 clang-tools-extra/docs/clang-tidy/checks/readability/use-early-exits.rst

Changeset View

Standalone View

clang-tools-extra/docs/clang-tidy/checks/readability/use-early-exits.rst

This file was added.

				.. title:: clang-tidy - readability-use-early-exits

				readability-use-early-exits
				===========================

				Finds ``if`` statements inside functions and loops that could be flipped to
				make an early exit.

				Example:

				.. code-block:: c++

				void Process(MyClass* C) {
				if (C) {
				// Do some long processing.
				}
				}

				void Process(span<MyClass*> C){
				for (MyClass *Item : C) {
				if (Item) {
				// Do some long processing.
				}
				}
				}

				Would be transformed to:

				.. code-block:: c++

				void Process(MyClass* C) {
				if (!C)
				return;
				// Do some long processing.
				}

				void Process(span<MyClass*> C){
				for (MyClass *Item : C) {
				if (!Item)
				continue;
				// Do some long processing.
				}
				}

				Options
				-------

				.. option:: LineCountThreshold

				Don't transform any ``if`` statement if the statement uses less than this
				many lines. Default value is `10`.

				.. option:: SplitConjunctions

				If `true`, split up conditions with cunjunctions (``&&``) into multiple
				``if`` statements. Default value is `false`.
				JonasTothUnsubmitted Done Reply Inline Actions typo `cunjunctions -> conjunctions` JonasToth: typo `cunjunctions -> conjunctions`

				When `true`:

				.. code-block:: c++

				void Process(bool A, bool B) {
				if (A && B) {
				// Long processing.
				JonasTothUnsubmitted Not Done Reply Inline Actions if this option is false, the transformation would be `if(!(A && B))`, right? should demorgan rules be applied or at least be mentioned here? I think transforming to `if (!A \|\| !B)` is at least a viable option for enough users. JonasToth: if this option is false, the transformation would be `if(!(A && B))`, right? should demorgan…
				njames93AuthorUnsubmitted Not Done Reply Inline Actions Once this is in, I plan to merge some common code with the simplify-boolean-expr logic for things like demorgan processing. Right now the transformation happens, the simplify boolean suggests a demorgan transformation of you run the output through clang tidy. njames93: Once this is in, I plan to merge some common code with the simplify-boolean-expr logic for…
				JonasTothUnsubmitted Done Reply Inline Actions a short reference to the `readability-simplify-boolean-expr` check in the user facing docs would be great. i personally find it ok if the users "pipe" multiple checks together to reach a final transformation. would this check then use the same settings as the `readability-simplify-boolean-expr` check? (that of course off topic and does not relate to this patch :) ) JonasToth: a short reference to the `readability-simplify-boolean-expr` check in the user facing docs…
				njames93AuthorUnsubmitted Done Reply Inline Actions I'm not sure it's really necessary to mention that the fix would likely need another fix, besides that comment would just be removed in the follow up. njames93: I'm not sure it's really necessary to mention that the fix would likely need another fix…
				JonasTothUnsubmitted Done Reply Inline Actions ok, thats good with me. JonasToth: ok, thats good with me.
				}
				}

				Would be transformed to:

				.. code-block:: c++

				void Process(bool A, bool B) {
				if (!A)
				return;

				if (!B)
				return;

				// Long processing.
				}

				.. option:: WrapInBraces

				If `true`, the early exit will be wrapped in braces.

				If unspecified, the value will be inferred based on whether
				:doc:`readability-braces-around-statements <braces-around-statements>` or one
				of its alias' are active.

				When `true`, The above exmples would be transformed to:

				.. code-block:: c++

				void Process(MyClass *C) {
				if (!C) {
				return;
				}
				// Do some long processing
				}

				void Process(span<MyClass*> C){
				for (MyClass *Item : C) {
				if (!Item) {
				continue;
				}
				// Do some long processing.
				}
				}
				Eugene.ZelenkoUnsubmitted Done Reply Inline Actions Please add newline. Eugene.Zelenko: Please add newline.
				JonasTothUnsubmitted Done Reply Inline Actions maybe highlight the `if` as code with double quotes? JonasToth: maybe highlight the `if` as code with double quotes?