erbrowser/src/indexFileHandler.h File Reference

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

Go to the source code of this file.

Classes
struct	_PageTypeInfo
struct	_PageNmbrInfo
struct	_PageUrlInfo
struct	_PageInfo
struct	_pagelistItem
struct	_IndexInfo
Defines
#define	INVALID_PAGE_COUNT   (-1)
#define	INVALID_PAGE_NMBR   (-1)
#define	DEFAULT_PAGE_COUNT   1
#define	DEFAULT_PAGE   1
#define	DEFAULT_PAGE_OFFSET   100
#define	INVALID_PAGE_TYPE   "unknown"
#define	INIT_PAGE_TYPE   "init"
#define	ONE_PAGE_TYPE   "one_page"
Typedefs
typedef struct _PageTypeInfo	PageTypeInfo
typedef struct _PageNmbrInfo	PageNmbrInfo
typedef struct _PageUrlInfo	PageUrlInfo
typedef struct _PageInfo	PageInfo
typedef struct _pagelistItem	PageListItem
typedef struct _IndexInfo	IndexInfo
Functions
void	index_file_close (IndexInfo *index)
int	index_file_init (const char *file, IndexInfo *index)
int	index_file_get_page_count (IndexInfo *index, const char *type)
int	index_file_get_page_number (IndexInfo *index, const char *type, const char *url)
char *	index_file_get_page_location (IndexInfo *index, const char *type, const int number)
void	dump (IndexInfo *index)

---

Define Documentation

#define DEFAULT_PAGE   1

Definition at line 36 of file indexFileHandler.h.

#define DEFAULT_PAGE_COUNT   1

Definition at line 35 of file indexFileHandler.h.

#define DEFAULT_PAGE_OFFSET   100

Definition at line 37 of file indexFileHandler.h.

#define INIT_PAGE_TYPE   "init"

Definition at line 39 of file indexFileHandler.h.

#define INVALID_PAGE_COUNT   (-1)

Definition at line 33 of file indexFileHandler.h.

#define INVALID_PAGE_NMBR   (-1)

Definition at line 34 of file indexFileHandler.h.

#define INVALID_PAGE_TYPE   "unknown"

Definition at line 38 of file indexFileHandler.h.

#define ONE_PAGE_TYPE   "one_page"

Definition at line 40 of file indexFileHandler.h.

---

Typedef Documentation

typedef struct _IndexInfo IndexInfo

typedef struct _PageInfo PageInfo

typedef struct _pagelistItem PageListItem

typedef struct _PageNmbrInfo PageNmbrInfo

typedef struct _PageTypeInfo PageTypeInfo

typedef struct _PageUrlInfo PageUrlInfo

---

Function Documentation

void dump

(

IndexInfo *

index

)

Dump IndexInfo information, for debug

Parameters:

IndexInfo

reference to the current inde file

Returns:

void

Definition at line 830 of file indexFileHandler.cpp.

{
    if (NULL == index) return;
    
    printf("=======================Index file information=======================\n");
    printf("length %d\n", index->length);
    for(int i = 0; i <index->length; ++i)
    {
        PageListItem *pItem = index->pagelist[i];
        printf("\titem type: %s\tcount: %d\n", pItem->type, pItem->count);
        
        for(int j = 0; j < pItem->count; ++j)
        {
            PageInfo *pInf = pItem->page[j];
            printf("\t\tpage number: %d\turl: %s\n", pInf->number, pInf->url);
        }
    }
    printf("====================================================================\n");
}    

void index_file_close

(

IndexInfo *

index

)

Close the index/manifest file

Parameters:

IndexInfo

pointer

Returns:

-

Definition at line 678 of file indexFileHandler.cpp.

{
    if (NULL == index)
    {
        TRACE("Invalid IndexInfo pointer!");
        return;
    }
    
    if (NULL == index->pagelist || 0 >= index->length)
    {
        // not initialized
        return;
    }
    
    // release all memory
    for(int i = 0; i < index->length; ++i)
    {
        pageListItem_release(index->pagelist[i]);
    }
    free(index->pagelist);
}

Here is the call graph for this function:

