images::ImagesDocument Class Reference

Handle images file format. More...

#include <images_document.h>

Collaboration diagram for images::ImagesDocument:

[legend]

Public Member Functions
	ImagesDocument (void)
	~ImagesDocument (void)
bool	open_document (const std::string &path, bool to_scan_dir=true)
	Open .images index file.
bool	is_open ()
	Check if the document has been opened.
unsigned int	page_count ()
	How many "page" does it contain.
int	get_initial_page_num ()
	Get the initial page number.
const ImagePtr	get_page (const unsigned int page_number)
	Retrieve specified page.
int	get_page (const std::string &anchor)
	Retrieve page from anchor.
bool	get_page_name (const std::string &anchor, std::string &name)
bool	close_document ()
	Close and release all allocated resource.
bool	get_anchor_of_page (const unsigned int page_number, std::string &anchor)
bool	has_anchor (const std::string &anchor)
	Check the document contains the anchor or not.
int	get_position (const std::string &anchor)
	Find position from the anchor.
int	compare_anchor (const std::string &first, const std::string &second)
	Compare the anchor object.
bool	get_prev_page (std::string &anchor)
	Anchor iteraotr: retrieve the previous anchor.
bool	get_next_page (std::string &anchor)
	Anchor iteraotr: retrieve the next anchor.
bool	get_original_size (const std::string &anchor, unsigned int &width, unsigned int &height)
bool	get_original_rotation (const std::string &anchor, PluginRotationDegree &rotation)

---

Detailed Description

Handle images file format.

Definition at line 38 of file images_document.h.

---

Constructor & Destructor Documentation

images::ImagesDocument::ImagesDocument

(

void

)

Definition at line 40 of file images_document.cpp.

References LOGPRINTF.

                                   : initial_page_num(1)
{
    LOGPRINTF("entry");
}

images::ImagesDocument::~ImagesDocument

(

void

)

Definition at line 45 of file images_document.cpp.

References close_document(), and LOGPRINTF.

{
    LOGPRINTF("entry");

    close_document();
}

Here is the call graph for this function:

---

Member Function Documentation

bool images::ImagesDocument::close_document

(

)

Close and release all allocated resource.

Definition at line 99 of file images_document.cpp.

References LOGPRINTF.

Referenced by ~ImagesDocument().

{
    LOGPRINTF("entry");

    ImagesIter begin = images.begin();
    ImagesIter end   = images.end();
    for(ImagesIter iter = begin; iter != end; ++iter)
    {
        delete *iter;
    }
    images.clear();
    return true;
}

Here is the caller graph for this function:

int images::ImagesDocument::compare_anchor	(	const std::string &	first,
		const std::string &	second
	)

Compare the anchor object.

Definition at line 139 of file images_document.cpp.

References get_position(), and LOGPRINTF.

{
    int first_pos = get_position(first);
    int second_pos = get_position(second);

    LOGPRINTF("first_pos[%d] second_pos[%d]", first_pos, second_pos);

    return first_pos - second_pos;
}

Here is the call graph for this function:

bool images::ImagesDocument::get_anchor_of_page	(	const unsigned int	page_number,
		std::string &	anchor
	)

Anchor policy: Use path name of image as the anchor. Get anchor for specified page.

Definition at line 113 of file images_document.cpp.

References LOGPRINTF, and path.

Referenced by main().

{
    LOGPRINTF("entry %d", page_number);

    if (page_number >= 1 && page_number <= images.size())
    {
        anchor = images[page_number - 1]->path;

        LOGPRINTF("%s", images[page_number -1]->path.c_str());

        return true;
    }
    else
    {
        return false;
    }
}

Here is the caller graph for this function:

int images::ImagesDocument::get_initial_page_num

(

)

Get the initial page number.

Definition at line 83 of file images_document.cpp.

{
    return initial_page_num;
}

bool images::ImagesDocument::get_next_page

(

std::string &

anchor

)

Anchor iteraotr: retrieve the next anchor.

Definition at line 206 of file images_document.cpp.

References LOGPRINTF.

{
    ImagesIter begin = images.begin();
    ImagesIter end   = images.end();
    ImagesIter iter;
    for(iter = begin; iter != end; ++iter)
    {
        if ((*iter)->path == anchor)
        {
            break;
        }
    }
    
    if (iter == end || ++iter == end)
    {
        return false;
    }
    anchor = (*iter)->path;

    LOGPRINTF("%s", anchor.c_str());

    return true;
}

bool images::ImagesDocument::get_original_rotation	(	const std::string &	anchor,
		PluginRotationDegree &	rotation
	)

Definition at line 265 of file images_document.cpp.

{
     ImagesIter begin = images.begin();
     ImagesIter end   = images.end();
     ImagesIter iter;
     for(iter = begin; iter != end; ++iter)
     {
         if ((*iter)->path == anchor)
         {
             // The image rotation is not calculated yet, calculate it now.
             if ( !((*iter)->is_rotation_calculated) )
             {
                 ImagesScanner::get_original_rotation((*iter)->path, (*iter)->rotation);
                 (*iter)->is_rotation_calculated = true;
             }

             rotation = (*iter)->rotation;
             
             return true;
         }
     }
     return false;
}

