7 ((lexed-ast (let ((ast (clnl-lexer:lex str)))
8 (format t "Via lexing, AST for~%~S~% became~%~S~%~%" str ast) ast))
9 (parsed-ast (let ((ast (clnl-parser:parse lexed-ast)))
10 (format t "Via parsing, AST for~%~S~% became~%~S~%~%" lexed-ast ast) ast))
11 (transpiled-ast (let ((ast (clnl-transpiler:transpile parsed-ast)))
12 (format t "Via transpiling, AST for~%~S~% became~%~S~%" parsed-ast ast) ast)))
13 (eval transpiled-ast)))
15 (defun p (result) result)
22 RESULT: undefined, the system terminates at the end of the loop
26 RUN starts up the CLNL system."
28 (sb-thread:make-thread #'clnl-cli:run)
31 (defvar *callback* nil)
33 (defun boot (&optional file headless-mode)
34 "BOOT &optional FILE HEADLESS-MODE => RESULT
38 FILE: nlogo file with which to initialize state
39 HEADLESS-MODE: a boolean, defaults to nil
44 BOOT does exactly that, boots the clnl system in a clean state. The seed
45 is set so that multiple runs will evaluate to the same.
47 When FILE is not provided, a default model is used.
49 When HEADLESS-MODE is set to nil, the opengl interface is initialized.
50 Otherwise, the model will run headlessly, with no view."
53 (model->single-form-lisp
54 (if file (with-open-file (str file) (clnl-model:read-from-nlogo str)) (clnl-model:default-model))
55 :initialize-interface (not headless-mode)
56 :netlogo-callback (lambda (f) (setf *callback* f))))
57 (*package* *model-package*))
58 (eval netlogoed-lisp)))
60 (defun run-commands (cmds)
61 "RUN-COMMANDS CMDS => RESULT
65 CMDS: A string that may have one more NetLogo commands
70 RUN-COMMANDS will take NetLogo commands, put them through the various
71 stages need to turn them into Common Lisp code, and run it."
72 (clnl-nvm:with-stop-handler
73 (funcall *callback* cmds)))
75 (defun run-reporter (reporter)
76 "RUN-REPORTER REPORTER => RESULT
80 REPORTER: A string that should have only one reporter
81 RESULT: The value reported by the NVM
85 RUN-REPORTER will take a NetLogo REPORTER, put it through the various
86 stages need to turn them into Common Lisp code, run it, and return the RESULT."
87 (eval (clnl-transpiler:transpile (clnl-parser:parse (clnl-lexer:lex reporter)))))
89 ; Because prims are used both at generation time and later at runtime, certain things in
90 ; them must be escaped a little bit more, such as wrapping the whole thing in a list
91 ; primitive. This way, the output of these things looks like halfway decent lisp,
92 ; and everything works nicely. We don't want any <FUNC #> showing up or anything
93 (defun munge-prim (prim)
95 ((copied (copy-list prim)))
96 (when (getf copied :args) (setf (getf copied :args) `(quote ,(getf copied :args))))
99 (defun netlogo-callback-body (prims)
101 (clnl-transpiler:transpile
103 (clnl-lexer:lex ,(intern "NETLOGO-CODE" *model-package*))
104 (list ,@(mapcar #'munge-prim prims)))
105 (list ,@(mapcar #'munge-prim prims)))))
107 (defun create-world-call (model globals code-ast)
108 `(clnl-nvm:create-world
109 :dims ',(clnl-model:world-dimensions model)
113 `(list ,(car pair) (lambda () ,(intern (string-upcase (car pair)) *model-package*))))
115 :turtles-own-vars ',(clnl-code-parser:turtles-own-vars code-ast)
116 :patches-own-vars ',(clnl-code-parser:patches-own-vars code-ast)
117 :breeds ',(clnl-code-parser:breeds code-ast)))
119 (defun create-proc-body (proc prims)
120 `(,(intern (string-upcase (car proc)) *model-package*) ()
121 (clnl-nvm:with-stop-handler
122 ,@(cdr ; remove the progn, cuz it looks nicer
123 (clnl-transpiler:transpile (cadr proc)
126 (if (getf prim :macro) ; The reason we do this is because with macros, we want to evaluate them in
127 ; this scope while preserving them for the generational purposes below
128 (append (list :macro (eval (getf prim :macro))) prim)
132 (defun nlogo->lisp (str pkg-symb boot-fn &key (seed 15) initialize-interface netlogo-callback-fn)
134 ((model (clnl-model:read-from-nlogo str))
139 (multiple-value-bind (found external) (find-symbol (symbol-name proc-symb) :cl)
140 (when (and found (eql :external external)) proc-symb)))
142 (clnl-code-parser:procedures
143 (clnl-code-parser:parse
144 (clnl-lexer:lex (clnl-model:code model))
145 (clnl-model:widget-globals model))))))))
148 (defpackage ,pkg-symb (:use :common-lisp) (:shadow ,@shadow-symbs))
149 (,(intern "IN-PACKAGE" :cl) ,pkg-symb) ; intern because of style check
151 `(defpackage ,,pkg-symb (:use :common-lisp) (:shadow ,,@shadow-symbs))
153 ((clnl:*model-package* (find-package ,pkg-symb)))
154 (clnl:model->multi-form-lisp
156 (intern (symbol-name ',boot-fn) ,pkg-symb)
158 :initialize-interface ,initialize-interface
159 :netlogo-callback-fn ,netlogo-callback-fn)))))))
161 (setf (documentation 'nlogo->lisp 'function)
162 "NLOGO->LISP STR PKG-SYMB BOOT-FN &key SEED INITIALIZE-INTERFACE NETLOGO-CALLBACK-FN => FORMS
164 ARGUMENTS AND VALUES:
166 STR: A stream holding an nlogo file
167 PKG-SYMB: A symbol for the generated package
168 BOOT-FN: A function name
169 SEED: An integer, defaults to 15
170 INITIALIZE-INTERFACE: A boolean
171 NETLOGO-CALLBACK-FN: a symbol
172 FORMS: A list of common lisp form
176 NLOGO->LISP takes a stream STR and returns a multi form lisp program,
177 that when executed, sets up the model. See MODEL->MULTI-FORM-LISP for
180 NLOGO->LISP does extra work of setting up the package to be named by
181 PKG-SYMB in order to correctly shadow common lisp functions.
183 It will also change the current package to the one created for the model
188 (with-open-file (str \"Wolf Sheep Predation.nlogo\") (nlogo->lisp str :wolfsheep 'boot)) => (forms)")
190 (defun model->single-form-lisp (model &key (seed 15) initialize-interface netlogo-callback)
193 (clnl-code-parser:parse (clnl-lexer:lex (clnl-model:code model)) (clnl-model:widget-globals model))
197 (clnl-code-parser:globals code-ast)
198 (clnl-model:widget-globals model))))
201 (lambda (pair) `(defparameter ,(intern (string-upcase (car pair)) *model-package*) ,(cadr pair)))
205 (lambda (proc) (create-proc-body proc prims))
206 (clnl-code-parser:procedures code-ast))
207 (clnl-random:set-seed ,seed)
208 ,(create-world-call model globals code-ast)
209 ,@(when netlogo-callback
210 `((funcall ,netlogo-callback
211 (lambda (,(intern "NETLOGO-CODE" *model-package*))
212 ,(netlogo-callback-body prims)))))
213 ,@(when initialize-interface `((clnl-interface:initialize :dims ',(clnl-model:world-dimensions model)))))))))
215 (setf (documentation 'model->single-form-lisp 'function)
216 "MODEL->SINGLE-FORM-LISP MODEL &key SEED INITIALIZE-INTERFACE NETLOGO-CALLBACK => FORM
218 ARGUMENTS AND VALUES:
221 SEED: An integer, defaults to 15
222 INITIALIZE-INTERFACE: A boolean
223 NETLOGO-CALLBACK: A function of one argument, or a symbol
224 FORM: A common lisp form
228 MODEL->SINGLE-FORM-LISP takes a model and returns a lisp program as a single form,
229 that when executed runs the model. The SEED passed in is used to start the
232 INITIALIZE-INTERFACE, when non nil, leads to initialization code for the
233 opengl interface being included.
235 NETLOGO-CALLBACK is a function that when called with a single argument,
236 a function that when called with netlogo code, will compile and run that
237 code in the environment of the model.
239 Of note, all globals defined either in the model code or via the widgets
240 are declared special in order to remain in the lexical environment for EVAL.")
242 (defun model->multi-form-lisp (model boot-fn &key (seed 15) initialize-interface netlogo-callback-fn)
245 (clnl-code-parser:parse (clnl-lexer:lex (clnl-model:code model)) (clnl-model:widget-globals model))
249 (clnl-model:widget-globals model)
250 (clnl-code-parser:globals code-ast))))
251 `((in-package ,(intern (package-name *model-package*) :keyword))
254 `(defvar ,(intern (string-upcase (car pair)) *model-package*) ,(cadr pair)))
257 (lambda (proc) `(defun ,@(create-proc-body proc prims)))
258 (clnl-code-parser:procedures code-ast))
260 (clnl-random:set-seed ,seed)
261 ,(create-world-call model globals code-ast)
262 ,@(when initialize-interface `((clnl-interface:initialize :dims ',(clnl-model:world-dimensions model)))))
263 ,@(when netlogo-callback-fn
264 `((defun ,netlogo-callback-fn (,(intern "NETLOGO-CODE" *model-package*))
265 ,(netlogo-callback-body prims))))))))
267 (setf (documentation 'model->multi-form-lisp 'function)
268 "MODEL->MULTI-FORM-LISP MODEL BOOT-FN &key SEED INITIALIZE-INTERFACE NETLOGO-CALLBACK-FN => FORMS
270 ARGUMENTS AND VALUES:
273 BOOT-FN: A function name
274 SEED: An integer, defaults to 15
275 INITIALIZE-INTERFACE: A boolean
276 NETLOGO-CALLBACK-FN: a symbol
277 FORMS: A list of common lisp form
281 MODEL->MULTI-FORM-LISP takes a model and returns a multi form lisp program,
282 that when executed, sets up the model. Procedures map to defuns, globals
283 to defvars, etc. This can be output to load up quickly later. A function
284 named by BOOT-FN will be set for booting the program.
286 The SEED passed in is used to start the clnl-random RNG.
288 INITIALIZE-INTERFACE, when non nil, leads to initialization code for the
289 opengl interface being included.
291 NETLOGO-CALLBACK-FN is a symbol that will be defined as a function
292 to be called to execute code in the running netlogo instance.")