pdf::PDFPage Class Reference

The page information. More...

#include <pdf_page.h>

Collaboration diagram for pdf::PDFPage:

[legend]

Public Types
enum	RenderStatus { RENDER_DONE = 0, RENDER_RUNNING, RENDER_STOP }
Public Member Functions
	PDFPage (int page_num, const PDFRenderAttributes &attr)
	~PDFPage (void)
size_t	operator() ()
	Return the size_t value based on the pagenumber.
bool	operator== (const PDFPage &right)
	Comparing.
bool	operator== (const PDFRenderAttributes &right)
unsigned int	destroy ()
	Destroy the resource of the page.
void	lock ()
void	unlock ()
	Unlock the page.
bool	locked () const
	Is current page be locked.
void	set_render_attr (const PDFRenderAttributes &attr)
const PDFRenderAttributes &	get_render_attr () const
	Get the render attributes.
int	get_ref_id ()
	Get/Set the reference id.
void	set_ref_id (int id)
int	get_page_num () const
int	get_bitmap_width ()
int	get_bitmap_height ()
int	get_bitmap_row_stride ()
SplashBitmap *	get_bitmap () const
Links *	get_links () const
TextPage *	get_text () const
TextWordList *	get_words_list ()
PDFController *	get_doc_controller () const
void	set_doc_controller (PDFController *doc)
unsigned int	length ()
	Get the data length of the bitmap.
const unsigned char *	get_bitmap_data ()
	Get the data of the bitmap.
bool	is_hyper_linked_page (int dst_page_num)
	Estimate whether the input is hyperlink page of current page.
bool	render_splash_map (PDFRenderer *renderer, void *abort_data)
	Render a splash page by render attributes passed in.
bool	render_text (PDFRenderer *renderer, bool use_defalt_setting=false)
	Render a text page by render attributes passed in.
SearchResult	search (SearchContext &ctx, PDFSearchPage &results)
bool	get_bounding_rectangles (const string &start_anchor, const string &end_anchor, PDFRectangles &rects)
	Get the bounding rectangles in the passed-in range.
RenderStatus	get_render_status ()
	Get rendering status.
void	get_anchor_param_from_coordinates (double x, double y, PDFAnchor &param)
	Get the anchor of (x, y).
int	get_goto_page_of_link (int link_index)
	Get the destination's page number of the link.
bool	get_goto_anchor_of_link (int link_index, std::string &anchor)
	Get the destination's anchor of the link.
bool	get_range_param_by_link_index (const int link_index, PDFAnchor &start_param, PDFAnchor &end_param)
	Get the range of link by link index.
bool	get_range_param_by_word_index (const int link_index, PDFAnchor &start_param, PDFAnchor &end_param)
	Get the range of word by word index.
bool	get_text_by_range (const PDFAnchor &start_param, const PDFAnchor &end_param, std::string &result)
	Get the text by range.
bool	get_content_area (PDFRenderer *renderer, RenderArea &area)
const RenderArea &	get_content_area () const
void	coordinates_dev_to_user (const double dx, const double dy, double *ux, double *uy)
	Translate point from device coordination to user's.
void	coordinates_user_to_dev (const double ux, const double uy, int *dx, int *dy)
Friends
class	PDFRenderTask
class	PDFSearcher

---

Detailed Description

The page information.

Definition at line 125 of file pdf_page.h.

---

Member Enumeration Documentation

enum pdf::PDFPage::RenderStatus

Render status, it would be used when submitting a new render task

Enumerator:

RENDER_DONE
RENDER_RUNNING
RENDER_STOP

Definition at line 130 of file pdf_page.h.

    {
        RENDER_DONE = 0,
        RENDER_RUNNING,
        RENDER_STOP
    }RenderStatus;

---

Constructor & Destructor Documentation

pdf::PDFPage::PDFPage	(	int	page_num,
		const PDFRenderAttributes &	attr
	)

Definition at line 82 of file pdf_page.cpp.

{
    init();
    page_number = page_num;
    render_attr = attr;
}

pdf::PDFPage::~PDFPage

(

void

)

Definition at line 89 of file pdf_page.cpp.

References destroy().

{
    destroy();
}

Here is the call graph for this function:

---

Member Function Documentation

void pdf::PDFPage::coordinates_dev_to_user	(	const double	dx,
		const double	dy,
		double *	ux,
		double *	uy
	)

Translate point from device coordination to user's.

Definition at line 1832 of file pdf_page.cpp.

{
  *ux = ictm[0] * dx + ictm[2] * dy + ictm[4];
  *uy = ictm[1] * dx + ictm[3] * dy + ictm[5];
}

void pdf::PDFPage::coordinates_user_to_dev	(	const double	ux,
		const double	uy,
		int *	dx,
		int *	dy
	)