bool images::ImagesDocument::get_original_size	(	const std::string &	anchor,
		unsigned int &	width,
		unsigned int &	height
	)

Definition at line 230 of file images_document.cpp.

References images::ImagesScanner::get_size().

{
     ImagesIter begin = images.begin();
     ImagesIter end   = images.end();
     ImagesIter iter;
     for(iter = begin; iter != end; ++iter)
     {
         if ((*iter)->path == anchor)
         {
             // The image size is not calculated yet, calculate it now.
             if (((*iter)->width == -1) || ((*iter)->height == -1))
             {
                 ImagesScanner::get_size((*iter)->path, 
                                         &(*iter)->width, 
                                         &(*iter)->height);
             }
             
             // The valid image's size is greater than zero.
             if (((*iter)->width > 0) && ((*iter)->height > 0))
             {
                 width = (*iter)->width;
                 height = (*iter)->height;
                 
                 return true;
             }
             
             return false;
         }
     }
     
     return false;
}

Here is the call graph for this function:

int images::ImagesDocument::get_page

(

const std::string &

anchor

)

Retrieve page from anchor.

const ImagePtr images::ImagesDocument::get_page

(

const unsigned int

page_number

)

Retrieve specified page.

Definition at line 88 of file images_document.cpp.

References LOGPRINTF, and path.

{
    assert(page_number >= 1 && page_number <= images.size()); 

    LOGPRINTF("page[%d] %s", 
            page_number, 
            images[page_number - 1]->path.c_str());
    
    return images[page_number - 1];
}

bool images::ImagesDocument::get_page_name	(	const std::string &	anchor,
		std::string &	name
	)

Definition at line 166 of file images_document.cpp.

References filename, get_file_name(), has_anchor(), and MAX_PATH_LEN.

{
    if (has_anchor(anchor))
    {
        char filename[MAX_PATH_LEN];
        if (get_file_name(anchor.c_str(), filename, MAX_PATH_LEN))
        {
            name = filename;
            return true;
        }
    }
    return false;
}

Here is the call graph for this function:

int images::ImagesDocument::get_position

(

const std::string &

anchor

)

Find position from the anchor.

Definition at line 150 of file images_document.cpp.

References LOGPRINTF.

Referenced by compare_anchor(), has_anchor(), and images::ImagesRenderer::render().

{
    ImagesIter begin = images.begin();
    ImagesIter end   = images.end();
    for(ImagesIter iter = begin; iter != end; ++iter)
    {
        if ((*iter)->path == path)
        {
            LOGPRINTF("%d", static_cast<int>((iter - begin) + 1));

            return static_cast<int>((iter - begin) + 1);
        }
    }
    return -1;
}

Here is the caller graph for this function:

bool images::ImagesDocument::get_prev_page

(

std::string &

anchor

)

Anchor iteraotr: retrieve the previous anchor.

Definition at line 181 of file images_document.cpp.

References LOGPRINTF, and path.

{
    ImagesIter begin = images.begin();
    ImagesIter end   = images.end();
    ImagesIter iter;
    for(iter = begin; iter != end; ++iter)
    {
        if ((*iter)->path == anchor)
        {
            break;
        }
    }
    
    // Check the iter position.
    if (iter == end || iter == begin)
    {
        return false;
    }
    anchor = (*--iter)->path;

    LOGPRINTF("%s", anchor.c_str());

    return true;
}

bool images::ImagesDocument::has_anchor

(

const std::string &

anchor

)

Check the document contains the anchor or not.

Definition at line 132 of file images_document.cpp.

References get_position(), and LOGPRINTF.

Referenced by get_page_name().

{
    LOGPRINTF("%s", anchor.c_str());

    return (get_position(anchor) >= 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool images::ImagesDocument::is_open

(

)

Check if the document has been opened.

Definition at line 69 of file images_document.cpp.

References LOGPRINTF.

{
    LOGPRINTF("%d", images.size());

    return (images.size() > 0);
}

bool images::ImagesDocument::open_document	(	const std::string &	path,
		bool	to_scan_dir = true
	)

Open .images index file.

Definition at line 52 of file images_document.cpp.

References images::BY_FILEPATH, LOGPRINTF, and images::ImagesScanner::scan_images().

Referenced by main().

{
    using namespace images;

    ImagesScanner scanner;

    initial_page_num = scanner.scan_images(path,
                                           to_scan_dir,
                                           false,
                                           BY_FILEPATH, 
                                           true,
                                           images) + 1;
    LOGPRINTF("%d", initial_page_num);

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int images::ImagesDocument::page_count

(

)

How many "page" does it contain.

Definition at line 76 of file images_document.cpp.

References LOGPRINTF.

Referenced by main().

{
    LOGPRINTF("%d", images.size());

    return static_cast<unsigned int>(images.size());
}

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• images_document.h
• images_document.cpp