Jak odzyskać dokumenty z funkcji i zmiennych?

Próbuję napisać funkcję, która pobierze ciągi znaków z dowolnej sexps w pasującym pliku (def.*).

Chciałbym móc zarówno pobierać dowolne funkcje / makra, jak i dowolne zdefiniowane zmienne. Dla zmiennych chciałbym docstring, podczas gdy dla dowolnych funkcji chciałbym również listy argumentów.

Jeśli celem jest uzyskanie informacji o funkcjach i zmiennych już znajdujących się w środowisku :

• Dokumenty funkcji i makr znajdują się w documentationfunkcji.

• W przypadku zmiennych dokumentów używaj documentation-property; na przykład:

  (documentation-property
   'user-init-file 'variable-documentation)
  

• Arity funkcji i listę argumentów można znaleźć w tym pytaniu Emacs.SE , odpowiedzi i komentarzach do pytania.

(Znalazłem to, naciskając C-h k C-h fi przeglądając kod źródłowy describe-function(to samo dla zmiennych dokumentów, ale studiując describe-variable).)

Aby przeanalizować plik kodu źródłowego Emacsa Lispa, zakładając, że celem jest uzyskanie informacji o def.*formularzach najwyższego poziomu , można zrobić coś podobnego do następującego.

(defun get-defun-info (buffer)
  "Get information about all `defun' top-level sexps in a buffer
BUFFER. Returns a list with elements of the form (symbol args docstring)."
  (with-current-buffer buffer
    (save-excursion
      (save-restriction
        (widen)
        (goto-char (point-min))
        (let (result)
          ;; keep going while reading succeeds
          (while (condition-case nil
                     (progn
                       (read (current-buffer))
                       (forward-sexp -1)
                       t)
                   (error nil))
            (let ((form (read (current-buffer))))
              (cond
               ((not (listp form))      ; if it's not a list, skip it
                nil)
               ((eq (nth 0 form) 'defun) ; if it's a defun, collect info
                (let ((sym (nth 1 form))
                      (args (nth 2 form))
                      (doc (when (stringp (nth 3 form)) (nth 3 form))))
                  (push (list sym args doc) result))))))
          result)))))

To może być łatwo rozszerzony defvar, defconstitp

Aby poradzić sobie z defunpojawianiem się wewnątrz formularzy najwyższego poziomu, należałoby zejść do tych formularzy, prawdopodobnie używając rekurencji.