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 : 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 : 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 : 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 : 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. textValue.removeListener (textHolder);
  759. textValue.referTo (Value());
  760. viewport.reset();
  761. textHolder = nullptr;
  762. }
  763. //==============================================================================
  764. void TextEditor::newTransaction()
  765. {
  766. lastTransactionTime = Time::getApproximateMillisecondCounter();
  767. undoManager.beginNewTransaction();
  768. }
  769. bool TextEditor::undoOrRedo (const bool shouldUndo)
  770. {
  771. if (! isReadOnly())
  772. {
  773. newTransaction();
  774. if (shouldUndo ? undoManager.undo()
  775. : undoManager.redo())
  776. {
  777. repaint();
  778. textChanged();
  779. scrollToMakeSureCursorIsVisible();
  780. return true;
  781. }
  782. }
  783. return false;
  784. }
  785. bool TextEditor::undo() { return undoOrRedo (true); }
  786. bool TextEditor::redo() { return undoOrRedo (false); }
  787. //==============================================================================
  788. void TextEditor::setMultiLine (const bool shouldBeMultiLine,
  789. const bool shouldWordWrap)
  790. {
  791. if (multiline != shouldBeMultiLine
  792. || wordWrap != (shouldWordWrap && shouldBeMultiLine))
  793. {
  794. multiline = shouldBeMultiLine;
  795. wordWrap = shouldWordWrap && shouldBeMultiLine;
  796. checkLayout();
  797. viewport->setViewPosition (0, 0);
  798. resized();
  799. scrollToMakeSureCursorIsVisible();
  800. }
  801. }
  802. bool TextEditor::isMultiLine() const
  803. {
  804. return multiline;
  805. }
  806. void TextEditor::setScrollbarsShown (bool shown)
  807. {
  808. if (scrollbarVisible != shown)
  809. {
  810. scrollbarVisible = shown;
  811. checkLayout();
  812. }
  813. }
  814. void TextEditor::setReadOnly (bool shouldBeReadOnly)
  815. {
  816. if (readOnly != shouldBeReadOnly)
  817. {
  818. readOnly = shouldBeReadOnly;
  819. enablementChanged();
  820. invalidateAccessibilityHandler();
  821. if (auto* peer = getPeer())
  822. peer->refreshTextInputTarget();
  823. }
  824. }
  825. void TextEditor::setClicksOutsideDismissVirtualKeyboard (bool newValue)
  826. {
  827. clicksOutsideDismissVirtualKeyboard = newValue;
  828. }
  829. bool TextEditor::isReadOnly() const noexcept
  830. {
  831. return readOnly || ! isEnabled();
  832. }
  833. bool TextEditor::isTextInputActive() const
  834. {
  835. return ! isReadOnly() && (! clicksOutsideDismissVirtualKeyboard || globalMouseListener.lastMouseDownInEditor());
  836. }
  837. void TextEditor::setReturnKeyStartsNewLine (bool shouldStartNewLine)
  838. {
  839. returnKeyStartsNewLine = shouldStartNewLine;
  840. }
  841. void TextEditor::setTabKeyUsedAsCharacter (bool shouldTabKeyBeUsed)
  842. {
  843. tabKeyUsed = shouldTabKeyBeUsed;
  844. }
  845. void TextEditor::setPopupMenuEnabled (bool b)
  846. {
  847. popupMenuEnabled = b;
  848. }
  849. void TextEditor::setSelectAllWhenFocused (bool b)
  850. {
  851. selectAllTextWhenFocused = b;
  852. }
  853. void TextEditor::setJustification (Justification j)
  854. {
  855. if (justification != j)
  856. {
  857. justification = j;
  858. resized();
  859. repaint();
  860. }
  861. }
  862. //==============================================================================
  863. void TextEditor::setFont (const Font& newFont)
  864. {
  865. currentFont = newFont;
  866. scrollToMakeSureCursorIsVisible();
  867. }
  868. void TextEditor::applyFontToAllText (const Font& newFont, bool changeCurrentFont)
  869. {
  870. if (changeCurrentFont)
  871. currentFont = newFont;
  872. auto overallColour = findColour (textColourId);
  873. for (auto* uts : sections)
  874. {
  875. uts->setFont (newFont, passwordCharacter);
  876. uts->colour = overallColour;
  877. }
  878. coalesceSimilarSections();
  879. checkLayout();
  880. scrollToMakeSureCursorIsVisible();
  881. repaint();
  882. }
  883. void TextEditor::applyColourToAllText (const Colour& newColour, bool changeCurrentTextColour)
  884. {
  885. for (auto* uts : sections)
  886. uts->colour = newColour;
  887. if (changeCurrentTextColour)
  888. setColour (TextEditor::textColourId, newColour);
  889. else
  890. repaint();
  891. }
  892. void TextEditor::lookAndFeelChanged()
  893. {
  894. caret.reset();
  895. recreateCaret();
  896. repaint();
  897. }
  898. void TextEditor::parentHierarchyChanged()
  899. {
  900. lookAndFeelChanged();
  901. }
  902. void TextEditor::enablementChanged()
  903. {
  904. recreateCaret();
  905. repaint();
  906. }
  907. void TextEditor::setCaretVisible (bool shouldCaretBeVisible)
  908. {
  909. if (caretVisible != shouldCaretBeVisible)
  910. {
  911. caretVisible = shouldCaretBeVisible;
  912. recreateCaret();
  913. }
  914. }
  915. void TextEditor::recreateCaret()
  916. {
  917. if (isCaretVisible())
  918. {
  919. if (caret == nullptr)
  920. {
  921. caret.reset (getLookAndFeel().createCaretComponent (this));
  922. textHolder->addChildComponent (caret.get());
  923. updateCaretPosition();
  924. }
  925. }
  926. else
  927. {
  928. caret.reset();
  929. }
  930. }
  931. void TextEditor::updateCaretPosition()
  932. {
  933. if (caret != nullptr
  934. && getWidth() > 0 && getHeight() > 0)
  935. {
  936. Iterator i (*this);
  937. caret->setCaretPosition (getCaretRectangle().translated (leftIndent,
  938. topIndent + roundToInt (i.getYOffset())) - getTextOffset());
  939. if (auto* handler = getAccessibilityHandler())
  940. handler->notifyAccessibilityEvent (AccessibilityEvent::textSelectionChanged);
  941. }
  942. }
  943. TextEditor::LengthAndCharacterRestriction::LengthAndCharacterRestriction (int maxLen, const String& chars)
  944. : allowedCharacters (chars), maxLength (maxLen)
  945. {
  946. }
  947. String TextEditor::LengthAndCharacterRestriction::filterNewText (TextEditor& ed, const String& newInput)
  948. {
  949. String t (newInput);
  950. if (allowedCharacters.isNotEmpty())
  951. t = t.retainCharacters (allowedCharacters);
  952. if (maxLength > 0)
  953. t = t.substring (0, maxLength - (ed.getTotalNumChars() - ed.getHighlightedRegion().getLength()));
  954. return t;
  955. }
  956. void TextEditor::setInputFilter (InputFilter* newFilter, bool takeOwnership)
  957. {
  958. inputFilter.set (newFilter, takeOwnership);
  959. }
  960. void TextEditor::setInputRestrictions (int maxLen, const String& chars)
  961. {
  962. setInputFilter (new LengthAndCharacterRestriction (maxLen, chars), true);
  963. }
  964. void TextEditor::setTextToShowWhenEmpty (const String& text, Colour colourToUse)
  965. {
  966. textToShowWhenEmpty = text;
  967. colourForTextWhenEmpty = colourToUse;
  968. }
  969. void TextEditor::setPasswordCharacter (juce_wchar newPasswordCharacter)
  970. {
  971. if (passwordCharacter != newPasswordCharacter)
  972. {
  973. passwordCharacter = newPasswordCharacter;
  974. applyFontToAllText (currentFont);
  975. }
  976. }
  977. void TextEditor::setScrollBarThickness (int newThicknessPixels)
  978. {
  979. viewport->setScrollBarThickness (newThicknessPixels);
  980. }
  981. //==============================================================================
  982. void TextEditor::clear()
  983. {
  984. clearInternal (nullptr);
  985. checkLayout();
  986. undoManager.clearUndoHistory();
  987. repaint();
  988. }
  989. void TextEditor::setText (const String& newText, bool sendTextChangeMessage)
  990. {
  991. auto newLength = newText.length();
  992. if (newLength != getTotalNumChars() || getText() != newText)
  993. {
  994. if (! sendTextChangeMessage)
  995. textValue.removeListener (textHolder);
  996. textValue = newText;
  997. auto oldCursorPos = caretPosition;
  998. bool cursorWasAtEnd = oldCursorPos >= getTotalNumChars();
  999. clearInternal (nullptr);
  1000. insert (newText, 0, currentFont, findColour (textColourId), nullptr, caretPosition);
  1001. // if you're adding text with line-feeds to a single-line text editor, it
  1002. // ain't gonna look right!
  1003. jassert (multiline || ! newText.containsAnyOf ("\r\n"));
  1004. if (cursorWasAtEnd && ! isMultiLine())
  1005. oldCursorPos = getTotalNumChars();
  1006. moveCaretTo (oldCursorPos, false);
  1007. if (sendTextChangeMessage)
  1008. textChanged();
  1009. else
  1010. textValue.addListener (textHolder);
  1011. checkLayout();
  1012. scrollToMakeSureCursorIsVisible();
  1013. undoManager.clearUndoHistory();
  1014. repaint();
  1015. }
  1016. }
  1017. //==============================================================================
  1018. void TextEditor::updateValueFromText()
  1019. {
  1020. if (valueTextNeedsUpdating)
  1021. {
  1022. valueTextNeedsUpdating = false;
  1023. textValue = getText();
  1024. }
  1025. }
  1026. Value& TextEditor::getTextValue()
  1027. {
  1028. updateValueFromText();
  1029. return textValue;
  1030. }
  1031. void TextEditor::textWasChangedByValue()
  1032. {
  1033. if (textValue.getValueSource().getReferenceCount() > 1)
  1034. setText (textValue.getValue());
  1035. }
  1036. //==============================================================================
  1037. void TextEditor::textChanged()
  1038. {
  1039. checkLayout();
  1040. if (listeners.size() != 0 || onTextChange != nullptr)
  1041. postCommandMessage (TextEditorDefs::textChangeMessageId);
  1042. if (textValue.getValueSource().getReferenceCount() > 1)
  1043. {
  1044. valueTextNeedsUpdating = false;
  1045. textValue = getText();
  1046. }
  1047. if (auto* handler = getAccessibilityHandler())
  1048. handler->notifyAccessibilityEvent (AccessibilityEvent::textChanged);
  1049. }
  1050. void TextEditor::setSelection (Range<int> newSelection) noexcept
  1051. {
  1052. if (newSelection != selection)
  1053. {
  1054. selection = newSelection;
  1055. if (auto* handler = getAccessibilityHandler())
  1056. handler->notifyAccessibilityEvent (AccessibilityEvent::textSelectionChanged);
  1057. }
  1058. }
  1059. void TextEditor::returnPressed() { postCommandMessage (TextEditorDefs::returnKeyMessageId); }
  1060. void TextEditor::escapePressed() { postCommandMessage (TextEditorDefs::escapeKeyMessageId); }
  1061. void TextEditor::addListener (Listener* l) { listeners.add (l); }
  1062. void TextEditor::removeListener (Listener* l) { listeners.remove (l); }
  1063. //==============================================================================
  1064. void TextEditor::timerCallbackInt()
  1065. {
  1066. checkFocus();
  1067. auto now = Time::getApproximateMillisecondCounter();
  1068. if (now > lastTransactionTime + 200)
  1069. newTransaction();
  1070. }
  1071. void TextEditor::checkFocus()
  1072. {
  1073. if (! wasFocused && hasKeyboardFocus (false) && ! isCurrentlyBlockedByAnotherModalComponent())
  1074. wasFocused = true;
  1075. }
  1076. void TextEditor::repaintText (Range<int> range)
  1077. {
  1078. if (! range.isEmpty())
  1079. {
  1080. if (range.getEnd() >= getTotalNumChars())
  1081. {
  1082. textHolder->repaint();
  1083. return;
  1084. }
  1085. Iterator i (*this);
  1086. Point<float> anchor;
  1087. auto lh = currentFont.getHeight();
  1088. i.getCharPosition (range.getStart(), anchor, lh);
  1089. auto y1 = std::trunc (anchor.y);
  1090. int y2 = 0;
  1091. if (range.getEnd() >= getTotalNumChars())
  1092. {
  1093. y2 = textHolder->getHeight();
  1094. }
  1095. else
  1096. {
  1097. i.getCharPosition (range.getEnd(), anchor, lh);
  1098. y2 = (int) (anchor.y + lh * 2.0f);
  1099. }
  1100. auto offset = i.getYOffset();
  1101. textHolder->repaint (0, roundToInt (y1 + offset), textHolder->getWidth(), roundToInt ((float) y2 - y1 + offset));
  1102. }
  1103. }
  1104. //==============================================================================
  1105. void TextEditor::moveCaret (int newCaretPos)
  1106. {
  1107. if (newCaretPos < 0)
  1108. newCaretPos = 0;
  1109. else
  1110. newCaretPos = jmin (newCaretPos, getTotalNumChars());
  1111. if (newCaretPos != getCaretPosition())
  1112. {
  1113. caretPosition = newCaretPos;
  1114. if (hasKeyboardFocus (false))
  1115. textHolder->restartTimer();
  1116. scrollToMakeSureCursorIsVisible();
  1117. updateCaretPosition();
  1118. if (auto* handler = getAccessibilityHandler())
  1119. handler->notifyAccessibilityEvent (AccessibilityEvent::textChanged);
  1120. }
  1121. }
  1122. int TextEditor::getCaretPosition() const
  1123. {
  1124. return caretPosition;
  1125. }
  1126. void TextEditor::setCaretPosition (const int newIndex)
  1127. {
  1128. moveCaretTo (newIndex, false);
  1129. }
  1130. void TextEditor::moveCaretToEnd()
  1131. {
  1132. setCaretPosition (std::numeric_limits<int>::max());
  1133. }
  1134. void TextEditor::scrollEditorToPositionCaret (const int desiredCaretX,
  1135. const int desiredCaretY)
  1136. {
  1137. updateCaretPosition();
  1138. auto caretRect = getCaretRectangle().translated (leftIndent, topIndent);
  1139. auto vx = caretRect.getX() - desiredCaretX;
  1140. auto vy = caretRect.getY() - desiredCaretY;
  1141. if (desiredCaretX < jmax (1, proportionOfWidth (0.05f)))
  1142. vx += desiredCaretX - proportionOfWidth (0.2f);
  1143. else if (desiredCaretX > jmax (0, viewport->getMaximumVisibleWidth() - (wordWrap ? 2 : 10)))
  1144. vx += desiredCaretX + (isMultiLine() ? proportionOfWidth (0.2f) : 10) - viewport->getMaximumVisibleWidth();
  1145. vx = jlimit (0, jmax (0, textHolder->getWidth() + 8 - viewport->getMaximumVisibleWidth()), vx);
  1146. if (! isMultiLine())
  1147. {
  1148. vy = viewport->getViewPositionY();
  1149. }
  1150. else
  1151. {
  1152. vy = jlimit (0, jmax (0, textHolder->getHeight() - viewport->getMaximumVisibleHeight()), vy);
  1153. if (desiredCaretY < 0)
  1154. vy = jmax (0, desiredCaretY + vy);
  1155. else if (desiredCaretY > jmax (0, viewport->getMaximumVisibleHeight() - caretRect.getHeight()))
  1156. vy += desiredCaretY + 2 + caretRect.getHeight() - viewport->getMaximumVisibleHeight();
  1157. }
  1158. viewport->setViewPosition (vx, vy);
  1159. }
  1160. Rectangle<int> TextEditor::getCaretRectangleForCharIndex (int index) const
  1161. {
  1162. Point<float> anchor;
  1163. auto cursorHeight = currentFont.getHeight(); // (in case the text is empty and the call below doesn't set this value)
  1164. getCharPosition (index, anchor, cursorHeight);
  1165. return Rectangle<float> { anchor.x, anchor.y, 2.0f, cursorHeight }.getSmallestIntegerContainer() + getTextOffset();
  1166. }
  1167. Point<int> TextEditor::getTextOffset() const noexcept
  1168. {
  1169. Iterator i (*this);
  1170. auto yOffset = i.getYOffset();
  1171. return { getLeftIndent() + borderSize.getLeft() - viewport->getViewPositionX(),
  1172. roundToInt ((float) getTopIndent() + (float) borderSize.getTop() + yOffset) - viewport->getViewPositionY() };
  1173. }
  1174. RectangleList<int> TextEditor::getTextBounds (Range<int> textRange) const
  1175. {
  1176. RectangleList<int> boundingBox;
  1177. Iterator i (*this);
  1178. while (i.next())
  1179. {
  1180. if (textRange.intersects ({ i.indexInText,
  1181. i.indexInText + i.atom->numChars }))
  1182. {
  1183. boundingBox.add (i.getTextBounds (textRange));
  1184. }
  1185. }
  1186. boundingBox.offsetAll (getTextOffset());
  1187. return boundingBox;
  1188. }
  1189. //==============================================================================
  1190. // Extra space for the cursor at the right-hand-edge
  1191. constexpr int rightEdgeSpace = 2;
  1192. int TextEditor::getWordWrapWidth() const
  1193. {
  1194. return wordWrap ? getMaximumTextWidth()
  1195. : std::numeric_limits<int>::max();
  1196. }
  1197. int TextEditor::getMaximumTextWidth() const
  1198. {
  1199. return jmax (1, viewport->getMaximumVisibleWidth() - leftIndent - rightEdgeSpace);
  1200. }
  1201. int TextEditor::getMaximumTextHeight() const
  1202. {
  1203. return jmax (1, viewport->getMaximumVisibleHeight() - topIndent);
  1204. }
  1205. void TextEditor::checkLayout()
  1206. {
  1207. if (getWordWrapWidth() > 0)
  1208. {
  1209. const auto textBottom = Iterator (*this).getTotalTextHeight() + topIndent;
  1210. const auto textRight = jmax (viewport->getMaximumVisibleWidth(),
  1211. Iterator (*this).getTextRight() + leftIndent + rightEdgeSpace);
  1212. textHolder->setSize (textRight, textBottom);
  1213. viewport->setScrollBarsShown (scrollbarVisible && multiline && textBottom > viewport->getMaximumVisibleHeight(),
  1214. scrollbarVisible && multiline && ! wordWrap && textRight > viewport->getMaximumVisibleWidth());
  1215. }
  1216. }
  1217. int TextEditor::getTextWidth() const { return textHolder->getWidth(); }
  1218. int TextEditor::getTextHeight() const { return textHolder->getHeight(); }
  1219. void TextEditor::setIndents (int newLeftIndent, int newTopIndent)
  1220. {
  1221. if (leftIndent != newLeftIndent || topIndent != newTopIndent)
  1222. {
  1223. leftIndent = newLeftIndent;
  1224. topIndent = newTopIndent;
  1225. resized();
  1226. repaint();
  1227. }
  1228. }
  1229. void TextEditor::setBorder (BorderSize<int> border)
  1230. {
  1231. borderSize = border;
  1232. resized();
  1233. }
  1234. BorderSize<int> TextEditor::getBorder() const
  1235. {
  1236. return borderSize;
  1237. }
  1238. void TextEditor::setScrollToShowCursor (const bool shouldScrollToShowCursor)
  1239. {
  1240. keepCaretOnScreen = shouldScrollToShowCursor;
  1241. }
  1242. void TextEditor::scrollToMakeSureCursorIsVisible()
  1243. {
  1244. updateCaretPosition();
  1245. if (keepCaretOnScreen)
  1246. {
  1247. auto viewPos = viewport->getViewPosition();
  1248. auto caretRect = getCaretRectangle().translated (leftIndent, topIndent) - getTextOffset();
  1249. auto relativeCursor = caretRect.getPosition() - viewPos;
  1250. if (relativeCursor.x < jmax (1, proportionOfWidth (0.05f)))
  1251. {
  1252. viewPos.x += relativeCursor.x - proportionOfWidth (0.2f);
  1253. }
  1254. else if (relativeCursor.x > jmax (0, viewport->getMaximumVisibleWidth() - (wordWrap ? 2 : 10)))
  1255. {
  1256. viewPos.x += relativeCursor.x + (isMultiLine() ? proportionOfWidth (0.2f) : 10) - viewport->getMaximumVisibleWidth();
  1257. }
  1258. viewPos.x = jlimit (0, jmax (0, textHolder->getWidth() + 8 - viewport->getMaximumVisibleWidth()), viewPos.x);
  1259. if (! isMultiLine())
  1260. {
  1261. viewPos.y = (getHeight() - textHolder->getHeight() - topIndent) / -2;
  1262. }
  1263. else if (relativeCursor.y < 0)
  1264. {
  1265. viewPos.y = jmax (0, relativeCursor.y + viewPos.y);
  1266. }
  1267. else if (relativeCursor.y > jmax (0, viewport->getMaximumVisibleHeight() - caretRect.getHeight()))
  1268. {
  1269. viewPos.y += relativeCursor.y + 2 + caretRect.getHeight() - viewport->getMaximumVisibleHeight();
  1270. }
  1271. viewport->setViewPosition (viewPos);
  1272. }
  1273. }
  1274. void TextEditor::moveCaretTo (const int newPosition, const bool isSelecting)
  1275. {
  1276. if (isSelecting)
  1277. {
  1278. moveCaret (newPosition);
  1279. auto oldSelection = selection;
  1280. if (dragType == notDragging)
  1281. {
  1282. if (std::abs (getCaretPosition() - selection.getStart()) < std::abs (getCaretPosition() - selection.getEnd()))
  1283. dragType = draggingSelectionStart;
  1284. else
  1285. dragType = draggingSelectionEnd;
  1286. }
  1287. if (dragType == draggingSelectionStart)
  1288. {
  1289. if (getCaretPosition() >= selection.getEnd())
  1290. dragType = draggingSelectionEnd;
  1291. setSelection (Range<int>::between (getCaretPosition(), selection.getEnd()));
  1292. }
  1293. else
  1294. {
  1295. if (getCaretPosition() < selection.getStart())
  1296. dragType = draggingSelectionStart;
  1297. setSelection (Range<int>::between (getCaretPosition(), selection.getStart()));
  1298. }
  1299. repaintText (selection.getUnionWith (oldSelection));
  1300. }
  1301. else
  1302. {
  1303. dragType = notDragging;
  1304. repaintText (selection);
  1305. moveCaret (newPosition);
  1306. setSelection (Range<int>::emptyRange (getCaretPosition()));
  1307. }
  1308. }
  1309. int TextEditor::getTextIndexAt (const int x, const int y) const
  1310. {
  1311. const auto offset = getTextOffset();
  1312. return indexAtPosition ((float) (x - offset.x),
  1313. (float) (y - offset.y));
  1314. }
  1315. int TextEditor::getTextIndexAt (const Point<int> pt) const
  1316. {
  1317. return getTextIndexAt (pt.x, pt.y);
  1318. }
  1319. int TextEditor::getCharIndexForPoint (const Point<int> point) const
  1320. {
  1321. return getTextIndexAt (isMultiLine() ? point : getTextBounds ({ 0, getTotalNumChars() }).getBounds().getConstrainedPoint (point));
  1322. }
  1323. void TextEditor::insertTextAtCaret (const String& t)
  1324. {
  1325. String newText (inputFilter != nullptr ? inputFilter->filterNewText (*this, t) : t);
  1326. if (isMultiLine())
  1327. newText = newText.replace ("\r\n", "\n");
  1328. else
  1329. newText = newText.replaceCharacters ("\r\n", " ");
  1330. const int insertIndex = selection.getStart();
  1331. const int newCaretPos = insertIndex + newText.length();
  1332. remove (selection, getUndoManager(),
  1333. newText.isNotEmpty() ? newCaretPos - 1 : newCaretPos);
  1334. insert (newText, insertIndex, currentFont, findColour (textColourId),
  1335. getUndoManager(), newCaretPos);
  1336. textChanged();
  1337. }
  1338. void TextEditor::setHighlightedRegion (const Range<int>& newSelection)
  1339. {
  1340. if (newSelection == getHighlightedRegion())
  1341. return;
  1342. const auto cursorAtStart = newSelection.getEnd() == getHighlightedRegion().getStart()
  1343. || newSelection.getEnd() == getHighlightedRegion().getEnd();
  1344. moveCaretTo (cursorAtStart ? newSelection.getEnd() : newSelection.getStart(), false);
  1345. moveCaretTo (cursorAtStart ? newSelection.getStart() : newSelection.getEnd(), true);
  1346. }
  1347. //==============================================================================
  1348. void TextEditor::copy()
  1349. {
  1350. if (passwordCharacter == 0)
  1351. {
  1352. auto selectedText = getHighlightedText();
  1353. if (selectedText.isNotEmpty())
  1354. SystemClipboard::copyTextToClipboard (selectedText);
  1355. }
  1356. }
  1357. void TextEditor::paste()
  1358. {
  1359. if (! isReadOnly())
  1360. {
  1361. auto clip = SystemClipboard::getTextFromClipboard();
  1362. if (clip.isNotEmpty())
  1363. insertTextAtCaret (clip);
  1364. }
  1365. }
  1366. void TextEditor::cut()
  1367. {
  1368. if (! isReadOnly())
  1369. {
  1370. moveCaret (selection.getEnd());
  1371. insertTextAtCaret (String());
  1372. }
  1373. }
  1374. //==============================================================================
  1375. void TextEditor::drawContent (Graphics& g)
  1376. {
  1377. if (getWordWrapWidth() > 0)
  1378. {
  1379. g.setOrigin (leftIndent, topIndent);
  1380. auto clip = g.getClipBounds();
  1381. auto yOffset = Iterator (*this).getYOffset();
  1382. AffineTransform transform;
  1383. if (yOffset > 0)
  1384. {
  1385. transform = AffineTransform::translation (0.0f, yOffset);
  1386. clip.setY (roundToInt ((float) clip.getY() - yOffset));
  1387. }
  1388. Iterator i (*this);
  1389. Colour selectedTextColour;
  1390. if (! selection.isEmpty())
  1391. {
  1392. selectedTextColour = findColour (highlightedTextColourId);
  1393. g.setColour (findColour (highlightColourId).withMultipliedAlpha (hasKeyboardFocus (true) ? 1.0f : 0.5f));
  1394. auto boundingBox = getTextBounds (selection);
  1395. boundingBox.offsetAll (-getTextOffset());
  1396. g.fillPath (boundingBox.toPath(), transform);
  1397. }
  1398. const UniformTextSection* lastSection = nullptr;
  1399. while (i.next() && i.lineY < (float) clip.getBottom())
  1400. {
  1401. if (i.lineY + i.lineHeight >= (float) clip.getY())
  1402. {
  1403. if (selection.intersects ({ i.indexInText, i.indexInText + i.atom->numChars }))
  1404. {
  1405. i.drawSelectedText (g, selection, selectedTextColour, transform);
  1406. lastSection = nullptr;
  1407. }
  1408. else
  1409. {
  1410. i.draw (g, lastSection, transform);
  1411. }
  1412. }
  1413. }
  1414. for (auto& underlinedSection : underlinedSections)
  1415. {
  1416. Iterator i2 (*this);
  1417. while (i2.next() && i2.lineY < (float) clip.getBottom())
  1418. {
  1419. if (i2.lineY + i2.lineHeight >= (float) clip.getY()
  1420. && underlinedSection.intersects ({ i2.indexInText, i2.indexInText + i2.atom->numChars }))
  1421. {
  1422. i2.drawUnderline (g, underlinedSection, findColour (textColourId), transform);
  1423. }
  1424. }
  1425. }
  1426. }
  1427. }
  1428. void TextEditor::paint (Graphics& g)
  1429. {
  1430. getLookAndFeel().fillTextEditorBackground (g, getWidth(), getHeight(), *this);
  1431. }
  1432. void TextEditor::paintOverChildren (Graphics& g)
  1433. {
  1434. if (textToShowWhenEmpty.isNotEmpty()
  1435. && (! hasKeyboardFocus (false))
  1436. && getTotalNumChars() == 0)
  1437. {
  1438. g.setColour (colourForTextWhenEmpty);
  1439. g.setFont (getFont());
  1440. Rectangle<int> textBounds (leftIndent,
  1441. topIndent,
  1442. viewport->getWidth() - leftIndent,
  1443. getHeight() - topIndent);
  1444. if (! textBounds.isEmpty())
  1445. g.drawText (textToShowWhenEmpty, textBounds, justification, true);
  1446. }
  1447. getLookAndFeel().drawTextEditorOutline (g, getWidth(), getHeight(), *this);
  1448. }
  1449. //==============================================================================
  1450. void TextEditor::addPopupMenuItems (PopupMenu& m, const MouseEvent*)
  1451. {
  1452. const bool writable = ! isReadOnly();
  1453. if (passwordCharacter == 0)
  1454. {
  1455. m.addItem (StandardApplicationCommandIDs::cut, TRANS("Cut"), writable);
  1456. m.addItem (StandardApplicationCommandIDs::copy, TRANS("Copy"), ! selection.isEmpty());
  1457. }
  1458. m.addItem (StandardApplicationCommandIDs::paste, TRANS("Paste"), writable);
  1459. m.addItem (StandardApplicationCommandIDs::del, TRANS("Delete"), writable);
  1460. m.addSeparator();
  1461. m.addItem (StandardApplicationCommandIDs::selectAll, TRANS("Select All"));
  1462. m.addSeparator();
  1463. if (getUndoManager() != nullptr)
  1464. {
  1465. m.addItem (StandardApplicationCommandIDs::undo, TRANS("Undo"), undoManager.canUndo());
  1466. m.addItem (StandardApplicationCommandIDs::redo, TRANS("Redo"), undoManager.canRedo());
  1467. }
  1468. }
  1469. void TextEditor::performPopupMenuAction (const int menuItemID)
  1470. {
  1471. switch (menuItemID)
  1472. {
  1473. case StandardApplicationCommandIDs::cut: cutToClipboard(); break;
  1474. case StandardApplicationCommandIDs::copy: copyToClipboard(); break;
  1475. case StandardApplicationCommandIDs::paste: pasteFromClipboard(); break;
  1476. case StandardApplicationCommandIDs::del: cut(); break;
  1477. case StandardApplicationCommandIDs::selectAll: selectAll(); break;
  1478. case StandardApplicationCommandIDs::undo: undo(); break;
  1479. case StandardApplicationCommandIDs::redo: redo(); break;
  1480. default: break;
  1481. }
  1482. }
  1483. //==============================================================================
  1484. void TextEditor::mouseDown (const MouseEvent& e)
  1485. {
  1486. beginDragAutoRepeat (100);
  1487. newTransaction();
  1488. if (wasFocused || ! selectAllTextWhenFocused)
  1489. {
  1490. if (! (popupMenuEnabled && e.mods.isPopupMenu()))
  1491. {
  1492. moveCaretTo (getTextIndexAt (e.getPosition()), e.mods.isShiftDown());
  1493. if (auto* peer = getPeer())
  1494. peer->closeInputMethodContext();
  1495. }
  1496. else
  1497. {
  1498. PopupMenu m;
  1499. m.setLookAndFeel (&getLookAndFeel());
  1500. addPopupMenuItems (m, &e);
  1501. menuActive = true;
  1502. m.showMenuAsync (PopupMenu::Options(),
  1503. [safeThis = SafePointer<TextEditor> { this }] (int menuResult)
  1504. {
  1505. if (auto* editor = safeThis.getComponent())
  1506. {
  1507. editor->menuActive = false;
  1508. if (menuResult != 0)
  1509. editor->performPopupMenuAction (menuResult);
  1510. }
  1511. });
  1512. }
  1513. }
  1514. }
  1515. void TextEditor::mouseDrag (const MouseEvent& e)
  1516. {
  1517. if (wasFocused || ! selectAllTextWhenFocused)
  1518. if (! (popupMenuEnabled && e.mods.isPopupMenu()))
  1519. moveCaretTo (getTextIndexAt (e.getPosition()), true);
  1520. }
  1521. void TextEditor::mouseUp (const MouseEvent& e)
  1522. {
  1523. newTransaction();
  1524. textHolder->restartTimer();
  1525. if (wasFocused || ! selectAllTextWhenFocused)
  1526. if (e.mouseWasClicked() && ! (popupMenuEnabled && e.mods.isPopupMenu()))
  1527. moveCaret (getTextIndexAt (e.getPosition()));
  1528. wasFocused = true;
  1529. }
  1530. void TextEditor::mouseDoubleClick (const MouseEvent& e)
  1531. {
  1532. int tokenEnd = getTextIndexAt (e.getPosition());
  1533. int tokenStart = 0;
  1534. if (e.getNumberOfClicks() > 3)
  1535. {
  1536. tokenEnd = getTotalNumChars();
  1537. }
  1538. else
  1539. {
  1540. auto t = getText();
  1541. auto totalLength = getTotalNumChars();
  1542. while (tokenEnd < totalLength)
  1543. {
  1544. auto c = t[tokenEnd];
  1545. // (note the slight bodge here - it's because iswalnum only checks for alphabetic chars in the current locale)
  1546. if (CharacterFunctions::isLetterOrDigit (c) || c > 128)
  1547. ++tokenEnd;
  1548. else
  1549. break;
  1550. }
  1551. tokenStart = tokenEnd;
  1552. while (tokenStart > 0)
  1553. {
  1554. auto c = t[tokenStart - 1];
  1555. // (note the slight bodge here - it's because iswalnum only checks for alphabetic chars in the current locale)
  1556. if (CharacterFunctions::isLetterOrDigit (c) || c > 128)
  1557. --tokenStart;
  1558. else
  1559. break;
  1560. }
  1561. if (e.getNumberOfClicks() > 2)
  1562. {
  1563. while (tokenEnd < totalLength)
  1564. {
  1565. auto c = t[tokenEnd];
  1566. if (c != '\r' && c != '\n')
  1567. ++tokenEnd;
  1568. else
  1569. break;
  1570. }
  1571. while (tokenStart > 0)
  1572. {
  1573. auto c = t[tokenStart - 1];
  1574. if (c != '\r' && c != '\n')
  1575. --tokenStart;
  1576. else
  1577. break;
  1578. }
  1579. }
  1580. }
  1581. moveCaretTo (tokenEnd, false);
  1582. moveCaretTo (tokenStart, true);
  1583. }
  1584. void TextEditor::mouseWheelMove (const MouseEvent& e, const MouseWheelDetails& wheel)
  1585. {
  1586. if (! viewport->useMouseWheelMoveIfNeeded (e, wheel))
  1587. Component::mouseWheelMove (e, wheel);
  1588. }
  1589. //==============================================================================
  1590. bool TextEditor::moveCaretWithTransaction (const int newPos, const bool selecting)
  1591. {
  1592. newTransaction();
  1593. moveCaretTo (newPos, selecting);
  1594. if (auto* peer = getPeer())
  1595. peer->closeInputMethodContext();
  1596. return true;
  1597. }
  1598. bool TextEditor::moveCaretLeft (bool moveInWholeWordSteps, bool selecting)
  1599. {
  1600. auto pos = getCaretPosition();
  1601. if (moveInWholeWordSteps)
  1602. pos = findWordBreakBefore (pos);
  1603. else
  1604. --pos;
  1605. return moveCaretWithTransaction (pos, selecting);
  1606. }
  1607. bool TextEditor::moveCaretRight (bool moveInWholeWordSteps, bool selecting)
  1608. {
  1609. auto pos = getCaretPosition();
  1610. if (moveInWholeWordSteps)
  1611. pos = findWordBreakAfter (pos);
  1612. else
  1613. ++pos;
  1614. return moveCaretWithTransaction (pos, selecting);
  1615. }
  1616. bool TextEditor::moveCaretUp (bool selecting)
  1617. {
  1618. if (! isMultiLine())
  1619. return moveCaretToStartOfLine (selecting);
  1620. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1621. const auto newY = caretPos.getY() - 1.0f;
  1622. if (newY < 0.0f)
  1623. return moveCaretToStartOfLine (selecting);
  1624. return moveCaretWithTransaction (indexAtPosition (caretPos.getX(), newY), selecting);
  1625. }
  1626. bool TextEditor::moveCaretDown (bool selecting)
  1627. {
  1628. if (! isMultiLine())
  1629. return moveCaretToEndOfLine (selecting);
  1630. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1631. return moveCaretWithTransaction (indexAtPosition (caretPos.getX(), caretPos.getBottom() + 1.0f), selecting);
  1632. }
  1633. bool TextEditor::pageUp (bool selecting)
  1634. {
  1635. if (! isMultiLine())
  1636. return moveCaretToStartOfLine (selecting);
  1637. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1638. return moveCaretWithTransaction (indexAtPosition (caretPos.getX(), caretPos.getY() - (float) viewport->getViewHeight()), selecting);
  1639. }
  1640. bool TextEditor::pageDown (bool selecting)
  1641. {
  1642. if (! isMultiLine())
  1643. return moveCaretToEndOfLine (selecting);
  1644. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1645. return moveCaretWithTransaction (indexAtPosition (caretPos.getX(), caretPos.getBottom() + (float) viewport->getViewHeight()), selecting);
  1646. }
  1647. void TextEditor::scrollByLines (int deltaLines)
  1648. {
  1649. viewport->getVerticalScrollBar().moveScrollbarInSteps (deltaLines);
  1650. }
  1651. bool TextEditor::scrollDown()
  1652. {
  1653. scrollByLines (-1);
  1654. return true;
  1655. }
  1656. bool TextEditor::scrollUp()
  1657. {
  1658. scrollByLines (1);
  1659. return true;
  1660. }
  1661. bool TextEditor::moveCaretToTop (bool selecting)
  1662. {
  1663. return moveCaretWithTransaction (0, selecting);
  1664. }
  1665. bool TextEditor::moveCaretToStartOfLine (bool selecting)
  1666. {
  1667. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1668. return moveCaretWithTransaction (indexAtPosition (0.0f, caretPos.getY()), selecting);
  1669. }
  1670. bool TextEditor::moveCaretToEnd (bool selecting)
  1671. {
  1672. return moveCaretWithTransaction (getTotalNumChars(), selecting);
  1673. }
  1674. bool TextEditor::moveCaretToEndOfLine (bool selecting)
  1675. {
  1676. const auto caretPos = (getCaretRectangle() - getTextOffset()).toFloat();
  1677. return moveCaretWithTransaction (indexAtPosition ((float) textHolder->getWidth(), caretPos.getY()), selecting);
  1678. }
  1679. bool TextEditor::deleteBackwards (bool moveInWholeWordSteps)
  1680. {
  1681. if (moveInWholeWordSteps)
  1682. moveCaretTo (findWordBreakBefore (getCaretPosition()), true);
  1683. else if (selection.isEmpty() && selection.getStart() > 0)
  1684. setSelection ({ selection.getEnd() - 1, selection.getEnd() });
  1685. cut();
  1686. return true;
  1687. }
  1688. bool TextEditor::deleteForwards (bool /*moveInWholeWordSteps*/)
  1689. {
  1690. if (selection.isEmpty() && selection.getStart() < getTotalNumChars())
  1691. setSelection ({ selection.getStart(), selection.getStart() + 1 });
  1692. cut();
  1693. return true;
  1694. }
  1695. bool TextEditor::copyToClipboard()
  1696. {
  1697. newTransaction();
  1698. copy();
  1699. return true;
  1700. }
  1701. bool TextEditor::cutToClipboard()
  1702. {
  1703. newTransaction();
  1704. copy();
  1705. cut();
  1706. return true;
  1707. }
  1708. bool TextEditor::pasteFromClipboard()
  1709. {
  1710. newTransaction();
  1711. paste();
  1712. return true;
  1713. }
  1714. bool TextEditor::selectAll()
  1715. {
  1716. newTransaction();
  1717. moveCaretTo (getTotalNumChars(), false);
  1718. moveCaretTo (0, true);
  1719. return true;
  1720. }
  1721. //==============================================================================
  1722. void TextEditor::setEscapeAndReturnKeysConsumed (bool shouldBeConsumed) noexcept
  1723. {
  1724. consumeEscAndReturnKeys = shouldBeConsumed;
  1725. }
  1726. bool TextEditor::keyPressed (const KeyPress& key)
  1727. {
  1728. if (isReadOnly() && key != KeyPress ('c', ModifierKeys::commandModifier, 0)
  1729. && key != KeyPress ('a', ModifierKeys::commandModifier, 0))
  1730. return false;
  1731. if (! TextEditorKeyMapper<TextEditor>::invokeKeyFunction (*this, key))
  1732. {
  1733. if (key == KeyPress::returnKey)
  1734. {
  1735. newTransaction();
  1736. if (returnKeyStartsNewLine)
  1737. {
  1738. insertTextAtCaret ("\n");
  1739. }
  1740. else
  1741. {
  1742. returnPressed();
  1743. return consumeEscAndReturnKeys;
  1744. }
  1745. }
  1746. else if (key.isKeyCode (KeyPress::escapeKey))
  1747. {
  1748. newTransaction();
  1749. moveCaretTo (getCaretPosition(), false);
  1750. escapePressed();
  1751. return consumeEscAndReturnKeys;
  1752. }
  1753. else if (key.getTextCharacter() >= ' '
  1754. || (tabKeyUsed && (key.getTextCharacter() == '\t')))
  1755. {
  1756. insertTextAtCaret (String::charToString (key.getTextCharacter()));
  1757. lastTransactionTime = Time::getApproximateMillisecondCounter();
  1758. }
  1759. else
  1760. {
  1761. return false;
  1762. }
  1763. }
  1764. return true;
  1765. }
  1766. bool TextEditor::keyStateChanged (const bool isKeyDown)
  1767. {
  1768. if (! isKeyDown)
  1769. return false;
  1770. #if JUCE_WINDOWS
  1771. if (KeyPress (KeyPress::F4Key, ModifierKeys::altModifier, 0).isCurrentlyDown())
  1772. return false; // We need to explicitly allow alt-F4 to pass through on Windows
  1773. #endif
  1774. if ((! consumeEscAndReturnKeys)
  1775. && (KeyPress (KeyPress::escapeKey).isCurrentlyDown()
  1776. || KeyPress (KeyPress::returnKey).isCurrentlyDown()))
  1777. return false;
  1778. // (overridden to avoid forwarding key events to the parent)
  1779. return ! ModifierKeys::currentModifiers.isCommandDown();
  1780. }
  1781. //==============================================================================
  1782. void TextEditor::focusGained (FocusChangeType cause)
  1783. {
  1784. newTransaction();
  1785. if (selectAllTextWhenFocused)
  1786. {
  1787. moveCaretTo (0, false);
  1788. moveCaretTo (getTotalNumChars(), true);
  1789. }
  1790. checkFocus();
  1791. if (cause == FocusChangeType::focusChangedByMouseClick && selectAllTextWhenFocused)
  1792. wasFocused = false;
  1793. repaint();
  1794. updateCaretPosition();
  1795. }
  1796. void TextEditor::focusLost (FocusChangeType)
  1797. {
  1798. newTransaction();
  1799. wasFocused = false;
  1800. textHolder->stopTimer();
  1801. underlinedSections.clear();
  1802. updateCaretPosition();
  1803. postCommandMessage (TextEditorDefs::focusLossMessageId);
  1804. repaint();
  1805. }
  1806. //==============================================================================
  1807. void TextEditor::resized()
  1808. {
  1809. viewport->setBoundsInset (borderSize);
  1810. viewport->setSingleStepSizes (16, roundToInt (currentFont.getHeight()));
  1811. checkLayout();
  1812. if (isMultiLine())
  1813. updateCaretPosition();
  1814. else
  1815. scrollToMakeSureCursorIsVisible();
  1816. }
  1817. void TextEditor::handleCommandMessage (const int commandId)
  1818. {
  1819. Component::BailOutChecker checker (this);
  1820. switch (commandId)
  1821. {
  1822. case TextEditorDefs::textChangeMessageId:
  1823. listeners.callChecked (checker, [this] (Listener& l) { l.textEditorTextChanged (*this); });
  1824. if (! checker.shouldBailOut() && onTextChange != nullptr)
  1825. onTextChange();
  1826. break;
  1827. case TextEditorDefs::returnKeyMessageId:
  1828. listeners.callChecked (checker, [this] (Listener& l) { l.textEditorReturnKeyPressed (*this); });
  1829. if (! checker.shouldBailOut() && onReturnKey != nullptr)
  1830. onReturnKey();
  1831. break;
  1832. case TextEditorDefs::escapeKeyMessageId:
  1833. listeners.callChecked (checker, [this] (Listener& l) { l.textEditorEscapeKeyPressed (*this); });
  1834. if (! checker.shouldBailOut() && onEscapeKey != nullptr)
  1835. onEscapeKey();
  1836. break;
  1837. case TextEditorDefs::focusLossMessageId:
  1838. updateValueFromText();
  1839. listeners.callChecked (checker, [this] (Listener& l) { l.textEditorFocusLost (*this); });
  1840. if (! checker.shouldBailOut() && onFocusLost != nullptr)
  1841. onFocusLost();
  1842. break;
  1843. default:
  1844. jassertfalse;
  1845. break;
  1846. }
  1847. }
  1848. void TextEditor::setTemporaryUnderlining (const Array<Range<int>>& newUnderlinedSections)
  1849. {
  1850. underlinedSections = newUnderlinedSections;
  1851. repaint();
  1852. }
  1853. //==============================================================================
  1854. UndoManager* TextEditor::getUndoManager() noexcept
  1855. {
  1856. return readOnly ? nullptr : &undoManager;
  1857. }
  1858. void TextEditor::clearInternal (UndoManager* const um)
  1859. {
  1860. remove ({ 0, getTotalNumChars() }, um, caretPosition);
  1861. }
  1862. void TextEditor::insert (const String& text, int insertIndex, const Font& font,
  1863. Colour colour, UndoManager* um, int caretPositionToMoveTo)
  1864. {
  1865. if (text.isNotEmpty())
  1866. {
  1867. if (um != nullptr)
  1868. {
  1869. if (um->getNumActionsInCurrentTransaction() > TextEditorDefs::maxActionsPerTransaction)
  1870. newTransaction();
  1871. um->perform (new InsertAction (*this, text, insertIndex, font, colour,
  1872. caretPosition, caretPositionToMoveTo));
  1873. }
  1874. else
  1875. {
  1876. repaintText ({ insertIndex, getTotalNumChars() }); // must do this before and after changing the data, in case
  1877. // a line gets moved due to word wrap
  1878. int index = 0;
  1879. int nextIndex = 0;
  1880. for (int i = 0; i < sections.size(); ++i)
  1881. {
  1882. nextIndex = index + sections.getUnchecked (i)->getTotalLength();
  1883. if (insertIndex == index)
  1884. {
  1885. sections.insert (i, new UniformTextSection (text, font, colour, passwordCharacter));
  1886. break;
  1887. }
  1888. if (insertIndex > index && insertIndex < nextIndex)
  1889. {
  1890. splitSection (i, insertIndex - index);
  1891. sections.insert (i + 1, new UniformTextSection (text, font, colour, passwordCharacter));
  1892. break;
  1893. }
  1894. index = nextIndex;
  1895. }
  1896. if (nextIndex == insertIndex)
  1897. sections.add (new UniformTextSection (text, font, colour, passwordCharacter));
  1898. coalesceSimilarSections();
  1899. totalNumChars = -1;
  1900. valueTextNeedsUpdating = true;
  1901. checkLayout();
  1902. moveCaretTo (caretPositionToMoveTo, false);
  1903. repaintText ({ insertIndex, getTotalNumChars() });
  1904. }
  1905. }
  1906. }
  1907. void TextEditor::reinsert (int insertIndex, const OwnedArray<UniformTextSection>& sectionsToInsert)
  1908. {
  1909. int index = 0;
  1910. int nextIndex = 0;
  1911. for (int i = 0; i < sections.size(); ++i)
  1912. {
  1913. nextIndex = index + sections.getUnchecked (i)->getTotalLength();
  1914. if (insertIndex == index)
  1915. {
  1916. for (int j = sectionsToInsert.size(); --j >= 0;)
  1917. sections.insert (i, new UniformTextSection (*sectionsToInsert.getUnchecked(j)));
  1918. break;
  1919. }
  1920. if (insertIndex > index && insertIndex < nextIndex)
  1921. {
  1922. splitSection (i, insertIndex - index);
  1923. for (int j = sectionsToInsert.size(); --j >= 0;)
  1924. sections.insert (i + 1, new UniformTextSection (*sectionsToInsert.getUnchecked(j)));
  1925. break;
  1926. }
  1927. index = nextIndex;
  1928. }
  1929. if (nextIndex == insertIndex)
  1930. for (auto* s : sectionsToInsert)
  1931. sections.add (new UniformTextSection (*s));
  1932. coalesceSimilarSections();
  1933. totalNumChars = -1;
  1934. valueTextNeedsUpdating = true;
  1935. }
  1936. void TextEditor::remove (Range<int> range, UndoManager* const um, const int caretPositionToMoveTo)
  1937. {
  1938. if (! range.isEmpty())
  1939. {
  1940. int index = 0;
  1941. for (int i = 0; i < sections.size(); ++i)
  1942. {
  1943. auto nextIndex = index + sections.getUnchecked(i)->getTotalLength();
  1944. if (range.getStart() > index && range.getStart() < nextIndex)
  1945. {
  1946. splitSection (i, range.getStart() - index);
  1947. --i;
  1948. }
  1949. else if (range.getEnd() > index && range.getEnd() < nextIndex)
  1950. {
  1951. splitSection (i, range.getEnd() - index);
  1952. --i;
  1953. }
  1954. else
  1955. {
  1956. index = nextIndex;
  1957. if (index > range.getEnd())
  1958. break;
  1959. }
  1960. }
  1961. index = 0;
  1962. if (um != nullptr)
  1963. {
  1964. Array<UniformTextSection*> removedSections;
  1965. for (auto* section : sections)
  1966. {
  1967. if (range.getEnd() <= range.getStart())
  1968. break;
  1969. auto nextIndex = index + section->getTotalLength();
  1970. if (range.getStart() <= index && range.getEnd() >= nextIndex)
  1971. removedSections.add (new UniformTextSection (*section));
  1972. index = nextIndex;
  1973. }
  1974. if (um->getNumActionsInCurrentTransaction() > TextEditorDefs::maxActionsPerTransaction)
  1975. newTransaction();
  1976. um->perform (new RemoveAction (*this, range, caretPosition,
  1977. caretPositionToMoveTo, removedSections));
  1978. }
  1979. else
  1980. {
  1981. auto remainingRange = range;
  1982. for (int i = 0; i < sections.size(); ++i)
  1983. {
  1984. auto* section = sections.getUnchecked (i);
  1985. auto nextIndex = index + section->getTotalLength();
  1986. if (remainingRange.getStart() <= index && remainingRange.getEnd() >= nextIndex)
  1987. {
  1988. sections.remove (i);
  1989. remainingRange.setEnd (remainingRange.getEnd() - (nextIndex - index));
  1990. if (remainingRange.isEmpty())
  1991. break;
  1992. --i;
  1993. }
  1994. else
  1995. {
  1996. index = nextIndex;
  1997. }
  1998. }
  1999. coalesceSimilarSections();
  2000. totalNumChars = -1;
  2001. valueTextNeedsUpdating = true;
  2002. checkLayout();
  2003. moveCaretTo (caretPositionToMoveTo, false);
  2004. repaintText ({ range.getStart(), getTotalNumChars() });
  2005. }
  2006. }
  2007. }
  2008. //==============================================================================
  2009. String TextEditor::getText() const
  2010. {
  2011. MemoryOutputStream mo;
  2012. mo.preallocate ((size_t) getTotalNumChars());
  2013. for (auto* s : sections)
  2014. s->appendAllText (mo);
  2015. return mo.toUTF8();
  2016. }
  2017. String TextEditor::getTextInRange (const Range<int>& range) const
  2018. {
  2019. if (range.isEmpty())
  2020. return {};
  2021. MemoryOutputStream mo;
  2022. mo.preallocate ((size_t) jmin (getTotalNumChars(), range.getLength()));
  2023. int index = 0;
  2024. for (auto* s : sections)
  2025. {
  2026. auto nextIndex = index + s->getTotalLength();
  2027. if (range.getStart() < nextIndex)
  2028. {
  2029. if (range.getEnd() <= index)
  2030. break;
  2031. s->appendSubstring (mo, range - index);
  2032. }
  2033. index = nextIndex;
  2034. }
  2035. return mo.toUTF8();
  2036. }
  2037. String TextEditor::getHighlightedText() const
  2038. {
  2039. return getTextInRange (selection);
  2040. }
  2041. int TextEditor::getTotalNumChars() const
  2042. {
  2043. if (totalNumChars < 0)
  2044. {
  2045. totalNumChars = 0;
  2046. for (auto* s : sections)
  2047. totalNumChars += s->getTotalLength();
  2048. }
  2049. return totalNumChars;
  2050. }
  2051. bool TextEditor::isEmpty() const
  2052. {
  2053. return getTotalNumChars() == 0;
  2054. }
  2055. void TextEditor::getCharPosition (int index, Point<float>& anchor, float& lineHeight) const
  2056. {
  2057. if (getWordWrapWidth() <= 0)
  2058. {
  2059. anchor = {};
  2060. lineHeight = currentFont.getHeight();
  2061. }
  2062. else
  2063. {
  2064. Iterator i (*this);
  2065. if (sections.isEmpty())
  2066. {
  2067. anchor = { i.getJustificationOffsetX (0), 0 };
  2068. lineHeight = currentFont.getHeight();
  2069. }
  2070. else
  2071. {
  2072. i.getCharPosition (index, anchor, lineHeight);
  2073. }
  2074. }
  2075. }
  2076. int TextEditor::indexAtPosition (const float x, const float y) const
  2077. {
  2078. if (getWordWrapWidth() > 0)
  2079. {
  2080. for (Iterator i (*this); i.next();)
  2081. {
  2082. if (y < i.lineY + (i.lineHeight * lineSpacing))
  2083. {
  2084. if (jmax (0.0f, y) < i.lineY)
  2085. return jmax (0, i.indexInText - 1);
  2086. if (x <= i.atomX || i.atom->isNewLine())
  2087. return i.indexInText;
  2088. if (x < i.atomRight)
  2089. return i.xToIndex (x);
  2090. }
  2091. }
  2092. }
  2093. return getTotalNumChars();
  2094. }
  2095. //==============================================================================
  2096. int TextEditor::findWordBreakAfter (const int position) const
  2097. {
  2098. auto t = getTextInRange ({ position, position + 512 });
  2099. auto totalLength = t.length();
  2100. int i = 0;
  2101. while (i < totalLength && CharacterFunctions::isWhitespace (t[i]))
  2102. ++i;
  2103. auto type = TextEditorDefs::getCharacterCategory (t[i]);
  2104. while (i < totalLength && type == TextEditorDefs::getCharacterCategory (t[i]))
  2105. ++i;
  2106. while (i < totalLength && CharacterFunctions::isWhitespace (t[i]))
  2107. ++i;
  2108. return position + i;
  2109. }
  2110. int TextEditor::findWordBreakBefore (const int position) const
  2111. {
  2112. if (position <= 0)
  2113. return 0;
  2114. auto startOfBuffer = jmax (0, position - 512);
  2115. auto t = getTextInRange ({ startOfBuffer, position });
  2116. int i = position - startOfBuffer;
  2117. while (i > 0 && CharacterFunctions::isWhitespace (t [i - 1]))
  2118. --i;
  2119. if (i > 0)
  2120. {
  2121. auto type = TextEditorDefs::getCharacterCategory (t [i - 1]);
  2122. while (i > 0 && type == TextEditorDefs::getCharacterCategory (t [i - 1]))
  2123. --i;
  2124. }
  2125. jassert (startOfBuffer + i >= 0);
  2126. return startOfBuffer + i;
  2127. }
  2128. //==============================================================================
  2129. void TextEditor::splitSection (const int sectionIndex, const int charToSplitAt)
  2130. {
  2131. jassert (sections[sectionIndex] != nullptr);
  2132. sections.insert (sectionIndex + 1,
  2133. sections.getUnchecked (sectionIndex)->split (charToSplitAt));
  2134. }
  2135. void TextEditor::coalesceSimilarSections()
  2136. {
  2137. for (int i = 0; i < sections.size() - 1; ++i)
  2138. {
  2139. auto* s1 = sections.getUnchecked (i);
  2140. auto* s2 = sections.getUnchecked (i + 1);
  2141. if (s1->font == s2->font
  2142. && s1->colour == s2->colour)
  2143. {
  2144. s1->append (*s2);
  2145. sections.remove (i + 1);
  2146. --i;
  2147. }
  2148. }
  2149. }
  2150. //==============================================================================
  2151. class TextEditor::EditorAccessibilityHandler : public AccessibilityHandler
  2152. {
  2153. public:
  2154. explicit EditorAccessibilityHandler (TextEditor& textEditorToWrap)
  2155. : AccessibilityHandler (textEditorToWrap,
  2156. textEditorToWrap.isReadOnly() ? AccessibilityRole::staticText : AccessibilityRole::editableText,
  2157. {},
  2158. { std::make_unique<TextEditorTextInterface> (textEditorToWrap) }),
  2159. textEditor (textEditorToWrap)
  2160. {
  2161. }
  2162. String getHelp() const override { return textEditor.getTooltip(); }
  2163. private:
  2164. class TextEditorTextInterface : public AccessibilityTextInterface
  2165. {
  2166. public:
  2167. explicit TextEditorTextInterface (TextEditor& editor)
  2168. : textEditor (editor)
  2169. {
  2170. }
  2171. bool isDisplayingProtectedText() const override { return textEditor.getPasswordCharacter() != 0; }
  2172. bool isReadOnly() const override { return textEditor.isReadOnly(); }
  2173. int getTotalNumCharacters() const override { return textEditor.getText().length(); }
  2174. Range<int> getSelection() const override { return textEditor.getHighlightedRegion(); }
  2175. void setSelection (Range<int> r) override
  2176. {
  2177. textEditor.setHighlightedRegion (r);
  2178. }
  2179. String getText (Range<int> r) const override
  2180. {
  2181. if (isDisplayingProtectedText())
  2182. return String::repeatedString (String::charToString (textEditor.getPasswordCharacter()),
  2183. getTotalNumCharacters());
  2184. return textEditor.getTextInRange (r);
  2185. }
  2186. void setText (const String& newText) override
  2187. {
  2188. textEditor.setText (newText);
  2189. }
  2190. int getTextInsertionOffset() const override { return textEditor.getCaretPosition(); }
  2191. RectangleList<int> getTextBounds (Range<int> textRange) const override
  2192. {
  2193. auto localRects = textEditor.getTextBounds (textRange);
  2194. RectangleList<int> globalRects;
  2195. std::for_each (localRects.begin(), localRects.end(),
  2196. [&] (const Rectangle<int>& r) { globalRects.add (textEditor.localAreaToGlobal (r)); });
  2197. return globalRects;
  2198. }
  2199. int getOffsetAtPoint (Point<int> point) const override
  2200. {
  2201. return textEditor.getTextIndexAt (textEditor.getLocalPoint (nullptr, point));
  2202. }
  2203. private:
  2204. TextEditor& textEditor;
  2205. //==============================================================================
  2206. JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TextEditorTextInterface)
  2207. };
  2208. TextEditor& textEditor;
  2209. //==============================================================================
  2210. JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (EditorAccessibilityHandler)
  2211. };
  2212. std::unique_ptr<AccessibilityHandler> TextEditor::createAccessibilityHandler()
  2213. {
  2214. return std::make_unique<EditorAccessibilityHandler> (*this);
  2215. }
  2216. } // namespace juce