scbpage.h File Reference

#include "scbconfig.h"
#include "scbstream.h"
#include "scbstrokes.h"

Include dependency graph for scbpage.h:

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

Go to the source code of this file.

Data Structures
struct	_ScbPageId
struct	_ScbPageStyle
struct	_ScbPageOptHist
struct	_ScbPageEraseCtx
struct	_ScbPageAttributes
struct	_ScbPage
Typedefs
typedef struct _ScbPageId	ScbPageId
typedef ScbPageId *	ScbPageIdPtr
typedef struct _ScbPageStyle	ScbPageStyle
typedef struct _ScbPageOptHist	ScbPageOptHist
typedef struct _ScbPageEraseCtx	ScbPageEraseCtx
typedef ScbPageEraseCtx *	ScbPageEraseCtxPtr
typedef struct _ScbPageAttributes	ScbPageAttributes
typedef struct _ScbPage	ScbPage
typedef ScbPage *	ScbPagePtr
Functions
ScbPagePtr	erscribble_page_new ()
void	erscribble_page_set_size (ScbPagePtr ptr, const int width, const int height)
void	erscribble_page_free (ScbPagePtr ptr)
void	erscribble_page_clear_strokes (ScbPagePtr ptr)
void	erscribble_page_copy_id (ScbPageIdPtr dst, const ScbPageIdPtr src)
void	erscribble_page_set_id (ScbPageIdPtr ptr, const int position, const char *anchor, const int anno_id)
void	erscribble_page_reset_id (ScbPageIdPtr ptr)
int	erscribble_page_get_stroke_count (ScbPagePtr ptr)
gboolean	erscribble_page_add_stroke (ScbPagePtr page, ScbStrokePtr stroke)
ScbStrokesPtr	erscribble_page_get_strokes (ScbPagePtr page)
void	erscribble_page_erase_init (ScbPageEraseCtxPtr ptr)
ScbStrokesPtr	erscribble_page_erase_hit_test (ScbPagePtr page, ScbDevPointPtr point, ScbPageEraseCtxPtr ptr)
gboolean	erscribble_page_load (ScbPagePtr page, ScbStreamPtr stream)
gboolean	erscribble_page_write_stream (ScbPagePtr page, ScbStreamPtr stream)
int	erscribble_page_get_length (ScbPagePtr ptr)
void	erscribble_page_set_minor_version_number (ScbPagePtr page, const unsigned short minor)
void	erscribble_page_dump (ScbPagePtr ptr)

---

Typedef Documentation

typedef struct _ScbPage ScbPage

typedef struct _ScbPageAttributes ScbPageAttributes

typedef struct _ScbPageEraseCtx ScbPageEraseCtx

typedef ScbPageEraseCtx* ScbPageEraseCtxPtr

Definition at line 106 of file scbpage.h.

typedef struct _ScbPageId ScbPageId

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

typedef ScbPageId* ScbPageIdPtr

Definition at line 76 of file scbpage.h.

typedef struct _ScbPageOptHist ScbPageOptHist

typedef ScbPage* ScbPagePtr

Definition at line 128 of file scbpage.h.

typedef struct _ScbPageStyle ScbPageStyle

---

Function Documentation

gboolean erscribble_page_add_stroke	(	ScbPagePtr	page,
		ScbStrokePtr	stroke
	)

Definition at line 181 of file scbpage.c.

References ERSCRIBBLE_RET_FALSE_IF, _ScbStrokes::strokes, and _ScbPage::strokes.

Referenced by notepad::CNotepadDoc::on_scribble_begin().

{
    ERSCRIBBLE_RET_FALSE_IF(NULL == page || NULL == stroke, "Invalid pointer!");        
    page->strokes.strokes = g_list_append(page->strokes.strokes, stroke);

    return TRUE;
}

Here is the caller graph for this function:

void erscribble_page_clear_strokes

(

ScbPagePtr

ptr

)

Definition at line 154 of file scbpage.c.

References _ScbPage::del_strokes, ERSCRIBBLE_RET_IF, erscribble_strokes_free(), and _ScbPage::strokes.

Referenced by test::ScribbleMgr::clear_page(), notepad::CNotepadDoc::clear_page(), erscribble_doc_delete_page_impl(), erscribble_page_free(), load_page_data(), and remove_oldest_page_data().

