base/dali-toolkit/internal/controls/text-input/text-input-text-highlight-impl.cpp

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/controls/text-input/text-input-text-highlight-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <math.h>
  23 #include <sstream>
  24 #include <algorithm>
  25 #include <libintl.h>
  26 #include <dali/integration-api/debug.h>
  27
  28 // INTERNAL INCLUDES
  29
  30 using namespace Dali;
  31 using namespace std;
  32
  33 namespace
  34 {
  35   /**
  36    * Selection state enumeration (FSM)
  37    */
  38   enum SelectionState
  39   {
  40     SelectionNone,                            ///< Currently not encountered selected section.
  41     SelectionStarted,                         ///< Encountered selected section
  42     SelectionFinished                         ///< Finished selected section
  43   };
  44
  45   const Vector4 LIGHTBLUE( 10.0f/255.0f, 140.0f/255.0f, 210.0f/255.0f, 1.0f );    // todo make this a setting
  46
  47   const float CHARACTER_THRESHOLD( 2.5f ); // todo check if unified method to do this in Text
  48 }
  49
  50 namespace Dali
  51 {
  52
  53 namespace Toolkit
  54 {
  55
  56 namespace Internal
  57 {
  58
  59 // Default constructor
  60 TextHighlight::TextHighlight( TextViewCharacterPositioning& textViewCharacterPositioning ) :
  61     mTextViewCharacterPositioning( textViewCharacterPositioning )
  62 {
  63 }
  64
  65 TextHighlight::~TextHighlight()
  66 {
  67 }
  68
  69 void TextHighlight::GetVisualTextSelection(std::vector<bool>& selectedVisualText, std::size_t startSelection, std::size_t endSelection,
  70                                            Toolkit::TextView::TextLayoutInfo& textLayoutInfo )
  71 {
  72   std::vector<int>::iterator it = textLayoutInfo.mCharacterLogicalToVisualMap.begin();
  73   std::vector<int>::iterator startSelectionIt = textLayoutInfo.mCharacterLogicalToVisualMap.begin() + std::min(startSelection, endSelection);
  74   std::vector<int>::iterator endSelectionIt = textLayoutInfo.mCharacterLogicalToVisualMap.begin() + std::max(startSelection, endSelection);
  75   std::vector<int>::iterator end = textLayoutInfo.mCharacterLogicalToVisualMap.end();
  76
  77   selectedVisualText.resize( mTextViewCharacterPositioning.GetNumberOfCharactersInText() );
  78
  79   // Deselect text prior to startSelectionIt
  80   for(;it!=startSelectionIt;++it)
  81   {
  82     selectedVisualText[*it] = false;
  83   }
  84
  85   // Select text from startSelectionIt -> endSelectionIt
  86   for(;it!=endSelectionIt;++it)
  87   {
  88     selectedVisualText[*it] = true;
  89   }
  90
  91   // Deselect text after endSelection
  92   for(;it!=end;++it)
  93   {
  94     selectedVisualText[*it] = false;
  95   }
  96
  97   selectedVisualText.resize( mTextViewCharacterPositioning.GetNumberOfCharactersInText(), false );
  98 }
  99
 100 // Calculate the dimensions of the quads they will make the highlight mesh
 101 TextHighlight::HighlightInfo TextHighlight::CalculateHighlightInfo( std::size_t handlePositionStart, std::size_t handlePositionEnd, Toolkit::TextView::TextLayoutInfo& textLayoutInfo )
 102 {
 103   // At the moment there is no public API to modify the block alignment option.
 104
 105   TextHighlight::HighlightInfo newHighlightInfo;
 106   //newHighlightInfo.mQuadList.clear(); // clear last quad information.
 107
 108   if ( !mTextViewCharacterPositioning.IsTextEmpty() && !textLayoutInfo.mCharacterLogicalToVisualMap.empty() )
 109   {
 110     // Get vector of flags representing characters that are selected (true) vs unselected (false).
 111     std::vector<bool> selectedVisualText;
 112     GetVisualTextSelection(selectedVisualText, handlePositionStart, handlePositionEnd, textLayoutInfo );
 113     std::vector<bool>::iterator selectedIt(selectedVisualText.begin());
 114     std::vector<bool>::iterator selectedEndIt(selectedVisualText.end());
 115
 116     SelectionState selectionState = SelectionNone;          ///< Current selection status of cursor over entire text.
 117     float rowLeft = 0.0f;
 118     float rowRight = 0.0f;
 119     // Keep track of the TextView's min/max extents. Should be able to query this from TextView.
 120     float maxRowLeft = std::numeric_limits<float>::max();
 121     float maxRowRight = 0.0f;
 122
 123     Toolkit::TextView::CharacterLayoutInfoContainer::iterator it = textLayoutInfo.mCharacterLayoutInfoTable.begin();
 124     Toolkit::TextView::CharacterLayoutInfoContainer::iterator end = textLayoutInfo.mCharacterLayoutInfoTable.end();
 125
 126     Toolkit::TextView::CharacterLayoutInfoContainer::iterator lastIt = it;
 127
 128     // Scan through entire text.
 129     while(it != end)
 130     {
 131       // selectionState: None when not in selection, Started when in selection, and Ended when reached end of selection.
 132
 133       Toolkit::TextView::CharacterLayoutInfo& charInfo(*it);
 134       bool charSelected( false );
 135       if( selectedIt != selectedEndIt )
 136       {
 137         charSelected = *selectedIt++;
 138       }
 139
 140       if(selectionState == SelectionNone)
 141       {
 142         if(charSelected)
 143         {
 144           selectionState = SelectionStarted;
 145           rowLeft = charInfo.mPosition.x - textLayoutInfo.mScrollOffset.x;
 146           rowRight = rowLeft + charInfo.mSize.width;
 147         }
 148       }
 149       else if(selectionState == SelectionStarted)
 150       {
 151         // break selection on:
 152         // 1. new line causing selection break. (\n or wordwrap)
 153         // 2. character not selected.
 154         if(charInfo.mPosition.y - lastIt->mPosition.y > CHARACTER_THRESHOLD ||
 155            !charSelected)
 156         {
 157           // finished selection.
 158           // TODO: TextView should have a table of visual rows, and each character a reference to the row
 159           // that it resides on. That way this enumeration is not necessary.
 160           Vector2 min, max;
 161           if(lastIt->mIsNewParagraphChar)
 162           {
 163             // If the last character is a new line, then to get the row rect, we need to scan from the character before the new line.
 164             lastIt = std::max( textLayoutInfo.mCharacterLayoutInfoTable.begin(), lastIt - 1 );
 165           }
 166           const Size rowSize( mTextViewCharacterPositioning.GetRowRectFromCharacterPosition( lastIt - textLayoutInfo.mCharacterLayoutInfoTable.begin(), min, max ) );
 167           maxRowLeft = std::min(maxRowLeft, min.x);
 168           maxRowRight = std::max(maxRowRight, max.x);
 169           float rowBottom = lastIt->mPosition.y - textLayoutInfo.mScrollOffset.y;
 170           float rowTop = rowBottom - rowSize.height;
 171
 172           // Still selected, and block-align mode then set rowRight to max, so it can be clamped afterwards
 173           if(charSelected)
 174           {
 175             rowRight = std::numeric_limits<float>::max();
 176           }
 177           newHighlightInfo.AddQuad( rowLeft, rowTop, rowRight, rowBottom );
 178
 179           selectionState = SelectionNone;
 180
 181           // Still selected? start a new selection
 182           if( charSelected )
 183           {
 184             // if block-align mode then set rowLeft to min, so it can be clamped afterwards
 185             rowLeft = 0.0f;
 186             rowRight = ( charInfo.mPosition.x - textLayoutInfo.mScrollOffset.x ) + charInfo.mSize.width;
 187             selectionState = SelectionStarted;
 188           }
 189         }
 190         else
 191         {
 192           // build up highlight(s) with this selection data.
 193           rowLeft = std::min( charInfo.mPosition.x - textLayoutInfo.mScrollOffset.x, rowLeft );
 194           rowRight = std::max( ( charInfo.mPosition.x - textLayoutInfo.mScrollOffset.x ) + charInfo.mSize.width, rowRight );
 195         }
 196       }
 197
 198       lastIt = it++;
 199     }
 200
 201     // If reached end, and still on selection, then close selection.
 202     if(it == end)
 203     {
 204       if(selectionState == SelectionStarted)
 205       {
 206         // finished selection.
 207         Vector2 min, max;
 208         if(lastIt != end && lastIt->mIsNewParagraphChar)
 209         {
 210           lastIt = std::max( textLayoutInfo.mCharacterLayoutInfoTable.begin(), lastIt - 1 );
 211         }
 212         const Size rowSize( mTextViewCharacterPositioning.GetRowRectFromCharacterPosition( lastIt - textLayoutInfo.mCharacterLayoutInfoTable.begin(), min, max ) );
 213         maxRowLeft = std::min(maxRowLeft, min.x);
 214         maxRowRight = std::max(maxRowRight, max.x);
 215         float rowBottom = lastIt->mPosition.y - textLayoutInfo.mScrollOffset.y;
 216         float rowTop = rowBottom - rowSize.height;
 217         newHighlightInfo.AddQuad( rowLeft, rowTop, rowRight, rowBottom );
 218       }
 219     }
 220
 221     // Get the top left and bottom right corners.
 222     const Toolkit::TextView::CharacterLayoutInfo& firstCharacter( *textLayoutInfo.mCharacterLayoutInfoTable.begin() );
 223     const Vector2 topLeft( maxRowLeft, firstCharacter.mPosition.y - firstCharacter.mSize.height );
 224     const Vector2 bottomRight( topLeft.x + textLayoutInfo.mTextSize.width, topLeft.y + textLayoutInfo.mTextSize.height );
 225
 226     // Clamp quads so they appear to clip to borders of the whole text.
 227     newHighlightInfo.Clamp2D( topLeft, bottomRight );
 228
 229     // For block-align align Further Clamp quads to max left and right extents
 230       // BlockAlign: Will adjust highlight to block:
 231       // i.e.
 232       //   H[ello] (top row right = max of all rows right)
 233       // [--this-] (middle rows' left = min of all rows left, middle rows' right = max of all rows right)
 234       // [is some] (middle rows' left = min of all rows left, middle rows' right = max of all rows right)
 235       // [text] (bottom row left = min of all rows left)
 236       // (common in SMS messaging selection)
 237       //
 238       // As opposed to the default which is tight text highlighting.
 239       //   H[ello]
 240       //   [this]
 241       // [is some]
 242       // [text]
 243       // (common in regular text editors/web browser selection)
 244       newHighlightInfo.Clamp2D( Vector2(maxRowLeft, topLeft.y), Vector2(maxRowRight, bottomRight.y ) );
 245
 246   }
 247
 248   return newHighlightInfo;
 249 }
 250
 251 void TextHighlight::UpdateHighlight( TextHighlight::HighlightInfo& newHighlightInfo )
 252 {
 253 //  Construct a Mesh with a texture to be used as the highlight 'box' for selected text
 254 //
 255 //  Example scenarios where mesh is made from 3, 1, 2, 2 ,3 or 3 quads.
 256 //
 257 //   [ TOP   ]  [ TOP ]      [TOP ]  [ TOP    ]      [ TOP  ]      [ TOP  ]
 258 //  [ MIDDLE ]             [BOTTOM]  [BOTTOM]      [ MIDDLE ]   [ MIDDLE  ]
 259 //  [ BOTTOM]                                      [ MIDDLE ]   [ MIDDLE  ]
 260 //                                                 [BOTTOM]     [ MIDDLE  ]
 261 //                                                              [BOTTOM]
 262 //
 263 //  Each quad is created as 2 triangles.
 264 //  Middle is just 1 quad regardless of its size.
 265 //
 266 //  (0,0)         (0,0)
 267 //     0*    *2     0*       *2
 268 //     TOP          TOP
 269 //     3*    *1     3*       *1
 270 //  4*       *1     4*     *6
 271 //     MIDDLE         BOTTOM
 272 //  6*       *5     7*     *5
 273 //  6*    *8
 274 //   BOTTOM
 275 //  9*    *7
 276 //
 277
 278   // vertex and triangle buffers should always be present if MeshActor is alive.
 279   //HighlightInfo newHighlightInfo = CalculateHighlightInfo( handlePositionStart, handlePositionEnd );
 280   MeshData::VertexContainer vertices;
 281   Dali::MeshData::FaceIndices faceIndices;
 282
 283   if( !newHighlightInfo.mQuadList.empty() )
 284   {
 285     std::vector<QuadCoordinates>::iterator iter = newHighlightInfo.mQuadList.begin();
 286     std::vector<QuadCoordinates>::iterator endIter = newHighlightInfo.mQuadList.end();
 287
 288     // vertex position defaults to (0 0 0)
 289     MeshData::Vertex vertex;
 290     // set normal for all vertices as (0 0 1) pointing outward from TextInput Actor.
 291     vertex.nZ = 1.0f;
 292
 293     for(std::size_t v = 0; iter != endIter; ++iter,v+=4 )
 294     {
 295       // Add each quad geometry (a sub-selection) to the mesh data.
 296
 297       // 0-----1
 298       // |\    |
 299       // | \ A |
 300       // |  \  |
 301       // | B \ |
 302       // |    \|
 303       // 2-----3
 304
 305       QuadCoordinates& quad = *iter;
 306       // top-left (v+0)
 307       vertex.x = quad.min.x;
 308       vertex.y = quad.min.y;
 309       vertices.push_back( vertex );
 310
 311       // top-right (v+1)
 312       vertex.x = quad.max.x;
 313       vertex.y = quad.min.y;
 314       vertices.push_back( vertex );
 315
 316       // bottom-left (v+2)
 317       vertex.x = quad.min.x;
 318       vertex.y = quad.max.y;
 319       vertices.push_back( vertex );
 320
 321       // bottom-right (v+3)
 322       vertex.x = quad.max.x;
 323       vertex.y = quad.max.y;
 324       vertices.push_back( vertex );
 325
 326       // triangle A (3, 1, 0)
 327       faceIndices.push_back( v + 3 );
 328       faceIndices.push_back( v + 1 );
 329       faceIndices.push_back( v );
 330
 331       // triangle B (0, 2, 3)
 332       faceIndices.push_back( v );
 333       faceIndices.push_back( v + 2 );
 334       faceIndices.push_back( v + 3 );
 335     }
 336
 337     mMeshData.SetVertices( vertices );
 338     mMeshData.SetFaceIndices( faceIndices );
 339
 340     mHighlightMesh.UpdateMeshData(mMeshData);
 341   }
 342 }
 343
 344 Mesh TextHighlight::CreateHighLightMesh()
 345 {
 346   mMeshData = MeshData( );
 347   mMeshData.SetHasNormals( true );
 348
 349   mCustomMaterial = Material::New("CustomMaterial");
 350   mCustomMaterial.SetDiffuseColor( LIGHTBLUE );
 351
 352   mMeshData.SetMaterial( mCustomMaterial );
 353
 354   mHighlightMesh = Mesh::New( mMeshData );
 355
 356   return mHighlightMesh;
 357 }
 358
 359 void TextHighlight::HighlightInfo::AddQuad( float x1, float y1, float x2, float y2 )
 360 {
 361   QuadCoordinates quad(x1, y1, x2, y2);
 362   mQuadList.push_back( quad );
 363 }
 364
 365 void TextHighlight::HighlightInfo::Clamp2D(const Vector2& min, const Vector2& max)
 366 {
 367   for(std::size_t i = 0;i < mQuadList.size(); i++)
 368   {
 369     QuadCoordinates& quad = mQuadList[i];
 370
 371     quad.min.Clamp(min, max);
 372     quad.max.Clamp(min, max);
 373   }
 374 }
 375
 376 } // Internal
 377
 378 } // namespace Toolkit
 379
 380 } // namespace Dali
 381