271 lines
11 KiB
C
271 lines
11 KiB
C
|
/*
|
||
|
|
==============================================================================
|
||
|
|
|
||
|
|
This file is part of the JUCE library.
|
||
|
|
Copyright (c) 2020 - Raw Material Software Limited
|
||
|
|
|
||
|
|
JUCE is an open source library subject to commercial or open-source
|
||
|
|
licensing.
|
||
|
|
|
||
|
|
By using JUCE, you agree to the terms of both the JUCE 6 End-User License
|
||
|
|
Agreement and JUCE Privacy Policy (both effective as of the 16th June 2020).
|
||
|
|
|
||
|
|
End User License Agreement: www.juce.com/juce-6-licence
|
||
|
|
Privacy Policy: www.juce.com/juce-privacy-policy
|
||
|
|
|
||
|
|
Or: You may also use this code under the terms of the GPL v3 (see
|
||
|
|
www.gnu.org/licenses).
|
||
|
|
|
||
|
|
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
||
|
|
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
|
||
|
|
DISCLAIMED.
|
||
|
|
|
||
|
|
==============================================================================
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace juce
|
||
|
|
{
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/**
|
||
|
|
A Pre-formatted piece of text, which may contain multiple fonts and colours.
|
||
|
|
|
||
|
|
A TextLayout is created from an AttributedString, and once created can be
|
||
|
|
quickly drawn into a Graphics context.
|
||
|
|
|
||
|
|
@see AttributedString
|
||
|
|
|
||
|
|
@tags{Graphics}
|
||
|
|
*/
|
||
|
|
class JUCE_API TextLayout final
|
||
|
|
{
|
||
|
|
private:
|
||
|
|
template <typename Iterator>
|
||
|
|
class DereferencingIterator
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
using value_type = typename std::remove_reference<decltype(**std::declval<Iterator>())>::type;
|
||
|
|
using difference_type = typename std::iterator_traits<Iterator>::difference_type;
|
||
|
|
using pointer = value_type*;
|
||
|
|
using reference = value_type&;
|
||
|
|
using iterator_category = typename std::iterator_traits<Iterator>::iterator_category;
|
||
|
|
|
||
|
|
explicit DereferencingIterator (Iterator in) : iterator (std::move (in)) {}
|
||
|
|
|
||
|
|
DereferencingIterator& operator+= (difference_type distance)
|
||
|
|
{
|
||
|
|
iterator += distance;
|
||
|
|
return *this;
|
||
|
|
}
|
||
|
|
|
||
|
|
friend DereferencingIterator operator+ (DereferencingIterator i, difference_type d) { return i += d; }
|
||
|
|
friend DereferencingIterator operator+ (difference_type d, DereferencingIterator i) { return i += d; }
|
||
|
|
|
||
|
|
DereferencingIterator& operator-= (difference_type distance)
|
||
|
|
{
|
||
|
|
iterator -= distance;
|
||
|
|
return *this;
|
||
|
|
}
|
||
|
|
|
||
|
|
friend DereferencingIterator operator- (DereferencingIterator i, difference_type d) { return i -= d; }
|
||
|
|
|
||
|
|
friend difference_type operator- (DereferencingIterator a, DereferencingIterator b) { return a.iterator - b.iterator; }
|
||
|
|
|
||
|
|
reference operator[] (difference_type d) const { return *iterator[d]; }
|
||
|
|
|
||
|
|
friend bool operator< (DereferencingIterator a, DereferencingIterator b) { return a.iterator < b.iterator; }
|
||
|
|
friend bool operator<= (DereferencingIterator a, DereferencingIterator b) { return a.iterator <= b.iterator; }
|
||
|
|
friend bool operator> (DereferencingIterator a, DereferencingIterator b) { return a.iterator > b.iterator; }
|
||
|
|
friend bool operator>= (DereferencingIterator a, DereferencingIterator b) { return a.iterator >= b.iterator; }
|
||
|
|
friend bool operator== (DereferencingIterator a, DereferencingIterator b) { return a.iterator == b.iterator; }
|
||
|
|
friend bool operator!= (DereferencingIterator a, DereferencingIterator b) { return a.iterator != b.iterator; }
|
||
|
|
|
||
|
|
DereferencingIterator& operator++() { ++iterator; return *this; }
|
||
|
|
DereferencingIterator& operator--() { --iterator; return *this; }
|
||
|
|
DereferencingIterator operator++ (int) const { DereferencingIterator copy (*this); ++(*this); return copy; }
|
||
|
|
DereferencingIterator operator-- (int) const { DereferencingIterator copy (*this); --(*this); return copy; }
|
||
|
|
|
||
|
|
reference operator* () const { return **iterator; }
|
||
|
|
pointer operator->() const { return *iterator; }
|
||
|
|
|
||
|
|
private:
|
||
|
|
Iterator iterator;
|
||
|
|
};
|
||
|
|
|
||
|
|
public:
|
||
|
|
/** Creates an empty layout.
|
||
|
|
Having created a TextLayout, you can populate it using createLayout() or
|
||
|
|
createLayoutWithBalancedLineLengths().
|
||
|
|
*/
|
||
|
|
TextLayout();
|
||
|
|
TextLayout (const TextLayout&);
|
||
|
|
TextLayout& operator= (const TextLayout&);
|
||
|
|
TextLayout (TextLayout&&) noexcept;
|
||
|
|
TextLayout& operator= (TextLayout&&) noexcept;
|
||
|
|
|
||
|
|
/** Destructor. */
|
||
|
|
~TextLayout();
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/** Creates a layout from the given attributed string.
|
||
|
|
This will replace any data that is currently stored in the layout.
|
||
|
|
*/
|
||
|
|
void createLayout (const AttributedString&, float maxWidth);
|
||
|
|
|
||
|
|
/** Creates a layout from the given attributed string, given some size constraints.
|
||
|
|
This will replace any data that is currently stored in the layout.
|
||
|
|
*/
|
||
|
|
void createLayout (const AttributedString&, float maxWidth, float maxHeight);
|
||
|
|
|
||
|
|
/** Creates a layout, attempting to choose a width which results in lines
|
||
|
|
of a similar length.
|
||
|
|
|
||
|
|
This will be slower than the normal createLayout method, but produces a
|
||
|
|
tidier result.
|
||
|
|
*/
|
||
|
|
void createLayoutWithBalancedLineLengths (const AttributedString&, float maxWidth);
|
||
|
|
|
||
|
|
/** Creates a layout, attempting to choose a width which results in lines
|
||
|
|
of a similar length.
|
||
|
|
|
||
|
|
This will be slower than the normal createLayout method, but produces a
|
||
|
|
tidier result.
|
||
|
|
*/
|
||
|
|
void createLayoutWithBalancedLineLengths (const AttributedString&, float maxWidth, float maxHeight);
|
||
|
|
|
||
|
|
/** Draws the layout within the specified area.
|
||
|
|
The position of the text within the rectangle is controlled by the justification
|
||
|
|
flags set in the original AttributedString that was used to create this layout.
|
||
|
|
*/
|
||
|
|
void draw (Graphics&, Rectangle<float> area) const;
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/** A positioned glyph. */
|
||
|
|
class JUCE_API Glyph
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
Glyph (int glyphCode, Point<float> anchor, float width) noexcept;
|
||
|
|
|
||
|
|
/** The code number of this glyph. */
|
||
|
|
int glyphCode;
|
||
|
|
|
||
|
|
/** The glyph's anchor point - this is relative to the line's origin.
|
||
|
|
@see TextLayout::Line::lineOrigin
|
||
|
|
*/
|
||
|
|
Point<float> anchor;
|
||
|
|
|
||
|
|
float width;
|
||
|
|
|
||
|
|
private:
|
||
|
|
JUCE_LEAK_DETECTOR (Glyph)
|
||
|
|
};
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/** A sequence of glyphs with a common font and colour. */
|
||
|
|
class JUCE_API Run
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
Run() = default;
|
||
|
|
Run (Range<int> stringRange, int numGlyphsToPreallocate);
|
||
|
|
|
||
|
|
/** Returns the X position range which contains all the glyphs in this run. */
|
||
|
|
Range<float> getRunBoundsX() const noexcept;
|
||
|
|
|
||
|
|
Font font; /**< The run's font. */
|
||
|
|
Colour colour { 0xff000000 }; /**< The run's colour. */
|
||
|
|
Array<Glyph> glyphs; /**< The glyphs in this run. */
|
||
|
|
Range<int> stringRange; /**< The character range that this run represents in the
|
||
|
|
original string that was used to create it. */
|
||
|
|
private:
|
||
|
|
JUCE_LEAK_DETECTOR (Run)
|
||
|
|
};
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/** A line containing a sequence of glyph-runs. */
|
||
|
|
class JUCE_API Line
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
Line() = default;
|
||
|
|
Line (Range<int> stringRange, Point<float> lineOrigin,
|
||
|
|
float ascent, float descent, float leading, int numRunsToPreallocate);
|
||
|
|
|
||
|
|
Line (const Line&);
|
||
|
|
Line& operator= (const Line&);
|
||
|
|
|
||
|
|
Line (Line&&) noexcept = default;
|
||
|
|
Line& operator= (Line&&) noexcept = default;
|
||
|
|
|
||
|
|
~Line() noexcept = default;
|
||
|
|
|
||
|
|
/** Returns the X position range which contains all the glyphs in this line. */
|
||
|
|
Range<float> getLineBoundsX() const noexcept;
|
||
|
|
|
||
|
|
/** Returns the Y position range which contains all the glyphs in this line. */
|
||
|
|
Range<float> getLineBoundsY() const noexcept;
|
||
|
|
|
||
|
|
/** Returns the smallest rectangle which contains all the glyphs in this line. */
|
||
|
|
Rectangle<float> getLineBounds() const noexcept;
|
||
|
|
|
||
|
|
void swap (Line& other) noexcept;
|
||
|
|
|
||
|
|
OwnedArray<Run> runs; /**< The glyph-runs in this line. */
|
||
|
|
Range<int> stringRange; /**< The character range that this line represents in the
|
||
|
|
original string that was used to create it. */
|
||
|
|
Point<float> lineOrigin; /**< The line's baseline origin. */
|
||
|
|
float ascent = 0.0f, descent = 0.0f, leading = 0.0f;
|
||
|
|
|
||
|
|
private:
|
||
|
|
JUCE_LEAK_DETECTOR (Line)
|
||
|
|
};
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/** Returns the maximum width of the content. */
|
||
|
|
float getWidth() const noexcept { return width; }
|
||
|
|
|
||
|
|
/** Returns the maximum height of the content. */
|
||
|
|
float getHeight() const noexcept { return height; }
|
||
|
|
|
||
|
|
/** Returns the number of lines in the layout. */
|
||
|
|
int getNumLines() const noexcept { return lines.size(); }
|
||
|
|
|
||
|
|
/** Returns one of the lines. */
|
||
|
|
Line& getLine (int index) const noexcept;
|
||
|
|
|
||
|
|
/** Adds a line to the layout. The layout will take ownership of this line object
|
||
|
|
and will delete it when it is no longer needed. */
|
||
|
|
void addLine (std::unique_ptr<Line>);
|
||
|
|
|
||
|
|
/** Pre-allocates space for the specified number of lines. */
|
||
|
|
void ensureStorageAllocated (int numLinesNeeded);
|
||
|
|
|
||
|
|
using iterator = DereferencingIterator< Line* const*>;
|
||
|
|
using const_iterator = DereferencingIterator<const Line* const*>;
|
||
|
|
|
||
|
|
/** Returns an iterator over the lines of content */
|
||
|
|
iterator begin() { return iterator (lines.begin()); }
|
||
|
|
const_iterator begin() const { return const_iterator (lines.begin()); }
|
||
|
|
const_iterator cbegin() const { return const_iterator (lines.begin()); }
|
||
|
|
|
||
|
|
/** Returns an iterator over the lines of content */
|
||
|
|
iterator end() { return iterator (lines.end()); }
|
||
|
|
const_iterator end() const { return const_iterator (lines.end()); }
|
||
|
|
const_iterator cend() const { return const_iterator (lines.end()); }
|
||
|
|
|
||
|
|
/** If you modify the TextLayout after creating it, call this to compute
|
||
|
|
the new dimensions of the content.
|
||
|
|
*/
|
||
|
|
void recalculateSize();
|
||
|
|
|
||
|
|
private:
|
||
|
|
OwnedArray<Line> lines;
|
||
|
|
float width, height;
|
||
|
|
Justification justification;
|
||
|
|
|
||
|
|
void createStandardLayout (const AttributedString&);
|
||
|
|
bool createNativeLayout (const AttributedString&);
|
||
|
|
|
||
|
|
JUCE_LEAK_DETECTOR (TextLayout)
|
||
|
|
};
|
||
|
|
|
||
|
|
} // namespace juce
|