libgitk core

Files
file	gitk.h
	libgitk includes
file	gitkdone.c
	libgitk done routines
file	gitkdone.h
	libgitk done routines
file	gitkglobal.c
	libgitk global vars
file	gitkglobal.h
	libgitk global vars
file	gitkincludes.h
	libgitk local includes
file	gitkinit.c
	libgitk init routine
file	gitkinit.h
	libgitk init routines
file	gitklayout.c
	layout routines
file	gitklayout.h
	layout routines
file	gitktools.c
	libgitk tools
file	gitktools.h
	libgitk tools
file	gitkversion.c
	libgitk version checking
file	gitkversion.h
	libgitk version checking
file	gitkwrapper.c
	wrapper for renderer-plugins
file	gitkwrapper.h
	wrapper for renderer-plugins
Modules
group	giml dtd
group	libgitk context manager
group	libgitk dialog class
group	libgitk error handling
group	libgitk profile manager
group	libgitk renderer plugin manager
group	libgitk internal http server
group	libgitk dialog templates
group	libgitk logging routines
group	libgitk widget class
group	libgitk core unit tests
Functions
xmlNodePtr	gitk__cxpath_get_node (GitkDialogPtr const dialog, GitkDialogAccessType access_type, xmlXPathCompExprPtr const xpath_comp_expression, xmlNodePtr const root_node)
	return the first node of the result of the evaluation of the supplied compiled xpath expression agains the given document
xmlXPathObjectPtr	gitk__cxpath_get_object (GitkDialogPtr const dialog, GitkDialogAccessType access_type, xmlXPathCompExprPtr const xpath_comp_expression, xmlNodePtr const root_node)
	return the result as xmlXPathObjectPtr of the evaluation of the supplied compiled xpath expression agains the given document
gchar *	gitk__cxpath_get_string (GitkDialogPtr const dialog, GitkDialogAccessType access_type, xmlXPathCompExprPtr const xpath_comp_expression, xmlNodePtr const root_node)
	return the result as string of the evaluation of the supplied compiled xpath expression agains the given document
xmlNodePtr	gitk__xpath_get_node (GitkDialogPtr const dialog, GitkDialogAccessType access_type, gchar *const xpath_expression, xmlNodePtr const root_node)
	return the first node of the result of the evaluation of the supplied xpath expression agains the given document
xmlXPathObjectPtr	gitk__xpath_get_object (GitkDialogPtr const dialog, GitkDialogAccessType access_type, gchar *const xpath_expression, xmlNodePtr const root_node)
	return the result as xmlXPathObjectPtr of the evaluation of the supplied xpath expression agains the given document
gchar *	gitk__xpath_get_string (GitkDialogPtr const dialog, GitkDialogAccessType access_type, gchar *const xpath_expression, xmlNodePtr const root_node)
	return the result as string of the evaluation of the supplied xpath expression agains the given document
void	gitk_done (void)
	Frees memory and data used by the library.
void	gitk_event_loop_end (void)
	activates the event_loop of current selected renderer
void	gitk_event_loop_start (void)
	activates the event_loop of current selected renderer
void	gitk_init (guint *const argc, gchar ***const argv, gchar *const _client_package_name, gchar *const _client_locale_dir)
	Filters gitk-related options from commandline options, setup initial data for the application using the lib and loads the renderer.
xmlXPathObjectPtr	gitk_xpath_type_filter (xmlXPathObjectPtr xpath_optr, const xmlXPathObjectType type)
	test if the given XPathObject is of the expected type, otherwise discard the object

---

Detailed Description

The gitk core module manages plugin handling and provides common support routines, e.g. for logging, error handling and introspection. Most of these functions are interesting to core developers and rendering plugin writers.

Client applications of this library should wrap their usage of the library with calls to gitk_init() and gitk_done().
The next action, usualy is to create and use dialog objects. The libgitk dialog class provides all methods for it, such as e.g. gitk_dialog_new().
Furthermore gitk provides a collection of template dialogs. With these one can easily show message boxes, etc..

---

Function Documentation

xmlNodePtr gitk__cxpath_get_node (  GitkDialogPtr const  dialog, GitkDialogAccessType  access_type, xmlXPathCompExprPtr const  xpath_comp_expression, xmlNodePtr const  root_node )

