CRNDocument.h

Go to the documentation of this file.

/* Copyright 2006-2016 Yann LEYDIER, CoReNum, INSA-Lyon, ENS-Lyon
 * 
 * This file is part of libcrn.
 * 
 * libcrn is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * libcrn 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with libcrn.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * file: CRNDocument.h
 * \author Yann LEYDIER
 */

#ifndef CRNDOCUMENT_HEADER
#define CRNDOCUMENT_HEADER

#include <vector>
#include <CRNSavable.h>
#include <CRNBlock.h>
#include <CRNDocumentPtr.h>
#include <CRNData/CRNForeach.h>
#include <CRNIO/CRNPath.h>
#ifdef CRN_USING_HARU
#   include <CRNUtils/CRNPDFAttributes.h>
#endif

namespace crn
{
    class Progress;

    /****************************************************************************/
    class Document: public Savable
    {
        public:
            Document();
            virtual ~Document() override;

            Document(const Document &) = delete;
            Document& operator=(const Document &) = delete;
            Document(Document &&) = default;
            Document& operator=(Document &&) = default;

            void SetBasename(const Path &s) { basename = s; }
            void SetAuthor(const String &s) { author = s; }
            void SetDate(const String &s) { date = s; }

            const Path& GetBasename() const noexcept { return basename; }
            const String& GetAuthor() const noexcept { return author; }
            const String& GetDate() const noexcept { return date; }
            std::vector<Path> GetFilenames() const;
            std::vector<String> GetViewIds() const;

            String AddView(const Path &fname);
            String InsertView(const Path &fname, size_t pos);
            void RemoveView(const Path &fname);
            void RemoveView(size_t num);
            void RemoveView(const String &id);
            SBlock GetView(size_t num) const;
            SBlock GetView(const String &id) const;
            SBlock GetView(const Path &fname) const;
            size_t GetViewIndex(const String &id) const;
            size_t GetViewIndex(const Path &fname) const;
            String GetViewId(size_t num) const;
            String GetViewId(const Path &fname) const;
            Path GetViewFilename(size_t num) const;
            Path GetViewFilename(const String &id) const;
            size_t GetNbViews() const noexcept { return views.size(); }
            void ReorderViewsFrom(const std::vector<size_t> &from);
            void ReorderViewsTo(const std::vector<size_t> &to);
            void Clear();

            Path GetThumbnailPath() const;
            UImage GetThumbnail(size_t index, bool refresh = false) const;
            UImage GetThumbnail(const String &id, bool refresh = false) const;
            Path GetThumbnailFilename(size_t index, bool refresh = false) const;
            Path GetThumbnailFilename(const String &id, bool refresh = false) const;

            class iterator: public std::iterator<std::input_iterator_tag, SBlock>
            {
                public:
                    iterator(const Document *d, size_t n):doc(d),num(n) { init_block(); }
                    iterator(const iterator &it):doc(it.doc),num(it.num) { init_block(); }
                    iterator(iterator&&) = default;
                    iterator& operator=(const iterator &it) { doc = it.doc; num = it.num;  init_block(); return *this; }
                    iterator& operator=(iterator&&) = default;
                    iterator& operator++() { num += 1; init_block(); return *this; }
                    iterator operator++(int nouse) { iterator it = *this; ++*this; return it; }
                    bool operator==(const iterator &it) const noexcept { return (doc == it.doc) && (num == it.num); }
                    bool operator!=(const iterator &it) const noexcept { return (doc != it.doc) || (num != it.num); }
                    value_type operator*() const noexcept { return b; }
                    value_type operator->() const noexcept { return b; }
                    size_t GetIndex() const noexcept { return num; }
                    String GetId() const { return doc->GetViewId(num); }
                    Path GetFilename() const { return doc->GetViewFilename(num); }
                private:
                    void init_block() { if (num < doc->views.size()) b = doc->GetView(num); else b = nullptr; }
                    const Document *doc;
                    SBlock b;
                    size_t num;
            };
            iterator begin() const { return iterator(this, 0); }
            iterator end() const { return iterator(this, views.size()); }

            static Path GetDefaultDirName();

#ifdef CRN_USING_HARU

            void ExportPDF(const Path &fname, const PDF::Attributes &attr = PDF::Attributes(), Progress *prog = nullptr) const;
#endif

            static size_t GetThumbWidth() noexcept;
            static size_t GetThumbHeight() noexcept;
            static void SetThumbWidth(size_t w);
            static void SetThumbHeight(size_t h);

        private:
            void addView(const Path &fname, const String &id);

            virtual Path completeFilename(const Path &fn) const override;
            virtual void load(const Path &fname) override;
            virtual void save(const Path &fname) override;

            UImage createThumbnail(const Path &imagename) const;

            String createNewId() const;
            struct view
            {
                view(const Path &fname = "", const String &unique_id = U""):filename(fname),id(unique_id) {}
                /* using default copy constructor */
                bool operator==(const view &other) const noexcept { return filename == other.filename; }
                Path filename; 
                String id; 
                mutable WBlock ptr; 
            };

            std::vector<view> views; 
            Path basename; 
            String author; 
            String date; 
            static const Path thumbdir; 
            static size_t thumbWidth; 
            static size_t thumbHeight; 
    };

    inline size_t Size(const Document &doc) noexcept { return doc.GetNbViews(); }
}
CRN_ADD_RANGED_FOR_TO_POINTERS(crn::Document)
#endif