The JUCE cross-platform C++ framework, with DISTRHO/KXStudio specific changes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2778 lines
81KB

  1. /*
  2. ==============================================================================
  3. This file is part of the JUCE library.
  4. Copyright (c) 2022 - Raw Material Software Limited
  5. JUCE is an open source library subject to commercial or open-source
  6. licensing.
  7. By using JUCE, you agree to the terms of both the JUCE 7 End-User License
  8. Agreement and JUCE Privacy Policy.
  9. End User License Agreement: www.juce.com/juce-7-licence
  10. Privacy Policy: www.juce.com/juce-privacy-policy
  11. Or: You may also use this code under the terms of the GPL v3 (see
  12. www.gnu.org/licenses).
  13. JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  14. EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  15. DISCLAIMED.
  16. ==============================================================================
  17. */
  18. namespace juce
  19. {
  20. // a word or space that can't be broken down any further
  21. struct TextAtom
  22. {
  23. //==============================================================================
  24. String atomText;
  25. float width;
  26. int numChars;
  27. //==============================================================================
  28. bool isWhitespace() const noexcept { return CharacterFunctions::isWhitespace (atomText[0]); }
  29. bool isNewLine() const noexcept { return atomText[0] == '\r' || atomText[0] == '\n'; }
  30. String getText (juce_wchar passwordCharacter) const
  31. {
  32. if (passwordCharacter == 0)
  33. return atomText;
  34. return String::repeatedString (String::charToString (passwordCharacter),
  35. atomText.length());
  36. }
  37. String getTrimmedText (const juce_wchar passwordCharacter) const
  38. {
  39. if (passwordCharacter == 0)
  40. return atomText.substring (0, numChars);
  41. if (isNewLine())
  42. return {};
  43. return String::repeatedString (String::charToString (passwordCharacter), numChars);
  44. }
  45. JUCE_LEAK_DETECTOR (TextAtom)
  46. };
  47. //==============================================================================
  48. // a run of text with a single font and colour
  49. class TextEditor::UniformTextSection
  50. {
  51. public:
  52. UniformTextSection (const String& text, const Font& f, Colour col, juce_wchar passwordCharToUse)
  53. : font (f), colour (col), passwordChar (passwordCharToUse)
  54. {
  55. initialiseAtoms (text);
  56. }
  57. UniformTextSection (const UniformTextSection&) = default;
  58. UniformTextSection (UniformTextSection&&) = default;
  59. UniformTextSection& operator= (const UniformTextSection&) = delete;
  60. void append (UniformTextSection& other)
  61. {
  62. if (! other.atoms.isEmpty())
  63. {
  64. int i = 0;
  65. if (! atoms.isEmpty())
  66. {
  67. auto& lastAtom = atoms.getReference (atoms.size() - 1);
  68. if (! CharacterFunctions::isWhitespace (lastAtom.atomText.getLastCharacter()))
  69. {
  70. auto& first = other.atoms.getReference (0);
  71. if (! CharacterFunctions::isWhitespace (first.atomText[0]))
  72. {
  73. lastAtom.atomText += first.atomText;
  74. lastAtom.numChars = (uint16) (lastAtom.numChars + first.numChars);
  75. lastAtom.width = font.getStringWidthFloat (lastAtom.getText (passwordChar));
  76. ++i;
  77. }
  78. }
  79. }
  80. atoms.ensureStorageAllocated (atoms.size() + other.atoms.size() - i);
  81. while (i < other.atoms.size())
  82. {
  83. atoms.add (other.atoms.getReference (i));
  84. ++i;
  85. }
  86. }
  87. }
  88. UniformTextSection* split (int indexToBreakAt)
  89. {
  90. auto* section2 = new UniformTextSection ({}, font, colour, passwordChar);
  91. int index = 0;
  92. for (int i = 0; i < atoms.size(); ++i)
  93. {
  94. auto& atom = atoms.getReference (i);
  95. auto nextIndex = index + atom.numChars;
  96. if (index == indexToBreakAt)
  97. {
  98. for (int j = i; j < atoms.size(); ++j)
  99. section2->atoms.add (atoms.getUnchecked (j));
  100. atoms.removeRange (i, atoms.size());
  101. break;
  102. }
  103. if (indexToBreakAt >= index && indexToBreakAt < nextIndex)
  104. {
  105. TextAtom secondAtom;
  106. secondAtom.atomText = atom.atomText.substring (indexToBreakAt - index);
  107. secondAtom.width = font.getStringWidthFloat (secondAtom.getText (passwordChar));
  108. secondAtom.numChars = (uint16) secondAtom.atomText.length();
  109. section2->atoms.add (secondAtom);
  110. atom.atomText = atom.atomText.substring (0, indexToBreakAt - index);
  111. atom.width = font.getStringWidthFloat (atom.getText (passwordChar));
  112. atom.numChars = (uint16) (indexToBreakAt - index);
  113. for (int j = i + 1; j < atoms.size(); ++j)
  114. section2->atoms.add (atoms.getUnchecked (j));
  115. atoms.removeRange (i + 1, atoms.size());
  116. break;
  117. }
  118. index = nextIndex;
  119. }
  120. return section2;
  121. }
  122. void appendAllText (MemoryOutputStream& mo) const
  123. {
  124. for (auto& atom : atoms)
  125. mo << atom.atomText;
  126. }
  127. void appendSubstring (MemoryOutputStream& mo, Range<int> range) const
  128. {
  129. int index = 0;
  130. for (auto& atom : atoms)
  131. {
  132. auto nextIndex = index + atom.numChars;
  133. if (range.getStart() < nextIndex)
  134. {
  135. if (range.getEnd() <= index)
  136. break;
  137. auto r = (range - index).getIntersectionWith ({ 0, (int) atom.numChars });
  138. if (! r.isEmpty())
  139. mo << atom.atomText.substring (r.getStart(), r.getEnd());
  140. }
  141. index = nextIndex;
  142. }
  143. }
  144. int getTotalLength() const noexcept
  145. {
  146. int total = 0;
  147. for (auto& atom : atoms)
  148. total += atom.numChars;
  149. return total;
  150. }
  151. void setFont (const Font& newFont, const juce_wchar passwordCharToUse)
  152. {
  153. if (font != newFont || passwordChar != passwordCharToUse)
  154. {
  155. font = newFont;
  156. passwordChar = passwordCharToUse;
  157. for (auto& atom : atoms)
  158. atom.width = newFont.getStringWidthFloat (atom.getText (passwordChar));
  159. }
  160. }
  161. //==============================================================================
  162. Font font;
  163. Colour colour;
  164. Array<TextAtom> atoms;
  165. juce_wchar passwordChar;
  166. private:
  167. void initialiseAtoms (const String& textToParse)
  168. {
  169. auto text = textToParse.getCharPointer();
  170. while (! text.isEmpty())
  171. {
  172. size_t numChars = 0;
  173. auto start = text;
  174. // create a whitespace atom unless it starts with non-ws
  175. if (text.isWhitespace() && *text != '\r' && *text != '\n')
  176. {
  177. do
  178. {
  179. ++text;
  180. ++numChars;
  181. }
  182. while (text.isWhitespace() && *text != '\r' && *text != '\n');
  183. }
  184. else
  185. {
  186. if (*text == '\r')
  187. {
  188. ++text;
  189. ++numChars;
  190. if (*text == '\n')
  191. {
  192. ++start;
  193. ++text;
  194. }
  195. }
  196. else if (*text == '\n')
  197. {
  198. ++text;
  199. ++numChars;
  200. }
  201. else
  202. {
  203. while (! (text.isEmpty() || text.isWhitespace()))
  204. {
  205. ++text;
  206. ++numChars;
  207. }
  208. }
  209. }
  210. TextAtom atom;
  211. atom.atomText = String (start, numChars);
  212. atom.width = (atom.isNewLine() ? 0.0f : font.getStringWidthFloat (atom.getText (passwordChar)));
  213. atom.numChars = (uint16) numChars;
  214. atoms.add (atom);
  215. }
  216. }
  217. JUCE_LEAK_DETECTOR (UniformTextSection)
  218. };
  219. //==============================================================================
  220. struct TextEditor::Iterator
  221. {
  222. Iterator (const TextEditor& ed)
  223. : sections (ed.sections),
  224. justification (ed.justification),
  225. bottomRight ((float) ed.getMaximumTextWidth(), (float) ed.getMaximumTextHeight()),
  226. wordWrapWidth ((float) ed.getWordWrapWidth()),
  227. passwordCharacter (ed.passwordCharacter),
  228. lineSpacing (ed.lineSpacing),
  229. underlineWhitespace (ed.underlineWhitespace)
  230. {
  231. jassert (wordWrapWidth > 0);
  232. if (! sections.isEmpty())
  233. {
  234. currentSection = sections.getUnchecked (sectionIndex);
  235. if (currentSection != nullptr)
  236. beginNewLine();
  237. }
  238. lineHeight = ed.currentFont.getHeight();
  239. }
  240. Iterator (const Iterator&) = default;
  241. Iterator& operator= (const Iterator&) = delete;
  242. //==============================================================================
  243. bool next()
  244. {
  245. if (atom == &longAtom && chunkLongAtom (true))
  246. return true;
  247. if (sectionIndex >= sections.size())
  248. {
  249. moveToEndOfLastAtom();
  250. return false;
  251. }
  252. bool forceNewLine = false;
  253. if (atomIndex >= currentSection->atoms.size() - 1)
  254. {
  255. if (atomIndex >= currentSection->atoms.size())
  256. {
  257. if (++sectionIndex >= sections.size())
  258. {
  259. moveToEndOfLastAtom();
  260. return false;
  261. }
  262. atomIndex = 0;
  263. currentSection = sections.getUnchecked (sectionIndex);
  264. }
  265. else
  266. {
  267. auto& lastAtom = currentSection->atoms.getReference (atomIndex);
  268. if (! lastAtom.isWhitespace())
  269. {
  270. // handle the case where the last atom in a section is actually part of the same
  271. // word as the first atom of the next section...
  272. float right = atomRight + lastAtom.width;
  273. float lineHeight2 = lineHeight;
  274. float maxDescent2 = maxDescent;
  275. for (int section = sectionIndex + 1; section < sections.size(); ++section)
  276. {
  277. auto* s = sections.getUnchecked (section);
  278. if (s->atoms.size() == 0)
  279. break;
  280. auto& nextAtom = s->atoms.getReference (0);
  281. if (nextAtom.isWhitespace())
  282. break;
  283. right += nextAtom.width;
  284. lineHeight2 = jmax (lineHeight2, s->font.getHeight());
  285. maxDescent2 = jmax (maxDescent2, s->font.getDescent());
  286. if (shouldWrap (right))
  287. {
  288. lineHeight = lineHeight2;
  289. maxDescent = maxDescent2;
  290. forceNewLine = true;
  291. break;
  292. }
  293. if (s->atoms.size() > 1)
  294. break;
  295. }
  296. }
  297. }
  298. }
  299. bool isInPreviousAtom = false;
  300. if (atom != nullptr)
  301. {
  302. atomX = atomRight;
  303. indexInText += atom->numChars;
  304. if (atom->isNewLine())
  305. beginNewLine();
  306. else
  307. isInPreviousAtom = true;
  308. }
  309. atom = &(currentSection->atoms.getReference (atomIndex));
  310. atomRight = atomX + atom->width;
  311. ++atomIndex;
  312. if (shouldWrap (atomRight) || forceNewLine)
  313. {
  314. if (atom->isWhitespace())
  315. {
  316. // leave whitespace at the end of a line, but truncate it to avoid scrolling
  317. atomRight = jmin (atomRight, wordWrapWidth);
  318. }
  319. else if (shouldWrap (atom->width)) // atom too big to fit on a line, so break it up..
  320. {
  321. longAtom = *atom;
  322. longAtom.numChars = 0;
  323. atom = &longAtom;
  324. chunkLongAtom (isInPreviousAtom);
  325. }
  326. else
  327. {
  328. beginNewLine();
  329. atomRight = atomX + atom->width;
  330. }
  331. }
  332. return true;
  333. }
  334. void beginNewLine()
  335. {
  336. lineY += lineHeight * lineSpacing;
  337. float lineWidth = 0;
  338. auto tempSectionIndex = sectionIndex;
  339. auto tempAtomIndex = atomIndex;
  340. auto* section = sections.getUnchecked (tempSectionIndex);
  341. lineHeight = section->font.getHeight();
  342. maxDescent = section->font.getDescent();
  343. float nextLineWidth = (atom != nullptr) ? atom->width : 0.0f;
  344. while (! shouldWrap (nextLineWidth))
  345. {
  346. lineWidth = nextLineWidth;
  347. if (tempSectionIndex >= sections.size())
  348. break;
  349. bool checkSize = false;
  350. if (tempAtomIndex >= section->atoms.size())
  351. {
  352. if (++tempSectionIndex >= sections.size())
  353. break;
  354. tempAtomIndex = 0;
  355. section = sections.getUnchecked (tempSectionIndex);
  356. checkSize = true;
  357. }
  358. if (! isPositiveAndBelow (tempAtomIndex, section->atoms.size()))
  359. break;
  360. auto& nextAtom = section->atoms.getReference (tempAtomIndex);
  361. nextLineWidth += nextAtom.width;
  362. if (shouldWrap (nextLineWidth) || nextAtom.isNewLine())
  363. break;
  364. if (checkSize)
  365. {
  366. lineHeight = jmax (lineHeight, section->font.getHeight());
  367. maxDescent = jmax (maxDescent, section->font.getDescent());
  368. }
  369. ++tempAtomIndex;
  370. }
  371. atomX = getJustificationOffsetX (lineWidth);
  372. }
  373. float getJustificationOffsetX (float lineWidth) const
  374. {
  375. if (justification.testFlags (Justification::horizontallyCentred)) return jmax (0.0f, (bottomRight.x - lineWidth) * 0.5f);
  376. if (justification.testFlags (Justification::right)) return jmax (0.0f, bottomRight.x - lineWidth);
  377. return 0;
  378. }
  379. //==============================================================================
  380. void draw (Graphics& g, const UniformTextSection*& lastSection, AffineTransform transform) const
  381. {
  382. if (atom == nullptr)
  383. return;
  384. if (passwordCharacter != 0 || (underlineWhitespace || ! atom->isWhitespace()))
  385. {
  386. if (lastSection != currentSection)
  387. {
  388. lastSection = currentSection;
  389. g.setColour (currentSection->colour);
  390. g.setFont (currentSection->font);
  391. }
  392. jassert (atom->getTrimmedText (passwordCharacter).isNotEmpty());
  393. GlyphArrangement ga;
  394. ga.addLineOfText (currentSection->font,
  395. atom->getTrimmedText (passwordCharacter),
  396. atomX, (float) roundToInt (lineY + lineHeight - maxDescent));
  397. ga.draw (g, transform);
  398. }
  399. }
  400. void drawUnderline (Graphics& g, Range<int> underline, Colour colour, AffineTransform transform) const
  401. {
  402. auto startX = roundToInt (indexToX (underline.getStart()));
  403. auto endX = roundToInt (indexToX (underline.getEnd()));
  404. auto baselineY = roundToInt (lineY + currentSection->font.getAscent() + 0.5f);
  405. Graphics::ScopedSaveState state (g);
  406. g.addTransform (transform);
  407. g.reduceClipRegion ({ startX, baselineY, endX - startX, 1 });
  408. g.fillCheckerBoard ({ (float) endX, (float) baselineY + 1.0f }, 3.0f, 1.0f, colour, Colours::transparentBlack);
  409. }
  410. void drawSelectedText (Graphics& g, Range<int> selected, Colour selectedTextColour, AffineTransform transform) const
  411. {
  412. if (atom == nullptr)
  413. return;
  414. if (passwordCharacter != 0 || ! atom->isWhitespace())
  415. {
  416. GlyphArrangement ga;
  417. ga.addLineOfText (currentSection->font,
  418. atom->getTrimmedText (passwordCharacter),
  419. atomX, (float) roundToInt (lineY + lineHeight - maxDescent));
  420. if (selected.getEnd() < indexInText + atom->numChars)
  421. {
  422. GlyphArrangement ga2 (ga);
  423. ga2.removeRangeOfGlyphs (0, selected.getEnd() - indexInText);
  424. ga.removeRangeOfGlyphs (selected.getEnd() - indexInText, -1);
  425. g.setColour (currentSection->colour);
  426. ga2.draw (g, transform);
  427. }
  428. if (selected.getStart() > indexInText)
  429. {
  430. GlyphArrangement ga2 (ga);
  431. ga2.removeRangeOfGlyphs (selected.getStart() - indexInText, -1);
  432. ga.removeRangeOfGlyphs (0, selected.getStart() - indexInText);
  433. g.setColour (currentSection->colour);
  434. ga2.draw (g, transform);
  435. }
  436. g.setColour (selectedTextColour);
  437. ga.draw (g, transform);
  438. }
  439. }
  440. //==============================================================================
  441. float indexToX (int indexToFind) const
  442. {
  443. if (indexToFind <= indexInText || atom == nullptr)
  444. return atomX;
  445. if (indexToFind >= indexInText + atom->numChars)
  446. return atomRight;
  447. GlyphArrangement g;
  448. g.addLineOfText (currentSection->font,
  449. atom->getText (passwordCharacter),
  450. atomX, 0.0f);
  451. if (indexToFind - indexInText >= g.getNumGlyphs())
  452. return atomRight;
  453. return jmin (atomRight, g.getGlyph (indexToFind - indexInText).getLeft());
  454. }
  455. int xToIndex (float xToFind) const
  456. {
  457. if (xToFind <= atomX || atom == nullptr || atom->isNewLine())
  458. return indexInText;
  459. if (xToFind >= atomRight)
  460. return indexInText + atom->numChars;
  461. GlyphArrangement g;
  462. g.addLineOfText (currentSection->font,
  463. atom->getText (passwordCharacter),
  464. atomX, 0.0f);
  465. auto numGlyphs = g.getNumGlyphs();
  466. int j;
  467. for (j = 0; j < numGlyphs; ++j)
  468. {
  469. auto& pg = g.getGlyph (j);
  470. if ((pg.getLeft() + pg.getRight()) / 2 > xToFind)
  471. break;
  472. }
  473. return indexInText + j;
  474. }
  475. //==============================================================================
  476. bool getCharPosition (int index, Point<float>& anchor, float& lineHeightFound)
  477. {
  478. while (next())
  479. {
  480. if (indexInText + atom->numChars > index)
  481. {
  482. anchor = { indexToX (index), lineY };
  483. lineHeightFound = lineHeight;
  484. return true;
  485. }
  486. }
  487. anchor = { atomX, lineY };
  488. lineHeightFound = lineHeight;
  489. return false;
  490. }
  491. float getYOffset()
  492. {
  493. if (justification.testFlags (Justification::top) || lineY >= bottomRight.y)
  494. return 0;
  495. while (next())
  496. {
  497. if (lineY >= bottomRight.y)
  498. return 0;
  499. }
  500. auto bottom = jmax (0.0f, bottomRight.y - lineY - lineHeight);
  501. if (justification.testFlags (Justification::bottom))
  502. return bottom;
  503. return bottom * 0.5f;
  504. }
  505. int getTotalTextHeight()
  506. {
  507. while (next()) {}
  508. auto height = lineY + lineHeight + getYOffset();
  509. if (atom != nullptr && atom->isNewLine())
  510. height += lineHeight;
  511. return roundToInt (height);
  512. }
  513. int getTextRight()
  514. {
  515. float maxWidth = 0.0f;
  516. while (next())
  517. maxWidth = jmax (maxWidth, atomRight);
  518. return roundToInt (maxWidth);
  519. }
  520. Rectangle<int> getTextBounds (Range<int> range) const
  521. {
  522. auto startX = indexToX (range.getStart());
  523. auto endX = indexToX (range.getEnd());
  524. return Rectangle<float> (startX, lineY, endX - startX, lineHeight * lineSpacing).getSmallestIntegerContainer();
  525. }
  526. //==============================================================================
  527. int indexInText = 0;
  528. float lineY = 0, lineHeight = 0, maxDescent = 0;
  529. float atomX = 0, atomRight = 0;
  530. const TextAtom* atom = nullptr;
  531. private:
  532. const OwnedArray<UniformTextSection>& sections;
  533. const UniformTextSection* currentSection = nullptr;
  534. int sectionIndex = 0, atomIndex = 0;
  535. Justification justification;
  536. const Point<float> bottomRight;
  537. const float wordWrapWidth;
  538. const juce_wchar passwordCharacter;
  539. const float lineSpacing;
  540. const bool underlineWhitespace;
  541. TextAtom longAtom;
  542. bool chunkLongAtom (bool shouldStartNewLine)
  543. {
  544. const auto numRemaining = longAtom.atomText.length() - longAtom.numChars;
  545. if (numRemaining <= 0)
  546. return false;
  547. longAtom.atomText = longAtom.atomText.substring (longAtom.numChars);
  548. indexInText += longAtom.numChars;
  549. GlyphArrangement g;
  550. g.addLineOfText (currentSection->font, atom->getText (passwordCharacter), 0.0f, 0.0f);
  551. int split;
  552. for (split = 0; split < g.getNumGlyphs(); ++split)
  553. if (shouldWrap (g.getGlyph (split).getRight()))
  554. break;
  555. const auto numChars = jmax (1, split);
  556. longAtom.numChars = (uint16) numChars;
  557. longAtom.width = g.getGlyph (numChars - 1).getRight();
  558. atomX = getJustificationOffsetX (longAtom.width);
  559. if (shouldStartNewLine)
  560. {
  561. if (split == numRemaining)
  562. beginNewLine();
  563. else
  564. lineY += lineHeight * lineSpacing;
  565. }
  566. atomRight = atomX + longAtom.width;
  567. return true;
  568. }
  569. void moveToEndOfLastAtom()
  570. {
  571. if (atom != nullptr)
  572. {
  573. atomX = atomRight;
  574. if (atom->isNewLine())
  575. {
  576. atomX = getJustificationOffsetX (0);
  577. lineY += lineHeight * lineSpacing;
  578. }
  579. }
  580. }
  581. bool shouldWrap (const float x) const noexcept
  582. {
  583. return (x - 0.0001f) >= wordWrapWidth;
  584. }
  585. JUCE_LEAK_DETECTOR (Iterator)
  586. };
  587. //==============================================================================
  588. struct TextEditor::InsertAction final : public UndoableAction
  589. {
  590. InsertAction (TextEditor& ed, const String& newText, int insertPos,
  591. const Font& newFont, Colour newColour, int oldCaret, int newCaret)
  592. : owner (ed),
  593. text (newText),
  594. insertIndex (insertPos),
  595. oldCaretPos (oldCaret),
  596. newCaretPos (newCaret),
  597. font (newFont),
  598. colour (newColour)
  599. {
  600. }
  601. bool perform() override
  602. {
  603. owner.insert (text, insertIndex, font, colour, nullptr, newCaretPos);
  604. return true;
  605. }
  606. bool undo() override
  607. {
  608. owner.remove ({ insertIndex, insertIndex + text.length() }, nullptr, oldCaretPos);
  609. return true;
  610. }
  611. int getSizeInUnits() override
  612. {
  613. return text.length() + 16;
  614. }
  615. private:
  616. TextEditor& owner;
  617. const String text;
  618. const int insertIndex, oldCaretPos, newCaretPos;
  619. const Font font;
  620. const Colour colour;
  621. JUCE_DECLARE_NON_COPYABLE (InsertAction)
  622. };
  623. //==============================================================================
  624. struct TextEditor::RemoveAction final : public UndoableAction
  625. {
  626. RemoveAction (TextEditor& ed, Range<int> rangeToRemove, int oldCaret, int newCaret,
  627. const Array<UniformTextSection*>& oldSections)
  628. : owner (ed),
  629. range (rangeToRemove),
  630. oldCaretPos (oldCaret),
  631. newCaretPos (newCaret)
  632. {
  633. removedSections.addArray (oldSections);
  634. }
  635. bool perform() override
  636. {
  637. owner.remove (range, nullptr, newCaretPos);
  638. return true;
  639. }
  640. bool undo() override
  641. {
  642. owner.reinsert (range.getStart(), removedSections);
  643. owner.moveCaretTo (oldCaretPos, false);
  644. return true;
  645. }
  646. int getSizeInUnits() override
  647. {
  648. int n = 16;
  649. for (auto* s : removedSections)
  650. n += s->getTotalLength();
  651. return n;
  652. }
  653. private:
  654. TextEditor& owner;
  655. const Range<int> range;
  656. const int oldCaretPos, newCaretPos;
  657. OwnedArray<UniformTextSection> removedSections;
  658. JUCE_DECLARE_NON_COPYABLE (RemoveAction)
  659. };
  660. //==============================================================================
  661. struct TextEditor::TextHolderComponent final : public Component,
  662. public Timer,
  663. public Value::Listener
  664. {
  665. TextHolderComponent (TextEditor& ed) : owner (ed)
  666. {
  667. setWantsKeyboardFocus (false);
  668. setInterceptsMouseClicks (false, true);
  669. setMouseCursor (MouseCursor::ParentCursor);
  670. owner.getTextValue().addListener (this);
  671. }
  672. ~TextHolderComponent() override
  673. {
  674. owner.getTextValue().removeListener (this);
  675. }
  676. void paint (Graphics& g) override
  677. {
  678. owner.drawContent (g);
  679. }
  680. void restartTimer()
  681. {
  682. startTimer (350);
  683. }
  684. void timerCallback() override
  685. {
  686. owner.timerCallbackInt();
  687. }
  688. void valueChanged (Value&) override
  689. {
  690. owner.textWasChangedByValue();
  691. }
  692. TextEditor& owner;
  693. private:
  694. std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override
  695. {
  696. return createIgnoredAccessibilityHandler (*this);
  697. }
  698. JUCE_DECLARE_NON_COPYABLE (TextHolderComponent)
  699. };
  700. //==============================================================================
  701. struct TextEditor::TextEditorViewport final : public Viewport
  702. {
  703. TextEditorViewport (TextEditor& ed) : owner (ed) {}
  704. void visibleAreaChanged (const Rectangle<int>&) override
  705. {
  706. if (! reentrant) // it's rare, but possible to get into a feedback loop as the viewport's scrollbars
  707. // appear and disappear, causing the wrap width to change.
  708. {
  709. auto wordWrapWidth = owner.getWordWrapWidth();
  710. if (wordWrapWidth != lastWordWrapWidth)
  711. {
  712. lastWordWrapWidth = wordWrapWidth;
  713. ScopedValueSetter<bool> svs (reentrant, true);
  714. owner.checkLayout();
  715. }
  716. }
  717. }
  718. private:
  719. std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override
  720. {
  721. return createIgnoredAccessibilityHandler (*this);
  722. }
  723. TextEditor& owner;
  724. int lastWordWrapWidth = 0;
  725. bool reentrant = false;
  726. JUCE_DECLARE_NON_COPYABLE (TextEditorViewport)
  727. };
  728. //==============================================================================
  729. namespace TextEditorDefs
  730. {
  731. const int textChangeMessageId = 0x10003001;
  732. const int returnKeyMessageId = 0x10003002;
  733. const int escapeKeyMessageId = 0x10003003;
  734. const int focusLossMessageId = 0x10003004;
  735. const int maxActionsPerTransaction = 100;
  736. static int getCharacterCategory (juce_wchar character) noexcept
  737. {
  738. return CharacterFunctions::isLetterOrDigit (character)
  739. ? 2 : (CharacterFunctions::isWhitespace (character) ? 0 : 1);
  740. }
  741. }
  742. //==============================================================================
  743. TextEditor::TextEditor (const String& name, juce_wchar passwordChar)
  744. : Component (name),
  745. passwordCharacter (passwordChar)
  746. {
  747. setMouseCursor (MouseCursor::IBeamCursor);
  748. viewport.reset (new TextEditorViewport (*this));
  749. addAndMakeVisible (viewport.get());
  750. viewport->setViewedComponent (textHolder = new TextHolderComponent (*this));
  751. viewport->setWantsKeyboardFocus (false);
  752. viewport->setScrollBarsShown (false, false);
  753. setWantsKeyboardFocus (true);
  754. recreateCaret();
  755. }
  756. TextEditor::~TextEditor()
  757. {
  758. if (auto* peer = getPeer())
  759. peer->refreshTextInputTarget();
  760. textValue.removeListener (textHolder);
  761. textValue.referTo (Value());
  762. viewport.reset();
  763. textHolder = nullptr;
  764. }
  765. //==============================================================================
  766. void TextEditor::newTransaction()
  767. {
  768. lastTransactionTime = Time::getApproximateMillisecondCounter();
  769. undoManager.beginNewTransaction();
  770. }
  771. bool TextEditor::undoOrRedo (const bool shouldUndo)
  772. {
  773. if (! isReadOnly())
  774. {
  775. newTransaction();
  776. if (shouldUndo ? undoManager.undo()
  777. : undoManager.redo())
  778. {
  779. repaint();
  780. textChanged();
  781. scrollToMakeSureCursorIsVisible();
  782. return true;
  783. }
  784. }
  785. return false;
  786. }
  787. bool TextEditor::undo() { return undoOrRedo (true); }
  788. bool TextEditor::redo() { return undoOrRedo (false); }
  789. //==============================================================================
  790. void TextEditor::setMultiLine (const bool shouldBeMultiLine,
  791. const bool shouldWordWrap)
  792. {
  793. if (multiline != shouldBeMultiLine
  794. || wordWrap != (shouldWordWrap && shouldBeMultiLine))
  795. {
  796. multiline = shouldBeMultiLine;
  797. wordWrap = shouldWordWrap && shouldBeMultiLine;
  798. checkLayout();
  799. viewport->setViewPosition (0, 0);
  800. resized();
  801. scrollToMakeSureCursorIsVisible();
  802. }
  803. }
  804. bool TextEditor::isMultiLine() const
  805. {
  806. return multiline;
  807. }
  808. void TextEditor::setScrollbarsShown (bool shown)
  809. {
  810. if (scrollbarVisible != shown)
  811. {
  812. scrollbarVisible = shown;
  813. checkLayout();
  814. }
  815. }
  816. void TextEditor::setReadOnly (bool shouldBeReadOnly)
  817. {
  818. if (readOnly != shouldBeReadOnly)
  819. {
  820. readOnly = shouldBeReadOnly;
  821. enablementChanged();
  822. invalidateAccessibilityHandler();
  823. if (auto* peer = getPeer())
  824. peer->refreshTextInputTarget();
  825. }
  826. }
  827. void TextEditor::setClicksOutsideDismissVirtualKeyboard (bool newValue)
  828. {
  829. clicksOutsideDismissVirtualKeyboard = newValue;
  830. }
  831. bool TextEditor::isReadOnly() const noexcept
  832. {
  833. return readOnly || ! isEnabled();
  834. }
  835. bool TextEditor::isTextInputActive() const
  836. {
  837. return ! isReadOnly() && (! clicksOutsideDismissVirtualKeyboard || globalMouseListener.lastMouseDownInEditor());
  838. }
  839. void TextEditor::setReturnKeyStartsNewLine (bool shouldStartNewLine)
  840. {
  841. returnKeyStartsNewLine = shouldStartNewLine;
  842. }
  843. void TextEditor::setTabKeyUsedAsCharacter (bool shouldTabKeyBeUsed)
  844. {
  845. tabKeyUsed = shouldTabKeyBeUsed;
  846. }
  847. void TextEditor::setPopupMenuEnabled (bool b)
  848. {
  849. popupMenuEnabled = b;
  850. }
  851. void TextEditor::setSelectAllWhenFocused (bool b)
  852. {
  853. selectAllTextWhenFocused = b;
  854. }
  855. void TextEditor::setJustification (Justification j)
  856. {
  857. if (justification != j)
  858. {
  859. justification = j;
  860. resized();
  861. repaint();
  862. }
  863. }
  864. //==============================================================================
  865. void TextEditor::setFont (const Font& newFont)
  866. {
  867. currentFont = newFont;
  868. scrollToMakeSureCursorIsVisible();
  869. }
  870. void TextEditor::applyFontToAllText (const Font& newFont, bool changeCurrentFont)
  871. {
  872. if (changeCurrentFont)
  873. currentFont = newFont;
  874. auto overallColour = findColour (textColourId);
  875. for (auto* uts : sections)
  876. {
  877. uts->setFont (newFont, passwordCharacter);
  878. uts->colour = overallColour;
  879. }
  880. coalesceSimilarSections();
  881. checkLayout();
  882. scrollToMakeSureCursorIsVisible();
  883. repaint();
  884. }
  885. void TextEditor::applyColourToAllText (const Colour& newColour, bool changeCurrentTextColour)
  886. {
  887. for (auto* uts : sections)
  888. uts->colour = newColour;
  889. if (changeCurrentTextColour)
  890. setColour (TextEditor::textColourId, newColour);
  891. else
  892. repaint();
  893. }
  894. void TextEditor::lookAndFeelChanged()
  895. {
  896. caret.reset();
  897. recreateCaret();
  898. }
  899. void TextEditor::parentHierarchyChanged()
  900. {
  901. lookAndFeelChanged();
  902. }
  903. void TextEditor::enablementChanged()
  904. {
  905. recreateCaret();
  906. repaint();
  907. }
  908. void TextEditor::setCaretVisible (bool shouldCaretBeVisible)
  909. {
  910. if (caretVisible != shouldCaretBeVisible)
  911. {
  912. caretVisible = shouldCaretBeVisible;
  913. recreateCaret();
  914. }
  915. }
  916. void TextEditor::recreateCaret()
  917. {
  918. if (isCaretVisible())
  919. {
  920. if (caret == nullptr)
  921. {
  922. caret.reset (getLookAndFeel().createCaretComponent (this));
  923. textHolder->addChildComponent (caret.get());
  924. updateCaretPosition();
  925. }
  926. }
  927. else
  928. {
  929. caret.reset();
  930. }
  931. }
  932. void TextEditor::updateCaretPosition()
  933. {
  934. if (caret != nullptr
  935. && getWidth() > 0 && getHeight() > 0)
  936. {
  937. Iterator i (*this);
  938. caret->setCaretPosition (getCaretRectangle().translated (leftIndent,
  939. topIndent + roundToInt (i.getYOffset())) - getTextOffset());
  940. if (auto* handler = getAccessibilityHandler())
  941. handler->notifyAccessibilityEvent (AccessibilityEvent::textSelectionChanged);
  942. }
  943. }
  944. TextEditor::LengthAndCharacterRestriction::LengthAndCharacterRestriction (int maxLen, const String& chars)
  945. : allowedCharacters (chars), maxLength (maxLen)
  946. {
  947. }
  948. String TextEditor::LengthAndCharacterRestriction::filterNewText (TextEditor& ed, const String& newInput)
  949. {
  950. String t (newInput);
  951. if (allowedCharacters.isNotEmpty())
  952. t = t.retainCharacters (allowedCharacters);
  953. if (maxLength > 0)
  954. t = t.substring (0, maxLength - (ed.getTotalNumChars() - ed.getHighlightedRegion().getLength()));
  955. return t;
  956. }
  957. void TextEditor::setInputFilter (InputFilter* newFilter, bool takeOwnership)
  958. {
  959. inputFilter.set (newFilter, takeOwnership);
  960. }
  961. void TextEditor::setInputRestrictions (int maxLen, const String& chars)
  962. {
  963. setInputFilter (new LengthAndCharacterRestriction (maxLen, chars), true);
  964. }
  965. void TextEditor::setTextToShowWhenEmpty (const String& text, Colour colourToUse)
  966. {
  967. textToShowWhenEmpty = text;
  968. colourForTextWhenEmpty = colourToUse;
  969. }
  970. void TextEditor::setPasswordCharacter (juce_wchar newPasswordCharacter)
  971. {
  972. if (passwordCharacter != newPasswordCharacter)
  973. {
  974. passwordCharacter = newPasswordCharacter;
  975. applyFontToAllText (currentFont);
  976. }
  977. }
  978. void TextEditor::setScrollBarThickness (int newThicknessPixels)
  979. {
  980. viewport->setScrollBarThickness (newThicknessPixels);
  981. }
  982. //==============================================================================
  983. void TextEditor::clear()
  984. {
  985. clearInternal (nullptr);
  986. checkLayout();
  987. undoManager.clearUndoHistory();
  988. repaint();
  989. }
  990. void TextEditor::setText (const String& newText, bool sendTextChangeMessage)
  991. {
  992. auto newLength = newText.length();
  993. if (newLength != getTotalNumChars() || getText() != newText)
  994. {
  995. if (! sendTextChangeMessage)
  996. textValue.removeListener (textHolder);
  997. textValue = newText;
  998. auto oldCursorPos = caretPosition;
  999. auto cursorWasAtEnd = oldCursorPos >= getTotalNumChars();
  1000. clearInternal (nullptr);
  1001. insert (newText, 0, currentFont, findColour (textColourId), nullptr, caretPosition);
  1002. // if you're adding text with line-feeds to a single-line text editor, it
  1003. // ain't gonna look right!
  1004. jassert (multiline || ! newText.containsAnyOf ("\r\n"));
  1005. if (cursorWasAtEnd && ! isMultiLine())
  1006. oldCursorPos = getTotalNumChars();
  1007. moveCaretTo (oldCursorPos, false);
  1008. if (sendTextChangeMessage)
  1009. textChanged();
  1010. else
  1011. textValue.addListener (textHolder);
  1012. checkLayout();
  1013. scrollToMakeSureCursorIsVisible();
  1014. undoManager.clearUndoHistory();
  1015. repaint();
  1016. }
  1017. }
  1018. //==============================================================================
  1019. void TextEditor::updateValueFromText()
  1020. {
  1021. if (valueTextNeedsUpdating)
  1022. {
  1023. valueTextNeedsUpdating = false;
  1024. textValue = getText();
  1025. }
  1026. }
  1027. Value& TextEditor::getTextValue()
  1028. {
  1029. updateValueFromText();
  1030. return textValue;
  1031. }
  1032. void TextEditor::textWasChangedByValue()
  1033. {
  1034. if (textValue.getValueSource().getReferenceCount() > 1)
  1035. setText (textValue.getValue());
  1036. }
  1037. //==============================================================================
  1038. void TextEditor::textChanged()
  1039. {
  1040. checkLayout();
  1041. if (listeners.size() != 0 || onTextChange != nullptr)
  1042. postCommandMessage (TextEditorDefs::textChangeMessageId);
  1043. if (textValue.getValueSource().getReferenceCount() > 1)
  1044. {
  1045. valueTextNeedsUpdating = false;
  1046. textValue = getText();
  1047. }
  1048. if (auto* handler = getAccessibilityHandler())
  1049. handler->notifyAccessibilityEvent (AccessibilityEvent::textChanged);
  1050. }
  1051. void TextEditor::setSelection (Range<int> newSelection) noexcept
  1052. {
  1053. if (newSelection != selection)
  1054. {
  1055. selection = newSelection;
  1056. if (auto* handler = getAccessibilityHandler())
  1057. handler->notifyAccessibilityEvent (AccessibilityEvent::textSelectionChanged);
  1058. }
  1059. }
  1060. void TextEditor::returnPressed() { postCommandMessage (TextEditorDefs::returnKeyMessageId); }
  1061. void TextEditor::escapePressed() { postCommandMessage (TextEditorDefs::escapeKeyMessageId); }
  1062. void TextEditor::addListener (Listener* l) { listeners.add (l); }
  1063. void TextEditor::removeListener (Listener* l) { listeners.remove (l); }
  1064. //==============================================================================
  1065. void TextEditor::timerCallbackInt()
  1066. {
  1067. checkFocus();
  1068. auto now = Time::getApproximateMillisecondCounter();
  1069. if (now > lastTransactionTime + 200)
  1070. newTransaction();
  1071. }
  1072. void TextEditor::checkFocus()
  1073. {
  1074. if (! wasFocused && hasKeyboardFocus (false) && ! isCurrentlyBlockedByAnotherModalComponent())
  1075. wasFocused = true;
  1076. }
  1077. void TextEditor::repaintText (Range<int> range)
  1078. {
  1079. if (! range.isEmpty())
  1080. {
  1081. if (range.getEnd() >= getTotalNumChars())
  1082. {
  1083. textHolder->repaint();
  1084. return;
  1085. }
  1086. Iterator i (*this);
  1087. Point<float> anchor;
  1088. auto lh = currentFont.getHeight();
  1089. i.getCharPosition (range.getStart(), anchor, lh);
  1090. auto y1 = std::trunc (anchor.y);
  1091. int y2 = 0;
  1092. if (range.getEnd() >= getTotalNumChars())
  1093. {
  1094. y2 = textHolder->getHeight();
  1095. }
  1096. else
  1097. {
  1098. i.getCharPosition (range.getEnd(), anchor, lh);
  1099. y2 = (int) (anchor.y + lh * 2.0f);
  1100. }
  1101. auto offset = i.getYOffset();
  1102. textHolder->repaint (0, roundToInt (y1 + offset), textHolder->getWidth(), roundToInt ((float) y2 - y1 + offset));
  1103. }
  1104. }
  1105. //==============================================================================
  1106. void TextEditor::moveCaret (const int newCaretPos)
  1107. {
  1108. const auto clamped = std::clamp (newCaretPos, 0, getTotalNumChars());
  1109. if (clamped == getCaretPosition())
  1110. return;
  1111. caretPosition = clamped;
  1112. if (hasKeyboardFocus (false))
  1113. textHolder->restartTimer();
  1114. scrollToMakeSureCursorIsVisible();
  1115. updateCaretPosition();
  1116. if (auto* handler = getAccessibilityHandler())
  1117. handler->notifyAccessibilityEvent (AccessibilityEvent::textChanged);
  1118. }
  1119. int TextEditor::getCaretPosition() const
  1120. {
  1121. return caretPosition;
  1122. }
  1123. void TextEditor::setCaretPosition (const int newIndex)
  1124. {
  1125. moveCaretTo (newIndex, false);
  1126. }
  1127. void TextEditor::moveCaretToEnd()
  1128. {
  1129. setCaretPosition (std::numeric_limits<int>::max());
  1130. }
  1131. void TextEditor::scrollEditorToPositionCaret (const int desiredCaretX,
  1132. const int desiredCaretY)
  1133. {
  1134. updateCaretPosition();
  1135. auto caretRect = getCaretRectangle().translated (leftIndent, topIndent);
  1136. auto vx = caretRect.getX() - desiredCaretX;
  1137. auto vy = caretRect.getY() - desiredCaretY;
  1138. if (desiredCaretX < jmax (1, proportionOfWidth (0.05f)))
  1139. vx += desiredCaretX - proportionOfWidth (0.2f);
  1140. else if (desiredCaretX > jmax (0, viewport->getMaximumVisibleWidth() - (wordWrap ? 2 : 10)))
  1141. vx += desiredCaretX + (isMultiLine() ? proportionOfWidth (0.2f) : 10) - viewport->getMaximumVisibleWidth();
  1142. vx = jlimit (0, jmax (0, textHolder->getWidth() + 8 - viewport->getMaximumVisibleWidth()), vx);
  1143. if (! isMultiLine())
  1144. {
  1145. vy = viewport->getViewPositionY();
  1146. }
  1147. else
  1148. {
  1149. vy = jlimit (0, jmax (0, textHolder->getHeight() - viewport->getMaximumVisibleHeight()), vy);
  1150. if (desiredCaretY < 0)
  1151. vy = jmax (0, desiredCaretY + vy);
  1152. else if (desiredCaretY > jmax (0, viewport->getMaximumVisibleHeight() - caretRect.getHeight()))
  1153. vy += desiredCaretY + 2 + caretRect.getHeight() - viewport->getMaximumVisibleHeight();
  1154. }
  1155. viewport->setViewPosition (vx, vy);
  1156. }
  1157. Rectangle<int> TextEditor::getCaretRectangleForCharIndex (int index) const
  1158. {
  1159. Point<float> anchor;
  1160. auto cursorHeight = currentFont.getHeight(); // (in case the text is empty and the call below doesn't set this value)
  1161. getCharPosition (index, anchor, cursorHeight);
  1162. return Rectangle<float> { anchor.x, anchor.y, 2.0f, cursorHeight }.getSmallestIntegerContainer() + getTextOffset();
  1163. }
  1164. Point<int> TextEditor::getTextOffset() const noexcept
  1165. {
  1166. Iterator i (*this);
  1167. auto yOffset = i.getYOffset();
  1168. return { getLeftIndent() + borderSize.getLeft() - viewport->getViewPositionX(),
  1169. roundToInt ((float) getTopIndent() + (float) borderSize.getTop() + yOffset) - viewport->getViewPositionY() };
  1170. }
  1171. RectangleList<int> TextEditor::getTextBounds (Range<int> textRange) const
  1172. {
  1173. RectangleList<int> boundingBox;
  1174. Iterator i (*this);
  1175. while (i.next())
  1176. {
  1177. if (textRange.intersects ({ i.indexInText,
  1178. i.indexInText + i.atom->numChars }))
  1179. {
  1180. boundingBox.add (i.getTextBounds (textRange));
  1181. }
  1182. }
  1183. boundingBox.offsetAll (getTextOffset());
  1184. return boundingBox;
  1185. }
  1186. //==============================================================================
  1187. // Extra space for the cursor at the right-hand-edge
  1188. constexpr int rightEdgeSpace = 2;
  1189. int TextEditor::getWordWrapWidth() const
  1190. {
  1191. return wordWrap ? getMaximumTextWidth()
  1192. : std::numeric_limits<int>::max();
  1193. }
  1194. int TextEditor::getMaximumTextWidth() const
  1195. {
  1196. return jmax (1, viewport->getMaximumVisibleWidth() - leftIndent - rightEdgeSpace);
  1197. }
  1198. int TextEditor::getMaximumTextHeight() const
  1199. {
  1200. return jmax (1, viewport->getMaximumVisibleHeight() - topIndent);
  1201. }
  1202. void TextEditor::checkLayout()
  1203. {
  1204. if (getWordWrapWidth() > 0)
  1205. {
  1206. const auto textBottom = Iterator (*this).getTotalTextHeight() + topIndent;
  1207. const auto textRight = jmax (viewport->getMaximumVisibleWidth(),
  1208. Iterator (*this).getTextRight() + leftIndent + rightEdgeSpace);
  1209. textHolder->setSize (textRight, textBottom);
  1210. viewport->setScrollBarsShown (scrollbarVisible && multiline && textBottom > viewport->getMaximumVisibleHeight(),
  1211. scrollbarVisible && multiline && ! wordWrap && textRight > viewport->getMaximumVisibleWidth());
  1212. }
  1213. }
  1214. int TextEditor::getTextWidth() const { return textHolder->getWidth(); }
  1215. int TextEditor::getTextHeight() const { return textHolder->getHeight(); }
  1216. void TextEditor::setIndents (int newLeftIndent, int newTopIndent)
  1217. {
  1218. if (leftIndent != newLeftIndent || topIndent != newTopIndent)
  1219. {
  1220. leftIndent = newLeftIndent;
  1221. topIndent = newTopIndent;
  1222. resized();
  1223. repaint();
  1224. }
  1225. }
  1226. void TextEditor::setBorder (BorderSize<int> border)
  1227. {
  1228. borderSize = border;
  1229. resized();
  1230. }
  1231. BorderSize<int> TextEditor::getBorder() const
  1232. {
  1233. return borderSize;
  1234. }
  1235. void TextEditor::setScrollToShowCursor (const bool shouldScrollToShowCursor)
  1236. {
  1237. keepCaretOnScreen = shouldScrollToShowCursor;
  1238. }
  1239. void TextEditor::scrollToMakeSureCursorIsVisible()
  1240. {
  1241. updateCaretPosition();
  1242. if (keepCaretOnScreen)
  1243. {
  1244. auto viewPos = viewport->getViewPosition();
  1245. auto caretRect = getCaretRectangle().translated (leftIndent, topIndent) - getTextOffset();
  1246. auto relativeCursor = caretRect.getPosition() - viewPos;
  1247. if (relativeCursor.x < jmax (1, proportionOfWidth (0.05f)))
  1248. {
  1249. viewPos.x += relativeCursor.x - proportionOfWidth (0.2f);
  1250. }
  1251. else if (relativeCursor.x > jmax (0, viewport->getMaximumVisibleWidth() - (wordWrap ? 2 : 10)))
  1252. {
  1253. viewPos.x += relativeCursor.x + (isMultiLine() ? proportionOfWidth (0.2f) : 10) - viewport->getMaximumVisibleWidth();
  1254. }
  1255. viewPos.x = jlimit (0, jmax (0, textHolder->getWidth() + 8 - viewport->getMaximumVisibleWidth()), viewPos.x);
  1256. if (! isMultiLine())
  1257. {
  1258. viewPos.y = (getHeight() - textHolder->getHeight() - topIndent) / -2;
  1259. }
  1260. else if (relativeCursor.y < 0)
  1261. {
  1262. viewPos.y = jmax (0, relativeCursor.y + viewPos.y);
  1263. }
  1264. else if (relativeCursor.y > jmax (0, viewport->getMaximumVisibleHeight() - caretRect.getHeight()))
  1265. {
  1266. viewPos.y += relativeCursor.y + 2 + caretRect.getHeight() - viewport->getMaximumVisibleHeight();
  1267. }
  1268. viewport->setViewPosition (viewPos);
  1269. }
  1270. }
  1271. void TextEditor::moveCaretTo (const int newPosition, const bool isSelecting)
  1272. {
  1273. if (isSelecting)
  1274. {
  1275. moveCaret (newPosition);
  1276. auto oldSelection = selection;
  1277. if (dragType == notDragging)
  1278. {
  1279. if (std::abs (getCaretPosition() - selection.getStart()) < std::abs (getCaretPosition() - selection.getEnd()))
  1280. dragType = draggingSelectionStart;
  1281. else
  1282. dragType = draggingSelectionEnd;
  1283. }
  1284. if (dragType == draggingSelectionStart)
  1285. {
  1286. if (getCaretPosition() >= selection.getEnd())
  1287. dragType = draggingSelectionEnd;
  1288. setSelection (Range<int>::between (getCaretPosition(), selection.getEnd()));
  1289. }
  1290. else
  1291. {
  1292. if (getCaretPosition() < selection.getStart())
  1293. dragType = draggingSelectionStart;
  1294. setSelection (Range<int>::between (getCaretPosition(), selection.getStart()));
  1295. }
  1296. repaintText (selection.getUnionWith (oldSelection));
  1297. }
  1298. else
  1299. {
  1300. dragType = notDragging;
  1301. repaintText (selection);
  1302. moveCaret (newPosition);
  1303. setSelection (Range<int>::emptyRange (getCaretPosition()));
  1304. }
  1305. }
  1306. int TextEditor::getTextIndexAt (const int x, const int y) const
  1307. {
  1308. const auto offset = getTextOffset();
  1309. return indexAtPosition ((float) (x - offset.x),
  1310. (float) (y - offset.y));
  1311. }
  1312. int TextEditor::getTextIndexAt (const Point<int> pt) const
  1313. {
  1314. return getTextIndexAt (pt.x, pt.y);
  1315. }
  1316. int TextEditor::getCharIndexForPoint (const Point<int> point) const
  1317. {
  1318. return getTextIndexAt (isMultiLine() ? point : getTextBounds ({ 0, getTotalNumChars() }).getBounds().getConstrainedPoint (point));
  1319. }
  1320. void TextEditor::insertTextAtCaret (const String& t)
  1321. {
  1322. const auto filtered = inputFilter != nullptr ? inputFilter->filterNewText (*this, t) : t;
  1323. const auto newText = isMultiLine() ? filtered.replace ("\r\n", "\n")
  1324. : filtered.replaceCharacters ("\r\n", " ");
  1325. const auto insertIndex = selection.getStart();
  1326. const auto newCaretPos = insertIndex + newText.length();
  1327. remove (selection, getUndoManager(),
  1328. newText.isNotEmpty() ? newCaretPos - 1 : newCaretPos);
  1329. insert (newText, insertIndex, currentFont, findColour (textColourId),
  1330. getUndoManager(), newCaretPos);
  1331. textChanged();
  1332. }
  1333. void TextEditor::setHighlightedRegion (const Range<int>& newSelection)
  1334. {
  1335. if (newSelection == getHighlightedRegion())
  1336. return;
  1337. const auto cursorAtStart = newSelection.getEnd() == getHighlightedRegion().getStart()
  1338. || newSelection.getEnd() == getHighlightedRegion().getEnd();
  1339. moveCaretTo (cursorAtStart ? newSelection.getEnd() : newSelection.getStart(), false);
  1340. moveCaretTo (cursorAtStart ? newSelection.getStart() : newSelection.getEnd(), true);
  1341. }
  1342. //==============================================================================
  1343. void TextEditor::copy()
  1344. {
  1345. if (passwordCharacter == 0)
  1346. {
  1347. auto selectedText = getHighlightedText();
  1348. if (selectedText.isNotEmpty())
  1349. SystemClipboard::copyTextToClipboard (selectedText);
  1350. }
  1351. }
  1352. void TextEditor::paste()
  1353. {
  1354. if (! isReadOnly())
  1355. {
  1356. auto clip = SystemClipboard::getTextFromClipboard();
  1357. if (clip.isNotEmpty())
  1358. insertTextAtCaret (clip);
  1359. }
  1360. }
  1361. void TextEditor::cut()
  1362. {
  1363. if (! isReadOnly())
  1364. {
  1365. moveCaret (selection.getEnd());
  1366. insertTextAtCaret (String());
  1367. }
  1368. }
  1369. //==============================================================================
  1370. void TextEditor::drawContent (Graphics& g)
  1371. {
  1372. if (getWordWrapWidth() > 0)
  1373. {
  1374. g.setOrigin (leftIndent, topIndent);
  1375. auto clip = g.getClipBounds();
  1376. auto yOffset = Iterator (*this).getYOffset();
  1377. AffineTransform transform;
  1378. if (yOffset > 0)
  1379. {
  1380. transform = AffineTransform::translation (0.0f, yOffset);
  1381. clip.setY (roundToInt ((float) clip.getY() - yOffset));
  1382. }
  1383. Iterator i (*this);
  1384. Colour selectedTextColour;
  1385. if (! selection.isEmpty())
  1386. {
  1387. selectedTextColour = findColour (highlightedTextColourId);
  1388. g.setColour (findColour (highlightColourId).withMultipliedAlpha (hasKeyboardFocus (true) ? 1.0f : 0.5f));
  1389. auto boundingBox = getTextBounds (selection);
  1390. boundingBox.offsetAll (-getTextOffset());
  1391. g.fillPath (boundingBox.toPath(), transform);
  1392. }
  1393. const UniformTextSection* lastSection = nullptr;
  1394. while (i.next() && i.lineY < (float) clip.getBottom())
  1395. {
  1396. if (i.lineY + i.lineHeight >= (float) clip.getY())
  1397. {
  1398. if (selection.intersects ({ i.indexInText, i.indexInText + i.atom->numChars }))
  1399. {
  1400. i.drawSelectedText (g, selection, selectedTextColour, transform);
  1401. lastSection = nullptr;
  1402. }
  1403. else
  1404. {
  1405. i.draw (g, lastSection, transform);
  1406. }
  1407. }
  1408. }
  1409. for (auto& underlinedSection : underlinedSections)
  1410. {
  1411. Iterator i2 (*this);
  1412. while (i2.next() && i2.lineY < (float) clip.getBottom())
  1413. {
  1414. if (i2.lineY + i2.lineHeight >= (float) clip.getY()
  1415. && underlinedSection.intersects ({ i2.indexInText, i2.indexInText + i2.atom->numChars }))
  1416. {
  1417. i2.drawUnderline (g, underlinedSection, findColour (textColourId), transform);
  1418. }
  1419. }
  1420. }
  1421. }
  1422. }
  1423. void TextEditor::paint (Graphics& g)
  1424. {
  1425. getLookAndFeel().fillTextEditorBackground (g, getWidth(), getHeight(), *this);
  1426. }
  1427. void TextEditor::paintOverChildren (Graphics& g)
  1428. {
  1429. if (textToShowWhenEmpty.isNotEmpty()
  1430. && (! hasKeyboardFocus (false))
  1431. && getTotalNumChars() == 0)
  1432. {
  1433. g.setColour (colourForTextWhenEmpty);
  1434. g.setFont (getFont());
  1435. Rectangle<int> textBounds (leftIndent,
  1436. topIndent,
  1437. viewport->getWidth() - leftIndent,
  1438. getHeight() - topIndent);
  1439. if (! textBounds.isEmpty())
  1440. g.drawText (textToShowWhenEmpty, textBounds, justification, true);
  1441. }
  1442. getLookAndFeel().drawTextEditorOutline (g, getWidth(), getHeight(), *this);
  1443. }
  1444. //==============================================================================
  1445. void TextEditor::addPopupMenuItems (PopupMenu& m, const MouseEvent*)
  1446. {
  1447. const bool writable = ! isReadOnly();
  1448. if (passwordCharacter == 0)
  1449. {
  1450. m.addItem (StandardApplicationCommandIDs::cut, TRANS ("Cut"), writable);
  1451. m.addItem (StandardApplicationCommandIDs::copy, TRANS ("Copy"), ! selection.isEmpty());
  1452. }
  1453. m.addItem (StandardApplicationCommandIDs::paste, TRANS ("Paste"), writable);
  1454. m.addItem (StandardApplicationCommandIDs::del, TRANS ("Delete"), writable);
  1455. m.addSeparator();
  1456. m.addItem (StandardApplicationCommandIDs::selectAll, TRANS ("Select All"));
  1457. m.addSeparator();
  1458. if (getUndoManager() != nullptr)
  1459. {
  1460. m.addItem (StandardApplicationCommandIDs::undo, TRANS ("Undo"), undoManager.canUndo());
  1461. m.addItem (StandardApplicationCommandIDs::redo, TRANS ("Redo"), undoManager.canRedo());
  1462. }
  1463. }
  1464. void TextEditor::performPopupMenuAction (const int menuItemID)
  1465. {
  1466. switch (menuItemID)
  1467. {
  1468. case StandardApplicationCommandIDs::cut: cutToClipboard(); break;
  1469. case StandardApplicationCommandIDs::copy: copyToClipboard(); break;
  1470. case StandardApplicationCommandIDs::paste: pasteFromClipboard(); break;
  1471. case StandardApplicationCommandIDs::del: cut(); break;
  1472. case StandardApplicationCommandIDs::selectAll: selectAll(); break;
  1473. case StandardApplicationCommandIDs::undo: undo(); break;
  1474. case StandardApplicationCommandIDs::redo: redo(); break;
  1475. default: break;
  1476. }
  1477. }
  1478. //==============================================================================
  1479. void TextEditor::mouseDown (const MouseEvent& e)
  1480. {
  1481. beginDragAutoRepeat (100);
  1482. newTransaction();
  1483. if (wasFocused || ! selectAllTextWhenFocused)
  1484. {
  1485. if (! (popupMenuEnabled && e.mods.isPopupMenu()))
  1486. {
  1487. moveCaretTo (getTextIndexAt (e.getPosition()), e.mods.isShiftDown());
  1488. if (auto* peer = getPeer())
  1489. peer->closeInputMethodContext();
  1490. }
  1491. else
  1492. {
  1493. PopupMenu m;
  1494. m.setLookAndFeel (&getLookAndFeel());
  1495. addPopupMenuItems (m, &e);
  1496. menuActive = true;
  1497. m.showMenuAsync (PopupMenu::Options(),
  1498. [safeThis = SafePointer<TextEditor> { this }] (int menuResult)
  1499. {
  1500. if (auto* editor = safeThis.getComponent())
  1501. {
  1502. editor->menuActive = false;
  1503. if (menuResult != 0)
  1504. editor->performPopupMenuAction (menuResult);
  1505. }
  1506. });
  1507. }
  1508. }
  1509. }
  1510. void TextEditor::mouseDrag (const MouseEvent& e)
  1511. {
  1512. if (wasFocused || ! selectAllTextWhenFocused)
  1513. if (! (popupMenuEnabled && e.mods.isPopupMenu()))
  1514. moveCaretTo (getTextIndexAt (e.getPosition()), true);
  1515. }
  1516. void TextEditor::mouseUp (const MouseEvent& e)
  1517. {
  1518. newTransaction();
  1519. textHolder->restartTimer();
  1520. if (wasFocused || ! selectAllTextWhenFocused)
  1521. if (e.mouseWasClicked() && ! (popupMenuEnabled && e.mods.isPopupMenu()))
  1522. moveCaret (getTextIndexAt (e.getPosition()));
  1523. wasFocused = true;
  1524. }
  1525. void TextEditor::mouseDoubleClick (const MouseEvent& e)
  1526. {
  1527. int tokenEnd = getTextIndexAt (e.getPosition());
  1528. int tokenStart = 0;
  1529. if (e.getNumberOfClicks() > 3)
  1530. {
  1531. tokenEnd = getTotalNumChars();
  1532. }
  1533. else
  1534. {
  1535. auto t = getText();
  1536. auto totalLength = getTotalNumChars();
  1537. while (tokenEnd < totalLength)
  1538. {
  1539. auto c = t[tokenEnd];
  1540. // (note the slight bodge here - it's because iswalnum only checks for alphabetic chars in the current locale)
  1541. if (CharacterFunctions::isLetterOrDigit (c) || c > 128)
  1542. ++tokenEnd;
  1543. else
  1544. break;
  1545. }
  1546. tokenStart = tokenEnd;
  1547. while (tokenStart > 0)
  1548. {
  1549. auto c = t[tokenStart - 1];
  1550. // (note the slight bodge here - it's because iswalnum only checks for alphabetic chars in the current locale)
  1551. if (CharacterFunctions::isLetterOrDigit (c) || c > 128)
  1552. --tokenStart;
  1553. else
  1554. break;
  1555. }
  1556. if (e.getNumberOfClicks() > 2)
  1557. {
  1558. while (tokenEnd < totalLength)
  1559. {
  1560. auto c = t[tokenEnd];
  1561. if (c != '\r' && c != '\n')
  1562. ++tokenEnd;
  1563. else
  1564. break;
  1565. }
  1566. while (tokenStart > 0)
  1567. {
  1568. auto c = t[tokenStart - 1];
  1569. if (c != '\r' && c != '\n')
  1570. --tokenStart;
  1571. else
  1572. break;
  1573. }
  1574. }
  1575. }
  1576. moveCaretTo (tokenEnd, false);
  1577. moveCaretTo (tokenStart, true);
  1578. }
  1579. void TextEditor::mouseWheelMove (const MouseEvent& e, const MouseWheelDetails& wheel)
  1580. {
  1581. if (! viewport->useMouseWheelMoveIfNeeded (e, wheel))
  1582. Component::mouseWheelMove (e, wheel);
  1583. }
  1584. //==============================================================================
  1585. bool TextEditor::moveCaretWithTransaction (const int newPos, const bool selecting)
  1586. {
  1587. newTransaction();
  1588. moveCaretTo (newPos, selecting);
  1589. if (auto* peer = getPeer())
  1590. peer->closeInputMethodContext();
  1591. return true;
  1592. }
  1593. bool TextEditor::moveCaretLeft (bool moveInWholeWordSteps, bool selecting)
  1594. {
  1595. auto pos = getCaretPosition();
  1596. if (moveInWholeWordSteps)
  1597. pos = findWordBreakBefore (pos);
  1598. else
  1599. --pos;
  1600. return moveCaretWithTransaction (pos, selecting);
  1601. }
  1602. bool TextEditor::moveCaretRight (bool moveInWholeWordSteps, bool selecting)
  1603. {
  1604. auto pos = getCaretPosition();
  1605. if (moveInWholeWordSteps)
  1606. pos = findWordBreakAfter (pos);
  1607. else
  1608. ++pos;
  1609. return moveCaretWithTransaction (pos, selecting);
  1610. }
  1611. bool TextEditor::moveCaretUp (bool selecting)
  1612. {
  1613. if (! isMultiLine())
  1614. return moveCaretToStartOfLine (selecting);
  1615. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1616. const auto newY = caretPos.getY() - 1.0f;
  1617. if (newY < 0.0f)
  1618. return moveCaretToStartOfLine (selecting);
  1619. return moveCaretWithTransaction (indexAtPosition (caretPos.getX(), newY), selecting);
  1620. }
  1621. bool TextEditor::moveCaretDown (bool selecting)
  1622. {
  1623. if (! isMultiLine())
  1624. return moveCaretToEndOfLine (selecting);
  1625. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1626. return moveCaretWithTransaction (indexAtPosition (caretPos.getX(), caretPos.getBottom() + 1.0f), selecting);
  1627. }
  1628. bool TextEditor::pageUp (bool selecting)
  1629. {
  1630. if (! isMultiLine())
  1631. return moveCaretToStartOfLine (selecting);
  1632. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1633. return moveCaretWithTransaction (indexAtPosition (caretPos.getX(), caretPos.getY() - (float) viewport->getViewHeight()), selecting);
  1634. }
  1635. bool TextEditor::pageDown (bool selecting)
  1636. {
  1637. if (! isMultiLine())
  1638. return moveCaretToEndOfLine (selecting);
  1639. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1640. return moveCaretWithTransaction (indexAtPosition (caretPos.getX(), caretPos.getBottom() + (float) viewport->getViewHeight()), selecting);
  1641. }
  1642. void TextEditor::scrollByLines (int deltaLines)
  1643. {
  1644. viewport->getVerticalScrollBar().moveScrollbarInSteps (deltaLines);
  1645. }
  1646. bool TextEditor::scrollDown()
  1647. {
  1648. scrollByLines (-1);
  1649. return true;
  1650. }
  1651. bool TextEditor::scrollUp()
  1652. {
  1653. scrollByLines (1);
  1654. return true;
  1655. }
  1656. bool TextEditor::moveCaretToTop (bool selecting)
  1657. {
  1658. return moveCaretWithTransaction (0, selecting);
  1659. }
  1660. bool TextEditor::moveCaretToStartOfLine (bool selecting)
  1661. {
  1662. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1663. return moveCaretWithTransaction (indexAtPosition (0.0f, caretPos.getCentreY()), selecting);
  1664. }
  1665. bool TextEditor::moveCaretToEnd (bool selecting)
  1666. {
  1667. return moveCaretWithTransaction (getTotalNumChars(), selecting);
  1668. }
  1669. bool TextEditor::moveCaretToEndOfLine (bool selecting)
  1670. {
  1671. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1672. return moveCaretWithTransaction (indexAtPosition ((float) textHolder->getWidth(), caretPos.getCentreY()), selecting);
  1673. }
  1674. bool TextEditor::deleteBackwards (bool moveInWholeWordSteps)
  1675. {
  1676. if (moveInWholeWordSteps)
  1677. moveCaretTo (findWordBreakBefore (getCaretPosition()), true);
  1678. else if (selection.isEmpty() && selection.getStart() > 0)
  1679. setSelection ({ selection.getEnd() - 1, selection.getEnd() });
  1680. cut();
  1681. return true;
  1682. }
  1683. bool TextEditor::deleteForwards (bool /*moveInWholeWordSteps*/)
  1684. {
  1685. if (selection.isEmpty() && selection.getStart() < getTotalNumChars())
  1686. setSelection ({ selection.getStart(), selection.getStart() + 1 });
  1687. cut();
  1688. return true;
  1689. }
  1690. bool TextEditor::copyToClipboard()
  1691. {
  1692. newTransaction();
  1693. copy();
  1694. return true;
  1695. }
  1696. bool TextEditor::cutToClipboard()
  1697. {
  1698. newTransaction();
  1699. copy();
  1700. cut();
  1701. return true;
  1702. }
  1703. bool TextEditor::pasteFromClipboard()
  1704. {
  1705. newTransaction();
  1706. paste();
  1707. return true;
  1708. }
  1709. bool TextEditor::selectAll()
  1710. {
  1711. newTransaction();
  1712. moveCaretTo (getTotalNumChars(), false);
  1713. moveCaretTo (0, true);
  1714. return true;
  1715. }
  1716. //==============================================================================
  1717. void TextEditor::setEscapeAndReturnKeysConsumed (bool shouldBeConsumed) noexcept
  1718. {
  1719. consumeEscAndReturnKeys = shouldBeConsumed;
  1720. }
  1721. bool TextEditor::keyPressed (const KeyPress& key)
  1722. {
  1723. if (isReadOnly() && key != KeyPress ('c', ModifierKeys::commandModifier, 0)
  1724. && key != KeyPress ('a', ModifierKeys::commandModifier, 0))
  1725. return false;
  1726. if (! TextEditorKeyMapper<TextEditor>::invokeKeyFunction (*this, key))
  1727. {
  1728. if (key == KeyPress::returnKey)
  1729. {
  1730. newTransaction();
  1731. if (returnKeyStartsNewLine)
  1732. {
  1733. insertTextAtCaret ("\n");
  1734. }
  1735. else
  1736. {
  1737. returnPressed();
  1738. return consumeEscAndReturnKeys;
  1739. }
  1740. }
  1741. else if (key.isKeyCode (KeyPress::escapeKey))
  1742. {
  1743. newTransaction();
  1744. moveCaretTo (getCaretPosition(), false);
  1745. escapePressed();
  1746. return consumeEscAndReturnKeys;
  1747. }
  1748. else if (key.getTextCharacter() >= ' '
  1749. || (tabKeyUsed && (key.getTextCharacter() == '\t')))
  1750. {
  1751. insertTextAtCaret (String::charToString (key.getTextCharacter()));
  1752. lastTransactionTime = Time::getApproximateMillisecondCounter();
  1753. }
  1754. else
  1755. {
  1756. return false;
  1757. }
  1758. }
  1759. return true;
  1760. }
  1761. bool TextEditor::keyStateChanged (const bool isKeyDown)
  1762. {
  1763. if (! isKeyDown)
  1764. return false;
  1765. #if JUCE_WINDOWS
  1766. if (KeyPress (KeyPress::F4Key, ModifierKeys::altModifier, 0).isCurrentlyDown())
  1767. return false; // We need to explicitly allow alt-F4 to pass through on Windows
  1768. #endif
  1769. if ((! consumeEscAndReturnKeys)
  1770. && (KeyPress (KeyPress::escapeKey).isCurrentlyDown()
  1771. || KeyPress (KeyPress::returnKey).isCurrentlyDown()))
  1772. return false;
  1773. // (overridden to avoid forwarding key events to the parent)
  1774. return ! ModifierKeys::currentModifiers.isCommandDown();
  1775. }
  1776. //==============================================================================
  1777. void TextEditor::focusGained (FocusChangeType cause)
  1778. {
  1779. newTransaction();
  1780. if (selectAllTextWhenFocused)
  1781. {
  1782. moveCaretTo (0, false);
  1783. moveCaretTo (getTotalNumChars(), true);
  1784. }
  1785. checkFocus();
  1786. if (cause == FocusChangeType::focusChangedByMouseClick && selectAllTextWhenFocused)
  1787. wasFocused = false;
  1788. repaint();
  1789. updateCaretPosition();
  1790. }
  1791. void TextEditor::focusLost (FocusChangeType)
  1792. {
  1793. newTransaction();
  1794. wasFocused = false;
  1795. textHolder->stopTimer();
  1796. underlinedSections.clear();
  1797. updateCaretPosition();
  1798. postCommandMessage (TextEditorDefs::focusLossMessageId);
  1799. repaint();
  1800. }
  1801. //==============================================================================
  1802. void TextEditor::resized()
  1803. {
  1804. viewport->setBoundsInset (borderSize);
  1805. viewport->setSingleStepSizes (16, roundToInt (currentFont.getHeight()));
  1806. checkLayout();
  1807. if (isMultiLine())
  1808. updateCaretPosition();
  1809. else
  1810. scrollToMakeSureCursorIsVisible();
  1811. }
  1812. void TextEditor::handleCommandMessage (const int commandId)
  1813. {
  1814. Component::BailOutChecker checker (this);
  1815. switch (commandId)
  1816. {
  1817. case TextEditorDefs::textChangeMessageId:
  1818. listeners.callChecked (checker, [this] (Listener& l) { l.textEditorTextChanged (*this); });
  1819. if (! checker.shouldBailOut())
  1820. NullCheckedInvocation::invoke (onTextChange);
  1821. break;
  1822. case TextEditorDefs::returnKeyMessageId:
  1823. listeners.callChecked (checker, [this] (Listener& l) { l.textEditorReturnKeyPressed (*this); });
  1824. if (! checker.shouldBailOut())
  1825. NullCheckedInvocation::invoke (onReturnKey);
  1826. break;
  1827. case TextEditorDefs::escapeKeyMessageId:
  1828. listeners.callChecked (checker, [this] (Listener& l) { l.textEditorEscapeKeyPressed (*this); });
  1829. if (! checker.shouldBailOut())
  1830. NullCheckedInvocation::invoke (onEscapeKey);
  1831. break;
  1832. case TextEditorDefs::focusLossMessageId:
  1833. updateValueFromText();
  1834. listeners.callChecked (checker, [this] (Listener& l) { l.textEditorFocusLost (*this); });
  1835. if (! checker.shouldBailOut())
  1836. NullCheckedInvocation::invoke (onFocusLost);
  1837. break;
  1838. default:
  1839. jassertfalse;
  1840. break;
  1841. }
  1842. }
  1843. void TextEditor::setTemporaryUnderlining (const Array<Range<int>>& newUnderlinedSections)
  1844. {
  1845. underlinedSections = newUnderlinedSections;
  1846. repaint();
  1847. }
  1848. TextInputTarget::VirtualKeyboardType TextEditor::getKeyboardType()
  1849. {
  1850. return passwordCharacter != 0 ? passwordKeyboard : keyboardType;
  1851. }
  1852. //==============================================================================
  1853. UndoManager* TextEditor::getUndoManager() noexcept
  1854. {
  1855. return readOnly ? nullptr : &undoManager;
  1856. }
  1857. void TextEditor::clearInternal (UndoManager* const um)
  1858. {
  1859. remove ({ 0, getTotalNumChars() }, um, caretPosition);
  1860. }
  1861. void TextEditor::insert (const String& text, int insertIndex, const Font& font,
  1862. Colour colour, UndoManager* um, int caretPositionToMoveTo)
  1863. {
  1864. if (text.isNotEmpty())
  1865. {
  1866. if (um != nullptr)
  1867. {
  1868. if (um->getNumActionsInCurrentTransaction() > TextEditorDefs::maxActionsPerTransaction)
  1869. newTransaction();
  1870. um->perform (new InsertAction (*this, text, insertIndex, font, colour,
  1871. caretPosition, caretPositionToMoveTo));
  1872. }
  1873. else
  1874. {
  1875. repaintText ({ insertIndex, getTotalNumChars() }); // must do this before and after changing the data, in case
  1876. // a line gets moved due to word wrap
  1877. int index = 0;
  1878. int nextIndex = 0;
  1879. for (int i = 0; i < sections.size(); ++i)
  1880. {
  1881. nextIndex = index + sections.getUnchecked (i)->getTotalLength();
  1882. if (insertIndex == index)
  1883. {
  1884. sections.insert (i, new UniformTextSection (text, font, colour, passwordCharacter));
  1885. break;
  1886. }
  1887. if (insertIndex > index && insertIndex < nextIndex)
  1888. {
  1889. splitSection (i, insertIndex - index);
  1890. sections.insert (i + 1, new UniformTextSection (text, font, colour, passwordCharacter));
  1891. break;
  1892. }
  1893. index = nextIndex;
  1894. }
  1895. if (nextIndex == insertIndex)
  1896. sections.add (new UniformTextSection (text, font, colour, passwordCharacter));
  1897. coalesceSimilarSections();
  1898. totalNumChars = -1;
  1899. valueTextNeedsUpdating = true;
  1900. checkLayout();
  1901. moveCaretTo (caretPositionToMoveTo, false);
  1902. repaintText ({ insertIndex, getTotalNumChars() });
  1903. }
  1904. }
  1905. }
  1906. void TextEditor::reinsert (int insertIndex, const OwnedArray<UniformTextSection>& sectionsToInsert)
  1907. {
  1908. int index = 0;
  1909. int nextIndex = 0;
  1910. for (int i = 0; i < sections.size(); ++i)
  1911. {
  1912. nextIndex = index + sections.getUnchecked (i)->getTotalLength();
  1913. if (insertIndex == index)
  1914. {
  1915. for (int j = sectionsToInsert.size(); --j >= 0;)
  1916. sections.insert (i, new UniformTextSection (*sectionsToInsert.getUnchecked (j)));
  1917. break;
  1918. }
  1919. if (insertIndex > index && insertIndex < nextIndex)
  1920. {
  1921. splitSection (i, insertIndex - index);
  1922. for (int j = sectionsToInsert.size(); --j >= 0;)
  1923. sections.insert (i + 1, new UniformTextSection (*sectionsToInsert.getUnchecked (j)));
  1924. break;
  1925. }
  1926. index = nextIndex;
  1927. }
  1928. if (nextIndex == insertIndex)
  1929. for (auto* s : sectionsToInsert)
  1930. sections.add (new UniformTextSection (*s));
  1931. coalesceSimilarSections();
  1932. totalNumChars = -1;
  1933. valueTextNeedsUpdating = true;
  1934. }
  1935. void TextEditor::remove (Range<int> range, UndoManager* const um, const int caretPositionToMoveTo)
  1936. {
  1937. if (! range.isEmpty())
  1938. {
  1939. int index = 0;
  1940. for (int i = 0; i < sections.size(); ++i)
  1941. {
  1942. auto nextIndex = index + sections.getUnchecked (i)->getTotalLength();
  1943. if (range.getStart() > index && range.getStart() < nextIndex)
  1944. {
  1945. splitSection (i, range.getStart() - index);
  1946. --i;
  1947. }
  1948. else if (range.getEnd() > index && range.getEnd() < nextIndex)
  1949. {
  1950. splitSection (i, range.getEnd() - index);
  1951. --i;
  1952. }
  1953. else
  1954. {
  1955. index = nextIndex;
  1956. if (index > range.getEnd())
  1957. break;
  1958. }
  1959. }
  1960. index = 0;
  1961. if (um != nullptr)
  1962. {
  1963. Array<UniformTextSection*> removedSections;
  1964. for (auto* section : sections)
  1965. {
  1966. if (range.getEnd() <= range.getStart())
  1967. break;
  1968. auto nextIndex = index + section->getTotalLength();
  1969. if (range.getStart() <= index && range.getEnd() >= nextIndex)
  1970. removedSections.add (new UniformTextSection (*section));
  1971. index = nextIndex;
  1972. }
  1973. if (um->getNumActionsInCurrentTransaction() > TextEditorDefs::maxActionsPerTransaction)
  1974. newTransaction();
  1975. um->perform (new RemoveAction (*this, range, caretPosition,
  1976. caretPositionToMoveTo, removedSections));
  1977. }
  1978. else
  1979. {
  1980. auto remainingRange = range;
  1981. for (int i = 0; i < sections.size(); ++i)
  1982. {
  1983. auto* section = sections.getUnchecked (i);
  1984. auto nextIndex = index + section->getTotalLength();
  1985. if (remainingRange.getStart() <= index && remainingRange.getEnd() >= nextIndex)
  1986. {
  1987. sections.remove (i);
  1988. remainingRange.setEnd (remainingRange.getEnd() - (nextIndex - index));
  1989. if (remainingRange.isEmpty())
  1990. break;
  1991. --i;
  1992. }
  1993. else
  1994. {
  1995. index = nextIndex;
  1996. }
  1997. }
  1998. coalesceSimilarSections();
  1999. totalNumChars = -1;
  2000. valueTextNeedsUpdating = true;
  2001. checkLayout();
  2002. moveCaretTo (caretPositionToMoveTo, false);
  2003. repaintText ({ range.getStart(), getTotalNumChars() });
  2004. }
  2005. }
  2006. }
  2007. //==============================================================================
  2008. String TextEditor::getText() const
  2009. {
  2010. MemoryOutputStream mo;
  2011. mo.preallocate ((size_t) getTotalNumChars());
  2012. for (auto* s : sections)
  2013. s->appendAllText (mo);
  2014. return mo.toUTF8();
  2015. }
  2016. String TextEditor::getTextInRange (const Range<int>& range) const
  2017. {
  2018. if (range.isEmpty())
  2019. return {};
  2020. MemoryOutputStream mo;
  2021. mo.preallocate ((size_t) jmin (getTotalNumChars(), range.getLength()));
  2022. int index = 0;
  2023. for (auto* s : sections)
  2024. {
  2025. auto nextIndex = index + s->getTotalLength();
  2026. if (range.getStart() < nextIndex)
  2027. {
  2028. if (range.getEnd() <= index)
  2029. break;
  2030. s->appendSubstring (mo, range - index);
  2031. }
  2032. index = nextIndex;
  2033. }
  2034. return mo.toUTF8();
  2035. }
  2036. String TextEditor::getHighlightedText() const
  2037. {
  2038. return getTextInRange (selection);
  2039. }
  2040. int TextEditor::getTotalNumChars() const
  2041. {
  2042. if (totalNumChars < 0)
  2043. {
  2044. totalNumChars = 0;
  2045. for (auto* s : sections)
  2046. totalNumChars += s->getTotalLength();
  2047. }
  2048. return totalNumChars;
  2049. }
  2050. bool TextEditor::isEmpty() const
  2051. {
  2052. return getTotalNumChars() == 0;
  2053. }
  2054. void TextEditor::getCharPosition (int index, Point<float>& anchor, float& lineHeight) const
  2055. {
  2056. if (getWordWrapWidth() <= 0)
  2057. {
  2058. anchor = {};
  2059. lineHeight = currentFont.getHeight();
  2060. }
  2061. else
  2062. {
  2063. Iterator i (*this);
  2064. if (sections.isEmpty())
  2065. {
  2066. anchor = { i.getJustificationOffsetX (0), 0 };
  2067. lineHeight = currentFont.getHeight();
  2068. }
  2069. else
  2070. {
  2071. i.getCharPosition (index, anchor, lineHeight);
  2072. }
  2073. }
  2074. }
  2075. int TextEditor::indexAtPosition (const float x, const float y) const
  2076. {
  2077. if (getWordWrapWidth() > 0)
  2078. {
  2079. for (Iterator i (*this); i.next();)
  2080. {
  2081. if (y < i.lineY + (i.lineHeight * lineSpacing))
  2082. {
  2083. if (jmax (0.0f, y) < i.lineY)
  2084. return jmax (0, i.indexInText - 1);
  2085. if (x <= i.atomX || i.atom->isNewLine())
  2086. return i.indexInText;
  2087. if (x < i.atomRight)
  2088. return i.xToIndex (x);
  2089. }
  2090. }
  2091. }
  2092. return getTotalNumChars();
  2093. }
  2094. //==============================================================================
  2095. int TextEditor::findWordBreakAfter (const int position) const
  2096. {
  2097. auto t = getTextInRange ({ position, position + 512 });
  2098. auto totalLength = t.length();
  2099. int i = 0;
  2100. while (i < totalLength && CharacterFunctions::isWhitespace (t[i]))
  2101. ++i;
  2102. auto type = TextEditorDefs::getCharacterCategory (t[i]);
  2103. while (i < totalLength && type == TextEditorDefs::getCharacterCategory (t[i]))
  2104. ++i;
  2105. while (i < totalLength && CharacterFunctions::isWhitespace (t[i]))
  2106. ++i;
  2107. return position + i;
  2108. }
  2109. int TextEditor::findWordBreakBefore (const int position) const
  2110. {
  2111. if (position <= 0)
  2112. return 0;
  2113. auto startOfBuffer = jmax (0, position - 512);
  2114. auto t = getTextInRange ({ startOfBuffer, position });
  2115. int i = position - startOfBuffer;
  2116. while (i > 0 && CharacterFunctions::isWhitespace (t [i - 1]))
  2117. --i;
  2118. if (i > 0)
  2119. {
  2120. auto type = TextEditorDefs::getCharacterCategory (t [i - 1]);
  2121. while (i > 0 && type == TextEditorDefs::getCharacterCategory (t [i - 1]))
  2122. --i;
  2123. }
  2124. jassert (startOfBuffer + i >= 0);
  2125. return startOfBuffer + i;
  2126. }
  2127. //==============================================================================
  2128. void TextEditor::splitSection (const int sectionIndex, const int charToSplitAt)
  2129. {
  2130. jassert (sections[sectionIndex] != nullptr);
  2131. sections.insert (sectionIndex + 1,
  2132. sections.getUnchecked (sectionIndex)->split (charToSplitAt));
  2133. }
  2134. void TextEditor::coalesceSimilarSections()
  2135. {
  2136. for (int i = 0; i < sections.size() - 1; ++i)
  2137. {
  2138. auto* s1 = sections.getUnchecked (i);
  2139. auto* s2 = sections.getUnchecked (i + 1);
  2140. if (s1->font == s2->font
  2141. && s1->colour == s2->colour)
  2142. {
  2143. s1->append (*s2);
  2144. sections.remove (i + 1);
  2145. --i;
  2146. }
  2147. }
  2148. }
  2149. //==============================================================================
  2150. class TextEditor::EditorAccessibilityHandler final : public AccessibilityHandler
  2151. {
  2152. public:
  2153. explicit EditorAccessibilityHandler (TextEditor& textEditorToWrap)
  2154. : AccessibilityHandler (textEditorToWrap,
  2155. textEditorToWrap.isReadOnly() ? AccessibilityRole::staticText : AccessibilityRole::editableText,
  2156. {},
  2157. { std::make_unique<TextEditorTextInterface> (textEditorToWrap) }),
  2158. textEditor (textEditorToWrap)
  2159. {
  2160. }
  2161. String getHelp() const override { return textEditor.getTooltip(); }
  2162. private:
  2163. class TextEditorTextInterface final : public AccessibilityTextInterface
  2164. {
  2165. public:
  2166. explicit TextEditorTextInterface (TextEditor& editor)
  2167. : textEditor (editor)
  2168. {
  2169. }
  2170. bool isDisplayingProtectedText() const override { return textEditor.getPasswordCharacter() != 0; }
  2171. bool isReadOnly() const override { return textEditor.isReadOnly(); }
  2172. int getTotalNumCharacters() const override { return textEditor.getText().length(); }
  2173. Range<int> getSelection() const override { return textEditor.getHighlightedRegion(); }
  2174. void setSelection (Range<int> r) override
  2175. {
  2176. textEditor.setHighlightedRegion (r);
  2177. }
  2178. String getText (Range<int> r) const override
  2179. {
  2180. if (isDisplayingProtectedText())
  2181. return String::repeatedString (String::charToString (textEditor.getPasswordCharacter()),
  2182. getTotalNumCharacters());
  2183. return textEditor.getTextInRange (r);
  2184. }
  2185. void setText (const String& newText) override
  2186. {
  2187. textEditor.setText (newText);
  2188. }
  2189. int getTextInsertionOffset() const override { return textEditor.getCaretPosition(); }
  2190. RectangleList<int> getTextBounds (Range<int> textRange) const override
  2191. {
  2192. auto localRects = textEditor.getTextBounds (textRange);
  2193. RectangleList<int> globalRects;
  2194. std::for_each (localRects.begin(), localRects.end(),
  2195. [&] (const Rectangle<int>& r) { globalRects.add (textEditor.localAreaToGlobal (r)); });
  2196. return globalRects;
  2197. }
  2198. int getOffsetAtPoint (Point<int> point) const override
  2199. {
  2200. return textEditor.getTextIndexAt (textEditor.getLocalPoint (nullptr, point));
  2201. }
  2202. private:
  2203. TextEditor& textEditor;
  2204. //==============================================================================
  2205. JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TextEditorTextInterface)
  2206. };
  2207. TextEditor& textEditor;
  2208. //==============================================================================
  2209. JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (EditorAccessibilityHandler)
  2210. };
  2211. std::unique_ptr<AccessibilityHandler> TextEditor::createAccessibilityHandler()
  2212. {
  2213. return std::make_unique<EditorAccessibilityHandler> (*this);
  2214. }
  2215. } // namespace juce