home *** CD-ROM | disk | FTP | other *** search
/ Macwelt 1 / Macwelt DVD 1.toast / Web-Publishing / HTML-Editoren / Alpha ƒ / Tcl / Modes / pythonMode.tcl < prev    next >
Encoding:
Text File  |  2000-12-06  |  7.4 KB  |  205 lines
  1. # (auto-install)
  2. ############################################################################# 
  3. # pythonMode.tcl
  4. #  Howard Oakley, EHN & DIJ Oakley
  5. #  howard@quercus.demon.co.uk
  6. #
  7. # Description:
  8. # This auto-installing file implements a simple mode for editing 
  9. # Python using Alpha. It has been tested with Alpha version 7.2. 
  10. # The features of this mode include:
  11. # syntax colouring - comments in red, strings (some) in green,
  12. #  keywords in blue, and colons (a Python particular) in magenta 
  13. # easy production of comment boxes etc.
  14. # def and class marking - automatically generated marks (M popup) give 
  15. #  the function name first, and then the class (if any), whilst class 
  16. #  definitions give the class name twice; the {} popup takes
  17. #  you to class definitions
  18. # automatic indentation - given the importance of this in Python control 
  19. #  structures, this was an essential, and is accomplished
  20. #  using tabs in syntactic context.
  21. # The code below is a cobbling together of code stolen from other sources. 
  22. # Whilst the fine code of the original sources is reliable, there are 
  23. # all sorts of nasty kludges which I have used to get it to do what 
  24. # I needed. Tcl purists who can improve on it are invited to do so: 
  25. # please e-mail your corrections to me so that I can maintain this. 
  26. # My thanks and apologies to those from whom I have stolen code. 
  27. # Version: 1.0 dated 17 Sep 1999 [or if you prefer it, 1999-09-17]. 
  28. # 
  29. # (Vince fixed some stuff up for Alphatk, and removed some obsolete things)
  30. ############################################################################# 
  31.  
  32. alpha::mode Pyth 1.0.1 source {*.py} {
  33.     electricBraces electricTab electricReturn
  34. } {} help {
  35.     Python Mode provides syntax coloring - comments in red, strings (some) in
  36.     green, keywords in blue, and colons (a Python particular) in magenta; easy
  37.     production of comment boxes etc.; def and class marking - automatically
  38.     generated file marks (M popup) give the function name first, and then the
  39.     class (if any), whilst class definitions give the class name twice; the {}
  40.     popup (ParseFuncs) takes you to class definitions; automatic indentation -
  41.     given the importance of this in Python control structures, this is an
  42.     essential, and is accomplished using tabs in syntactic context.
  43. }
  44.  
  45. # We need at least this version
  46. alpha::package require AlphaTcl 7.4a7
  47.  
  48. newPref v leftFillColumn {1} Pyth
  49. newPref v wordBreak {\w+} Pyth
  50. newPref f wordWrap {0} Pyth
  51. newPref v funcExpr {^[ \t]*(def|class)[ \t]+([A-Za-z0-9_]+)} Pyth 
  52. newPref v parseExpr {^[ \t]*([A-Za-z0-9_]*)} Pyth
  53. newPref v wordBreakPreface {\W} Pyth
  54. newPref f autoMark 0 Pyth
  55.  
  56. # I extend the range of keywords a little, to include some type conversions # and other important items
  57.  
  58. set pythKeyWords {
  59.     access and break class continue def del elif else
  60.     except exec finally for from global if import in
  61.     is lambda not or pass print raise return self try while 
  62.     = < > <= >= + * - / != <> % | ^ &
  63.     len min max ~ abs int long float complex divmod pow
  64.     list map tuple eval string repr assert
  65. }
  66.  
  67. regModeKeywords -e {#} -s green -c red -i : -I magenta -k blue Pyth $pythKeyWords
  68. unset pythKeyWords
  69.  
  70. #================================================================================ 
  71. # for Tcl 8.0 compatibility, hopefully
  72. namespace eval Pyth {}
  73. #================================================================================ 
  74.  
  75. # for easy production of comment boxes etc.
  76.  
  77. set Pyth::commentCharacters(General) "\#"
  78. set Pyth::commentCharacters(Paragraph) [list "#----" "#----" "#"] 
  79. set Pyth::commentCharacters(Box) [list "#" 2 "#" 2 "#" 3] 
  80.  
  81. # the mark routine, which has to append the class name *if* the definition is
  82. # part of a class definition, but reset the empty class name if it is not, 
  83. # i.e. there is no leading whitespace before the 'def'
  84. # - this therefore builds the M popup menu.
  85.  
  86. proc Pyth::MarkFile {} {
  87.     global PythmodeVars
  88.     set pos [minPos]
  89.     set classnom ""
  90.     
  91.     while {![catch {search -s -f 1 -r 1 -m 0 -i 1 $PythmodeVars(funcExpr) $pos} res]} {
  92.     set start [lindex $res 0]
  93.     set end [pos::math [lindex $res 1] + 1]
  94.     set text [getText $start $end]
  95.     
  96.     if {[regexp -indices {(class)[ \t]+([a-zA-Z0-9_]+)} $text dummy dummy0 pname]} {
  97.         set i1 [pos::math $start + [lindex $pname 0]]
  98.         set i2 [pos::math $start + [lindex $pname 1] + 1]
  99.         # this is the start of a class definition, so save the class name       
  100.         set classnom  [getText $i1 $i2]
  101.     } else {
  102.         if {[pos::compare $pos > [minPos]]} {
  103.         set pp [pos::math $start - 1]
  104.         set pq [pos::math $start + 1]
  105.         set pr [getText $pp $pq]
  106.         if {![regexp {[ \t]+} $pr]} {
  107.             # this is a standalone def, therefore reset the class name to an empty string
  108.             set classnom ""
  109.         }
  110.         }
  111.     }
  112.     
  113.     if {[regexp -indices {(def|class)[ \t]+([a-zA-Z0-9_]+)} $text dummy dummy0 pname]} {
  114.         set i1 [pos::math $start + [lindex $pname 0]]
  115.         set i2 [pos::math $start + [lindex $pname 1] + 1]
  116.         set word  [getText $i1 $i2]
  117.         set tmp [concat $i1 $i2]
  118.         # assemble the marker name with the def element first, followed by any class name
  119.         set ol_word [join [concat $word " " $classnom ""]]   set inds($ol_word) $tmp
  120.     }
  121.     
  122.     set pos $end
  123.     }
  124.     if {[info exists inds]} {
  125.     foreach f [lsort -ignore [array names inds]] {
  126.         set res $inds($f)
  127.         setNamedMark $f [lineStart [lindex $res 0]] [lindex $res 0] [lindex $res 1]
  128.     }
  129.     }
  130. }
  131.  
  132. # this builds the {} menu along similar lines, but this time with just
  133. # class definitions
  134. proc Pyth::parseFuncs {} {
  135.     global PythmodeVars
  136.     set pos [minPos]
  137.     
  138.     while {![catch {search -s -f 1 -r 1 -m 0 -i 1 $PythmodeVars(funcExpr) $pos} res]} {
  139.     set start [lindex $res 0]
  140.     set end [pos::math [lindex $res 1] + 1]
  141.     set text [getText $start $end]
  142.     
  143.     if {[regexp -indices {(class)[ \t]+([a-zA-Z0-9_]+)} $text dummy dummy0 pname]} {
  144.         set i1 [pos::math $start + [lindex $pname 0]]
  145.         set i2 [pos::math $start + [lindex $pname 1] + 1]
  146.         set word  [getText $i1 $i2]
  147.         set tmp [concat $i1 $i2]
  148.         set inds($word) $tmp
  149.     }
  150.     set pos $end
  151.     }
  152.     set rtnRes {}
  153.     
  154.     if {[info exists inds]} {
  155.     foreach f [lsort -ignore [array names inds]] {
  156.         set next [nextLineStart $inds($f)]
  157.         lappend rtnRes $f $next
  158.     }
  159.     }
  160.     return $rtnRes 
  161. }
  162.  
  163. proc Pyth::indentLine {} {
  164.     # get details of current line
  165.     set beg [lineStart [getPos]]
  166.     set text [getText $beg [nextLineStart $beg]]
  167.     regexp "^\[ \t\]*" $text white
  168.     set len [string length $white]
  169.     set epos [pos::math $beg + $len]
  170.     
  171.     # Find last previous non-comment line and get its leading
  172.     # whitespace 
  173.     set pos $beg
  174.     while 1 {
  175.     if {[catch {search -s -f 0 -r 1 -i 0 -m 0 "^\[ \t\]*\[^ \t\r\n\]" [pos::math $pos - 1]} lst]} {
  176.         # search failed at top of file
  177.         set line "#"
  178.         set lwhite 0
  179.         break
  180.     }
  181.     if {![catch {text::inCommentBlock [lindex $lst 0]} res]} {
  182.         set pos [lindex $res 0]
  183.     } else {
  184.         set line [getText [lindex $lst 0] [pos::math [nextLineStart [lindex $lst 0]] - 1]]
  185.         set lwhite [posX [pos::math [lindex $lst 1] - 1]] 
  186.         break
  187.     }
  188.     }
  189.     # we need (syntactically) to increase the tabs by 1, so first do
  190.     # this using spaces, and then convert the spaces to a tab.  This is
  191.     # not elegant, but it works!
  192.     if {[regexp ":\[ \t\]*$" $line]} {
  193.     getWinInfo a
  194.     set ps $a(tabsize)
  195.     incr lwhite $ps
  196.     }
  197.     set lwhite [text::indentOf $lwhite]
  198.     if {$white != $lwhite} {
  199.     replaceText $beg $epos $lwhite
  200.     select $beg [pos::math $beg + [string length $lwhite]]
  201.     spacesToTabs
  202.     }
  203.     goto [pos::math $beg + [string length $lwhite]]
  204. }
  205.