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
|
################################################################################################
# Copyright (c) 2006-2010 Trevor Williams #
# #
# This program is free software; you can redistribute it and/or modify #
# it under the terms of the GNU General Public License as published by the Free Software #
# Foundation; either version 2 of the License, or (at your option) any later version. #
# #
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; #
# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. #
# See the GNU General Public License for more details. #
# #
# You should have received a copy of the GNU General Public License along with this program; #
# if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. #
################################################################################################
# Highlight color values (this will need to be configurable via the preferences window
set vlog_hl_mode on
set vlog_hl_ppkeyword_color ForestGreen
set vlog_hl_keyword_color purple
set vlog_hl_comment_color blue
set vlog_hl_value_color red
set vlog_hl_string_color red
set vlog_hl_symbol_color coral
# Performs substitution using a user-specified command
proc regsub-eval {re string cmd} {
subst [regsub $re [string map {\[ \\[ \] \\] \$ \\$ \\ \\\\} $string] "\[$cmd\]"]
}
# Postprocesses a specified Verilog file that contains `line directives from preprocessor
proc postprocess_verilog {fname} {
global fileContent
set contents [split $fileContent($fname) \n]
set linenum 1
set newContent {}
foreach line $contents {
set pattern "`line\\s+(\\d+)\\s+\"$fname\""
if {[regexp "$pattern" $line -> linenum] == 0} {
set newContent [linsert $newContent [expr $linenum - 1] $line]
incr linenum
}
}
# Recreate the new file content
set fileContent($fname) [join $newContent "\n"]
}
# Main function called to read in the contents of the specified filename into
# the fileContent array.
proc load_verilog {fname pp} {
global fileContent
set retval 1
# Save off current directory
set cwd [pwd]
# Set current working directory to the score directory
if {[catch "cd [tcl_func_get_score_path]" eid]} {
tk_messageBox -default ok -icon error -message $eid -parent . -type ok
set retval 0
} else {
if {[catch {set fileText $fileContent($fname)}]} {
if {$pp} {
set tmpname [tcl_func_preprocess_verilog $fname]
} else {
set tmpname $fname
}
if {[catch {set fp [open $tmpname "r"]}]} {
tk_messageBox -message "File $fname Not Found!" -title "No File" -icon error
set retval 0
}
set fileContent($fname) [read $fp]
close $fp
if {$pp} {
file delete -force $tmpname
}
postprocess_verilog $fname
}
# Return current working directory
cd $cwd
}
return $retval
}
# Creates the include_enter, include_button and include_leave tags for the specified textbox,
# underlining the filenames of all included files.
# - tb = pathname to textbox
# - inform = pathname to information window
# - cmd = Name of command to call when an indices is selected by the user -- must take one argument: the name of the selected file
proc handle_verilog_includes {tb inform cmd} {
global cov_fgColor
global curr_cursor curr_info curr_cmd curr_inform
# Iterate through all found `include directives, creating a tag that will underline all of these
set start_index 1.0
set matching_chars ""
set include_indices ""
set curr_cmd($tb) $cmd
set curr_inform($tb) $inform
# Find all include directives and add their indices to the list
while 1 {
set start_index [$tb search "`include" $start_index end]
if {$start_index != ""} {
set start_index [$tb index "[$tb search -count matching_chars -regexp {\".*\"} $start_index] + 1 chars"]
set end_index [$tb index "$start_index + [expr $matching_chars - 2] chars"]
lappend include_indices $start_index $end_index
set start_index "$start_index + 1 chars"
} else {
break
}
}
# Remove all include tags
$tb tag delete include_enter include_button include_leave
if {$include_indices != ""} {
eval "$tb tag add include_enter $include_indices"
eval "$tb tag add include_button $include_indices"
eval "$tb tag add include_leave $include_indices"
# Configure the include_button tag
$tb tag configure include_button -underline true
# Bind the include_enter tag
$tb tag bind include_enter <Enter> {
set curr_cursor [%W cget -cursor]
set curr_info [$curr_inform(%W) cget -text]
%W configure -cursor hand2
$curr_inform(%W) configure -text "Click left button to view this included file"
}
# Bind the include_leave tag
$tb tag bind include_leave <Leave> {
%W configure -cursor $curr_cursor
$curr_inform(%W) configure -text $curr_info
}
# Bind the include_button tag
$tb tag bind include_button <ButtonPress-1> {
%W configure -cursor $curr_cursor
$curr_inform(%W) configure -text $curr_info
eval $curr_cmd(%W) [tcl_func_get_include_pathname [eval "%W get [%W tag prevrange include_button {current + 1 chars}]"]]
}
}
}
# Finds all comments in the specified textbox and highlights them with the given color
proc verilog_highlight_comments {tb color} {
set start_index 1.0
set ilist ""
# Handle all single line comments first
while 1 {
set start_index [$tb search "//" $start_index end]
if {$start_index != ""} {
set end_index [$tb index "[lindex [split $start_index .] 0].end"]
lappend ilist $start_index $end_index
set start_index "$end_index + 1 chars"
} else {
break
}
}
# Handle all multi-line comments
set start_index 1.0
while 1 {
set start_index [$tb search "/*" $start_index end]
if {$start_index != ""} {
set end_index [$tb search "*/" "$start_index + 1 chars" end]
if {$end_index == ""} {
set end_index [$tb index end]
}
lappend ilist $start_index $end_index
set start_index "$end_index + 1 chars"
} else {
break
}
}
if {$ilist != ""} {
eval "$tb tag add comment_highlights $ilist"
# Configure the comment_highlights tag
$tb tag configure comment_highlights -foreground $color
}
}
# Finds all preprocessor keywords in the specified textbox and highlights them with the given color
proc verilog_highlight_ppkeywords {tb color} {
# Create list of all preprocessor directives
set directives [list "`line" "`define" "`include" "`ifdef" "`ifndef" "`undef" "`else" "`elseif" "`timescale" "`endif"]
set ilist ""
foreach directive $directives {
set start_index 1.0
set len [string length $directive]
set match_str ""
append match_str $directive {($|[^a-zA-Z0-9_])}
# Find all preprocessor directives and add their indices to the list
while 1 {
set start_index [$tb search -regexp $match_str $start_index end]
if {$start_index != ""} {
set end_index [$tb index "$start_index + $len chars"]
lappend ilist $start_index $end_index
set start_index "$start_index + 1 chars"
} else {
break
}
}
}
if {$ilist != ""} {
eval "$tb tag add ppkeyword_highlights $ilist"
# Configure the ppkeyword_highlights tag
$tb tag configure ppkeyword_highlights -foreground $color
}
}
# Finds all preprocessor keywords in the specified textbox and highlights them with the given color
proc verilog_highlight_keywords {tb color} {
global curr_block
# Create list of all language keywords
set v1995_keywords [list always and assign begin buf bufif0 bufif1 case casex casez cmos deassign default defparam disable edge else end \
endcase endfunction endmodule endprimitive endspecify endtable endtask event for force forever fork function \
highz0 highz1 if initial inout input integer join large localparam macromodule medium module nand negedge nmos \
nor not notif0 notif1 or output parameter pmos posedge primitive pull0 pull1 pulldown pullup rcmos real realtime \
reg release repeat rnmos rpmos rtran rtranif0 rtranif1 scalered signed small specify specparam strong0 strong1 \
supply0 supply1 table task time tran tranif0 tranif1 tri tri0 tri1 triand trior trireg vectored wait wand weak0 \
weak1 while wire wor xnor xor]
set v2001_keywords [list automatic cell config design endconfig endgenerate generate genvar instance liblist library localparam \
noshowcancelled pulsestyle_onevent pulsestyle_ondetect showcancelled use]
set sv_keywords [list always_comb always_ff always_latch assert bool bit break byte char continue cover do endprogram endproperty \
endsequence enum final int logic longint packed priority program property return sequence shortint struct \
typedef union unique unsigned void]
set ilist ""
# Create full list based on user-specified generation
set generation [tcl_func_get_generation [tcl_func_get_funit_name $curr_block]]
if {$generation == 3} {
set keywords [concat $v1995_keywords $v2001_keywords $sv_keywords]
} elseif {$generation == 2} {
set keywords [concat $v1995_keywords $v2001_keywords]
} else {
set keywords $v1995_keywords
}
foreach keyword $keywords {
set start_index 1.0
set len [string length $keyword]
set match_str ""
append match_str {(^|[^a-zA-Z0-9_`])} $keyword {($|[^a-zA-Z0-9_])}
# Find all preprocessor directives and add their indices to the list
while 1 {
set start_index [$tb search -count matching_chars -regexp $match_str $start_index end]
if {$start_index != ""} {
if {[$tb get $start_index] != [string index $keyword 0]} {
set start_index [$tb index "$start_index + 1 chars"]
}
set end_index [$tb index "$start_index + $len chars"]
lappend ilist $start_index $end_index
set start_index "$start_index + 1 chars"
} else {
break
}
}
}
if {$ilist != ""} {
eval "$tb tag add keyword_highlights $ilist"
# Configure the keyword_highlights tag
$tb tag configure keyword_highlights -foreground $color
}
}
# Finds all defined and constant values in the specified textbox and highlights them with the given color
proc verilog_highlight_values {tb color} {
set ilist ""
# Highlight all numeric values
set start_index 1.0
while 1 {
set start_index [$tb search -count matching_chars -regexp {(^|[^a-zA-Z0-9_])[0-9]+($|[^a-zA-Z0-9_])} $start_index end]
if {$start_index != ""} {
set start_index [$tb index "$start_index + 1 chars"]
set end_index [$tb index "$start_index + [expr $matching_chars - 2] chars"]
lappend ilist $start_index $end_index
set start_index "$end_index + 1 chars"
} else {
break
}
}
set start_index 1.0
while 1 {
set start_index [$tb search -count matching_chars -regexp {[0-9_]*[ \t]*'[sS]?[dDbBoOhH][0-9_a-fA-F]+} $start_index end]
if {$start_index != ""} {
set end_index [$tb index "$start_index + $matching_chars chars"]
lappend ilist $start_index $end_index
set start_index "$end_index + 1 chars"
} else {
break
}
}
# Highlight all defined values
set start_index 1.0
while 1 {
set start_index [$tb search -count matching_chars -regexp {`[a-zA-Z0-9_]+} $start_index end]
if {$start_index != ""} {
set end_index [$tb index "$start_index + $matching_chars chars"]
lappend ilist $start_index $end_index
set start_index "$end_index + 1 chars"
} else {
break
}
}
if {$ilist != ""} {
eval "$tb tag add value_highlights $ilist"
# Configure the value_highlights tag
$tb tag configure value_highlights -foreground $color
}
}
# Finds all string values in the specified textbox and highlights them with the given color
proc verilog_highlight_strings {tb color} {
set start_index 1.0
set ilist ""
while 1 {
set start_index [$tb search \" $start_index end]
if {$start_index != ""} {
set end_index [$tb search \" "$start_index + 1 chars" end]
if {$end_index == ""} {
set end_index end
} else {
set end_index [$tb index "$end_index + 1 chars"]
}
lappend ilist $start_index $end_index
set start_index "$end_index + 1 chars"
} else {
break
}
}
if {$ilist != ""} {
eval "$tb tag add string_highlights $ilist"
# Configure the comment_highlights tag
$tb tag configure string_highlights -foreground $color
}
}
# Highlights all symbols in the specified textbox with the given color
proc verilog_highlight_symbols {tb color} {
set start_index 1.0
set ilist ""
while 1 {
set start_index [$tb search -regexp {[\}\{;:\[\],()#=.@&!?<>%|^~+*/-]} $start_index end]
if {$start_index != ""} {
set end_index [$tb index "$start_index + 1 chars"]
lappend ilist $start_index $end_index
set start_index $end_index
} else {
break
}
}
if {$ilist != ""} {
eval "$tb tag add symbol_highlights $ilist"
# Configure the symbol_highlights tag
$tb tag configure symbol_highlights -foreground $color
}
}
# Main function to highlight all Verilog syntax for the given textbox
proc verilog_highlight {tb} {
global vlog_hl_mode
global vlog_hl_keyword_color vlog_hl_comment_color vlog_hl_ppkeyword_color
global vlog_hl_value_color vlog_hl_string_color vlog_hl_symbol_color
if {$vlog_hl_mode == "on"} {
# Highlight all keywords
verilog_highlight_keywords $tb $vlog_hl_keyword_color
# Highlight all values
verilog_highlight_values $tb $vlog_hl_value_color
# Highlight all preprocessor keywords
verilog_highlight_ppkeywords $tb $vlog_hl_ppkeyword_color
# Highlight all symbols
verilog_highlight_symbols $tb $vlog_hl_symbol_color
# Highlight all string
verilog_highlight_strings $tb $vlog_hl_string_color
# Highlight all comments
verilog_highlight_comments $tb $vlog_hl_comment_color
} else {
# Delete any current syntax highlighting tags
$tb tag delete ppkeyword_highlights
$tb tag delete keyword_highlights
$tb tag delete comment_highlights
$tb tag delete string_highlights
$tb tag delete value_highlights
$tb tag delete symbol_highlights
}
}
|