-
Notifications
You must be signed in to change notification settings - Fork 17
/
verilog_navigation.py
1733 lines (1634 loc) · 80.1 KB
/
verilog_navigation.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import absolute_import
import sublime, sublime_plugin
import re, string, os, sys, functools, mmap, pprint, imp, threading
from collections import Counter
from plistlib import readPlistFromBytes
from . import verilog_module
from .verilogutil import verilogutil
from .verilogutil import sublimeutil
from .color_scheme_util import st_color_scheme_matcher
from .color_scheme_util import rgba
############################################################################
# Init
TOOLTIP_SUPPORT = int(sublime.version()) >= 3072
use_tooltip = False
show_ref = False
show_signal_links = False
debug = False
sv_settings = None
tooltip_css = ''
tooltip_flag = 0
navBar = {}
colors = {}
def plugin_loaded():
imp.reload(verilogutil)
imp.reload(sublimeutil)
imp.reload(verilog_module)
imp.reload(st_color_scheme_matcher)
global sv_settings
global pref_settings
global debug
pref_settings = sublime.load_settings('Preferences.sublime-settings')
pref_settings.clear_on_change('reload')
pref_settings.add_on_change('reload',plugin_loaded)
sv_settings = sublime.load_settings('SystemVerilog.sublime-settings')
sv_settings.clear_on_change('reload')
sv_settings.add_on_change('reload',plugin_loaded)
debug = sv_settings.get("sv.debug")
if debug:
print('[SV:Popup] Plugin Loaded')
init_css()
def init_css():
global use_tooltip
global tooltip_css
global tooltip_flag
global show_ref
global show_signal_links
global colors
if int(sublime.version()) >= 3072 :
use_tooltip = sv_settings.get('sv.tooltip',True)
show_signal_links = sv_settings.get('sv.tooltip_show_signal_links',False)
if sv_settings.get('sv.tooltip_hide_on_move',True):
tooltip_flag = sublime.HIDE_ON_MOUSE_MOVE_AWAY
else:
tooltip_flag = 0
show_ref = int(sublime.version()) >= 3145 and sv_settings.get('sv.tooltip_show_refs',True)
#
scheme = st_color_scheme_matcher.ColorSchemeMatcher(pref_settings.get('color_scheme'))
bg = scheme.get_special_color('background')
fg = scheme.get_special_color('foreground')
# Create background and border color based on the background color
bg_rgb = rgba.RGBA(bg)
if bg_rgb.b > 128:
bgHtml = bg_rgb.b - 0x33
bgBody = bg_rgb.b - 0x20
else:
bgHtml = bg_rgb.b + 0x33
bgBody = bg_rgb.b + 0x20
if bg_rgb.g > 128:
bgHtml += (bg_rgb.g - 0x33)<<8
bgBody += (bg_rgb.g - 0x20)<<8
else:
bgHtml += (bg_rgb.g + 0x33)<<8
bgBody += (bg_rgb.g + 0x20)<<8
if bg_rgb.r > 128:
bgHtml += (bg_rgb.r - 0x33)<<16
bgBody += (bg_rgb.r - 0x20)<<16
else:
bgHtml += (bg_rgb.r + 0x33)<<16
bgBody += (bg_rgb.r + 0x20)<<16
tooltip_css = 'html {{ background-color: #{bg:06x}; color: {fg}; }}\n'.format(bg=bgHtml, fg=fg)
tooltip_css+= 'body {{ background-color: #{bg:06x}; margin: 1px; font-size: 1em; }}\n'.format(bg=bgBody)
tooltip_css+= 'p {padding-left: 0.6em;}\n'
tooltip_css+= '.content {margin: 0.8em;}\n'
tooltip_css+= 'h1 {font-size: 1.0rem;font-weight: bold; margin: 0 0 0.25em 0;}\n'
tooltip_css+= 'a {{color: {c};}}\n'.format(c=fg)
tooltip_css+= '.keyword {{color: {c};}}\n'.format(c=scheme.get_color('keyword'))
tooltip_css+= '.support {{color: {c};}}\n'.format(c=scheme.get_color('support'))
tooltip_css+= '.storage {{color: {c};}}\n'.format(c=scheme.get_color('storage'))
tooltip_css+= '.function {{color: {c};}}\n'.format(c=scheme.get_color('support.function'))
tooltip_css+= '.entity {{color: {c};}}\n'.format(c=scheme.get_color('entity'))
tooltip_css+= '.operator {{color: {c};}}\n'.format(c=scheme.get_color('keyword.operator'))
tooltip_css+= '.numeric {{color: {c};}}\n'.format(c=scheme.get_color('constant.numeric'))
tooltip_css+= '.string {{color: {c};}}\n'.format(c=scheme.get_color('string'))
tooltip_css+= '.extra-info {font-size: 0.9em; }\n'
tooltip_css+= '.ref_links {font-size: 0.9em; color: #0080D0; padding-left: 0.6em}\n'
colors['operator'] = scheme.get_color('keyword.operator')
else :
use_tooltip = False
tooltip_css = ''
############################################################################
callbacks_on_load = {}
class VerilogOnLoadEventListener(sublime_plugin.EventListener):
# Called when a file is finished loading.
def on_load_async(self, view):
global callbacks_on_load
if view.file_name() in callbacks_on_load:
callbacks_on_load[view.file_name()]()
del callbacks_on_load[view.file_name()]
############################################################################
# Display type of the signal/variable under the cursor into the status bar #
class VerilogTypePopup :
def __init__(self,view):
self.view = view
def show(self,region,location):
# If nothing is selected expand selection to word
if region.empty() :
region = self.view.word(region)
# Make sure a whole word is selected
elif (self.view.classify(region.a) & sublime.CLASS_WORD_START)==0 or (self.view.classify(region.b) & sublime.CLASS_WORD_END)==0:
if (self.view.classify(region.a) & sublime.CLASS_WORD_START)==0:
region.a = self.view.find_by_class(region.a,False,sublime.CLASS_WORD_START)
if (self.view.classify(region.b) & sublime.CLASS_WORD_END)==0:
region.b = self.view.find_by_class(region.b,True,sublime.CLASS_WORD_END)
# Optionnaly extend selection to parent object (parent.var)
if 'support.function.port' not in self.view.scope_name(region.a):
while region.a>1 and self.view.substr(sublime.Region(region.a-1,region.a))=='.' :
c = self.view.substr(sublime.Region(region.a-2,region.a-1))
# Array selection -> extend to start of array
if c == ']':
region.a = self.view.find_by_class(region.a-3,False,sublime.CLASS_WORD_START)
if self.view.classify(region.a-2) & sublime.CLASS_WORD_START:
region.a = region.a-2
else :
region.a = self.view.find_by_class(region.a-2,False,sublime.CLASS_WORD_START)
# Optionnaly extend selection to scope specifier
if region.a>2 and self.view.substr(sublime.Region(region.a-2,region.a))=='::' :
region.a = self.view.find_by_class(region.a-3,False,sublime.CLASS_WORD_START)
v = self.view.substr(region)
if debug: print('[SV:Popup.show] Word to show = {0}'.format(v));
if re.match(r'^([A-Za-z_]\w*::|(([A-Za-z_]\w*(\[.+\])?)\.)+)?[A-Za-z_]\w*$',v): # Check this is a valid word
s,ti,colored,is_local = self.get_type(v,region)
# print('s={},is_local={}, ti={},colored={}'.format(s,is_local,ti,colored))
ref_name = ''
if not s:
sublime.status_message('No definition found for ' + v)
# Check if we use tooltip or statusbar to display information
elif use_tooltip :
if debug: print('[SV:Popup.show] {} (colored={})'.format(ti,colored));
s_func = '<br><span class="extra-info">{0}<span class="keyword">function </span><span class="function">{1}</span>()</span>' # tempalte for printing function info
if ti and (ti['type'] in ['module','interface','function','task']):
ref_name = ti['name']
s,_ = self.color_str(s=s, addLink=True,ti_var=ti)
if 'param' in ti:
s += self.add_info(ti['param'],fieldTemplate='DNV-parameter')
if 'port' in ti:
s += self.add_info(ti['port'])
if ti['type']=='interface':
if 'signal' not in ti and 'fname' in ti:
ti = verilogutil.parse_module_file(ti['fname'][0],ti['name'])
if ti:
if 'signal' in ti:
s += self.add_info([x for x in ti['signal'] if x['tag']=='decl'])
if 'modport' in ti:
s += self.add_info(ti['modport'],fieldTemplate='modport {0}', field='name')
elif ti and ti['type'] == 'clocking':
s,_ = self.color_str(s=s, addLink=True,ti_var=ti)
for p in ti['port']:
x = '{} {}'.format(p['type'],p['name'])
s += '<br><span class="extra-info">{}{}</span>'.format(' '*4,self.color_str(x)[0])
elif ti and 'tag' in ti and (ti['tag'] == 'enum' or ti['tag']=='struct'):
m = re.search(r'(?s)^(.*)\{(.*)\}', ti['decl'])
s,tti = self.color_str(s=m.groups()[0] + ' ' + v, addLink=True)
if ti['tag'] == 'enum':
s+='<br><span class="extra-info">{0}{1}</span>'.format(' '*4,m.groups()[1])
else :
fti = verilogutil.get_all_type_info(m.groups()[1])
if fti:
s += self.add_info(fti)
elif ti and ti['type']=='class':
ref_name = ti['name']
if 'fname' in ti:
ci = verilogutil.parse_class_file(ti['fname'][0],ti['name'])
else :
txt = self.view.substr(sublime.Region(0, self.view.size()))
ci = verilogutil.parse_class(txt,ti['name'])
s,_ = self.color_str(s='class {0}'.format(ti['name']), addLink=True,ti_var=ti)
if ci:
if ci['extend']:
s+=' <span class="keyword">extends</span> '
s+='<span class="storage">{0}</span>'.format(ci['extend'])
s += self.add_info([x for x in ci['member'] if 'access' not in x])
s += self.add_info([x for x in ci['function'] if 'access' not in x and x['name']!='new'],field='name',template=s_func, useColor=False)
#if debug: print(ci);
elif ti and ti['type']=='package':
s,_ = self.color_str(s=s, addLink=True,ti_var=ti)
if 'member' in ti:
members = []
for x in ti['member']:
m = re.match(r'(?P<decl>(typedef\s+)?enum\s+([^\{]*))\{(?P<val>.*)\}\s*(?P<name>[^;]*)',x['decl'])
if m :
d = '{} {}'.format(m.group('decl'),m.group('name'))
for v in m.group('val').split(','):
d+=' <br>{}{}'.format(' '*8,v.strip())
else :
d = re.sub(r'struct\s+(packed\s*)(\{.*\})',r'struct \1',x['decl'])
members.append({'decl' : d})
s += self.add_info(members)
# s += self.add_info([x for x in ti['member']])
elif not colored :
s,ti = self.color_str(s=s, addLink=True)
if ti:
if debug: print('Default : {}'.format(ti))
if 'tag' in ti and ti['tag'] == 'enum':
m = re.search(r'\{(.*)\}', ti['decl'])
if m:
s+='<br><span class="extra-info">{0}{1}</span>'.format(' '*4,m.groups()[0])
elif 'tag' in ti and ti['tag'] == 'struct':
m = re.search(r'\{(.*)\}', ti['decl'])
if m:
fti = verilogutil.get_all_type_info(m.groups()[0])
if fti:
s += self.add_info(fti)
elif ti['decl'] and 'interface' in ti['decl']:
mi = verilog_module.lookup_module(self.view,ti['name'])
if mi :
# pprint.pprint(mi)
if 'param' in mi:
s += self.add_info(mi['param'],fieldTemplate='DNV-parameter')
if 'signal' in mi:
s += self.add_info([x for x in mi['signal'] if x['tag']=='decl'])
if 'modport' in mi:
s += self.add_info(mi['modport'],fieldTemplate='modport {0}', field='name')
elif ti['type']=='class':
ci = verilogutil.parse_class_file(ti['fname'][0],ti['name'])
if ci:
s += self.add_info([x for x in ci['member'] if 'access' not in x])
s += self.add_info([x for x in ci['function'] if 'access' not in x and x['name']!='new'],field='name',template=s_func, useColor=False)
# Add reference list
if show_ref and ref_name :
refs = self.view.window().lookup_references_in_index(ref_name)
if refs:
ref_links = []
for l in refs :
l_href = '{}:{}:{}'.format(l[0],l[2][0],l[2][1])
l_name = os.path.basename(l[0])
ref_links.append('<a href="LINK@{}" class="ref_links">{}</a>'.format(l_href,l_name))
s += '<h1><br>Reference:</h1><span>{}</span>'.format('<br>'.join(ref_links))
elif is_local and show_signal_links:
s += '<span><br><a href="DRIVER@__CURRENT__@{}" class="ref_links">Goto Driver</a><br>'.format(v)
s += '<a href="REFERENCE@__CURRENT__@{}" class="ref_links">Goto Reference</a></span>'.format(v)
s = '<style>{css}</style><div class="content">{txt}</div>'.format(css=tooltip_css, txt=s)
# print(s)
self.view.show_popup(s,location=location, flags=tooltip_flag, max_width=500, on_navigate=self.on_navigate)
else :
# fix hard limit to signal declaration to 128 to ensure it can be displayed
if s and len(s) > 128:
s = re.sub(r'\{.*\}','',s) # A long signal is typical of an enum, struct : remove content to only let the type appear
if len(s) > 128:
s = s[:127]
sublime.status_message(s)
def add_info(self, ilist, field='decl', template='<br><span class="extra-info">{0}{1}</span>', space=4, limit=256, useColor=True, fieldTemplate='{0}'):
s = ''
cnt = 0;
for x in ilist:
if fieldTemplate.startswith('DNV'):
f = fieldTemplate[4:]+' {d} {n} = {v}'
f = f.format(d=x['decl'],n=x['name'],v=x['value'])
else :
f = fieldTemplate.format(x[field])
if useColor:
f = self.color_str(f)[0]
s += template.format(' '*space,f)
cnt += 1
if cnt >= limit:
s+='<br><span class="extra-info">continuing ...</span>'
break
return s
def get_type(self,var_name,region):
vs = None
is_local = False
if '::' in var_name:
vs = var_name.split('::')
var_name = vs[1]
scope = self.view.scope_name(region.a+len(vs[0])+2)
else:
scope = self.view.scope_name(region.a)
ti = None
colored = False
txt = ''
if debug: print ('[SV:Popup.get_type] var={0} scope="{1}"'.format(var_name,scope));
# In case of field, retrieve parent type
if '.' in var_name:
ti = verilog_module.type_info_on_hier(self.view,var_name,region=region)
if ti:
# print('[SV:get_type] Return {0}'.format(ti))
txt = ti['decl']
# Extract type info from module if we are on port connection
elif 'support.function.port' in scope:
region = sublimeutil.expand_to_scope(self.view,'meta.module.inst',region)
s = self.view.substr(region)
m = re.match(r'^(?s)\s*(\w+)\s+(\w+)',s,re.MULTILINE)
if not m:
m = re.match(r'^(?s)\s*(\w+)\s*#(?:.*?)\)\s*(\w+)',s,re.MULTILINE)
if not m:
m = re.match(r'^(?s)\s*(\w+)()',s,re.MULTILINE)
if not m:
print('[SV:Popup.get_type] Unable to extract the module name in {}'.format(s))
return
mname = m.group(1)
iname = m.group(2)
# print('[get_type] Find module with name {} (instance {})'.format(mname,iname))
mi = verilog_module.lookup_module(self.view,mname)
if mi:
colored = True
found = False
fname = '{0}:{1}:{2}'.format(mi['fname'][0],mi['fname'][1],mi['fname'][2])
for p in mi['port']:
if p['name']==var_name:
txt,_ = self.color_str(s=p['decl'].rsplit(' ',1)[0],last_word=False)
if p['decl'].startswith('in'): # Input or inout
txt += ' <a href="REFERENCE@{0}@{1}">{1}</a>'.format(mi['fname'][0],var_name)
elif p['decl'].startswith('output'): # output
txt += ' <a href="DRIVER@{0}@{1}">{1}</a>'.format(mi['fname'][0],var_name)
else:
txt += ' {0}'.format(var_name)
found = True
break
# Check parameters if this was not found in port name
if not found:
for p in mi['param']:
if p['name']==var_name:
txt,_ = self.color_str(s=' parameter {0} {1} = {2}'.format(p['decl'],p['name'],p['value']))
if sv_settings.get('sv.tooltip_show_module_on_port',False):
txt = '<a href="LINK@{0}" class="storage">{1}</a><span class="entity"> {2}</span><br> {3}'.format(fname,mname,iname,txt)
# Get function I/O
elif 'support.function.generic' in scope or 'entity.name.function' in scope:
ti = verilog_module.lookup_function(self.view,var_name)
if debug: print ('[get_type] Function: {0}'.format(ti))
if ti:
txt = ti['decl']
# Get structure/interface
elif 'storage.type.userdefined' in scope or 'storage.type.uvm' in scope or 'storage.type.interface' in scope:
ti = verilog_module.lookup_type(self.view,var_name)
if ti:
txt = ti['decl']
# Get Module I/O
elif 'storage.type.module' in scope:
ti = verilog_module.lookup_module(self.view,var_name)
if ti:
txt = ti['type'] + ' ' + var_name
# Get Package info
elif 'support.type.scope' in scope:
ti = verilog_module.lookup_package(self.view,var_name)
if ti:
txt = 'package {0}'.format(var_name)
# Get Macro text
elif 'constant.other.define' in scope:
txt,_ = verilog_module.lookup_macro(self.view,var_name)
# Get Base Class
elif 'entity.other.inherited-class' in scope:
ti = verilog_module.lookup_type(self.view,var_name)
if ti:
txt = ti['decl']
# Variable inside a scope
elif vs:
if len(vs)==2:
ti = verilog_module.lookup_type(self.view,vs[0])
if ti and ti['type']=='package':
ti = verilog_module.type_info_file(self.view,ti['fname'][0],vs[1])
if ti:
txt = ti['decl']
if 'value' in ti and ti['value']:
txt += ' = {0}'.format(ti['value'])
# Simply lookup in the file before the use of the variable
else :
#If inside a function try first in the function body
ti = {'type':None}
if 'meta.function.body' in scope:
r_func = sublimeutil.expand_to_scope(self.view,'meta.function',region)
ti = verilog_module.type_info(self.view,self.view.substr(r_func),var_name)
elif 'meta.task.body' in scope:
r_func = sublimeutil.expand_to_scope(self.view,'meta.task',region)
ti = verilog_module.type_info(self.view,self.view.substr(r_func),var_name)
if not ti['type'] :
# select whole file until end of current line
region = self.view.line(region)
lines = self.view.substr(sublime.Region(0, region.b))
# Extract type
ti = verilog_module.type_info(self.view,lines,var_name)
#if not found check for a definition in base class if we this is an extended class
if not ti['type'] :
bti = verilog_module.type_info_from_base(self.view,region,var_name)
if bti:
ti = bti
elif ti['tag'] == 'decl' :
is_local = True
# Type not found in current file ? fallback to sublime index
if not ti['decl']:
ti = verilog_module.lookup_type(self.view,var_name)
if ti:
txt = ti['decl']
if 'value' in ti and ti['value']:
txt += ' = ' + ti['value']
# if debug: print('[SV:get_type] Return {0}'.format(ti))
return txt,ti,colored,is_local
keywords = ['localparam', 'parameter', 'module', 'interface', 'package', 'class', 'typedef', 'struct', 'union', 'enum', 'packed', 'automatic',
'local', 'protected', 'public', 'static', 'const', 'virtual', 'function', 'task', 'var', 'modport', 'clocking', 'default', 'extends']
def color_str(self,s, addLink=False, ti_var=None, last_word=True):
ss = re.sub(r'<(?!br>)','<',s).split()
sh = ''
ti = None
pos_var = len(ss)-1
if pos_var>2 and ss[-2] == '=':
pos_var -= 2
for i,w in enumerate(ss):
m = re.match(r'^[A-Za-z_]\w+$',w)
if '"' in w :
sh+=re.sub(r'(".*?")',r'<span class="string">\1</span> ',w)
elif i == len(ss)-1 and last_word:
if m:
if addLink and ti_var and 'fname' in ti_var:
fname = '{0}:{1}:{2}'.format(ti_var['fname'][0],ti_var['fname'][1],ti_var['fname'][2])
w ='<a href="LINK@{0}" class="entity">{1}</a>'.format(fname,w)
else:
w = re.sub(r'\b((b|d|o)?\d+(\.\d+(ms|us|ns|ps|fs)?)?)\b',r'<span class="numeric">\1</span>',w)
w = re.sub(r'(\'h[0-9A-Fa-f]+)\b',r'<span class="numeric">\1</span>',w)
w = re.sub(r'(\#|\:|\')',r'<span class="operator">\1</span>',w)
sh+=w
elif w in ['input', 'output', 'inout', 'ref']:
sh+='<span class="support">{0}</span> '.format(w)
elif w in self.keywords:
sh+='<span class="keyword">{0}</span> '.format(w)
elif w in ['wire', 'reg', 'logic', 'int', 'signed', 'unsigned', 'real', 'bit', 'rand', 'void', 'string']:
sh+='<span class="storage">{0}</span> '.format(w)
elif '::' in w:
ws = w.split('::')
sh+='<span class="support">{0}</span><span class="operator">::</span>'.format(ws[0])
if addLink:
ti = verilog_module.lookup_type(self.view,w)
if debug: print('[SV:color_str] user-defined type: word={}::{} => ti={}'.format(ws[0],ws[1],ti));
if ti and 'fname' in ti:
fname = '{0}:{1}:{2}'.format(ti['fname'][0],ti['fname'][1],ti['fname'][2])
sh+='<a href="LINK@{0}" class="storage">{1}</a> '.format(fname,ws[1])
else:
sh+='<span class="storage">{0}</span> '.format(ws[1])
elif '.' in w:
ws = w.split('.')
if ws[0] and re.match(r'^[A-Za-z_]\w+$',ws[0]):
if addLink:
ti = verilog_module.lookup_type(self.view,ws[0])
if ti and 'fname' in ti:
fname = '{0}:{1}:{2}'.format(ti['fname'][0],ti['fname'][1],ti['fname'][2])
sh+='<a href="LINK@{0}" class="storage">{1}</a>'.format(fname,ws[0])
else:
sh+='<span class="storage">{0}</span>'.format(ws[0])
sh+='.<span class="support">{0}</span> '.format(ws[1])
else :
if '#' in ws[0]:
sh += re.sub(r'(#)',r'<span class="operator">\1</span> ',ws[0])
sh+='.'
sh+= re.sub(r'\b(\w+)\b',r'<span class="function">\1</span> ',ws[1],count=1)
elif '[' in w or '(' in w:
w = re.sub(r'\b(\d+)\b',r'<span class="numeric">\1</span>',w)
sh += re.sub(r'(\#|\:)',r'<span class="operator">\1</span>',w) + ' '
# Color type: typically just before the variable or one word earlier in case of array or parameter
elif ((i == pos_var-1 or (i>0 and ss[i-1]=='typedef')) and m) or (i == pos_var-2 and ('[' in ss[pos_var-1] or '#' in ss[pos_var-1])) :
if addLink:
ti = verilog_module.lookup_type(self.view,w)
#if debug: print('[SV:color_str] word={0} => ti={1}'.format(w,ti));
if ti and 'fname' in ti:
fname = '{0}:{1}:{2}'.format(ti['fname'][0],ti['fname'][1],ti['fname'][2])
sh+='<a href="LINK@{0}" class="storage">{1}</a> '.format(fname,w)
else:
sh+='<span class="storage">{0}</span> '.format(w)
elif re.match(r'(\d+\'(b|d|o|h))?\d+',w) :
sh += re.sub(r'\b((\d+\'(b|d|o|h))?\d+)\b',r'<span class="numeric">\1</span> ',w)
elif w in ['=','#'] :
sh += re.sub(r'(=|#)',r'<span class="operator">\1</span> ',w)
else:
sh += w + ' '
return sh,ti
def on_navigate(self, href):
href_s = href.split('@')
if href_s[1]=='__CURRENT__' :
v = self.view
else :
v = self.view.window().find_open_file(href_s[1])
if v :
self.view.window().focus_view(v)
if href_s[0]=='DRIVER':
goto_driver(v,href_s[2])
elif href_s[0]=='REFERENCE':
goto_signal_ref(v,href_s[2])
else :
v = self.view.window().open_file(href_s[1],sublime.ENCODED_POSITION)
global callbacks_on_load
if href_s[0]=='DRIVER':
callbacks_on_load[href_s[1]] = lambda v=v, inst_name=href_s[2]: goto_driver(v,inst_name)
elif href_s[0]=='REFERENCE':
callbacks_on_load[href_s[1]] = lambda v=v, inst_name=href_s[2]: goto_signal_ref(v,inst_name)
# Manual command to display the popup
class VerilogTypeCommand(sublime_plugin.TextCommand):
def run(self,edit):
if len(self.view.sel())==0 : return;
popup = VerilogTypePopup(self.view)
popup.show(self.view.sel()[0],-1)
# Event onHover to display the popup
class VerilogShowTypeHover(sublime_plugin.EventListener):
def on_hover(self, view, point, hover_zone):
# Popup only on text
if hover_zone != sublime.HOVER_TEXT:
return
# Check file size to optionnaly disable the feature (finding the information can be quite long)
threshold = view.settings().get('sv.hover_max_size',-1)
if view.size() > threshold and threshold!=-1 :
return
# Only show a popup for systemVerilog, when not in a string of a comment
scope = view.scope_name(point)
if 'source.systemverilog' not in scope:
return
if any(w in scope for w in ['comment', 'string', 'keyword']):
return
popup = VerilogTypePopup(view)
sublime.set_timeout_async(lambda r=view.word(point), p=point: popup.show(r,p))
###################################################################
# Move cursor to the declaration of the signal currently selected #
class VerilogGotoDeclarationCommand(sublime_plugin.TextCommand):
def run(self,edit):
if len(self.view.sel())==0 : return;
region = self.view.sel()[0]
# If nothing is selected expand selection to word
if region.empty() : region = self.view.word(region);
v = self.view.substr(region).strip()
sl = [verilogutil.re_decl + v + r'\b', verilogutil.re_enum + v + r'\b', verilogutil.re_union + v + r'\b', verilogutil.re_inst + v + '\b']
for s in sl:
r = self.view.find(s,0)
if r:
sublimeutil.move_cursor(self.view,r.b-1)
return
##############################################################
# Move cursor to the driver of the signal currently selected #
class VerilogGotoDriverCommand(sublime_plugin.TextCommand):
def run(self,edit):
if len(self.view.sel())==0 : return;
region = self.view.sel()[0]
# If nothing is selected expand selection to word
if region.empty() : region = self.view.word(region);
signal = self.view.substr(region).strip()
goto_driver(self.view,signal)
##########################################################
# Move cursor to the begin/end, [], {}, case/endcase ... #
class VerilogGotoBlockBoundary(sublime_plugin.TextCommand):
def run(self,edit, cmd="move"):
if len(self.view.sel())==0 : return;
token_begin = ['begin','(','[','{','module','function','task','class','covergroup','fork','generate','case','interface','clocking']
token_end = ['end' ,')',']','}','endmodule','endfunction','endtask','endclass','endgroup','join','join_none','join_any','endgenerate','endcase','endinterface','endclocking']
re_token = r'\(|\[|\{|\)|\]|\}|\bbegin\b|\bend\b|'
re_token += r'\bmodule\b|\bendmodule\b|\bcase\b|\bendcase\b|\bfunction\b|\bendfunction\b|'
re_token += r'\btask\b|\bendtask\b|\bgenerate\b|\bendgenerate\b|\bclass\b|\bendclass\b|'
re_token += r'\binterface\b|\bendinterface\b|\bclocking\b|\bendclocking\b|'
re_token += r'\bcovergroup\b|\bendgroup\b|\bfork\b|\bjoin\b|\bjoin_any\b|\bjoin_none\b'
sel = self.view.sel()[0]
tl = []
rl = self.view.find_all(re_token,0,r'$0',tl)
i = 0
while i<len(rl) and rl[i].a < sel.b:
i=i+1
if i==len(rl):
return
si = i-1 # start index
ei = i # end index
cnt = 0
# Search for token start before pt, ignoring pairs and token inside comment or string
scope = self.view.scope_name(rl[si].a)
while si>0 and (tl[si] not in token_begin or cnt>0 or 'comment' in scope or 'string' in scope):
if 'comment' not in scope and 'string' not in scope:
if tl[si] in token_end:
cnt = cnt + 1
else:
cnt = cnt - 1
si = si - 1
scope = self.view.scope_name(rl[si].a)
if cnt!=0:
# print('[SV.GotoBlockBoundary] Pairs not balanced toward start')
return
# Search for token end after pt, ignoring pairs and token inside comment or string
scope = self.view.scope_name(rl[ei].a)
while ei<len(tl) and (tl[ei] not in token_end or cnt>0 or 'comment' in scope or 'string' in scope):
if 'comment' not in scope and 'string' not in scope:
if tl[ei] in token_begin:
cnt = cnt + 1
else:
cnt = cnt - 1
ei = ei + 1
if ei==len(tl):
# print('[SV.GotoBlockBoundary] Pairs not balanced toward end')
return
scope = self.view.scope_name(rl[ei].a)
# Select text
# print('[SV.GotoBlockBoundary] Cursor at {0} - surrounded by "{1}" ({2}=>{3}) and "{4}" ({5}=>{6})'.format(pt,tl[si],rl[si].a,self.view.rowcol(rl[si].a),tl[ei],rl[ei].a,self.view.rowcol(rl[ei].a)))
if cmd=='select':
self.view.sel().clear()
if sel.a != rl[si].b or sel.b != rl[ei].a :
self.view.sel().add(sublime.Region(rl[si].b,rl[ei].a))
else :
self.view.sel().add(sublime.Region(rl[si].a,rl[ei].b))
else :
# Move cursor to the end token if not already at the end. Otherwise move it to the start one
if sel.b<rl[ei].a:
pos = rl[ei].a
else:
pos = rl[si].b
sublimeutil.move_cursor(self.view,pos)
############################################################################
# Helper function to retrieve current module name based on cursor position #
def getModuleName(view):
r = view.sel()[0]
# Empty selection ? get current module name
if r.empty():
p = r'(?s)^[ \t]*(module|interface)\s+(\w+\b)'
nameList = []
rList = view.find_all(p,0,r'\2',nameList)
name = ''
if rList:
name = nameList[0]
# Handle case where there is multiple class in a file
# and select the one closest to the cursor
for (rf,n) in zip(rList,nameList):
if rf.a < r.a:
name = n
else:
break
else:
name = view.substr(r)
# print(name)
return name
def goto_driver(view,signal):
signal_word = r'\b'+signal+r'\b'
# look for an input or an interface of the current module, and for an assignement
sl = [r'input\s+(\w+\s+)?(\w+\s+)?([A-Za-z_][\w\:]*\s+)?(\[[\w\:\-`\s]+\])?\s*([A-Za-z_][\w=,\s]*,\s*)?' + signal + r'\b']
sl.append(r'^\s*\w+\.\w+\s+' + signal + r'\b')
sl.append(r'\b' + signal + r'\b(\[[^\]]*\])*\s*<?\=[^\=]')
for s in sl:
r = view.find(s,0)
# print('searching ' + s + ' => ' + str(r))
if r:
# print("Found input at " + str(r) + ': ' + view.substr(view.line(r)))
sublimeutil.move_cursor(view,r.a)
return
# look for a connection explicit, implicit or by position
sl = [r'\.(\w+)\s*\(\s*'+signal+r'\b' , r'(\.\*)', r'(\(|,)\s*'+signal+r'\b\s*(,|\)\s*;)']
for k,s in enumerate(sl):
pl = []
rl = view.find_all(s,0,r'$1',pl)
# print('searching ' + s + ' => ' + str(rl))
for i,r in enumerate(rl):
# print('Found in line ' + view.substr(view.line(r)))
# print('Scope for ' + str(r) + ' = ' + view.scope_name(r.a))
if 'meta.module.inst' in view.scope_name(r.a) :
rm = sublimeutil.expand_to_scope(view,'meta.module.inst',r)
txt = verilogutil.clean_comment(view.substr(rm))
# Parse module definition
mname = re.findall(r'\w+',txt)[0]
filelist = view.window().lookup_symbol_in_index(mname)
if not filelist:
return
for f in filelist:
fname = sublimeutil.normalize_fname(f[0])
mi = verilogutil.parse_module_file(fname,mname)
if mi:
break
if mi:
op = r'^(output\s+.*|\w+\.\w+\s+)'
# Output port string to search
portname = ''
if k==1: #Explicit connection
portname = signal
elif k==0: #implicit connection
portname = pl[i]
elif k==2 : #connection by position
for j,l in enumerate(txt.split(',')) :
if signal in l:
dl = [x['decl'] for x in mi['port']]
if re.search(op,dl[j]) :
r_v = view.find(signal_word,rm.a)
if r_v and r_v.b<=rm.b:
sublimeutil.move_cursor(view,r_v.a)
else:
sublimeutil.move_cursor(view,r.a)
return
if portname != '' :
op += portname+r'\b'
for x in mi['port']:
m = re.search(op,x['decl'])
if m:
r_v = view.find(signal_word,rm.a)
if r_v and r_v.b<=rm.b:
sublimeutil.move_cursor(view,r_v.a)
else:
sublimeutil.move_cursor(view,r.a)
return
# Everything failed
sublime.status_message("Could not find driver of " + signal)
def goto_signal_ref(view,signal):
lr = view.find_all(r'\b{}\b'.format(signal))
refs = { 'txt':[], 'row':[], 'point':[] }
for r in lr:
scope = view.scope_name(r.b)
if 'comment' in scope or 'meta.module' in scope :
continue
row,col = view.rowcol(r.b)
if row not in refs['row']:
line = view.substr(view.line(r.b)).strip()
if re.search(r'\b{}\b\s*<?=(?!=)',line) :
continue
refs['txt'].append(line)
refs['row'].append(row)
refs['point'].append(r.b)
if len(refs['row']) > 1 :
view.window().show_quick_panel(refs['txt'],
on_select = lambda x:sublimeutil.move_cursor(view,refs['point'][x]),
on_highlight = lambda x:sublimeutil.move_cursor(view,refs['point'][x]))
elif len(refs['row']) == 1 :
sublimeutil.move_cursor(view,refs['point'][0])
def goto_first_occurence(view,name):
r = sublime.Region(0)
max_rb = view.size()
while r.b < max_rb :
r = view.find(r'\b{}\b'.format(name),r.b)
# print('Found "{}" at {} (max={})'.format(name,r,max_rb))
if not r:
return
if 'comment' not in view.scope_name(r.a):
break;
view.window().focus_view(view)
sublimeutil.move_cursor(view,r.a)
######################################################################################
# Create a new buffer showing the hierarchy (sub-module instances) of current module #
hierarchyInfo = {'dict':{}, 'view':None,'fname':''}
class VerilogShowHierarchyCommand(sublime_plugin.TextCommand):
def run(self,edit):
mname = getModuleName(self.view)
txt = self.view.substr(sublime.Region(0, self.view.size()))
mi = verilogutil.parse_module(txt,mname,True)
if not mi:
print('[VerilogShowHierarchyCommand] Not inside a module !')
return
sublime.status_message("Show Hierarchy can take some time, please wait ...")
sublime.set_timeout_async(lambda mi=mi, w=self.view.window(), txt=txt: self.showHierarchy(mi,w,txt))
def showHierarchy(self,mi,w,txt):
# Save info in global for later access
global hierarchyInfo
hierarchyInfo['view'] = self.view
hierarchyInfo['fname'] = self.view.file_name()
# Create Dictionnary where each type is associated with a list of tuple (instance type, instance name)
self.d = {}
top_level = mi['name']
# Extract Symbol position
for x in self.view.symbols() :
if x[1] == top_level:
row,col = self.view.rowcol(x[0].a)
hierarchyInfo['fname'] += ':{}:{}'.format(row,col+2)
break
self.d[mi['name']] = [(x['type'],x['name']) for x in mi['inst']]
self.unresolved = []
li = [x['type'] for x in mi['inst']]
while li :
# print('Loop on list with {1} elements : {2}'.format(len(li),li))
li_next = []
for i in li:
if i not in self.d.keys() and i not in self.unresolved:
filelist = w.lookup_symbol_in_index(i)
if filelist:
for f in filelist:
fname = sublimeutil.normalize_fname(f[0])
mi = verilogutil.parse_module_file(fname,i,True)
if mi:
hierarchyInfo['dict'][mi['name']] = '{}:{}:{}'.format(fname,f[2][0],f[2][1])
break
# Not in project ? try in current file
else :
mi = verilogutil.parse_module(txt,i,True)
if mi:
hierarchyInfo['dict'][mi['name']] = self.view.file_name()
if mi:
li_next += [x['type'] for x in mi['inst']]
if mi['type'] not in ['interface']:
self.d[i] = [(x['type'],x['name']) for x in mi['inst']]
else:
self.unresolved.append(i)
li = list(set(li_next))
txt = top_level + '\n'
txt += self.printSubmodule(top_level,1)
nw = self.view.settings().get('sv.hierarchy_new_window',False)
if nw:
sublime.run_command('new_window')
w = sublime.active_window()
v = w.new_file()
v.settings().set("tab_size", 2)
v.set_name(top_level + ' Hierarchy')
v.set_syntax_file('Packages/SystemVerilog/Find Results SV.hidden-tmLanguage')
v.set_scratch(True)
v.run_command('insert_snippet',{'contents':str(txt)})
def printSubmodule(self,name,lvl):
txt = ''
if name in self.d:
# print('printSubmodule ' + str(self.d[name]))
for x in self.d[name]:
txt += ' '*lvl
if x[0] in self.d :
txt += '+ {name} ({type})\n'.format(name=x[1],type=x[0])
if lvl<20 :
txt += self.printSubmodule(x[0],lvl+1)
else:
ustr = ' [U]' if x[0] in self.unresolved else ''
txt += '- {name} ({type}){unresolved}\n'.format(name=x[1],type=x[0],unresolved=ustr)
return txt
# Navigate within the hierarchy
class VerilogHierarchyGotoDefinitionCommand(sublime_plugin.TextCommand):
def run(self,edit):
global hierarchyInfo
r = self.view.sel()[0]
if r.empty() :
r = self.view.word(r)
scope = self.view.scope_name(r.a)
fname = ''
inst_name = ''
# Not in the proper file ? use standard goto_definition to
if 'text.result-systemverilog' not in scope:
self.view.window().run_command('goto_definition')
return
if 'entity.name' in scope:
l = self.view.substr(self.view.line(r))
indent = (len(l) - len(l.lstrip()))-2
if indent<0:
print('[SV.navigation] Hierarchy buffer corrupted : Invalid position for an instance !')
return
elif indent == 0:
fname = hierarchyInfo['fname']
else:
w = ''
# find module parent name
txt = self.view.substr(sublime.Region(0,r.a))
m = re.findall(r'^{}\+ \w+\s+\((\w+)\)'.format(' '*indent),txt,re.MULTILINE)
if m:
inst_name = self.view.substr(r)
if m[-1] in hierarchyInfo['dict']:
fname = hierarchyInfo['dict'][m[-1]]
elif 'storage.name' in scope:
w = self.view.substr(r)
if w in hierarchyInfo['dict']:
fname = hierarchyInfo['dict'][w]
elif 'keyword.module' in scope:
fname = hierarchyInfo['fname']
if fname:
if not inst_name:
hierarchyInfo['view'].window().open_file(fname,sublime.ENCODED_POSITION)
else:
m = re.match(r'(.+)\:(\d+)\:(\d+)',fname)
fname_short = fname if not m else m.group(1)
v = hierarchyInfo['view'].window().find_open_file(fname_short)
if v :
hierarchyInfo['view'].window().focus_view(v)
self.goto_symb(v,inst_name)
else :
v = hierarchyInfo['view'].window().open_file(fname,sublime.ENCODED_POSITION)
global callbacks_on_load
callbacks_on_load[fname_short] = lambda v=v, inst_name=inst_name: self.goto_symb(v,inst_name)
def goto_symb(self,v,inst_name):
row=-1
for x in v.symbols() :
if x[1] == inst_name:
row,col = v.rowcol(x[0].a)
break
if row>=0:
sublimeutil.move_cursor(v,v.text_point(row,col))
######################################################################################
# Create a new buffer showing the class hierarchy (sub-class instances) of current class #
PHANTOM_TEMPLATE = """
<body id="sv-navbar">
<style>
html, body {{
margin: 0;
padding: 0;
background-color: transparent;
}}
a {{
text-decoration: none;
color: {1};
}}
.content {{color: {1};}}
</style>
<span class="content">{0}</span>
</body>
"""
def getObjList(view):
r = view.sel()[0]
p = r'(?s)^[ \t]*(?:virtual\s+)?(class|module|interface)\s+(\w+\b)'
nameList = []
r = view.find_all(p,0,r'\1 \2',nameList)
nl = []
for (r,n) in zip(r,nameList):
if 'comment' not in view.scope_name(r.a):
nl.append(n)
return nl
class VerilogShowNavbarCommand(sublime_plugin.TextCommand):
def run(self,edit):
objects = getObjList(self.view)
if not objects:
# print('[SV:NavBar] Not inside a module/interface/class !')
return
enable = self.view.settings().get('sv.navbar_update',15)
if objects[0][0] == 'class' and (enable & 1) == 0:
return
elif objects[0][0]== 'module' and (enable & 1) == 0:
return
elif (enable & 4) == 0:
return
sublime.set_timeout_async(lambda objects=objects: self.showHierarchy(objects))
def showHierarchy(self,objects):
# Save info in global for later access
info = {'view':None,'fname':''}
info['view'] = self.view
info['fname'] = self.view.file_name()
global navBar
w = sublime.active_window()
wid = w.id()
navbar_flag = w.settings().get('navbar-hdl-shared', 0)
# print('navbar_flag = {}'.format(navbar_flag))
if wid not in navBar :
l = w.get_layout()
nb_col = len(l['cols'])
if navbar_flag != 0:
if nb_col < 2:
navbar_flag = 0
else :
gid = len(l['cells'])-1
vl = w.views_in_group(gid)
if len(vl) == 1:
if not vl[0].name().endswith(' Hierarchy') :
navbar_flag = 0
else :
navbar_flag = 0
if navbar_flag == 0:
l['cols'].append(1.0)
width = self.view.settings().get('sv.navbar_width',0.2)