/usr/share/tcltk/tcllib1.17/html/html.tcl is in tcllib 1.17-dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 | # html.tcl --
#
# Procedures to make generating HTML easier.
#
# This module depends on the ncgi module for the procedures
# that initialize form elements based on current CGI values.
#
# Copyright (c) 1998-2000 by Ajuba Solutions.
# Copyright (c) 2006 Michael Schlenker <mic42@users.sourceforge.net>
#
# See the file "license.terms" for information on usage and redistribution
# of this file, and for a DISCLAIMER OF ALL WARRANTIES.
#
# Originally by Brent Welch, with help from Dan Kuchler and Melissa Chawla
package require Tcl 8.2
package require ncgi
package provide html 1.4.4
namespace eval ::html {
# State about the current page
variable page
# A simple set of global defaults for tag parameters is implemented
# by storing into elements indexed by "key.param", where key is
# often the name of an HTML tag (anything for scoping), and
# param must be the name of the HTML tag parameter (e.g., "href" or "size")
# input.size
# body.bgcolor
# body.text
# font.face
# font.size
# font.color
variable defaults
array set defaults {
input.size 45
body.bgcolor white
body.text black
}
# In order to nandle nested calls to redefined control structures,
# we need a temporary variable that is known not to exist. We keep this
# counter to append to the varname. Each time we need a temporary
# variable, we increment this counter.
variable randVar 0
# No more export, because this defines things like
# foreach and if that do HTML things, not Tcl control
# namespace export *
# Dictionary mapping from special characters to their entities.
variable entities {
\xa0 \xa1 ¡ \xa2 ¢ \xa3 £ \xa4 ¤
\xa5 ¥ \xa6 ¦ \xa7 § \xa8 ¨ \xa9 ©
\xaa ª \xab « \xac ¬ \xad ­ \xae ®
\xaf ¯ \xb0 ° \xb1 ± \xb2 ² \xb3 ³
\xb4 ´ \xb5 µ \xb6 ¶ \xb7 · \xb8 ¸
\xb9 ¹ \xba º \xbb » \xbc ¼ \xbd ½
\xbe ¾ \xbf ¿ \xc0 À \xc1 Á \xc2 Â
\xc3 Ã \xc4 Ä \xc5 Å \xc6 Æ \xc7 Ç
\xc8 È \xc9 É \xca Ê \xcb Ë \xcc Ì
\xcd Í \xce Î \xcf Ï \xd0 Ð \xd1 Ñ
\xd2 Ò \xd3 Ó \xd4 Ô \xd5 Õ \xd6 Ö
\xd7 × \xd8 Ø \xd9 Ù \xda Ú \xdb Û
\xdc Ü \xdd Ý \xde Þ \xdf ß \xe0 à
\xe1 á \xe2 â \xe3 ã \xe4 ä \xe5 å
\xe6 æ \xe7 ç \xe8 è \xe9 é \xea ê
\xeb ë \xec ì \xed í \xee î \xef ï
\xf0 ð \xf1 ñ \xf2 ò \xf3 ó \xf4 ô
\xf5 õ \xf6 ö \xf7 ÷ \xf8 ø \xf9 ù
\xfa ú \xfb û \xfc ü \xfd ý \xfe þ
\xff ÿ \u192 ƒ \u391 Α \u392 Β \u393 Γ
\u394 Δ \u395 Ε \u396 Ζ \u397 Η \u398 Θ
\u399 Ι \u39A Κ \u39B Λ \u39C Μ \u39D Ν
\u39E Ξ \u39F Ο \u3A0 Π \u3A1 Ρ \u3A3 Σ
\u3A4 Τ \u3A5 Υ \u3A6 Φ \u3A7 Χ \u3A8 Ψ
\u3A9 Ω \u3B1 α \u3B2 β \u3B3 γ \u3B4 δ
\u3B5 ε \u3B6 ζ \u3B7 η \u3B8 θ \u3B9 ι
\u3BA κ \u3BB λ \u3BC μ \u3BD ν \u3BE ξ
\u3BF ο \u3C0 π \u3C1 ρ \u3C2 ς \u3C3 σ
\u3C4 τ \u3C5 υ \u3C6 φ \u3C7 χ \u3C8 ψ
\u3C9 ω \u3D1 ϑ \u3D2 ϒ \u3D6 ϖ
\u2022 • \u2026 … \u2032 ′ \u2033 ″
\u203E ‾ \u2044 ⁄ \u2118 ℘ \u2111 ℑ
\u211C ℜ \u2122 ™ \u2135 ℵ \u2190 ←
\u2191 ↑ \u2192 → \u2193 ↓ \u2194 ↔ \u21B5 ↵
\u21D0 ⇐ \u21D1 ⇑ \u21D2 ⇒ \u21D3 ⇓ \u21D4 ⇔
\u2200 ∀ \u2202 ∂ \u2203 ∃ \u2205 ∅
\u2207 ∇ \u2208 ∈ \u2209 ∉ \u220B ∋ \u220F ∏
\u2211 ∑ \u2212 − \u2217 ∗ \u221A √
\u221D ∝ \u221E ∞ \u2220 ∠ \u2227 ∧ \u2228 ∨
\u2229 ∩ \u222A ∪ \u222B ∫ \u2234 ∴ \u223C ∼
\u2245 ≅ \u2248 ≈ \u2260 ≠ \u2261 ≡ \u2264 ≤
\u2265 ≥ \u2282 ⊂ \u2283 ⊃ \u2284 ⊄ \u2286 ⊆
\u2287 ⊇ \u2295 ⊕ \u2297 ⊗ \u22A5 ⊥
\u22C5 ⋅ \u2308 ⌈ \u2309 ⌉ \u230A ⌊
\u230B ⌋ \u2329 ⟨ \u232A ⟩ \u25CA ◊
\u2660 ♠ \u2663 ♣ \u2665 ♥ \u2666 ♦
\x22 " \x26 & \x3C < \x3E > \u152 Œ
\u153 œ \u160 Š \u161 š \u178 Ÿ
\u2C6 ˆ \u2DC ˜ \u2002   \u2003   \u2009  
\u200C ‌ \u200D ‍ \u200E ‎ \u200F ‏ \u2013 –
\u2014 — \u2018 ‘ \u2019 ’ \u201A ‚
\u201C “ \u201D ” \u201E „ \u2020 †
\u2021 ‡ \u2030 ‰ \u2039 ‹ \u203A ›
\u20AC €
}
}
# ::html::foreach
#
# Rework the "foreach" command to blend into HTML template files.
# Rather than evaluating the body, we return the subst'ed body. Each
# iteration of the loop causes another string to be concatenated to
# the result value. No error checking is done on any arguments.
#
# Arguments:
# varlist Variables to instantiate with values from the next argument.
# list Values to set variables in varlist to.
# args ?varlist2 list2 ...? body, where body is the string to subst
# during each iteration of the loop.
#
# Results:
# Returns a string composed of multiple concatenations of the
# substitued body.
#
# Side Effects:
# None.
proc ::html::foreach {vars vals args} {
variable randVar
# The body of the foreach loop must be run in the stack frame
# above this one in order to have access to local variable at that stack
# level.
# To support nested foreach loops, we use a uniquely named
# variable to store incremental results.
incr randVar
::set resultVar "result_$randVar"
# Extract the body and any varlists and valuelists from the args.
::set body [lindex $args end]
::set varvals [linsert [lreplace $args end end] 0 $vars $vals]
# Create the script to eval in the stack frame above this one.
::set script "::foreach"
::foreach {vars vals} $varvals {
append script " [list $vars] [list $vals]"
}
append script " \{\n"
append script " append $resultVar \[subst \{$body\}\]\n"
append script "\}\n"
# Create a temporary variable in the stack frame above this one,
# and use it to store the incremental results of the multiple loop
# iterations. Remove the temporary variable when we're done so there's
# no trace of this loop left in that stack frame.
upvar 1 $resultVar tmp
::set tmp ""
uplevel 1 $script
::set result $tmp
unset tmp
return $result
}
# ::html::for
#
# Rework the "for" command to blend into HTML template files.
# Rather than evaluating the body, we return the subst'ed body. Each
# iteration of the loop causes another string to be concatenated to
# the result value. No error checking is done on any arguments.
#
# Arguments:
# start A script to evaluate once at the very beginning.
# test An expression to eval before each iteration of the loop.
# Once the expression is false, the command returns.
# next A script to evaluate after each iteration of the loop.
# body The string to subst during each iteration of the loop.
#
# Results:
# Returns a string composed of multiple concatenations of the
# substitued body.
#
# Side Effects:
# None.
proc ::html::for {start test next body} {
variable randVar
# The body of the for loop must be run in the stack frame
# above this one in order to have access to local variable at that stack
# level.
# To support nested for loops, we use a uniquely named
# variable to store incremental results.
incr randVar
::set resultVar "result_$randVar"
# Create the script to eval in the stack frame above this one.
::set script "::for [list $start] [list $test] [list $next] \{\n"
append script " append $resultVar \[subst \{$body\}\]\n"
append script "\}\n"
# Create a temporary variable in the stack frame above this one,
# and use it to store the incremental resutls of the multiple loop
# iterations. Remove the temporary variable when we're done so there's
# no trace of this loop left in that stack frame.
upvar 1 $resultVar tmp
::set tmp ""
uplevel 1 $script
::set result $tmp
unset tmp
return $result
}
# ::html::while
#
# Rework the "while" command to blend into HTML template files.
# Rather than evaluating the body, we return the subst'ed body. Each
# iteration of the loop causes another string to be concatenated to
# the result value. No error checking is done on any arguments.
#
# Arguments:
# test An expression to eval before each iteration of the loop.
# Once the expression is false, the command returns.
# body The string to subst during each iteration of the loop.
#
# Results:
# Returns a string composed of multiple concatenations of the
# substitued body.
#
# Side Effects:
# None.
proc ::html::while {test body} {
variable randVar
# The body of the while loop must be run in the stack frame
# above this one in order to have access to local variable at that stack
# level.
# To support nested while loops, we use a uniquely named
# variable to store incremental results.
incr randVar
::set resultVar "result_$randVar"
# Create the script to eval in the stack frame above this one.
::set script "::while [list $test] \{\n"
append script " append $resultVar \[subst \{$body\}\]\n"
append script "\}\n"
# Create a temporary variable in the stack frame above this one,
# and use it to store the incremental resutls of the multiple loop
# iterations. Remove the temporary variable when we're done so there's
# no trace of this loop left in that stack frame.
upvar 1 $resultVar tmp
::set tmp ""
uplevel 1 $script
::set result $tmp
unset tmp
return $result
}
# ::html::if
#
# Rework the "if" command to blend into HTML template files.
# Rather than evaluating a body clause, we return the subst'ed body.
# No error checking is done on any arguments.
#
# Arguments:
# test An expression to eval to decide whether to use the then body.
# body The string to subst if the test case was true.
# args ?elseif test body2 ...? ?else bodyn?, where bodyn is the string
# to subst if none of the tests are true.
#
# Results:
# Returns a string composed by substituting a body clause.
#
# Side Effects:
# None.
proc ::html::if {test body args} {
variable randVar
# The body of the then/else clause must be run in the stack frame
# above this one in order to have access to local variable at that stack
# level.
# To support nested if's, we use a uniquely named
# variable to store incremental results.
incr randVar
::set resultVar "result_$randVar"
# Extract the elseif clauses and else clause if they exist.
::set cmd [linsert $args 0 "::if" $test $body]
::foreach {keyword test body} $cmd {
::if {[string equal $keyword "else"]} {
append script " else \{\n"
::set body $test
} else {
append script " $keyword [list $test] \{\n"
}
append script " append $resultVar \[subst \{$body\}\]\n"
append script "\} "
}
# Create a temporary variable in the stack frame above this one,
# and use it to store the incremental resutls of the multiple loop
# iterations. Remove the temporary variable when we're done so there's
# no trace of this loop left in that stack frame.
upvar $resultVar tmp
::set tmp ""
uplevel $script
::set result $tmp
unset tmp
return $result
}
# ::html::set
#
# Rework the "set" command to blend into HTML template files.
# The return value is always "" so nothing is appended in the
# template. No error checking is done on any arguments.
#
# Arguments:
# var The variable to set.
# val The new value to give the variable.
#
# Results:
# Returns "".
#
# Side Effects:
# None.
proc ::html::set {var val} {
# The variable must be set in the stack frame above this one.
::set cmd [list set $var $val]
uplevel 1 $cmd
return ""
}
# ::html::eval
#
# Rework the "eval" command to blend into HTML template files.
# The return value is always "" so nothing is appended in the
# template. No error checking is done on any arguments.
#
# Arguments:
# args The args to evaluate. At least one must be given.
#
# Results:
# Returns "".
#
# Side Effects:
# Throws an error if no arguments are given.
proc ::html::eval {args} {
# The args must be evaluated in the stack frame above this one.
::eval [linsert $args 0 uplevel 1]
return ""
}
# ::html::init
#
# Reset state that gets accumulated for the current page.
#
# Arguments:
# nvlist Name, value list that is used to initialize default namespace
# variables that set font, size, etc.
#
# Side Effects:
# Wipes the page state array
proc ::html::init {{nvlist {}}} {
variable page
variable defaults
::if {[info exists page]} {
unset page
}
::if {[info exists defaults]} {
unset defaults
}
array set defaults $nvlist
}
# ::html::head
#
# Generate the <head> section. There are a number of
# optional calls you make *before* this to inject
# meta tags - see everything between here and the bodyTag proc.
#
# Arguments:
# title The page title
#
# Results:
# HTML for the <head> section
proc ::html::head {title} {
variable page
::set html "[openTag html][openTag head]\n"
append html "\t[title $title]"
::if {[info exists page(author)]} {
append html "\t$page(author)"
}
::if {[info exists page(meta)]} {
::foreach line $page(meta) {
append html "\t$line\n"
}
}
::if {[info exists page(css)]} {
::foreach style $page(css) {
append html "\t$style\n"
}
}
::if {[info exists page(js)]} {
::foreach script $page(js) {
append html "\t$script\n"
}
}
append html "[closeTag]\n"
}
# ::html::title
#
# Wrap up the <title> and tuck it away for use in the page later.
#
# Arguments:
# title The page title
#
# Results:
# HTML for the <title> section
proc ::html::title {title} {
variable page
::set page(title) $title
::set html "<title>$title</title>\n"
return $html
}
# ::html::getTitle
#
# Return the title of the current page.
#
# Arguments:
# None
#
# Results:
# The title
proc ::html::getTitle {} {
variable page
::if {[info exists page(title)]} {
return $page(title)
} else {
return ""
}
}
# ::html::meta
#
# Generate a meta tag. This tag gets bundled into the <head>
# section generated by html::head
#
# Arguments:
# args A name-value list of meta tag names and values.
#
# Side Effects:
# Stores HTML for the <meta> tag for use later by html::head
proc ::html::meta {args} {
variable page
::set html ""
::foreach {name value} $args {
append html "<meta name=\"$name\" content=\"[quoteFormValue $value]\">"
}
lappend page(meta) $html
return ""
}
# ::html::refresh
#
# Generate a meta refresh tag. This tag gets bundled into the <head>
# section generated by html::head
#
# Arguments:
# content Time period, in seconds, before the refresh
# url (option) new page to view. If not specified, then
# the current page is reloaded.
#
# Side Effects:
# Stores HTML for the <meta> tag for use later by html::head
proc ::html::refresh {content {url {}}} {
variable page
::set html "<meta http-equiv=\"Refresh\" content=\"$content"
::if {[string length $url]} {
append html "; url=$url"
}
append html "\">"
lappend page(meta) $html
return ""
}
# ::html::headTag
#
# Embed a tag into the HEAD section
# generated by html::head
#
# Arguments:
# string Everything but the < > for the tag.
#
# Side Effects:
# Stores HTML for the tag for use later by html::head
proc ::html::headTag {string} {
variable page
lappend page(meta) <$string>
return ""
}
# ::html::keywords
#
# Add META tag keywords to the <head> section.
# Call this before you call html::head
#
# Arguments:
# args The keywords
#
# Side Effects:
# See html::meta
proc ::html::keywords {args} {
html::meta keywords [join $args ", "]
}
# ::html::description
#
# Add a description META tag to the <head> section.
# Call this before you call html::head
#
# Arguments:
# description The description
#
# Side Effects:
# See html::meta
proc ::html::description {description} {
html::meta description $description
}
# ::html::author
#
# Add an author comment to the <head> section.
# Call this before you call html::head
#
# Arguments:
# author Author's name
#
# Side Effects:
# sets page(author)
proc ::html::author {author} {
variable page
::set page(author) "<!-- $author -->\n"
return ""
}
# ::html::tagParam
#
# Return a name, value string for the tag parameters.
# The values come from "hard-wired" values in the
# param agrument, or from the defaults set with html::init.
#
# Arguments:
# tag Name of the HTML tag (case insensitive).
# param pname=value info that overrides any default values
#
# Results
# A string of the form:
# pname="keyvalue" name2="2nd value"
proc ::html::tagParam {tag {param {}}} {
variable defaults
::set def ""
::foreach key [lsort [array names defaults $tag.*]] {
append def [default $key $param]
}
return [string trimleft $param$def]
}
# ::html::default
#
# Return a default value, if one has been registered
# and an overriding value does not occur in the existing
# tag parameters.
#
# Arguments:
# key Index into the defaults array defined by html::init
# This is expected to be in the form tag.pname where
# the pname part is used in the tag parameter name
# param pname=value info that overrides any default values
#
# Results
# pname="keyvalue"
proc ::html::default {key {param {}}} {
variable defaults
::set pname [string tolower [lindex [split $key .] 1]]
::set key [string tolower $key]
::if {![regexp -nocase "(\[ \]|^)$pname=" $param] &&
[info exists defaults($key)] &&
[string length $defaults($key)]} {
return " $pname=\"$defaults($key)\""
} else {
return ""
}
}
# ::html::bodyTag
#
# Generate a body tag
#
# Arguments:
# none
#
# Results
# A body tag
proc ::html::bodyTag {args} {
return [openTag body [join $args]]\n
}
# The following procedures are all related to generating form elements
# that are initialized to store the current value of the form element
# based on the CGI state. These functions depend on the ncgi::value
# procedure and assume that the caller has called ncgi::parse and/or
# ncgi::init appropriately to initialize the ncgi module.
# ::html::formValue
#
# Return a name and value pair, where the value is initialized
# from existing form data, if any.
#
# Arguments:
# name The name of the form element
# defvalue A default value to use, if not appears in the CGI
# inputs. DEPRECATED - use ncgi::defValue instead.
#
# Retults:
# A string like:
# name="fred" value="freds value"
proc ::html::formValue {name {defvalue {}}} {
::set value [ncgi::value $name]
::if {[string length $value] == 0} {
::set value $defvalue
}
return "name=\"$name\" value=\"[quoteFormValue $value]\""
}
# ::html::quoteFormValue
#
# Quote a value for use in a value=\"$value\" fragment.
#
# Arguments:
# value The value to quote
#
# Retults:
# A string like:
# "Hello, <b>World!"
proc ::html::quoteFormValue {value} {
return [string map [list "&" "&" "\"" """ \
"'" "'" "<" "<" ">" ">"] $value]
}
# ::html::textInput --
#
# Return an <input type=text> element. This uses the
# input.size default falue.
#
# Arguments:
# name The form element name
# args Additional attributes for the INPUT tag
#
# Results:
# The html fragment
proc ::html::textInput {name {value {}} args} {
::set html "<input type=\"text\" "
append html [formValue $name $value]
append html [default input.size $args]
::if {[llength $args] != 0} then {
append html " " [join $args]
}
append html ">\n"
return $html
}
# ::html::textInputRow --
#
# Format a table row containing a text input element and a label.
#
# Arguments:
# label Label to display next to the form element
# name The form element name
# args Additional attributes for the INPUT tag
#
# Results:
# The html fragment
proc ::html::textInputRow {label name {value {}} args} {
::set html [row $label [::eval [linsert $args 0 html::textInput $name $value]]]
return $html
}
# ::html::passwordInputRow --
#
# Format a table row containing a password input element and a label.
#
# Arguments:
# label Label to display next to the form element
# name The form element name
#
# Results:
# The html fragment
proc ::html::passwordInputRow {label {name password}} {
::set html [row $label [passwordInput $name]]
return $html
}
# ::html::passwordInput --
#
# Return an <input type=password> element.
#
# Arguments:
# name The form element name. Defaults to "password"
#
# Results:
# The html fragment
proc ::html::passwordInput {{name password}} {
::set html "<input type=\"password\" name=\"$name\">\n"
return $html
}
# ::html::checkbox --
#
# Format a checkbox so that it retains its state based on
# the current CGI values
#
# Arguments:
# name The form element name
# value The value associated with the checkbox
#
# Results:
# The html fragment
proc ::html::checkbox {name value} {
::set html "<input type=\"checkbox\" [checkValue $name $value]>\n"
}
# ::html::checkValue
#
# Like html::formalue, but for checkboxes that need CHECKED
#
# Arguments:
# name The name of the form element
# defvalue A default value to use, if not appears in the CGI
# inputs
#
# Retults:
# A string like:
# name="fred" value="freds value" CHECKED
proc ::html::checkValue {name {value 1}} {
::foreach v [ncgi::valueList $name] {
::if {[string compare $value $v] == 0} {
return "name=\"$name\" value=\"[quoteFormValue $value]\" checked"
}
}
return "name=\"$name\" value=\"[quoteFormValue $value]\""
}
# ::html::radioValue
#
# Like html::formValue, but for radioboxes that need CHECKED
#
# Arguments:
# name The name of the form element
# value The value associated with the radio button.
#
# Retults:
# A string like:
# name="fred" value="freds value" CHECKED
proc ::html::radioValue {name value {defaultSelection {}}} {
::if {[string equal $value [ncgi::value $name $defaultSelection]]} {
return "name=\"$name\" value=\"[quoteFormValue $value]\" checked"
} else {
return "name=\"$name\" value=\"[quoteFormValue $value]\""
}
}
# ::html::radioSet --
#
# Display a set of radio buttons while looking for an existing
# value from the query data, if any.
proc ::html::radioSet {key sep list {defaultSelection {}}} {
::set html ""
::set s ""
::foreach {label v} $list {
append html "$s<input type=\"radio\" [radioValue $key $v $defaultSelection]> $label"
::set s $sep
}
return $html
}
# ::html::checkSet --
#
# Display a set of check buttons while looking for an existing
# value from the query data, if any.
proc ::html::checkSet {key sep list} {
::set s ""
::foreach {label v} $list {
append html "$s<input type=\"checkbox\" [checkValue $key $v]> $label"
::set s $sep
}
return $html
}
# ::html::select --
#
# Format a <select> element that retains the state of the
# current CGI values.
#
# Arguments:
# name The form element name
# param The various size, multiple parameters for the tag
# choices A simple list of choices
# current Value to assume if nothing is in CGI state
#
# Results:
# The html fragment
proc ::html::select {name param choices {current {}}} {
::set def [ncgi::valueList $name $current]
::set html "<select name=\"$name\"[string trimright " $param"]>\n"
::foreach {label v} $choices {
::if {[lsearch -exact $def $v] != -1} {
::set SEL " selected"
} else {
::set SEL ""
}
append html "<option value=\"$v\"$SEL>$label\n"
}
append html "</select>\n"
return $html
}
# ::html::selectPlain --
#
# Format a <select> element where the values are the same
# as those that are displayed.
#
# Arguments:
# name The form element name
# param Tag parameters
# choices A simple list of choices
#
# Results:
# The html fragment
proc ::html::selectPlain {name param choices {current {}}} {
::set namevalue {}
::foreach c $choices {
lappend namevalue $c $c
}
return [select $name $param $namevalue $current]
}
# ::html::textarea --
#
# Format a <textarea> element that retains the state of the
# current CGI values.
#
# Arguments:
# name The form element name
# param The various size, multiple parameters for the tag
# current Value to assume if nothing is in CGI state
#
# Results:
# The html fragment
proc ::html::textarea {name {param {}} {current {}}} {
::set value [quoteFormValue [ncgi::value $name $current]]
return "<[string trimright \
"textarea name=\"$name\"\
[tagParam textarea $param]"]>$value</textarea>\n"
}
# ::html::submit --
#
# Format a submit button.
#
# Arguments:
# label The string to appear in the submit button.
# name The name for the submit button element
#
# Results:
# The html fragment
proc ::html::submit {label {name submit}} {
::set html "<input type=\"submit\" name=\"$name\" value=\"$label\">\n"
}
# ::html::varEmpty --
#
# Return true if the variable doesn't exist or is an empty string
#
# Arguments:
# varname Name of the variable
#
# Results:
# 1 if the variable doesn't exist or has the empty value
proc ::html::varEmpty {name} {
upvar 1 $name var
::if {[info exists var]} {
::set value $var
} else {
::set value ""
}
return [expr {[string length [string trim $value]] == 0}]
}
# ::html::getFormInfo --
#
# Generate hidden fields to capture form values.
#
# Arguments:
# args List of elements to save. If this is empty, everything is
# saved in hidden fields. This is a list of string match
# patterns.
#
# Results:
# A bunch of <input type=hidden> elements
proc ::html::getFormInfo {args} {
::if {[llength $args] == 0} {
::set args *
}
::set html ""
::foreach {n v} [ncgi::nvlist] {
::foreach pat $args {
::if {[string match $pat $n]} {
append html "<input type=\"hidden\" name=\"$n\" \
value=\"[quoteFormValue $v]\">\n"
}
}
}
return $html
}
# ::html::h1
# Generate an H1 tag.
#
# Arguments:
# string
# param
#
# Results:
# Formats the tag.
proc ::html::h1 {string {param {}}} {
html::h 1 $string $param
}
proc ::html::h2 {string {param {}}} {
html::h 2 $string $param
}
proc ::html::h3 {string {param {}}} {
html::h 3 $string $param
}
proc ::html::h4 {string {param {}}} {
html::h 4 $string $param
}
proc ::html::h5 {string {param {}}} {
html::h 5 $string $param
}
proc ::html::h6 {string {param {}}} {
html::h 6 $string $param
}
proc ::html::h {level string {param {}}} {
return "<[string trimright "h$level [tagParam h$level $param]"]>$string</h$level>\n"
}
# ::html::openTag
# Remember that a tag is opened so it can be closed later.
# This is used to automatically clean up at the end of a page.
#
# Arguments:
# tag The HTML tag name
# param Any parameters for the tag
#
# Results:
# Formats the tag. Also keeps it around in a per-page stack
# of open tags.
proc ::html::openTag {tag {param {}}} {
variable page
lappend page(stack) $tag
return "<[string trimright "$tag [tagParam $tag $param]"]>"
}
# ::html::closeTag
# Pop a tag from the stack and close it.
#
# Arguments:
# None
#
# Results:
# A close tag. Also pops the stack.
proc ::html::closeTag {} {
variable page
::if {[info exists page(stack)]} {
::set top [lindex $page(stack) end]
::set page(stack) [lreplace $page(stack) end end]
}
::if {[info exists top] && [string length $top]} {
return </$top>
} else {
return ""
}
}
# ::html::end
#
# Close out all the open tags. Especially useful for
# Tables that do not display at all if they are unclosed.
#
# Arguments:
# None
#
# Results:
# Some number of close HTML tags.
proc ::html::end {} {
variable page
::set html ""
::while {[llength $page(stack)]} {
append html [closeTag]\n
}
return $html
}
# ::html::row
#
# Format a table row. If the default font has been set, this
# takes care of wrapping the table cell contents in a font tag.
#
# Arguments:
# args Values to put into the row
#
# Results:
# A <tr><td>...</tr> fragment
proc ::html::row {args} {
::set html <tr>\n
::foreach x $args {
append html \t[cell "" $x td]\n
}
append html "</tr>\n"
return $html
}
# ::html::hdrRow
#
# Format a table row. If the default font has been set, this
# takes care of wrapping the table cell contents in a font tag.
#
# Arguments:
# args Values to put into the row
#
# Results:
# A <tr><th>...</tr> fragment
proc ::html::hdrRow {args} {
variable defaults
::set html <tr>\n
::foreach x $args {
append html \t[cell "" $x th]\n
}
append html "</tr>\n"
return $html
}
# ::html::paramRow
#
# Format a table row. If the default font has been set, this
# takes care of wrapping the table cell contents in a font tag.
#
# Based on html::row
#
# Arguments:
# list Values to put into the row
# rparam Parameters for row
# cparam Parameters for cells
#
# Results:
# A <tr><td>...</tr> fragment
proc ::html::paramRow {list {rparam {}} {cparam {}}} {
::set html "<tr $rparam>\n"
::foreach x $list {
append html \t[cell $cparam $x td]\n
}
append html "</tr>\n"
return $html
}
# ::html::cell
#
# Format a table cell. If the default font has been set, this
# takes care of wrapping the table cell contents in a font tag.
#
# Arguments:
# param Td tag parameters
# value The value to put into the cell
# tag (option) defaults to TD
#
# Results:
# <td>...</td> fragment
proc ::html::cell {param value {tag td}} {
::set font [font]
::if {[string length $font]} {
::set value $font$value</font>
}
return "<[string trimright "$tag $param"]>$value</$tag>"
}
# ::html::tableFromArray
#
# Format a Tcl array into an HTML table
#
# Arguments:
# arrname The name of the array
# param The <table> tag parameters, if any.
# pat A string match pattern for the element keys
#
# Results:
# A <table>
proc ::html::tableFromArray {arrname {param {}} {pat *}} {
upvar 1 $arrname arr
::set html ""
::if {[info exists arr]} {
append html "<table $param>\n"
append html "<tr><th colspan=2>$arrname</th></tr>\n"
::foreach name [lsort [array names arr $pat]] {
append html [row $name $arr($name)]
}
append html </table>\n
}
return $html
}
# ::html::tableFromList
#
# Format a table from a name, value list
#
# Arguments:
# querylist A name, value list
# param The <table> tag parameters, if any.
#
# Results:
# A <table>
proc ::html::tableFromList {querylist {param {}}} {
::set html ""
::if {[llength $querylist]} {
append html "<table $param>"
::foreach {label value} $querylist {
append html [row $label $value]
}
append html </table>
}
return $html
}
# ::html::mailto
#
# Format a mailto: HREF tag
#
# Arguments:
# email The target
# subject The subject of the email, if any
#
# Results:
# A <a href=mailto> tag </a>
proc ::html::mailto {email {subject {}}} {
::set html "<a href=\"mailto:$email"
::if {[string length $subject]} {
append html ?subject=$subject
}
append html "\">$email</a>"
return $html
}
# ::html::font
#
# Generate a standard <font> tag. This depends on defaults being
# set via html::init
#
# Arguments:
# args Font parameters.
#
# Results:
# HTML
proc ::html::font {args} {
# e.g., font.face, font.size, font.color
::set param [tagParam font [join $args]]
::if {[string length $param]} {
return "<[string trimright "font $param"]>"
} else {
return ""
}
}
# ::html::minorMenu
#
# Create a menu of links given a list of label, URL pairs.
# If the URL is the current page, it is not highlighted.
#
# Arguments:
#
# list List that alternates label, url, label, url
# sep Separator between elements
#
# Results:
# html
proc ::html::minorMenu {list {sep { | }}} {
::set s ""
::set html ""
regsub -- {index.h?tml$} [ncgi::urlStub] {} this
::foreach {label url} $list {
regsub -- {index.h?tml$} $url {} that
::if {[string compare $this $that] == 0} {
append html "$s$label"
} else {
append html "$s<a href=\"$url\">$label</a>"
}
::set s $sep
}
return $html
}
# ::html::minorList
#
# Create a list of links given a list of label, URL pairs.
# If the URL is the current page, it is not highlighted.
#
# Based on html::minorMenu
#
# Arguments:
#
# list List that alternates label, url, label, url
# ordered Boolean flag to choose between ordered and
# unordered lists. Defaults to 0, i.e. unordered.
#
# Results:
# A <ul><li><a...><\li>.....<\ul> fragment
# or a <ol><li><a...><\li>.....<\ol> fragment
proc ::html::minorList {list {ordered 0}} {
::set s ""
::set html ""
::if { $ordered } {
append html [openTag ol]
} else {
append html [openTag ul]
}
regsub -- {index.h?tml$} [ncgi::urlStub] {} this
::foreach {label url} $list {
append html [openTag li]
regsub -- {index.h?tml$} $url {} that
::if {[string compare $this $that] == 0} {
append html "$s$label"
} else {
append html "$s<a href=\"$url\">$label</a>"
}
append html [closeTag]
append html \n
}
append html [closeTag]
return $html
}
# ::html::extractParam
#
# Extract a value from parameter list (this needs a re-do)
#
# Arguments:
# param A parameter list. It should alredy have been processed to
# remove any entity references
# key The parameter name
# varName The variable to put the value into (use key as default)
#
# Results:
# returns "1" if the keyword is found, "0" otherwise
proc ::html::extractParam {param key {varName ""}} {
::if {$varName == ""} {
upvar $key result
} else {
upvar $varName result
}
::set ws " \t\n\r"
# look for name=value combinations. Either (') or (") are valid delimeters
::if {
[regsub -nocase [format {.*%s[%s]*=[%s]*"([^"]*).*} $key $ws $ws] $param {\1} value] ||
[regsub -nocase [format {.*%s[%s]*=[%s]*'([^']*).*} $key $ws $ws] $param {\1} value] ||
[regsub -nocase [format {.*%s[%s]*=[%s]*([^%s]+).*} $key $ws $ws $ws] $param {\1} value] } {
::set result $value
return 1
}
# now look for valueless names
# I should strip out name=value pairs, so we don't end up with "name"
# inside the "value" part of some other key word - some day
::set bad \[^a-zA-Z\]+
::if {[regexp -nocase "$bad$key$bad" -$param-]} {
return 1
} else {
return 0
}
}
# ::html::urlParent --
# This is like "file dirname", but doesn't screw with the slashes
# (file dirname will collapse // into /)
#
# Arguments:
# url The URL
#
# Results:
# The parent directory of the URL.
proc ::html::urlParent {url} {
::set url [string trimright $url /]
regsub -- {[^/]+$} $url {} url
return $url
}
# ::html::html_entities --
# Replaces all special characters in the text with their
# entities.
#
# Arguments:
# s The near-HTML text
#
# Results:
# The text with entities in place of specials characters.
proc ::html::html_entities {s} {
variable entities
return [string map $entities $s]
}
# ::html::nl2br --
# Replaces all line-endings in the text with <br> tags.
#
# Arguments:
# s The near-HTML text
#
# Results:
# The text with <br> in place of line-endings.
proc ::html::nl2br {s} {
return [string map [list \n\r <br> \r\n <br> \n <br> \r <br>] $s]
}
# ::html::doctype
# Create the DOCTYPE tag and tuck it away for usage
#
# Arguments:
# arg The DOCTYPE you want to declare
#
# Results:
# HTML for the doctype section
proc ::html::doctype {arg} {
variable doctypes
::set code [string toupper $arg]
::if {![info exists doctypes($code)]} {
return -code error -errorcode {HTML DOCTYPE BAD} \
"Unknown doctype \"$arg\""
}
return $doctypes($code)
}
namespace eval ::html {
variable doctypes
array set doctypes {
HTML32 {<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">}
HTML40 {<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">}
HTML40T {<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">}
HTML40F {<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN" "http://www.w3.org/TR/REC-html40/frameset.dtd">}
HTML401 {<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">}
HTML401T {<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">}
HTML401F {<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">}
XHTML10S {<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">}
XHTML10T {<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">}
XHTML10F {<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">}
XHTML11 {<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">}
XHTMLB {<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">}
}
}
# ::html::css
# Create the text/css tag and tuck it away for usage
#
# Arguments:
# href The location of the css file to include the filename and path
#
# Results:
# None.
proc ::html::css {href} {
variable page
lappend page(css) "<link rel=\"stylesheet\" type=\"text/css\" href=\"[quoteFormValue $href]\">"
return
}
# ::html::css-clear
# Drop all text/css references.
#
# Arguments:
# None.
#
# Results:
# None.
proc ::html::css-clear {} {
variable page
catch { unset page(css) }
return
}
# ::html::js
# Create the text/javascript tag and tuck it away for usage
#
# Arguments:
# href The location of the javascript file to include the filename and path
#
# Results:
# None.
proc ::html::js {href} {
variable page
lappend page(js) "<script language=\"javascript\" type=\"text/javascript\" src=\"[quoteFormValue $href]\"></script>"
return
}
# ::html::js-clear
# Drop all text/javascript references.
#
# Arguments:
# None.
#
# Results:
# None.
proc ::html::js-clear {} {
variable page
catch { unset page(js) }
return
}
|