ext/scintilla/src/EditView.h

   1 // Scintilla source code edit control
   2 /** @file EditView.h
   3  ** Defines the appearance of the main text area of the editor window.
   4  **/
   5 // Copyright 1998-2014 by Neil Hodgson <neilh@scintilla.org>
   6 // The License.txt file describes the conditions under which this software may be distributed.
   7
   8 #ifndef EDITVIEW_H
   9 #define EDITVIEW_H
  10
  11 namespace Scintilla {
  12
  13 struct PrintParameters {
  14         int magnification;
  15         int colourMode;
  16         WrapMode wrapState;
  17         PrintParameters() noexcept;
  18 };
  19
  20 /**
  21 * The view may be drawn in separate phases.
  22 */
  23 enum DrawPhase {
  24         drawBack = 0x1,
  25         drawIndicatorsBack = 0x2,
  26         drawText = 0x4,
  27         drawIndentationGuides = 0x8,
  28         drawIndicatorsFore = 0x10,
  29         drawSelectionTranslucent = 0x20,
  30         drawLineTranslucent = 0x40,
  31         drawFoldLines = 0x80,
  32         drawCarets = 0x100,
  33         drawAll = 0x1FF
  34 };
  35
  36 bool ValidStyledText(const ViewStyle &vs, size_t styleOffset, const StyledText &st) noexcept;
  37 int WidestLineWidth(Surface *surface, const ViewStyle &vs, int styleOffset, const StyledText &st);
  38 void DrawTextNoClipPhase(Surface *surface, PRectangle rc, const Style &style, XYPOSITION ybase,
  39         std::string_view text, DrawPhase phase);
  40 void DrawStyledText(Surface *surface, const ViewStyle &vs, int styleOffset, PRectangle rcText,
  41         const StyledText &st, size_t start, size_t length, DrawPhase phase);
  42
  43 typedef void (*DrawTabArrowFn)(Surface *surface, PRectangle rcTab, int ymid);
  44
  45 class LineTabstops;
  46
  47 /**
  48 * EditView draws the main text area.
  49 */
  50 class EditView {
  51 public:
  52         PrintParameters printParameters;
  53         std::unique_ptr<LineTabstops> ldTabstops;
  54         int tabWidthMinimumPixels;
  55
  56         bool hideSelection;
  57         bool drawOverstrikeCaret; // used by the curses platform
  58
  59         /** In bufferedDraw mode, graphics operations are drawn to a pixmap and then copied to
  60         * the screen. This avoids flashing but is about 30% slower. */
  61         bool bufferedDraw;
  62         /** In phasesTwo mode, drawing is performed in two phases, first the background
  63         * and then the foreground. This avoids chopping off characters that overlap the next run.
  64         * In multiPhaseDraw mode, drawing is performed in multiple phases with each phase drawing
  65         * one feature over the whole drawing area, instead of within one line. This allows text to
  66         * overlap from one line to the next. */
  67         enum PhasesDraw { phasesOne, phasesTwo, phasesMultiple };
  68         PhasesDraw phasesDraw;
  69
  70         int lineWidthMaxSeen;
  71
  72         bool additionalCaretsBlink;
  73         bool additionalCaretsVisible;
  74
  75         bool imeCaretBlockOverride;
  76
  77         std::unique_ptr<Surface> pixmapLine;
  78         std::unique_ptr<Surface> pixmapIndentGuide;
  79         std::unique_ptr<Surface> pixmapIndentGuideHighlight;
  80         void    *editor;
  81
  82         LineLayoutCache llc;
  83         PositionCache posCache;
  84
  85         int tabArrowHeight; // draw arrow heads this many pixels above/below line midpoint
  86         /** Some platforms, notably PLAT_CURSES, do not support Scintilla's native
  87          * DrawTabArrow function for drawing tab characters. Allow those platforms to
  88          * override it instead of creating a new method in the Surface class that
  89          * existing platforms must implement as empty. */
  90         DrawTabArrowFn customDrawTabArrow;
  91         DrawWrapMarkerFn customDrawWrapMarker;
  92
  93         EditView();
  94         // Deleted so EditView objects can not be copied.
  95         EditView(const EditView &) = delete;
  96         EditView(EditView &&) = delete;
  97         void operator=(const EditView &) = delete;
  98         void operator=(EditView &&) = delete;
  99         virtual ~EditView();
 100
 101         bool SetTwoPhaseDraw(bool twoPhaseDraw) noexcept;
 102         bool SetPhasesDraw(int phases) noexcept;
 103         bool LinesOverlap() const noexcept;
 104
 105         void ClearAllTabstops() noexcept;
 106         XYPOSITION NextTabstopPos(Sci::Line line, XYPOSITION x, XYPOSITION tabWidth) const noexcept;
 107         bool ClearTabstops(Sci::Line line) noexcept;
 108         bool AddTabstop(Sci::Line line, int x);
 109         int GetNextTabstop(Sci::Line line, int x) const noexcept;
 110         void LinesAddedOrRemoved(Sci::Line lineOfPos, Sci::Line linesAdded);
 111
 112         void DropGraphics(bool freeObjects);
 113         void AllocateGraphics(const ViewStyle &vsDraw);
 114         void RefreshPixMaps(Surface *surfaceWindow, WindowID wid, const ViewStyle &vsDraw);
 115
 116         LineLayout *RetrieveLineLayout(Sci::Line lineNumber, const EditModel &model);
 117         void LayoutLine(const EditModel &model, Sci::Line line, Surface *surface, const ViewStyle &vstyle,
 118                 LineLayout *ll, int width = LineLayout::wrapWidthInfinite);
 119
 120         static void UpdateBidiData(const EditModel &model, const ViewStyle &vstyle, LineLayout *ll);
 121
 122         Point LocationFromPosition(Surface *surface, const EditModel &model, SelectionPosition pos, Sci::Line topLine,
 123                 const ViewStyle &vs, PointEnd pe, const PRectangle rcClient);
 124         Range RangeDisplayLine(Surface *surface, const EditModel &model, Sci::Line lineVisible, const ViewStyle &vs);
 125         SelectionPosition SPositionFromLocation(Surface *surface, const EditModel &model, PointDocument pt, bool canReturnInvalid,
 126                 bool charPosition, bool virtualSpace, const ViewStyle &vs, const PRectangle rcClient);
 127         SelectionPosition SPositionFromLineX(Surface *surface, const EditModel &model, Sci::Line lineDoc, int x, const ViewStyle &vs);
 128         Sci::Line DisplayFromPosition(Surface *surface, const EditModel &model, Sci::Position pos, const ViewStyle &vs);
 129         Sci::Position StartEndDisplayLine(Surface *surface, const EditModel &model, Sci::Position pos, bool start, const ViewStyle &vs);
 130
 131         void DrawIndentGuide(Surface *surface, Sci::Line lineVisible, int lineHeight, XYPOSITION start, PRectangle rcSegment, bool highlight);
 132         void DrawEOL(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll, PRectangle rcLine,
 133                 Sci::Line line, Sci::Position lineEnd, int xStart, int subLine, XYACCUMULATOR subLineStart,
 134                 ColourOptional background);
 135         void DrawFoldDisplayText(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll,
 136                 Sci::Line line, int xStart, PRectangle rcLine, int subLine, XYACCUMULATOR subLineStart, DrawPhase phase);
 137         void DrawEOLAnnotationText(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll,
 138                 Sci::Line line, int xStart, PRectangle rcLine, int subLine, XYACCUMULATOR subLineStart, DrawPhase phase);
 139         void DrawAnnotation(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll,
 140                 Sci::Line line, int xStart, PRectangle rcLine, int subLine, DrawPhase phase);
 141         void DrawCarets(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll, Sci::Line lineDoc,
 142                 int xStart, PRectangle rcLine, int subLine) const;
 143         void DrawBackground(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll, PRectangle rcLine,
 144                 Range lineRange, Sci::Position posLineStart, int xStart,
 145                 int subLine, ColourOptional background) const;
 146         void DrawForeground(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll, Sci::Line lineVisible,
 147                 PRectangle rcLine, Range lineRange, Sci::Position posLineStart, int xStart,
 148                 int subLine, ColourOptional background);
 149         void DrawIndentGuidesOverEmpty(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll,
 150                 Sci::Line line, Sci::Line lineVisible, PRectangle rcLine, int xStart, int subLine);
 151         void DrawLine(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll, Sci::Line line,
 152                 Sci::Line lineVisible, int xStart, PRectangle rcLine, int subLine, DrawPhase phase);
 153         void PaintText(Surface *surfaceWindow, const EditModel &model, PRectangle rcArea, PRectangle rcClient,
 154                 const ViewStyle &vsDraw);
 155         void FillLineRemainder(Surface *surface, const EditModel &model, const ViewStyle &vsDraw, const LineLayout *ll,
 156                 Sci::Line line, PRectangle rcArea, int subLine) const;
 157         Sci::Position FormatRange(bool draw, const Sci_RangeToFormat *pfr, Surface *surface, Surface *surfaceMeasure,
 158                 const EditModel &model, const ViewStyle &vs);
 159 };
 160
 161 /**
 162 * Convenience class to ensure LineLayout objects are always disposed.
 163 */
 164 class AutoLineLayout {
 165         LineLayoutCache &llc;
 166         LineLayout *ll;
 167 public:
 168         AutoLineLayout(LineLayoutCache &llc_, LineLayout *ll_) noexcept : llc(llc_), ll(ll_) {}
 169         AutoLineLayout(const AutoLineLayout &) = delete;
 170         AutoLineLayout(AutoLineLayout &&) = delete;
 171         AutoLineLayout &operator=(const AutoLineLayout &) = delete;
 172         AutoLineLayout &operator=(AutoLineLayout &&) = delete;
 173         ~AutoLineLayout() noexcept {
 174                 llc.Dispose(ll);
 175                 ll = nullptr;
 176         }
 177         LineLayout *operator->() const noexcept {
 178                 return ll;
 179         }
 180         operator LineLayout *() const noexcept {
 181                 return ll;
 182         }
 183         void Set(LineLayout *ll_) noexcept {
 184                 llc.Dispose(ll);
 185                 ll = ll_;
 186         }
 187 };
 188
 189 }
 190
 191 #endif