charstyle.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.
 */
/***************************************************************************
*                                                                         *
*   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 CHARSTYLE_H
#define CHARSTYLE_H


#include "style.h"

class ResourceCollection;

enum StyleFlagValue {
    ScStyle_None          = 0,
    ScStyle_Default       = 0,
    ScStyle_Superscript   = 1,
    ScStyle_Subscript     = 2,
    ScStyle_Outline       = 4,
    ScStyle_Underline     = 8,
    ScStyle_Strikethrough = 16,
    ScStyle_AllCaps       = 32,
    ScStyle_SmallCaps     = 64,
    ScStyle_HyphenationPossible=128, //Hyphenation possible here (Soft Hyphen)
    ScStyle_Shadowed      = 256,
    ScStyle_UnderlineWords= 512,
    xScStyle_Reserved01    = 1024, //free, not used in the moment
    xScStyle_DropCap       = 2048,
    xScStyle_SuppressSpace = 4096,//internal use in PageItem (Suppresses spaces when in Block alignment)
    xScStyle_SoftHyphenVisible=8192, //Soft Hyphen visible at line end
    xScStyle_StartOfLine   = 16384,
    ScStyle_UserStyles    = 1919, // == 1024 + 512 + 256 + 64 + 32 + 16 + 8 + 4 + 2 + 1
    ScStyle_NonUserStyles = 30848, // == 128 + 2048 + 4096 + 8192 + 16384
    ScStyle_All           = 65535
};

class SCRIBUS_API StyleFlag
{
public:

    StyleFlagValue value;

    StyleFlag(void) { value = ScStyle_Default; }
    StyleFlag(StyleFlagValue val) { value = val; }
    StyleFlag(int val) { value = static_cast<StyleFlagValue>(val); }

    operator StyleFlagValue() const { return value; }

    QStringList featureList() const; 
    
    StyleFlag& operator=  (StyleFlagValue val) { value = val; return *this;}
    StyleFlag& operator&= (const StyleFlag& right);
    StyleFlag& operator|= (const StyleFlag& right);
    StyleFlag  operator&  (const StyleFlag& right);
    StyleFlag  operator&  (int right);
    StyleFlag  operator|  (const StyleFlag& right);
    StyleFlag  operator^  (const StyleFlag& right);
    StyleFlag  operator^  (int right);
    StyleFlag  operator~  ();

    bool operator== (const StyleFlag& right) const;
    bool operator== (const StyleFlagValue right) const;
    bool operator== (int right) const;
    bool operator!= (const StyleFlag& right) const;
    bool operator!= (const StyleFlagValue right) const;
};

class SCRIBUS_API CharStyle : public Style {
public:

    static const QString INHERIT;
    static const QString BOLD;
    static const QString ITALIC;
    static const QString UNDERLINE;
    static const QString UNDERLINEWORDS;
    static const QString STRIKETHROUGH;
    static const QString SUPERSCRIPT;
    static const QString SUBSCRIPT;
    static const QString OUTLINE;
    static const QString SHADOWED;
    static const QString ALLCAPS;
    static const QString SMALLCAPS;

    CharStyle() : Style() {
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
        m_##attr_NAME = attr_DEFAULT; \
        inh_##attr_NAME = true;
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
        m_isDefaultStyle=false;
    };
    
    CharStyle(const ScFace& font, int size, StyleFlag style = ScStyle_Default) : Style() {
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
        m_##attr_NAME = attr_DEFAULT; \
        inh_##attr_NAME = true;
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
        m_isDefaultStyle=false;
        setFont(font);
        setFontSize(size);
        setEffects(style);
    };
    
    CharStyle(const CharStyle & other);
    
    CharStyle & operator=(const CharStyle & other);
    
    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); }
    

    void getNamedResources(ResourceCollection& lists) const;
    void replaceNamedResources(ResourceCollection& newNames);

    QString displayName() const;

    void update(const StyleContext * b);
    
    void updateFeatures();
    
    bool equiv(const Style& other) const;   
    
    void applyCharStyle(const CharStyle & other);
    void eraseCharStyle(const CharStyle & other);
    void setStyle(const CharStyle & other);
    void erase() { eraseCharStyle(*this); }
    void eraseDirectFormatting();
    
    QString asString() const;
    
    const StyleFlag effects() const { validate(); return m_Effects; }
    void setEffects(StyleFlag flags) { m_Effects = flags; }
    
    
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
    const attr_TYPE &attr_GETTER() const { validate(); return m_##attr_NAME; }
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
    
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
    void set##attr_NAME(attr_TYPE v) { m_##attr_NAME = v; inh_##attr_NAME = false; }
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
    
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
    void reset##attr_NAME() { m_##attr_NAME = attr_DEFAULT; inh_##attr_NAME = true; }
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
    
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
    bool isInh##attr_NAME() const { return inh_##attr_NAME; }
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
    
    
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
    bool isDef##attr_NAME() const { \
        if ( !inh_##attr_NAME ) return true; \
        const CharStyle * par = dynamic_cast<const CharStyle*>(parentStyle()); \
        return par && par->isDef##attr_NAME(); \
    }
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
    
    
private:

    void runFeatures(const QStringList& featurelist, const CharStyle* parent);
    
    StyleFlag m_Effects;
    // member declarations:
        
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
    attr_TYPE m_##attr_NAME; \
    bool inh_##attr_NAME;
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
};


inline CharStyle & CharStyle::operator=(const CharStyle & other)
{
    static_cast<Style&>(*this) = static_cast<const Style&>(other);
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
    m_##attr_NAME = other.m_##attr_NAME; \
    inh_##attr_NAME = other.inh_##attr_NAME;
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
    m_Effects = other.m_Effects;
//  m_context = NULL;
    m_contextversion = -1;
    return *this;
}

inline CharStyle::CharStyle(const CharStyle & other) : Style(other) 
{
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT) \
    m_##attr_NAME = other.m_##attr_NAME; \
    inh_##attr_NAME = other.inh_##attr_NAME;
#include "charstyle.attrdefs.cxx"
#undef ATTRDEF
    m_Effects = other.m_Effects;
//  m_context = NULL;
    m_contextversion = -1;
}

#endif