;;;; -*-  Mode: LISP; Syntax: Common-Lisp; Base: 10                          -*-
;;;; ---------------------------------------------------------------------------
;;;; File name: export.lsp
;;;;    System: FIRE
;;;;    Author: Jeff Usher
;;;;   Created: January 8, 2001 18:21:27
;;;;   Purpose: Exports public symbols.
;;;; ---------------------------------------------------------------------------
;;;;  Modified: Monday, June 7, 2004 at 14:33:55 by usher
;;;; ---------------------------------------------------------------------------

(in-package :fire)


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

#+packdoc
(packdoc:package-documentation
 :fire
 "QRG's Integrated Reasoning Engine (The F is for Fast/Flexible/TBD)")


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(export-symbols "Loading the Source Code"
    "These functions and globals are used for loading the source code and other
     associated operations."
  '(load-fire
    load-fire-only
    load-fire-viewers
    load-kb-tools
    
    *fire-path*
    *fire-version*
    
    #+packdoc generate-fire-documentation
    export-symbols
    ))


(export-symbols "Knowledge-Bases"
    "Functions for working with knowledge-bases."
  '(knowledge-base
    name
    path
    plist
    
    make-kb
    open-kb
    close-kb
    open-kb?
    reset-kb-integrity-flags
    rebuild-kb-indices
    
    dump-structural-cache
    dump-structural-cache-for-kb
    repopulate-structural-cache
    make-scache-files-writable
    
    in-kb
    with-kb
    clear-kb
    kb-store    ;; use this instead of store
    store       ;; deprecated
    retrieve
    retrieve-all
    retrieve-references
    retrieve-isas
    isa-statement?
    kb-forget   ;; use this instead of forget
    forget      ;; deprecated
    instance-of?
    instance-of-any?
    instances-of
    collection?
    collections-of
    all-collections-of
    map-collections
    list-all-collections
    
    immediate-genls
    all-genls
    immediate-specs
    all-specs
    spec-of?
    map-over-genls
    map-over-specs
    
    immediate-genlpreds
    all-genlpreds
    immediate-specpreds
    all-specpreds
    specpred-of?
    list-all-predicates
    list-all-functions
    list-all-relations
    list-all-connectives
    list-all-constants
    
    arity
    n-ary?
    arg-isa
    
    function?
    logical-connective?
    relation?
    commutative?
    predicate-type
    flat-file->kb
    meld-file->kb
    get-documentation
    *kb*
    mixed-case?
    predicate-style
    pidginize
    
    init-dbex  ;; *** deprecated but kept here for legacy apps
    ))


(export-symbols "Reasoning Sessions"
    "Functions for working with FIRE reasoners."
  '(make-reasoner
    in-reasoner
    with-reasoner
    kb
    ltre
    sources
    plist
    q
    query
    ask
    ask-it
    tell
    tell-it
    untell
    make-case-assertion
    *reasoner*
    reasoner
    ))


(export-symbols "Analogy"
    "Special functions and such for dealing with analogical reasoning."
  '(analogy-source
    analogy-source?
    add-analogy-source
    analogy-source-of
    gather-dgroup-facts
    extract-entities-and-expressions
    sme->fire-expression
    uncache-dgroup
    internal-predicates
    sme-referent
    *guess-predicate-info-if-needed*))


(export-symbols "Expression Constructors"
    "Useful abstractions for making expresions of various types."
  '(make-case-fact
    make-arg-type
    make-isa))

(export-symbols "Evaluation"
    "functions and such for the eval source."
  '(add-eval-source
    reset-evalfn-table
    defEvalFn
    show-evalfn-table))


(export-symbols "Backchainer"
    "Functions for doing reasoning via backchaining."
  '(create-chainer-from-axioms
    add-chainer-to-reasoner
    query-within-chainer 
    install-query-reasons-in-wm
    setup-rulemacros))

(export-symbols "Utils"
    "Functions of general utility."
  '(date*
    time*
    variable?))


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Franz Allegro stuff

#+(and allegro allegro-version>= (version>= 5) (not :runtime-system) (not unix))
(progn
  (setf (cg:text-edit-indentation 'export-symbols) '(4 4 2))
  (setf (cg:text-edit-indentation 'if) '(2 2))
  (setf (cg:text-edit-indentation 'trap-error) '(4 2))
  (setf (cg:text-edit-indentation 'query) '(4 2))
  )


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; End of Code