Search code examples
clojure

Difference between Symbols and Vars in Clojure


I'm always a bit confused about Symbols and Vars in Clojure. For example, is it safe to say that + is a symbol which is used to denote a var, and this var points to a value which is a function that can add numbers?

So what happens, step by step when I just enter "+" in a REPL?

  1. The symbol gets qualified to a namespace, in this case clojure.core
  2. Then in some symbol table there is the information that + refers to a var
  3. When this var is evaluated, the result is a function-value?

Solution

  • There's a symbol + that you can talk about by quoting it:

    user=> '+
    +
    user=> (class '+)
    clojure.lang.Symbol
    user=> (resolve '+)
    #'clojure.core/+
    

    So it resolves to #'+, which is a Var:

    user=> (class #'+)
    clojure.lang.Var
    

    The Var references the function object:

    user=> (deref #'+)
    #<core$_PLUS_ clojure.core$_PLUS_@55a7b0bf>
    user=> @#'+
    #<core$_PLUS_ clojure.core$_PLUS_@55a7b0bf>
    

    (The @ sign is just shorthand for deref.) Of course the usual way to get to the function is to not quote the symbol:

    user=> +
    #<core$_PLUS_ clojure.core$_PLUS_@55a7b0bf>
    

    Note that lexical bindings are a different mechanism, and they can shadow Vars, but you can bypass them by referring to the Var explicitly:

    user=> (let [+ -] [(+ 1 2) (@#'+ 1 2)])
    [-1 3]
    

    In that last example the deref can even be left out:

    user=> (let [+ -] [(+ 1 2) (#'+ 1 2)])
    [-1 3]
    

    This is because Var implements IFn (the interface for Clojure functions) by calling deref on itself, casting the result to IFn and delegating the function call to that.

    The visibility mechanism used when you define private functions with defn- is based on metadata on the symbol. You can bypass it by referring directly to the Var, as above:

    user=> (ns foo)
    nil
    foo=> (defn- private-function [] :secret)
    #'foo/private-function
    foo=> (in-ns 'user)
    #<Namespace user>
    user=> (foo/private-function)
    java.lang.IllegalStateException: var: #'foo/private-function is not public (NO_SOURCE_FILE:36)
    user=> (#'foo/private-function)
    :secret