]> git.saurik.com Git - wxWidgets.git/blame - src/stc/scintilla/src/LexFortran.cxx
better docs for Get/SetLabel methods
[wxWidgets.git] / src / stc / scintilla / src / LexFortran.cxx
CommitLineData
9e730a78
RD
1// Scintilla source code edit control
2/** @file LexFortran.cxx
3 ** Lexer for Fortran.
8e54aaed 4 ** Writen by Chuan-jian Shen, Last changed Sep. 2003
9e730a78
RD
5 **/
6// Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org>
7// The License.txt file describes the conditions under which this software may be distributed.
8e54aaed 8/***************************************/
9e730a78
RD
9#include <stdlib.h>
10#include <string.h>
11#include <ctype.h>
12#include <stdio.h>
13#include <stdarg.h>
8e54aaed 14/***************************************/
9e730a78 15#include "Platform.h"
9e730a78
RD
16#include "PropSet.h"
17#include "Accessor.h"
18#include "StyleContext.h"
19#include "KeyWords.h"
20#include "Scintilla.h"
21#include "SciLexer.h"
7e0c58e9
RD
22
23#ifdef SCI_NAMESPACE
24using namespace Scintilla;
25#endif
26
8e54aaed 27/***********************************************/
9e730a78
RD
28static inline bool IsAWordChar(const int ch) {
29 return (ch < 0x80) && (isalnum(ch) || ch == '_' || ch == '%');
30}
8e54aaed 31/**********************************************/
9e730a78
RD
32static inline bool IsAWordStart(const int ch) {
33 return (ch < 0x80) && (isalnum(ch));
34}
8e54aaed 35/***************************************/
9e730a78
RD
36inline bool IsABlank(unsigned int ch) {
37 return (ch == ' ') || (ch == 0x09) || (ch == 0x0b) ;
38}
8e54aaed
RD
39/***************************************/
40inline bool IsALineEnd(char ch) {
41 return ((ch == '\n') || (ch == '\r')) ;
42}
43/***************************************/
44unsigned int GetContinuedPos(unsigned int pos, Accessor &styler) {
45 while (!IsALineEnd(styler.SafeGetCharAt(pos++))) continue;
46 if (styler.SafeGetCharAt(pos) == '\n') pos++;
47 while (IsABlank(styler.SafeGetCharAt(pos++))) continue;
48 char chCur = styler.SafeGetCharAt(pos);
49 if (chCur == '&') {
50 while (IsABlank(styler.SafeGetCharAt(++pos))) continue;
51 return pos;
52 } else {
53 return pos;
54 }
55}
56/***************************************/
57static void ColouriseFortranDoc(unsigned int startPos, int length, int initStyle,
58 WordList *keywordlists[], Accessor &styler, bool isFixFormat) {
9e730a78
RD
59 WordList &keywords = *keywordlists[0];
60 WordList &keywords2 = *keywordlists[1];
61 WordList &keywords3 = *keywordlists[2];
8e54aaed
RD
62 /***************************************/
63 int posLineStart = 0, numNonBlank = 0, prevState = 0;
9e730a78 64 int endPos = startPos + length;
8e54aaed 65 /***************************************/
9e730a78
RD
66 // backtrack to the nearest keyword
67 while ((startPos > 1) && (styler.StyleAt(startPos) != SCE_F_WORD)) {
68 startPos--;
69 }
70 startPos = styler.LineStart(styler.GetLine(startPos));
71 initStyle = styler.StyleAt(startPos - 1);
72 StyleContext sc(startPos, endPos-startPos, initStyle, styler);
8e54aaed 73 /***************************************/
9e730a78 74 for (; sc.More(); sc.Forward()) {
8e54aaed 75 // remember the start position of the line
9e730a78
RD
76 if (sc.atLineStart) {
77 posLineStart = sc.currentPos;
8e54aaed 78 numNonBlank = 0;
9e730a78
RD
79 sc.SetState(SCE_F_DEFAULT);
80 }
8e54aaed
RD
81 if (!IsASpaceOrTab(sc.ch)) numNonBlank ++;
82 /***********************************************/
83 // Handle the fix format generically
84 int toLineStart = sc.currentPos - posLineStart;
85 if (isFixFormat && (toLineStart < 6 || toLineStart > 72)) {
86 if (toLineStart == 0 && (tolower(sc.ch) == 'c' || sc.ch == '*') || sc.ch == '!') {
87 sc.SetState(SCE_F_COMMENT);
88 while (!sc.atLineEnd && sc.More()) sc.Forward(); // Until line end
89 } else if (toLineStart > 72) {
90 sc.SetState(SCE_F_COMMENT);
91 while (!sc.atLineEnd && sc.More()) sc.Forward(); // Until line end
92 } else if (toLineStart < 5) {
93 if (IsADigit(sc.ch))
94 sc.SetState(SCE_F_LABEL);
95 else
96 sc.SetState(SCE_F_DEFAULT);
97 } else if (toLineStart == 5) {
98 if (!IsASpace(sc.ch) && sc.ch != '0') {
99 sc.SetState(SCE_F_CONTINUATION);
100 sc.ForwardSetState(prevState);
101 } else
102 sc.SetState(SCE_F_DEFAULT);
103 }
104 continue;
105 }
106 /***************************************/
9e730a78 107 // Handle line continuation generically.
8e54aaed 108 if (!isFixFormat && sc.ch == '&') {
9e730a78
RD
109 char chTemp = ' ';
110 int j = 1;
111 while (IsABlank(chTemp) && j<132) {
112 chTemp = static_cast<char>(sc.GetRelative(j));
8e54aaed 113 j++;
9e730a78
RD
114 }
115 if (chTemp == '!') {
116 sc.SetState(SCE_F_CONTINUATION);
117 if (sc.chNext == '!') sc.ForwardSetState(SCE_F_COMMENT);
118 } else if (chTemp == '\r' || chTemp == '\n') {
119 int currentState = sc.state;
120 sc.SetState(SCE_F_CONTINUATION);
8e54aaed
RD
121 sc.ForwardSetState(SCE_F_DEFAULT);
122 while (IsASpace(sc.ch) && sc.More()) sc.Forward();
123 if (sc.ch == '&') {
124 sc.SetState(SCE_F_CONTINUATION);
125 sc.Forward();
9e730a78 126 }
8e54aaed 127 sc.SetState(currentState);
9e730a78 128 }
9e730a78 129 }
8e54aaed 130 /***************************************/
9e730a78
RD
131 // Determine if the current state should terminate.
132 if (sc.state == SCE_F_OPERATOR) {
133 sc.SetState(SCE_F_DEFAULT);
134 } else if (sc.state == SCE_F_NUMBER) {
8e54aaed 135 if (!(IsAWordChar(sc.ch) || sc.ch=='\'' || sc.ch=='\"' || sc.ch=='.')) {
9e730a78
RD
136 sc.SetState(SCE_F_DEFAULT);
137 }
138 } else if (sc.state == SCE_F_IDENTIFIER) {
139 if (!IsAWordChar(sc.ch) || (sc.ch == '%')) {
140 char s[100];
141 sc.GetCurrentLowered(s, sizeof(s));
142 if (keywords.InList(s)) {
143 sc.ChangeState(SCE_F_WORD);
144 } else if (keywords2.InList(s)) {
145 sc.ChangeState(SCE_F_WORD2);
146 } else if (keywords3.InList(s)) {
147 sc.ChangeState(SCE_F_WORD3);
148 }
149 sc.SetState(SCE_F_DEFAULT);
150 }
8e54aaed 151 } else if (sc.state == SCE_F_COMMENT || sc.state == SCE_F_PREPROCESSOR) {
9e730a78
RD
152 if (sc.ch == '\r' || sc.ch == '\n') {
153 sc.SetState(SCE_F_DEFAULT);
154 }
155 } else if (sc.state == SCE_F_STRING1) {
156 prevState = sc.state;
157 if (sc.ch == '\'') {
158 if (sc.chNext == '\'') {
159 sc.Forward();
160 } else {
161 sc.ForwardSetState(SCE_F_DEFAULT);
162 prevState = SCE_F_DEFAULT;
163 }
164 } else if (sc.atLineEnd) {
8e54aaed
RD
165 sc.ChangeState(SCE_F_STRINGEOL);
166 sc.ForwardSetState(SCE_F_DEFAULT);
9e730a78
RD
167 }
168 } else if (sc.state == SCE_F_STRING2) {
169 prevState = sc.state;
170 if (sc.atLineEnd) {
8e54aaed
RD
171 sc.ChangeState(SCE_F_STRINGEOL);
172 sc.ForwardSetState(SCE_F_DEFAULT);
9e730a78
RD
173 } else if (sc.ch == '\"') {
174 if (sc.chNext == '\"') {
175 sc.Forward();
176 } else {
177 sc.ForwardSetState(SCE_F_DEFAULT);
178 prevState = SCE_F_DEFAULT;
179 }
180 }
181 } else if (sc.state == SCE_F_OPERATOR2) {
182 if (sc.ch == '.') {
183 sc.ForwardSetState(SCE_F_DEFAULT);
184 }
185 } else if (sc.state == SCE_F_CONTINUATION) {
186 sc.SetState(SCE_F_DEFAULT);
187 } else if (sc.state == SCE_F_LABEL) {
8e54aaed 188 if (!IsADigit(sc.ch)) {
9e730a78 189 sc.SetState(SCE_F_DEFAULT);
8e54aaed
RD
190 } else {
191 if (isFixFormat && sc.currentPos-posLineStart > 4)
192 sc.SetState(SCE_F_DEFAULT);
193 else if (numNonBlank > 5)
194 sc.SetState(SCE_F_DEFAULT);
9e730a78
RD
195 }
196 }
8e54aaed 197 /***************************************/
9e730a78
RD
198 // Determine if a new state should be entered.
199 if (sc.state == SCE_F_DEFAULT) {
8e54aaed
RD
200 if (sc.ch == '!') {
201 if (sc.chNext == '$') {
202 sc.SetState(SCE_F_PREPROCESSOR);
203 } else {
9e730a78 204 sc.SetState(SCE_F_COMMENT);
9e730a78 205 }
8e54aaed
RD
206 } else if ((!isFixFormat) && IsADigit(sc.ch) && numNonBlank == 1) {
207 sc.SetState(SCE_F_LABEL);
9e730a78
RD
208 } else if (IsADigit(sc.ch) || (sc.ch == '.' && IsADigit(sc.chNext))) {
209 sc.SetState(SCE_F_NUMBER);
8e54aaed
RD
210 } else if ((tolower(sc.ch) == 'b' || tolower(sc.ch) == 'o' ||
211 tolower(sc.ch) == 'z') && (sc.chNext == '\"' || sc.chNext == '\'')) {
212 sc.SetState(SCE_F_NUMBER);
213 sc.Forward();
9e730a78
RD
214 } else if (sc.ch == '.' && isalpha(sc.chNext)) {
215 sc.SetState(SCE_F_OPERATOR2);
216 } else if (IsAWordStart(sc.ch)) {
217 sc.SetState(SCE_F_IDENTIFIER);
9e730a78
RD
218 } else if (sc.ch == '\"') {
219 sc.SetState(SCE_F_STRING2);
220 } else if (sc.ch == '\'') {
221 sc.SetState(SCE_F_STRING1);
222 } else if (isoperator(static_cast<char>(sc.ch))) {
223 sc.SetState(SCE_F_OPERATOR);
224 }
225 }
226 }
227 sc.Complete();
228}
8e54aaed
RD
229/***************************************/
230// To determine the folding level depending on keywords
231static int classifyFoldPointFortran(const char* s, const char* prevWord, const char chNextNonBlank) {
9e730a78 232 int lev = 0;
9e730a78
RD
233 if ((strcmp(prevWord, "else") == 0 && strcmp(s, "if") == 0) || strcmp(s, "elseif") == 0)
234 return -1;
235 if (strcmp(s, "associate") == 0 || strcmp(s, "block") == 0
236 || strcmp(s, "blockdata") == 0 || strcmp(s, "select") == 0
237 || strcmp(s, "do") == 0 || strcmp(s, "enum") ==0
8e54aaed
RD
238 || strcmp(s, "function") == 0 || strcmp(s, "interface") == 0
239 || strcmp(s, "module") == 0 || strcmp(s, "program") == 0
240 || strcmp(s, "subroutine") == 0 || strcmp(s, "then") == 0
241 || (strcmp(s, "type") == 0 && chNextNonBlank != '(') ){
242 if (strcmp(prevWord, "end") == 0)
243 lev = 0;
244 else
245 lev = 1;
246 } else if (strcmp(s, "end") == 0 && chNextNonBlank != '='
247 || strcmp(s, "endassociate") == 0 || strcmp(s, "endblock") == 0
248 || strcmp(s, "endblockdata") == 0 || strcmp(s, "endselect") == 0
249 || strcmp(s, "enddo") == 0 || strcmp(s, "endenum") ==0
250 || strcmp(s, "endif") == 0 || strcmp(s, "endforall") == 0
251 || strcmp(s, "endfunction") == 0 || strcmp(s, "endinterface") == 0
252 || strcmp(s, "endmodule") == 0 || strcmp(s, "endprogram") == 0
253 || strcmp(s, "endsubroutine") == 0 || strcmp(s, "endtype") == 0
254 || strcmp(s, "endwhere") == 0
255 || strcmp(s, "procedure") == 0 ) { // Take care of the module procedure statement
256 lev = -1;
257 } else if (strcmp(prevWord, "end") == 0 && strcmp(s, "if") == 0){ // end if
258 lev = 0;
9e730a78
RD
259 }
260 return lev;
261}
8e54aaed
RD
262// Folding the code
263static void FoldFortranDoc(unsigned int startPos, int length, int initStyle,
264 Accessor &styler, bool isFixFormat) {
265 //
266 // bool foldComment = styler.GetPropertyInt("fold.comment") != 0;
9e730a78 267 // Do not know how to fold the comment at the moment.
8e54aaed 268 //
9e730a78
RD
269 bool foldCompact = styler.GetPropertyInt("fold.compact", 1) != 0;
270 unsigned int endPos = startPos + length;
271 int visibleChars = 0;
272 int lineCurrent = styler.GetLine(startPos);
273 int levelPrev = styler.LevelAt(lineCurrent) & SC_FOLDLEVELNUMBERMASK;
274 int levelCurrent = levelPrev;
275 char chNext = styler[startPos];
8e54aaed 276 char chNextNonBlank;
9e730a78
RD
277 int styleNext = styler.StyleAt(startPos);
278 int style = initStyle;
8e54aaed 279 /***************************************/
9e730a78 280 int lastStart = 0;
1e9bafca
RD
281 char prevWord[32] = "";
282 char Label[6] = "";
8e54aaed 283 // Variables for do label folding.
1e9bafca
RD
284 static int doLabels[100];
285 static int posLabel=-1;
8e54aaed 286 /***************************************/
9e730a78
RD
287 for (unsigned int i = startPos; i < endPos; i++) {
288 char ch = chNext;
289 chNext = styler.SafeGetCharAt(i + 1);
8e54aaed
RD
290 chNextNonBlank = chNext;
291 unsigned int j=i+1;
292 while(IsABlank(chNextNonBlank) && j<endPos) {
293 j ++ ;
294 chNextNonBlank = styler.SafeGetCharAt(j);
295 }
9e730a78
RD
296 int stylePrev = style;
297 style = styleNext;
298 styleNext = styler.StyleAt(i + 1);
299 bool atEOL = (ch == '\r' && chNext != '\n') || (ch == '\n');
8e54aaed
RD
300 //
301 if (stylePrev == SCE_F_DEFAULT && (style == SCE_F_WORD || style == SCE_F_LABEL)) {
302 // Store last word and label start point.
9e730a78
RD
303 lastStart = i;
304 }
8e54aaed 305 /***************************************/
9e730a78
RD
306 if (style == SCE_F_WORD) {
307 if(iswordchar(ch) && !iswordchar(chNext)) {
308 char s[32];
8e54aaed
RD
309 unsigned int k;
310 for(k=0; (k<31 ) && (k<i-lastStart+1 ); k++) {
311 s[k] = static_cast<char>(tolower(styler[lastStart+k]));
312 }
313 s[k] = '\0';
314 // Handle the forall and where statement and structure.
315 if (strcmp(s, "forall") == 0 || strcmp(s, "where") == 0) {
316 if (strcmp(prevWord, "end") != 0) {
317 j = i + 1;
318 char chBrace = '(', chSeek = ')', ch1 = styler.SafeGetCharAt(j);
319 // Find the position of the first (
320 while (ch1 != chBrace && j<endPos) {
321 j++;
322 ch1 = styler.SafeGetCharAt(j);
323 }
324 char styBrace = styler.StyleAt(j);
325 int depth = 1;
326 char chAtPos;
327 char styAtPos;
328 while (j<endPos) {
329 j++;
330 chAtPos = styler.SafeGetCharAt(j);
331 styAtPos = styler.StyleAt(j);
332 if (styAtPos == styBrace) {
333 if (chAtPos == chBrace) depth++;
334 if (chAtPos == chSeek) depth--;
335 if (depth == 0) break;
336 }
337 }
338 while (j<endPos) {
339 j++;
340 chAtPos = styler.SafeGetCharAt(j);
341 styAtPos = styler.StyleAt(j);
342 if (styAtPos == SCE_F_COMMENT || IsABlank(chAtPos)) continue;
343 if (isFixFormat) {
344 if (!IsALineEnd(chAtPos)) {
345 break;
346 } else {
347 if (lineCurrent < styler.GetLine(styler.Length()-1)) {
348 j = styler.LineStart(lineCurrent+1);
349 if (styler.StyleAt(j+5) == SCE_F_CONTINUATION) {
350 j += 5;
351 continue;
352 } else {
353 levelCurrent++;
354 break;
355 }
356 }
357 }
358 } else {
359 if (chAtPos == '&' && styler.StyleAt(j) == SCE_F_CONTINUATION) {
360 j = GetContinuedPos(j+1, styler);
361 continue;
362 } else if (IsALineEnd(chAtPos)) {
363 levelCurrent ++;
364 break;
365 } else {
366 break;
367 }
368 }
369 }
370 }
371 } else {
372 levelCurrent += classifyFoldPointFortran(s, prevWord, chNextNonBlank);
373 // Store the do Labels into array
374 if (strcmp(s, "do") == 0 && IsADigit(chNextNonBlank)) {
375 unsigned int k = 0;
376 for (i=j; (i<j+5 && i<endPos); i++) {
377 ch = styler.SafeGetCharAt(i);
378 if (IsADigit(ch))
379 Label[k++] = ch;
380 else
381 break;
382 }
383 Label[k] = '\0';
384 posLabel ++;
385 doLabels[posLabel] = atoi(Label);
386 }
9e730a78 387 }
9e730a78
RD
388 strcpy(prevWord, s);
389 }
8e54aaed
RD
390 } else if (style == SCE_F_LABEL) {
391 if(IsADigit(ch) && !IsADigit(chNext)) {
392 for(j = 0; ( j < 5 ) && ( j < i-lastStart+1 ); j++) {
393 ch = styler.SafeGetCharAt(lastStart + j);
394 if (IsADigit(ch) && styler.StyleAt(lastStart+j) == SCE_F_LABEL)
395 Label[j] = ch;
396 else
397 break;
398 }
399 Label[j] = '\0';
400 while (doLabels[posLabel] == atoi(Label) && posLabel > -1) {
401 levelCurrent--;
402 posLabel--;
403 }
404 }
9e730a78
RD
405 }
406 if (atEOL) {
407 int lev = levelPrev;
408 if (visibleChars == 0 && foldCompact)
409 lev |= SC_FOLDLEVELWHITEFLAG;
410 if ((levelCurrent > levelPrev) && (visibleChars > 0))
411 lev |= SC_FOLDLEVELHEADERFLAG;
412 if (lev != styler.LevelAt(lineCurrent)) {
413 styler.SetLevel(lineCurrent, lev);
414 }
415 lineCurrent++;
416 levelPrev = levelCurrent;
417 visibleChars = 0;
418 strcpy(prevWord, "");
419 }
8e54aaed
RD
420 /***************************************/
421 if (!isspacechar(ch)) visibleChars++;
9e730a78 422 }
8e54aaed 423 /***************************************/
9e730a78
RD
424 // Fill in the real level of the next line, keeping the current flags as they will be filled in later
425 int flagsNext = styler.LevelAt(lineCurrent) & ~SC_FOLDLEVELNUMBERMASK;
426 styler.SetLevel(lineCurrent, levelPrev | flagsNext);
427}
8e54aaed 428/***************************************/
9e730a78
RD
429static const char * const FortranWordLists[] = {
430 "Primary keywords and identifiers",
431 "Intrinsic functions",
432 "Extended and user defined functions",
433 0,
434};
8e54aaed 435/***************************************/
9e730a78
RD
436static void ColouriseFortranDocFreeFormat(unsigned int startPos, int length, int initStyle, WordList *keywordlists[],
437 Accessor &styler) {
438 ColouriseFortranDoc(startPos, length, initStyle, keywordlists, styler, false);
439}
8e54aaed 440/***************************************/
9e730a78
RD
441static void ColouriseFortranDocFixFormat(unsigned int startPos, int length, int initStyle, WordList *keywordlists[],
442 Accessor &styler) {
443 ColouriseFortranDoc(startPos, length, initStyle, keywordlists, styler, true);
444}
8e54aaed
RD
445/***************************************/
446static void FoldFortranDocFreeFormat(unsigned int startPos, int length, int initStyle,
447 WordList *[], Accessor &styler) {
448 FoldFortranDoc(startPos, length, initStyle,styler, false);
449}
450/***************************************/
451static void FoldFortranDocFixFormat(unsigned int startPos, int length, int initStyle,
452 WordList *[], Accessor &styler) {
453 FoldFortranDoc(startPos, length, initStyle,styler, true);
454}
455/***************************************/
456LexerModule lmFortran(SCLEX_FORTRAN, ColouriseFortranDocFreeFormat, "fortran", FoldFortranDocFreeFormat, FortranWordLists);
457LexerModule lmF77(SCLEX_F77, ColouriseFortranDocFixFormat, "f77", FoldFortranDocFixFormat, FortranWordLists);