X-Git-Url: https://code.consxy.com/gitweb/gitweb.cgi?p=clnl;a=blobdiff_plain;f=src%2Fmain%2Fpackage.lisp;h=970535e0085f0e250c92182370ac8dc1d85dac0a;hp=cde6c077cf6531dc205c97c8b0fbd0e716880abb;hb=bc0c65622016066a82bc03b065f7138118c5b3cd;hpb=d4ab3334d216c9963f9459d9e8870c6abafce8f1

diff --git a/src/main/package.lisp b/src/main/package.lisp
index cde6c07..970535e 100644
--- a/src/main/package.lisp
+++ b/src/main/package.lisp
@@ -1,23 +1,117 @@
-(defpackage #:cl-nl (:use :common-lisp)
- (:export :run :boot :run-commands :run-reporter))
+(defpackage #:clnl (:use :common-lisp)
+ (:export
+  #:run #:boot #:run-commands #:run-reporter #:*model-package*
+  #:model->multi-form-lisp #:model->single-form-lisp
+  #:nlogo->lisp)
+ (:documentation
+  "Main CLNL package
 
-(defpackage #:cl-nl.parser
+The entry point for general purpose clnl startup, as well as
+the place that ties all the parts together into a cohesive whole."))
+
+(defpackage #:clnl-parser
  (:use :common-lisp)
- (:export :parse))
+ (:export #:parse)
+ (:documentation
+  "CLNL Parser
+
+All the code to convert the list of tokens coming from the lexer
+into an ast that can be transpiled later."))
+
+(defpackage #:clnl-code-parser
+ (:use :common-lisp)
+ (:export #:parse #:globals #:procedures #:turtles-own-vars #:patches-own-vars #:breeds)
+ (:documentation
+  "CLNL Code Parser
+
+A parser specifically for code from NetLogo models, that turns the lexed
+ast from an entire structured file into something more defined.
 
-(defpackage #:cl-nl.random
+This is different from the general parser (in clnl-parser) in that
+it's made for parsing the code section of nlogo files, and so works
+outside of the constraints.  In NetLogo, I believe this is analagous
+to the StructureParser, but I'm guessing there's weird overlap with
+other things."))
+
+(defpackage #:clnl-random
  (:use :common-lisp)
  (:shadow #:export)
- (:export #:export #:set-seed #:next-int #:next-double))
+ (:export #:export #:set-seed #:next-int #:next-double #:next-long)
+ (:documentation
+  "Wrapper around mt19937.
+
+mt19937 implements a merseinne twister that must be adapted a little in
+order to match the implementation in the main NetLogo codebase which tries
+to match how java.util.Random works.  Turtles, all the way down."))
+
+(defpackage #:clnl-transpiler
+ (:use :common-lisp)
+ (:export #:transpile #:reporter-p #:command-list-p)
+ (:documentation
+  "CLNL Transpiler
+
+The transpiler is responsible for taking an ast and turning it into valid CL code
+targeting the nvm.  Here is where start to care about commands versus reporters
+and ensuring that things are in the right place.  The reason we wait until here
+is because we want to allow someone else to play with the AST before handing it off
+to us.  For instance, the command center wants to add \"show\" to reporters, and
+the users dictate based on entry point whether they are expecting a command
+or a reporter.  So monitors can say \"hey, transpile this reporter\" and we'll check
+to make sure it actually is.
 
-(defpackage #:cl-nl.transpiler
+Furthermore, the lisp code that any netlogo code would be transpiled to should
+use exported symbols, such that anyone writing NetLogo code in lisp could use
+the nvm in the same way that comes out of this transpiler
+All the code to convert the list of tokens coming from the lexer
+into an ast that can be transpiled later."))
+
+(defpackage #:clnl-lexer
+ (:use :common-lisp)
+ (:export #:lex)
+ (:documentation
+  "CLNL Lexer
+
+The primary code responsible for tokenizing NetLogo code."))
+
+(defpackage #:clnl-interface
+ (:use :common-lisp)
+ (:export #:run #:export-view #:initialize)
+ (:documentation
+  "CLNL Interface
+
+The NetLogo view interface using opengl.  This is responsible for taking the
+current state of the enging and displaying it.  Will not house any interface
+components."))
+
+(defpackage #:clnl-model
  (:use :common-lisp)
- (:export :transpile-commands :transpile-reporter))
+ (:export
+  #:execute-button #:default-model #:read-from-nlogo #:world-dimensions #:widget-globals #:code
+  #:buttons #:view #:interface #:set-current-interface #:set-callback)
+ (:documentation
+  "CLNL Model
+
+The representation, parsing, and serializing of NetLogo model files, including
+all of the sections, and subsections held within.  This package houses not only
+the code to read and write .nlogo files, but also the living state of the model
+as clnl runs."))
 
-(defpackage #:cl-nl.nvm
+(defpackage #:clnl-extensions
  (:use :common-lisp)
- (:export :export-world :create-world :dump-object))
+ (:export #:load-extension #:prims)
+ (:documentation
+  "CLNL Extensions
+
+The loading and handling of extensions to CLNL modeled after the way that
+NetLogo handles extensions.
+
+Extensions are defined as Common Lisp systems (under asdf) that export
+the primitive PRIMS.  The name of the asdf system is defined to be the
+name of the extension prepended by CLNL-EXTENSION-, such that for a hypothetical
+extension ARRAY, the name of the asdf system would be CLNL-EXTENSION-ARRAY
+and found through conventional asdf means.  The package that the required
+functions are symbols in should be the same as the asdf system."))
 
-(defpackage #:cl-nl.lexer
+(defpackage #:clnl-default-model-package
  (:use :common-lisp)
- (:export :lex))
+ (:shadow #:go))