liberscribble/include/scbpages.h File Reference

#include "scbpage.h"
#include <glib.h>

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_ScbPages
Typedefs
typedef struct _ScbPages	ScbPages
typedef ScbPages *	ScbPagesPtr
Functions
gboolean	scb_pages_new (ScbPagesPtr ptr)
void	scb_pages_free (ScbPagesPtr ptr)
gboolean	scb_pages_add_page (ScbPagesPtr pages, ScbPagePtr page)
ScbPagePtr	scb_pages_detach_page (ScbPagesPtr pages, ScbPageIdPtr id)
void	scb_pages_remove_page (ScbPagesPtr pages, ScbPageIdPtr id)
int	scb_pages_get_count (ScbPagesPtr ptr)
ScbPagePtr	scb_pages_get_page (ScbPagesPtr pages, ScbPageIdPtr id)
gboolean	scb_pages_change_page_id (ScbPagesPtr pages, ScbPageIdPtr oldId, ScbPageIdPtr newId)
gboolean	scb_pages_save (ScbPagesPtr pages, ScbXmlPtr xml)
gboolean	scb_pages_load (ScbPagesPtr pages, ScbXmlPtr xml)
void	scb_pages_dump (ScbPagesPtr pages)

---

Typedef Documentation

typedef struct _ScbPages ScbPages

Copyright (C) 2005-2008 iRex Technologies B.V. All rights reserved.

typedef ScbPages* ScbPagesPtr

Definition at line 38 of file scbpages.h.

---

Function Documentation

gboolean scb_pages_add_page	(	ScbPagesPtr	pages,
		ScbPagePtr	page
	)

Definition at line 73 of file scbpages.c.

{
    SCB_RET_FALSE_IF(NULL == pages || NULL == page, "Invalid pages or page pointer!");
    
    ScbPagePtr pItem  = NULL;
    GList* ptr = g_list_first(pages->pages);
    while(ptr)
    {
        pItem = ptr->data;
        if (pItem && 0 == strncmp(pItem->id.id, page->id.id, SCB_MAX_PAGEID_LEN))
        {
            // already exist, quit, it's ok,
            // SCB_WARN("Duplicated page id %s!", page->id.id);
            return TRUE;
        }
        ptr = g_list_next(ptr);   
    }
    g_list_append(pages->pages, page);
    return TRUE;
}

gboolean scb_pages_change_page_id	(	ScbPagesPtr	pages,
		ScbPageIdPtr	oldId,
		ScbPageIdPtr	newId
	)

Definition at line 171 of file scbpages.c.

{
    ScbPagePtr pItem  = NULL;
    GList* ptr = g_list_first(pages->pages);
    while(ptr)
    {
        pItem = ptr->data;
        if (pItem && 0 == strncmp(pItem->id.id, oldId->id, SCB_MAX_PAGEID_LEN))
        {
            // ok, hit. 
            strncpy(pItem->id.id, newId->id, SCB_MAX_PAGEID_LEN);
            return TRUE;
        }
        ptr = g_list_next(ptr);   
    }
    return FALSE;
}

ScbPagePtr scb_pages_detach_page	(	ScbPagesPtr	pages,
		ScbPageIdPtr	id
	)

Definition at line 96 of file scbpages.c.

{
    ScbPagePtr pItem  = NULL;
    GList* ptr = g_list_first(pages->pages);
    while(ptr)
    {
        pItem = ptr->data;
        if (pItem && 0 == strncmp(pItem->id.id, id->id, SCB_MAX_PAGEID_LEN))
        {
            // ok, hit. notice.......
            g_list_remove(pages->pages, pItem);
            return pItem;
        }
        ptr = g_list_next(ptr);   
    }
    return NULL;
}

void scb_pages_dump

(

ScbPagesPtr

pages

)

Definition at line 260 of file scbpages.c.

{
    SCB_RET_IF(NULL == pages, "NULL pointer!");
    g_list_foreach(pages->pages, _page_dump, 0);
}

Here is the call graph for this function:

void scb_pages_free

(

ScbPagesPtr

ptr

)

