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
|
#lang at-exp racket/base
(require
(for-syntax racket/base) ; for help menu
drracket/tool ; necessary to build a drracket plugin
framework ; for preferences (too heavy a package?)
help/search
net/sendurl ; for the help menu
racket/class
racket/dict
racket/file
racket/gui/base
racket/list
racket/path ; for filename-extension
racket/runtime-path ; for the help menu
racket/string
racket/unit
"base.rkt"
(prefix-in lib: "library.rkt")
"library-gui.rkt"
)
(provide tool@)
#|
To debug:
$ export PLTSTEDDR=debug@quickscript && drracket&
If the menu takes a long time to load, it's because the scripts are not compiled.
Click on Scripts|Manage scripts|Compile user scripts.
It should then be very fast to load.
|#
(define (user-script-files #:exclude? [exclude? #t])
(lib:all-files (lib:load library-file) #:exclude? exclude?))
(define (error-message-box str e)
(message-box "Quickscript caught an exception"
(string-append str " " (exn-message e))
#f '(stop ok)))
(define-syntax with-error-message-box
(syntax-rules ()
[(_ str #:error-value err-val body ...)
(with-handlers ([exn? (λ (e)
(error-message-box str e)
err-val)])
body ...)]
[(_ str body ...)
(with-error-message-box str #:error-value (void) body ...)]))
;; Recompiles all (enabled or disabled, user and third-party) scripts that are not yet compiled
;; for the current version.
;; This is to prevent Quickscript trying to load from compiled after an upgrade of
;; the Racket system, and displaying one error message for each script.
;; It is important to recompile disabled scripts too, because these may still be
;; dependencies of shadowing scripts.
;; Caveat: Dependencies are not compiled automatically. Hence if a script depends on a collection
;; (package) then the collection needs to be compiled with the correct version, otherwise
;; an error will be raised on DrRacket startup.
;; How to test this works:
;; - Create a new script or use an old one that is *not* deactivated in the library
;; - Compile it with another version of racket (install locally, not unix style,
;; then use its old raco to setup quickscript and make the script)
;; - In DrRacket, use the quickscript "Compiled version" to make sure it has the old version.
;; - Exit DrRacket.
;; - Use the new version of raco to setup (again) quickscript
;; If installing a new version of racket, it may be necessary to run:
;; $ raco pkg update --link <path-to-local-quickscript>
;; - Restart DrRacket, the script should be compiled silently with the correct version,
;; and no error message should be displayed.
;; - In the library, check that a quickscript-extra shadowed script does not raise an error
;; when clicking on it.
(define (recompile-all-of-previous-version)
(compile-user-scripts
(filter (λ (f) (not (compiled-for-current-version? f)))
(user-script-files #:exclude? #f))))
(define-namespace-anchor a)
(define tool@
(unit
(import drracket:tool^)
(export drracket:tool-exports^)
(define script-menu-mixin
(mixin (drracket:unit:frame<%>) ()
(super-new)
(inherit get-button-panel
get-definitions-text
get-interactions-text
;register-toolbar-button
create-new-tab
)
(define/private (get-the-text-editor)
; for a frame:text% :
;(define text (send frame get-editor))
; for DrRacket:
(define defed (get-definitions-text))
(if (send defed has-focus?)
defed
(get-interactions-text)))
(define frame this)
(define/private (new-script)
(define name (get-text-from-user "Script name" "Enter the name of the new script:"
this
#:validate non-empty-string?
#:dialog-mixin frame:focus-table-mixin))
(when name
(define filename (string-append (string-foldcase (string-replace name " " "-")) ".rkt"))
(define file-path (build-path user-script-dir filename))
(define proc-name (string-foldcase (string-replace name " " "-")))
(define label name)
;; Make sure the directory containing the script exists
(make-directory* user-script-dir)
;; Write the script to file
(with-output-to-file file-path
(λ _
(displayln (make-simple-script-string proc-name label))))
(reload-scripts-menu)
(edit-script file-path)))
;; file: path?
(define/private (edit-script file)
(when file
; For frame:text% :
;(send (get-the-text-editor) load-file file)
; For DrRacket:
(send this open-in-new-tab file)))
(define/private (open-script)
(define file (get-file "Open a script" frame user-script-dir #f #f '()
'(("Racket" "*.rkt"))))
(edit-script file))
;; dict for persistent scripts:
;; the module is instanciated only once, and made available for future calls.
(define namespace-dict (make-hash))
(define/private (unload-persistent-scripts)
(set! namespace-dict (make-hash)))
;; f: path?
(define/private (run-script props)
(define name (prop-dict-ref props 'name))
(define fpath (prop-dict-ref props 'filepath))
(define output-to (prop-dict-ref props 'output-to))
(define persistent? (prop-dict-ref props 'persistent?))
; For frame:text% :
;(define text (send frame get-editor))
; For DrRacket:
(define text (get-the-text-editor))
(define str (send text get-text
(send text get-start-position)
(send text get-end-position)))
; Create a namespace for the script:
(define (make-script-namespace)
(define ns (make-base-empty-namespace))
(for ([mod '(racket/class racket/gui/base)])
(namespace-attach-module (namespace-anchor->empty-namespace a)
mod ns))
ns)
; if the script is persistent, we try to load an existing namespace, or we create one.
; if not, we always create a new namespace.
(define ns
(if persistent?
(dict-ref! namespace-dict fpath make-script-namespace)
(make-script-namespace)))
(define file-str (path->string fpath))
(define ed-file (send (get-definitions-text) get-filename))
(define str-out
(with-error-message-box
(format "Run: Error in script file ~s:\n" file-str)
#:error-value #f
; See HelpDesk for "Manipulating namespaces"
(let ([f (parameterize ([current-namespace ns]) (dynamic-require fpath name))]
[kw-dict `((#:definitions . ,(get-definitions-text))
(#:interactions . ,(get-interactions-text))
(#:editor . ,text)
(#:file . ,ed-file)
(#:frame . ,this))])
;; f is evaluated *outside* the created namespace so as to make
;; all features of drracket's frame available.
;; If it were evaluated inside ns, (send fr open-in-new-tab <some-file>)
;; wouldn't work.
(let-values ([(_ kws) (procedure-keywords f)])
(let ([k-v (sort (map (λ (k) (assoc k kw-dict)) kws)
keyword<? #:key car)])
(keyword-apply f (map car k-v) (map cdr k-v) str '()))))))
(define (insert-to-text text)
; Inserts the text, possibly overwriting the selection:
(send text begin-edit-sequence)
(send text insert str-out)
(send text end-edit-sequence))
; DrRacket specific:
(when (or (string? str-out) (is-a? str-out snip%)) ; do not modify the file if no output
(case output-to
[(new-tab)
(create-new-tab)
(define new-defs (get-definitions-text))
(send new-defs select-all) ; get the newly created text
(insert-to-text new-defs)]
[(selection)
(insert-to-text text)]
[(message-box)
(when (string? str-out)
(message-box "Output" str-out this))]
[(clipboard)
(when (string? str-out)
(send the-clipboard set-clipboard-string str-out 0))]
)))
(define/private (open-help)
(perform-search "quickscript")
; Does not seem to work well.
#;(send-main-page #:sub "quickscript/index.html"))
(define/private (bug-report)
(send-url "https://github.com/Metaxal/quickscript/issues"))
(define menu-bar (send this get-menu-bar))
(define menu-reload-count 0)
(define scripts-menu
(new menu% [parent menu-bar] [label "&Scripts"]))
(define/private (reload-scripts-menu)
(time-info
"Building script menu"
(set! menu-reload-count (add1 menu-reload-count))
(log-quickscript-info "Script menu rebuild #~a..." menu-reload-count)
(let ()
;; Create an empty namespace to load all the scripts (in the same namespace).
(define property-dicts
(parameterize ([current-namespace (make-base-empty-namespace)])
;; For all scripts in the script directory.
(append-map
(λ (f)
(time-info
(string-append "Loading file " (path->string f))
; Catch problems and display them in a message-box.
(with-error-message-box
(format "Reload: Error in script file ~s:\n" (path->string f))
#:error-value '() ; skip this file
(define props-list (get-property-dicts f))
; Keep only the scripts that match the current os type.
(filter (λ (props) (memq this-os-type (prop-dict-ref props 'os-types)))
props-list))))
(user-script-files))))
;; Sort the menu items lexicographically.
(set! property-dicts
(sort property-dicts
string<=?
#:key (λ (props)
(define menu-path (prop-dict-ref props 'menu-path))
(string-downcase
(string-replace
(string-join
(append
(if (empty? menu-path)
'("/")
menu-path)
(list (prop-dict-ref props 'label)))
"/")
"&" "" #:all? #t)))
#:cache-keys? #t))
;; remove all scripts items, after the default ones:
(time-info
"Deleting menu items"
(for ([item (list-tail (send scripts-menu get-items) 2)])
(log-quickscript-info "Deleting menu item ~a... " (send item get-label))
(send item delete)))
;; Add script items.
(for ([props (in-list property-dicts)])
(let*([label (prop-dict-ref props 'label)]
[menu-path (prop-dict-ref props 'menu-path)]
[shortcut (prop-dict-ref props 'shortcut)]
[shortcut-prefix (or (prop-dict-ref props 'shortcut-prefix)
(get-default-shortcut-prefix))]
[help-string (prop-dict-ref props 'help-string)]
)
; Create the menu hierarchy if it doesn't exist.
(define parent-menu
(let loop ([menu-path menu-path] [parent scripts-menu])
(if (empty? menu-path)
parent
(let ([menu (first menu-path)])
(loop (rest menu-path)
(or (findf (λ (m) (and (is-a? m labelled-menu-item<%>)
(string=? (send m get-label) menu)))
(send parent get-items))
(new menu% [parent parent] [label menu])))))))
(new menu-item% [parent parent-menu]
[label label]
[shortcut shortcut]
[shortcut-prefix shortcut-prefix]
[help-string help-string]
[callback (λ (it ev) (run-script props))]))))))
(define manage-menu (new menu% [parent scripts-menu] [label "&Manage scripts"]))
(for ([(lbl cbk)
(in-dict
`(("&New script…" . ,(λ () (new-script)))
("&Open script…" . ,(λ () (open-script)))
("&Disable scripts…" . ,(λ () (make-library-gui #:parent-frame this
#:drracket-parent? #t)))
(separator . #f)
("&Library…" . ,(λ () (make-library-gui #:parent-frame this
#:drracket-parent? #t)))
("&Reload menu" . ,(λ ()
(unload-persistent-scripts)
(reload-scripts-menu)))
("&Compile scripts and reload" . ,(λ ()
(unload-persistent-scripts)
(compile-user-scripts (user-script-files))
(reload-scripts-menu)))
("&Unload persistent scripts" . ,(λ () (unload-persistent-scripts)))
(separator . #f)
("&Help" . ,(λ () (open-help)))
("&Feedback/Bug report…" . ,(λ () (bug-report)))
))])
(if (eq? lbl 'separator)
(new separator-menu-item% [parent manage-menu])
(new menu-item% [parent manage-menu] [label lbl]
[callback (λ _ (cbk))])))
(new separator-menu-item% [parent scripts-menu])
; Silently recompile for the new version if necessary, at the start up of DrRacket.
(with-error-message-box
"Error while recompiling all from previous version:\n"
(recompile-all-of-previous-version))
(reload-scripts-menu)
))
(define (phase1) (void))
(define (phase2) (void))
(drracket:get/extend:extend-unit-frame script-menu-mixin)
))
|