X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Fvisual-model-impl.h;h=6356f32de5d05410f98a3b157d6fc8695581e633;hp=c8ea7e9a6211ff410ee54abeae09641130c6fd2c;hb=3a23cbcd64ab5780928e4a141e497242c9989110;hpb=56d412791a44c2a79135d2293c13fddb135c9d54 diff --git a/dali-toolkit/internal/text/visual-model-impl.h b/dali-toolkit/internal/text/visual-model-impl.h index c8ea7e9..6356f32 100644 --- a/dali-toolkit/internal/text/visual-model-impl.h +++ b/dali-toolkit/internal/text/visual-model-impl.h @@ -2,7 +2,7 @@ #define __DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H__ /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,24 +21,23 @@ // EXTERNAL INCLUDES #include #include +#include #include #include // INTERNAL INCLUDES #include +#include namespace Dali { -struct Vector2; - namespace Toolkit { namespace Text { -struct LineRun; class VisualModel; typedef IntrusivePtr VisualModelPtr; @@ -63,43 +62,28 @@ public: // Glyph interface. /** - * @brief Replaces any glyphs previously set. - * - * @note If the number of glyphs is zero, all buffers are cleared. - * @note If one pointer is NULL and the number of glyphs is not zero, the buffer is not touched. - * - * @param[in] glyphs An array of glyphs in the visual order. - * @param[in] characterIndices An array containing the first character in the logical model that each glyph relates to. - * @param[in] charactersPerGlyph An array containing the number of characters per glyph. - * @param[in] numberOfGlyphs The number of glyphs. - */ - void SetGlyphs( const GlyphInfo* glyphs, - const CharacterIndex* characterIndices, - const Length* charactersPerGlyph, - Length numberOfGlyphs ); - - /** * @brief Creates the character to glyph conversion table. * * @pre The glyphs per character table needs to be created first. * + * @param[in] startIndex The character from where the conversion table is created. + * @param[in] startGlyphIndex The glyph from where the conversion table is created. * @param[in] numberOfCharacters The number of characters. */ - void CreateCharacterToGlyphTable( Length numberOfCharacters = 0u ); + void CreateCharacterToGlyphTable( CharacterIndex startIndex, + GlyphIndex startGlyphIndex, + Length numberOfCharacters ); /** * @brief Creates an array containing the number of glyphs per character. * + * @param[in] startIndex The character from where the table is created. + * @param[in] startGlyphIndex The glyph from where the conversion table is created. * @param[in] numberOfCharacters The number of characters. */ - void CreateGlyphsPerCharacterTable( Length numberOfCharacters = 0u ); - - /** - * Retrieves the number of glyphs. - * - * @return The number of glyphs. - */ - Length GetNumberOfGlyphs() const; + void CreateGlyphsPerCharacterTable( CharacterIndex startIndex, + GlyphIndex startGlyphIndex, + Length numberOfCharacters ); /** * @brief Retrieves glyphs in the given buffer. @@ -113,133 +97,9 @@ public: GlyphIndex glyphIndex, Length numberOfGlyphs ) const; - /** - * Retrieves a glyph. - * - * @param[in] glyphIndex Index to a glyph. - * - * @return A glyph. - */ - const GlyphInfo& GetGlyphInfo( GlyphIndex glyphIndex ) const; - - /** - * Replaces glyphs. - * - * If the @p numberOfGlyphsToRemove is zero, this operation is like an insert. - * If the @p numberOfGlyphsToInsert is zero, this operation is like a remove. - * - * @param[in] glyphIndex Where to replace the glyphs. - * @param[in] numberOfGlyphsToRemove The number of glyphs to be removed. - * @param[in] glyphs Pointer to a buffer with the new glyphs. - * @param[in] numberOfCharacters Pointer to a buffer with the number of characters per glyph. - * @param[in] numberOfGlyphsToInsert The number of new glyphs in the buffer. - */ - void ReplaceGlyphs( GlyphIndex glyphIndex, - Length numberOfGlyphsToRemove, - const GlyphInfo* const glyphs, - const Length* const numberOfCharacters, - Length numberOfGlyphsToInsert ); - - // Character <--> Glyph conversion - - /** - * @brief Retrieves the first character in the logical model which a glyph represents. - * - * @note After shaping several characters may be represented by the same glyph. - * Alternatively several glyphs may be required to display a character. - * @param[in] glyphIndex The glyph index. - * @return The character index. - */ - CharacterIndex GetCharacterIndex( GlyphIndex glyphIndex ) const; - - /** - * @brief Query the number of characters the glyph represents. - * - * @param[in] glyphIndex The glyph index. - * @return The number of characters represented by the glyph. - */ - Length GetCharactersPerGlyph( GlyphIndex glyphIndex ) const; - - /** - * Retrieves the first glyph in the visual model which represents a given character. - * - * @note After shaping several characters may be represented by the same glyph. - * Alternatively several glyphs may be required to display a character. - * @param[in] characterIndex The character index. - * @return The glyph index. - */ - GlyphIndex GetGlyphIndex( CharacterIndex characterIndex ) const; - - /** - * Retrieves the whole or part of the character to glyph conversion map. - * - * The size of the buffer needs to be big enough to copy the @p numberOfCharacters. - * - * @param[out] characterToGlyphMap Pointer to a buffer where the conversion map is copied. - * @param[in] characterIndex Index to the first character. - * @param[in] numberOfCharacters The number of characters. - */ - void GetCharacterToGlyphMap( GlyphIndex* characterToGlyphMap, - CharacterIndex characterIndex, - Length numberOfCharacters ) const; - - /** - * Retrieves the whole or part of the glyph to character conversion map. - * - * The size of the buffer needs to be big enough to copy the @p numberOfGlyphs. - * - * @param[out] glyphToCharacter Pointer to a buffer where the conversion map is copied. - * @param[in] glyphIndex Index to the first glyph. - * @param[in] numberOfGlyphs The number of glyphs. - */ - void GetGlyphToCharacterMap( CharacterIndex* glyphToCharacter, - GlyphIndex glyphIndex, - Length numberOfGlyphs ) const; - - /** - * Retrieves for each glyph the number of characters the glyph represents. - * - * @param[out] charactersPerGlyph Pointer to a buffer where the number of characters for each glyph are copied. - * @param[in] glyphIndex Index to the first glyph. - * @param[in] numberOfGlyphs The number of glyphs. - */ - void GetCharactersPerGlyphMap( Length* charactersPerGlyph, - GlyphIndex glyphIndex, - Length numberOfGlyphs ) const; - - /** - * Retrieves for each character the number of glyphs the character is shaped. - * - * @param[out] glyphsPerCharacter Pointer to a buffer where the number of glyphs for each character are copied. - * @param[in] characterIndex Index to the first character. - * @param[in] numberOfCharacters The number of characters. - */ - void GetGlyphsPerCharacterMap( Length* glyphsPerCharacter, - CharacterIndex characterIndex, - Length numberOfCharacters ) const; - // Position interface /** - * @brief Replaces any glyph positions previously set. - * - * @note If the number of glyphs is zero the position buffer is cleared. - * - * @param[in] glyphPositions An array of visual positions for each glyph. - * @param[in] numberOfGlyphs The number of positions. - */ - void SetGlyphPositions( const Vector2* glyphPositions, - Length numberOfGlyphs ); - - /** - * Retrieves the number of glyph positions set. - * - * @note This may be less than the number of glyphs in the model. - * @return The number of glyphs. - */ - Length GetNumberOfGlyphPositions() const; - - /** * @brief Retrieves the glyph positions. * * @pre The size of the @p positions buffer needs to be big enough to copy the @p numberOfGlyphs positions. @@ -251,70 +111,10 @@ public: GlyphIndex glyphIndex, Length numberOfGlyphs ) const; - /** - * Retrieve the glyph's position of the given glyph. - * - * @param[in] glyphIndex Index to the glyph. - * - * @return The glyph's position. - */ - const Vector2& GetGlyphPosition( GlyphIndex glyphIndex ) const; - - /** - * Replaces glyph's positions. - * - * If the @p numberOfGlyphsToRemove is zero, this operation is like an insert. - * If the @p numberOfGlyphsToInsert is zero, this operation is like a remove. - * - * @param[in] glyphIndex Where to replace the glyph's positions. - * @param[in] numberOfGlyphsToRemove The number of glyph's positions to be removed. - * @param[in] positions Pointer to a buffer with the new glyph's positions. - * @param[in] numberOfGlyphsToInsert The number of new glyph's positions in the buffer. - */ - void ReplaceGlyphPositions( GlyphIndex glyphIndex, - Length numberOfGlyphsToRemove, - const Vector2* const positions, - Length numberOfGlyphsToInsert ); - // Line interface. /** - * Sets the lines. - * - * Replaces any lines previously set. - * - * Every line is an item run containing the index to the first glyph of the line and the number of glyphs. - * - * @note If the number of lines is zero or the pointer is NULL, the lines buffer is cleared. - * - * @param[in] lines Pointer to a buffer containing all the line runs. - * @param[in] numberOfLines The number of lines in the buffer. - */ - void SetLines( const LineRun* const lines, - Length numberOfLines ); - - /** - * Retrieves the number of lines of the whole text. - * - * @return The number of lines. - */ - Length GetNumberOfLines() const; - - /** - * Retrieves lines. - * - * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines. - * - * @param[out] lines Pointer to a buffer where the lines are copied. - * @param[in] lineIndex Index to the first line. - * @param[in] numberOfLines Number of lines to be copied. - */ - void GetLines( LineRun* lines, - LineIndex lineIndex, - Length numberOfLines ) const; - - /** - * Retrieves the number of lines and the index to the first line where the given range of glyphs is laid out. + * @brief Retrieves the number of lines and the index to the first line where the given range of glyphs is laid out. * * @param[in] glyphIndex Index to the first glyph. * @param[in] numberOfGlyphs The number of glyph. @@ -325,8 +125,9 @@ public: Length numberOfGlyphs, LineIndex& firstLine, Length& numberOfLines ) const; + /** - * Retrieves the lines where the given range of glyphs is laid out. + * @brief Retrieves the lines where the given range of glyphs is laid out. * * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines. * @@ -339,50 +140,56 @@ public: Length numberOfGlyphs ) const; /** - * Replaces lines for the given range of glyphs. + * @brief Retrieves the line index where the character is laid-out. * - * If the @p numberOfGlyphsToRemove is zero, this operation is like an insert. - * If the @p numberOfGlyphsToInsert is zero, this operation is like a remove. + * @param[in] characterIndex The character's index. * - * @param[in] glyphIndex Index of the first glyph where to replace the line info. - * @param[in] numberOfGlyphsToRemove The number of glyphs to be the line info removed. - * @param[in] lines Pointer to a buffer with the lines. - * @param[in] numberOfGlyphsToInsert The number of characters to be the line info inserted. + * @return The line index. */ - void ReplaceLines( GlyphIndex glyphIndex, - Length numberOfGlyphsToRemove, - const LineRun* const lines, - Length numberOfGlyphsToInsert ); + LineIndex GetLineOfCharacter( CharacterIndex characterIndex ); + + // Underline runs + + /** + * @brief Retrieves the underline runs. + * + * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied. + * @param[in] index Index of the first underline run to be copied. + * @param[in] numberOfRuns Number of underline runs to be copied. + */ + void GetUnderlineRuns( GlyphRun* underlineRuns, + UnderlineRunIndex index, + Length numberOfRuns ) const; // Size interface /** - * Sets the natural size. + * @brief Sets the natural size. * * @param[in] size The text's natural size. */ void SetNaturalSize( const Vector2& size ); /** - * Retrieves the natural size. + * @brief Retrieves the natural size. * * @return The text's natural size. */ const Vector2& GetNaturalSize() const; /** - * Sets the text's actual size after it has been laid out. + * @brief Sets the text's layout size. * * @param[in] size The text's size. */ - void SetActualSize( const Vector2& size ); + void SetLayoutSize( const Vector2& size ); /** - * Retrieves the text's actual size after it has been laid out. + * @brief Retrieves the text's layout size. * * @return The text's size. */ - const Vector2& GetActualSize() const; + const Vector2& GetLayoutSize() const; /** * @brief Set the text's color @@ -454,6 +261,32 @@ public: */ bool IsUnderlineEnabled() const; + /** + * @brief Clear the caches. + */ + void ClearCaches(); + + /** + * @brief Set the override used for underline height, 0 indicates height will be come from font metrics + * + * @param[in] height The height in pixels of the underline + */ + void SetUnderlineHeight( float height ); + + /** + * @brief Retrieves the underline height override + * + * @return Returns the override height for an underline, 0 indicates that font metrics will determine the height + */ + float GetUnderlineHeight() const; + + /** + * @brief Retrieves the number of underline runs. + * + * @return The number of underline runs. + */ + Length GetNumberOfUnderlineRuns() const; + protected: /** @@ -483,18 +316,29 @@ public: Vector mGlyphsPerCharacter; ///< For each character, the number of glyphs that are shaped. Vector mGlyphPositions; ///< For each glyph, the position. Vector mLines; ///< The laid out lines. + Vector mUnderlineRuns; ///< Runs of glyphs that are underlined. + Vector mColors; ///< Colors of the glyphs. + Vector mColorIndices; ///< Indices to the vector of colors for each glyphs. Vector4 mTextColor; ///< The text color - Vector2 mShadowOffset; ///< Offset for drop shadow, 0 indicates no shadow Vector4 mShadowColor; ///< Color of drop shadow Vector4 mUnderlineColor; ///< Color of underline - bool mUnderlineEnabled:1; ///< Underline enabled flag - bool mUnderlineColorSet:1; ///< Has the underline color been explicitly set? + Size mControlSize; ///< The size of the UI control. + Vector2 mShadowOffset; ///< Offset for drop shadow, 0 indicates no shadow + float mUnderlineHeight; ///< Fixed height for underline to override font metrics. private: Size mNaturalSize; ///< Size of the text with no line wrapping. - Size mActualSize; ///< Size of the laid-out text considering the layout properties set. + Size mLayoutSize; ///< Size of the laid-out text considering the layout properties set. + + // Caches to increase performance in some consecutive operations. + LineIndex mCachedLineIndex; ///< Used to increase performance in consecutive calls to GetLineOfGlyph() or GetLineOfCharacter() with consecutive glyphs or characters. + +public: + + bool mUnderlineEnabled:1; ///< Underline enabled flag + bool mUnderlineColorSet:1; ///< Has the underline color been explicitly set? }; } // namespace Text