notepad_pages.h

Go to the documentation of this file.

#ifndef __NOTEPAD_PAGES_H__
#define __NOTEPAD_PAGES_H__

/**
 * File Name  : notepad_pages.h
 *
 * Description: notepad pages cache class
 */

/*
 * This file is part of notepad.
 *
 * notepad is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * notepad is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2010 IREX Technologies B.V.
 * All rights reserved.
 */
 
#include <glib.h>
#include <gtk/gtk.h> 
#include <gdk/gdk.h> 

#include "notepad_utils.h"
#include "notepad_point.h"
#include "notepad_doc.h"
#include "notepad_commandqueue.h"
#include <liberscribble/scb.h>


namespace notepad 
{

#define NPAGES    11 // odd, currentpage +5 and -5
#define NOTFOUND (-1)

    // Context/parameters for rendering scribble page.
    struct RenderPageCtx
    {
        int     pageno;
        bool    isCurrent;
    };


    class CNotepadPages
    {
        private: 

            typedef struct
            {
                GdkImage*   image;
                gint        pageno;
                gboolean    dirty;
            } NpPage;


        public:
            // object lifecycle
            CNotepadPages(); // constructor is not initializing, see init() -- construction of window 
            ~CNotepadPages();

            void init(CNotepadDoc* aDoc, GCtx* aCtx, int pageno, GdkVisual* visual = 0);
            void stop(); // to end prerenderthread before destruction

        private:
            CNotepadPages(const CNotepadPages&);            // no copy 
            CNotepadPages& operator=(const CNotepadPages&); // no assignment

        public:
            // page functions
            void insert_page(const int pageno);
            void delete_page(const int pageno);
            void clear_page(const int pageno);
            void mark_dirty(const int pageno);
            void mark_all_dirty();
            GdkImage*   get_page(const int pageno);

        private: 
            // internals
            gint        find_page(const int pageno);
            gint        make_room(const int pageno);
            gint        remove_from_cache(const gint index);
            gint        remove_page_from_cache(const int pageno);
            gint        replace_page_at_index(const gint index, const int pageno);
            bool        stop_flag;

        private:
            // member variables
            GdkVisual*      visual;         //< visual for creation of images
            NpPage          pages[NPAGES];  //< Page Image cache
            CNotepadDoc*    doc;            //< document class
            GCtx*           gctx;           //< scribble graphic context
            int             current_page;   //< Page currently used.

            // working thread used for executing tasks
            CmdQueue        cmd_queue;
            CSemaphore      drawsem;
            CSemaphore      pages_rw_sem;   //< guards writing in the datastruct

            // executed by thread
        public:
            bool execRenderPage(RenderPageCtx* ctx);
    };

} // namespace

#endif // __NOTEPAD_PAGES_H__