int index_file_get_page_count	(	IndexInfo *	index,
		const char *	type
	)

Retrieve the page count from the index file, given the page type

Parameters:

	FILE	reference to the current inde file
	type	page type

Returns:

pagecount (DEFAULT_PAGE_COUNT in case of error)

Definition at line 733 of file indexFileHandler.cpp.

{
    if (NULL == index)
    {
        TRACE("Invalid index pointer!");
        return INVALID_PAGE_COUNT;
    }
    
    if (NULL == type)
    {
        TRACE("Invalid type pointer!");
        return INVALID_PAGE_COUNT;
    }
    
    for(int i = 0; i < index->length; ++i)
    {
        if (0 == strcmp(index->pagelist[i]->type, type))
        {
            return index->pagelist[i]->count;
        }
    }
    return INVALID_PAGE_COUNT;
}

char* index_file_get_page_location	(	IndexInfo *	index,
		const char *	type,
		const int	number
	)

Retrieve the page number from the index file, given the page type and the url

Parameters:

	IndexInfo	reference to the current inde file
	type	page type
	number	page number

Returns:

url (allocated memory should be freed by the calling routine)

Definition at line 798 of file indexFileHandler.cpp.

{
    if (NULL == index)
    {
        TRACE("Invalid index pointer!");
        return NULL;
    }
    
    if (NULL == type)
    {
        TRACE("Invalid type pointer!");
        return NULL;
    }

    
    for(int i = 0; i < index->length; ++i)
    {
        if (0 == strcmp(index->pagelist[i]->type, type))
        {
            PageListItem *pItem = index->pagelist[i];
            for(int j = 0; j < pItem->count; ++j)
            {
                if (number == pItem->page[j]->number)
                {
                    return pItem->page[j]->url;
                }
            }
        }
    }
    return NULL;
}

int index_file_get_page_number	(	IndexInfo *	index,
		const char *	type,
		const char *	url
	)

Retrieve the page number from the index file, given the page type and the url

Parameters:

	IndexInfo	reference to the current index struct
	type	page type
	url	page url

Returns:

pagenumber

Definition at line 760 of file indexFileHandler.cpp.

{
    if (NULL == index)
    {
        TRACE("Invalid index pointer!");
        return INVALID_PAGE_COUNT;
    }
    
    if (NULL == type)
    {
        TRACE("Invalid type pointer!");
        return INVALID_PAGE_COUNT;
    }
    
    if (NULL == url)
    {
        TRACE("Invalid url pointer!");
        return INVALID_PAGE_COUNT;
    }
   
    for(int i = 0; i < index->length; ++i)
    {
        if (0 == strcmp(index->pagelist[i]->type, type))
        {
            PageListItem *pItem = index->pagelist[i];
            for(int j = 0; j < pItem->count; ++j)
            {
                // should use contain_url. 
                if (contain_url(url, pItem->page[j]->url))
                {
                    return pItem->page[j]->number;
                }
            }
        }
    }
    return INVALID_PAGE_NMBR;
}

Here is the call graph for this function:

int index_file_init	(	const char *	file,
		IndexInfo *	index
	)

Open the index/manifest file

Parameters:

file

name

Returns:

non zero in case of error

Definition at line 700 of file indexFileHandler.cpp.

{
    pIndex->pagelist  = NULL;
    pIndex->length    = 0;
    erManifest manifest;
    if (RET_OK != ermXmlOpenFile(pathName, &manifest))
    {
        TRACE("Could not open manifest file %s", pathName);
        return -1;
    }
    
    pIndex->length    = get_pagelist_length(&manifest);
    if (0 >= pIndex->length)
    {
        TRACE("No Pagelist item!");
        return 0;
    }
    
    // construct one by one
    pIndex->pagelist = (PageListItem **)malloc(pIndex->length * sizeof(PageListItem *));
    for(int i = 0; i < pIndex->length; ++i)
    {
        pIndex->pagelist[i] = pageListItem_create(&manifest, i + 1);
    }
    ermXmlClose(&manifest);
    
#if (INDEX_DEBUG)
    dump(pIndex);
#endif
    
    return 0;
}

Here is the call graph for this function: