请在2024 Clojure 状态调查中分享您的想法！

欢迎！请查看关于页面，获取更多关于此如何工作的信息。

提问

这是 cl-format 的 bug 吗

+2 票
在 IO 由
重新标记 由

以下对 cl-format 的调用导致 Java 级别空指针异常。

(cl-format false "
~@")

当然，该代码样本相当没有意义。导致这个最小测试用例的实际示例如下。

(cl-format false "~&~
                            item=~A~@
                            transitions=~A~@
                            lhs=~A~@
                            rhs=~A~@"
                      1
                      2
                      3
                      4
                      )

据我所知，问题似乎出在处理最后的 ~@ 上，clojure 代码似乎（我在猜测）解构了 extract-params 的 nil 返回值
在 cl_format.clj 中的 compile-directive 函数里。

(defn- compile-directive [s offset]
  (let [[raw-params [rest offset]] (extract-params s offset)
        [_ [rest offset flags]] (extract-flags rest offset)
        directive (first rest)
        def (get directive-table (Character/toUpperCase ^Character directive))
        params (if def (map-params def (map translate-param raw-params) flags offset))]
    (if (not directive)
      (format-error "Format string ended in the middle of a directive" offset))
    (if (not def)
      (format-error (str "Directive \"" directive "\" is undefined") offset))
    [(struct compiled-directive ((:generator-fn def) params offset) def params offset)
     (let [remainder (subs rest 1) 
           offset (inc offset)
           trim? (and (= \newline (:directive def))
                      (not (:colon params)))
           trim-count (if trim? (prefix-count remainder [\space \tab]) 0)
           remainder (subs remainder trim-count)
           offset (+ offset trim-count)]
       [remainder offset])]))

这是我看到堆栈跟踪。

1. Unhandled java.lang.NullPointerException
   (No message)

             cl_format.clj: 1717  clojure.pprint/compile-directive
             cl_format.clj: 1861  clojure.pprint/compile-format/fn
                  AFn.java:  154  clojure.lang.AFn/applyToHelper
                  AFn.java:  144  clojure.lang.AFn/applyTo
                  core.clj:  665  clojure.core/apply
             utilities.clj:   37  clojure.pprint/consume
             cl_format.clj: 1845  clojure.pprint/compile-format
             cl_format.clj: 1845  clojure.pprint/compile-format
             cl_format.clj:   62  clojure.pprint/cl-format
             cl_format.clj:   27  clojure.pprint/cl-format
               RestFn.java:  521  clojure.lang.RestFn/invoke
                      REPL: 1391  clojure-rte.rte-core/eval24978
                      REPL: 1391  clojure-rte.rte-core/eval24978
             Compiler.java: 7176  clojure.lang.Compiler/eval
             Compiler.java: 7131  clojure.lang.Compiler/eval
                  core.clj: 3214  clojure.core/eval
                  core.clj: 3210  clojure.core/eval
    interruptible_eval.clj:   87  nrepl.middleware.interruptible-eval/evaluate/fn/fn
                  AFn.java:  152  clojure.lang.AFn/applyToHelper
                  AFn.java:  144  clojure.lang.AFn/applyTo
                  core.clj:  665  clojure.core/apply
                  core.clj: 1973  clojure.core/with-bindings*
                  core.clj: 1973  clojure.core/with-bindings*
               RestFn.java:  425  clojure.lang.RestFn/invoke
    interruptible_eval.clj:   87  nrepl.middleware.interruptible-eval/evaluate/fn
                  main.clj:  414  clojure.main/repl/read-eval-print/fn
                  main.clj:  414  clojure.main/repl/read-eval-print
                  main.clj:  435  clojure.main/repl/fn
                  main.clj:  435  clojure.main/repl
                  main.clj:  345  clojure.main/repl
               RestFn.java: 1523  clojure.lang.RestFn/invoke
    interruptible_eval.clj:   84  nrepl.middleware.interruptible-eval/evaluate
    interruptible_eval.clj:   56  nrepl.middleware.interruptible-eval/evaluate
    interruptible_eval.clj:  152  nrepl.middleware.interruptible-eval/interruptible-eval/fn/fn
                  AFn.java:   22  clojure.lang.AFn/run
               session.clj:  202  nrepl.middleware.session/session-exec/main-loop/fn
               session.clj:  201  nrepl.middleware.session/session-exec/main-loop
                  AFn.java:   22  clojure.lang.AFn/run
               Thread.java:  834  java.lang.Thread/run

1 答案

+1 票
由

经过一番研究，我现在对错误有了更好的理解。给 cl-format 传递的格式字符串可以包含零个或多个 指令。每个指令以 ~ 开头，以 %、a 或 s 等调度字符结束。在 ~ 和调度字符之间可以找到一些间隔项，如 , 或 @，顺序不限，还可以有诸如 ~2,4f、~3,-4s 或 ~3,-4:@s 等参数。这里的 , 和 @ 只是传递给调度函数的布尔标志。

在我这个例子中，我提供了 ~@ 后跟字符串结尾，因此 cl-format 理想情况下应该在找到调度字符之前检测到字符串结尾。

以下是我在common-lisp中遇到的错误

CL-USER> (format nil "~@")
error in FORMAT: String ended before directive was found
  ~@
  ^
   [Condition of type SB-FORMAT:FORMAT-ERROR]

Restarts:
 0: [RETRY] Retry SLIME REPL evaluation request.
 1: [*ABORT] Return to SLIME's top level.
 2: [ABORT] abort thread (#<THREAD "repl-thread" RUNNING {1004289BC3}>)

Backtrace:
  0: (SB-FORMAT::FORMAT-ERROR-AT* "~@" 0 "String ended before directive was found" NIL)
  1: (SB-FORMAT::FORMAT-ERROR-AT "~@" 0 "String ended before directive was found")
  2: ((FLET SB-FORMAT::GET-CHAR :IN SB-FORMAT::PARSE-DIRECTIVE))
  3: (SB-FORMAT::PARSE-DIRECTIVE "~@" 0 NIL)
  4: (SB-FORMAT::%TOKENIZE-CONTROL-STRING "~@" 0 2 NIL)
  5: (SB-FORMAT::TOKENIZE-CONTROL-STRING "~@")
  6: (SB-FORMAT::%FORMAT #<SB-IMPL::CHARACTER-STRING-OSTREAM {1004883B33}> "~@" NIL NIL)
  7: (FORMAT NIL "~@")
  8: (FORMAT NIL "~@") [more]
  9: (SB-INT:SIMPLE-EVAL-IN-LEXENV (FORMAT NIL "~@") #<NULL-LEXENV>)
 10: (EVAL (FORMAT NIL "~@"))
顺便说一句，`cl_format.clj`中的`compile-directive`函数似乎有检测`"Format string ended in the middle of a directive"`并调用`format-error`的有用错误消息的代码。不幸的是，Java错误的到来似乎阻止了这段代码被执行。
我相信这个补丁可以修复`compile-directive`函数的问题。注意，我使用了`if`而没有使用`else`的约定，这是先前作者使用的。这个更改仅仅是检测声明在`let`中的`directive`是`nil`还是字符。

```
(defn- compile-directive [s offset]
  (let [[raw-params [rest offset]] (extract-params s offset)
        [_ [rest offset flags]] (extract-flags rest offset)
        directive (first rest)
        def (if directive (get directive-table (Character/toUpperCase ^Character directive))))
    params (if def (map-params def (map translate-param raw-params) flags offset))]
    (if (not directive)
      (format-error "Format string ended in the middle of a directive" offset))
    (if (not def)
      (format-error (str "Directive \"" directive "\" is undefined") offset))
    [(struct compiled-directive ((:generator-fn def) params offset) def params offset)
     (let [remainder (subs rest 1)
           offset (inc offset)
           trim? (and (= \newline (:directive def))
                      (not (:colon params)))
           trim-count (if trim? (prefix-count remainder [\space \tab]) 0)
           remainder (subs remainder trim-count)
           offset (+ offset trim-count)]
       [remainder offset])]))
```

使用这个更改，我会得到一个有意义的错误消息，我认为这正是原始作者的意图。

```
(cl-format nil "~:@")

在nrepl.middleware.interruptible-eval/evaluate$fn$fn (interruptible_eval.clj:87)出现执行错误。
格式字符串在指令中间结束
~:@
   ^

```
由
我尝试使用这个简单的补丁创建一个拉取请求。  然而，我看到这个项目不接受拉取请求。  我尝试遵循说明，但我承认我迷路了。
由
我已收到并记录了您的贡献者协议，并发送电子邮件邀请您加入jira。 我已经在https://clojure.atlassian.net/browse/CLJ-2653提交了一个问题。 如果您喜欢，可以访问https://clojure.org/dev/developing_patches进行补丁制作。谢谢！
由
这个补丁被拒绝了吗？  今天我遇到了同样的问题，Clojure 1.11.1中的代码似乎仍然存在同样的错误。

也许我的补丁中哪里做错了？    

有人能帮忙吗？
由
我们还没看过，很抱歉。
由
在我看来这是一个很低风险的修复。
由Cognitect代表Clojure社区维护
...