introspection: Build with --warn-fatal, drop fix-meta-rectangle.py hack

Cleanly build with --warn-fatal.  Implementation:

* Liberally apply (skip) where the API is clearly C only, e.g. uses
  XLib.  The theming code and MutterPlugin are skipped too.
* Add missing (transfer) and (element-type) annotations

For a few functions that had a comment, I turned it into gtk-doc, but
I didn't (with a few exceptions) try to write new documentation in
this pass.
This commit is contained in:
Colin Walters
2010-09-01 15:39:53 -04:00
parent 599eb5e3e4
commit 4c0763792d
19 changed files with 370 additions and 41 deletions

View File

@ -529,7 +529,12 @@ compare_rect_areas (gconstpointer a, gconstpointer b)
return b_area - a_area; /* positive ret value denotes b > a, ... */
}
/* This function is trying to find a "minimal spanning set (of rectangles)"
/**
* meta_rectangle_get_minimal_spanning_set_for_region:
* @basic_rect: Input rectangle
* @all_struts: (element-type Meta.Rectangle): List of struts
*
* This function is trying to find a "minimal spanning set (of rectangles)"
* for a given region.
*
* The region is given by taking basic_rect, then removing the areas
@ -542,10 +547,7 @@ compare_rect_areas (gconstpointer a, gconstpointer b)
* the region if and only if it is contained within at least one of the
* rectangles.
*
* The GList* returned will be a list of (allocated) MetaRectangles.
* The list will need to be freed by calling
* meta_rectangle_free_spanning_set() on it (or by manually
* implementing that function...)
* Returns: (transfer full) (element-type Meta.Rectangle): Minimal spanning set
*/
GList*
meta_rectangle_get_minimal_spanning_set_for_region (
@ -678,6 +680,10 @@ meta_rectangle_get_minimal_spanning_set_for_region (
return ret;
}
/**
* meta_rectangle_expand_region: (skip)
*
*/
GList*
meta_rectangle_expand_region (GList *region,
const int left_expand,
@ -694,6 +700,10 @@ meta_rectangle_expand_region (GList *region,
0);
}
/**
* meta_rectangle_expand_region_conditionally: (skip)
*
*/
GList*
meta_rectangle_expand_region_conditionally (GList *region,
const int left_expand,
@ -1671,7 +1681,10 @@ fix_up_edges (MetaRectangle *rect, MetaEdge *edge,
}
}
/* This function removes intersections of edges with the rectangles from the
/**
* meta_rectangle_remove_intersections_with_boxes_from_edges: (skip)
*
* This function removes intersections of edges with the rectangles from the
* list of edges.
*/
GList*
@ -1737,7 +1750,11 @@ meta_rectangle_remove_intersections_with_boxes_from_edges (
return edges;
}
/* This function is trying to find all the edges of an onscreen region. */
/**
* meta_rectangle_find_onscreen_edges: (skip)
*
* This function is trying to find all the edges of an onscreen region.
*/
GList*
meta_rectangle_find_onscreen_edges (const MetaRectangle *basic_rect,
const GSList *all_struts)
@ -1820,6 +1837,10 @@ meta_rectangle_find_onscreen_edges (const MetaRectangle *basic_rect,
return ret;
}
/**
* meta_rectangle_find_nonintersected_monitor_edges: (skip)
*
*/
GList*
meta_rectangle_find_nonintersected_monitor_edges (
const GList *monitor_rects,

View File

@ -4550,6 +4550,18 @@ find_tab_backward (MetaDisplay *display,
return NULL;
}
/**
* meta_display_get_tab_list:
* @display: a #MetaDisplay
* @type: type of tab list
* @screen: a #MetaScreen
* @workspace: origin workspace
*
* Determine the list of windows that should be displayed for Alt-TAB
* functionality. The windows are returned in most recently used order.
*
* Returns: (transfer container) (element-type Meta.Window): List of windows
*/
GList*
meta_display_get_tab_list (MetaDisplay *display,
MetaTabList type,
@ -4627,6 +4639,21 @@ meta_display_get_tab_list (MetaDisplay *display,
return tab_list;
}
/**
* meta_display_get_tab_next:
* @display: a #MetaDisplay
* @type: type of tab list
* @screen: a #MetaScreen
* @workspace: origin workspace
* @window: (allow-none): starting window
* @backward: If %TRUE, look for the previous window.
*
* Determine the next window that should be displayed for Alt-TAB
* functionality.
*
* Returns: (transfer none): Next window
*
*/
MetaWindow*
meta_display_get_tab_next (MetaDisplay *display,
MetaTabList type,
@ -4677,6 +4704,18 @@ meta_display_get_tab_next (MetaDisplay *display,
return ret;
}
/**
* meta_display_get_tab_current:
* @display: a #MetaDisplay
* @type: type of tab list
* @screen: a #MetaScreen
* @workspace: origin workspace
*
* Determine the active window that should be displayed for Alt-TAB.
*
* Returns: (transfer none): Current window
*
*/
MetaWindow*
meta_display_get_tab_current (MetaDisplay *display,
MetaTabList type,
@ -5353,18 +5392,32 @@ meta_display_get_compositor_version (MetaDisplay *display,
*minor = display->composite_minor_version;
}
/**
* meta_display_get_xdisplay: (skip)
*
*/
Display *
meta_display_get_xdisplay (MetaDisplay *display)
{
return display->xdisplay;
}
/**
* meta_display_get_compositor: (skip)
*
*/
MetaCompositor *
meta_display_get_compositor (MetaDisplay *display)
{
return display->compositor;
}
/**
* meta_display_get_screens:
* @display: a #MetaDisplay
*
* Returns: (transfer none) (element-type Meta.Screen): Screens for this display
*/
GSList *
meta_display_get_screens (MetaDisplay *display)
{

View File

@ -104,6 +104,10 @@ meta_group_unref (MetaGroup *group)
}
}
/**
* meta_window_get_group: (skip)
*
*/
MetaGroup*
meta_window_get_group (MetaWindow *window)
{
@ -198,6 +202,10 @@ meta_window_shutdown_group (MetaWindow *window)
remove_window_from_group (window);
}
/**
* meta_display_lookup_group: (skip)
*
*/
MetaGroup*
meta_display_lookup_group (MetaDisplay *display,
Window group_leader)
@ -213,6 +221,12 @@ meta_display_lookup_group (MetaDisplay *display,
return group;
}
/**
* meta_group_list_windows:
* @group: A #MetaGroup
*
* Returns: (transfer container) (element-type Meta.Window): List of windows
*/
GSList*
meta_group_list_windows (MetaGroup *group)
{
@ -263,6 +277,10 @@ meta_group_get_startup_id (MetaGroup *group)
return group->startup_id;
}
/**
* meta_group_property_notify: (skip)
*
*/
gboolean
meta_group_property_notify (MetaGroup *group,
XEvent *event)

View File

@ -3547,6 +3547,10 @@ meta_keybindings_set_custom_handler (const gchar *name,
return TRUE;
}
/**
* meta_keybindings_switch_window: (skip)
*
*/
void
meta_keybindings_switch_window (MetaDisplay *display,
MetaScreen *screen,

View File

@ -886,6 +886,10 @@ handle_preference_update_int (const gchar *key, GConfValue *value)
/* Listeners. */
/****************************************************************************/
/**
* meta_prefs_add_listener: (skip)
*
*/
void
meta_prefs_add_listener (MetaPrefsChangedFunc func,
gpointer data)
@ -899,6 +903,10 @@ meta_prefs_add_listener (MetaPrefsChangedFunc func,
listeners = g_list_prepend (listeners, l);
}
/**
* meta_prefs_remove_listener: (skip)
*
*/
void
meta_prefs_remove_listener (MetaPrefsChangedFunc func,
gpointer data)
@ -2998,6 +3006,11 @@ meta_prefs_set_compositing_manager (gboolean whether)
#endif
}
/**
* meta_prefs_get_clutter_plugins:
*
* Returns: (transfer none) (element-type utf8): Plugin names to load
*/
GSList *
meta_prefs_get_clutter_plugins (void)
{

View File

@ -3122,6 +3122,10 @@ meta_screen_get_display (MetaScreen *screen)
return screen->display;
}
/**
* meta_screen_get_xroot: (skip)
*
*/
Window
meta_screen_get_xroot (MetaScreen *screen)
{
@ -3137,6 +3141,10 @@ meta_screen_get_size (MetaScreen *screen,
*height = screen->rect.height;
}
/**
* meta_screen_get_compositor_data: (skip)
*
*/
gpointer
meta_screen_get_compositor_data (MetaScreen *screen)
{
@ -3178,6 +3186,12 @@ meta_screen_unset_cm_selection (MetaScreen *screen)
None, screen->wm_cm_timestamp);
}
/**
* meta_screen_get_workspaces: (skip)
* @screen: a #MetaScreen
*
* Returns: (transfer none) (element-type Meta.Workspace): The workspaces for @screen
*/
GList *
meta_screen_get_workspaces (MetaScreen *screen)
{

View File

@ -4371,10 +4371,17 @@ idle_move_resize (gpointer data)
return FALSE;
}
/* This is used to notify us of an unrequested configuration
* (only applicable to override redirect windows) */
/**
* meta_window_configure_notify: (skip)
* @window: a #MetaWindow
* @event: a #XConfigureEvent
*
* This is used to notify us of an unrequested configuration
* (only applicable to override redirect windows)
*/
void
meta_window_configure_notify (MetaWindow *window, XConfigureEvent *event)
meta_window_configure_notify (MetaWindow *window,
XConfigureEvent *event)
{
g_assert (window->override_redirect);
g_assert (window->frame == NULL);
@ -4927,6 +4934,15 @@ find_root_ancestor (MetaWindow *window,
return TRUE;
}
/**
* meta_window_find_root_ancestor:
* @window: a #MetaWindow
*
* Follow the chain of parents of @window, skipping transient windows,
* and return the "root" window which has no non-transient parent.
*
* Returns: (transfer none): The root ancestor window
*/
MetaWindow *
meta_window_find_root_ancestor (MetaWindow *window)
{
@ -8828,6 +8844,10 @@ meta_window_unset_demands_attention (MetaWindow *window)
}
}
/**
* meta_window_get_frame: (skip)
*
*/
MetaFrame *
meta_window_get_frame (MetaWindow *window)
{
@ -8896,12 +8916,22 @@ meta_window_get_screen (MetaWindow *window)
return window->screen;
}
/**
* meta_window_get_display:
* @window: A #MetaWindow
*
* Returns: (transfer none): The display for @window
*/
MetaDisplay *
meta_window_get_display (MetaWindow *window)
{
return window->display;
}
/**
* meta_window_get_xwindow: (skip)
*
*/
Window
meta_window_get_xwindow (MetaWindow *window)
{