all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: hansbkk@gmail.com
To: help-gnu-emacs@gnu.org
Subject: Generating a listing of all symbols (16K+) and labeling subsets
Date: Thu, 17 Apr 2014 22:34:25 -0400	[thread overview]
Message-ID: <CAAEZYjy+3KhmCwbYBHA9HC_TiWFD8G_se+47YFmYkum0_orNXw@mail.gmail.com> (raw)

Total noob here - and non-programmer to boot, as will become
immediately apparent from the code below - so please be gentle.

Before I start getting to know emacs as an end-user - which I'm
highly motivated to do, despite the amazingly steep learning curve to
do the most basic things - I plan to of course highly customize my
emacs environment to suit my needs, before starting the muscle-memory
training required to become efficient.

I want to experiment with "out of the box" newbie-friendly mods like
cua-mode, Starter Kit, Prelude, Evil maybe even Ergoemacs, but to
start with, not so much in a hands-on manner, but systematically
investigating the packages they install, keybinding mods etc.

To that end I'd like to generate standardized-format text "symbols
reports" on the relevant values of all functions, variables, key
bindings etc, so that I can do A-B comparison via diff between stock
vanilla emacs vs after installing these bundles, or in fact any
packages in the future.

I wrote the following function "list-hh-symbols" toward this end,
based on the list-options function from the now-obsolete options.el.
Please anyone noobier than me - don't use this for anything other than
learning by reading, I suspect it's of laughable quality.

Obviously any feedback at all would be most welcome, but the ideal
would be for someone to point me to something that already does this
out of the box. Or write it for me of course 8-)

Failing that, I'd specifically like to ask about the logic of the
categorizing breakdown and for better taxonomy terms.

And most of all, for code in line with the below scheme that allows
for the "other" categories to be more precisely broken down,
specifically identifying those symbols which are constant-value
variables, keymaps and macros.

And any others I might have missed among the 16,000+ that are out there.

------------------------------------------
(defun list-hh-symbols ()
  "Display a list of Emacs symbols - names only"
  (interactive)
  (message "Looking up all symbols...")
  (with-output-to-temp-buffer "*List Symbols*"
    (let (vars)
      (mapatoms (function (lambda (sym)
                            (setq vars (cons sym vars)))))
      (setq vars (sort vars 'string-lessp))
      (while vars
        (let ((sym (car vars)))
          (cond
           ((fboundp sym)                  ; ALL functions
            (cond
             ((commandp sym)
              (cond
               ((subrp (symbol-function sym))
                (princ "=============================\n")
                (princ "command - built-in primitive:\t\t")
                (prin1 sym)
                (princ "\n\n"))
               ((byte-code-function-p (symbol-function sym))
                (princ "====================\n")
                (princ "command - byte-code:\t\t\t")
                (prin1 sym)
                (princ "\n\n"))
               ((functionp sym)
                (princ "================\n")
                (princ "command - elisp:\t\t\t")
                (prin1 sym)
                (princ "\n\n"))
               (t
                (princ "===============\n")
                (princ "keymap command:\t\t\t\t")
                (prin1 sym)
                (princ "\n\n"))
               )
             )
             (t                            ; (non-command) functions
              (cond
               ((subrp (symbol-function sym))
                (princ "==============================\n")
                (princ "function - built-in primitive:\t\t")
                (prin1 sym)
                (princ "\n\n"))
               ((byte-code-function-p (symbol-function sym))
                (princ "=====================\n")
                (princ "function - byte-code:\t\t\t")
                (prin1 sym)
                (princ "\n\n"))
               ((functionp sym)
                (princ "=================\n")
                (princ "function - elisp:\t\t\t")
                (prin1 sym)
                (princ "\n\n"))
               (t
                (princ "================================\n")
                (princ "other ~function (keymap, macro):\t")
                (prin1 sym)
                (princ "\n\n"))
               )
              )
             )
            )
           ((boundp sym)                  ; ALL variables
            (cond
             ((custom-variable-p sym)
              (princ "=====================\n")
              (princ "user (custom) option:\t\t\t")
              (prin1 sym)
              (princ "\n\n"))
             (t
                (princ "=========================\n")
                (princ "non-user (setq) variable:\t\t")
                (prin1 sym)
                (princ "\n\n"))
             )
            )
           ((facep sym)
            (princ "=====\n")
            (princ "\n")
            (princ "face:\t\t\t\t\t")
            (prin1 sym)
            (princ "\n\n"))
           (t
            (princ "====================\n")
            (princ "other (misc) symbol:\t\t\t")
            (prin1 sym)
            (princ "\n\n"))
           )
        (setq vars (cdr vars))))
      (message "Looking up all symbols...done")
      (with-current-buffer "*List Symbols*"
        (setq buffer-read-only t)))))

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

(provide 'hh-list-symbols)

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; hh-list-symbols.el ends here
-------------------------------------------------------

and as a complete side note, which is better for navigating this
stuff, Helm or Icicles?

or has anyone got both of them working together? I assume from my
reading that they'd have so much overlap as to most likely interfere
with each other. . .

Thanks in advance.



             reply	other threads:[~2014-04-18  2:34 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-04-18  2:34 hansbkk [this message]
  -- strict thread matches above, loose matches on Subject: below --
2014-04-18  5:15 Generating a listing of all symbols (16K+) and labeling subsets Hans BKK
2014-04-18 19:01 ` Hans BKK
2014-04-18 20:47   ` Nicolas Richard
2014-04-19  1:23 ` Hans BKK
2014-04-19  2:16   ` John Mastro
2014-04-19  2:25 ` Hans BKK
2014-04-19  2:50   ` Hans BKK
2014-04-19  4:24   ` Drew Adams
2014-04-19 20:15 ` Hans BKK
2014-04-23  4:11 ` Hans BKK
2014-04-23  7:40   ` Florian v. Savigny
     [not found]   ` <<874n1klchv.fsf@bertrandrussell.Speedport_W_723V_1_32_000>
2014-04-23 15:07     ` Drew Adams
2014-04-23 13:22 ` Hans BKK
2014-04-24  2:30 ` Hans BKK
2014-04-18  2:09 hansbkk
2014-04-18  7:19 ` Thien-Thi Nguyen
2014-04-18 10:09   ` Thorsten Jolitz
     [not found]   ` <mailman.19825.1397815734.10748.help-gnu-emacs@gnu.org>
2014-04-18 15:00     ` Hans BKK
     [not found] ` <mailman.19813.1397805348.10748.help-gnu-emacs@gnu.org>
2014-04-18 14:55   ` Hans BKK
2014-04-18 15:27     ` Nicolas Richard
2014-04-19 16:34 ` Robert Thorpe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAAEZYjy+3KhmCwbYBHA9HC_TiWFD8G_se+47YFmYkum0_orNXw@mail.gmail.com \
    --to=hansbkk@gmail.com \
    --cc=help-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.