Merge pull request #317 from guyhughes/fix-doc

[bspwm.git] / tree.h

diff --git a/tree.h b/tree.h
index 82d20ff98a521823ac5d2e61c84a180136af1231..25316c451757a34ca8dfffc0c9617e874415f942 100644 (file)
--- a/tree.h
+++ b/tree.h
@@ -1,33 +1,75 @@
-#ifndef _TREE_H
-#define _TREE_H
+/* Copyright (c) 2012, Bastien Dejean
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
 
-#define INC_EXP 0.9
-#define DEC_EXP 1.1
+#ifndef BSPWM_TREE_H
+#define BSPWM_TREE_H
 
-bool is_leaf(node_t *);
+void arrange(monitor_t *m, desktop_t *d);
+void apply_layout(monitor_t *m, desktop_t *d, node_t *n, xcb_rectangle_t rect, xcb_rectangle_t root_rect);
+void insert_node(monitor_t *m, desktop_t *d, node_t *n, node_t *f);
+void activate_node(monitor_t *m, desktop_t *d, node_t *n);
+void focus_node(monitor_t *m, desktop_t *d, node_t *n);
+void update_current(void);
+node_t *make_node(void);
+client_t *make_client(xcb_window_t win, unsigned int border_width);
+bool is_leaf(node_t *n);
 bool is_first_child(node_t *n);
 bool is_second_child(node_t *n);
-void change_split_ratio(node_t *, value_change_t);
-node_t *first_extrema(node_t *);
-node_t *second_extrema(node_t *);
-node_t *next_leaf(node_t *);
-node_t *prev_leaf(node_t *);
-node_t *find_fence(node_t *, direction_t);
-node_t *find_neighbor(node_t *, direction_t);
-void move_fence(node_t *, direction_t, fence_move_t);
-void rotate_tree(node_t *, rotate_t);
-void update_root_dimensions(void);
-void apply_layout(desktop_t *, node_t *, xcb_rectangle_t);
-void insert_node(desktop_t *, node_t *);
-void dump_tree(desktop_t *, node_t *, char *, int);
-void list_desktops(char *);
-void focus_node(desktop_t *, node_t *);
-void unlink_node(desktop_t *, node_t *);
-void remove_node(desktop_t *, node_t *);
-void transfer_node(desktop_t *, desktop_t *, node_t *);
-void select_desktop(desktop_t *);
-void cycle_leaf(desktop_t *, node_t *, cycle_dir_t, skip_client_t);
-void update_vacant_state(node_t *);
-bool is_tiled(client_t *);
+void reset_mode(coordinates_t *loc);
+node_t *brother_tree(node_t *n);
+void closest_public(desktop_t *d, node_t *n, node_t **closest, node_t **public);
+node_t *first_extrema(node_t *n);
+node_t *second_extrema(node_t *n);
+node_t *next_leaf(node_t *n, node_t *r);
+node_t *prev_leaf(node_t *n, node_t *r);
+node_t *next_tiled_leaf(desktop_t *d, node_t *n, node_t *r);
+node_t *prev_tiled_leaf(desktop_t *d, node_t *n, node_t *r);
+bool is_adjacent(node_t *a, node_t *b, direction_t dir);
+node_t *find_fence(node_t *n, direction_t dir);
+node_t *nearest_neighbor(monitor_t *m, desktop_t *d, node_t *n, direction_t dir, client_select_t sel);
+node_t *nearest_from_tree(monitor_t *m, desktop_t *d, node_t *n, direction_t dir, client_select_t sel);
+node_t *nearest_from_history(monitor_t *m, desktop_t *d, node_t *n, direction_t dir, client_select_t sel);
+node_t *nearest_from_distance(monitor_t *m, desktop_t *d, node_t *n, direction_t dir, client_select_t sel);
+void get_opposite(direction_t src, direction_t *dst);
+int tiled_area(node_t *n);
+int tiled_count(desktop_t *d);
+node_t *find_biggest(monitor_t *m, desktop_t *d, node_t *n, client_select_t sel);
+void rotate_tree(node_t *n, int deg);
+void rotate_brother(node_t *n);
+void unrotate_tree(node_t *n, int rot);
+void unrotate_brother(node_t *n);
+void flip_tree(node_t *n, flip_t flp);
+void equalize_tree(node_t *n);
+int balance_tree(node_t *n);
+void unlink_node(monitor_t *m, desktop_t *d, node_t *n);
+void remove_node(monitor_t *m, desktop_t *d, node_t *n);
+void destroy_tree(node_t *n);
+bool swap_nodes(monitor_t *m1, desktop_t *d1, node_t *n1, monitor_t *m2, desktop_t *d2, node_t *n2);
+bool transfer_node(monitor_t *ms, desktop_t *ds, node_t *ns, monitor_t *md, desktop_t *dd, node_t *nd);
+node_t *closest_node(monitor_t *m, desktop_t *d, node_t *n, cycle_dir_t dir, client_select_t sel);
+void circulate_leaves(monitor_t *m, desktop_t *d, circulate_dir_t dir);
+void update_vacant_state(node_t *n);
+void update_privacy_level(node_t *n, bool value);
 
 #endif