vhdl.kak (17947B)
1 # Based on IEEE Std 1076‐2019 2 3 # Detection 4 hook global BufCreate .*[.](vhd[l]?) %[ 5 set-option buffer filetype vhdl 6 ] 7 8 # Initialization 9 hook global WinSetOption filetype=vhdl %[ 10 require-module vhdl 11 set-option window static_words %opt{vhdl_static_words} 12 hook -group vhdl-indent window InsertChar \n vhdl-indent-on-new-line 13 hook -group vhdl-indent window InsertChar \) vhdl-indent-on-closing-parenthesis 14 hook -group vhdl-insert window InsertChar \n vhdl-insert-on-new-line 15 # Cleanup trailing whitespaces on current line insert end. 16 hook -group vhdl-trim-indent window ModeChange pop:insert:.* %[ try %[ execute-keys -draft <semicolon> x s ^\h+$ <ret> d ] ] 17 hook -once -always window WinSetOption filetype=.* %[ remove-hooks window vhdl-.+ ] 18 ] 19 20 hook -group vhdl-highlight global WinSetOption filetype=vhdl %[ 21 add-highlighter window/vhdl ref vhdl 22 hook -once -always window WinSetOption filetype=.* %[ remove-highlighter window/vhdl ] 23 ] 24 25 provide-module vhdl %§ 26 27 # Highlighters & Completion 28 add-highlighter shared/vhdl regions 29 add-highlighter shared/vhdl/code default-region group 30 add-highlighter shared/vhdl/comment_line region '--' $ fill comment 31 add-highlighter shared/vhdl/comment region /\* \*/ fill comment 32 33 # Integer formats 34 add-highlighter shared/vhdl/code/ regex '(?i)\b0b[01]+l?\b' 0:value 35 add-highlighter shared/vhdl/code/ regex '(?i)\b0x[\da-f]+l?\b' 0:value 36 add-highlighter shared/vhdl/code/ regex '(?i)\b0o?[0-7]+l?\b' 0:value 37 add-highlighter shared/vhdl/code/ regex '(?i)\b([1-9]\d*|0)l?\b' 0:value 38 # Float formats 39 add-highlighter shared/vhdl/code/ regex '\b\d+[eE][+-]?\d+\b' 0:value 40 add-highlighter shared/vhdl/code/ regex '(\b\d+)?\.\d+\b' 0:value 41 add-highlighter shared/vhdl/code/ regex '\b\d+\.' 0:value 42 # Imaginary formats 43 add-highlighter shared/vhdl/code/ regex '\b\d+\+\d+[jJ]\b' 0:value 44 45 evaluate-commands %sh[ 46 values="true false note warning error failure nul" 47 48 # LRM 5.2.4.1 49 units="fs ps ns us ms sec min hr Å nm um mm cm m km" 50 51 # LRM 16.2 52 predefined_attributes=" 53 base left right high low ascending length range reverse_range 54 subtype image pos succ pred leftof rightof value val 55 designated_subtype reflect high low index element delayed 56 stable quiet transaction event active last_event last_active 57 last_value driving driving_value simple_name instance_name 58 path_name record signal converse 59 " 60 61 libraries="ieee std work" 62 63 packages=" 64 math_real math_complex std_logic_1164 std_logic_textio numeric_bit numeric_std 65 numeric_bit_unsigned numeric_std_unsigned fixed_float_types fixed_generic_pkg 66 fixed_pkg float_generic_pkg float_pkg 67 standard textio env 68 " 69 70 # LRM 15.10 71 reserved_words=" 72 abs access after alias all and architecture array assert assume assume_guarantee attribute 73 begin block body buffer bus 74 case component configuration constant context cover 75 default disconnect downto 76 else elsif end entity exit 77 fairness file for force function 78 generate generic group guarded 79 if impure in inertial inout is 80 label library linkage literal loop 81 map mod 82 nand new next nor not null 83 of on open or others out 84 package parameter port postponed procedure process property protected pure 85 range record register reject release rem report restrict restrict_guarantee return rol ror 86 select sequence severity signal shared sla sll sra srl strong subtype 87 then to transport type 88 unaffected units until use 89 variable view vpkg vmode vprop vunit 90 wait when while with 91 xnor xor 92 " 93 94 types=" 95 bit bit_vector 96 boolean boolean_vector 97 character 98 file_open_state file_origin_kind 99 integer integer_vector 100 natural positive 101 line line_vector 102 real real_vector 103 std_logic std_logic_vector 104 std_ulogic std_ulogic_vector 105 side 106 signed unsigned 107 string text 108 time time_vector 109 " 110 111 functions=" 112 find_leftmost find_rightmost divide reciprocal remainder modulo minimum maximum 113 std_match add_carry scalb 114 resize to_ufixed to_sfixed to_unsigned to_signed to_real to_integer to_slv 115 to_std_logic_vector to_stdlogicvector to_sulv to_std_ulogic_vector to_std_ulogicvector 116 to_01 is_x to_x01 to_ux01 to_x01z 117 ufixed_high ufixed_low sfixed_high sfixed_low to_ufix to_sfix ufix_high ufix_low 118 sfix_high sfix_low 119 write read bwrite binary_write bread binary_read owrite oread octal_write octal_read 120 hwrite hread hex_write hex_read to_string to_bstring to_binary_string to_ostring 121 to_octal_string to_hstring to_hex_string from_string from_bstring from_binary_string 122 from_ostring from_octal_string from_hstring from_hex_string 123 rising_edge falling_edge 124 " 125 126 join() { sep=$2; eval set -- $1; IFS="$sep"; echo "$*"; } 127 128 # Add the language's grammar to the static completion list 129 printf %s\\n "declare-option str-list vhdl_static_words $(join "${values} ${units} ${predefined_attributes} ${libraries} ${packages} ${reserved_words} ${types} ${functions}" ' ')" 130 131 # Highlight keywords 132 printf %s " 133 add-highlighter shared/vhdl/code/ regex '(?i)\b($(join "${values}" '|'))\b' 0:value 134 add-highlighter shared/vhdl/code/ regex '(?i)\b($(join "${units}" '|'))\b' 0:meta 135 add-highlighter shared/vhdl/code/ regex \"'(?i)\b($(join "${predefined_attributes}" '|'))\b\" 0:attribute 136 add-highlighter shared/vhdl/code/ regex '(?i)\b($(join "${libraries}" '|'))\b' 0:builtin 137 add-highlighter shared/vhdl/code/ regex '(?i)\b($(join "${packages}" '|'))\b' 0:builtin 138 add-highlighter shared/vhdl/code/ regex '(?i)\b($(join "${reserved_words}" '|'))\b' 0:keyword 139 add-highlighter shared/vhdl/code/ regex '(?i)\b($(join "${functions}" '|'))\b\(' 1:builtin 140 add-highlighter shared/vhdl/code/ regex '(?i)\b($(join "${types}" '|'))\b' 0:type 141 add-highlighter shared/vhdl/code/ regex '^\h*(@[\w_.]+))' 1:attribute 142 " 143 ] 144 145 add-highlighter shared/vhdl/code/ regex \(|\)|\;|\.|,|:|\| 0:attribute 146 147 add-highlighter shared/vhdl/code/ regex \?\?|=|/=|<|<=|>|>=|\?=|\?/=|\?<|\?<=|\?>|\?>=|\+|-|&|\*|/|:= 0:operator 148 149 # Meta values highlight. 150 # The values 'U', 'X', 'W', and '–' are metalogical values; they define the behavior of the model itself rather than the behavior of the hardware being synthesized. 151 add-highlighter shared/vhdl/code/ regex "(?i)'[U|X|W|-]'" 0:meta 152 # Highlight other logical values. 153 add-highlighter shared/vhdl/code/ regex "(?i)'[0|1|Z|L|H]'" 0:value 154 155 # String 156 add-highlighter shared/vhdl/code/ regex '"[^"]*"' 0:string 157 158 # Binary vector. 159 add-highlighter shared/vhdl/code/ regex '[bB]"[01_]*"' 0:value 160 161 # Octal vector. 162 add-highlighter shared/vhdl/code/ regex '[oO]"[01234567_]*"' 0:value 163 164 # Hex vector. 165 add-highlighter shared/vhdl/code/ regex '(?i)x"[0123456789abcdef_]*"' 0:value 166 167 define-command -hidden vhdl-insert-on-new-line %[ 168 # Handle comment lines. 169 evaluate-commands -itersel %[ 170 # Copy '--' comment prefix and following white spaces. 171 try %[ 172 # <a-lt> is needed because of "Preserve previous line indent" command. 173 try %[ execute-keys -draft k x s ^\h*--\h* <ret> y j <a-lt> gh P ] 174 ] 175 ] 176 177 evaluate-commands -save-regs x %[ 178 # Save previous line indent in register x. 179 try %[ execute-keys -draft kxs^\h+<ret>"xy ] catch %[ reg x '' ] 180 181 # All "wisely add" commands share the same concept. 182 # Only "end if" has extra comments. 183 # Wisely add "end if;". 184 evaluate-commands %[ 185 try %[ 186 # Validate previous line and that it is not closed yet. 187 execute-keys -draft kx <a-k>^\h*(?i)((then|(.*:\h*)?if\b.*\bthen)$)<ret> j}ijx <a-K>^<c-r>x(?i)(elsif|else|end)\b<ret> 188 # Don't add for "if ... generate", it requires "end generate;". 189 execute-keys -draft kx <a-K>(?i)\bgenerate\b<ret> 190 execute-keys -draft o<c-r>xend<space>if<semicolon><esc> 191 ] 192 ] 193 # Wisely add "end generate;". 194 evaluate-commands %[ 195 try %[ 196 execute-keys -draft kx <a-k>^\h*(?i).*\bgenerate$<ret> j}ijx <a-K>^<c-r>x(?i)(begin|elsif|else|end)\b<ret> 197 # Don't add in case of comment line. 198 execute-keys -draft kx <a-K>^\h*--<ret> 199 execute-keys -draft o<c-r>xend<space>generate<semicolon><esc> 200 ] 201 ] 202 # Wisely add "when" and "end case;". 203 evaluate-commands %[ 204 try %[ 205 # TODO: Case needs special handling. 206 execute-keys -draft kx <a-k>^\h*(?i)(case|.*\h*:\h*case)\b<ret> jwx <a-K>^<c-r>x(?i)(end|when)<ret> 207 execute-keys -draft <c-r>xo<c-r>xend<space>case<semicolon><esc>kAwhen<space><esc> 208 ] 209 ] 210 # Wisely add "begin" and "end block;". 211 evaluate-commands %[ 212 try %[ 213 execute-keys -draft kx <a-k>^\h*(?i)((block|.*:\h*block)\b)<ret> j}ijx <a-K>^<c-r>x(?i)(begin|end)\b<ret> 214 execute-keys -draft o<c-r>xbegin<ret><c-r>xend<space>block<semicolon><esc> 215 ] 216 ] 217 # Wisely add "begin" and "end process;". 218 evaluate-commands %[ 219 try %[ 220 execute-keys -draft kx <a-k>^\h*(?i)(.*:\h*)?(postponed\h+)?process\b<ret> j}ijx <a-K>^<c-r>x(?i)(begin|end)<ret> 221 execute-keys -draft o<c-r>xbegin<ret><c-r>xend<space>process<semicolon><esc> 222 ] 223 ] 224 # Wisely add "end loop;". 225 evaluate-commands %[ 226 try %[ 227 execute-keys -draft kx <a-k>^\h*(?i)(.*\bloop|.*\h*:\h*(for|loop))$<ret> j}ijx <a-K>^<c-r>x(?i)(end)<ret> 228 execute-keys -draft o<c-r>xend<space>loop<semicolon><esc> 229 ] 230 ] 231 # Wisely add "end protected;". 232 evaluate-commands %[ 233 try %[ 234 execute-keys -draft kx <a-k>^\h*(?i)(type\b.*\bis\h+protected)$<ret> j}ijx <a-K>^<c-r>x(?i)(end)<ret> 235 execute-keys -draft o<c-r>xend<space>protected<semicolon><esc> 236 ] 237 ] 238 # Wisely add "end protected body;". 239 evaluate-commands %[ 240 try %[ 241 execute-keys -draft kx <a-k>^(?i)(\h*type\h+\w+\h+is\h+protected\h+body$)<ret> j}ijx <a-K>^<c-r>x(?i)end\h+protected\h+body\b<ret> 242 execute-keys -draft o<c-r>xend<space>protected<space>body<semicolon><esc> 243 ] 244 ] 245 # Wisely add "end record;". 246 evaluate-commands %[ 247 try %[ 248 execute-keys -draft kx <a-k>^\h*(?i)(type\b.*\bis\h+record\h*)$<ret> j}ijx <a-K>^<c-r>x(?i)(end)<ret> 249 execute-keys -draft o<c-r>xend<space>record<semicolon><esc> 250 ] 251 ] 252 # Wisely add ");" for "type ... is (". 253 evaluate-commands %[ 254 try %[ 255 execute-keys -draft kx <a-k>^\h*(?i)(type\b.*\bis\h+\(\h*)$<ret> j}ijx <a-K>^<c-r>x(\))<ret> 256 execute-keys -draft o<c-r>x)<semicolon><esc> 257 ] 258 ] 259 # Wisely add "end entity;". 260 evaluate-commands %[ 261 try %[ 262 execute-keys -draft kx <a-k>^(?i)\h*entity\b.*\bis$<ret> j}ijx <a-K>^<c-r>x(?i)(begin|end)\b<ret> 263 execute-keys -draft o<c-r>xend<space>entity<semicolon><esc> 264 ] 265 ] 266 # Wisely add "begin" and "end function;". 267 evaluate-commands %[ 268 try %[ 269 execute-keys -draft kx <a-k>^(?i)(\h*\)?\h*return\b.*\bis$)<ret> j}ijx <a-K>^<c-r>x(?i)(begin|end)\b<ret> 270 execute-keys -draft o<c-r>xbegin<ret><c-r>xend<space>function<semicolon><esc> 271 ] 272 try %[ 273 execute-keys -draft kx <a-k>^(?i)(\h*((pure|impure)\h+)?function\b.*\bis$)<ret> j}ijx <a-K>^<c-r>x(?i)(begin|end)\b<ret> 274 execute-keys -draft o<c-r>xbegin<ret><c-r>xend<space>function<semicolon><esc> 275 ] 276 ] 277 # Wisely add "begin" and "end procedure;". 278 evaluate-commands %[ 279 try %[ 280 execute-keys -draft kx <a-k>^(?i)(\h*procedure\b.*\bis$)<ret> j}ijx <a-K>^<c-r>x(?i)\b(begin|end)\b<ret> 281 execute-keys -draft o<c-r>xbegin<ret><c-r>xend<space>procedure<semicolon><esc> 282 ] 283 try %[ 284 execute-keys -draft kx <a-k>^(?i)\h*\)\h*\bis$<ret> j}ijx <a-K>^<c-r>x(?i)\b(begin|end)\b<ret> 285 # Verify that line with opening parenthesis contains "procedure" keyword. 286 execute-keys -draft kx s\)<ret> <a-m><semicolon> x<a-k> (?i)\bprocedure\b<ret> 287 execute-keys -draft o<c-r>xbegin<ret><c-r>xend<space>procedure<semicolon><esc> 288 ] 289 ] 290 # Wisely add "end package;". 291 evaluate-commands %[ 292 try %[ 293 execute-keys -draft kx <a-k>^(?i)(package\b)<ret> j}ijx <a-K>^<c-r>x(?i)(end)\b<ret> 294 # Make sure it is not package body. 295 execute-keys -draft kx<a-K>(?i)\bbody\b<ret> 296 execute-keys -draft oend<space>package<semicolon><esc> 297 ] 298 ] 299 # Wisely add "end package body;". 300 evaluate-commands %[ 301 try %[ 302 execute-keys -draft kx <a-k>^(?i)(package\h+body\b)<ret> j}ijx <a-K>^<c-r>x(?i)(end)\b<ret> 303 execute-keys -draft oend<space>package<space>body<semicolon><esc> 304 ] 305 ] 306 # Wisely add "begin" and "end architecture;". 307 evaluate-commands %[ 308 try %[ 309 execute-keys -draft kx <a-k>^(?i)\h*architecture\b<ret> j}ijx <a-K>^<c-r>x(?i)(begin|end)\b<ret> 310 execute-keys -draft o<c-r>xbegin<ret><c-r>xend<space>architecture<semicolon><esc> 311 ] 312 ] 313 # Wisely add ");" for "port (". 314 evaluate-commands %[ 315 try %[ 316 execute-keys -draft kx <a-k>^\h*(?i)port\h*\($<ret> j}ijx <a-K>^<c-r>x(\)\;)<ret> 317 execute-keys -draft o<c-r>x)<semicolon><esc> 318 ] 319 ] 320 # Wisely add ");" for "port map (". 321 evaluate-commands %[ 322 try %[ 323 execute-keys -draft kx <a-k>^\h*(?i)port\h+map\h*\($<ret> j}ijx <a-K>^<c-r>x(\)\;)<ret> 324 execute-keys -draft o<c-r>x)<semicolon><esc> 325 ] 326 ] 327 # Wisely add ");" for "generic (". 328 evaluate-commands %[ 329 try %[ 330 execute-keys -draft kx <a-k>^\h*(?i)generic\h*\($<ret> j}ijx <a-K>^<c-r>x(\)\;)<ret> 331 execute-keys -draft o<c-r>x)<semicolon><esc> 332 ] 333 ] 334 # Wisely add ")" for "generic map (". 335 evaluate-commands %[ 336 try %[ 337 execute-keys -draft kx <a-k>^\h*(?i)generic\h+map\h*\($<ret> j}ijx <a-K>^<c-r>x(\))<ret> 338 execute-keys -draft o<c-r>x)<esc> 339 ] 340 ] 341 # Wisely add ") return ;" for "[pure|impure] function ... (". 342 evaluate-commands %[ 343 try %[ 344 execute-keys -draft kx <a-k>^\h*(?i)(pure\b|impure\b)?\h*function\b.*\h*\($<ret> j}ijx <a-K>^<c-r>x(\)\h*return.*)<ret> 345 execute-keys -draft o<c-r>x)<space>return<space><semicolon><esc> 346 ] 347 ] 348 # Wisely add ");" for "procedure ... (". 349 evaluate-commands %[ 350 try %[ 351 execute-keys -draft kx <a-k>^\h*(?i)procedure\b.*\h*\($<ret> j}ijx <a-K>^<c-r>x(\)\h*\;)<ret> 352 execute-keys -draft o<c-r>x)<semicolon><esc> 353 ] 354 ] 355 ] 356 ] 357 358 define-command -hidden vhdl-indent-on-new-line %{ 359 evaluate-commands -itersel %{ 360 # Align "then" to previous "if|elsif". 361 evaluate-commands -itersel -save-regs x %[ 362 try %[ 363 execute-keys -draft k x <a-k> (?i)^\h*then$ <ret> 364 try %[ execute-keys -draft <a-/>(?i)\b(if|elsif)\b<ret>xs^\h+<ret>"xy ] catch %[ reg x '' ] 365 try %[ execute-keys -draft k xs^\h+<ret>d ] catch %[ ] 366 execute-keys -draft kgh i<c-r>x<esc> 367 ] 368 ] 369 370 # Align "generate" to previous "if|for". 371 evaluate-commands -itersel -save-regs x %[ 372 try %[ 373 execute-keys -draft k x <a-k> (?i)^\h*generate$ <ret> 374 try %[ execute-keys -draft <a-/>(?i)\b(if|for)\b<ret>xs^\h+<ret>"xy ] catch %[ reg x '' ] 375 try %[ execute-keys -draft k xs^\h+<ret>d ] catch %[ ] 376 execute-keys -draft kgh i<c-r>x<esc> 377 ] 378 ] 379 380 # Preserve previous line indent. 381 try %[ execute-keys -draft <semicolon> K <a-&> ] 382 383 # Cleanup trailing whitespaces from previous line. 384 try %[ execute-keys -draft k x s \h+$ <ret> d ] 385 386 # Increase indent after some keywords. 387 try %[ 388 execute-keys -draft kx<a-k> (?i)\b(begin|block|body|else|for|generate|if|is|loop|process|protected|record|select|then)$ <ret> 389 # Do not indent if in comment line. 390 execute-keys -draft kx<a-K>(?i)^\h*--<ret> 391 # Do not indent for "case ... is". 392 execute-keys -draft kx<a-K>^\h*(?i)(case|.*\h*:\h*case)\b<ret> 393 execute-keys -draft <semicolon> <a-gt> 394 ] 395 # Copy the indentation of the matching if. 396 try %{ execute-keys -draft , k x <a-k> ^\h*(elsif\b|else$) <ret> gh [c^\h*(\S*\h*:\h*)?if\b,\bend\sif\b <ret> x <a-S> 1<a-&> , j K <a-&> } 397 398 # Increase indent after some operators. 399 try %[ execute-keys -draft <semicolon> k x <a-k> (\(|=>|<=|:=)$ <ret> j <a-gt> ] 400 } 401 } 402 403 define-command vhdl-indent-on-closing-parenthesis %[ 404 evaluate-commands -itersel %[ 405 # Decrease indent after ")" at the beginning of line. 406 try %[ execute-keys -draft x <a-k> (^\h+\)$) <ret> <a-lt> ] 407 ] 408 ] 409 410 §