return the first node of the result of the evaluation of the supplied compiled xpath expression agains the given document Parameters: dialog  gitk dialog access_type  how to access the dialog xpath_comp_expression  compiled xpath expression to use root_node  from where to search, uses doc root when NULL Returns: xmlNode pointer to result of NULL Definition at line 229 of file gitktools.c. References gitk__cxpath_get_object(), gitk_err, gitk_log1, gitk_xpath_type_filter(), GitkDialogAccessType, and GitkDialogPtr. Referenced by gitk__xpath_get_node(), and gitk_dialog_set_content().

Here is the call graph for this function:

xmlXPathObjectPtr gitk__cxpath_get_object (  GitkDialogPtr const  dialog, GitkDialogAccessType  access_type, xmlXPathCompExprPtr const  xpath_comp_expression, xmlNodePtr const  root_node )

return the result as xmlXPathObjectPtr of the evaluation of the supplied compiled xpath expression agains the given document Parameters: dialog  gitk dialog access_type  how to access the dialog xpath_comp_expression  compiled xpath expression to use root_node  from where to search, uses doc root when NULL Returns: xpathobject; do not forget to free the result after use Definition at line 123 of file gitktools.c. References gitk__dialog_get_doc(), gitk_err, GITK_NS_PREFIX, GITK_NS_URL, GitkDialogAccessType, and GitkDialogPtr. Referenced by gitk__cxpath_get_node(), gitk__cxpath_get_string(), and gitk__xpath_get_object().

Here is the call graph for this function:

gchar* gitk__cxpath_get_string (  GitkDialogPtr const  dialog, GitkDialogAccessType  access_type, xmlXPathCompExprPtr const  xpath_comp_expression, xmlNodePtr const  root_node )

return the result as string of the evaluation of the supplied compiled xpath expression agains the given document Parameters: dialog  gitk dialog access_type  how to access the dialog xpath_comp_expression  compiled xpath expression to use root_node  from where to search, uses doc root when NULL Returns: gchar pointer to result of NULL; do not forget to free the result after use. Definition at line 183 of file gitktools.c. References gitk__cxpath_get_object(), gitk_err, GitkDialogAccessType, and GitkDialogPtr. Referenced by gitk__xpath_get_string().

Here is the call graph for this function:

xmlNodePtr gitk__xpath_get_node (  GitkDialogPtr const  dialog, GitkDialogAccessType  access_type, gchar *const  xpath_expression, xmlNodePtr const  root_node )

return the first node of the result of the evaluation of the supplied xpath expression agains the given document Parameters: dialog  gitk dialog access_type  how to access the dialog xpath_expression  xpath expression to use root_node  from where to search, uses doc root when NULL Returns: xmlNode pointer to result of NULL Definition at line 261 of file gitktools.c. References gitk__cxpath_get_node(), gitk_err1, GitkDialogAccessType, and GitkDialogPtr. Referenced by gitk__dialog_attach_callback(), gitk__dialog_get_widget(), gitk_dialog_detach_callback(), and gitk_dialog_trans_callback().

Here is the call graph for this function:

xmlXPathObjectPtr gitk__xpath_get_object (  GitkDialogPtr const  dialog, GitkDialogAccessType  access_type, gchar *const  xpath_expression, xmlNodePtr const  root_node )

return the result as xmlXPathObjectPtr of the evaluation of the supplied xpath expression agains the given document Parameters: dialog  gitk dialog access_type  how to access the dialog xpath_expression  xpath expression to use root_node  from where to search, uses doc root when NULL Returns: xpathobject; do not forget to free the result after use Definition at line 160 of file gitktools.c. References gitk__cxpath_get_object(), gitk_err1, GitkDialogAccessType, and GitkDialogPtr.

Here is the call graph for this function:

gchar* gitk__xpath_get_string (  GitkDialogPtr const  dialog, GitkDialogAccessType  access_type, gchar *const  xpath_expression, xmlNodePtr const  root_node )

return the result as string of the evaluation of the supplied xpath expression agains the given document Parameters: dialog  gitk dialog access_type  how to access the dialog xpath_expression  xpath expression to use root_node  from where to search, uses doc root when NULL Returns: gchar pointer to result of NULL; do not forget to free the result after use. Definition at line 207 of file gitktools.c. References gitk__cxpath_get_string(), gitk_err1, GitkDialogAccessType, and GitkDialogPtr.

Here is the call graph for this function:

void gitk_done (  void   )