{
    ERSCRIBBLE_RET_IF(NULL == ptr, "Attempt to operate on NULL pointer!");

    erscribble_strokes_free(&ptr->strokes);
    erscribble_strokes_free(&ptr->del_strokes);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void erscribble_page_copy_id	(	ScbPageIdPtr	dst,
		const ScbPageIdPtr	src
	)

Definition at line 85 of file scbpage.c.

References _ScbPageId::annotation_id, ERSCRIBBLE_MAX_PAGEID_LEN, _ScbPageId::id, and _ScbPageId::position.

Referenced by notepad::CNotepadDoc::add_page(), test::ScribbleMgr::copy_page_id(), erscribble_doc_get_page(), notepad::CNotepadDoc::insert_page(), and notepad::CNotepadDoc::on_scribble_begin().

{
    if (dst && src)
    {
        strncpy(dst->id, src->id, ERSCRIBBLE_MAX_PAGEID_LEN);
        dst->position = src->position;
        dst->annotation_id = src->annotation_id;
    }
}

Here is the caller graph for this function:

void erscribble_page_dump

(

ScbPagePtr

ptr

)

Definition at line 297 of file scbpage.c.

References _ScbPageAttributes::area, _ScbPage::attributes, _ScbRect::bottom, DUMPPRINTF, ERSCRIBBLE_RET_IF, erscribble_strokes_dump(), _ScbPageId::id, _ScbPage::id, _ScbRect::left, _ScbPageStyle::orientation, _ScbRect::right, _ScbPage::strokes, _ScbPageAttributes::style, and _ScbRect::top.

Referenced by _page_dump().

{
    ERSCRIBBLE_RET_IF(NULL == ptr, "Attempt to dump on NULL page pointer!");

    DUMPPRINTF("================= Page %s Information =================", ptr->id.id);
    DUMPPRINTF("orientation %d", ptr->attributes.style.orientation);
    DUMPPRINTF("rect (%d, %d) - (%d, %d)", ptr->attributes.area.left, ptr->attributes.area.top, 
        ptr->attributes.area.right, ptr->attributes.area.bottom);
    erscribble_strokes_dump(&ptr->strokes);
    DUMPPRINTF("==================== Page %s Done =====================", ptr->id.id);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ScbStrokesPtr erscribble_page_erase_hit_test	(	ScbPagePtr	page,
		ScbDevPointPtr	point,
		ScbPageEraseCtxPtr	ptr
	)

Definition at line 204 of file scbpage.c.

References _ScbPageEraseCtx::bInit, ctx, ERSCRIBBLE_DEF_ERASE_SIZE, erscribble_strokes_line_hit_test(), erscribble_strokes_point_hit_test(), _ScbPageEraseCtx::p1, _ScbPageEraseCtx::p2, _ScbHitTestCtx::size, _ScbPage::strokes, _ScbPageEraseCtx::zoom, and _ScbHitTestCtx::zoom.

Referenced by test::ScribbleMgr::on_erase_begin(), notepad::CNotepadDoc::on_erase_begin(), test::ScribbleMgr::on_erase_end(), notepad::CNotepadDoc::on_erase_end(), test::ScribbleMgr::on_erase_move(), and notepad::CNotepadDoc::on_erase_move().

{
    ScbStrokesPtr strokes = NULL;
    ScbHitTestCtx ctx; 
    ctx.size = ERSCRIBBLE_DEF_ERASE_SIZE;
    ctx.zoom = eraCtx->zoom;
    if (!eraCtx->bInit)
    {
        eraCtx->p1 = *point;
        eraCtx->bInit = TRUE;
        strokes = erscribble_strokes_point_hit_test(&page->strokes, point, &ctx);
    }
    else
    {
        eraCtx->p2 = eraCtx->p1;
        eraCtx->p1 = *point;
        strokes = erscribble_strokes_line_hit_test(&page->strokes, 
            &eraCtx->p2, 
            &eraCtx->p1,
            &ctx);
    }

    return strokes;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void erscribble_page_erase_init

(

ScbPageEraseCtxPtr

ptr

)

Definition at line 197 of file scbpage.c.

References _ScbPageEraseCtx::bInit, and _ScbPageEraseCtx::zoom.

Referenced by test::ScribbleMgr::on_erase_begin(), notepad::CNotepadDoc::on_erase_begin(), and test::ScribbleMgr::on_erase_move().

{
    ptr->zoom = 1.0;
    ptr->bInit = FALSE;
}

Here is the caller graph for this function:

void erscribble_page_free

(

ScbPagePtr

ptr

)

Definition at line 145 of file scbpage.c.

References erscribble_page_clear_strokes(), and ERSCRIBBLE_RET_IF.

Referenced by _page_release(), erscribble_pages_remove_page(), and load_pages_basic_data().

{
    ERSCRIBBLE_RET_IF(NULL == ptr, "Attempt to release NULL pointer!");

    erscribble_page_clear_strokes(ptr);
    g_free(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

int erscribble_page_get_length

(

ScbPagePtr

ptr

)

Definition at line 230 of file scbpage.c.

References _ScbStroke::attributes, _ScbPage::attributes, erscribble_page_get_stroke_count(), erscribble_stroke_get_point_count(), _ScbStrokes::strokes, _ScbPage::strokes, and _ScbPageAttributes::strokes_number.

Referenced by erscribble_doc_save_page().

{
    // set the strokes number before exporting
    ptr->attributes.strokes_number = erscribble_page_get_stroke_count(ptr);

    int length = sizeof(ptr->attributes);

    ScbStrokePtr stroke  = NULL;
    GList* item = g_list_first(ptr->strokes.strokes);
    while(item)
    {
        stroke = (ScbStrokePtr)item->data;
        
        // set points number before exporting
        stroke->attributes.points_number = erscribble_stroke_get_point_count(stroke);
        
        // add by stroke attributes
        length += sizeof(stroke->attributes);

        // add by stroke points
        length += stroke->attributes.points_number * sizeof(ScbDevPoint);

        item = g_list_next(item);   
    }

    return length;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int erscribble_page_get_stroke_count

(

ScbPagePtr

ptr

)

Definition at line 174 of file scbpage.c.

References ERSCRIBBLE_INVALID_COUNT, ERSCRIBBLE_RET_INT_IF, erscribble_strokes_get_count(), and _ScbPage::strokes.

Referenced by erscribble_page_get_length(), load_page_data(), and save_page_data().

{
    ERSCRIBBLE_RET_INT_IF(NULL == ptr, ERSCRIBBLE_INVALID_COUNT, "Invalid page pointer!");
    return erscribble_strokes_get_count(&ptr->strokes);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ScbStrokesPtr erscribble_page_get_strokes

(

ScbPagePtr

page

)

Definition at line 190 of file scbpage.c.

References ERSCRIBBLE_RET_NULL_IF, and _ScbPage::strokes.

Referenced by notepad::CNotepadDoc::draw_scribble_page().

{
    ERSCRIBBLE_RET_NULL_IF(NULL == page, "Attempt to access NULL pointer!");
    return &page->strokes;
}

Here is the caller graph for this function:

gboolean erscribble_page_load	(	ScbPagePtr	page,
		ScbStreamPtr	stream
	)

Definition at line 265 of file scbpage.c.

References _ScbPage::attributes, erscribble_read_stream(), ERSCRIBBLE_RET_FALSE_IF, erscribble_strokes_load(), _ScbPage::strokes, and _ScbPageAttributes::strokes_number.

Referenced by erscribble_doc_get_page(), and load_page_data().

{
    // read the page attributes at the first
    ERSCRIBBLE_RET_FALSE_IF(page == NULL || stream == NULL, "Invalid page structure or stream");

    gboolean ret = erscribble_read_stream(stream, &page->attributes, sizeof(page->attributes));

    if (ret == FALSE)
    {
        return ret;
    }

    return erscribble_strokes_load(&page->strokes, stream, page->attributes.strokes_number);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ScbPagePtr erscribble_page_new

(

)

Definition at line 107 of file scbpage.c.

References _ScbPageId::annotation_id, _ScbPageAttributes::area, _ScbPage::attributes, _ScbRect::bottom, ERRORPRINTF, ERSCRIBBLE_DEF_PAGE_BOTTOM, ERSCRIBBLE_DEF_PAGE_LEFT, ERSCRIBBLE_DEF_PAGE_RIGHT, ERSCRIBBLE_DEF_PAGE_TOP, erscribble_strokes_new(), _ScbPage::id, _ScbPage::is_blob_loaded, _ScbRect::left, _ScbPageId::position, _ScbRect::right, _ScbPage::strokes, and _ScbRect::top.

Referenced by notepad::CNotepadDoc::add_page(), erscribble_doc_get_page(), notepad::CNotepadDoc::insert_page(), load_pages_basic_data(), and notepad::CNotepadDoc::on_scribble_begin().

{
    ScbPagePtr ptr = g_new0(ScbPage, 1);
    if (NULL == ptr)
    {
        // not enough memory, fatal error
        ERRORPRINTF("Not enough memory for page!");
        return NULL;
    }

    // init values
    if (!erscribble_strokes_new(&ptr->strokes))
    {
        g_free(ptr);
        return NULL;
    }

    ptr->attributes.area.left      = ERSCRIBBLE_DEF_PAGE_LEFT;
    ptr->attributes.area.right     = ERSCRIBBLE_DEF_PAGE_RIGHT;
    ptr->attributes.area.top       = ERSCRIBBLE_DEF_PAGE_TOP;
    ptr->attributes.area.bottom    = ERSCRIBBLE_DEF_PAGE_BOTTOM;

    // initialize the position and annotation id to be -1
    ptr->id.position      = -1;
    ptr->id.annotation_id = -1;

    // set the flag is_blob_loaded to be false
    ptr->is_blob_loaded = FALSE;

    return ptr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void erscribble_page_reset_id

(

ScbPageIdPtr

ptr

)

Definition at line 96 of file scbpage.c.

References _ScbPageId::annotation_id, ERSCRIBBLE_MAX_PAGEID_LEN, _ScbPageId::id, and _ScbPageId::position.

Referenced by test::ScribbleMgr::clear_page_id().

{
    if (ptr)
    {
        memset(ptr->id, 0, ERSCRIBBLE_MAX_PAGEID_LEN);
        ptr->position = -1;
        ptr->annotation_id = -1;
    }
}

Here is the caller graph for this function:

void erscribble_page_set_id	(	ScbPageIdPtr	ptr,
		const int	position,
		const char *	anchor,
		const int	anno_id
	)

Definition at line 72 of file scbpage.c.

References _ScbPageId::annotation_id, ERSCRIBBLE_MAX_PAGEID_LEN, _ScbPageId::id, and _ScbPageId::position.

Referenced by test::ScribbleMgr::generate_page_id(), and load_pages_basic_data().

{
    if (ptr)
    {
        strncpy(ptr->id, anchor, ERSCRIBBLE_MAX_PAGEID_LEN);
        ptr->position = position;
        // the annotation id should be set to invalid
        // and then it would be set by query database
        ptr->annotation_id = anno_id;
    }
}

Here is the caller graph for this function:

void erscribble_page_set_minor_version_number	(	ScbPagePtr	page,
		const unsigned short	minor
	)

Definition at line 259 of file scbpage.c.

References _ScbPage::attributes, and _ScbPageAttributes::minor_version.

Referenced by erscribble_doc_save_page().

{
    page->attributes.minor_version = minor;
}

Here is the caller graph for this function:

void erscribble_page_set_size	(	ScbPagePtr	ptr,
		const int	width,
		const int	height
	)

Definition at line 139 of file scbpage.c.

References _ScbPageAttributes::area, _ScbPage::attributes, _ScbRect::bottom, _ScbRect::left, _ScbRect::right, and _ScbRect::top.

{
    ptr->attributes.area.right = ptr->attributes.area.left + width;
    ptr->attributes.area.bottom = ptr->attributes.area.top + height;
}

gboolean erscribble_page_write_stream	(	ScbPagePtr	page,
		ScbStreamPtr	stream
	)

Definition at line 281 of file scbpage.c.

References _ScbPage::attributes, erscribble_strokes_write_stream(), erscribble_write_stream(), and _ScbPage::strokes.

Referenced by erscribble_doc_save_page().

{
    // write the page attributes into stream
    if (erscribble_write_stream(stream, &page->attributes, sizeof(page->attributes)))
    {
        // write the stokes data into stream
        if (erscribble_strokes_write_stream(&page->strokes, stream))
        {
            return TRUE;
        }
    }

    return FALSE;
}

Here is the call graph for this function:

Here is the caller graph for this function: