Code Quality: Replace for loops with LISTBASE_FOREACH
ClosedPublic
Actions

Authored by Dalai Felinto (dfelinto) on Apr 3 2020, 2:20 PM.

Details

Reviewers: None
Commits: rBd138cbfb47e3: Code Quality: Replace for loops with LISTBASE_FOREACH

Summary

The script itself is:

#!/bin/bash

# ListBase for loop cleanup
#
# "Usage: ./listbase_foreach.sh FILE [dryrun]";
#
# Note: It runs clang-format in the files so some harmless
# false positive changes may occur.

if [[ $# -eq 0 ]]; 
    then
	echo "Replace for loops with LISTBASE_FOREACH"
	echo "Usage: ./listbase_foreach.sh FILE [dryrun]";
	exit 1
fi

DRYRUN=0
if [[ $# -gt 1 ]]; then DRYRUN=1; fi

FILE="$1"
TMP_FILE="/tmp/LISTBASE_FOREACH"

if [ ! -f "$FILE" ]; then
	echo "File invalid: \"$FILE\""
	exit 1
fi

# The main regex
< $FILE tr '\n' '\f' |
sed "s/for (\([^;]\+\);[[:space:]]\+\([^;]\+\);[[:space:]]\+\([^;]\+\)) {/for (\1; \2; \3) {/g" |
tr '\f' '\n' |
sed "s/for (\(const \)\?\(\b\w*\b\) \*\(\b\w*\b\) = \(.*\)\.first; \3; \3 = \3->next) {/LISTBASE_FOREACH (\1\2 *, \3, \&\4) {/" |
sed "s/for (\(const \)\?\(\b\w*\b\) \*\(\b\w*\b\) = \(.*\)\->first; \3; \3 = \3->next) {/LISTBASE_FOREACH (\1\2 *, \3, \4) {/" > $TMP_FILE

if [[ $DRYRUN -eq 1 ]]; then
	grep LISTBASE_FOREACH $TMP_FILE
else
	cp $TMP_FILE $FILE
	clang-format -i $FILE
fi

And I ran it with for i in find . -name *.c`; do echo $i; listbase_foreach.sh $i; done`

Diff Detail

Repository

rB Blender

Branch

listbase-foreach (branched from master)

Build Status

Buildable 7446
Build 7446: arc lint + arc unit

Event Timeline

Dalai Felinto (dfelinto) created this revision.Apr 3 2020, 2:20 PM

Harbormaster completed remote builds in B7432: Diff 23392.Apr 3 2020, 2:20 PM

Dalai Felinto (dfelinto) planned changes to this revision.Apr 3 2020, 2:31 PM

Dalai Felinto (dfelinto) retitled this revision from Code Quality: Replace for loops with LISTBASE_FOREACH to Code Quality: Replace for loops with LISTBASE_FOREACH (wip).

Dalai Felinto (dfelinto) edited the summary of this revision. (Show Details)

Dalai Felinto (dfelinto) edited the summary of this revision. (Show Details)Apr 3 2020, 2:44 PM

Including missing includes
Adjustment required

Harbormaster completed remote builds in B7445: Diff 23408.Apr 3 2020, 5:43 PM

It seems fine.

It's missing case where there is no variable definition inside the for loop, but that's very hard to automate to this extent.

There's also the case of id.next for the datablock lists in Main, but not sure we have a macro for that.

Single build error on windows, smooth sailing sofar , but have not run any tests.

source/blender/render/intern/source/pipeline.c
2103	LISTBASE_FOREACH (ViewLayer *, view_layer, re->view_layers) {

Final updates, build seems to be working fine

Harbormaster completed remote builds in B7446: Diff 23409.Apr 3 2020, 6:34 PM

Final take, using BLI_listbase.h instead.

Harbormaster completed remote builds in B7447: Diff 23410.Apr 3 2020, 6:44 PM

make format

Harbormaster completed remote builds in B7448: Diff 23411.Apr 3 2020, 6:46 PM

Dalai Felinto (dfelinto) retitled this revision from Code Quality: Replace for loops with LISTBASE_FOREACH (wip) to Code Quality: Replace for loops with LISTBASE_FOREACH.Apr 3 2020, 7:14 PM

Dalai Felinto (dfelinto) edited the summary of this revision. (Show Details)

This revision was not accepted when it landed; it landed in state Needs Review.Apr 3 2020, 7:29 PM

Closed by commit rBd138cbfb47e3: Code Quality: Replace for loops with LISTBASE_FOREACH (authored by Dalai Felinto (dfelinto)). · Explain Why

This revision was automatically updated to reflect the committed changes.

Dalai Felinto (dfelinto) added a commit: rBd138cbfb47e3: Code Quality: Replace for loops with LISTBASE_FOREACH.

Dalai Felinto (dfelinto) mentioned this in T73586: Code Quality Day Tasks.Apr 3 2020, 7:38 PM

Large Diff

This large diff affects 206 files. Files without inline comments have been collapsed. Expand All Files

Revision Contents
Changeset List

Path

Size

source/

blender/

blenkernel/

intern/

18 lines

12 lines

6 lines

2 lines

2 lines

2 lines

42 lines

4 lines

6 lines

8 lines

6 lines

6 lines

2 lines

4 lines

4 lines

2 lines

3 lines

14 lines

2 lines

117 lines

12 lines

4 lines

45 lines

2 lines

23 lines

12 lines

2 lines

2 lines

24 lines

10 lines

2 lines

2 lines

6 lines

3 lines

2 lines

8 lines

2 lines

blenlib/

intern/

array_store.c

18 lines

threads.c

6 lines

blenloader/

intern/

134 lines

2 lines

40 lines

324 lines

48 lines

versioning_defaults.c

34 lines

versioning_userdef.c

11 lines

writefile.c

102 lines

bmesh/

intern/

bmesh_marking.c

4 lines

bmesh_mesh.c

2 lines

draw/

engines/

eevee/

eevee_materials.c

3 lines

eevee_volumes.c

3 lines

gpencil/

gpencil_engine.c

13 lines

overlay/

overlay_extra.c

4 lines

overlay_image.c

4 lines

overlay_motion_path.c

3 lines

workbench/

workbench_volume.c

3 lines

intern/

draw_cache_impl_curve.c

17 lines

draw_cache_impl_displist.c

17 lines

draw_cache_impl_mesh.c

3 lines

draw_cache_impl_volume.c

3 lines

draw_manager.c

17 lines

draw_manager_data.c

7 lines

draw_manager_profiling.c

3 lines

draw_manager_shader.c

2 lines

editors/

animation/

4 lines

12 lines

8 lines

15 lines

armature/

4 lines

12 lines

9 lines

14 lines

42 lines

10 lines

3 lines

2 lines

4 lines

curve/

editcurve.c

4 lines

editcurve_select.c

5 lines

gpencil/

gpencil_armature.c

4 lines

gpencil_data.c

24 lines

gpencil_edit.c

2 lines

gpencil_ops_versioning.c

10 lines

gpencil_utils.c

2 lines

interface/

interface.c

22 lines

interface_eyedropper_gpencil_color.c

3 lines

12 lines

4 lines

10 lines

19 lines

interface_region_color_picker.c

2 lines

interface_region_hud.c

6 lines

interface_region_menu_popup.c

6 lines

interface_region_popup.c

10 lines

interface_region_tooltip.c

5 lines

interface_templates.c

4 lines

view2d.c

4 lines

mask/

2 lines

28 lines

9 lines

36 lines

16 lines

mesh/

editmesh_extrude_spin_gizmo.c

3 lines

editmesh_utils.c

3 lines

meshtools.c

6 lines

metaball/

mball_edit.c

4 lines

object/

object_add.c

4 lines

object_data_transform.c

4 lines

10 lines

8 lines

4 lines

5 lines

2 lines

render/

render_internal.c

6 lines

render_preview.c

6 lines

render_update.c

4 lines

scene/

scene_edit.c

4 lines

screen/

14 lines

15 lines

4 lines

32 lines

10 lines

30 lines

8 lines

9 lines

workspace_layout_edit.c

2 lines

sculpt_paint/

paint_image.c

4 lines

paint_ops.c

4 lines

sculpt.c

6 lines

space_action/

action_draw.c

2 lines

action_select.c

4 lines

space_action.c

2 lines

space_buttons/

space_buttons.c

2 lines

space_clip/

clip_editor.c

5 lines

space_image/

image_ops.c

6 lines

image_sequence.c

2 lines

image_undo.c

22 lines

space_info/

info_report.c

4 lines

space_nla/

nla_channels.c

2 lines

nla_draw.c

8 lines

nla_select.c

2 lines

space_node/

node_edit.c

4 lines

node_relationships.c

2 lines

node_select.c

3 lines

space_outliner/

outliner_collections.c

10 lines

10 lines

33 lines

4 lines

4 lines

9 lines

2 lines

19 lines

11 lines

space_sequencer/

sequencer_edit.c

2 lines

sequencer_select.c

4 lines

space_view3d/

2 lines

2 lines

12 lines

2 lines

transform/

transform_convert.c

13 lines

transform_convert_armature.c

10 lines

transform_convert_curve.c

5 lines

transform_convert_object.c

18 lines

transform_gizmo_3d.c

6 lines

transform_snap_object.c

4 lines

undo/

ed_undo.c

8 lines

util/

ed_util.c

3 lines

gpu/

intern/

2 lines

20 lines

4 lines

4 lines

3 lines

6 lines

4 lines

ikplugin/

intern/

iksolver_plugin.c

2 lines

makesrna/

intern/

rna_access_compare_override.c

9 lines

3 lines

4 lines

4 lines

5 lines

5 lines

12 lines

10 lines

modifiers/

intern/

MOD_dynamicpaint.c

4 lines

nodes/

shader/

node_shader_tree.c

6 lines

nodes/

node_shader_displacement.c

2 lines

node_shader_tex_brick.c

2 lines

node_shader_volume_principled.c

4 lines

python/

intern/

bpy_capi_utils.c

3 lines

render/

intern/

source/

pipeline.c

7 lines

render_result.c

16 lines

windowmanager/

gizmo/

intern/

wm_gizmo_group.c

30 lines

wm_gizmo_map.c

51 lines

wm_gizmo_type.c

6 lines

intern/

4 lines

25 lines

22 lines

8 lines

2 lines

6 lines

3 lines

8 lines

2 lines

28 lines

19 lines

message_bus/

intern/

wm_message_bus.c

11 lines

Code Quality: Replace for loops with LISTBASE_FOREACHClosedPublicActions

Details

Diff Detail

Event Timeline

Large Diff

Revision ContentsChangeset List

Diff 23409

source/blender/blenkernel/intern/anim_sys.c

source/blender/blenkernel/intern/armature.c

source/blender/blenkernel/intern/blender.c

source/blender/blenkernel/intern/blender_user_menu.c

source/blender/blenkernel/intern/blendfile.c

source/blender/blenkernel/intern/camera.c

source/blender/blenkernel/intern/collection.c

source/blender/blenkernel/intern/collision.c

source/blender/blenkernel/intern/constraint.c

source/blender/blenkernel/intern/curve.c

source/blender/blenkernel/intern/effect.c

source/blender/blenkernel/intern/fcurve.c

source/blender/blenkernel/intern/fmodifier.c

source/blender/blenkernel/intern/gpencil.c

source/blender/blenkernel/intern/gpencil_geom.c

source/blender/blenkernel/intern/idprop.c

source/blender/blenkernel/intern/idprop_utils.c

source/blender/blenkernel/intern/image.c

source/blender/blenkernel/intern/keyconfig.c

source/blender/blenkernel/intern/layer.c

source/blender/blenkernel/intern/lib_id.c

source/blender/blenkernel/intern/lib_override.c

source/blender/blenkernel/intern/lib_query.c

source/blender/blenkernel/intern/material.c

source/blender/blenkernel/intern/mball.c

source/blender/blenkernel/intern/node.c

source/blender/blenkernel/intern/particle.c

source/blender/blenkernel/intern/pointcache.c

source/blender/blenkernel/intern/scene.c

source/blender/blenkernel/intern/screen.c

source/blender/blenkernel/intern/seqeffects.c

source/blender/blenkernel/intern/sequencer.c

source/blender/blenkernel/intern/text.c

source/blender/blenkernel/intern/texture.c

source/blender/blenkernel/intern/tracking_solver.c

source/blender/blenkernel/intern/undo_system.c

source/blender/blenkernel/intern/workspace.c

source/blender/blenlib/intern/array_store.c

source/blender/blenlib/intern/threads.c

source/blender/blenloader/intern/readfile.c

source/blender/blenloader/intern/undofile.c

source/blender/blenloader/intern/versioning_270.c

source/blender/blenloader/intern/versioning_280.c

source/blender/blenloader/intern/versioning_cycles.c

source/blender/blenloader/intern/versioning_defaults.c

source/blender/blenloader/intern/versioning_userdef.c

source/blender/blenloader/intern/writefile.c

source/blender/bmesh/intern/bmesh_marking.c

source/blender/bmesh/intern/bmesh_mesh.c

source/blender/draw/engines/eevee/eevee_materials.c

source/blender/draw/engines/eevee/eevee_volumes.c

source/blender/draw/engines/gpencil/gpencil_engine.c

source/blender/draw/engines/overlay/overlay_extra.c

source/blender/draw/engines/overlay/overlay_image.c

source/blender/draw/engines/overlay/overlay_motion_path.c

source/blender/draw/engines/workbench/workbench_volume.c

source/blender/draw/intern/draw_cache_impl_curve.c

source/blender/draw/intern/draw_cache_impl_displist.c

source/blender/draw/intern/draw_cache_impl_mesh.c

source/blender/draw/intern/draw_cache_impl_volume.c

source/blender/draw/intern/draw_manager.c

source/blender/draw/intern/draw_manager_data.c

source/blender/draw/intern/draw_manager_profiling.c

source/blender/draw/intern/draw_manager_shader.c

source/blender/editors/animation/anim_filter.c

source/blender/editors/animation/anim_markers.c

source/blender/editors/animation/anim_motion_paths.c

source/blender/editors/animation/keyframes_draw.c

source/blender/editors/armature/armature_add.c

source/blender/editors/armature/armature_edit.c

source/blender/editors/armature/armature_naming.c

source/blender/editors/armature/armature_relations.c

source/blender/editors/armature/armature_select.c

Code Quality: Replace for loops with LISTBASE_FOREACH
ClosedPublic
Actions

Revision Contents
Changeset List