storytext.h

/*
 For general Scribus (>=1.3.2) copyright and licensing information please refer
 to the COPYING file provided with the program. Following this notice may exist
 a copyright and/or license notice that predates the release of Scribus 1.3.2
 for which a new license (GPL+exception) is in place.
 */
/***************************************************************************
pageitem.cpp  -  description
-------------------
    begin                : Sat Apr 7 2001
    copyright            : (C) 2001 by Franz Schmid
    email                : Franz.Schmid@altmuehlnet.de
    ***************************************************************************/

/***************************************************************************
*                                                                         *
*   This program 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.                                   *
*                                                                         *
***************************************************************************/


#ifndef STORYTEXT_H_
#define STORYTEXT_H_

#include <QObject>
#include <QString>
#include <QList>
#include <cassert>

#include "marks.h"
//#include "text/paragraphlayout.h"
#include "text/frect.h"
#include "text/specialchars.h"
#include "sctextstruct.h"
#include "style.h"
#include "styles/charstyle.h"
#include "styles/paragraphstyle.h"
#include "desaxe/saxio.h"


class CharStyle;
class ParagraphStyle;
class PageItem;
//class ScTextEngine;
//class ScScriptItem;
class ScribusDoc;
class ScText_Shared;
class ResourceCollection;
 


class SCRIBUS_API StoryText : public QObject, public SaxIO
{
    Q_OBJECT
    
 public:
    StoryText(ScribusDoc *doc);
    StoryText();
    StoryText(const StoryText & other);
    StoryText& operator= (const StoryText & other);
    virtual ~StoryText();
    void setDoc(ScribusDoc *docin);
    
    static const Xml_string saxxDefaultElem;
    static void  desaxeRules(const Xml_string& prefixPattern, desaxe::Digester& ruleset, Xml_string elemtag = saxxDefaultElem);
    
    virtual void saxx(SaxHandler& handler, const Xml_string& elemtag) const;
    virtual void saxx(SaxHandler& handler)                     const { saxx(handler, saxxDefaultElem); }
    
    int  cursorPosition() const;
    void setCursorPosition(int pos, bool relative = false);
    void normalizeCursorPosition();
    int  normalizedCursorPosition();

    void clear();
    StoryText copy() const;

    // Find text in story
    int indexOf(const QString &str, int from = 0, Qt::CaseSensitivity cs = Qt::CaseSensitive) const;
    int indexOf(QChar ch, int from = 0, Qt::CaseSensitivity cs = Qt::CaseSensitive) const;
    
    // Add, change, replace
    // Insert chars from another StoryText object at current cursor position
    void insert(const StoryText& other, bool onlySelection = false);
    // Insert chars from another StoryText object at specific position
    void insert(int pos, const StoryText& other, bool onlySelection = false);
    // Append chars from another StoryText object
    void append(const StoryText& other) { insert(length(), other, false); }
    // Remove len chars at specific position
    void removeChars(int pos, uint len);
    // Removes trailing empty paragraphs
    void trim();
    // Insert chars at current cursor position
    void insertChars(QString txt, bool applyNeighbourStyle = false);
    // Insert chars ar specific position
    void insertChars(int pos, QString txt, bool applyNeighbourStyle = false);
    // Insert inline object at current cursor position
    void insertObject(int obj);
    // Insert object at specific position
    void insertObject(int pos, int obj);
    // Insert mark at cursor or specific position
    void insertMark(Mark* Mark, int pos = -1);
    void replaceChar(int pos, QChar ch);
    // Replaced a word, and return the difference in length between old and new
    int replaceWord(int pos, QString newWord);
    void replaceObject(int pos, int obj);

    void hyphenateWord(int pos, uint len, char* hyphens);
    
    // Retrieve length of story text
    int length() const;

    // Get content at specific position as plain text
    // Internal paragraph separator are converted to 
    // unix new lines for better compatibility with
    // text editors
    QString plainText() const;

    // Get char at current cursor position
    QChar   text() const;
    // Get char at specific position
    QChar   text(int pos) const;
    // Get text with len chars at specific position
    QString text(int pos, uint len) const;
    //Get sentence at any position within it
    QString sentence(int pos, int &posn);
    // Get word at specific position
    QString wordAt(int pos) const;

    bool hasObject(int pos) const;
    PageItem* object(int pos) const;
    bool hasMark(int pos, Mark* mrk = NULL) const;
    Mark *mark(int pos) const;
    void replaceMark(int pos, Mark* mrk);

