File indexing completed on 2024-06-16 04:11:24

 /*
  *  SPDX-FileCopyrightText: 2017 Dmitry Kazakov <dimula73@gmail.com>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef KOSVGTEXTPROPERTIES_H
 #define KOSVGTEXTPROPERTIES_H
 
 #include "kritaflake_export.h"
 #include "KoFlakeTypes.h"
 
 #include <QScopedPointer>
 #include <QVariant>
 #include <QList>
 
 class SvgLoadingContext;
 class KoShapeBackground;
 
 /**
  * KoSvgTextProperties represents the text attributes defined in SVG DOM tree
  *
  * There is a limitation in flake: it doesn't support the inheritance of shape
  * properties: every shape stores all the properties that were defined at the
  * loading/creation stage. KoSvgTextProperties allows the user to compare
  * the properties of the two shapes and distinguish, which properties were
  * inherited by text shape, and which are its own. It is needed to generate a
  * correct and clean SVG/markup code that can be edited by the user easily.
  * Otherwise, every \<tspan\> block will contain the full list of 20+ attributes,
  * which are not interesting for the user, since they are inherited or default.
  *
  * To achieve the goal, KoSvgTextProperties wraps all the SVG attributes into a
  * map of QVariants. When the user need to find a set of unique properties
  * of the shape, it iterates through the map and compares values with standard
  * QVariant-based comparison operator. If the property value in a child and a
  * parent is not the same, then it is not inherited.
  */
 class KRITAFLAKE_EXPORT KoSvgTextProperties
 {
 public:
     /**
      * Defines a set of supported properties. See SVG 1.1 for details.
      */
     enum PropertyId {
         WritingModeId, ///< KoSvgText::WritingMode
         DirectionId, ///< KoSvgText::Direction
         UnicodeBidiId, ///< KoSvgText::UnicodeBidi
         TextAnchorId, ///< KoSvgText::TextAnchor
         DominantBaselineId, ///< KoSvgText::Baseline
         AlignmentBaselineId, ///< KoSvgText::Baseline
         BaselineShiftModeId, ///< KoSvgText::BaselineShiftMode
         BaselineShiftValueId, ///< Double
         KerningId, ///< KoSvgText::AutoValue
         TextOrientationId, ///< KoSvgText::TextOrientation
         LetterSpacingId, ///< KoSvgText::AutoValue
         WordSpacingId, ///< KoSvgText::AutoValue
 
         FontFamiliesId, ///< QStringList
         FontStyleId, ///< QFont::Style
         FontStretchId, ///< Int
         FontWeightId, ///< Int
         FontSizeId, ///< Double
         FontSizeAdjustId, ///< KoSvgText::AutoValue
 
         /// KoSvgText::FontVariantFeature
         FontVariantCommonLigId,
         FontVariantDiscretionaryLigId,
         FontVariantHistoricalLigId,
         FontVariantContextualAltId,
         FontVariantPositionId,
         FontVariantCapsId,
         FontVariantNumFigureId,
         FontVariantNumSpacingId,
         FontVariantNumFractId,
         FontVariantNumOrdinalId,
         FontVariantNumSlashedZeroId,
         FontVariantHistoricalFormsId,
         FontVariantEastAsianVarId,
         FontVariantEastAsianWidthId,
         FontVariantRubyId,
 
         FontFeatureSettingsId, ///< QStringList
         FontOpticalSizingId, ///< Bool
         FontVariationSettingsId, ///< QStringList
 
         TextDecorationLineId, ///< Flags, KoSvgText::TextDecorations
         TextDecorationStyleId, ///< KoSvgText::TextDecorationStyle
         TextDecorationColorId, ///< QColor
         TextDecorationPositionHorizontalId, ///< KoSvgText::TextDecorationUnderlinePosition
         TextDecorationPositionVerticalId, ///< KoSvgText::TextDecorationUnderlinePosition
         FillId, ///< KoSvgText::BackgroundProperty
         StrokeId, ///< KoSvgText::StrokeProperty
         Opacity, ///< Double, SVG shape opacity.
         PaintOrder, ///< QVector<KoShape::PaintOrder>
         Visiblity, ///< Bool, CSS visibility
 
         TextLanguage, ///< a language string.
 
         TextCollapseId, ///< KoSvgText::TextSpaceCollapse
         TextWrapId, ///< KoSvgText::TextWrap
         TextTrimId, ///< Flags, KoSvgText::TextSpaceTrims
         LineBreakId, ///< KoSvgText::LineBreak
         WordBreakId, ///< KoSvgText::WordBreak
         TextAlignAllId, ///< KoSvgText::TextAlign
         TextAlignLastId, ///< KoSvgText::TextAlign
         TextTransformId, ///< KoSvgText::TextTransformInfo Struct
         TextOverFlowId, ///< KoSvgText::WordBreak
         OverflowWrapId, ///<
         InlineSizeId, ///< KoSvgText::AutoValue
         LineHeightId, ///< KoSvgText::AutoValue
         TextIndentId, ///< KoSvgText::TextIndentInfo Struct.
         HangingPunctuationId, ///< Flags, KoSvgText::HangingPunctuations
         TabSizeId, ///< Int
 
         ShapePaddingId, ///< Double
         ShapeMarginId,  ///< Double
 
         KraTextVersionId ///< Int, used for handling incorrectly saved files.
     };
 
     KoSvgTextProperties();
     ~KoSvgTextProperties();
 
     KoSvgTextProperties(const KoSvgTextProperties &rhs);
     KoSvgTextProperties& operator=(const KoSvgTextProperties &rhs);
 
     /**
      * Set the property \p id to \p value
      */
     void setProperty(PropertyId id, const QVariant &value);
 
     /**
      * Check if property \p id is present in this properties set
      */
     bool hasProperty(PropertyId id) const;
 
     /**
      * Return the value of property \p id. If the property doesn't exist in
      * the shape, return \p defaultValue instead.
      */
     QVariant property(PropertyId id, const QVariant &defaultValue = QVariant()) const;
 
     /**
      * Remove property \p id from the set
      */
     void removeProperty(PropertyId id);
 
     /**
      * Return the value of property \p id. If the property doesn't exist in the
      * shape, return the default value define in SVG 1.1.
      */
     QVariant propertyOrDefault(PropertyId id) const;
 
     /**
      * Return a list of properties contained in this set
      */
     QList<PropertyId> properties() const;
 
     /**
      * Return true if the set contains no properties
      */
     bool isEmpty() const;
 
     /**
      * Reset all non-inheritable properties to default values. The set of
      * non-inheritable properties is define by SVG 1.1. Used by the loading
      * code for resetting state automata's properties on entering a \<tspan\>.
      */
     void resetNonInheritableToDefault();
 
 
     /**
      * Apply properties from the parent shape. The property is set **iff** the
      * property is inheritable according to SVG and this set does not define
      * it.
      */
     void inheritFrom(const KoSvgTextProperties &parentProperties);
 
     /**
      * Return true if the property \p id is inherited from \p parentProperties.
      * The property is considered "inherited" **iff* it is inheritable
      * according to SVG and the parent defined the same property with the same
      * value.
      */
     bool inheritsProperty(PropertyId id, const KoSvgTextProperties &parentProperties) const;
 
     /**
      * Return a set of properties that ar **not** inherited from \p
      * parentProperties. The property is considered "inherited" **iff* it is
      * inheritable according to SVG and the parent defined the same property
      * with the same value.
      * @param keepFontSize whether to keep the font size, use for root nodes
      * so that it won't be omitted and inheriting from the "default", which may
      * not be deterministic.
      */
     KoSvgTextProperties ownProperties(const KoSvgTextProperties &parentProperties, bool keepFontSize = false) const;
 
     /**
      * @brief parseSvgTextAttribute add a property according to an XML attribute value.
      * @param context shared loading context
      * @param command XML attribute name
      * @param value attribute value
      *
      * @see supportedXmlAttributes for a list of supported attributes
      */
     void parseSvgTextAttribute(const SvgLoadingContext &context, const QString &command, const QString &value);
 
     /**
      * Convert all the properties of the set into a map of XML attribute/value
      * pairs.
      */
     QMap<QString, QString> convertToSvgTextAttributes() const;
 
     /**
      * @brief convertParagraphProperties
      * some properties only apply to the root shape, so we write those separately.
      * @return
      */
     QMap<QString, QString> convertParagraphProperties() const;
 
     QFont generateFont() const;
 
     /**
      * @brief fontFeaturesForText
      * Returns a harfbuzz friendly list of opentype font-feature settings using
      * the various font-variant and font-feature-settings values.
      * @param start the start pos of the text.
      * @param length the length of the text.
      * @return a list of strings for font-features and their ranges that can be
      * understood by harfbuzz.
      */
     QStringList fontFeaturesForText(int start, int length) const;
 
     /**
      * @brief fontAxisSettings
      * This is used to configure variable fonts. It gets the appropriate values
      * from font width, stretch, style, size, if font-optical-sizing is not set
      * to 'none, and finally the font-variation-settings property.
      * @return a map of axis-tags and their values.
      */
     QMap<QString, qreal> fontAxisSettings() const;
 
     QSharedPointer<KoShapeBackground> background() const;
     KoShapeStrokeModelSP stroke() const;
 
     /**
      * Return a list of supported XML attribute names (defined in SVG)
      */
     static QStringList supportedXmlAttributes();
 
     /**
      * Return a static object that defines default values for all the supported
      * properties according to SVG
      */
     static const KoSvgTextProperties& defaultProperties();
 
 private:
     struct Private;
     const QScopedPointer<Private> m_d;
 };
 
 #endif // KOSVGTEXTPROPERTIES_H