Frees memory and data used by the library. This releases the current renderer and therefore will shutdown all running dialogs. See also: gitk_init Todo: gitkr_dialog_free_layout(dialog); needed Definition at line 23 of file gitkdone.c. References GitkCallbackNode::callback_name, gitk_dialog_free(), gitk_dialog_hide(), gitk_dialog_list, gitk_done_common_xpath_expressions(), gitk_done_xsl(), gitk_global_callback_list, gitk_initialized, gitk_log_intro, gitk_log_outro, gitk_renderer_done(), gitk_renderer_name, gitk_style_name, GitkCallbackNodePtr, GitkDialogPtr, and GitkCallbackNode::widget_id. Referenced by main(), test_gitk_dialog_new_from_string_1(), test_gitk_dialog_show_1(), test_gitk_dialog_show_2(), test_gitk_init(), test_gitk_init_cmdargs1(), test_gitk_init_cmdargs2(), test_gitk_template_message(), test_gitk_template_message_text_null(), test_gitk_template_message_title_null(), test_gitk_valid_invalid_giml(), test_gitk_valid_not_giml(), test_gitk_valid_not_xml(), and test_gitk_widget_set_get_value().

Here is the call graph for this function:

void gitk_event_loop_end (  void   )

activates the event_loop of current selected renderer See also: gitk_event_loop_start Definition at line 130 of file gitkwrapper.c. References gitk_log_intro, gitk_log_outro, gitk_renderer, and GitkRenderer::gitkr_event_loop_end. Referenced by dialog_on_clicked(), main_on_clicked(), sighandler_on_sighup(), sighandler_on_sigint(), and sighandler_window_on_destroy().

void gitk_event_loop_start (  void   )

activates the event_loop of current selected renderer See also: gitk_event_loop_end Definition at line 111 of file gitkwrapper.c. References exchange_event_loop, gitk_event_loop_exchange(), gitk_log, gitk_log_intro, gitk_log_outro, gitk_renderer, and GitkRenderer::gitkr_event_loop_start. Referenced by gitk_template_message_with_title(), main(), and main_show().

Here is the call graph for this function:

void gitk_init (  guint *const  argc, gchar ***const  argv, gchar *const  _client_package_name, gchar *const  _client_locale_dir )

Filters gitk-related options from commandline options, setup initial data for the application using the lib and loads the renderer. The routine tries very hard to open a renderer by checking for commandline-arg, env-var, defaults, etc.. Aborts the programm, when no renderer can be loaded or any other critical error happened. Parameters: argc  pointer to callers argc variable argv  pointer to callers argv variable _client_package_name  locale support _client_locale_dir  locale support Todo: check which renderers are installed and open one of them; decide which one (if more then one is available) we could use the _client_package_name to register the running client with a gitk_console_server See also: gitk_done Definition at line 49 of file gitkinit.c. References bindtextdomain, client_locale_dir, client_name, client_package_name, gitk_err, gitk_init_common_xpath_expressions(), gitk_init_process_commandline(), gitk_init_xml(), gitk_init_xsl(), gitk_initialized, gitk_log, gitk_log1, gitk_log3, gitk_log_handler(), gitk_log_intro, gitk_log_outro, gitk_print_handler(), gitk_renderer_init(), gitk_sensor_locale(), gitk_server_port, gitk_server_thread(), server_thread, and textdomain. Referenced by main(), test_gitk_dialog_new_from_string_1(), test_gitk_dialog_show_1(), test_gitk_dialog_show_2(), test_gitk_init(), test_gitk_init_cmdargs1(), test_gitk_init_cmdargs2(), test_gitk_template_message(), test_gitk_template_message_text_null(), test_gitk_template_message_title_null(), test_gitk_valid_invalid_giml(), test_gitk_valid_not_giml(), test_gitk_valid_not_xml(), and test_gitk_widget_set_get_value().

Here is the call graph for this function:

xmlXPathObjectPtr gitk_xpath_type_filter (  xmlXPathObjectPtr  xpath_optr, const xmlXPathObjectType  type )

test if the given XPathObject is of the expected type, otherwise discard the object Parameters: xpath_optr  the xpath object to test type  the required type Returns: the supplied xpath object or NULL is types do not match Definition at line 105 of file gitktools.c. References gitk_err2. Referenced by gitk__cxpath_get_node(), gitkr_dialog_generate_layout(), gitkr_dialog_generate_sequential_layout(), gitkr_dialog_generate_sequential_layout_build_page(), gitkr_dialog_generate_sequential_layout_count_pages(), gitkr_widget_optionchoice_get_choices(), and gitkr_widget_optionchoice_get_ids().

---