glib库是Linux平台下最常用的C语言函数库,它具有很好的可移植性和实用性。
glib是Gtk +库和Gnome的基础。glib可以在多个平台下使用,比如Linux、Unix、Windows等。glib为许多标准的、常用的C语言结构提供了相应的替代物。
使用glib库的程序都应该包含glib的头文件glib.h。
########################### glib基本类型定义: ##############################
整数类型:
gint8、guint8、gint16、guint16、gint32、guint32、gint64、guint64。
不是所有的平台都提供64位整型,如果一个平台有这些, glib会定义G_HAVE_GINT64。
类型gshort、glong、gint和short、long、int完全等价。
布尔类型:
gboolean:它可使代码更易读,因为普通C没有布尔类型。
Gboolean可以取两个值:TRUE和FALSE。实际上FALSE定义为0,而TRUE定义为非零值。
字符型:
gchar和char完全一样,只是为了保持一致的命名。
浮点类型:
gfloat、gdouble和float、double完全等价。
指针类型:
gpointer对应于标准C的void *,但是比void *更方便。
指针gconstpointer对应于标准C的const void *(注意,将const void *定义为const gpointer是行不通的
########################### glib的宏 ##############################
一些常用的宏列表
#include
TRUE
FALSE
NULL
MAX(a, b)
MIN(a, b)
ABS ( x )
CLAMP(x, low, high)
TRUE / FALSE / NULL就是1 / 0 / ( ( v o i d * ) 0 )。
MIN ( ) / MAX ( )返回更小或更大的参数。
ABS ( )返回绝对值。
CLAMP(x,low,high )若X在[low,high]范围内,则等于X;如果X小于low,则返回low;如果X大于high,则返
回high。
有些宏只有g l i b拥有,例如在后面要介绍的gpointer-to-gint和gpointer-to-guint。
大多数glib的数据结构都设计成存储一个gpointer。如果想存储指针来动态分配对象,可以这样做。
在某些情况下,需要使用中间类型转换。
//////////////////////////////////////////////////////////////
gint my_int;
gpointer my_pointer;
my_int = 5;
my_pointer = GINT_TO_POINTER(my_int);
printf("We are storing %d\n", GPOINTER_TO_INT(my_pointer));
//////////////////////////////////////////////////////////////
这些宏允许在一个指针中存储一个整数,但在一个整数中存储一个指针是不行的。
如果要实现的话,必须在一个长整型中存储指针。
宏列表:
在指针中存储整数的宏
#include
GINT_TO_POINTER ( p )
GPOINTER_TO_INT ( p )
GUINT_TO_POINTER ( p )
GPOINTER_TO_UINT ( p )
调试宏:
定义了G_DISABLE_CHECKS或G_DISABLE_ASSERT之后,编译时它们就会消失.
宏列表:
前提条件检查
#include
g_return_if_fail ( condition )
g_return_val_if_fail(condition, retval)
///////////////////////////////////////////////////////////////////////////////////
使用这些函数很简单,下面的例子是g l i b中哈希表的实现:
void g_hash_table_foreach (GHashTable *hash_table,GHFunc func,gpointer user_data)
{
GHashNode *node;
gint i;
g_return_if_fail (hash_table != NULL);
g_return_if_fail (func != NULL);
for (i = 0; i < hash_table->size; i++)
for (node = hash_table->nodes; node; node = node->next)
(* func) (node->key, node->value, user_data);
}
///////////////////////////////////////////////////////////////////////////////////
宏列表:
断言
#include
g_assert( condition )
g_assert_not_reached ( )
如果执行到这个语句,它会调用abort()退出程序并且(如果环境支持)转储一个可用于调试的core文件。
断言与前提条件检查的区别:
应该断言用来检查函数或库内部的一致性。
g_return_if_fail()确保传递到程序模块的公用接口的值是合法的。
如果断言失败,将返回一条信息,通常应该在包含断言的模块中查找错误;
如果g_return_if_fail()检查失败,通常要在调用这个模块的代码中查找错误。
//////////////////////////////////////////////////////////////////////
下面glib日历计算模块的代码说明了这种差别:
GDate * g_date_new_dmy (GDateDay day, GDateMonth m, GDateYear y)
{
GDate *d;
g_return_val_if_fail (g_date_valid_dmy (day, m, y), NULL);
d = g_new (GDate, 1);
d->julian = FALSE;
d->dmy = TRUE;
d->month = m;
d->day = day;
d->year = y;
g_assert (g_date_valid (d));
return d;
}
//////////////////////////////////////////////////////////////////////
开始的预条件检查确保用户传递合理的年月日值;
结尾的断言确保glib构造一个健全的对象,输出健全的值。
断言函数g_assert_not_reached() 用来标识“不可能”的情况,通常用来检测不能处理的
所有可能枚举值的switch语句:
switch (val)
{
case FOO_ONE:
break ;
case FOO_TWO:
break ;
default:
/* 无效枚举值* /
g_assert_not_reached ( ) ;
break ;
}
所有调试宏使用glib的g_log()输出警告信息,g_log()的警告信息包含发生错误的应用程序或库函数名字,并且还可以
使用一个替代的警告打印例程.
########################### 内存管理 ##############################
glib用自己的g_变体包装了标准的malloc()和free(),即g_malloc()和g_free()。
它们有以下几个小优点:
* g_malloc()总是返回gpointer,而不是char *,所以不必转换返回值。
* 如果低层的malloc()失败,g_malloc()将退出程序,所以不必检查返回值是否是NULL。
* g_malloc() 对于分配0字节返回NULL。
* g_free()忽略任何传递给它的NULL指针。
函数列表: glib内存分配
#include
gpointer g_malloc(gulong size)
void g_free(gpointer mem)
gpointer g_realloc(gpointer mem,gulong size)
gpointer g_memdup(gconstpointer mem,guint bytesize)
g_realloc()和realloc()是等价的。
g_malloc0(),它将分配的内存每一位都设置为0;
g_memdup()返回一个从mem开始的字节数为bytesize的拷贝。
为了与g_malloc()一致,g_realloc()和g_malloc0()都可以分配0字节内存。
g_memdup()在分配的原始内存中填充未设置的位,而不是设置为数值0。
宏列表:内存分配宏
#include
g_new(type, count)
g_new0(type, count)
g_renew(type, mem, count)
########################### 字符串处理 ##############################
如果需要比gchar *更好的字符串,glib提供了一个GString类型。
函数列表: 字符串操作
#include
gint g_snprintf(gchar* buf,gulong n,const gchar* format,. . . )
gint g_strcasecmp(const gchar* s1,const gchar* s2)
gint g_strncasecmp(const gchar* s1,const gchar* s2,guint n)
在含有snprintf()的平台上,g_snprintf()封装了一个本地的snprintf(),并且比原有实现更稳定、安全。
以往的snprintf()不保证它所填充的缓冲是以NULL结束的,但g_snprintf()保证了这一点。
g_snprintf函数在buf参数中生成一个最大长度为n的字符串。其中format是格式字符串,“...”是要插入的参数。
函数列表: 修改字符串
#include
void g_strdown(gchar* string)
void g_strup(gchar* string)
void g_strreverse(gchar* string)
gchar* g_strchug(gchar* string)
gchar* g_strchomp(gchar* string)
宏g_strstrip()结合以上两个函数,删除字符串前后的空格。
函数列表: 字符串转换
#include
gdouble g_strtod(const gchar* nptr,gchar** endptr)
gchar* g_strerror(gint errnum)
gchar* g_strsignal(gint signum)
函数列表: 分配字符串
#include
gchar * g_strdup(const gchar* str)
gchar* g_strndup(const gchar* format,guint n)
gchar* g_strdup_printf(const gchar* format,. . . )
gchar* g_strdup_vprintf(const gchar* format,va_list args)
gchar* g_strescape(gchar* string)
gchar* g_strnfill(guint length,gchar fill_char)
/////////////////////////////////////////////////////////////////////////
gchar* str = g_malloc(256);
g_snprintf(str, 256, "%d printf-style %s", 1, "format");
用下面的代码,不需计算缓冲区的大小:
gchar* str = g_strdup_printf("%d printf-style %", 1, "format") ;
/////////////////////////////////////////////////////////////////////////
函数列表:连接字符串的函数
#include
gchar* g_strconcat(const gchar* string1,. . . )
gchar* g_strjoin(const gchar* separator,. . . )
函数列表: 处理以NULL结尾的字符串向量
#include
gchar** g_strsplit(const gchar* string,const gchar* delimiter,gint max_tokens)
gchar* g_strjoinv(const gchar* separator,gchar** str_array)
void g_strfreev(gchar** str_array)
########################### 数据结构 ##############################
链表~~~~~~~~~~
glib提供了普通的单向链表和双向链表,分别是GSList 和GList。
创建链表、添加一个元素的代码:
GSList* list = NULL;
gchar* element = g_strdup("a string");
list = g_slist_append(list, element);
删除上面添加的元素并清空链表:
list = g_slist_remove(list, element);
为了清除整个链表,可使用g_slist_free(),它会快速删除所有的链接;
g_slist_free()只释放链表的单元,它并不知道怎样操作链表内容。
访问链表的元素,可以直接访问GSList结构:
gchar* my_data = list->data;
为了遍历整个链表,可以如下操作:
GSList* tmp = list;
while (tmp != NULL)
{
printf("List data: %p\n", tmp->data);
tmp = g_slist_next(tmp);
}
/////////////////////////////////////////////////////////////////////////////
下面的代码可以用来有效地向链表中添加数据:
void efficient_append(GSList** list, GSList** list_end, gpointer data)
{
g_return_if_fail(list != NULL);
g_return_if_fail(list_end != NULL);
if (*list == NULL)
{
g_assert(*list_end == NULL);
*list = g_slist_append(*list, data);
*list_end = *list;
}
else
{
*list_end = g_slist_append(*list_end, data)->next;
}
}
要使用这个函数,应该在其他地方存储指向链表和链表尾的指针,并将地址传递给efficient_append ():
GSList* list = NULL;
GSList* list_end = NULL;
efficient_append(&list, &list_end, g_strdup("Foo"));
efficient_append(&list, &list_end, g_strdup("Bar"));
efficient_append(&list, &list_end, g_strdup("Baz"));
//////////////////////////////////////////////////////////////////////////////
函数列表:改变链表内容
#include
/* 向链表最后追加数据,应将修改过的链表赋给链表指针* /
GSList* g_slist_append(GSList* list,gpointer data)
/* 向链表最前面添加数据,应将修改过的链表赋给链表指针* /
GSList* g_slist_prepend(GSList* list,gpointer data)
/* 在链表的position位置向链表插入数据,应将修改过的链表赋给链表指针* /
GSList* g_slist_insert(GSList* list,gpointer data,gint position)
/ *删除链表中的data元素,应将修改过的链表赋给链表指针* /
GSList* g_slist_remove(GSList* list,gpointer data)
访问链表元素可以使用下面的函数列表中的函数。
这些函数都不改变链表的结构。
g_slist_foreach()对链表的每一项调用Gfunc函数。
Gfunc函数是像下面这样定义的:
typedef void (*GFunc)(gpointer data, gpointer user_data);
在g_slist_foreach()中,Gfunc函数会对链表的每个list->data调用一次,将user_data传递到g_slist_foreach()函
数中。
////////////////////////////////////////////////////////////////////////////////
例如, 有一个字符串链表,并且想创建一个类似的链表,让每个字符串做一些变换。
下面是相应的代码,使用了前面例子中的efficient_append()函数。
typedef struct _AppendContext AppendContext;
struct _AppendContext {
GSList* list;
GSList* list_end;
const gchar* append;
} ;
static void append_foreach(gpointer data, gpointer user_data)
{
AppendContext* ac = (AppendContext*) user_data;
gchar* oldstring = (gchar*) data;
efficient_append(&ac->list, &ac->list_end, g_strconcat(oldstring, ac->append, NULL));
}
GSList * copy_with_append(GSList* list_of_strings, const gchar* append)
{
AppendContext ac;
ac.list = NULL;
ac.list_end = NULL;
ac.append = append;
g_slist_foreach(list_of_strings, append_foreach, &ac);
return ac.list;
}
函数列表:访问链表中的数据
#include
GSList* g_slist_find(GSList* list,gpointer data)
GSList* g_slist_nth(GSList* list,guint n)
gpointer g_slist_nth_data(GSList* list,guint n)
GSList* g_slist_last(GSList* list)
gint g_slist_index(GSList* list,gpointer data)
void g_slist_foreach(GSList* list,GFunc func,gpointer user_data)
函数列表: 操纵链表
#include
/* 返回链表的长度* /
guint g_slist_length(GSList* list)
/* 将list1和list2两个链表连接成一个新链表* /
GSList* g_slist_concat(GSList* list1,GSList* list2)
/ *将链表的元素颠倒次序* /
GSList* g_slist_reverse(GSList* list)
/ *返回链表list的一个拷贝* /
GSList* g_slist_copy(GSList* list)
还有一些用于对链表排序的函数,见下面的函数列表。要使用这些函数,必须写一个比较函数GcompareFunc,就像标准
C里面的qsort()函数一样。
在glib里面,比较函数是这个样子:
typedef gint (*GCompareFunc) (gconstpointer a, gconstpointer b);
如果a < b,函数应该返回一个负值;如果a > b,返回一个正值;如果a = b,返回0。
函数列表: 对链表排序
#include
GSList* g_slist_insert_sorted(GSList* list,gpointer data,GCompareFunc func)
GSList* g_slist_sort(GSList* list,GCompareFunc func)
GSList* g_slist_find_custom(GSList* list,gpointer data,GCompareFunc func)
树~~~~~~~~~~~~~~
在glib中有两种不同的树:GTree是基本的平衡二叉树,它将存储按键值排序成对键值; GNode存储任意的树结构数据
,比如分析树或分类树。
函数列表:创建和销毁平衡二叉树
#include
GTree* g_tree_new(GCompareFunc key_compare_func)
void g_tree_destroy(GTree* tree)
函数列表: 操纵G t r e e数据
#include
void g_tree_insert(GTree* tree,gpointer key,gpointer value)
void g_tree_remove(GTree* tree,gpointer key)
gpointer g_tree_lookup(GTree* tree,gpointer key)
函数列表: 获得G Tr e e的大小
#include
/ *获得树的节点数* /
gint g_tree_nnodes(GTree* tree)
/ *获得树的高度* /
gint g_tree_height(GTree* tree)
使用g_tree_traverse()函数可以遍历整棵树。
要使用它,需要一个GtraverseFunc遍历函数,它用来给g_tree_trave rse()函数传递每一对键值对和数据参数。
只要GTraverseFunc返回FALSE,遍历继续;返回TRUE时,遍历停止。
可以用GTraverseFunc函数按值搜索整棵树。
以下是GTraverseFunc的定义:
typedef gint (*GTraverseFunc)(gpointer key, gpointer value, gpointer data);
G Tr a v e r s e Ty p e是枚举型,它有四种可能的值。下面是它们在G t r e e中各自的意思:
* G_IN_ORDER (中序遍历)首先递归左子树节点(通过GCompareFunc比较后,较小的键),然后对当前节点的键值对调用
遍历函数,最后递归右子树。这种遍历方法是根据使用GCompareFunc函数从最小到最大遍历。
* G_PRE_ORDER (先序遍历)对当前节点的键值对调用遍历函数,然后递归左子树,最后递归右子树。
* G_POST_ORDER (后序遍历)先递归左子树,然后递归右子树,最后对当前节点的键值对调用遍历函数。
* G_LEVEL_ORDER (水平遍历)在GTree中不允许使用,只能用在Gnode中。
函数列表: 遍历GTree
#include
void g_tree_traverse( GTree* tree,
GTraverseFunc traverse_func,
GTraverseType traverse_type,
gpointer data )
一个GNode是一棵N维的树,由双链表(父和子链表)实现。
这样,大多数链表操作函数在Gnode API中都有对等的函数。可以用多种方式遍历。
以下是一个GNode的声明:
typedef struct _GNode GNode;
struct _GNode
{
gpointer data;
GNode *next;
GNode *prev;
GNode *parent;
GNode *children;
} ;
宏列表:访问GNode成员
#include
/ *返回GNode的前一个节点* /
g_node_prev_sibling ( node )
/ *返回GNode的下一个节点* /
g_node_next_sibling ( node )
/ *返回GNode的第一个子节点* /
g_node_first_child( node )
用g_node_new ()函数创建一个新节点。
g_node_new ()创建一个包含数据,并且无子节点、无父节点的Gnode节点。
通常仅用g_node_new ()创建根节点,还有一些宏可以根据需要自动创建新节点。
函数列表: 创建一个GNode
#include
GNode* g_node_new(gpointer data)
函数列表: 创建一棵GNode树
#include
/ *在父节点p a r e n t的p o s i t i o n处插入节点n o d e * /
GNode* g_node_insert(GNode* parent,gint position,GNode* node)
/ *在父节点p a r e n t中的s i b l i n g节点之前插入节点n o d e * /
GNode* g_node_insert_before(GNode* parent,GNode* sibling,GNode* node)
/ *在父节点p a r e n t最前面插入节点n o d e * /
GNode* g_node_prepend(GNode* parent,GNode* node)
宏列表:向Gnode添加、插入数据
#include
g_node_append(parent, node)
g_node_insert_data(parent, position, data)
g_node_insert_data_before(parent, sibling, data)
g_node_prepend_data(parent, data)
g_node_append_data(parent, data)
函数列表: 销毁GNode
#include
void g_node_destroy(GNode* root)
void g_node_unlink(GNode* node)
宏列表:判断G n o d e的类型
#include
G_NODE_IS_ROOT ( node )
G_NODE_IS_LEAF ( node )
下面函数列表中的函数返回Gnode的一些有用信息,包括它的节点数、根节点、深度以及含有特定数据指针的节点。
其中的遍历类型GtraverseType在Gtree中介绍过。
下面是在Gnode中它的可能取值:
* G_IN_ORDER 先递归节点最左边的子树,并访问节点本身,然后递归节点子树的其他部分。
这不是很有用,因为多数情况用于Gtree中。
* G_PRE_ORDER 访问当前节点,然后递归每一个子树。
* G_POST_ORDER 按序递归每个子树,然后访问当前节点。
* G_LEVEL_ORDER 首先访问节点本身,然后每个子树,然后子树的子树,然后子树的子树的子树,以次类推。
也就是说,它先访问深度为0的节点,然后是深度为1,然后是深度为2,等等。
GNode的树遍历函数有一个GTraverseFlags参数。这是一个位域,用来改变遍历的种类。
当前仅有三个标志—只访问叶节点,非叶节点,或者所有节点:
* G_TRAVERSE_LEAFS 指仅遍历叶节点。
* G_TRAVERSE_NON_LEAFS 指仅遍历非叶节点。
* G_TRAVERSE_ALL 只是指( G_TRAVERSE_LEAFS | G_TRAVERSE_NON_LEAFS )快捷方式。
函数列表: 取得G N o d e属性
#include
guint g_node_n_nodes(GNode* root,GTraverseFlags flags)
GNode* g_node_get_root(GNode* node)
Gboolean g_node_is_ancestor(GNode* node,GNode* descendant)
Guint g_node_depth(GNode* node)
GNode* g_node_find(GNode* root,GTraverseType order,GTraverseFlags flags,gpointer data)
GNode有两个独有的函数类型定义:
typedef gboolean (*GNodeTraverseFunc) (GNode* node, gpointer data);
typedef void (*GNodeForeachFunc) (GNode* node, gpointer data);
这些函数调用以要访问的节点指针以及用户数据作为参数。GNodeTraverseFunc返回TRUE,停止任何正在进行的遍历,
这样就能将GnodeTraverseFunc与g_node_traverse()结合起来按值搜索树。
函数列表: 访问GNode
#include
/ *对Gnode进行遍历* /
void g_node_traverse( GNode* root,
GTraverseType order,
GTraverseFlags flags,
gint max_depth,
GNodeTraverseFunc func,
gpointer data )
/ *返回GNode的最大高度* /
guint g_node_max_height(GNode* root)
/ *对Gnode的每个子节点调用一次f u n c函数* /
void g_node_children_foreach( GNode* node,
GTraverseFlags flags,
GNodeForeachFunc func,
gpointer data )
/ *颠倒node的子节点顺序* /
void g_node_reverse_children(GNode* node)
/ *返回节点node的子节点个数* /
guint g_node_n_children(GNode* node)
/ *返回node的第n个子节点* /
GNode* g_node_nth_child(GNode* node,guint n)
/ *返回node的最后一个子节点* /
GNode* g_node_last_child(GNode* node)
/ *在node中查找值为d a t e的节点* /
GNode* g_node_find_child(GNode* node,GTraverseFlags flags,gpointer data)
/ *返回子节点child在node中的位置* /
gint g_node_child_position(GNode* node,GNode* child)
/ *返回数据data在node中的索引号* /
gint g_node_child_index(GNode* node,gpointer data)
/ *以子节点形式返回node的第一个兄弟节点* /
GNode* g_node_first_sibling(GNode* node)
/ *以子节点形式返回node的第一个兄弟节点* /
GNode* g_node_last_sibling(GNode* node)
哈希表~~~~~~~~~~`
GHashTable是一个简单的哈希表实现,提供一个带有连续时间查寻的关联数组。
要使用哈希表,必须提供一个GhashFunc函数,当向它传递一个哈希值时,会返回正整数:
typedef guint (*GHashFunc) (gconstpointer key);
除了GhashFunc,还需要一个GcompareFunc比较函数用来测试关键字是否相等。
不过,虽然GCompareFunc函数原型是一样的,但它在GHashTable中的用法和在GSList、Gtree中的用法不一样。
在GHashTable中可以将GcompareFunc看作是等式操作符,如果参数是相等的,则返回TRUE。
函数列表: GHashTable
#include
GHashTable* 上的glib文档也是极好的资源。
如果你需要一些通用的函数,但glib中还没有,考虑写一个glib风格的例程,将它贡献到glib库中!
你自己,以及全世界的glib使用者,都将因为你的出色工作而受益。