Merge pull request #3271 from ianyfan/list-cleanup

list.c: Remove list_foreach

common/list.c

@@ -30,15 +30,6 @@ void list_free(list_t *list) {
 	free(list);
 }
 
-void list_foreach(list_t *list, void (*callback)(void *item)) {
-	if (list == NULL || callback == NULL) {
-		return;
-	}
-	for (int i = 0; i < list->length; i++) {
-		callback(list->items[i]);
-	}
-}
-
 void list_add(list_t *list, void *item) {
 	list_resize(list);
 	list->items[list->length++] = item;
@@ -57,8 +48,7 @@ void list_del(list_t *list, int index) {
 }
 
 void list_cat(list_t *list, list_t *source) {
-	int i;
-	for (i = 0; i < source->length; ++i) {
+	for (int i = 0; i < source->length; ++i) {
 		list_add(list, source->items[i]);
 	}
 }
@@ -156,3 +146,15 @@ void list_stable_sort(list_t *list, int compare(const void *a, const void *b)) {
 		list_inplace_sort(list, 0, list->length - 1, compare);
 	}
 }
+
+void list_free_items_and_destroy(list_t *list) {
+	if (!list) {
+		return;
+	}
+
+	for (int i = 0; i < list->length; ++i) {
+		free(list->items[i]);
+	}
+	list_free(list);
+}
+

common/loop.c

@@ -45,10 +45,8 @@ struct loop *loop_create(void) {
 }
 
 void loop_destroy(struct loop *loop) {
-	list_foreach(loop->fd_events, free);
-	list_foreach(loop->timers, free);
-	list_free(loop->fd_events);
-	list_free(loop->timers);
+	list_free_items_and_destroy(loop->fd_events);
+	list_free_items_and_destroy(loop->timers);
 	free(loop->fds);
 	free(loop);
 }

common/stringop.c

@@ -97,14 +97,6 @@ list_t *split_string(const char *str, const char *delims) {
 	return res;
 }
 
-void free_flat_list(list_t *list) {
-	int i;
-	for (i = 0; i < list->length; ++i) {
-		free(list->items[i]);
-	}
-	list_free(list);
-}
-
 char **split_args(const char *start, int *argc) {
 	*argc = 0;
 	int alloc = 2;

include/list.h

@@ -9,7 +9,6 @@ typedef struct {
 
 list_t *create_list(void);
 void list_free(list_t *list);
-void list_foreach(list_t *list, void (*callback)(void* item));
 void list_add(list_t *list, void *item);
 void list_insert(list_t *list, int index, void *item);
 void list_del(list_t *list, int index);
@@ -27,4 +26,10 @@ void list_stable_sort(list_t *list, int compare(const void *a, const void *b));
 void list_swap(list_t *list, int src, int dest);
 // move item to end of list
 void list_move_to_end(list_t *list, void *item);
+
+/* Calls `free` for each item in the list, then frees the list.
+ * Do not use this to free lists of primitives or items that require more
+ * complicated deallocation code.
+ */
+void list_free_items_and_destroy(list_t *list);
 #endif

include/stringop.h

@@ -17,9 +17,8 @@ char *lenient_strncat(char *dest, const char *src, size_t len);
 // strcmp that also handles null pointers.
 int lenient_strcmp(char *a, char *b);
 
-// Simply split a string with delims, free with `free_flat_list`
+// Simply split a string with delims, free with `list_free_items_and_destroy`
 list_t *split_string(const char *str, const char *delims);
-void free_flat_list(list_t *list);
 
 // Splits an argument string, keeping quotes intact
 char **split_args(const char *str, int *argc);

sway/commands.c

@@ -43,8 +43,7 @@ struct cmd_results *checkarg(int argc, const char *name, enum expected_args type
 }
 
 void apply_seat_config(struct seat_config *seat_config) {
-	int i;
-	i = list_seq_find(config->seat_configs, seat_name_cmp, seat_config->name);
+	int i = list_seq_find(config->seat_configs, seat_name_cmp, seat_config->name);
 	if (i >= 0) {
 		// merge existing config
 		struct seat_config *sc = config->seat_configs->items[i];

sway/commands/bar/modifier.c

@@ -20,15 +20,14 @@ struct cmd_results *bar_cmd_modifier(int argc, char **argv) {
 		uint32_t tmp_mod;
 		if ((tmp_mod = get_modifier_mask_by_name(split->items[i])) > 0) {
 			mod |= tmp_mod;
-			continue;
 		} else {
 			error = cmd_results_new(CMD_INVALID, "modifier",
 				"Unknown modifier '%s'", split->items[i]);
-			free_flat_list(split);
+			list_free_items_and_destroy(split);
 			return error;
 		}
 	}
-	free_flat_list(split);
+	list_free_items_and_destroy(split);
 	config->current_bar->modifier = mod;
 	wlr_log(WLR_DEBUG,
 			"Show/Hide the bar when pressing '%s' in hide mode.", argv[0]);

sway/commands/bind.c

@@ -23,9 +23,7 @@ void free_sway_binding(struct sway_binding *binding) {
 		return;
 	}
 
-	if (binding->keys) {
-		free_flat_list(binding->keys);
-	}
+	list_free_items_and_destroy(binding->keys);
 	free(binding->input);
 	free(binding->command);
 	free(binding);
@@ -80,7 +78,6 @@ static int key_qsort_cmp(const void *keyp_a, const void *keyp_b) {
 	return (key_a < key_b) ? -1 : ((key_a > key_b) ? 1 : 0);
 }
 
-
 /**
  * From a keycode, bindcode, or bindsym name and the most likely binding type,
  * identify the appropriate numeric value corresponding to the key. Return NULL
@@ -223,14 +220,14 @@ static struct cmd_results *cmd_bindsym_or_bindcode(int argc, char **argv,
 		uint32_t *key = calloc(1, sizeof(uint32_t));
 		if (!key) {
 			free_sway_binding(binding);
-			free_flat_list(split);
+			list_free_items_and_destroy(split);
 			return cmd_results_new(CMD_FAILURE, bindtype,
 					"Unable to allocate binding key");
 		}
 		*key = key_val;
 		list_add(binding->keys, key);
 	}
-	free_flat_list(split);
+	list_free_items_and_destroy(split);
 	binding->order = binding_order++;
 
 	// refine region of interest for mouse binding once we are certain
@@ -280,7 +277,6 @@ static struct cmd_results *cmd_bindsym_or_bindcode(int argc, char **argv,
 	wlr_log(WLR_DEBUG, "%s - Bound %s to command `%s` for device '%s'",
 		bindtype, argv[0], binding->command, binding->input);
 	return cmd_results_new(CMD_SUCCESS, NULL, NULL);
-
 }
 
 struct cmd_results *cmd_bindsym(int argc, char **argv) {
@@ -291,7 +287,6 @@ struct cmd_results *cmd_bindcode(int argc, char **argv) {
 	return cmd_bindsym_or_bindcode(argc, argv, true);
 }
 
-
 /**
  * Execute the command associated to a binding
  */
@@ -301,15 +296,14 @@ void seat_execute_command(struct sway_seat *seat, struct sway_binding *binding)
 	config->handler_context.seat = seat;
 	list_t *res_list = execute_command(binding->command, NULL, NULL);
 	bool success = true;
-	while (res_list->length) {
-		struct cmd_results *results = res_list->items[0];
+	for (int i = 0; i < res_list->length; ++i) {
+		struct cmd_results *results = res_list->items[i];
 		if (results->status != CMD_SUCCESS) {
 			wlr_log(WLR_DEBUG, "could not run command for binding: %s (%s)",
 				binding->command, results->error);
 			success = false;
 		}
 		free_cmd_results(results);
-		list_del(res_list, 0);
 	}
 	list_free(res_list);
 	if (success) {

sway/commands/reload.c

@@ -24,8 +24,7 @@ static void do_reload(void *data) {
 
 	if (!load_main_config(config->current_config_path, true, false)) {
 		wlr_log(WLR_ERROR, "Error(s) reloading config");
-		list_foreach(bar_ids, free);
-		list_free(bar_ids);
+		list_free_items_and_destroy(bar_ids);
 		return;
 	}
 
@@ -42,9 +41,7 @@ static void do_reload(void *data) {
 			}
 		}
 	}
-
-	list_foreach(bar_ids, free);
-	list_free(bar_ids);
+	list_free_items_and_destroy(bar_ids);
 
 	config_update_font_height(true);
 	root_for_each_container(rebuild_textures_iterator, NULL);

sway/commands/workspace.c

@@ -33,7 +33,7 @@ static struct workspace_config *workspace_config_find_or_create(char *ws_name) {
 
 void free_workspace_config(struct workspace_config *wsc) {
 	free(wsc->workspace);
-	free_flat_list(wsc->outputs);
+	list_free_items_and_destroy(wsc->outputs);
 	free(wsc);
 }
 

sway/config.c

@@ -38,26 +38,24 @@
 struct sway_config *config = NULL;
 
 static void free_mode(struct sway_mode *mode) {
-	int i;
-
 	if (!mode) {
 		return;
 	}
 	free(mode->name);
 	if (mode->keysym_bindings) {
-		for (i = 0; i < mode->keysym_bindings->length; i++) {
+		for (int i = 0; i < mode->keysym_bindings->length; i++) {
 			free_sway_binding(mode->keysym_bindings->items[i]);
 		}
 		list_free(mode->keysym_bindings);
 	}
 	if (mode->keycode_bindings) {
-		for (i = 0; i < mode->keycode_bindings->length; i++) {
+		for (int i = 0; i < mode->keycode_bindings->length; i++) {
 			free_sway_binding(mode->keycode_bindings->items[i]);
 		}
 		list_free(mode->keycode_bindings);
 	}
 	if (mode->mouse_bindings) {
-		for (i = 0; i < mode->mouse_bindings->length; i++) {
+		for (int i = 0; i < mode->mouse_bindings->length; i++) {
 			free_sway_binding(mode->mouse_bindings->items[i]);
 		}
 		list_free(mode->mouse_bindings);
@@ -446,7 +444,7 @@ bool load_main_config(const char *file, bool is_active, bool validating) {
 			}
 		}
 
-		free_flat_list(secconfigs);
+		list_free_items_and_destroy(secconfigs);
 	}
 	*/
 
@@ -654,8 +652,7 @@ bool read_config(FILE *file, struct sway_config *config,
 
 			if (read + length > config_size) {
 				wlr_log(WLR_ERROR, "Config file changed during reading");
-				list_foreach(stack, free);
-				list_free(stack);
+				list_free_items_and_destroy(stack);
 				free(line);
 				return false;
 			}
@@ -684,8 +681,7 @@ bool read_config(FILE *file, struct sway_config *config,
 		}
 		char *expanded = expand_line(block, line, brace_detected > 0);
 		if (!expanded) {
-			list_foreach(stack, free);
-			list_free(stack);
+			list_free_items_and_destroy(stack);
 			free(line);
 			return false;
 		}
@@ -750,8 +746,7 @@ bool read_config(FILE *file, struct sway_config *config,
 		free(line);
 		free_cmd_results(res);
 	}
-	list_foreach(stack, free);
-	list_free(stack);
+	list_free_items_and_destroy(stack);
 	config->current_config_line_number = 0;
 	config->current_config_line = NULL;
 

sway/config/bar.c

@@ -49,13 +49,10 @@ void free_bar_config(struct bar_config *bar) {
 	free(bar->font);
 	free(bar->separator_symbol);
 	for (int i = 0; i < bar->bindings->length; i++) {
-		struct bar_binding *binding = bar->bindings->items[i];
-		free_bar_binding(binding);
+		free_bar_binding(bar->bindings->items[i]);
 	}
 	list_free(bar->bindings);
-	if (bar->outputs) {
-		free_flat_list(bar->outputs);
-	}
+	list_free_items_and_destroy(bar->outputs);
 	if (bar->pid != 0) {
 		terminate_swaybar(bar->pid);
 	}

sway/config/seat.c

@@ -117,11 +117,8 @@ void free_seat_config(struct seat_config *seat) {
 
 	free(seat->name);
 	for (int i = 0; i < seat->attachments->length; ++i) {
-		struct seat_attachment_config *attachment =
-			seat->attachments->items[i];
-		seat_attachment_config_free(attachment);
+		seat_attachment_config_free(seat->attachments->items[i]);
 	}
-
 	list_free(seat->attachments);
 	free(seat);
 }

sway/ipc-server.c

@@ -73,14 +73,11 @@ static void handle_display_destroy(struct wl_listener *listener, void *data) {
 	unlink(ipc_sockaddr->sun_path);
 
 	while (ipc_client_list->length) {
-		struct ipc_client *client = ipc_client_list->items[0];
-		ipc_client_disconnect(client);
+		ipc_client_disconnect(ipc_client_list->items[ipc_client_list->length-1]);
 	}
 	list_free(ipc_client_list);
 
-	if (ipc_sockaddr) {
-		free(ipc_sockaddr);
-	}
+	free(ipc_sockaddr);
 
 	wl_list_remove(&ipc_display_destroy.link);
 }

sway/main.c

@@ -393,13 +393,12 @@ int main(int argc, char **argv) {
 	while (config->cmd_queue->length) {
 		char *line = config->cmd_queue->items[0];
 		list_t *res_list = execute_command(line, NULL, NULL);
-		while (res_list->length) {
-			struct cmd_results *res = res_list->items[0];
+		for (int i = 0; i < res_list->length; ++i) {
+			struct cmd_results *res = res_list->items[i];
 			if (res->status != CMD_SUCCESS) {
 				wlr_log(WLR_ERROR, "Error on line '%s': %s", line, res->error);
 			}
 			free_cmd_results(res);
-			list_del(res_list, 0);
 		}
 		list_free(res_list);
 		free(line);

sway/tree/container.c

@@ -21,6 +21,7 @@
 #include "sway/tree/arrange.h"
 #include "sway/tree/view.h"
 #include "sway/tree/workspace.h"
+#include "list.h"
 #include "log.h"
 #include "stringop.h"
 
@@ -67,8 +68,7 @@ void container_destroy(struct sway_container *con) {
 	list_free(con->current.children);
 	list_free(con->outputs);
 
-	list_foreach(con->marks, free);
-	list_free(con->marks);
+	list_free_items_and_destroy(con->marks);
 	wlr_texture_destroy(con->marks_focused);
 	wlr_texture_destroy(con->marks_focused_inactive);
 	wlr_texture_destroy(con->marks_unfocused);
@@ -1267,7 +1267,9 @@ bool container_find_and_unmark(char *mark) {
 }
 
 void container_clear_marks(struct sway_container *con) {
-	list_foreach(con->marks, free);
+	for (int i = 0; i < con->marks->length; ++i) {
+		free(con->marks->items[i]);
+	}
 	con->marks->length = 0;
 	ipc_event_window(con, "mark");
 }

sway/tree/workspace.c

@@ -142,7 +142,7 @@ void workspace_destroy(struct sway_workspace *workspace) {
 
 	free(workspace->name);
 	free(workspace->representation);
-	free_flat_list(workspace->output_priority);
+	list_free_items_and_destroy(workspace->output_priority);
 	list_free(workspace->floating);
 	list_free(workspace->tiling);
 	list_free(workspace->current.floating);

swayidle/main.c

@@ -365,11 +365,6 @@ static int parse_args(int argc, char *argv[]) {
 	return 0;
 }
 
-static void register_zero_idle_timeout(void *item) {
-	struct swayidle_timeout_cmd *cmd = item;
-	register_timeout(cmd, 0);
-}
-
 static int handle_signal(int sig, void *data) {
 	switch (sig) {
 	case SIGINT:
@@ -378,7 +373,9 @@ static int handle_signal(int sig, void *data) {
 		return 0;
 	case SIGUSR1:
 		wlr_log(WLR_DEBUG, "Got SIGUSR1");
-		list_foreach(state.timeout_cmds, register_zero_idle_timeout);
+		for (int i = 0; i < state.timeout_cmds->length; ++i) {
+			register_timeout(state.timeout_cmds->items[i], 0);
+		}
 		return 1;
 	}
 	assert(false); // not reached
@@ -409,11 +406,6 @@ static int display_event(int fd, uint32_t mask, void *data) {
 	return count;
 }
 
-static void register_idle_timeout(void *item) {
-	struct swayidle_timeout_cmd *cmd = item;
-	register_timeout(cmd, cmd->timeout);
-}
-
 int main(int argc, char *argv[]) {
 	if (parse_args(argc, argv) != 0) {
 		return -1;
@@ -458,7 +450,10 @@ int main(int argc, char *argv[]) {
 		sway_terminate(0);
 	}
 
-	list_foreach(state.timeout_cmds, register_idle_timeout);
+	for (int i = 0; i < state.timeout_cmds->length; ++i) {
+		struct swayidle_timeout_cmd *cmd = state.timeout_cmds->items[i];
+		register_timeout(cmd, cmd->timeout);
+	}
 
 	wl_display_roundtrip(state.display);
 

swaynag/swaynag.c

@@ -407,9 +407,8 @@ void swaynag_destroy(struct swaynag *swaynag) {
 	swaynag->run_display = false;
 
 	free(swaynag->message);
-	while (swaynag->buttons->length) {
-		struct swaynag_button *button = swaynag->buttons->items[0];
-		list_del(swaynag->buttons, 0);
+	for (int i = 0; i < swaynag->buttons->length; ++i) {
+		struct swaynag_button *button = swaynag->buttons->items[i];
 		free(button->text);
 		free(button->action);
 		free(button);

swaynag/types.c

@@ -147,10 +147,8 @@ void swaynag_type_free(struct swaynag_type *type) {
 }
 
 void swaynag_types_free(list_t *types) {
-	while (types->length) {
-		struct swaynag_type *type = types->items[0];
-		swaynag_type_free(type);
-		list_del(types, 0);
+	for (int i = 0; i < types->length; ++i) {
+		swaynag_type_free(types->items[i]);
 	}
 	list_free(types);
 }