CRNAltoTextBlock.hpp

Go to the documentation of this file.

/* Copyright 2011-2016 CoReNum
 * 
 * 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: CRNAltoTextBlock.h
 * \author Yann LEYDIER
 */

#ifdef CRNAlto_HEADER

class TextBlock: public Block
{
    public:
        TextBlock(const TextBlock&) = delete;
        TextBlock(TextBlock&&) = default;
        virtual ~TextBlock() override {}
        TextBlock& operator=(const TextBlock&) = delete;
        TextBlock& operator=(TextBlock&&) = default;

        Option<StringUTF8> GetLanguage() const;

        class TextLine: public Element
        {
            public:
                TextLine(const TextLine&) = delete;
                TextLine(TextLine&&) = default;
                virtual ~TextLine() override {}
                TextLine& operator=(const TextLine&) = delete;
                TextLine& operator=(TextLine&&) = default;

                const Id& GetId() const { return id; }

                std::vector<Id> GetStyles() const;
                void AddStyle(const Id &styleid);
                void RemoveStyle(const Id &styleid);

                double GetWidth() const;
                void SetWidth(double d);
                double GetHeight() const;
                void SetHeight(double d);
                double GetHPos() const;
                void SetHPos(double d);
                double GetVPos() const;
                void SetVPos(double d);
                Option<double> GetBaseline() const;
                void SetBaseline(double d, bool check_bounds = true);
                void UnsetBaseline();
                Option<bool> GetManuallyCorrected() const;
                void SetManuallyCorrected(bool c);
                void UnsetManuallyCorrected();

                class LineElement: public Element
                {
                    public:
                        LineElement(const LineElement&) = delete;
                        LineElement(LineElement&&) = default;
                        virtual ~LineElement() override {}
                        LineElement& operator=(const LineElement&) = delete;
                        LineElement& operator=(LineElement&&) = default;

                        Option<double> GetWidth() const;
                        void SetWidth(double d);
                        Option<double> GetHPos() const;
                        void SetHPos(double d);
                        Option<double> GetVPos() const;
                        void SetVPos(double d);

                    protected:
                        LineElement(const Element &el);
                        LineElement(const Element &el, const Option<double> &x, const Option<double> &y, const Option<double> &w);
                };
                typedef std::weak_ptr<LineElement> LineElementPtr;

                std::vector<LineElementPtr> GetLineElements() const;
                size_t GetNbLineElements() const { return lineElements.size(); }

                class Word: public LineElement
                {
                    public:
                        Word(const Word&) = delete;
                        Word(Word&&) = default;
                        virtual ~Word() override {}
                        Word& operator=(const Word&) = delete;
                        Word& operator=(Word&&) = default;

                        const Option<Id>& GetId() const { return id; }

                        std::vector<Id> GetStyles() const;
                        void AddStyle(const Id &styleid);
                        void RemoveStyle(const Id &styleid);

                        StringUTF8 GetContent() const;
                        void SetContent(const StringUTF8 &s);
                        Option<double> GetHeight() const;
                        void SetHeight(double d);
                        Option<Alto::Styles::Text::FontStyle> GetFontStyle() const;
                        void SetFontStyle(Alto::Styles::Text::FontStyle fs);
                        void UnsetFontStyle();
                        enum class SubstitutionType { Undef = 0, HypPart1, HypPart2, Abbreviation };
                        Option<SubstitutionType> GetSubstitutionType() const;
                        Option<StringUTF8> GetSubstitutionContent() const;
                        void SetSubstitution(SubstitutionType stype, const StringUTF8 &scontent);
                        Option<double> GetWC() const;
                        void SetWC(double conf);
                        Option<StringUTF8> GetCC() const;
                        void UnsetWC();
                        // TODO alternatives

                    private:
                        Word(const Element &el);
                        Word(const Element &el, const Id &id_, const StringUTF8 &text, const Option<double> &x, const Option<double> &y, const Option<double> &w, const Option<double> &h);

                        Option<Id> id;
                    friend class TextLine;
                };
                typedef std::weak_ptr<Word> WordPtr;

                const std::vector<WordPtr>& GetWords() const;
                size_t GetNbWords() const { return words.size(); }
                Word& GetWord(const Id &id_);
                Word& AddWord(const Id &id_, const StringUTF8 &text, const Option<double> &x = Option<double>(), const Option<double> &y = Option<double>(), const Option<double> &w = Option<double>(), const Option<double> &h = Option<double>());
                Word& AddWordAfter(const Id &pred, const Id &id_, const StringUTF8 &text, const Option<double> &x = Option<double>(), const Option<double> &y = Option<double>(), const Option<double> &w = Option<double>(), const Option<double> &h = Option<double>());
                Word& AddWordBefore(const Id &next, const Id &id_, const StringUTF8 &text, const Option<double> &x = Option<double>(), const Option<double> &y = Option<double>(), const Option<double> &w = Option<double>(), const Option<double> &h = Option<double>());

                void RemoveWord(const Id &wid);

                class WhiteSpace: public LineElement
                {
                    public:
                        WhiteSpace(const WhiteSpace&) = delete;
                        WhiteSpace(WhiteSpace&&) = default;
                        virtual ~WhiteSpace() override {}
                        WhiteSpace& operator=(const WhiteSpace&) = delete;
                        WhiteSpace& operator=(WhiteSpace&&) = default;

                        const Option<Id>& GetId() const { return id; }

                    private:
                        WhiteSpace(const Element &el);

                        Option<Id> id;

                    friend class TextLine;
                };
                typedef std::weak_ptr<WhiteSpace> WhiteSpacePtr;

                class Hyphen: public LineElement
                {
                    public:
                        Hyphen(const Hyphen&) = delete;
                        Hyphen(Hyphen&&) = default;
                        virtual ~Hyphen() override {}
                        Hyphen& operator=(const Hyphen&) = delete;
                        Hyphen& operator=(Hyphen&&) = default;

                        StringUTF8 GetContent() const;
                        void SetContent(const StringUTF8 &s);

                    private:
                        Hyphen(const Element &el);

                    friend class TextLine;
                };
                typedef std::weak_ptr<Hyphen> HyphenPtr;

            private:
                TextLine(const Element &el);
                TextLine(const Element &el, const Id &id_, double x, double y, double w, double h);
                void update_subelements();

                Id id;
                mutable std::vector<std::shared_ptr<LineElement> > lineElements;
                mutable std::vector<WordPtr> words;
                mutable std::map<Id, WordPtr> id_words;

            friend class TextBlock;
        };
        typedef std::weak_ptr<TextLine> TextLinePtr;

        std::vector<TextLinePtr> GetTextLines() const;
        size_t GetNbTextLines() const { return lines.size(); }
        TextLine& GetTextLine(const Id &id_);
        TextLine& AddTextLine(const Id &id_, double x, double y, double w, double h);
        TextLine& AddTextLineAfter(const Id &pred, const Id &id_, double x, double y, double w, double h);
        TextLine& AddTextLineBefore(const Id &next, const Id &id_, double x, double y, double w, double h);

        void RemoveTextLine(const Id &tid);

    private:
        TextBlock(const Element &el);
        TextBlock(const Element &el, const Id &id_, int x, int y, int w, int h);
        void update_subelements();

        std::vector<std::shared_ptr<TextLine> > lines;
        std::map<Id, TextLinePtr> id_lines;
    
    friend class Space;
};
#else
#error  you cannot include this file directly
#endif