Definition at line 1839 of file pdf_page.cpp.

Referenced by get_anchor_param_from_coordinates(), and get_bounding_rectangles().

{
  *dx = (int)(ctm[0] * ux + ctm[2] * uy + ctm[4] + 0.5);
  *dy = (int)(ctm[1] * ux + ctm[3] * uy + ctm[5] + 0.5);
}

Here is the caller graph for this function:

unsigned int pdf::PDFPage::destroy

(

)

Destroy the resource of the page.

Definition at line 163 of file pdf_page.cpp.

References get_render_status(), locked(), RENDER_RUNNING, and RENDER_STOP.

Referenced by pdf::PagesCache::clear_cached_bitmaps(), and ~PDFPage().

{
    if (locked())
    {
        return 0;
    }

    if (get_render_status() == RENDER_RUNNING)
    {
        // if the page is in rendering, cannot delete it
        // it won't happen now, because the deleting is executed
        // in working thread.
        return 0;
    }

    // reset the render status
    set_render_status(RENDER_STOP);

    destroy_links();
    destroy_text();
    unsigned int size = destroy_bitmap();

    return size;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void pdf::PDFPage::get_anchor_param_from_coordinates	(	double	x,
		double	y,
		PDFAnchor &	param
	)

Get the anchor of (x, y).

Definition at line 1531 of file pdf_page.cpp.

References pdf::PDFAnchor::char_idx, coordinates_user_to_dev(), get_words_list(), pdf::PDFAnchor::link_idx, pdf::PDFAnchor::page_num, and pdf::PDFAnchor::word_num.

{
    int i;
    // Caculate whether (x, y) inside a Link and inside which Link
    int link_index = -1;
    if (links && links->onLink(x, y))
    {
        int link_num;
        Link * link;

        link_num = links->getNumLinks();
        for (i = 0; i < link_num; i++)
        {
            link = links->getLink(i);
            if (link && link->inRect(x, y))
            {
                link_index = i;
                break;
            }
        }
    }

    // get the anchor of a screen point
    // now the anchor is supposed to be like "pdf:/page:8/link:0/word:12/char:06"
    // however, if the point is located on a object(image, shape or any thing else),
    // word and char cannot be retrieved.
    // TODO. add support to the non-text object
    int dx, dy;
    coordinates_user_to_dev(x, y, &dx, &dy);

    int word_index = -1, char_index = -1;

    TextWordList * words = get_words_list();
    if (words != 0)
    {
        int words_num = words->getLength();
        TextWord * word = 0;
        double x_min = 0.0, y_min = 0.0, x_max = 0.0, y_max = 0.0;
        for(i = 0; i < words_num; i++)
        {
            word = words->get(i);
            word->getBBox(&x_min, &y_min, &x_max, &y_max);

            if ((x_min <= dx) && (dx <= x_max) 
                && (y_min <= dy) && (dy <= y_max))
            {
                word_index = i;

                int chars_num = word->getLength();
                for (int j = 0; j < chars_num; j++)
                {
#ifdef WIN32
                    x_min = word->getEdge(j);
                    x_max = word->getEdge(j+1);
#else
                    word->getCharBBox(j, &x_min, &y_min, &x_max, &y_max); 
#endif
                    if ((x_min <= dx) && (dx <= x_max) 
                        && (y_min <= dy) && (dy <= y_max))
                    {
                        char_index = j;
                        break;
                    }
                }
                break;
            }
        }

        delete words;
    }

    // set the anchor
    param.page_num = page_number;
    param.link_idx = link_index;
    param.word_num = word_index;
    param.char_idx = char_index;
    //param.file_name = get_doc_controller()->name();
}

Here is the call graph for this function:

SplashBitmap* pdf::PDFPage::get_bitmap

(

)

const [inline]

Definition at line 179 of file pdf_page.h.

Referenced by pdf::PagesCache::clear_cached_bitmaps(), and pdf::operator<().

{ return bitmap; }

Here is the caller graph for this function:

const unsigned char * pdf::PDFPage::get_bitmap_data

(

)

Get the data of the bitmap.

Definition at line 251 of file pdf_page.cpp.

{
    if (!bitmap)
    {
        return 0;
    }

    return bitmap->getDataPtr();
}

int pdf::PDFPage::get_bitmap_height

(

)

Definition at line 210 of file pdf_page.cpp.

{
    if (!bitmap)
    {
        return 0;
    }

    return bitmap->getHeight();
}

int pdf::PDFPage::get_bitmap_row_stride

(

)

Definition at line 241 of file pdf_page.cpp.

{
    if (!bitmap)
    {
        return 0;
    }

    return bitmap->getRowSize();
}

int pdf::PDFPage::get_bitmap_width

(

)

Definition at line 200 of file pdf_page.cpp.

{
    if (!bitmap)
    {
        return 0;
    }

    return bitmap->getWidth();
}

bool pdf::PDFPage::get_bounding_rectangles	(	const string &	start_anchor,
		const string &	end_anchor,
		PDFRectangles &	rects
	)

Get the bounding rectangles in the passed-in range.

Definition at line 1039 of file pdf_page.cpp.

References pdf::PDFInstanceCollection< T >::add(), coordinates_user_to_dev(), get_words_list(), PluginRectangle::height, pdf::PDFAnchor::link_idx, pdf::merge_rectangle(), pdf::PDFAnchor::page_num, PluginRectangle::width, pdf::PDFAnchor::word_num, PluginRectangle::x, and PluginRectangle::y.

Referenced by pdf::PDFController::get_bounding_rectangles().

{
    PDFAnchor start_param(start_anchor);
    PDFAnchor end_param(end_anchor);

    //Cannot identify the word in seperated pages
    if (start_param.page_num != page_number ||
        start_param.page_num != end_param.page_num)
    {
        return false;
    }

    //int len = end_param.char_idx - start_param.char_idx + 1;
    //assert(len > 0);
    //assert(start_param.word_num >= 0 && end_param.word_num >= 0);

    // TODO. Get rectange from hyperlink (without word)
    PDFRectangle pdf_rect;
    if (start_param.word_num >= 0 && end_param.word_num >= 0)
    {
        TextWordList * words = get_words_list();
        for(int i = start_param.word_num; i <= end_param.word_num; ++i)
        {
            double x_min = 0.0, y_min = 0.0, x_max = 0.0, y_max = 0.0;
            words->get(i)->getBBox(&x_min, &y_min, &x_max, &y_max);

            if (!merge_rectangle(x_min, y_min, x_max, y_max, &pdf_rect))
            {
                PluginRectangle rect;
                rect.x = static_cast<int>(pdf_rect.x1);
                rect.y = static_cast<int>(pdf_rect.y1);
                rect.width  = static_cast<int>(pdf_rect.x2 - pdf_rect.x1) + 1;
                rect.height = static_cast<int>(pdf_rect.y2 - pdf_rect.y1) + 1;
                rects.add(rect);

                // update the rectangle
                pdf_rect.x1 = x_min;
                pdf_rect.x2 = x_max;
                pdf_rect.y1 = y_min;
                pdf_rect.y2 = y_max;
            }
        }

        delete words;

        if (pdf_rect.isValid())
        {
            // add the last rectangle into the list
            PluginRectangle rect;
            rect.x = static_cast<int>(pdf_rect.x1);
            rect.y = static_cast<int>(pdf_rect.y1);
            rect.width  = static_cast<int>(pdf_rect.x2 - pdf_rect.x1) + 1;
            rect.height = static_cast<int>(pdf_rect.y2 - pdf_rect.y1) + 1;
            rects.add(rect);
        }
    }
    else if (start_param.link_idx >= 0 && end_param.link_idx >= 0)
    {
        if (links == 0)
        {
            return false;
        }

        for(int i = start_param.link_idx; i <= end_param.link_idx; ++i)
        {
            double x_min = 0.0, y_min = 0.0, x_max = 0.0, y_max = 0.0;
            Link *link = links->getLink(i);
            link->getRect(&x_min, &y_min, &x_max, &y_max);
            int real_x_min, real_y_min, real_x_max, real_y_max;
            coordinates_user_to_dev(x_min, y_min, &real_x_min, &real_y_min);
            coordinates_user_to_dev(x_max, y_max, &real_x_max, &real_y_max);
            x_min = min(real_x_min, real_x_max);
            x_max = max(real_x_min, real_x_max);
            y_min = min(real_y_min, real_y_max);
            y_max = max(real_y_min, real_y_max);

            if (!merge_rectangle(x_min, y_min, x_max, y_max, &pdf_rect))
            {
                PluginRectangle rect;
                rect.x = static_cast<int>(pdf_rect.x1);
                rect.y = static_cast<int>(pdf_rect.y1);
                rect.width  = static_cast<int>(pdf_rect.x2 - pdf_rect.x1) + 1;
                rect.height = static_cast<int>(pdf_rect.y2 - pdf_rect.y1) + 1;
                rects.add(rect);

                // update the rectangle
                pdf_rect.x1 = x_min;
                pdf_rect.x2 = x_max;
                pdf_rect.y1 = y_min;
                pdf_rect.y2 = y_max;
            }

        }

        if (pdf_rect.isValid())
        {
            // add the last rectangle into the list
            PluginRectangle rect;
            rect.x = static_cast<int>(pdf_rect.x1);
            rect.y = static_cast<int>(pdf_rect.y1);
            rect.width  = static_cast<int>(pdf_rect.x2 - pdf_rect.x1) + 1;
            rect.height = static_cast<int>(pdf_rect.y2 - pdf_rect.y1) + 1;
            rects.add(rect);
        }
    }

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

const RenderArea& pdf::PDFPage::get_content_area

(

)

const [inline]

Definition at line 242 of file pdf_page.h.

{ return content_area; }

bool pdf::PDFPage::get_content_area	(	PDFRenderer *	renderer,
		RenderArea &	area
	)

Get content area of a page. The content area should be caculated by the result of a thumbnail rendering

Definition at line 1272 of file pdf_page.cpp.

References ERRORPRINTF, pdf::PDFViewAttributes::get_device_dpi_h(), pdf::PDFViewAttributes::get_device_dpi_v(), get_page_num(), pdf::PDFController::get_pdf_doc(), pdf::PDFRenderer::get_render_mutex(), pdf::PDFRenderer::get_view_attr(), RenderArea::height, pdf::is_render_area_valid(), RenderArea::width, RenderArea::x_offset, and RenderArea::y_offset.

Referenced by pdf::PDFRenderTask::execute(), and pdf::PDFController::get_page_content_area().

{
    static const double SHRINK_ZOOM = 0.2f;
    static const int    EXPAND_STEP = 2;

    if (!is_render_area_valid(content_area))
    {
        // lock when rendering
        ScopeMutex m(&(renderer->get_render_mutex()));

        RenderRet ret = doc_controller->get_pdf_doc()->displayPage(
        renderer->get_thumbnail_output_dev()
        , get_page_num()
        , SHRINK_ZOOM * renderer->get_view_attr().get_device_dpi_h()
        , SHRINK_ZOOM * renderer->get_view_attr().get_device_dpi_v()
        , 0
        , gFalse  //useMediaBox, TODO.
        , gFalse  //crop, TODO.
        , gFalse  //doLinks, TODO.
        );

        if (ret == Render_Error || ret == Render_Invalid)
        {
            ERRORPRINTF("Error in rendering thumbnail page:%d\n", get_page_num());
            return false;
        }

        SplashBitmap *thumb_map = renderer->get_thumbnail_output_dev()->takeBitmap();
        PDFRectangle content_rect;
        bool succeed = get_content_from_bitmap(thumb_map, content_rect);
        // calculate the render area by the rectangle
        double page_width = thumb_map->getWidth();
        double page_height = thumb_map->getHeight();
        delete thumb_map;
        if (!succeed)
        {
            // set the content area to be the page area
            content_rect.x1 = content_rect.y1 = 0;
            content_rect.x2 = page_width;
            content_rect.y2 = page_height;
        }
        else
        {
            // expand the content area to avoid content covering
            double inc_x2 = 0;
            double inc_y2 = 0;

            // expand x1
            if (content_rect.x1 > EXPAND_STEP)
            {
                content_rect.x1 -= EXPAND_STEP;
                inc_x2 = EXPAND_STEP;
            }
            else
            {
                inc_x2 = content_rect.x1;
                content_rect.x1 = 0;
            }

            // expand y1
            if (content_rect.y1 > EXPAND_STEP)
            {
                content_rect.y1 -= EXPAND_STEP;
                inc_y2 = EXPAND_STEP;
            }
            else
            {
                inc_y2 = content_rect.y1;
                content_rect.y1 = 0;
            }

            // expand x2
            content_rect.x2 += (inc_x2 + 1);
            if (content_rect.x2 > page_width)
            {
                content_rect.x2 = page_width;
            }

            // expand y2
            content_rect.y2 += (inc_y2 + 1);
            if (content_rect.y2 > page_height)
            {
                content_rect.y2 = page_height;
            }
        }

        content_area.x_offset = static_cast<float>(content_rect.x1 / page_width);
        content_area.y_offset = static_cast<float>(content_rect.y1 / page_height);

        content_area.width =
            static_cast<float>((content_rect.x2 - content_rect.x1) / page_width);
        content_area.height =
            static_cast<float>((content_rect.y2 - content_rect.y1) / page_height);

        if (content_area.width > 1.0f)
        {
            content_area.x_offset = 0.0f;
            content_area.width    = 1.0f;
        }
        if (content_area.height > 1.0f)
        {
            content_area.y_offset = 0.0f;
            content_area.height   = 1.0f;
        }
    }

    area = content_area;

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

PDFController* pdf::PDFPage::get_doc_controller

(

)

const [inline]

Definition at line 183 of file pdf_page.h.

Referenced by pdf::operator<().

{ return doc_controller; }

Here is the caller graph for this function:

bool pdf::PDFPage::get_goto_anchor_of_link	(	int	link_index,
		std::string &	anchor
	)

Get the destination's anchor of the link.

Definition at line 1816 of file pdf_page.cpp.

References get_goto_page_of_link(), pdf::PDFAnchor::get_string(), and pdf::PDFAnchor::page_num.

{
    // Get the anchor of destination for this link.
    int page_num = get_goto_page_of_link(link_index);
    if (page_num > 0)
    {
        PDFAnchor param;
        param.page_num = page_num;
        //param.file_name = get_doc_controller()->name();
        anchor = param.get_string();
        return true;
    }

    return false;
}

Here is the call graph for this function:

int pdf::PDFPage::get_goto_page_of_link

(

int

link_index

)

Get the destination's page number of the link.

Definition at line 1739 of file pdf_page.cpp.

References action, ERRORPRINTF, and pdf::PDFController::get_pdf_doc().

Referenced by get_goto_anchor_of_link(), and is_hyper_linked_page().

{
    if (links == 0)
    {
        return 0;
    }

    //assert(link_index >= 0 && link_index < links->getNumLinks());
    if (link_index < 0 || link_index >= links->getNumLinks())
    {
        ERRORPRINTF("Error Link Index");
        return 0;
    }

    Link *link = links->getLink(link_index);
    int page_num = 0;
    if (link != 0)
    {
        LinkAction *action = link->getAction();
        LinkActionKind kind = action->getKind();
        if (kind == actionGoTo)
        {
            // Caculate the page number of destination of this link.
#ifdef WIN32
            UGooString *named_dest = 0;
#else
            GooString *named_dest = 0;
#endif
            PDFDoc *doc = doc_controller->get_pdf_doc();

            LinkDest *dest = ((LinkGoTo *)action)->getDest();
            named_dest = ((LinkGoTo *)action)->getNamedDest();

            if (dest && dest->isPageRef())
            {
                Ref pageRef = dest->getPageRef();
                page_num = doc->findPage(pageRef.num, pageRef.gen);
            }
            else if (named_dest)
            {
                dest = doc->findDest(named_dest);
                if (dest)
                {
                    Ref pageRef = dest->getPageRef();
                    page_num = doc->findPage(pageRef.num, pageRef.gen);
                }
            }
        }
    }
    return page_num;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Links* pdf::PDFPage::get_links

(

)

const [inline]

Definition at line 180 of file pdf_page.h.

{ return links; }

int pdf::PDFPage::get_page_num

(

)

const [inline]

Definition at line 175 of file pdf_page.h.

Referenced by get_content_area(), pdf::operator<(), render_splash_map(), and pdf::PluginRenderResultImpl::set_page().

{ return page_number; }

Here is the caller graph for this function:

bool pdf::PDFPage::get_range_param_by_link_index	(	const int	link_index,
		PDFAnchor &	start_param,
		PDFAnchor &	end_param
	)

Get the range of link by link index.

Definition at line 1697 of file pdf_page.cpp.

References ERRORPRINTF, pdf::PDFAnchor::link_idx, and pdf::PDFAnchor::page_num.

{
    if (links)
    {
        //assert(link_index >= 0 && link_index < links->getNumLinks());
        if (link_index < 0 || link_index >= links->getNumLinks())
        {
            ERRORPRINTF("Error Link Index");
            return false;
        }

        // Link * link = links->getLink(link_index);

        // Disable the area check
        // Do we really need the area check for hyperlinks?
        // In most of the PDF documents, hyperlinks are indicated by a rectangle.
        // We can just return the index of hyperlink

        /*double x_min = 0.0f, y_min = 0.0f, x_max = 0.0f, y_max = 0.0f, y = 0.0f;
        link->getRect(&x_min, &y_min, &x_max, &y_max);

        // calculate the middle point
        y = (y_min + y_max) / 2;

        get_anchor_param_from_coordinates(x_min, y, start_param);
        get_anchor_param_from_coordinates(x_max, y, end_param);*/

        start_param.page_num = page_number;
        start_param.link_idx = link_index;
        //start_param.file_name = get_doc_controller()->name();

        end_param.page_num = page_number;
        end_param.link_idx = link_index;
        //end_param.file_name = get_doc_controller()->name();
        return true;
    }

    return false;
}

bool pdf::PDFPage::get_range_param_by_word_index	(	const int	link_index,
		PDFAnchor &	start_param,
		PDFAnchor &	end_param
	)

Get the range of word by word index.

Definition at line 1611 of file pdf_page.cpp.

References pdf::PDFAnchor::char_idx, get_words_list(), pdf::PDFAnchor::page_num, and pdf::PDFAnchor::word_num.

{
    TextWordList * words = get_words_list();
    bool ret = false;
    if (words != 0)
    {
        int words_num = words->getLength();
        if (word_index >= 0 && word_index < words_num)
        {
            TextWord * word = words->get(word_index);

            start_param.page_num = page_number;
            start_param.word_num = word_index;
            start_param.char_idx = 0;
            //start_param.file_name = get_doc_controller()->name();

            end_param.page_num = page_number;
            end_param.word_num = word_index;
            end_param.char_idx = word->getLength();
            //end_param.file_name = get_doc_controller()->name();

            ret = true;
        }
        delete words;
    }
    return ret;
}

Here is the call graph for this function:

int pdf::PDFPage::get_ref_id

(

)

[inline]

Get/Set the reference id.

Definition at line 172 of file pdf_page.h.

Referenced by pdf::PluginRenderResultImpl::set_page().

{ return ref_id; }

Here is the caller graph for this function:

const PDFRenderAttributes& pdf::PDFPage::get_render_attr

(

)

const [inline]

Get the render attributes.

Definition at line 169 of file pdf_page.h.

Referenced by pdf::PDFRenderTask::execute(), and pdf::PDFRenderer::post_render_task().

{ return render_attr; }

Here is the caller graph for this function:

RenderStatus pdf::PDFPage::get_render_status

(

)

[inline]

Get rendering status.

Definition at line 213 of file pdf_page.h.

Referenced by destroy(), pdf::PDFRenderTask::execute(), pdf::PDFRenderer::post_render_task(), and render_splash_map().

{return render_status;}

Here is the caller graph for this function:

TextPage* pdf::PDFPage::get_text

(

)

const [inline]

Definition at line 181 of file pdf_page.h.

{ return text; }

bool pdf::PDFPage::get_text_by_range	(	const PDFAnchor &	start_param,
		const PDFAnchor &	end_param,
		std::string &	result
	)

Get the text by range.

Definition at line 1641 of file pdf_page.cpp.

References ERRORPRINTF, pdf::get_std_string_from_text_word(), get_words_list(), pdf::PDFAnchor::is_end_anchor(), pdf::PDFAnchor::page_num, and pdf::PDFAnchor::word_num.

Referenced by pdf::PDFController::get_text_from_range().

{
    if (!end_param.is_end_anchor() && start_param.page_num != end_param.page_num)
    {
        // start anchor and end anchor point to different pages, quit
        return false;
    }

    TextWordList * words = get_words_list();
    result.clear();
    if (words != 0)
    {
        int words_num = words->getLength();
        int start_index = start_param.word_num;
        int end_index = end_param.is_end_anchor() ? words_num : end_param.word_num;

        // Get each word in the range.

        TextWord * word;
        string text;

        for (int idx = start_index; idx < end_index; ++idx)
        {
            word = words->get(idx);
            if (word == 0)
            {
                // the word is NULL
                ERRORPRINTF("Null word in search");
                break;
            }

            get_std_string_from_text_word(word, text);
            result += text;
            // Append the seperator " "
            result += " ";
        }

        // Append the last word.
        if (start_index <= end_index)
        {
            word = words->get(end_index);
            if (word)
            {
                get_std_string_from_text_word(word, text);
                result += text;
            }
        }

        delete words;
    }

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

TextWordList * pdf::PDFPage::get_words_list

(

)

Definition at line 188 of file pdf_page.cpp.

Referenced by get_anchor_param_from_coordinates(), get_bounding_rectangles(), get_range_param_by_word_index(), get_text_by_range(), and search().

{
    TextWordList *words = 0;

    if (text)
    {
        words = text->makeWordList(gFalse);
    }

    return words;
}

Here is the caller graph for this function:

bool pdf::PDFPage::is_hyper_linked_page

(

int

dst_page_num

)

Estimate whether the input is hyperlink page of current page.

Definition at line 1791 of file pdf_page.cpp.

References get_goto_page_of_link().

{
    if (links == 0)
    {
        return false;
    }

    int link_num = links->getNumLinks();
    if (link_num <= 0)
    {
        return false;
    }

    for (int i = 0; i < link_num; ++i)
    {
        if (dst_page_num == get_goto_page_of_link(i))
        {
            return true;
        }
    }

    return false;
}

Here is the call graph for this function:

unsigned int pdf::PDFPage::length

(

void

)

Get the data length of the bitmap.

Definition at line 220 of file pdf_page.cpp.

Referenced by pdf::PDFRenderTask::execute(), and render_splash_map().

{
    if (!bitmap)
    {
        return 0;
    }
    return bitmap->getHeight() * bitmap->getRowSize();
}

Here is the caller graph for this function:

void pdf::PDFPage::lock

(

void

)

[inline]

Lock the page so that it has the highest priority(cannot be removed until UDS unlocks it)

Definition at line 154 of file pdf_page.h.

Referenced by pdf::PluginRenderResultImpl::set_page().

{ b_lock = true; }

Here is the caller graph for this function:

bool pdf::PDFPage::locked

(

)

const [inline]

Is current page be locked.

Definition at line 160 of file pdf_page.h.

Referenced by pdf::PagesCache::clear_cached_bitmaps(), destroy(), pdf::operator<(), and render_splash_map().

{ return b_lock; }

Here is the caller graph for this function:

size_t pdf::PDFPage::operator()

(

void

)

Return the size_t value based on the pagenumber.

Definition at line 107 of file pdf_page.cpp.

{
    return static_cast<size_t>(page_number);
}

bool pdf::PDFPage::operator==

(

const PDFRenderAttributes &

right

)

Definition at line 118 of file pdf_page.cpp.

{
    return (this->render_attr == right);
}

bool pdf::PDFPage::operator==

(

const PDFPage &

right

)

Comparing.

Definition at line 112 of file pdf_page.cpp.

{
    return ((this->page_number == right.page_number) &&
            this->render_attr == right.render_attr);
}

bool pdf::PDFPage::render_splash_map	(	PDFRenderer *	renderer,
		void *	abort_data
	)

Render a splash page by render attributes passed in.

Definition at line 1150 of file pdf_page.cpp.

References pdf::PDFViewAttributes::get_device_dpi_h(), pdf::PDFViewAttributes::get_device_dpi_v(), get_page_num(), pdf::PDFController::get_pdf_doc(), pdf::PDFRenderAttributes::get_real_zoom_value(), pdf::PDFRenderer::get_render_mutex(), get_render_status(), pdf::PDFRenderAttributes::get_rotate(), pdf::PDFRenderer::get_view_attr(), length(), locked(), LOGPRINTF, RENDER_RUNNING, RENDER_STOP, and unlock().

Referenced by pdf::PDFRenderTask::execute().

{
    if (locked())
    {
        if (get_render_status() == RENDER_STOP)
        {
            // the previous rendering stopped by some reason
            // reset the lock
            unlock();
        }
        else
        {
            // cannot render when the page is locked
            LOGPRINTF("Locked, Cannot render\n");
            return false;
        }
    }

    // destroy the pre-rendered results
    destroy_links();
    doc_controller->update_memory_usage((-1) * destroy_bitmap());

    // set the status to rendering
    set_render_status(RENDER_RUNNING);

    // second render the page
    RenderRet ret = Render_Error;
    SplashBitmap *b = 0;
    Links *l = 0;

    // lock when rendering
    ScopeMutex m(&(renderer->get_render_mutex()));

    ret = doc_controller->get_pdf_doc()->displayPage(
        renderer->get_splash_output_dev()
        , page_number
        , render_attr.get_real_zoom_value() * 0.01 * renderer->get_view_attr().get_device_dpi_h()
        , render_attr.get_real_zoom_value() * 0.01 * renderer->get_view_attr().get_device_dpi_v()
        , render_attr.get_rotate()
        , gFalse //useMediaBox, TODO.
        , gTrue  //crop, TODO.
        , gTrue  //doLinks, TODO.
        , abort_render_check
        , abort_data
    );

    if (ret == Render_Error || ret == Render_Invalid)
    {
        LOGPRINTF("1. Error in rendering page:%d\n", get_page_num());
        return false;
    }

    // take bitmap
    b = renderer->get_splash_output_dev()->takeBitmap();

    // take hyperlinks
#ifdef WIN32
    l = doc_controller->get_pdf_doc()->takeLinks();
#else
    l = doc_controller->get_pdf_doc()->getLinks(page_number);
#endif

    if (ret == Render_Done)
    {
        update_bitmap(b);
        update_links(l);

        // retrieve ctm and ictm
        memcpy(ctm, renderer->get_splash_output_dev()->getDefCTM(), 6 * sizeof(double));
        memcpy(ictm, renderer->get_splash_output_dev()->getDefICTM(), 6 * sizeof(double)); 

        doc_controller->update_memory_usage(length());
        LOGPRINTF("Rendering of page:%d Done! Length:%d\n", get_page_num(), length());
        return true;
    }
    else if (ret == Render_Abort)
    {
        // MUST remove the temporary render results
        delete b;
        delete l;
        set_render_status(RENDER_STOP);
        LOGPRINTF("Rendering of page:%d is aborted! Task:%p\n", get_page_num(), abort_data);
        return false;
    }

    LOGPRINTF("2. Error in rendering page:%d\n", get_page_num());
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool pdf::PDFPage::render_text	(	PDFRenderer *	renderer,
		bool	use_defalt_setting = false
	)

Render a text page by render attributes passed in.

Definition at line 1244 of file pdf_page.cpp.

References pdf::PDFViewAttributes::get_device_dpi_h(), pdf::PDFViewAttributes::get_device_dpi_v(), pdf::PDFController::get_pdf_doc(), pdf::PDFRenderAttributes::get_real_zoom_value(), pdf::PDFRenderer::get_render_mutex(), pdf::PDFRenderAttributes::get_rotate(), and pdf::PDFRenderer::get_view_attr().

Referenced by pdf::PDFRenderTask::execute().

{
    static const double DEFAULT_ZOOM = 0.2f;

    destroy_text();
    // currently, the text rendering cannot be aborted

    // lock when rendering
    ScopeMutex m(&(renderer->get_render_mutex()));

    doc_controller->get_pdf_doc()->displayPage(
        renderer->get_text_output_dev()
        , page_number
        , (use_defalt_setting ? DEFAULT_ZOOM : render_attr.get_real_zoom_value() * 0.01) *
          renderer->get_view_attr().get_device_dpi_h()
        , (use_defalt_setting ? DEFAULT_ZOOM : render_attr.get_real_zoom_value() * 0.01) *
          renderer->get_view_attr().get_device_dpi_v()
        , render_attr.get_rotate()
        , gFalse
        , gTrue
        , gFalse
        );

    update_text(renderer->get_text_output_dev()->takeText());

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SearchResult pdf::PDFPage::search	(	SearchContext &	ctx,
		PDFSearchPage &	results
	)

Search in the current PDFPage. Make sure the text page is rendered before searching

Definition at line 291 of file pdf_page.cpp.

References pdf::PDFCollection< T >::add(), pdf::SearchContext::forward, get_words_list(), pdf::RES_ERROR, pdf::RES_NOT_FOUND, pdf::RES_OK, pdf::SearchContext::search_all, and pdf::SearchContext::word_cursor.

{
    if (!text)
    {
        return RES_ERROR;
    }

    TextWordList *words = get_words_list();
    PluginRangeImpl *result = 0;
    SearchResult ret = RES_NOT_FOUND;

    int count = 0;

    // the search operation would update the index of start word
    // in the context    
    if (ctx.forward)
    {
        if (ctx.word_cursor < 0)
        {
            // set the start word to be the first one
            ctx.word_cursor = 0;
        }

        // search forward
        result = search_string_forward(ctx, words);
        if (ctx.search_all)
        {    
            while(result != 0)
            {
                results.add(result);
                count++;
                result = search_string_forward(ctx, words);
            }
        }
        else
        {
            if (result)
            {
                results.add(result);
                count++;
            }
        }

    }
    else
    {
        if (ctx.word_cursor < 0)
        {
            // set the start word to be the last one
            ctx.word_cursor = words->getLength() - 1;
        }

        //search backward
        result = search_string_backward(ctx, words);
        if (ctx.search_all)
        {
            while(result != 0)
            {
                results.add(result);
                count++;
                result = search_string_backward(ctx, words);
            }
        }
        else
        {
            if (result)
            {
                results.add(result);
                count++;
            }
        }
    }

    if (count > 0)
    {
        ret = RES_OK;
    }

    delete words;
    return ret;
}

Here is the call graph for this function:

void pdf::PDFPage::set_doc_controller

(

PDFController *

doc

)

[inline]

Definition at line 184 of file pdf_page.h.

Referenced by pdf::PDFRenderer::gen_page().

{ doc_controller = doc; }

Here is the caller graph for this function:

void pdf::PDFPage::set_ref_id

(

int

id

)

[inline]

Definition at line 173 of file pdf_page.h.

Referenced by pdf::PDFRenderTask::execute(), and pdf::PDFRenderer::post_render_task().

{ ref_id = id; }

Here is the caller graph for this function:

void pdf::PDFPage::set_render_attr

(

const PDFRenderAttributes &

attr

)

Set the render attributes return true means setting succeed, or there is no change return false means the page is in rendering, cannot change the setting now

Definition at line 123 of file pdf_page.cpp.

Referenced by pdf::PDFRenderTask::execute().

{
    if (render_attr == attr)
    {
        return;
    }

    render_attr = attr;
}

Here is the caller graph for this function:

void pdf::PDFPage::unlock

(

void

)

[inline]

Unlock the page.

Definition at line 157 of file pdf_page.h.

Referenced by render_splash_map(), and pdf::PluginRenderResultImpl::~PluginRenderResultImpl().

{ b_lock = false; }

Here is the caller graph for this function:

---

Friends And Related Function Documentation

friend class PDFRenderTask [friend]

Definition at line 346 of file pdf_page.h.

friend class PDFSearcher [friend]

Definition at line 347 of file pdf_page.h.

---

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

• pdf_page.h
• pdf_page.cpp