Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 328 lines (294 sloc) 11.061 kB
f858c4b @djs Import Scintilla 2.11
authored
1 // Scintilla source code edit control
2 /** @file CallTip.cxx
3 ** Code for displaying call tips.
4 **/
5 // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org>
6 // The License.txt file describes the conditions under which this software may be distributed.
7
8 #include <stdlib.h>
9 #include <string.h>
10
11 #include "Platform.h"
12
13 #include "Scintilla.h"
14 #include "CallTip.h"
15 #include <stdio.h>
16
17 #ifdef SCI_NAMESPACE
18 using namespace Scintilla;
19 #endif
20
21 static const int insetX = 5; // text inset in x from calltip border
22 static const int widthArrow = 14;
23
24 CallTip::CallTip() {
25 wCallTip = 0;
26 inCallTipMode = false;
27 posStartCallTip = 0;
28 val = 0;
29 rectUp = PRectangle(0,0,0,0);
30 rectDown = PRectangle(0,0,0,0);
31 lineHeight = 1;
32 startHighlight = 0;
33 endHighlight = 0;
34 tabSize = 0;
35 useStyleCallTip = false; // for backwards compatibility
36
37 #ifdef __APPLE__
38 // proper apple colours for the default
39 colourBG.desired = ColourDesired(0xff, 0xff, 0xc6);
40 colourUnSel.desired = ColourDesired(0, 0, 0);
41 #else
42 colourBG.desired = ColourDesired(0xff, 0xff, 0xff);
43 colourUnSel.desired = ColourDesired(0x80, 0x80, 0x80);
44 #endif
45 colourSel.desired = ColourDesired(0, 0, 0x80);
46 colourShade.desired = ColourDesired(0, 0, 0);
47 colourLight.desired = ColourDesired(0xc0, 0xc0, 0xc0);
48 }
49
50 CallTip::~CallTip() {
51 font.Release();
52 wCallTip.Destroy();
53 delete []val;
54 val = 0;
55 }
56
57 void CallTip::RefreshColourPalette(Palette &pal, bool want) {
58 pal.WantFind(colourBG, want);
59 pal.WantFind(colourUnSel, want);
60 pal.WantFind(colourSel, want);
61 pal.WantFind(colourShade, want);
62 pal.WantFind(colourLight, want);
63 }
64
65 // Although this test includes 0, we should never see a \0 character.
66 static bool IsArrowCharacter(char ch) {
67 return (ch == 0) || (ch == '\001') || (ch == '\002');
68 }
69
70 // We ignore tabs unless a tab width has been set.
71 bool CallTip::IsTabCharacter(char ch) const {
72 return (tabSize > 0) && (ch == '\t');
73 }
74
75 int CallTip::NextTabPos(int x) {
76 if (tabSize > 0) { // paranoia... not called unless this is true
77 x -= insetX; // position relative to text
78 x = (x + tabSize) / tabSize; // tab "number"
79 return tabSize*x + insetX; // position of next tab
80 } else {
81 return x + 1; // arbitrary
82 }
83 }
84
85 // Draw a section of the call tip that does not include \n in one colour.
86 // The text may include up to numEnds tabs or arrow characters.
87 void CallTip::DrawChunk(Surface *surface, int &x, const char *s,
88 int posStart, int posEnd, int ytext, PRectangle rcClient,
89 bool highlight, bool draw) {
90 s += posStart;
91 int len = posEnd - posStart;
92
93 // Divide the text into sections that are all text, or that are
94 // single arrows or single tab characters (if tabSize > 0).
95 int maxEnd = 0;
96 const int numEnds = 10;
97 int ends[numEnds + 2];
98 for (int i=0; i<len; i++) {
99 if ((maxEnd < numEnds) &&
100 (IsArrowCharacter(s[i]) || IsTabCharacter(s[i])) ) {
101 if (i > 0)
102 ends[maxEnd++] = i;
103 ends[maxEnd++] = i+1;
104 }
105 }
106 ends[maxEnd++] = len;
107 int startSeg = 0;
108 int xEnd;
109 for (int seg = 0; seg<maxEnd; seg++) {
110 int endSeg = ends[seg];
111 if (endSeg > startSeg) {
112 if (IsArrowCharacter(s[startSeg])) {
113 bool upArrow = s[startSeg] == '\001';
114 rcClient.left = x;
115 rcClient.right = rcClient.left + widthArrow;
116 if (draw) {
117 const int halfWidth = widthArrow / 2 - 3;
118 const int centreX = rcClient.left + widthArrow / 2 - 1;
119 const int centreY = (rcClient.top + rcClient.bottom) / 2;
120 surface->FillRectangle(rcClient, colourBG.allocated);
121 PRectangle rcClientInner(rcClient.left + 1, rcClient.top + 1,
122 rcClient.right - 2, rcClient.bottom - 1);
123 surface->FillRectangle(rcClientInner, colourUnSel.allocated);
124
125 if (upArrow) { // Up arrow
126 Point pts[] = {
127 Point(centreX - halfWidth, centreY + halfWidth / 2),
128 Point(centreX + halfWidth, centreY + halfWidth / 2),
129 Point(centreX, centreY - halfWidth + halfWidth / 2),
130 };
131 surface->Polygon(pts, sizeof(pts) / sizeof(pts[0]),
132 colourBG.allocated, colourBG.allocated);
133 } else { // Down arrow
134 Point pts[] = {
135 Point(centreX - halfWidth, centreY - halfWidth / 2),
136 Point(centreX + halfWidth, centreY - halfWidth / 2),
137 Point(centreX, centreY + halfWidth - halfWidth / 2),
138 };
139 surface->Polygon(pts, sizeof(pts) / sizeof(pts[0]),
140 colourBG.allocated, colourBG.allocated);
141 }
142 }
143 xEnd = rcClient.right;
144 offsetMain = xEnd;
145 if (upArrow) {
146 rectUp = rcClient;
147 } else {
148 rectDown = rcClient;
149 }
150 } else if (IsTabCharacter(s[startSeg])) {
151 xEnd = NextTabPos(x);
152 } else {
153 xEnd = x + surface->WidthText(font, s + startSeg, endSeg - startSeg);
154 if (draw) {
155 rcClient.left = x;
156 rcClient.right = xEnd;
157 surface->DrawTextTransparent(rcClient, font, ytext,
158 s+startSeg, endSeg - startSeg,
159 highlight ? colourSel.allocated : colourUnSel.allocated);
160 }
161 }
162 x = xEnd;
163 startSeg = endSeg;
164 }
165 }
166 }
167
168 int CallTip::PaintContents(Surface *surfaceWindow, bool draw) {
169 PRectangle rcClientPos = wCallTip.GetClientPosition();
170 PRectangle rcClientSize(0, 0, rcClientPos.right - rcClientPos.left,
171 rcClientPos.bottom - rcClientPos.top);
172 PRectangle rcClient(1, 1, rcClientSize.right - 1, rcClientSize.bottom - 1);
173
174 // To make a nice small call tip window, it is only sized to fit most normal characters without accents
175 int ascent = surfaceWindow->Ascent(font) - surfaceWindow->InternalLeading(font);
176
177 // For each line...
178 // Draw the definition in three parts: before highlight, highlighted, after highlight
179 int ytext = rcClient.top + ascent + 1;
180 rcClient.bottom = ytext + surfaceWindow->Descent(font) + 1;
181 char *chunkVal = val;
182 bool moreChunks = true;
183 int maxWidth = 0;
184
185 while (moreChunks) {
186 char *chunkEnd = strchr(chunkVal, '\n');
187 if (chunkEnd == NULL) {
188 chunkEnd = chunkVal + strlen(chunkVal);
189 moreChunks = false;
190 }
191 int chunkOffset = chunkVal - val;
192 int chunkLength = chunkEnd - chunkVal;
193 int chunkEndOffset = chunkOffset + chunkLength;
194 int thisStartHighlight = Platform::Maximum(startHighlight, chunkOffset);
195 thisStartHighlight = Platform::Minimum(thisStartHighlight, chunkEndOffset);
196 thisStartHighlight -= chunkOffset;
197 int thisEndHighlight = Platform::Maximum(endHighlight, chunkOffset);
198 thisEndHighlight = Platform::Minimum(thisEndHighlight, chunkEndOffset);
199 thisEndHighlight -= chunkOffset;
200 rcClient.top = ytext - ascent - 1;
201
202 int x = insetX; // start each line at this inset
203
204 DrawChunk(surfaceWindow, x, chunkVal, 0, thisStartHighlight,
205 ytext, rcClient, false, draw);
206 DrawChunk(surfaceWindow, x, chunkVal, thisStartHighlight, thisEndHighlight,
207 ytext, rcClient, true, draw);
208 DrawChunk(surfaceWindow, x, chunkVal, thisEndHighlight, chunkLength,
209 ytext, rcClient, false, draw);
210
211 chunkVal = chunkEnd + 1;
212 ytext += lineHeight;
213 rcClient.bottom += lineHeight;
214 maxWidth = Platform::Maximum(maxWidth, x);
215 }
216 return maxWidth;
217 }
218
219 void CallTip::PaintCT(Surface *surfaceWindow) {
220 if (!val)
221 return;
222 PRectangle rcClientPos = wCallTip.GetClientPosition();
223 PRectangle rcClientSize(0, 0, rcClientPos.right - rcClientPos.left,
224 rcClientPos.bottom - rcClientPos.top);
225 PRectangle rcClient(1, 1, rcClientSize.right - 1, rcClientSize.bottom - 1);
226
227 surfaceWindow->FillRectangle(rcClient, colourBG.allocated);
228
229 offsetMain = insetX; // initial alignment assuming no arrows
230 PaintContents(surfaceWindow, true);
231
232 #ifndef __APPLE__
233 // OSX doesn't put borders on "help tags"
234 // Draw a raised border around the edges of the window
235 surfaceWindow->MoveTo(0, rcClientSize.bottom - 1);
236 surfaceWindow->PenColour(colourShade.allocated);
237 surfaceWindow->LineTo(rcClientSize.right - 1, rcClientSize.bottom - 1);
238 surfaceWindow->LineTo(rcClientSize.right - 1, 0);
239 surfaceWindow->PenColour(colourLight.allocated);
240 surfaceWindow->LineTo(0, 0);
241 surfaceWindow->LineTo(0, rcClientSize.bottom - 1);
242 #endif
243 }
244
245 void CallTip::MouseClick(Point pt) {
246 clickPlace = 0;
247 if (rectUp.Contains(pt))
248 clickPlace = 1;
249 if (rectDown.Contains(pt))
250 clickPlace = 2;
251 }
252
253 PRectangle CallTip::CallTipStart(int pos, Point pt, const char *defn,
254 const char *faceName, int size,
255 int codePage_, int characterSet, Window &wParent) {
256 clickPlace = 0;
257 delete []val;
258 val = 0;
259 val = new char[strlen(defn) + 1];
260 strcpy(val, defn);
261 codePage = codePage_;
262 Surface *surfaceMeasure = Surface::Allocate();
263 if (!surfaceMeasure)
264 return PRectangle();
265 surfaceMeasure->Init(wParent.GetID());
266 surfaceMeasure->SetUnicodeMode(SC_CP_UTF8 == codePage);
267 surfaceMeasure->SetDBCSMode(codePage);
268 startHighlight = 0;
269 endHighlight = 0;
270 inCallTipMode = true;
271 posStartCallTip = pos;
272 int deviceHeight = surfaceMeasure->DeviceHeightFont(size);
273 font.Create(faceName, characterSet, deviceHeight, false, false);
274 // Look for multiple lines in the text
275 // Only support \n here - simply means container must avoid \r!
276 int numLines = 1;
277 const char *newline;
278 const char *look = val;
279 rectUp = PRectangle(0,0,0,0);
280 rectDown = PRectangle(0,0,0,0);
281 offsetMain = insetX; // changed to right edge of any arrows
282 int width = PaintContents(surfaceMeasure, false) + insetX;
283 while ((newline = strchr(look, '\n')) != NULL) {
284 look = newline + 1;
285 numLines++;
286 }
287 lineHeight = surfaceMeasure->Height(font);
288
289 // Extra line for border and an empty line at top and bottom. The returned
290 // rectangle is aligned to the right edge of the last arrow encountered in
291 // the tip text, else to the tip text left edge.
292 int height = lineHeight * numLines - surfaceMeasure->InternalLeading(font) + 2 + 2;
293 delete surfaceMeasure;
294 return PRectangle(pt.x - offsetMain, pt.y + 1, pt.x + width - offsetMain, pt.y + 1 + height);
295 }
296
297 void CallTip::CallTipCancel() {
298 inCallTipMode = false;
299 if (wCallTip.Created()) {
300 wCallTip.Destroy();
301 }
302 }
303
304 void CallTip::SetHighlight(int start, int end) {
305 // Avoid flashing by checking something has really changed
306 if ((start != startHighlight) || (end != endHighlight)) {
307 startHighlight = start;
308 endHighlight = end;
309 if (wCallTip.Created()) {
310 wCallTip.InvalidateAll();
311 }
312 }
313 }
314
315 // Set the tab size (sizes > 0 enable the use of tabs). This also enables the
316 // use of the STYLE_CALLTIP.
317 void CallTip::SetTabSize(int tabSz) {
318 tabSize = tabSz;
319 useStyleCallTip = true;
320 }
321
322 // It might be better to have two access functions for this and to use
323 // them for all settings of colours.
324 void CallTip::SetForeBack(const ColourPair &fore, const ColourPair &back) {
325 colourBG = back;
326 colourUnSel = fore;
327 }
Something went wrong with that request. Please try again.