ext/scintilla/src/ViewStyle.cxx

   1 // Scintilla source code edit control
   2 /** @file ViewStyle.cxx
   3  ** Store information on how the document is to be viewed.
   4  **/
   5 // Copyright 1998-2003 by Neil Hodgson <neilh@scintilla.org>
   6 // The License.txt file describes the conditions under which this software may be distributed.
   7
   8 #include <string.h>
   9
  10 #include <vector>
  11 #include <map>
  12
  13 #include "Platform.h"
  14
  15 #include "Scintilla.h"
  16 #include "SplitVector.h"
  17 #include "Partitioning.h"
  18 #include "RunStyles.h"
  19 #include "Indicator.h"
  20 #include "XPM.h"
  21 #include "LineMarker.h"
  22 #include "Style.h"
  23 #include "ViewStyle.h"
  24
  25 #ifdef SCI_NAMESPACE
  26 using namespace Scintilla;
  27 #endif
  28
  29 MarginStyle::MarginStyle() :
  30         style(SC_MARGIN_SYMBOL), width(0), mask(0), sensitive(false), cursor(SC_CURSORREVERSEARROW) {
  31 }
  32
  33 // A list of the fontnames - avoids wasting space in each style
  34 FontNames::FontNames() {
  35         size = 8;
  36         names = new char *[size];
  37         max = 0;
  38 }
  39
  40 FontNames::~FontNames() {
  41         Clear();
  42         delete []names;
  43         names = 0;
  44 }
  45
  46 void FontNames::Clear() {
  47         for (int i=0; i<max; i++) {
  48                 delete []names[i];
  49         }
  50         max = 0;
  51 }
  52
  53 const char *FontNames::Save(const char *name) {
  54         if (!name)
  55                 return 0;
  56         for (int i=0; i<max; i++) {
  57                 if (strcmp(names[i], name) == 0) {
  58                         return names[i];
  59                 }
  60         }
  61         if (max >= size) {
  62                 // Grow array
  63                 int sizeNew = size * 2;
  64                 char **namesNew = new char *[sizeNew];
  65                 for (int j=0; j<max; j++) {
  66                         namesNew[j] = names[j];
  67                 }
  68                 delete []names;
  69                 names = namesNew;
  70                 size = sizeNew;
  71         }
  72         names[max] = new char[strlen(name) + 1];
  73         strcpy(names[max], name);
  74         max++;
  75         return names[max-1];
  76 }
  77
  78 FontRealised::FontRealised(const FontSpecification &fs) {
  79         frNext = NULL;
  80         (FontSpecification &)(*this) = fs;
  81 }
  82
  83 FontRealised::~FontRealised() {
  84         font.Release();
  85         delete frNext;
  86         frNext = 0;
  87 }
  88
  89 void FontRealised::Realise(Surface &surface, int zoomLevel) {
  90         PLATFORM_ASSERT(fontName);
  91         sizeZoomed = size + zoomLevel;
  92         if (sizeZoomed <= 2)    // Hangs if sizeZoomed <= 1
  93                 sizeZoomed = 2;
  94
  95         int deviceHeight = surface.DeviceHeightFont(sizeZoomed);
  96         font.Create(fontName, characterSet, deviceHeight, bold, italic, extraFontFlag);
  97
  98         ascent = surface.Ascent(font);
  99         descent = surface.Descent(font);
 100         externalLeading = surface.ExternalLeading(font);
 101         lineHeight = surface.Height(font);
 102         aveCharWidth = surface.AverageCharWidth(font);
 103         spaceWidth = surface.WidthChar(font, ' ');
 104         if (frNext) {
 105                 frNext->Realise(surface, zoomLevel);
 106         }
 107 }
 108
 109 FontRealised *FontRealised::Find(const FontSpecification &fs) {
 110         if (!fs.fontName)
 111                 return this;
 112         FontRealised *fr = this;
 113         while (fr) {
 114                 if (fr->EqualTo(fs))
 115                         return fr;
 116                 fr = fr->frNext;
 117         }
 118         return 0;
 119 }
 120
 121 void FontRealised::FindMaxAscentDescent(unsigned int &maxAscent, unsigned int &maxDescent) {
 122         FontRealised *fr = this;
 123         while (fr) {
 124                 if (maxAscent < fr->ascent)
 125                         maxAscent = fr->ascent;
 126                 if (maxDescent < fr->descent)
 127                         maxDescent = fr->descent;
 128                 fr = fr->frNext;
 129         }
 130 }
 131
 132 ViewStyle::ViewStyle() {
 133         Init();
 134 }
 135
 136 ViewStyle::ViewStyle(const ViewStyle &source) {
 137         frFirst = NULL;
 138         Init(source.stylesSize);
 139         for (unsigned int sty=0; sty<source.stylesSize; sty++) {
 140                 styles[sty] = source.styles[sty];
 141                 // Can't just copy fontname as its lifetime is relative to its owning ViewStyle
 142                 styles[sty].fontName = fontNames.Save(source.styles[sty].fontName);
 143         }
 144         for (int mrk=0; mrk<=MARKER_MAX; mrk++) {
 145                 markers[mrk] = source.markers[mrk];
 146         }
 147         for (int ind=0; ind<=INDIC_MAX; ind++) {
 148                 indicators[ind] = source.indicators[ind];
 149         }
 150
 151         selforeset = source.selforeset;
 152         selforeground.desired = source.selforeground.desired;
 153         selAdditionalForeground.desired = source.selAdditionalForeground.desired;
 154         selbackset = source.selbackset;
 155         selbackground.desired = source.selbackground.desired;
 156         selAdditionalBackground.desired = source.selAdditionalBackground.desired;
 157         selbackground2.desired = source.selbackground2.desired;
 158         selAlpha = source.selAlpha;
 159         selAdditionalAlpha = source.selAdditionalAlpha;
 160         selEOLFilled = source.selEOLFilled;
 161
 162         foldmarginColourSet = source.foldmarginColourSet;
 163         foldmarginColour.desired = source.foldmarginColour.desired;
 164         foldmarginHighlightColourSet = source.foldmarginHighlightColourSet;
 165         foldmarginHighlightColour.desired = source.foldmarginHighlightColour.desired;
 166
 167         hotspotForegroundSet = source.hotspotForegroundSet;
 168         hotspotForeground.desired = source.hotspotForeground.desired;
 169         hotspotBackgroundSet = source.hotspotBackgroundSet;
 170         hotspotBackground.desired = source.hotspotBackground.desired;
 171         hotspotUnderline = source.hotspotUnderline;
 172         hotspotSingleLine = source.hotspotSingleLine;
 173
 174         whitespaceForegroundSet = source.whitespaceForegroundSet;
 175         whitespaceForeground.desired = source.whitespaceForeground.desired;
 176         whitespaceBackgroundSet = source.whitespaceBackgroundSet;
 177         whitespaceBackground.desired = source.whitespaceBackground.desired;
 178         selbar.desired = source.selbar.desired;
 179         selbarlight.desired = source.selbarlight.desired;
 180         caretcolour.desired = source.caretcolour.desired;
 181         additionalCaretColour.desired = source.additionalCaretColour.desired;
 182         showCaretLineBackground = source.showCaretLineBackground;
 183         caretLineBackground.desired = source.caretLineBackground.desired;
 184         caretLineAlpha = source.caretLineAlpha;
 185         edgecolour.desired = source.edgecolour.desired;
 186         edgeState = source.edgeState;
 187         caretStyle = source.caretStyle;
 188         caretWidth = source.caretWidth;
 189         someStylesProtected = false;
 190         someStylesForceCase = false;
 191         leftMarginWidth = source.leftMarginWidth;
 192         rightMarginWidth = source.rightMarginWidth;
 193         for (int i=0; i < margins; i++) {
 194                 ms[i] = source.ms[i];
 195         }
 196         symbolMargin = source.symbolMargin;
 197         maskInLine = source.maskInLine;
 198         fixedColumnWidth = source.fixedColumnWidth;
 199         zoomLevel = source.zoomLevel;
 200         viewWhitespace = source.viewWhitespace;
 201         whitespaceSize = source.whitespaceSize;
 202         viewIndentationGuides = source.viewIndentationGuides;
 203         viewEOL = source.viewEOL;
 204         showMarkedLines = source.showMarkedLines;
 205         extraFontFlag = source.extraFontFlag;
 206         extraAscent = source.extraAscent;
 207         extraDescent = source.extraDescent;
 208         marginStyleOffset = source.marginStyleOffset;
 209         annotationVisible = source.annotationVisible;
 210         annotationStyleOffset = source.annotationStyleOffset;
 211         braceHighlightIndicatorSet = source.braceHighlightIndicatorSet;
 212         braceHighlightIndicator = source.braceHighlightIndicator;
 213         braceBadLightIndicatorSet = source.braceBadLightIndicatorSet;
 214         braceBadLightIndicator = source.braceBadLightIndicator;
 215 }
 216
 217 ViewStyle::~ViewStyle() {
 218         delete []styles;
 219         styles = NULL;
 220         delete frFirst;
 221         frFirst = NULL;
 222 }
 223
 224 void ViewStyle::Init(size_t stylesSize_) {
 225         frFirst = NULL;
 226         stylesSize = 0;
 227         styles = NULL;
 228         AllocStyles(stylesSize_);
 229         fontNames.Clear();
 230         ResetDefaultStyle();
 231
 232         indicators[0].style = INDIC_SQUIGGLE;
 233         indicators[0].under = false;
 234         indicators[0].fore = ColourDesired(0, 0x7f, 0);
 235         indicators[1].style = INDIC_TT;
 236         indicators[1].under = false;
 237         indicators[1].fore = ColourDesired(0, 0, 0xff);
 238         indicators[2].style = INDIC_PLAIN;
 239         indicators[2].under = false;
 240         indicators[2].fore = ColourDesired(0xff, 0, 0);
 241
 242         lineHeight = 1;
 243         maxAscent = 1;
 244         maxDescent = 1;
 245         aveCharWidth = 8;
 246         spaceWidth = 8;
 247
 248         selforeset = false;
 249         selforeground.desired = ColourDesired(0xff, 0, 0);
 250         selAdditionalForeground.desired = ColourDesired(0xff, 0, 0);
 251         selbackset = true;
 252         selbackground.desired = ColourDesired(0xc0, 0xc0, 0xc0);
 253         selAdditionalBackground.desired = ColourDesired(0xd7, 0xd7, 0xd7);
 254         selbackground2.desired = ColourDesired(0xb0, 0xb0, 0xb0);
 255         selAlpha = SC_ALPHA_NOALPHA;
 256         selAdditionalAlpha = SC_ALPHA_NOALPHA;
 257         selEOLFilled = false;
 258
 259         foldmarginColourSet = false;
 260         foldmarginColour.desired = ColourDesired(0xff, 0, 0);
 261         foldmarginHighlightColourSet = false;
 262         foldmarginHighlightColour.desired = ColourDesired(0xc0, 0xc0, 0xc0);
 263
 264         whitespaceForegroundSet = false;
 265         whitespaceForeground.desired = ColourDesired(0, 0, 0);
 266         whitespaceBackgroundSet = false;
 267         whitespaceBackground.desired = ColourDesired(0xff, 0xff, 0xff);
 268         selbar.desired = Platform::Chrome();
 269         selbarlight.desired = Platform::ChromeHighlight();
 270         styles[STYLE_LINENUMBER].fore.desired = ColourDesired(0, 0, 0);
 271         styles[STYLE_LINENUMBER].back.desired = Platform::Chrome();
 272         caretcolour.desired = ColourDesired(0, 0, 0);
 273         additionalCaretColour.desired = ColourDesired(0x7f, 0x7f, 0x7f);
 274         showCaretLineBackground = false;
 275         caretLineBackground.desired = ColourDesired(0xff, 0xff, 0);
 276         caretLineAlpha = SC_ALPHA_NOALPHA;
 277         edgecolour.desired = ColourDesired(0xc0, 0xc0, 0xc0);
 278         edgeState = EDGE_NONE;
 279         caretStyle = CARETSTYLE_LINE;
 280         caretWidth = 1;
 281         someStylesProtected = false;
 282         someStylesForceCase = false;
 283
 284         hotspotForegroundSet = false;
 285         hotspotForeground.desired = ColourDesired(0, 0, 0xff);
 286         hotspotBackgroundSet = false;
 287         hotspotBackground.desired = ColourDesired(0xff, 0xff, 0xff);
 288         hotspotUnderline = true;
 289         hotspotSingleLine = true;
 290
 291         leftMarginWidth = 1;
 292         rightMarginWidth = 1;
 293         ms[0].style = SC_MARGIN_NUMBER;
 294         ms[0].width = 0;
 295         ms[0].mask = 0;
 296         ms[1].style = SC_MARGIN_SYMBOL;
 297         ms[1].width = 16;
 298         ms[1].mask = ~SC_MASK_FOLDERS;
 299         ms[2].style = SC_MARGIN_SYMBOL;
 300         ms[2].width = 0;
 301         ms[2].mask = 0;
 302         fixedColumnWidth = leftMarginWidth;
 303         symbolMargin = false;
 304         maskInLine = 0xffffffff;
 305         for (int margin=0; margin < margins; margin++) {
 306                 fixedColumnWidth += ms[margin].width;
 307                 symbolMargin = symbolMargin || (ms[margin].style != SC_MARGIN_NUMBER);
 308                 if (ms[margin].width > 0)
 309                         maskInLine &= ~ms[margin].mask;
 310         }
 311         zoomLevel = 0;
 312         viewWhitespace = wsInvisible;
 313         whitespaceSize = 1;
 314         viewIndentationGuides = ivNone;
 315         viewEOL = false;
 316         showMarkedLines = true;
 317         extraFontFlag = 0;
 318         extraAscent = 0;
 319         extraDescent = 0;
 320         marginStyleOffset = 0;
 321         annotationVisible = ANNOTATION_HIDDEN;
 322         annotationStyleOffset = 0;
 323         braceHighlightIndicatorSet = false;
 324         braceHighlightIndicator = 0;
 325         braceBadLightIndicatorSet = false;
 326         braceBadLightIndicator = 0;
 327 }
 328
 329 void ViewStyle::RefreshColourPalette(Palette &pal, bool want) {
 330         unsigned int i;
 331         for (i=0; i<stylesSize; i++) {
 332                 pal.WantFind(styles[i].fore, want);
 333                 pal.WantFind(styles[i].back, want);
 334         }
 335         for (i=0; i<(sizeof(indicators)/sizeof(indicators[0])); i++) {
 336                 pal.WantFind(indicators[i].fore, want);
 337         }
 338         for (i=0; i<(sizeof(markers)/sizeof(markers[0])); i++) {
 339                 markers[i].RefreshColourPalette(pal, want);
 340         }
 341         pal.WantFind(selforeground, want);
 342         pal.WantFind(selAdditionalForeground, want);
 343         pal.WantFind(selbackground, want);
 344         pal.WantFind(selAdditionalBackground, want);
 345         pal.WantFind(selbackground2, want);
 346
 347         pal.WantFind(foldmarginColour, want);
 348         pal.WantFind(foldmarginHighlightColour, want);
 349
 350         pal.WantFind(whitespaceForeground, want);
 351         pal.WantFind(whitespaceBackground, want);
 352         pal.WantFind(selbar, want);
 353         pal.WantFind(selbarlight, want);
 354         pal.WantFind(caretcolour, want);
 355         pal.WantFind(additionalCaretColour, want);
 356         pal.WantFind(caretLineBackground, want);
 357         pal.WantFind(edgecolour, want);
 358         pal.WantFind(hotspotForeground, want);
 359         pal.WantFind(hotspotBackground, want);
 360 }
 361
 362 void ViewStyle::CreateFont(const FontSpecification &fs) {
 363         if (fs.fontName) {
 364                 for (FontRealised *cur=frFirst; cur; cur=cur->frNext) {
 365                         if (cur->EqualTo(fs))
 366                                 return;
 367                         if (!cur->frNext) {
 368                                 cur->frNext = new FontRealised(fs);
 369                                 return;
 370                         }
 371                 }
 372                 frFirst = new FontRealised(fs);
 373         }
 374 }
 375
 376 void ViewStyle::Refresh(Surface &surface) {
 377         delete frFirst;
 378         frFirst = NULL;
 379         selbar.desired = Platform::Chrome();
 380         selbarlight.desired = Platform::ChromeHighlight();
 381
 382         for (unsigned int i=0; i<stylesSize; i++) {
 383                 styles[i].extraFontFlag = extraFontFlag;
 384         }
 385
 386         CreateFont(styles[STYLE_DEFAULT]);
 387         for (unsigned int j=0; j<stylesSize; j++) {
 388                 CreateFont(styles[j]);
 389         }
 390
 391         frFirst->Realise(surface, zoomLevel);
 392
 393         for (unsigned int k=0; k<stylesSize; k++) {
 394                 FontRealised *fr = frFirst->Find(styles[k]);
 395                 styles[k].Copy(fr->font, *fr);
 396         }
 397         maxAscent = 1;
 398         maxDescent = 1;
 399         frFirst->FindMaxAscentDescent(maxAscent, maxDescent);
 400         maxAscent += extraAscent;
 401         maxDescent += extraDescent;
 402         lineHeight = maxAscent + maxDescent;
 403
 404         someStylesProtected = false;
 405         someStylesForceCase = false;
 406         for (unsigned int l=0; l<stylesSize; l++) {
 407                 if (styles[l].IsProtected()) {
 408                         someStylesProtected = true;
 409                 }
 410                 if (styles[l].caseForce != Style::caseMixed) {
 411                         someStylesForceCase = true;
 412                 }
 413         }
 414
 415         aveCharWidth = styles[STYLE_DEFAULT].aveCharWidth;
 416         spaceWidth = styles[STYLE_DEFAULT].spaceWidth;
 417
 418         fixedColumnWidth = leftMarginWidth;
 419         symbolMargin = false;
 420         maskInLine = 0xffffffff;
 421         for (int margin=0; margin < margins; margin++) {
 422                 fixedColumnWidth += ms[margin].width;
 423                 symbolMargin = symbolMargin || (ms[margin].style != SC_MARGIN_NUMBER);
 424                 if (ms[margin].width > 0)
 425                         maskInLine &= ~ms[margin].mask;
 426         }
 427 }
 428
 429 void ViewStyle::AllocStyles(size_t sizeNew) {
 430         Style *stylesNew = new Style[sizeNew];
 431         size_t i=0;
 432         for (; i<stylesSize; i++) {
 433                 stylesNew[i] = styles[i];
 434                 stylesNew[i].fontName = styles[i].fontName;
 435         }
 436         if (stylesSize > STYLE_DEFAULT) {
 437                 for (; i<sizeNew; i++) {
 438                         if (i != STYLE_DEFAULT) {
 439                                 stylesNew[i].ClearTo(styles[STYLE_DEFAULT]);
 440                         }
 441                 }
 442         }
 443         delete []styles;
 444         styles = stylesNew;
 445         stylesSize = sizeNew;
 446 }
 447
 448 void ViewStyle::EnsureStyle(size_t index) {
 449         if (index >= stylesSize) {
 450                 size_t sizeNew = stylesSize * 2;
 451                 while (sizeNew <= index)
 452                         sizeNew *= 2;
 453                 AllocStyles(sizeNew);
 454         }
 455 }
 456
 457 void ViewStyle::ResetDefaultStyle() {
 458         styles[STYLE_DEFAULT].Clear(ColourDesired(0,0,0),
 459                 ColourDesired(0xff,0xff,0xff),
 460                 Platform::DefaultFontSize(), fontNames.Save(Platform::DefaultFont()),
 461                 SC_CHARSET_DEFAULT,
 462                 false, false, false, false, Style::caseMixed, true, true, false);
 463 }
 464
 465 void ViewStyle::ClearStyles() {
 466         // Reset all styles to be like the default style
 467         for (unsigned int i=0; i<stylesSize; i++) {
 468                 if (i != STYLE_DEFAULT) {
 469                         styles[i].ClearTo(styles[STYLE_DEFAULT]);
 470                 }
 471         }
 472         styles[STYLE_LINENUMBER].back.desired = Platform::Chrome();
 473
 474         // Set call tip fore/back to match the values previously set for call tips
 475         styles[STYLE_CALLTIP].back.desired = ColourDesired(0xff, 0xff, 0xff);
 476         styles[STYLE_CALLTIP].fore.desired = ColourDesired(0x80, 0x80, 0x80);
 477 }
 478
 479 void ViewStyle::SetStyleFontName(int styleIndex, const char *name) {
 480         styles[styleIndex].fontName = fontNames.Save(name);
 481 }
 482
 483 bool ViewStyle::ProtectionActive() const {
 484         return someStylesProtected;
 485 }
 486
 487 bool ViewStyle::ValidStyle(size_t styleIndex) const {
 488         return styleIndex < stylesSize;
 489 }
 490