; Copyright 2005 Kevin Reid, under the terms of the MIT X license
; found at http://www.opensource.org/licenses/mit-license.html ................

(in-package :cl-user)

(cl:defpackage :e.util
  (:nicknames :e-util) ; XXX remove use of this nickname
  (:use :cl)
  
  #.(cl:let ((cl:package (cl:or 
               #+(or allegro clisp lispworks) :clos
               #+(or cmu) :mop
               #+sbcl :sb-mop
               #+abcl :system ; XXX possibly ABCL bug that it isn't in MOP:
               #+openmcl :openmcl-mop
               #+ccl :ccl)))
    (cl:when cl:package
      `(:import-from ,cl:package
         :class-precedence-list)))
  
  (:export
    :defglobals
    :defglobal
    :defconstantonce
  
    :aan
    :named-lambda
    :map-from-hash
    :system-symbol

    :serve-event
    :add-io-handler
    :remove-io-handler
    :add-exclusive-io-handler
    :remove-exclusive-io-handler
    :io-handler-exclusion-group
    
    :run-program
    :external-process-input-stream
    :external-process-output-stream
    
    :mangle-verb
    :unmangle-verb
    :mverb-verb=
    
    :without-suffix
    :without-prefix
    :popping-equal-case
    :nreverse-here
    
    :class-precedence-list
    :with-appropriate-floating-point-rules
    
    :function-lambda-list :<unknown-lambda-list>
    
    :lambda-list-arguments-range
    :function-arguments-range
    :function-responds-to
    
    :backtrace-value
    
    :+the-asdf-system+))

;;; 'early util' interlude
(defmacro e.util:defglobals (&rest names)
  `(declaim (special ,@names)))

(e.util:defglobals
  e.util:+the-asdf-system+)

(cl:defpackage :e.elib
  (:nicknames :elib)
  (:use :cl :e.util)
  (:export 
    :*compatible-catch-leakage*
    :*break-on-ejections*
    
    :unexternalizable-optimization-p
    :with-unexternalizable-optimization
    
    :get-fine-universal-time
    
    :vicious-cycle-error
    :synchronous-call-error
    :no-such-method-error :no-such-method
  
    :+the-e+
    
    :vat
    :*vat*
    :vat-loop
    :with-turn
    :establish-vat
    :vat-label
    :vat-safe-scope
    :vat-privileged-scope
    :vat-checking
    :vat-enqueue-turn
    :vat-enqueue-timed
    :vat-add-io-handler
    :vat-remove-io-handler
  
    :e-call :e-call-dispatch :e.
    :e-send :e-send-dispatch :e<-
    :e-call-match
    
    :near :eventual :broken
    
    :ref-state
    :ref-is-resolved
    :ref-shorten
    :ref-opt-problem
    :make-promise
    :make-unconnected-ref
    :with-result-promise
    
    :def-vtable
    :e-lambda :efun
    :miranda
    :message-pairs-to-map-including-miranda-messages
    :or-miranda-message-descs
    :static-maker
    
    :e-simple-slot
    :e-var-slot
    :e-guarded-slot
    :native-e-slot
    :+the-make-simple-slot+
    :+the-make-var-slot+
    
    :cl-type-fq-name
    :cl-type-fq-expr :cl-type-simple-expr
    :cl-type-parameters
    :def-fqn
    
    :e-coerce
    :e-coercef
    :e-coerce-native
    
    :observable-type-of 
    :def-class-opaque
    :cl-type-guard
    :make-e-type-error
    :type-specifier-to-guard
    :guard-to-type-specifier
    
    :+the-void-guard+
    :+the-any-guard+
    :+the-text-writer-guard+
    :+the-exception-guard+
    :+the-flex-list-guard+
    
    :+the-audit-checker+
    :audited-by-magic-verb
    :+deep-frozen-stamp+
    :+selfless-stamp+
    :e-audit-check-dispatch
   
    :+e-false+ :+e-true+ :e-is-true :as-e-boolean :e-boolean
    
    :|NaN| :|Infinity| :float64 :float32
    
    :ejector
    :ejector-prethrow
    :eject-or-ethrow
    :e-catchable-condition
    :transform-condition-for-e-catch
    :e-problem-to-condition
    :e-problem-unseal
    
    :make-traversal-key
    :+the-make-traversal-key+
    :+the-make-flex-map+
    :+the-make-const-map+
    :+the-map-guard+
    :+the-any-map-guard+
    :+the-make-list+
    :+the-make-int+
    :+the-make-sorted-queue+    
    
    :e-quote
    :e-print
    :with-text-writer-to-string
    :+the-make-text-writer+
    :text-writer
    :make-text-writer-to-cl-stream
    :unguarded-text-writer-error
    
    :type-desc :message-desc :param-desc
    :+the-make-type-desc+
    :+the-make-message-desc+
    :+the-make-param-desc+
    
    :simplify-fq-name
    :join-fq-name
    
    :make-equalizer
    :eeq-is-settled
    :eeq-is-same-ever
    :eeq-is-same-yet
    :eeq-same-yet-hash
    :traversal-key
    :eeq-hash-dispatch
    :eeq-same-dispatch
    :eeq-is-transparent-selfless
    :def-atomic-sameness
    
    :twine
    :+the-make-twine+
    
    :+the-make-weak-ref+
    
    :+the-make-proxy-resolver+
    
    :e-slot-value :place-slot
    :def-shorten-methods
    :escape-bind
    :with-vat :call-when-resolved :when-resolved
    :mapping-bind
    :e-import))

(e.util:defglobals
  elib:+the-make-simple-slot+
  elib:+the-make-var-slot+

  elib:+the-any-map-guard+
  elib:+the-flex-list-guard+
  elib:+the-make-const-map+
  elib:+the-make-twine+
  elib:+the-text-writer-guard+

  elib:+the-make-type-desc+
  elib:+the-make-param-desc+
  elib:+the-make-message-desc+

  #-sbcl elib:+e-false+
  #-sbcl elib:+e-true+
  elib:+the-exception-guard+
  elib:+the-map-guard+

  elib:+the-make-flex-map+
  elib:+the-make-text-writer+
  elib:+the-make-list+
  elib:+the-make-int+
  elib:+the-make-sorted-queue+

  elib:+the-e+

  elib:+the-audit-checker+
  elib:+deep-frozen-stamp+

  elib:+the-make-weak-ref+
  elib:+the-make-traversal-key+
  elib:+the-make-proxy-resolver+)

(declaim (ftype function
  e.elib:ejector
  e.elib:simplify-fq-name
  e.elib:join-fq-name
  e.elib:make-equalizer
  e.elib:cl-type-simple-expr
  e.elib:eeq-same-yet-hash
  e.elib:make-text-writer-to-cl-stream
  e.elib:e-import))

(cl:defpackage :e.elib.tables
  (:nicknames :e.tables)
  (:use :cl :e.util :elib :net.hexapodia.hashtables)
  (:documentation "Collection implementations.")
  (:export
    :const-map ; type
    :+the-make-array+))

(e.util:defglobals
  e.elib.tables:+the-make-array+)

(cl:defpackage :e.knot
  (:use :cl :e.util :elib)
  (:export
    :scope
    :make-scope
    :make-safe-scope
    :make-io-scope
    
    :found-e-on-java-home
    :*emaker-search-list*
    
    :+traceln+))
  
(cl:defvar e.knot:*emaker-search-list*)

(cl:defpackage :e.elang.vm-node 
  (:nicknames)
  (:documentation "All symbols in this package are the names of subclasses of ENode, eccept for null, error and .tuple..")
  ; XXX arrange so that null, error and .tuple. are not produced by parseEToSExpression?
  (:use)
  (:import-from :cl
    :error)
  (:export
    :|null|

    :|.tuple.|
    :|.AtHole.|
    :|.DollarHole.|
    
    :|AssignExpr|
    :|CallExpr|
    :|CatchExpr|
    :|CdrPattern|
    :|DefineExpr|
    :|EExpr|
    :|EMatcher|
    :|EMethod|
    :|ENode|
    :|EScript|
    :|EscapeExpr|
    :|FinalPattern|
    :|FinallyExpr|
    :|HideExpr|
    :|IfExpr|
    :|IgnorePattern|
    :|ListPattern|
    :|LiteralExpr|
    :|MatchBindExpr|
    :|MetaContextExpr|
    :|MetaStateExpr|
    :|NounExpr|
    :|NounPattern|
    :|ObjectExpr|
    :|Pattern|
    :|QuasiLiteralExpr|
    :|QuasiLiteralNode|
    :|QuasiLiteralPatt|
    :|QuasiNode|
    :|QuasiPatternExpr|
    :|QuasiPatternNode|
    :|QuasiPatternPatt|
    :|SeqExpr|
    :|SlotExpr|
    :|SlotPattern|
    :|SuchThatPattern|
    :|VarPattern|)
  #+sbcl (:lock t))

(cl:defpackage :e.elang
  (:nicknames :elang)
  (:use :cl :e.util :elib :e.elang.vm-node)
  (:export
    :eval-e
    :get-translation
    
    :+the-make-static-scope+
    
    :node-elements ;; XXX shouldn't really be exported
    :node-arity-error
    :opt-guard-expr-to-safe-opt-guard
    :pattern-opt-noun
    :pattern-to-param-desc
    
    :slot-symbol-var-name ;; XXX stale
    ))

(e.util:defglobals
  elang:+the-make-static-scope+)

(declaim (ftype function
  e.elang:eval-e
  e.elang:get-translation))

(cl:defpackage :e.elang.syntax
  (:nicknames :e.syntax)
  (:use :cl :e.util :e.elib :e.elang :e.elang.vm-node :yacc)
  (:export
    +e-printer+
    
    :e-source-to-tree
    
    :load-parse-cache
    :save-parse-cache
    :load-parse-cache-file
    :save-parse-cache-file
    :with-parse-cache-file
    
    :+prim-parser+
  ))
  
(e.util:defglobals
  e.elang.syntax:+prim-parser+
  e.elang.syntax:+e-printer+)

(declaim (ftype function 
  e.elang.syntax:e-source-to-tree
  e.elang.syntax:load-parse-cache
  e.elang.syntax:save-parse-cache
  e.elang.syntax:load-parse-cache-file
  e.elang.syntax:save-parse-cache-file))


(cl:defpackage :e.elang.lexer
  (:use :cl)
  (:nicknames :e.lex)
  (:documentation "Lexer implementation package")
  (:export
    :make-lexer
  ))


(cl:defpackage :e.elang.compiler
  (:nicknames :e.compiler)
  (:use :cl :e.util :e.elib :e.elang :e.elang.vm-node)
  (:export
    :scope-layout
    :scope-layout-noun-binding
    :scope-layout-fqn-prefix
    :scope-layout-noun-is-local
    :scope-layout-bindings
    :scope-layout-meta-state-bindings
    :scope-layout-bindings-before
    :scope-layout-bind
    :scope-layout-nest
    
    :binding-get-code
    :binding-get-slot-code
    :binding-set-code
    :binding-exit-info
    
    :direct-def-binding
    :direct-var-binding
    :value-binding
    :binding-for-slot
    
    ;; ejector specifier tags
    :nil
    :ejector
    :eject-function
    
    :eject-code
    :opt-ejector-make-code
    
    :static-context
    
    :object-form
    :updating-fully-qualify-name
    
    :%catch-expr-resignal
    :such-that-error
    :%make-such-that-error
    
    :delta-extract-outer-scope
    :outer-scope-to-layout
    
    :compile-e-to-file
    :load-compiled-e))


(cl:defpackage :e.elang.compiler.seq
  (:nicknames :e.compiler.seq)
  (:use :cl :e.util :e.elib :e.elang :e.elang.vm-node :e.elang.compiler)
  (:export
    :sequence-e-to-cl))

(declaim (ftype function
  e.elang.compiler.seq:sequence-e-to-cl))

(cl:defpackage :e.extern
  (:use :common-lisp :e.util :elib :elang)
  (:documentation "Capability-structured IO, and interfaces to libraries.")
  (:export
    :+standard-external-format+
    :+standard-external-format-common-name+
    :+gc+
    :make-file-getter
    :pathname-to-file
    :read-entire-file
    :+the-timer+
    :+rx-perl5-compiler+
    :+rx-perl5-matcher+))

(e.util:defglobals
  e.extern:+standard-external-format+
  e.extern:+standard-external-format-common-name+
  e.extern:+gc+
  e.extern:+the-timer+
  e.extern:+rx-perl5-compiler+
  e.extern:+rx-perl5-matcher+)

(declaim (ftype function
  e.extern:make-file-getter
  e.extern:read-entire-file))

(cl:defpackage :e.rune
  (:use :cl :e.util :e.elib :e.knot)
  (:documentation "Bootstrapping: setting up the E runtime environment after clrune starts the Lisp process.")
  (:export
    :rune))

(cl:defpackage :e.elib.vtable-methods
  (:use)
  (:documentation "For profiling purposes, vtable method functions may be interned in this package so they can be operated on later."))