/pnwtl/third_party/scintilla/lexers/LexVerilog.cxx

https://code.google.com/p/pnotepad/ · C++ · 334 lines · 289 code · 22 blank · 23 comment · 204 complexity · c46e5d6806ca81c07181edf83c760209 MD5 · raw file 

    

  1. // Scintilla source code edit control

    2. 

  2. /** @file LexVerilog.cxx

    3. 

  3.  ** Lexer for Verilog.

    4. 

  4.  ** Written by Avi Yegudin, based on C++ lexer by Neil Hodgson

    5. 

  5.  **/

    6. 

  6. // Copyright 1998-2002 by Neil Hodgson <neilh@scintilla.org>

    7. 

  7. // The License.txt file describes the conditions under which this software may be distributed.

    8. 

  8. 

    9. 

  9. #include <stdlib.h>

    10. 

  10. #include <string.h>

    11. 

  11. #include <stdio.h>

    12. 

  12. #include <stdarg.h>

    13. 

  13. #include <assert.h>

    14. 

  14. #include <ctype.h>

    15. 

  15. 

    16. 

  16. #include "ILexer.h"

    17. 

  17. #include "Scintilla.h"

    18. 

  18. #include "SciLexer.h"

    19. 

  19. 

    20. 

  20. #include "PropSetSimple.h"

    21. 

  21. #include "WordList.h"

    22. 

  22. #include "LexAccessor.h"

    23. 

  23. #include "Accessor.h"

    24. 

  24. #include "StyleContext.h"

    25. 

  25. #include "CharacterSet.h"

    26. 

  26. #include "LexerModule.h"

    27. 

  27. 

    28. 

  28. #ifdef SCI_NAMESPACE

    29. 

  29. using namespace Scintilla;

    30. 

  30. #endif

    31. 

  31. 

    32. 

  32. static inline bool IsAWordChar(const int ch) {

    33. 

  33. 	return (ch < 0x80) && (isalnum(ch) || ch == '.' || ch == '_' || ch == '\'');

    34. 

  34. }

    35. 

  35. 

    36. 

  36. static inline bool IsAWordStart(const int ch) {

    37. 

  37. 	return (ch < 0x80) && (isalnum(ch) || ch == '_' || ch == '$');

    38. 

  38. }

    39. 

  39. 

    40. 

  40. static void ColouriseVerilogDoc(unsigned int startPos, int length, int initStyle, WordList *keywordlists[],

    41. 

  41.                             Accessor &styler) {

    42. 

  42. 

    43. 

  43. 	WordList &keywords = *keywordlists[0];

    44. 

  44. 	WordList &keywords2 = *keywordlists[1];

    45. 

  45. 	WordList &keywords3 = *keywordlists[2];

    46. 

  46. 	WordList &keywords4 = *keywordlists[3];

    47. 

  47. 

    48. 

  48. 	// Do not leak onto next line

    49. 

  49. 	if (initStyle == SCE_V_STRINGEOL)

    50. 

  50. 		initStyle = SCE_V_DEFAULT;

    51. 

  51. 

    52. 

  52. 	StyleContext sc(startPos, length, initStyle, styler);

    53. 

  53. 

    54. 

  54. 	for (; sc.More(); sc.Forward()) {

    55. 

  55. 

    56. 

  56. 		if (sc.atLineStart && (sc.state == SCE_V_STRING)) {

    57. 

  57. 			// Prevent SCE_V_STRINGEOL from leaking back to previous line

    58. 

  58. 			sc.SetState(SCE_V_STRING);

    59. 

  59. 		}

    60. 

  60. 

    61. 

  61. 		// Handle line continuation generically.

    62. 

  62. 		if (sc.ch == '\\') {

    63. 

  63. 			if (sc.chNext == '\n' || sc.chNext == '\r') {

    64. 

  64. 				sc.Forward();

    65. 

  65. 				if (sc.ch == '\r' && sc.chNext == '\n') {

    66. 

  66. 					sc.Forward();

    67. 

  67. 				}

    68. 

  68. 				continue;

    69. 

  69. 			}

    70. 

  70. 		}

    71. 

  71. 

    72. 

  72. 		// Determine if the current state should terminate.

    73. 

  73. 		if (sc.state == SCE_V_OPERATOR) {

    74. 

  74. 			sc.SetState(SCE_V_DEFAULT);

    75. 

  75. 		} else if (sc.state == SCE_V_NUMBER) {

    76. 

  76. 			if (!IsAWordChar(sc.ch)) {

    77. 

  77. 				sc.SetState(SCE_V_DEFAULT);

    78. 

  78. 			}

    79. 

  79. 		} else if (sc.state == SCE_V_IDENTIFIER) {

    80. 

  80. 			if (!IsAWordChar(sc.ch) || (sc.ch == '.')) {

    81. 

  81. 				char s[100];

    82. 

  82.                                 sc.GetCurrent(s, sizeof(s));

    83. 

  83. 				if (keywords.InList(s)) {

    84. 

  84. 					sc.ChangeState(SCE_V_WORD);

    85. 

  85. 				} else if (keywords2.InList(s)) {

    86. 

  86. 					sc.ChangeState(SCE_V_WORD2);

    87. 

  87. 				} else if (keywords3.InList(s)) {

    88. 

  88. 					sc.ChangeState(SCE_V_WORD3);

    89. 

  89.                                 } else if (keywords4.InList(s)) {

    90. 

  90. 					sc.ChangeState(SCE_V_USER);

    91. 

  91. 				}

    92. 

  92. 				sc.SetState(SCE_V_DEFAULT);

    93. 

  93. 			}

    94. 

  94. 		} else if (sc.state == SCE_V_PREPROCESSOR) {

    95. 

  95.                         if (!IsAWordChar(sc.ch)) {

    96. 

  96.                                 sc.SetState(SCE_V_DEFAULT);

    97. 

  97.                         }

    98. 

  98. 		} else if (sc.state == SCE_V_COMMENT) {

    99. 

  99. 			if (sc.Match('*', '/')) {

    100. 

  100. 				sc.Forward();

    101. 

  101. 				sc.ForwardSetState(SCE_V_DEFAULT);

    102. 

  102. 			}

    103. 

  103. 		} else if (sc.state == SCE_V_COMMENTLINE || sc.state == SCE_V_COMMENTLINEBANG) {

    104. 

  104. 			if (sc.atLineStart) {

    105. 

  105. 				sc.SetState(SCE_V_DEFAULT);

    106. 

  106. 			}

    107. 

  107.                 } else if (sc.state == SCE_V_STRING) {

    108. 

  108. 			if (sc.ch == '\\') {

    109. 

  109. 				if (sc.chNext == '\"' || sc.chNext == '\'' || sc.chNext == '\\') {

    110. 

  110. 					sc.Forward();

    111. 

  111. 				}

    112. 

  112. 			} else if (sc.ch == '\"') {

    113. 

  113. 				sc.ForwardSetState(SCE_V_DEFAULT);

    114. 

  114. 			} else if (sc.atLineEnd) {

    115. 

  115. 				sc.ChangeState(SCE_V_STRINGEOL);

    116. 

  116. 				sc.ForwardSetState(SCE_V_DEFAULT);

    117. 

  117. 			}

    118. 

  118. 		}

    119. 

  119. 

    120. 

  120. 		// Determine if a new state should be entered.

    121. 

  121. 		if (sc.state == SCE_V_DEFAULT) {

    122. 

  122. 			if (IsADigit(sc.ch) || (sc.ch == '\'') || (sc.ch == '.' && IsADigit(sc.chNext))) {

    123. 

  123. 				sc.SetState(SCE_V_NUMBER);

    124. 

  124. 			} else if (IsAWordStart(sc.ch)) {

    125. 

  125. 				sc.SetState(SCE_V_IDENTIFIER);

    126. 

  126. 			} else if (sc.Match('/', '*')) {

    127. 

  127.                                 sc.SetState(SCE_V_COMMENT);

    128. 

  128. 				sc.Forward();	// Eat the * so it isn't used for the end of the comment

    129. 

  129. 			} else if (sc.Match('/', '/')) {

    130. 

  130. 				if (sc.Match("//!"))	// Nice to have a different comment style

    131. 

  131. 					sc.SetState(SCE_V_COMMENTLINEBANG);

    132. 

  132. 				else

    133. 

  133. 					sc.SetState(SCE_V_COMMENTLINE);

    134. 

  134. 			} else if (sc.ch == '\"') {

    135. 

  135. 				sc.SetState(SCE_V_STRING);

    136. 

  136. 			} else if (sc.ch == '`') {

    137. 

  137. 				sc.SetState(SCE_V_PREPROCESSOR);

    138. 

  138. 				// Skip whitespace between ` and preprocessor word

    139. 

  139. 				do {

    140. 

  140. 					sc.Forward();

    141. 

  141. 				} while ((sc.ch == ' ' || sc.ch == '\t') && sc.More());

    142. 

  142. 				if (sc.atLineEnd) {

    143. 

  143. 					sc.SetState(SCE_V_DEFAULT);

    144. 

  144. 				}

    145. 

  145. 			} else if (isoperator(static_cast<char>(sc.ch)) || sc.ch == '@' || sc.ch == '#') {

    146. 

  146. 				sc.SetState(SCE_V_OPERATOR);

    147. 

  147. 			}

    148. 

  148. 		}

    149. 

  149. 	}

    150. 

  150. 	sc.Complete();

    151. 

  151. }

    152. 

  152. 

    153. 

  153. static bool IsStreamCommentStyle(int style) {

    154. 

  154. 	return style == SCE_V_COMMENT;

    155. 

  155. }

    156. 

  156. 

    157. 

  157. static bool IsCommentLine(int line, Accessor &styler) {

    158. 

  158. 	int pos = styler.LineStart(line);

    159. 

  159. 	int eolPos = styler.LineStart(line + 1) - 1;

    160. 

  160. 	for (int i = pos; i < eolPos; i++) {

    161. 

  161. 		char ch = styler[i];

    162. 

  162. 		char chNext = styler.SafeGetCharAt(i + 1);

    163. 

  163. 		int style = styler.StyleAt(i);

    164. 

  164. 		if (ch == '/' && chNext == '/' &&

    165. 

  165. 		   (style == SCE_V_COMMENTLINE || style == SCE_V_COMMENTLINEBANG)) {

    166. 

  166. 			return true;

    167. 

  167. 		} else if (!IsASpaceOrTab(ch)) {

    168. 

  168. 			return false;

    169. 

  169. 		}

    170. 

  170. 	}

    171. 

  171. 	return false;

    172. 

  172. }

    173. 

  173. // Store both the current line's fold level and the next lines in the

    174. 

  174. // level store to make it easy to pick up with each increment

    175. 

  175. // and to make it possible to fiddle the current level for "} else {".

    176. 

  176. static void FoldNoBoxVerilogDoc(unsigned int startPos, int length, int initStyle,

    177. 

  177.                             Accessor &styler) {

    178. 

  178. 	bool foldComment = styler.GetPropertyInt("fold.comment") != 0;

    179. 

  179. 	bool foldPreprocessor = styler.GetPropertyInt("fold.preprocessor") != 0;

    180. 

  180. 	bool foldCompact = styler.GetPropertyInt("fold.compact", 1) != 0;

    181. 

  181. 	bool foldAtElse = styler.GetPropertyInt("fold.at.else", 0) != 0;

    182. 

  182.         // Verilog specific folding options:

    183. 

  183.         // fold_at_module -

    184. 

  184.         //      Generally used methodology in verilog code is

    185. 

  185.         //      one module per file, so folding at module definition is useless.

    186. 

  186.         // fold_at_brace/parenthese -

    187. 

  187.         //      Folding of long port lists can be convenient.

    188. 

  188. 	bool foldAtModule = styler.GetPropertyInt("fold.verilog.flags", 0) != 0;

    189. 

  189. 	bool foldAtBrace  = 1;

    190. 

  190. 	bool foldAtParenthese  = 1;

    191. 

  191. 

    192. 

  192. 	unsigned int endPos = startPos + length;

    193. 

  193. 	int visibleChars = 0;

    194. 

  194. 	int lineCurrent = styler.GetLine(startPos);

    195. 

  195. 	int levelCurrent = SC_FOLDLEVELBASE;

    196. 

  196. 	if (lineCurrent > 0)

    197. 

  197. 		levelCurrent = styler.LevelAt(lineCurrent-1) >> 16;

    198. 

  198. 	int levelMinCurrent = levelCurrent;

    199. 

  199. 	int levelNext = levelCurrent;

    200. 

  200. 	char chNext = styler[startPos];

    201. 

  201. 	int styleNext = styler.StyleAt(startPos);

    202. 

  202. 	int style = initStyle;

    203. 

  203. 	for (unsigned int i = startPos; i < endPos; i++) {

    204. 

  204. 		char ch = chNext;

    205. 

  205. 		chNext = styler.SafeGetCharAt(i + 1);

    206. 

  206. 		int stylePrev = style;

    207. 

  207. 		style = styleNext;

    208. 

  208. 		styleNext = styler.StyleAt(i + 1);

    209. 

  209. 		bool atEOL = (ch == '\r' && chNext != '\n') || (ch == '\n');

    210. 

  210. 		if (foldComment && IsStreamCommentStyle(style)) {

    211. 

  211. 			if (!IsStreamCommentStyle(stylePrev)) {

    212. 

  212. 				levelNext++;

    213. 

  213. 			} else if (!IsStreamCommentStyle(styleNext) && !atEOL) {

    214. 

  214. 				// Comments don't end at end of line and the next character may be unstyled.

    215. 

  215. 				levelNext--;

    216. 

  216. 			}

    217. 

  217. 		}

    218. 

  218. 		if (foldComment && atEOL && IsCommentLine(lineCurrent, styler))

    219. 

  219. 		{

    220. 

  220. 			if (!IsCommentLine(lineCurrent - 1, styler)

    221. 

  221. 			    && IsCommentLine(lineCurrent + 1, styler))

    222. 

  222. 				levelNext++;

    223. 

  223. 			else if (IsCommentLine(lineCurrent - 1, styler)

    224. 

  224. 			         && !IsCommentLine(lineCurrent+1, styler))

    225. 

  225. 				levelNext--;

    226. 

  226. 		}

    227. 

  227. 		if (foldComment && (style == SCE_V_COMMENTLINE)) {

    228. 

  228. 			if ((ch == '/') && (chNext == '/')) {

    229. 

  229. 				char chNext2 = styler.SafeGetCharAt(i + 2);

    230. 

  230. 				if (chNext2 == '{') {

    231. 

  231. 					levelNext++;

    232. 

  232. 				} else if (chNext2 == '}') {

    233. 

  233. 					levelNext--;

    234. 

  234. 				}

    235. 

  235. 			}

    236. 

  236. 		}

    237. 

  237. 		if (foldPreprocessor && (style == SCE_V_PREPROCESSOR)) {

    238. 

  238. 			if (ch == '`') {

    239. 

  239. 				unsigned int j = i + 1;

    240. 

  240. 				while ((j < endPos) && IsASpaceOrTab(styler.SafeGetCharAt(j))) {

    241. 

  241. 					j++;

    242. 

  242. 				}

    243. 

  243. 				if (styler.Match(j, "if")) {

    244. 

  244. 					levelNext++;

    245. 

  245. 				} else if (styler.Match(j, "end")) {

    246. 

  246. 					levelNext--;

    247. 

  247. 				}

    248. 

  248. 			}

    249. 

  249. 		}

    250. 

  250.                 if (style == SCE_V_OPERATOR) {

    251. 

  251.                     if (foldAtParenthese) {

    252. 

  252. 			if (ch == '(') {

    253. 

  253. 				levelNext++;

    254. 

  254. 			} else if (ch == ')') {

    255. 

  255. 				levelNext--;

    256. 

  256. 			}

    257. 

  257.                     }

    258. 

  258. 		}

    259. 

  259.                 if (style == SCE_V_OPERATOR) {

    260. 

  260.                     if (foldAtBrace) {

    261. 

  261. 			if (ch == '{') {

    262. 

  262. 				levelNext++;

    263. 

  263. 			} else if (ch == '}') {

    264. 

  264. 				levelNext--;

    265. 

  265. 			}

    266. 

  266.                     }

    267. 

  267. 		}

    268. 

  268.                 if (style == SCE_V_WORD && stylePrev != SCE_V_WORD) {

    269. 

  269.                         unsigned int j = i;

    270. 

  270.                         if (styler.Match(j, "case") ||

    271. 

  271.                             styler.Match(j, "casex") ||

    272. 

  272.                             styler.Match(j, "casez") ||

    273. 

  273.                             styler.Match(j, "function") ||

    274. 

  274.                             styler.Match(j, "fork") ||

    275. 

  275.                             styler.Match(j, "table") ||

    276. 

  276.                             styler.Match(j, "task") ||

    277. 

  277.                             styler.Match(j, "generate") ||

    278. 

  278.                             styler.Match(j, "specify") ||

    279. 

  279.                             styler.Match(j, "primitive") ||

    280. 

  280.                             (styler.Match(j, "module") && foldAtModule) ||

    281. 

  281.                             styler.Match(j, "begin")) {

    282. 

  282.                                 levelNext++;

    283. 

  283.                         } else if (styler.Match(j, "endcase") ||

    284. 

  284.                                    styler.Match(j, "endfunction") ||

    285. 

  285.                                    styler.Match(j, "join") ||

    286. 

  286.                                    styler.Match(j, "endtask") ||

    287. 

  287.                                    styler.Match(j, "endgenerate") ||

    288. 

  288.                                    styler.Match(j, "endtable") ||

    289. 

  289.                                    styler.Match(j, "endspecify") ||

    290. 

  290.                                    styler.Match(j, "endprimitive") ||

    291. 

  291.                                    (styler.Match(j, "endmodule") && foldAtModule) ||

    292. 

  292.                                    (styler.Match(j, "end") && !IsAWordChar(styler.SafeGetCharAt(j+3)))) {

    293. 

  293.                                 levelNext--;

    294. 

  294.                         }

    295. 

  295. 		}

    296. 

  296. 		if (atEOL) {

    297. 

  297. 			int levelUse = levelCurrent;

    298. 

  298. 			if (foldAtElse) {

    299. 

  299. 				levelUse = levelMinCurrent;

    300. 

  300. 			}

    301. 

  301. 			int lev = levelUse | levelNext << 16;

    302. 

  302. 			if (visibleChars == 0 && foldCompact)

    303. 

  303. 				lev |= SC_FOLDLEVELWHITEFLAG;

    304. 

  304. 			if (levelUse < levelNext)

    305. 

  305. 				lev |= SC_FOLDLEVELHEADERFLAG;

    306. 

  306. 			if (lev != styler.LevelAt(lineCurrent)) {

    307. 

  307. 				styler.SetLevel(lineCurrent, lev);

    308. 

  308. 			}

    309. 

  309. 			lineCurrent++;

    310. 

  310. 			levelCurrent = levelNext;

    311. 

  311. 			levelMinCurrent = levelCurrent;

    312. 

  312. 			visibleChars = 0;

    313. 

  313. 		}

    314. 

  314. 		if (!isspacechar(ch))

    315. 

  315. 			visibleChars++;

    316. 

  316. 	}

    317. 

  317. }

    318. 

  318. 

    319. 

  319. static void FoldVerilogDoc(unsigned int startPos, int length, int initStyle, WordList *[],

    320. 

  320.                        Accessor &styler) {

    321. 

  321. 	FoldNoBoxVerilogDoc(startPos, length, initStyle, styler);

    322. 

  322. }

    323. 

  323. 

    324. 

  324. static const char * const verilogWordLists[] = {

    325. 

  325.             "Primary keywords and identifiers",

    326. 

  326.             "Secondary keywords and identifiers",

    327. 

  327.             "System Tasks",

    328. 

  328.             "User defined tasks and identifiers",

    329. 

  329.             "Unused",

    330. 

  330.             0,

    331. 

  331.         };

    332. 

  332. 

    333. 

  333. 

    334. 

  334. LexerModule lmVerilog(SCLEX_VERILOG, ColouriseVerilogDoc, "verilog", FoldVerilogDoc, verilogWordLists);
    335.