alphapapa / topsy.el Goto Github PK

Simple sticky header showing definition beyond top of window

License: GNU General Public License v3.0

Emacs Lisp 100.00%

topsy.el's Introduction

topsy.el

This library shows a sticky header at the top of the window. The header shows which definition the top line of the window is within. It’s intended as a simple alternative to semantic-stickyfunc-mode. It’s especially helpful when, for example, browsing a list of occur results: when a line is in the middle of a definition, and the top of the definition is beyond the top of the window, topsy shows what definition the line is in.

Mode-specific functions may be added to topsy-mode-functions.

NOTE: For Org mode buffers, please use org-sticky-header.

Screenshots

Installation
Usage
Changelog
Development

Installation

MELPA

If you installed from MELPA, you’re done. Just run one of the commands below.

Quelpa

The recommended way to install is with quelpa-use-package, like this:

;; Install and load `quelpa-use-package'.
(package-install 'quelpa-use-package)
(require 'quelpa-use-package)

(use-package topsy
  :quelpa (topsy :fetcher github :repo "alphapapa/topsy.el")
  :hook
  (prog-mode . topsy-mode)
  (magit-section-mode . topsy-mode))

Manual

Put topsy.el in your load-path, then:

(require 'topsy)

(add-hook 'prog-mode-hook #'topsy-mode)
(add-hook 'magit-section-mode-hook #'topsy-mode)

Usage

Run command topsy-mode. You may add it to appropriate hooks, such as prog-mode-hook and magit-section-mode-hook.

Tips

You can customize settings in the topsy group.

Changelog

0.1-pre

Not yet tagged.

Development

Bug reports, feature requests, suggestions — oh my!

There is currently only one function in topsy-mode-functions, one which returns the line that beginning-of-defun goes to. It should be useful in many major modes, but suggestions for additional, mode-specific functions are welcome.

License

GPLv3

topsy.el's People

Contributors

Stargazers

Watchers

Forkers

aspiers emacsmirror roshanshariff shafayetkhan josephmturner

topsy.el's Issues

Merge with org-sticky-header?

As discussed on Matrix, this seems to be a generalised version of https://github.com/alphapapa/org-sticky-header which works across multiple major modes. So I'm guessing it would make sense to merge with https://github.com/alphapapa/org-sticky-header and then open up for contributions supporting other major modes?

HTML support

Hello! Long time no see. Awesome contribution to the community as usual.

I tried to use it with an html file, expecting the most recent opened tag to be displayed in the header line, however, it is not the case. It would be an awesome feature to have. Do you think it would be possible to implement it?

Thanks a lot for your work!

Comparison to which-func.el

You might want to mention in the README the package which-func.el, shipped with Emacs. It is based on imenu, so I believe it should support any major mode that supports imenu.

(My thinking is that which-func.el should probably also grow the capability to display the current function in the header-line.)

Thanks for the package!

Shows header even if top of window is not in a defun

This can be somewhat confusing, as the end of the defun the header refers to is not visible. I think it should look to see if it's in a defun, and if not, omit the header (or at least offer a defcustom for this behaviour).

Sometimes duplicates the top line

Sometimes the header is identical to the top line of the window immediately below it, e.g. it always happens at the beginning of a buffer:

I may have also seen it occasionally duplicate (defun ... lines elsewhere, but not at all sure about that - I can't reproduce, so it might simply have been another start-of-buffer case.

[Feature Request] Also keep outline headers on top

I think it would be so helpful when viewing lisp files to also have the option to keep headings on top, so that at a glance you get a full glimpse of the context of where point is. The top-level heading would obviously be on top, with any subheadings beneath, and finally the relevant function title last. This means the number of lines required at the top would fluctuate as you move through the file, which hopefully wouldn’t be too hard to implement. An example of how it might look would be:

;;; Custom Variables
;;;; Appearance Variables
(defcustom var

Thank you so much for this package, and all of your wonderful packages!

topsy is confused when there are nested class definitions in c++

when there are nested class definitions such as

class a 
{
    ....
    class b 
    {
    ....
    }
    ....
}

and the screen is showing the lines of codes after class b, topsy will display class b instead of class a