    // Get charstyle at current cursor position
    const CharStyle& charStyle() const;
    // Get charstyle at specific position
    const CharStyle& charStyle(int pos) const;
    // Get paragraph style at current cursor position
    const ParagraphStyle& paragraphStyle() const;
    // Get paragraph style at specific position
    const ParagraphStyle& paragraphStyle(int pos) const;
    const ParagraphStyle& defaultStyle() const;
    void setDefaultStyle(const ParagraphStyle& style);
    void setCharStyle(int pos, uint len, const CharStyle& style);
    void setStyle(int pos, const ParagraphStyle& style);
    void applyCharStyle(int pos, uint len, const CharStyle& style);
    void applyStyle(int pos, const ParagraphStyle& style, bool rmDirectFormatting = false);
    void eraseCharStyle(int pos, uint len, const CharStyle& style);
    void eraseStyle(int pos, const ParagraphStyle& style);
    void replaceStyles(QMap<QString,QString> newNameForOld);
    void replaceCharStyles(QMap<QString,QString> newNameForOld);

    // Cleanup legacy formatting for whole story, ie remove direct
    // formatting for parameters already set at paragraph level
    void fixLegacyFormatting();
    
    // Cleanup legacy formatting for paragraph at position pos
    void fixLegacyFormatting(int pos);
    
    void getNamedResources(ResourceCollection& lists) const;
    void replaceNamedResources(ResourceCollection& newNames);
    
    uint nrOfParagraphs() const;
    int startOfParagraph() const;
    int startOfParagraph(uint index) const;
    int endOfParagraph() const;
    int endOfParagraph(uint index) const;
    uint nrOfParagraph() const;
    uint nrOfParagraph(int pos) const;

    uint nrOfRuns() const;
    int startOfRun(uint index) const;
    int endOfRun(uint index) const;

// positioning
    int nextChar(int pos);
    int prevChar(int pos);
    int firstWord();
    int nextWord(int pos);
    int prevWord(int pos);
    int endOfWord(int pos) const;
    int nextSentence(int pos);
    int prevSentence(int pos);
    int nextParagraph(int pos);
    int prevParagraph(int pos);

// these need valid layout:

//  int startOfLine(int pos);
//  int endOfLine(int pos);
//  int prevLine(int pos);
//  int nextLine(int pos);
//  int startOfFrame(int pos);
//  int endOfFrame(int pos);

// selection

    void selectAll();
    void deselectAll();
    void removeSelection();
    void extendSelection(int oldPos, int newPos);
    int selectWord(int pos);
    void select(int pos, uint len, bool on = true);
    bool selected(int pos) const;
    int startOfSelection() const;
    int endOfSelection() const;
    int lengthOfSelection() const;


// layout helpers

    GlyphLayout* getGlyphs(int pos);
    const GlyphLayout* getGlyphs(int pos) const;
    LayoutFlags flags(int pos) const;
    bool hasFlag(int pos, LayoutFlags flag) const;
    void setFlag(int pos, LayoutFlags flag);
    void clearFlag(int pos, LayoutFlags flag);

//  when physical view doesn't match logical view any more:

    void invalidateObject(const PageItem* embedded);
    void invalidateLayout();

public slots:
    void invalidateAll();

signals:
        void changed();

private:
    ScText * item(uint index);
    const ScText * item(uint index) const;

//public:
//  ScText * item_p(uint index) { return item(index); }

//  int screenToPosition(FPoint coord) const;
//  FRect  boundingBox(int pos, uint len = 1) const;

//  uint lines() const { return (uint) m_lines.count(); }
    
//  LineSpec line(uint i) const { return m_lines[i]; }
    

private:
    ScribusDoc * m_doc; 
    int m_selFirst, m_selLast;
//  int m_firstFrameItem, m_lastFrameItem;
//  QList<LineSpec> m_lines;
//  bool m_validLayout;
//  qreal m_magicX;
//  int m_lastMagicPos;

    QString textWithSoftHyphens (int pos, uint len) const;
    void    insertCharsWithSoftHyphens(int pos, QString txt, bool applyNeighbourStyle = false);
    
    void invalidate(int firstRun, int lastRun);
    void removeParSep(int pos);
    void insertParSep(int pos);

    //  int splitRun(int pos);
    
//  void validate();
    ScText_Shared * d;
//  uint layouterVersion;
//  bool layouterValid;
 };


#endif /*STORYTEXT_H_*/