Definition at line 57 of file scbpages.c.

{
    if (ptr)
    {
        // release all stroke
        g_list_foreach(ptr->pages, _page_release, NULL);

        // now the pointers are wild pointers
        g_list_free(ptr->pages);
        ptr->pages = NULL;
    }
}

Here is the call graph for this function:

int scb_pages_get_count

(

ScbPagesPtr

ptr

)

Definition at line 139 of file scbpages.c.

{
    SCB_RET_INT_IF(NULL == pages, SCB_INVALID_COUNT, "Invalid pages pointer!");
    int len = g_list_length(pages->pages);
    if (len > 0)
    {
        return len - 1;
    }
    return SCB_INVALID_COUNT;
}

ScbPagePtr scb_pages_get_page	(	ScbPagesPtr	pages,
		ScbPageIdPtr	id
	)

Definition at line 152 of file scbpages.c.

{
    ScbPagePtr pItem  = NULL;
    GList* ptr = g_list_first(pages->pages);
    while(ptr)
    {
        pItem = ptr->data;
        if (pItem && 0 == strncmp(pItem->id.id, id->id, SCB_MAX_PAGEID_LEN))
        {
            // ok, hit. notice.......
           return pItem;
        }
        ptr = g_list_next(ptr);   
    }
    return NULL;
}

gboolean scb_pages_load	(	ScbPagesPtr	pages,
		ScbXmlPtr	xml
	)

Definition at line 219 of file scbpages.c.

{
    // check
    SCB_RET_FALSE_IF(NULL == pages || NULL == xml, "Invalid pointer!");

    // construct xPath
    ScbXmlPtr self = scb_xml_clone(xml);
    strncat(self->xPath, "/pages", SCB_MAX_XML_PATH);
    self->index = 1;

    // load pages
    gboolean bLoad = TRUE;
    while (bLoad)
    {
        ScbPagePtr page = scb_page_new();
        bLoad = scb_page_load(page, self);
        if (bLoad)
        {
            scb_pages_add_page(pages, page);
            ++self->index;
        }
        else
        {
            scb_page_free(page);
            break;
        }
    }
    scb_xml_free(self);
    return TRUE;
}

Here is the call graph for this function:

gboolean scb_pages_new

(

ScbPagesPtr

ptr

)

Definition at line 42 of file scbpages.c.

{
    SCB_RET_FALSE_IF(NULL == ptr, "Invalid pointer!");

    ptr->pages = g_list_alloc();
    if (NULL == ptr->pages)
    {
        SCB_ERROR("Could not allocate list!");
        return FALSE;
    }
    return TRUE;
}

void scb_pages_remove_page	(	ScbPagesPtr	pages,
		ScbPageIdPtr	id
	)

Definition at line 116 of file scbpages.c.

{
    SCB_RET_IF(NULL == pages || NULL == id, "Invalid pointer!");
    
    ScbPagePtr pItem  = NULL;
    GList* ptr = g_list_first(pages->pages);
    while(ptr)
    {
        pItem = ptr->data;
        if (pItem && 0 == strncmp(pItem->id.id, id->id, SCB_MAX_PAGEID_LEN))
        {
            // ok, hit. notice.......
            scb_page_free(pItem);
            g_list_remove(pages->pages, ptr->data);
            return;
        }
        ptr = g_list_next(ptr);   
    }
}

Here is the call graph for this function:

gboolean scb_pages_save	(	ScbPagesPtr	pages,
		ScbXmlPtr	xml
	)

Definition at line 204 of file scbpages.c.

{
    SCB_RET_FALSE_IF(NULL == pages || NULL == xml, "Invalid pointer!");
    // xPath
    ScbXmlPtr self = scb_xml_clone(xml);
    self->index = 1;
    ermXmlNewString(&xml->handle, self->xPath, "pages", "");
    strncat(self->xPath, "/pages", SCB_MAX_XML_PATH);
    g_list_foreach(pages->pages, _page_save, self);
    scb_xml_free(self);
    return TRUE;
}

Here is the call graph for this function: