util/syntax.cgi

   1 #!/usr/bin/newlisp
   2
   3 # comment following line out when using as CGI utilty
   4 # in this case files to convert which are local must end with .txt
   5 #(define cgi-use true)
   6
   7 # syntax.cgi 2.1
   8 #
   9 # v.1.7 - switch for using as commandline or cgi utility
  10 # v.1.9 - fixed highlighting problem with escaped quotes
  11 # v.2.0 - fixed \r\n translation
  12 # v.2.1 - more compatible CGI
  13 #
  14 # formats newLISP source files with syntax highlighting in HTML
  15 #
  16 # use on the command line or as cgi file together with a webserver
  17 #
  18 # EXAMPLE command line:
  19 #
  20 #    ./syntaxi.cgi mysource.lsp > mysource.lsp.html
  21 #
  22 # formats mysorce.lsp and redirects output to a new file mysource.lsp.html
  23 #
  24 # EXAMPLE webserver CGI (tested on Apache) local files must end in txt for security
  25 #
  26 #    http://www.mysite.com/syntax.cgi?mysource.lsp.txt
  27 #
  28 # returns mysorce.lsp HTML formatted to the requesting client (browser)
  29 #
  30 # EXAMPLE webserver CGI with other site URL
  31 #
  32 #    http://www.mysite.com/syntax.cgi?http://othersite/afile.lsp
  33 #
  34 # displays afile.lsp formateed from other site
  35 #
  36 # the following situations are not handled correctly:
  37 #    - nested curly braces for strings like {abd{def}ghi}
  38 #    - multiline quoted strings, use [text] [/text] instead
  39 #    - multiline braced strings, use [text] [/text] instead
  40 #    - comments starting with # but not starting at beginning of line
  41 #      use ; as comment starter when comment appears after code
  42
  43 (if cgi-use
  44         (print "Content-type: text/html\r\n\r\n"))
  45
  46 (define keyword-color "#0000AA")      ; newLISP keywords
  47 (define string-color "#008800")       ; single line quoted and braced strings
  48 (define long-string-color "#008800")  ; multiline for [text], [/text] tags
  49 (define paren-color "#AA0000")        ; parenthesis
  50 (define comment-color "#555555")      ; comments
  51 (define number-color "#665500")       ; numbers
  52
  53 (define function-name-color "#000088")    ; not implemented yet for func in (define (func x y z) ...)
  54
  55 (set 'keywords (map name (filter (fn (x) (primitive? (eval x))) (sort (symbols) > ))))
  56 (push "nil" keywords)
  57 (push "true" keywords)
  58 (set 'keyword-regex (join keywords "|"))
  59 (replace "?" keyword-regex "\\?")
  60 (replace "$" keyword-regex "\\$")
  61 (replace "!" keyword-regex "\\!")
  62 (replace "+" keyword-regex "\\+")
  63 (replace "*" keyword-regex "\\*")
  64 (replace "||" keyword-regex "|\\|")
  65 (set 'keyword-regex (append {(\s+|\(|\))(} keyword-regex {)(\s+|\(|\))}))
  66
  67 (set 'file (if cgi-use
  68         (or (read-line) (env "QUERY_STRING"))
  69         (main-args 2)))
  70
  71 (if cgi-use
  72   (begin
  73     (if (and (not (starts-with file "http://" nil)) (not (ends-with file ".txt")))
  74         (begin
  75                 (println "<h3>File not allowed for viewing: " file "</h3>")
  76                 (exit)))
  77   ))
  78
  79
  80 (if (starts-with file "http://" nil)
  81         (set 'file (get-url file 10000))
  82         (set 'file (read-file file )))
  83
  84 (if (not file)
  85         (begin
  86                 (println "<h3>Cannot find file</h3>")
  87                 (exit)))
  88
  89 (define (clean-comment str)
  90         (replace {<font color='#......'>} str "" 0)
  91         (replace {</font>} str "")
  92         (replace {[text]} str "&#091&text]")
  93         (replace {[/text]} str "&#091&/text]")
  94 )
  95
  96 (define (format-quoted-string str)
  97         (replace {<font color='#......'>} str "" 0)
  98         (replace {</font>} str "")
  99         (replace ";" str "&#059&")
 100         (replace "{" str "&#123&")
 101         (replace "}" str "&#125&")
 102         (replace {\} str "&#092&")
 103         (replace {[text]} str "&#091&text]")
 104         (replace {[/text]} str "&#091&/text]")
 105         (format {<font color='%s'>%s</font>} string-color str)
 106 )
 107
 108 (define (format-braced-string str)
 109         (replace {<font color='#......'>} str "" 0)
 110         (replace {</font>} str "")
 111         (replace ";" str "&#059&")
 112         (replace {"} str "&#034&")
 113         (replace {[text]} str "&#091&text]")
 114         (replace {[/text]} str "&#091&/text]")
 115         (format {<font color='%s'>%s</font>} string-color str)
 116 )
 117
 118 (define (format-tagged-string str)
 119         (replace {<font color='#......'>} str "" 0)
 120         (replace {</font>} str "")
 121         (replace ";" str "&#059&")
 122         (format {<font color='%s'>%s</font>} string-color str)
 123 )
 124
 125 ; replace special HTML characters
 126 (replace "\r\n" file "\n")
 127 (replace "&" file "&amp&")
 128 (replace "<(\\w)" file (append "&lt&" $1) 0)
 129 (replace "(\\w)>" file (append $1 "&gt&") 0)
 130 (replace "/>" file "/&gt&" 0)
 131 (replace "</" file "&lt&/" 0)
 132 (replace "<!" file "&lt&!" 0)
 133 ; replace escaped quotes
 134 (replace  "\092\034"  file "&#092&&#034&")
 135
 136 ; color keywords
 137 (replace keyword-regex file (format {%s<font color='%s'>%s</font>%s} $1 keyword-color $2 $3) 0)
 138
 139 ; color numbers
 140 (replace {(\s+|\(|\))(0x[0-9a-fA-F]+|[+-]?\d+\.\d+|[+-]?\d+|\.\d+)} file
 141          (format {%s<font color='%s'>%s</font>} $1 number-color $2) 0)
 142
 143
 144 ; color parens
 145 (replace "(" file (format {<font color='%s'>(</font>} paren-color))
 146 (replace ")" file (format {<font color='%s'>)</font>} paren-color))
 147
 148 ; color braced strings
 149 (replace "{.*?}" file (format-braced-string $0) 0) ; no multiline string
 150 ; color quoted strings
 151 (replace {".*?"} file (format-quoted-string $0) 0) ; no multiline strings
 152
 153 ; color ;  comments
 154 (replace ";.*" file (clean-comment $0) 0)
 155 (replace ";.*" file (format {<font color='%s'>%s</font>} comment-color $0) 0)
 156
 157 ; color # comments
 158 (set 'buff "")
 159 (dolist (lne (parse file "\n"))
 160         (replace "^\\s*#.*" lne  (clean-comment $0) 0)
 161         (replace "^\\s*#.*" lne (format {<font color='%s'>%s</font>} comment-color $0) 0)
 162         (write-line lne buff))
 163 (set 'file buff)
 164
 165 ; color tagged strings
 166 (replace {\[text\].*?\[/text\]} file (format-tagged-string $0) 4) ; handles multiline strings
 167
 168 ; xlate back special characters
 169 (replace "&amp&" file "&amp;")   ; ampersand
 170 (replace "&lt&" file "&lt;")     ; less
 171 (replace "&gt&" file "&gt;")     ; greater
 172 (replace {&#034&} file "&#034;") ; quotes
 173 (replace {&#059&} file "&#059;") ; semicolon
 174 (replace {&#123&} file "&#123;") ; left curly brace
 175 (replace {&#125&} file "&#125;") ; right curly brace
 176 (replace {&#091&} file "&#091;") ; left bracket
 177 (replace {&#092&} file "&#092;") ; back slash
 178
 179
 180 ; add pre and post tags
 181 (println (append "<html><body><pre>\n" file "\n</pre>" ))
 182
 183 (println {<center><font face='Arial' size='-2' color='#444444'>}
 184          {syntax highlighting with <a href="http://newlisp.org">newLISP</a>&nbsp;}
 185          {and <a href="http://newlisp.org/syntax.cgi?code/syntax-cgi.txt">syntax.cgi</a>}
 186          {</font></center>})
 187
 188 (println {</body></html>})
 189
 190 (exit)
 191
 192 ;; eof
 193