From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.devel Subject: Re: question regarding my emacs package Date: Wed, 07 Jun 2023 15:53:08 +0000 Message-ID: <873533mfq3.fsf@posteo.net> References: <6cG8Tc55Zz8xk6rE6mJLfDxckAINPcYqp781yltsndzqq5146yw76EZ_2CoUtQT4P2j2afSx5VRD5G1-9qzFHWAW3LxYWwmxh87lvB2MgNE=@rj95.be> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19219"; mail-complaints-to="usenet@ciao.gmane.io" Cc: "emacs-devel@gnu.org" To: ram Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Jun 07 17:54:11 2023 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1q6vUA-0004pB-Fl for ged-emacs-devel@m.gmane-mx.org; Wed, 07 Jun 2023 17:54:10 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1q6vTK-0003DP-Vl; Wed, 07 Jun 2023 11:53:19 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q6vTJ-0003D7-CZ for emacs-devel@gnu.org; Wed, 07 Jun 2023 11:53:17 -0400 Original-Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q6vTH-0004Ai-1b for emacs-devel@gnu.org; Wed, 07 Jun 2023 11:53:17 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id ED9AB240103 for ; Wed, 7 Jun 2023 17:53:09 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1686153190; bh=KDVkZNlOU7UVYcXyAR68uqF7OmKEoZwYdAWyunaegKs=; h=From:To:Cc:Subject:Autocrypt:Date:Message-ID:MIME-Version:From; b=T0Ax3lh2fB6ioNvqyzxfRc9xe9thLnayUo67V+YOrdf2CECZWneE1rSOOr9SaigDA uM9K4tqHlNDfzW+Y6ZHQmfSQj3QOOvpZyWMPbS5VJhY1iGTE3eU28zdfuK11xGTGLj AjaBNMaO7qYBzHycnJ9vXf2ZKbMp3ZjLeTjlMs+spUExtF1KQONcqX0Bb1DgYbNLJg 3KCcA3TiuNdvI2acVKg8A16TR9cfWJpaWiSpKCfYHmEFtJTy4YdYXSdqfjK2Zsu6Jf waXSQSJyNOKQvK/qQmjt7Mdewcd+Pf3oXAOLJ2BvrIuKk+kklseXmzksoCixmC8gBz ORorLhY1Gggpg== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4QbsLs34NMz6twg; Wed, 7 Jun 2023 17:53:09 +0200 (CEST) In-Reply-To: <6cG8Tc55Zz8xk6rE6mJLfDxckAINPcYqp781yltsndzqq5146yw76EZ_2CoUtQT4P2j2afSx5VRD5G1-9qzFHWAW3LxYWwmxh87lvB2MgNE=@rj95.be> (ram's message of "Wed, 07 Jun 2023 03:18:07 +0000") Autocrypt: addr=philipk@posteo.net; keydata= mDMEZBBQQhYJKwYBBAHaRw8BAQdAHJuofBrfqFh12uQu0Yi7mrl525F28eTmwUDflFNmdui0QlBo aWxpcCBLYWx1ZGVyY2ljIChnZW5lcmF0ZWQgYnkgYXV0b2NyeXB0LmVsKSA8cGhpbGlwa0Bwb3N0 ZW8ubmV0PoiWBBMWCAA+FiEEDg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwMFCQHhM4AFCwkI BwIGFQoJCAsCBBYCAwECHgECF4AACgkQ8xYDWXahwulikAEA77hloUiSrXgFkUVJhlKBpLCHUjA0 mWZ9j9w5d08+jVwBAK6c4iGP7j+/PhbkxaEKa4V3MzIl7zJkcNNjHCXmvFcEuDgEZBBQQhIKKwYB BAGXVQEFAQEHQI5NLiLRjZy3OfSt1dhCmFyn+fN/QKELUYQetiaoe+MMAwEIB4h+BBgWCAAmFiEE Dg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwwFCQHhM4AACgkQ8xYDWXahwukm+wEA8cml4JpK NeAu65rg+auKrPOP6TP/4YWRCTIvuYDm0joBALw98AMz7/qMHvSCeU/hw9PL6u6R2EScxtpKnWof z4oM Received-SPF: pass client-ip=185.67.36.66; envelope-from=philipk@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:306686 Archived-At: --=-=-= Content-Type: text/plain ram writes: > hi, i am a professional programmer, but this is my first time > submitting an emacs package. i have conversed a little with stefan > monnier, and i believe the package i have meets the requirements for > elpa submission, but i am unsure as to the appropriate licensure. i > took some inspiration from two packages: dogears and gumshoe, neither > of which is in elpa. however, i did not use any code from here; i just > wanted some inspiration regarding the feature set That should not be an issue, these packages appear to only be a source of inspiration? > it is unclear to me whether my package warrants inclusion in gnu or > non gnu elpa, if at all, but i have certainly found it useful, despite > its simplicity Complexity is not a requirement for being useful :) > here is the repo: https://github.com/gitrj95/breadcrumbs.el Here are a few suggestions: --=-=-= Content-Type: text/plain Content-Disposition: inline diff -u /tmp/breadcrumbs.el.1 /tmp/breadcrumbs.el --- /tmp/breadcrumbs.el.1 2023-06-07 17:32:50.162889593 +0200 +++ /tmp/breadcrumbs.el 2023-06-07 17:52:36.608268297 +0200 @@ -35,9 +35,9 @@ ;; https://github.com/gitrj95/breadcrumbs.el ;; ;; In order to use breadcrumbs, `breadcrumbs-mode' must be enabled. -;; -;; Interface: -;; + +;;; Interface: + ;; `breadcrumbs-drop-breadcrumb' adds the current position in the ;; buffer to a ring. If point is at a known breadcrumb, the existing ;; breadcrumb will be moved to the head of the ring. Adding @@ -59,9 +59,14 @@ ;;; Code: (require 'ring) -(require 'eieio) +(require 'cl-lib) (require 'pulse) +(defgroup breadcrumbs () + "Track buffer positions." + :group 'convenience + :prefix "breadcrumbs-") + (defvar breadcrumbs-ring nil "All dropped breadcrumbs, up to `breadcrumb-ring-max' breadcrumbs.") @@ -81,44 +86,47 @@ (defvar breadcrumbs-list-buffer nil "The \"*Breadcrumbs List*\" buffer.") -(defclass breadcrumbs--breadcrumb () - ((buffer-name - :initform (buffer-name) - :documentation "Name of the buffer.") - (buffer-position - :initform (point) - :documentation "Position in buffer." - ) - (buffer-file-name - :initform (buffer-file-name) - :documentation "The full file path of this breadcrumb.")) - "The breadcrumb definition.") +(cl-defstruct breadcrumbs + "The breadcrumb definition." + (buffer-name + (buffer-name) + :documentation "Name of the buffer.") + (buffer-position + (point) + :documentation "Position in buffer.") + (buffer-file-name + (buffer-file-name) + :documentation "The full file path of this breadcrumb.")) (defun breadcrumbs--setup () "Set up the state required to start using breadcrumbs." (if (not breadcrumbs-ring) (setq breadcrumbs-ring (make-ring breadcrumb-ring-max))) (mapcar (lambda (fn) - (advice-add fn :around #'breadcrumbs--drop-around)) breadcrumbs-drop-around-fn-list)) + (advice-add fn :around #'breadcrumbs--drop-around)) + breadcrumbs-drop-around-fn-list)) (defun breadcrumbs--teardown () "Tear down the state required for breadcrumbs." (setq breadcrumbs-ring nil) (setq breadcrumbs--neighbor nil) (mapcar (lambda (fn) - (advice-remove fn #'breadcrumbs--drop-around)) breadcrumbs-drop-around-fn-list)) + (advice-remove fn #'breadcrumbs--drop-around)) + breadcrumbs-drop-around-fn-list)) (defun breadcrumbs--jump (breadcrumb) "Jump to the specified breadcrumb." (setq breadcrumbs--neighbor breadcrumb) - (with-slots (buffer-name buffer-position buffer-file-name) breadcrumb + (let ((buffer-name (breadcrumbs-buffer-name breadcrumb)) + (buffer-position (breadcrumbs-buffer-position breadcrumb)) + (buffer-file-name (breadcrumbs-buffer-file-name breadcrumb))) (if (get-buffer buffer-name) (progn (switch-to-buffer buffer-name) (goto-char buffer-position)) (find-file buffer-file-name) (goto-char buffer-position) - (setf buffer-name (buffer-name))) + (rename-buffer (buffer-name))) (pulse-momentary-highlight-one-line))) (defun breadcrumbs--drop () @@ -138,16 +146,18 @@ (breadcrumbs--drop) result)) -(defun breadcrumbs--find-and-jump (&key direction) +(defun breadcrumbs--find-and-jump (&rest args) "Find some candidate breadcrumb and jump to the next or previous, based on `direction'." (let ((jump-target (let ((candidate (make-instance 'breadcrumbs--breadcrumb))) - (if (ring-member breadcrumbs-ring candidate) - candidate)))) + (and (ring-member breadcrumbs-ring candidate) candidate))) + (direction (plist-get args :type))) (cond (jump-target (breadcrumbs--jump - (cond ((eq direction 'next) (ring-next breadcrumbs-ring jump-target)) - ((eq direction 'previous) (ring-next breadcrumbs-ring jump-target))))) + (ring-next + (cond ((eq direction 'next) breadcrumbs-ring) + ((eq direction 'previous) breadcrumbs-ring)) + jump-target))) (breadcrumbs--neighbor (if (eq direction 'previous) (breadcrumbs--jump breadcrumbs--neighbor)))))) @@ -156,14 +166,12 @@ (define-minor-mode breadcrumbs-mode "Track positions in buffers and files using breadcrumbs." :global t - :init-value t (if breadcrumbs-mode (breadcrumbs--setup) (breadcrumbs--teardown))) (defvar breadcrumbs-list-mode-map (let ((map (make-sparse-keymap))) - (set-keymap-parent map tabulated-list-mode-map) (define-key map (kbd "j") #'breadcrumbs-list-jump) (define-key map (kbd "") #'breadcrumbs-list-jump) (define-key map (kbd "k") #'breadcrumbs-list-delete) @@ -172,13 +180,14 @@ (defun breadcrumbs--format-slot (slot len) "Formats a breadcrumbs slot." - (let ((format-string (format "%%-%ss" len))) - (format format-string - (if slot slot "")))) + (let ((format-string (format "%%-%ds" len))) + (format format-string (or slot "")))) (defun breadcrumbs--format-breadcrumb (breadcrumb) "Return a formatted breadcrumb as a vector of formatted slots." - (with-slots (buffer-name buffer-position buffer-file-name) breadcrumb + (let ((buffer-name (breadcrumbs-buffer-name breadcrumb)) + (buffer-position (breadcrumbs-buffer-position breadcrumb)) + (buffer-file-name (breadcrumbs-buffer-file-name breadcrumb))) (vector (breadcrumbs--format-slot buffer-name 16) (breadcrumbs--format-slot buffer-position 16) @@ -199,13 +208,10 @@ (define-derived-mode breadcrumbs-list-mode tabulated-list-mode "Tabular list mode displaying tracked breadcrumbs." - (setq-local tabulated-list-format + (setq-local tabulated-list-entries #'breadcrumbs-list--entries + tabulated-list-format `[("Buffer" 16) ("Position" 16) ("File" 32)]) - (add-hook 'tabulated-list-revert-hook - (lambda () - (setf tabulated-list-entries (breadcrumbs-list--entries)))) - (tabulated-list-init-header) - (breadcrumbs-list--revert)) + (tabulated-list-init-header)) (defun breadcrumbs-list-jump () "Jump to breadcrumb from \"*Breadcrumbs List*\"." @@ -217,8 +223,8 @@ (interactive) (ring-remove breadcrumbs-ring (ring-member breadcrumbs-ring (tabulated-list-get-id))) - (if (ring-empty-p breadcrumbs-ring) - (setq breadcrumbs--neighbor nil)) + (when (ring-empty-p breadcrumbs-ring) + (setq breadcrumbs--neighbor nil)) (breadcrumbs-list--revert)) ;;;###autoload Diff finished. Wed Jun 7 17:52:43 2023 --=-=-=--