vis

a vi-like editor based on Plan 9's structural regular expressions
verilog.lua

(3890B)
      1 -- Copyright 2006-2025 Mitchell. See LICENSE.
      2 -- Verilog LPeg lexer.
      3 
      4 local lexer = require('lexer')
      5 local token, word_match = lexer.token, lexer.word_match
      6 local P, S = lpeg.P, lpeg.S
      7 
      8 local lex = lexer.new('verilog')
      9 
     10 -- Whitespace.
     11 lex:add_rule('whitespace', token(lexer.WHITESPACE, lexer.space^1))
     12 
     13 -- Keywords.
     14 lex:add_rule('keyword', token(lexer.KEYWORD, word_match{
     15 	'always', 'assign', 'begin', 'case', 'casex', 'casez', 'default', 'deassign', 'disable', 'else',
     16 	'end', 'endcase', 'endfunction', 'endgenerate', 'endmodule', 'endprimitive', 'endspecify',
     17 	'endtable', 'endtask', 'for', 'force', 'forever', 'fork', 'function', 'generate', 'if', 'initial',
     18 	'join', 'macromodule', 'module', 'negedge', 'posedge', 'primitive', 'repeat', 'release',
     19 	'specify', 'table', 'task', 'wait', 'while',
     20 	-- Compiler directives.
     21 	'`include', '`define', '`undef', '`ifdef', '`ifndef', '`else', '`endif', '`timescale',
     22 	'`resetall', '`signed', '`unsigned', '`celldefine', '`endcelldefine', '`default_nettype',
     23 	'`unconnected_drive', '`nounconnected_drive', '`protect', '`endprotect', '`protected',
     24 	'`endprotected', '`remove_gatename', '`noremove_gatename', '`remove_netname', '`noremove_netname',
     25 	'`expand_vectornets', '`noexpand_vectornets', '`autoexpand_vectornets',
     26 	-- Signal strengths.
     27 	'strong0', 'strong1', 'pull0', 'pull1', 'weak0', 'weak1', 'highz0', 'highz1', 'small', 'medium',
     28 	'large'
     29 }))
     30 
     31 -- Function.
     32 lex:add_rule('function', token(lexer.FUNCTION, word_match{
     33 	'$stop', '$finish', '$time', '$stime', '$realtime', '$settrace', '$cleartrace', '$showscopes',
     34 	'$showvars', '$monitoron', '$monitoroff', '$random', '$printtimescale', '$timeformat', '$display',
     35 	-- Built-in primitives.
     36 	'and', 'nand', 'or', 'nor', 'xor', 'xnor', 'buf', 'bufif0', 'bufif1', 'not', 'notif0', 'notif1',
     37 	'nmos', 'pmos', 'cmos', 'rnmos', 'rpmos', 'rcmos', 'tran', 'tranif0', 'tranif1', 'rtran',
     38 	'rtranif0', 'rtranif1', 'pullup', 'pulldown'
     39 }))
     40 
     41 -- Types.
     42 lex:add_rule('type', token(lexer.TYPE, word_match{
     43 	'integer', 'reg', 'time', 'realtime', 'defparam', 'parameter', 'event', 'wire', 'wand', 'wor',
     44 	'tri', 'triand', 'trior', 'tri0', 'tri1', 'trireg', 'vectored', 'scalared', 'input', 'output',
     45 	'inout', 'supply0', 'supply1'
     46 }))
     47 
     48 -- Identifiers.
     49 lex:add_rule('identifier', token(lexer.IDENTIFIER, lexer.word))
     50 
     51 -- Strings.
     52 lex:add_rule('string', token(lexer.STRING, lexer.range('"')))
     53 
     54 -- Comments.
     55 local line_comment = lexer.to_eol('//')
     56 local block_comment = lexer.range('/*', '*/')
     57 lex:add_rule('comment', token(lexer.COMMENT, line_comment + block_comment))
     58 
     59 -- Numbers.
     60 local bin_suffix = S('bB') * S('01_xXzZ')^1 * -lexer.xdigit
     61 local oct_suffix = S('oO') * S('01234567_xXzZ')^1
     62 local dec_suffix = S('dD') * S('0123456789_xXzZ')^1
     63 local hex_suffix = S('hH') * S('0123456789abcdefABCDEF_xXzZ')^1
     64 lex:add_rule('number', token(lexer.NUMBER, (lexer.digit + '_')^1 + "'" *
     65 	(bin_suffix + oct_suffix + dec_suffix + hex_suffix)))
     66 
     67 -- Operators.
     68 lex:add_rule('operator', token(lexer.OPERATOR, S('=~+-/*<>%&|^~,:;()[]{}')))
     69 
     70 -- Fold points.
     71 lex:add_fold_point(lexer.KEYWORD, 'case', 'endcase')
     72 lex:add_fold_point(lexer.KEYWORD, 'casex', 'endcase')
     73 lex:add_fold_point(lexer.KEYWORD, 'casez', 'endcase')
     74 lex:add_fold_point(lexer.KEYWORD, 'function', 'endfunction')
     75 lex:add_fold_point(lexer.KEYWORD, 'fork', 'join')
     76 lex:add_fold_point(lexer.KEYWORD, 'table', 'endtable')
     77 lex:add_fold_point(lexer.KEYWORD, 'task', 'endtask')
     78 lex:add_fold_point(lexer.KEYWORD, 'generate', 'endgenerate')
     79 lex:add_fold_point(lexer.KEYWORD, 'specify', 'endspecify')
     80 lex:add_fold_point(lexer.KEYWORD, 'primitive', 'endprimitive')
     81 lex:add_fold_point(lexer.KEYWORD, 'module', 'endmodule')
     82 lex:add_fold_point(lexer.KEYWORD, 'begin', 'end')
     83 lex:add_fold_point(lexer.OPERATOR, '(', ')')
     84 lex:add_fold_point(lexer.OPERATOR, '{', '}')
     85 lex:add_fold_point(lexer.COMMENT, '/*', '*/')
     86 
     87 lexer.property['scintillua.comment'] = '//'
     88 
     89 return lex