├── screenshots
├── .DS_Store
├── dark-modeline.png
└── light-modeline.png
├── README.org
├── LICENSE
└── bespoke-modeline.el
/screenshots/.DS_Store:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mclear-tools/bespoke-modeline/HEAD/screenshots/.DS_Store
--------------------------------------------------------------------------------
/screenshots/dark-modeline.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mclear-tools/bespoke-modeline/HEAD/screenshots/dark-modeline.png
--------------------------------------------------------------------------------
/screenshots/light-modeline.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mclear-tools/bespoke-modeline/HEAD/screenshots/light-modeline.png
--------------------------------------------------------------------------------
/README.org:
--------------------------------------------------------------------------------
1 | *NOTE*: I am no longer actively developing this modeline, though its design is now
2 | largely incorporated into [[https://github.com/Lambda-Emacs/lambda-line][Lambda-line]].
3 |
4 |
5 | #+ATTR_HTML: :width 85%
6 | [[file:screenshots/dark-modeline.png]]
7 | #+ATTR_HTML: :width 85%
8 | [[file:screenshots/light-modeline.png]]
9 |
10 | A simple custom modeline for emacs. This started as a fork of [[https://github.com/rougier][Nicolas Rougier's]] excellent
11 | [[https://github.com/rougier/nano-modeline][nano-modeline]], but has evolved somewhat to include several extra (or simply
12 | different) features.
13 |
14 | The modeline is less conservative/minimal than nano-modeline, in the sense
15 | that it has a broader color palette and provides more configuration options.
16 |
17 | The user is strongly encouraged to use bespoke-modeline with [[https://github.com/mclear-tools/bespoke-themes][bespoke-themes]] (see that
18 | repo for more sample images of the modeline), but it should be, in principle, compatible
19 | with any theme.
20 |
21 | ** Features/Options
22 |
23 | + The modeline may be set as a header line (similar in style to [[https://github.com/rougier/nano-emacs][nano-emacs]]), or as
24 | the normal footer line, setting =(bespoke-modeline-position)= to top, bottom, or nil.
25 | + You can set the size of the mode line with =(bespoke-modeline-size)=
26 | + Set the buffer status symbol in the modeline. This is configurable separately
27 | for GUI and terminal. Default symbols are, respectively, read-only: (⨂)/(RO),
28 | modified: (⨀)/(**), and read-write: (◯)/(RW).
29 | - *NOTE*: If you use symbols you should make sure you are using a font that
30 | will display them properly. Here is one reliable way, using [[https://fontlibrary.org/en/font/symbola][Symbola]] font:
31 | #+begin_src emacs-lisp
32 | (use-package fontset
33 | :straight (:type built-in) ;; only include this if you use straight
34 | :config
35 | ;; Use symbola for proper unicode
36 | (when (member "Symbola" (font-family-list))
37 | (set-fontset-font
38 | t 'symbol "Symbola" nil)))
39 | #+end_src
40 | + Show both vc project and branch in the modeline
41 | + Set the symbol for vc-mode with =bespoke-modeline-vc-symbol=
42 | and =bespoke-modeline-space-bottom=.
43 | + Show git diff in modeline with =(bespoke-modeline-git-diff-mode-line)=
44 | + Substitute any major mode symbol for its designated one by setting
45 | =(bespoke-modeline-cleaner)= to 't (and the related variable
46 | =(bespoke-modeline-cleaner-alist)=
47 | + Truncate the buffer-name to a specific value (default is 30) using
48 | =(bespoke-modeline-truncate-value)=
49 | + The modeline is treated as a minor mode, so that it may be toggled on or off with =(bespoke-modeline-mode)=
50 | + Toggle between the top or bottom mode line with =(bespoke-modeline-toggle)=
51 | + There is a useful footer line visual alert "bell" inspired by [[https://github.com/hlissner/doom-emacs][DOOM emacs]]. To use
52 | include =(setq bespoke-modeline-visual-bell t)= in your setup of the theme.
53 | + You can control spacing in the modeline with =bespoke-modeline-space-top=
54 |
55 | ** Setup
56 |
57 | I dont know if/when this will appear on MELPA. In the meantime to use this mode-line
58 | you'll have to clone or otherwise download the repo and put it into your load path.
59 | Here's one possible way of setting it up using [[https://github.com/jwiegley/use-package][use-package]] and [[https://github.com/raxod502/straight.el][straight]].
60 |
61 | #+begin_src emacs-lisp
62 | (use-package bespoke-modeline
63 | :straight (:type git :host github :repo "mclear-tools/bespoke-modeline")
64 | :init
65 | ;; Set header line
66 | (setq bespoke-modeline-position 'top)
67 | ;; Set mode-line height
68 | (setq bespoke-modeline-size 3)
69 | ;; Show diff lines in mode-line
70 | (setq bespoke-modeline-git-diff-mode-line t)
71 | ;; Set mode-line cleaner
72 | (setq bespoke-modeline-cleaner t)
73 | ;; Use mode-line visual bell
74 | (setq bespoke-modeline-visual-bell t)
75 | ;; Set vc symbol
76 | (setq bespoke-modeline-vc-symbol "G:")
77 | :config
78 | (bespoke-modeline-mode))
79 | #+end_src
80 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------
/bespoke-modeline.el:
--------------------------------------------------------------------------------
1 | ;;; bespoke-modeline.el -- custom mode line for bespoke theme ;; -*- lexical-binding: t -*-
2 | ;; Copyright (C) 2020 Colin McLear
3 | ;; -------------------------------------------------------------------
4 | ;; Authors: Colin McLear
5 | ;; -------------------------------------------------------------------
6 | ;; URL: https://github.com/mclear-tools/bespoke-modeline
7 | ;; -------------------------------------------------------------------
8 | ;; Created: 2021-10-20
9 | ;; Version: 0.1
10 | ;; Package-Requires: ((emacs "26.1"))
11 | ;; -------------------------------------------------------------------
12 | ;; This file is not part of GNU Emacs.
13 | ;;
14 | ;; This program is free software: you can redistribute it and/or
15 | ;; modify it under the terms of the GNU General Public License as
16 | ;; published by the Free Software Foundation, either version 3 of the
17 | ;; License, or (at your option) any later version.
18 | ;;
19 | ;; This program is distributed in the hope that it will be useful, but
20 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of
21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 | ;; General Public License for more details.
23 | ;;
24 | ;; You should have received a copy of the GNU General Public License
25 | ;; along with this program. If not, see
26 | ;; -------------------------------------------------------------------
27 | ;;; Commentary:
28 | ;; A bespoke modeline.
29 | ;; This mode line originated as a fork of the nano-emacs modeline.
30 | ;; See https://github.com/rougier/nano-emacs
31 | ;; https://github.com/rougier/nano-modeline
32 | ;; -------------------------------------------------------------------
33 | ;;
34 | ;; Bespoke mode line format:
35 | ;;
36 | ;; [ status | name (primary) secondary | item1 | item2 ]
37 | ;;
38 | ;; -------------------------------------------------------------------
39 | ;;
40 | ;; It can be displayed at the bottom (mode-line) or at the top (header-line)
41 | ;; depending on bespoke-modeline-position custom setting.
42 | ;;
43 | ;; There are two sets of faces (for active and inactive modelines) that
44 | ;; can be customized (M-x: customize-group + bespoke-modeline)
45 | ;;
46 | ;; - bespoke-modeline-active-name / bespoke-modeline-inactive-name
47 | ;; - bespoke-modeline-active-primary / bespoke-modeline-inactive-primary
48 | ;; - bespoke-modeline-active-secondary / bespoke-modeline-inactive-secondary
49 | ;; - bespoke-modeline-active-status-RO / bespoke-modeline-inactive-status-RO
50 | ;; - bespoke-modeline-active-status-RW / bespoke-modeline-inactive-status-RW
51 | ;; - bespoke-modeline-active-status-** / bespoke-modeline-inactive-status-**
52 | ;;
53 | ;; Usage example:
54 | ;;
55 | ;; M-x: bespoke-modeline-mode
56 | ;;
57 | ;; You may also toggle the modeline to the top or bottom using M-x: bespoke-modeline-toggle
58 |
59 | ;;; Code:
60 |
61 | ;;;; Group
62 | (defgroup bespoke nil
63 | "Bespoke group"
64 | :group 'convenience)
65 |
66 | (defgroup bespoke-modeline nil
67 | "Bespoke group modeline"
68 | :group 'bespoke)
69 |
70 | (defgroup bespoke-modeline-active nil
71 | "Active modeline faces.
72 |
73 | Modeline is composed as:
74 | [ status | name (primary) secondary ]"
75 | :group 'bespoke-modeline)
76 |
77 | (defgroup bespoke-modeline-inactive nil
78 | "Inactive modeline faces
79 |
80 | Modeline is composed as:
81 | [ status | name (primary) secondary ]"
82 | :group 'bespoke-modeline)
83 |
84 |
85 | ;;;; Faces
86 |
87 | (defface bespoke-modeline-active
88 | '((t (:inherit (mode-line))))
89 | "Modeline face for active modeline"
90 | :group 'bespoke-modeline-active)
91 |
92 | (defface bespoke-modeline-active-name
93 | '((t (:inherit (mode-line))))
94 | "Modeline face for active name element"
95 | :group 'bespoke-modeline-active)
96 |
97 | (defface bespoke-modeline-active-primary
98 | '((t (:weight light :inherit (mode-line))))
99 | "Modeline face for active primary element"
100 | :group 'bespoke-modeline-active)
101 |
102 | (defface bespoke-modeline-active-secondary
103 | '((t (:inherit mode-line)))
104 | "Modeline face for active secondary element"
105 | :group 'bespoke-modeline-active)
106 |
107 | (defface bespoke-modeline-active-status-RO
108 | '((t (:inherit default :background "yellow" :box (:line-width 2 :color "yellow" :style nil))))
109 | "Modeline face for active READ-ONLY element"
110 | :group 'bespoke-modeline-active)
111 |
112 | (defface bespoke-modeline-active-status-RW
113 | '((t (:inherit default :background "green" (:line-width 2 :color "green" :style nil))))
114 | "Modeline face for active READ-WRITE element"
115 | :group 'bespoke-modeline-active)
116 |
117 | (defface bespoke-modeline-active-status-**
118 | '((t (:inherit default :background "red" (:line-width 2 :color "red" :style nil))))
119 | "Modeline face for active MODIFIED element"
120 | :group 'bespoke-modeline-active)
121 |
122 | (defface bespoke-modeline-inactive
123 | '((t (:inherit mode-line-inactive)))
124 | "Modeline face for inactive window"
125 | :group 'bespoke-modeline-inactive)
126 |
127 | (defface bespoke-modeline-inactive-name
128 | '((t (:inherit mode-line-inactive)))
129 | "Modeline face for inactive name element"
130 | :group 'bespoke-modeline-inactive)
131 |
132 | (defface bespoke-modeline-inactive-primary
133 | '((t (:inherit mode-line-inactive)))
134 | "Modeline face for inactive primary element"
135 | :group 'bespoke-modeline-inactive)
136 |
137 | (defface bespoke-modeline-inactive-secondary
138 | '((t (:inherit mode-line-inactive)))
139 | "Modeline face for inactive primary element"
140 | :group 'bespoke-modeline-inactive)
141 |
142 | (defface bespoke-modeline-inactive-status-RO
143 | '((t (:foreground "light gray" :background "dark gray" (:line-width 2 :color "dark gray" :style nil))))
144 | "Modeline face for inactive READ-ONLY element"
145 | :group 'bespoke-modeline-inactive)
146 |
147 | (defface bespoke-modeline-inactive-status-RW
148 | '((t (:foreground "light gray" :background "dark gray" (:line-width 2 :color "dark gray" :style nil))))
149 | "Modeline face for inactive READ-WRITE element"
150 | :group 'bespoke-modeline-inactive)
151 |
152 | (defface bespoke-modeline-inactive-status-**
153 | '((t (:foreground "light gray" :background "dark gray" (:line-width 2 :color "dark gray" :style nil))))
154 | "Modeline face for inactive MODIFIED element"
155 | :group 'bespoke-modeline-inactive)
156 |
157 |
158 |
159 | ;;; Modeline Options
160 | (defcustom bespoke-modeline-position 'top
161 | "Default modeline position (top or bottom)"
162 | :type '(choice
163 | (const :tag "Nil" nil)
164 | (const :tag "Top" top)
165 | (const :tag "Bottom" bottom))
166 | :group 'bespoke-modeline)
167 |
168 | (defcustom bespoke-modeline-user-mode nil
169 | "User supplied mode to be evaluated for modeline."
170 | :type '(choice (const nil) function)
171 | :group 'bespoke-modeline)
172 |
173 | (defcustom bespoke-modeline-size 3
174 | "Set the size of the modeline as an integer
175 | Initial value is 3."
176 | :group 'bespoke-modeline
177 | :type 'integer)
178 |
179 | (defcustom bespoke-modeline-cleaner nil
180 | "If t then show abbreviated mode symbol in modeline. Default is
181 | nil. To change the values of the major-mode symbols see the value
182 | of bespoke-modeline-cleaner-alist"
183 | :group 'bespoke-modeline
184 | :type 'boolean)
185 |
186 | (defcustom bespoke-modeline-git-diff-mode-line t
187 | "If t then show diff lines in modeline."
188 | :group 'bespoke-modeline
189 | :type 'boolean)
190 |
191 | (defcustom bespoke-modeline-vc-symbol ""
192 | "Symbol to use in buffers visiting files under version control"
193 | :group 'bespoke-modeline
194 | :type 'string)
195 |
196 | ;; Visual Bell
197 | (defcustom bespoke-modeline-visual-bell t
198 | "If t then use bespoke-modeline-visual-bell."
199 | :group 'bespoke-themes
200 | :type 'boolean)
201 |
202 | ;; Mode line symbols
203 | (defcustom bespoke-modeline-gui-ro-symbol " ⨂ "
204 | "Modeline gui read-only symbol."
205 | :group 'bespoke-modeline
206 | :type 'string)
207 |
208 | (defcustom bespoke-modeline-gui-mod-symbol " ⨀ "
209 | "Modeline gui modified symbol."
210 | :group 'bespoke-modeline
211 | :type 'string)
212 |
213 | (defcustom bespoke-modeline-gui-rw-symbol " ◯ "
214 | "Modeline gui read-write symbol."
215 | :group 'bespoke-modeline
216 | :type 'string)
217 |
218 | (defcustom bespoke-modeline-tty-ro-symbol " RO "
219 | "Modeline tty read-only symbol."
220 | :group 'bespoke-modeline
221 | :type 'string)
222 |
223 | (defcustom bespoke-modeline-tty-mod-symbol " ** "
224 | "Modeline tty modified symbol."
225 | :group 'bespoke-modeline
226 | :type 'string)
227 |
228 | (defcustom bespoke-modeline-tty-rw-symbol " RW "
229 | "Modeline tty read-write symbol."
230 | :group 'bespoke-modeline
231 | :type 'string)
232 |
233 | (defcustom bespoke-modeline-truncate-value 30
234 | "Value of modeline truncate-length function."
235 | :group 'bespoke-modeline
236 | :type 'integer)
237 |
238 | (defcustom bespoke-modeline-spacer ""
239 | "Space adjustment for right end of modeline."
240 | :type 'string
241 | :group 'bespoke-modeline)
242 |
243 | (defcustom bespoke-modeline-space-top +0.20
244 | "Space adjustment for top of modeline
245 | Possitive is upwards"
246 | :type 'float
247 | :group 'bespoke-modeline)
248 |
249 | (defcustom bespoke-modeline-space-bottom -0.25
250 | "Space adjustment for bottom of modeline
251 | Negative is downwards."
252 | :type 'float
253 | :group 'bespoke-modeline)
254 |
255 | ;;; Optional Functions
256 |
257 | ;;;; Visual bell for mode line
258 |
259 | ;; See https://github.com/hlissner/emacs-doom-themes for the idea
260 |
261 | (require 'face-remap)
262 |
263 | (defface bespoke-modeline-visual-bell '((t (:underline "red3")))
264 | "Face to use for the mode-line when `bespoke-modeline-visual-bell-config' is used."
265 | :group 'bespoke-modeline)
266 |
267 | ;;;###autoload
268 | (defun bespoke-modeline-visual-bell-fn ()
269 | "Blink the mode-line red briefly. Set `ring-bell-function' to this to use it."
270 | (let ((bespoke-modeline--bell-cookie (face-remap-add-relative 'mode-line 'bespoke-modeline-visual-bell)))
271 | (force-mode-line-update)
272 | (run-with-timer 0.15 nil
273 | (lambda (cookie buf)
274 | (with-current-buffer buf
275 | (face-remap-remove-relative cookie)
276 | (force-mode-line-update)))
277 | bespoke-modeline--bell-cookie
278 | (current-buffer))))
279 |
280 | ;;;###autoload
281 | (defun bespoke-modeline-visual-bell-config ()
282 | "Enable flashing the mode-line on error."
283 | (setq ring-bell-function #'bespoke-modeline-visual-bell-fn
284 | visible-bell t))
285 |
286 | (when bespoke-modeline-visual-bell
287 | (bespoke-modeline-visual-bell-config))
288 |
289 |
290 | ;;;; Clean mode line
291 | ;; Source: https://www.masteringemacs.org/article/hiding-replacing-modeline-strings
292 | (require 'cl-lib)
293 |
294 | (defvar bespoke-modeline-cleaner-alist
295 | `((dired-mode . "Dir")
296 | (emacs-lisp-mode . "EL")
297 | (fundamental-mode . "F")
298 | (helpful-mode . "")
299 | (help-mode . "")
300 | (lisp-interaction-mode . "λ")
301 | (markdown-mode . "MD")
302 | (magit-mode . "MG")
303 | (nxhtml-mode . "NX")
304 | (prog-mode . "PR")
305 | (python-mode . "PY")
306 | (text-mode . "TX")
307 | )
308 | "Alist for `bespoke-modeline/clean-mode-line'.
309 |
310 | When you add a new element to the alist, keep in mind that you
311 | must pass the correct minor/major mode symbol and a string you
312 | want to use in the modeline *as substitute for* the original.")
313 |
314 | (defun bespoke-modeline/clean-mode-line ()
315 | (interactive)
316 | (cl-loop for cleaner in bespoke-modeline-cleaner-alist
317 | do (let* ((mode (car cleaner))
318 | (mode-str (cdr cleaner))
319 | (old-mode-str (cdr (assq mode minor-mode-alist))))
320 | (when old-mode-str
321 | (setcar old-mode-str mode-str))
322 | ;; major mode
323 | (when (eq mode major-mode)
324 | (setq mode-name mode-str)))))
325 |
326 | (when bespoke-modeline-cleaner
327 | (add-hook 'after-change-major-mode-hook #'bespoke-modeline/clean-mode-line))
328 |
329 |
330 |
331 | ;;; Modeline Functions
332 | ;;;; Base Functions
333 | (defun bespoke-modeline-user-mode-p ()
334 | "Should the user supplied mode be called for modeline?"
335 | bespoke-modeline-user-mode)
336 |
337 | (defun bespoke-modeline-truncate (str size &optional ellipsis)
338 | "If STR is longer than SIZE, truncate it and add ELLIPSIS."
339 |
340 | (let ((ellipsis (or ellipsis "…")))
341 | (if (> (length str) size)
342 | (format "%s%s" (substring str 0 (- size (length ellipsis))) ellipsis)
343 | str)))
344 |
345 | (defun bespoke-modeline-mode-name ()
346 | "Return current major mode name"
347 | (format-mode-line mode-name))
348 |
349 | ;;;; Branch display
350 | ;; -------------------------------------------------------------------
351 | (defun bespoke-project-name ()
352 | "return name of project without path"
353 | (file-name-nondirectory (directory-file-name (if (vc-root-dir) (vc-root-dir) "-"))))
354 |
355 | (defun bespoke-modeline-vc-project-branch ()
356 | "If buffer is visiting a file under version control, show project and branch name for file. Otherwise show '-'"
357 | (let ((backend (vc-backend buffer-file-name)))
358 | (concat
359 | (if buffer-file-name
360 | (if vc-mode
361 | (let ((project-name (bespoke-project-name)))
362 | ;; Project name
363 | (unless (string= "-" project-name)
364 | (concat
365 | ;; Divider
366 | (propertize " •" 'face `(:inherit fringe))
367 | (format " %s" project-name)
368 | )))))
369 | ;; Show branch
370 | (if vc-mode
371 | (concat
372 | bespoke-modeline-vc-symbol (substring-no-properties vc-mode ;
373 | (+ (if (eq backend 'Hg) 2 3) 2))) nil))))
374 | ;;;; Git diff in modeline
375 | ;; https://cocktailmake.github.io/posts/emacs-modeline-enhancement-for-git-diff/
376 | (when bespoke-modeline-git-diff-mode-line
377 | (defadvice vc-git-mode-line-string (after plus-minus (file) compile activate)
378 | "Show the information of git diff on modeline."
379 | (setq ad-return-value
380 | (concat ad-return-value
381 | (let ((plus-minus (vc-git--run-command-string
382 | file "diff" "--numstat" "--")))
383 | (if (and plus-minus
384 | (string-match "^\\([0-9]+\\)\t\\([0-9]+\\)\t" plus-minus))
385 | (concat
386 | " "
387 | (format "+%s" (match-string 1 plus-minus))
388 | (format "-%s" (match-string 2 plus-minus)))
389 | (propertize "" 'face '(:weight bold))))))))
390 |
391 | ;;;; Dir display
392 |
393 |
394 | ;; From https://amitp.blogspot.com/2011/08/emacs-custom-mode-line.html
395 | (defun bespoke-modeline-shorten-directory (dir max-length)
396 | "Show up to `max-length' characters of a directory name `dir'."
397 | (let ((path (reverse (split-string (abbreviate-file-name dir) "/")))
398 | (output ""))
399 | (when (and path (equal "" (car path)))
400 | (setq path (cdr path)))
401 | (while (and path (< (length output) (- max-length 4)))
402 | (setq output (concat (car path) "/" output))
403 | (setq path (cdr path)))
404 | (when path
405 | (setq output (concat "…/" output)))
406 | output))
407 |
408 | ;;;; Mode line status
409 | ;; ---------------------------------------------------------------------
410 | (defun bespoke-modeline-status ()
411 | "Return buffer status: default symbols are read-only (⨂)/(RO),
412 | modified (⨀)/(**), or read-write (◯)/(RW)"
413 | (let ((read-only buffer-read-only)
414 | (modified (and buffer-file-name (buffer-modified-p))))
415 | ;; Use status letters for TTY display
416 | (cond
417 | (modified
418 | (if (display-graphic-p)
419 | bespoke-modeline-gui-mod-symbol
420 | bespoke-modeline-tty-mod-symbol))
421 | (read-only
422 | (if (display-graphic-p)
423 | bespoke-modeline-gui-ro-symbol
424 | bespoke-modeline-tty-ro-symbol))
425 | (t (if (display-graphic-p)
426 | bespoke-modeline-gui-rw-symbol
427 | bespoke-modeline-tty-rw-symbol)))))
428 |
429 | ;;;; Compose mode line
430 | ;; -------------------------------------------------------------------
431 |
432 | (defun bespoke-modeline-compose (status name primary secondary)
433 | "Compose a string with provided information"
434 | (let* ((char-width (window-font-width nil 'header-line))
435 | (window (get-buffer-window (current-buffer)))
436 | (active (eq window bespoke-modeline--selected-window))
437 | (prefix (if (display-graphic-p)
438 | (cond ((string= status bespoke-modeline-gui-ro-symbol)
439 | (propertize (if (window-dedicated-p)" –– " bespoke-modeline-gui-ro-symbol)
440 | 'face (if active
441 | 'bespoke-modeline-active-status-RO
442 | 'bespoke-modeline-inactive-status-RO)))
443 | ((string= status bespoke-modeline-gui-mod-symbol)
444 | (propertize (if (window-dedicated-p)" –– " bespoke-modeline-gui-mod-symbol)
445 | 'face (if active
446 | 'bespoke-modeline-active-status-**
447 | 'bespoke-modeline-inactive-status-**)))
448 | ((string= status bespoke-modeline-gui-rw-symbol)
449 | (propertize (if (window-dedicated-p) " –– " bespoke-modeline-gui-rw-symbol)
450 | 'face (if active 'bespoke-modeline-active-status-RW
451 | 'bespoke-modeline-inactive-status-RW)))
452 | (t (propertize status
453 | 'face (if active 'bespoke-modeline-active-status-**
454 | 'bespoke-modeline-inactive-status-**))))
455 | ;; TTY displays
456 | (cond ((string= status bespoke-modeline-tty-ro-symbol)
457 | (propertize
458 | (if (window-dedicated-p) " -- " bespoke-modeline-tty-ro-symbol)
459 | 'face (if active
460 | 'bespoke-modeline-active-status-RO
461 | 'bespoke-modeline-inactive-status-RO)))
462 | ((string= status bespoke-modeline-tty-mod-symbol)
463 | (propertize
464 | (if (window-dedicated-p) " -- " bespoke-modeline-tty-mod-symbol)
465 | 'face (if active
466 | 'bespoke-modeline-active-status-**
467 | 'bespoke-modeline-inactive-status-**)))
468 | ((string= status bespoke-modeline-tty-rw-symbol)
469 | (propertize
470 | (if (window-dedicated-p) " -- " bespoke-modeline-tty-rw-symbol)
471 | 'face (if active 'bespoke-modeline-active-status-RW
472 | 'bespoke-modeline-inactive-status-RW)))
473 | (t (propertize status
474 | 'face (if active 'bespoke-modeline-active-status-**
475 | 'bespoke-modeline-inactive-status-**))))))
476 |
477 | (left (concat
478 | (propertize " " 'face (if active 'bespoke-modeline-active
479 | 'bespoke-modeline-inactive)
480 | 'display `(raise ,bespoke-modeline-space-top))
481 | (propertize name 'face (if active 'bespoke-modeline-active-name
482 | 'bespoke-modeline-inactive-name))
483 | (propertize " " 'face (if active 'bespoke-modeline-active
484 | 'bespoke-modeline-inactive)
485 | 'display `(raise ,bespoke-modeline-space-bottom))
486 | (propertize primary 'face (if active 'bespoke-modeline-active-primary
487 | 'bespoke-modeline-inactive-primary))))
488 | (right (concat secondary " " bespoke-modeline-spacer))
489 |
490 | (available-width (- (window-total-width)
491 | (length prefix) (length left) (length right)
492 | (/ (window-right-divider-width) char-width)))
493 | (available-width (max 1 available-width)))
494 | (concat prefix
495 | left
496 | (propertize (make-string available-width ?\ )
497 | 'face (if active 'bespoke-modeline-active
498 | 'bespoke-modeline-inactive))
499 | (propertize right 'face (if active 'bespoke-modeline-active-secondary
500 | 'bespoke-modeline-inactive-secondary)))))
501 |
502 | ;;;; Default display
503 |
504 | (defun bespoke-modeline-default-mode ()
505 | (let ((buffer-name (format-mode-line (if buffer-file-name (file-name-nondirectory (buffer-file-name)) "%b")))
506 | (mode-name (bespoke-modeline-mode-name))
507 | (branch (bespoke-modeline-vc-project-branch))
508 | (position (format-mode-line "%l:%c ")))
509 | (bespoke-modeline-compose (bespoke-modeline-status)
510 | (bespoke-modeline-truncate buffer-name bespoke-modeline-truncate-value)
511 | (concat "(" mode-name
512 | (when branch
513 | branch)
514 | ")")
515 | (concat
516 | ;; Narrowed buffer
517 | (when (buffer-narrowed-p)
518 | (propertize "⇥ " 'face `(:inherit fringe)))
519 | position))))
520 |
521 | ;;;; Prog & Text Modes
522 | ;; ---------------------------------------------------------------------
523 | (defun bespoke-modeline-prog-mode-p ()
524 | (derived-mode-p 'prog-mode))
525 |
526 | (defun bespoke-modeline-elisp-mode-p ()
527 | (derived-mode-p 'lisp-data-mode))
528 |
529 | (defun bespoke-modeline-text-mode-p ()
530 | (derived-mode-p 'text-mode))
531 |
532 | ;;;; Info Display
533 | ;; ---------------------------------------------------------------------
534 | (setq Info-use-header-line nil)
535 | (defun bespoke-modeline-info-breadcrumbs ()
536 | (let ((nodes (Info-toc-nodes Info-current-file))
537 | (cnode Info-current-node)
538 | (node Info-current-node)
539 | (crumbs ())
540 | (depth Info-breadcrumbs-depth)
541 | line)
542 | (while (> depth 0)
543 | (setq node (nth 1 (assoc node nodes)))
544 | (if node (push node crumbs))
545 | (setq depth (1- depth)))
546 | (setq crumbs (cons "Top" (if (member (pop crumbs) '(nil "Top"))
547 | crumbs (cons nil crumbs))))
548 | (forward-line 1)
549 | (dolist (node crumbs)
550 | (let ((text
551 | (if (not (equal node "Top")) node
552 | (format "%s"
553 | (if (stringp Info-current-file)
554 | (file-name-sans-extension
555 | (file-name-nondirectory Info-current-file))
556 | Info-current-file)))))
557 | (setq line (concat line (if (null line) "" " > ")
558 | (if (null node) "..." text)))))
559 | (if (and cnode (not (equal cnode "Top")))
560 | (setq line (concat line (if (null line) "" " > ") cnode)))
561 | line))
562 |
563 | (defun bespoke-modeline-info-mode-p ()
564 | (derived-mode-p 'Info-mode))
565 |
566 | (defun bespoke-modeline-info-mode ()
567 | (bespoke-modeline-compose (bespoke-modeline-status)
568 | "Info"
569 | (concat "("
570 | (bespoke-modeline-info-breadcrumbs)
571 | ")")
572 | ""))
573 |
574 | ;;;; Term & Vterm
575 | ;; ---------------------------------------------------------------------
576 | ;; term
577 | (defun bespoke-modeline-term-mode-p ()
578 | (derived-mode-p 'term-mode))
579 |
580 | ;; vterm
581 | (defun bespoke-modeline-vterm-mode-p ()
582 | (derived-mode-p 'vterm-mode))
583 |
584 | (defun bespoke-modeline-term-mode ()
585 | (bespoke-modeline-compose " >_ "
586 | "Terminal"
587 | (concat "(" (file-name-nondirectory shell-file-name) ")")
588 | (bespoke-modeline-shorten-directory default-directory 32)))
589 |
590 | ;; ---------------------------------------------------------------------
591 |
592 | (defun bespoke-modeline-get-ssh-host (_str)
593 | (let ((split-defdir (split-string default-directory)))
594 | (if (equal (length split-defdir) 1)
595 | (car (split-string (shell-command-to-string "hostname") "\n"))
596 | (cadr split-defdir))))
597 |
598 | (defun bespoke-modeline-ssh-mode ()
599 | (bespoke-modeline-compose " >_ "
600 | "Terminal"
601 | (concat "(" (bespoke-modeline-get-ssh-host default-directory) ")")
602 | (bespoke-modelibe-shorten-directory (car (last (split-string default-directory ":"))) 32)))
603 |
604 | ;;;; Message Mode
605 | ;; ---------------------------------------------------------------------
606 | (defun bespoke-modeline-message-mode-p ()
607 | (derived-mode-p 'message-mode))
608 |
609 | (defun bespoke-modeline-message-mode ()
610 | (bespoke-modeline-compose (bespoke-modeline-status)
611 | "Message" "(draft)" ""))
612 |
613 | ;;;; Docview Mode
614 | ;;---------------------------------------------------------------------
615 | (defun bespoke-modeline-docview-mode-p ()
616 | (derived-mode-p 'doc-view-mode))
617 |
618 | (defun bespoke-modeline-docview-mode ()
619 | (let ((buffer-name (format-mode-line "%b"))
620 | (mode-name (bespoke-modeline-mode-name))
621 | (branch (bespoke-modeline-vc-project-branch))
622 | (page-number (concat
623 | (number-to-string (doc-view-current-page)) "/"
624 | (or (ignore-errors
625 | (number-to-string (doc-view-last-page-number)))
626 | "???"))))
627 | (bespoke-modeline-compose
628 | (bespoke-modeline-status)
629 | buffer-name
630 | (concat "(" mode-name
631 | branch
632 | ")" )
633 | page-number)))
634 |
635 | ;;;; PDF View Mode
636 | ;; ---------------------------------------------------------------------
637 | (defun bespoke-modeline-pdf-view-mode-p ()
638 | (derived-mode-p 'pdf-view-mode))
639 |
640 | (with-eval-after-load 'pdf-tools
641 | (require 'pdf-view))
642 |
643 | (defun bespoke-modeline-pdf-view-mode ()
644 | (let ((buffer-name (format-mode-line "%b"))
645 | (mode-name (bespoke-modeline-mode-name))
646 | (branch (bespoke-modeline-vc-project-branch))
647 | (page-number (concat
648 | (number-to-string (eval `(pdf-view-current-page))) "/"
649 | (or (ignore-errors
650 | (number-to-string (pdf-cache-number-of-pages)))
651 | "???"))))
652 | (bespoke-modeline-compose
653 | (bespoke-modeline-status)
654 | buffer-name
655 | (concat "(" mode-name
656 | branch
657 | ")" )
658 | (concat page-number " "))))
659 |
660 | ;;;; MenuMode
661 |
662 | (defun bespoke-modeline-buffer-menu-mode-p ()
663 | (derived-mode-p 'buffer-menu-mode))
664 |
665 | (defun bespoke-modeline-buffer-menu-mode ()
666 | (let ((buffer-name "Buffer list")
667 | (mode-name (bespoke-modeline-mode-name))
668 | (position (format-mode-line "%l:%c ")))
669 |
670 | (bespoke-modeline-compose (bespoke-modeline-status)
671 | buffer-name "" position)))
672 |
673 |
674 | ;;;; Completion
675 | ;; ---------------------------------------------------------------------
676 | (defun bespoke-modeline-completion-list-mode-p ()
677 | (derived-mode-p 'completion-list-mode))
678 |
679 | (defun bespoke-modeline-completion-list-mode ()
680 | (let ((buffer-name (format-mode-line "%b"))
681 | (mode-name (bespoke-modeline-mode-name))
682 | (position (format-mode-line "%l:%c ")))
683 |
684 | (bespoke-modeline-compose (bespoke-modeline-status)
685 | buffer-name "" position)))
686 |
687 | ;;;; Deft Mode
688 |
689 | (with-eval-after-load 'deft
690 | (defun deft-print-header ()
691 | (force-mode-line-update)
692 | (widget-insert "\n")))
693 |
694 | (defun bespoke-modeline-deft-mode-p ()
695 | (derived-mode-p 'deft-mode))
696 |
697 | (defun bespoke-modeline-deft-mode ()
698 | (let ((prefix " DEFT ")
699 | (primary "Search:")
700 | (filter (if deft-filter-regexp
701 | (deft-whole-filter-regexp) ""))
702 | (matches (if deft-filter-regexp
703 | (format "%d matches" (length deft-current-files))
704 | (format "%d notes" (length deft-all-files)))))
705 | (bespoke-modeline-compose prefix primary filter matches)))
706 |
707 | ;;;; Calendar Mode
708 | ;; ---------------------------------------------------------------------
709 | (defun bespoke-modeline-calendar-mode-p ()
710 | (derived-mode-p 'calendar-mode))
711 |
712 | (defun bespoke-modeline-calendar-mode () "")
713 |
714 | ;; Calendar (no header, only overline)
715 | (with-eval-after-load 'calendar
716 | (defun bespoke-modeline-calendar-setup-header ()
717 | (setq header-line-format "")
718 | (face-remap-add-relative
719 | 'header-line `(:overline ,(face-foreground 'default)
720 | :height 0.5
721 | :background ,(face-background 'default)))))
722 | (add-hook 'calendar-initial-window-hook #'bespoke-modeline-calendar-setup-header)
723 |
724 | ;;;; Org Capture
725 | ;; ---------------------------------------------------------------------
726 | (defun bespoke-modeline-org-capture-mode-p ()
727 | (bound-and-true-p org-capture-mode))
728 |
729 | (defun bespoke-modeline-org-capture-mode ()
730 | (bespoke-modeline-compose (bespoke-modeline-status)
731 | "Capture"
732 | "(Org)"
733 | ""))
734 |
735 | (with-eval-after-load 'org-capture
736 | (defun bespoke-modeline--org-capture-turn-off-header-line ()
737 | (setq-local header-line-format (default-value nil))
738 | (message nil))
739 | (add-hook 'org-capture-mode-hook
740 | #'bespoke-modeline--org-capture-turn-off-header-line))
741 |
742 | ;;;; Org Agenda
743 | ;; ---------------------------------------------------------------------
744 | (defun bespoke-modeline-org-agenda-mode-p ()
745 | (derived-mode-p 'org-agenda-mode))
746 |
747 | (defun bespoke-modeline-org-agenda-mode ()
748 | (bespoke-modeline-compose (bespoke-modeline-status)
749 | "Agenda"
750 | ""
751 | (concat (propertize "◴"
752 | 'face 'default
753 | 'display '(raise 0.06))
754 | (format-time-string "%H:%M "))))
755 |
756 | ;;;; Org Clock
757 | ;; ---------------------------------------------------------------------
758 | (defun bespoke-modeline-org-clock-mode-p ()
759 | (and (boundp 'org-mode-line-string)
760 | (stringp org-mode-line-string))
761 | (bespoke-modeline-org-clock-deactivate))
762 |
763 | (defun bespoke-modeline-org-clock-mode ()
764 | (let ((buffer-name (format-mode-line "%b"))
765 | (mode-name (bespoke-modeline-mode-name))
766 | (branch (bespoke-modeline-vc-project-branch))
767 | (position (format-mode-line "%l:%c")))
768 | (bespoke-modeline-compose (bespoke-modeline-status)
769 | buffer-name
770 | (concat "(" mode-name
771 | (when branch
772 | branch)
773 | ")" )
774 | (concat
775 | ;; Narrowed buffer
776 | (when (buffer-narrowed-p)
777 | (propertize "⇥ " 'face `(:inherit fringe)))
778 | org-mode-line-string
779 | " "
780 | position
781 | " "))))
782 |
783 | (defun bespoke-modeline-org-clock-out ()
784 | (setq org-mode-line-string nil)
785 | (force-mode-line-update))
786 |
787 | (defun bespoke-modeline-org-clock-deactivate ()
788 | (with-eval-after-load 'org-clock
789 | (add-hook 'org-clock-out-hook #'bespoke-modeline-org-clock-out)))
790 |
791 | ;;;; Elfeed
792 | (defun bespoke-modeline-elfeed-search-mode-p ()
793 | (derived-mode-p 'elfeed-search-mode))
794 |
795 | (defun bespoke-modeline-elfeed-search-mode ()
796 | (bespoke-modeline-compose (bespoke-modeline-status)
797 | "Elfeed"
798 | (concat "(" (elfeed-search--header) ")")
799 | ""))
800 |
801 | (defun bespoke-modeline-elfeed-setup-header ()
802 | (setq header-line-format (default-value 'header-line-format)))
803 |
804 | (defun bespoke-modeline-elfeed-show-mode-p ()
805 | (derived-mode-p 'elfeed-show-mode))
806 |
807 | (defun bespoke-modeline-elfeed-show-mode ()
808 | (let* ((title (elfeed-entry-title elfeed-show-entry))
809 | (tags (elfeed-entry-tags elfeed-show-entry))
810 | (tags-str (mapconcat #'symbol-name tags ", "))
811 | (date (seconds-to-time (elfeed-entry-date elfeed-show-entry)))
812 | (feed (elfeed-entry-feed elfeed-show-entry))
813 | (feed-title (plist-get (elfeed-feed-meta feed) :title))
814 | (entry-author (elfeed-meta elfeed-show-entry :author)))
815 | (bespoke-modeline-compose (bespoke-modeline-status)
816 | (bespoke-modeline-truncate title 40)
817 | (concat "(" tags-str ")")
818 | feed-title)))
819 |
820 | ;;;; Mu4e
821 |
822 | (defun bespoke-modeline-mu4e-last-query ()
823 | "Get the most recent mu4e query or nil if there is none."
824 | (if (fboundp 'mu4e-last-query)
825 | (mu4e-last-query)
826 | mu4e~headers-last-query))
827 |
828 | (defun bespoke-modeline-mu4e-context ()
829 | "Return the current mu4e context as a non propertized string."
830 |
831 | (if (> (length (mu4e-context-label)) 0)
832 | (concat "(" (substring-no-properties (mu4e-context-label) 1 -1) ")")
833 | "(none)"))
834 |
835 | (defun bespoke-modeline-mu4e-server-props ()
836 | "Encapsulates the call to the variable mu4e-/~server-props
837 | depending on the version of mu4e."
838 | (if (string> mu4e-mu-version "1.6.5")
839 | mu4e--server-props
840 | mu4e~server-props))
841 |
842 | (defun bespoke-modeline-mu4e-activate ()
843 | (with-eval-after-load 'mu4e
844 | (advice-add 'mu4e~header-line-format :override #'bespoke-modeline)))
845 |
846 | (defun bespoke-modeline-mu4e-deactivate ()
847 | (advice-remove #'mu4e~header-line-format #'bespoke-modeline))
848 |
849 | ;; ---------------------------------------------------------------------
850 | (defun bespoke-modeline-mu4e-dashboard-mode-p ()
851 | (bound-and-true-p mu4e-dashboard-mode))
852 |
853 | (defun bespoke-modeline-mu4e-dashboard-mode ()
854 | (bespoke-modeline-compose (bespoke-modeline-status)
855 | (format "%d messages"
856 | (plist-get (bespoke-modeline-mu4e-server-props) :doccount))
857 | ""
858 | " "))
859 |
860 | ;; ---------------------------------------------------------------------
861 | (defun bespoke-modeline-mu4e-loading-mode-p ()
862 | (derived-mode-p 'mu4e-loading-mode))
863 |
864 |
865 | (defun bespoke-modeline-mu4e-loading-mode ()
866 | (bespoke-modeline-compose (bespoke-modeline-status)
867 | "Loading..."
868 | (bespoke-modeline-mu4e-context)
869 | (format-time-string "%A %d %B %Y, %H:%M ")))
870 |
871 | ;; ---------------------------------------------------------------------
872 | (defun bespoke-modeline-mu4e-main-mode-p ()
873 | (derived-mode-p 'mu4e-main-mode))
874 |
875 | (defun bespoke-modeline-mu4e-main-mode ()
876 | (bespoke-modeline-compose (bespoke-modeline-status)
877 | (bespoke-modeline-mu4e-context)
878 | ""
879 | (format-time-string "%A %d %B %Y, %H:%M ")))
880 |
881 | ;; ---------------------------------------------------------------------
882 | (defun bespoke-modeline-mu4e-compose-mode-p ()
883 | (derived-mode-p 'mu4e-compose-mode))
884 |
885 | (defun bespoke-modeline-mu4e-compose-mode ()
886 | (bespoke-modeline-compose (bespoke-modeline-status)
887 | (format-mode-line "%b")
888 | ""
889 | (format "[%s] "
890 | (bespoke-modeline-mu4e-quote
891 | (mu4e-context-name (mu4e-context-current))))))
892 |
893 | ;; ---------------------------------------------------------------------
894 | (defun bespoke-modeline-mu4e-quote (str)
895 | (if (version< "1.6.5" mu4e-mu-version)
896 | (mu4e~quote-for-modeline str)
897 | (mu4e-quote-for-modeline str)))
898 |
899 | (defun bespoke-modeline-mu4e-headers-mode-p ()
900 | (derived-mode-p 'mu4e-headers-mode))
901 |
902 | (defun bespoke-modeline-mu4e-headers-mode ()
903 | (let ((mu4e-modeline-max-width 80))
904 | (bespoke-modeline-compose (bespoke-modeline-status)
905 | "Search:"
906 | (or (bespoke-modeline-mu4e-quote
907 | (bespoke-modeline-mu4e-last-query)) "")
908 | (format "[%s] "
909 | (bespoke-modeline-mu4e-quote
910 | (mu4e-context-name (mu4e-context-current)))))))
911 |
912 | ;; ---------------------------------------------------------------------
913 | (defun bespoke-modeline-mu4e-view-mode-p ()
914 | (derived-mode-p 'mu4e-view-mode))
915 |
916 | (defun bespoke-modeline-mu4e-view-mode ()
917 | (let* ((msg (mu4e-message-at-point))
918 | (subject (mu4e-message-field msg :subject))
919 | (from (mu4e~headers-contact-str (mu4e-message-field msg :from)))
920 | (date (mu4e-message-field msg :date)))
921 | (bespoke-modeline-compose (bespoke-modeline-status)
922 | (or from "")
923 | (concat "(" (bespoke-modeline-truncate (or subject "") 50 "…") ")")
924 | (concat (or (format-time-string mu4e-headers-date-format date) "") " "))))
925 |
926 | ;;;; Help
927 |
928 | (defun bespoke-modeline-bespoke-help-mode-p ()
929 | (derived-mode-p 'bespoke-help-mode))
930 |
931 | (defun bespoke-modeline-bespoke-help-mode ()
932 | (bespoke-modeline-compose (bespoke-modeline-status)
933 | "GNU Emacs"
934 | "(help)"
935 | ""))
936 |
937 | ;;;; Ein
938 |
939 | (defun bespoke-modeline-ein-notebook-mode ()
940 | (let ((buffer-name (format-mode-line "%b")))
941 | (bespoke-modeline-compose (if (ein:notebook-modified-p) "**" "RW")
942 | buffer-name
943 | ""
944 | (ein:header-line))))
945 |
946 | ;;; Set Mode line
947 |
948 | ;;;; Clear Modeline Faces
949 |
950 | (defun bespoke-modeline-face-clear (face)
951 | "Clear FACE"
952 | (set-face-attribute face nil
953 | :foreground 'unspecified :background 'unspecified
954 | :family 'unspecified :slant 'unspecified
955 | :weight 'unspecified :height 'unspecified
956 | :underline 'unspecified :overline 'unspecified
957 | :box 'unspecified :inherit 'unspecified))
958 |
959 |
960 | ;;;; Define Selected Window
961 |
962 | (defvar bespoke-modeline--saved-mode-line-format nil)
963 | (defvar bespoke-modeline--saved-header-line-format nil)
964 | (defvar bespoke-modeline--selected-window nil)
965 |
966 | (defun bespoke-modeline--update-selected-window ()
967 | "Update selected window (before mode-line is active)"
968 | (setq bespoke-modeline--selected-window (selected-window)))
969 |
970 | ;;;; Set content for mode/header line
971 |
972 | (defun bespoke-modeline ()
973 | "Build and set the modeline."
974 |
975 | (let* ((format
976 | '((:eval
977 | (cond
978 | ((bespoke-modeline-user-mode-p) (funcall ,bespoke-modeline-user-mode))
979 | ((bespoke-modeline-prog-mode-p) (bespoke-modeline-default-mode))
980 | ((bespoke-modeline-message-mode-p) (bespoke-modeline-message-mode))
981 | ((bespoke-modeline-elfeed-search-mode-p) (bespoke-modeline-elfeed-search-mode))
982 | ((bespoke-modeline-elfeed-show-mode-p) (bespoke-modeline-elfeed-show-mode))
983 | ((bespoke-modeline-deft-mode-p) (bespoke-modeline-deft-mode))
984 | ((bespoke-modeline-info-mode-p) (bespoke-modeline-info-mode))
985 | ((bespoke-modeline-calendar-mode-p) (bespoke-modeline-calendar-mode))
986 | ((bespoke-modeline-org-capture-mode-p) (bespoke-modeline-org-capture-mode))
987 | ((bespoke-modeline-org-agenda-mode-p) (bespoke-modeline-org-agenda-mode))
988 | ((bespoke-modeline-org-clock-mode-p) (bespoke-modeline-org-clock-mode))
989 | ((bespoke-modeline-term-mode-p) (bespoke-modeline-term-mode))
990 | ((bespoke-modeline-vterm-mode-p) (bespoke-modeline-term-mode))
991 | ((bespoke-modeline-mu4e-dashboard-mode-p) (bespoke-modeline-mu4e-dashboard-mode))
992 | ((bespoke-modeline-mu4e-main-mode-p) (bespoke-modeline-mu4e-main-mode))
993 | ((bespoke-modeline-mu4e-loading-mode-p) (bespoke-modeline-mu4e-loading-mode))
994 | ((bespoke-modeline-mu4e-headers-mode-p) (bespoke-modeline-mu4e-headers-mode))
995 | ((bespoke-modeline-mu4e-view-mode-p) (bespoke-modeline-mu4e-view-mode))
996 | ((bespoke-modeline-text-mode-p) (bespoke-modeline-default-mode))
997 | ((bespoke-modeline-pdf-view-mode-p) (bespoke-modeline-pdf-view-mode))
998 | ((bespoke-modeline-docview-mode-p) (bespoke-modeline-docview-mode))
999 | ((bespoke-modeline-buffer-menu-mode-p) (bespoke-modeline-buffer-menu-mode))
1000 | ((bespoke-modeline-completion-list-mode-p) (bespoke-modeline-completion-list-mode))
1001 | ((bespoke-modeline-bespoke-help-mode-p) (bespoke-modeline-bespoke-help-mode))
1002 | (t (bespoke-modeline-default-mode)))))))
1003 |
1004 | (if (eq bespoke-modeline-position 'top)
1005 | (progn
1006 | (setq-default mode-line-format (list (propertize "%_" 'face `(:inherit fringe))))
1007 | (setq header-line-format format)
1008 | (setq-default header-line-format format))
1009 | (progn
1010 | (setq mode-line-format format)
1011 | (setq-default mode-line-format format)))))
1012 |
1013 |
1014 | (defun bespoke-modeline-mode--activate ()
1015 | "Activate bespoke modeline"
1016 |
1017 | ;; Save current mode-line and header-line
1018 | (unless bespoke-modeline--saved-mode-line-format
1019 | (setq bespoke-modeline--saved-mode-line-format mode-line-format)
1020 | (setq bespoke-modeline--saved-header-line-format header-line-format))
1021 |
1022 | ;; since the EIN library itself is constantly re-rendering the notebook, and thus
1023 | ;; re-setting the header-line-format, we cannot use the bespoke-modeline function to set
1024 | ;; the header format in a notebook buffer. Fortunately, EIN exposes the
1025 | ;; ein:header-line-format variable for just this purpose.
1026 | (with-eval-after-load 'ein
1027 | (if (eq bespoke-modeline-position 'top)
1028 | (setq ein:header-line-format '((:eval (bespoke-modeline-ein-notebook-mode))))))
1029 |
1030 | ;; Elfeed uses header-line, we need to tell it to use our own format
1031 | (with-eval-after-load 'elfeed
1032 | (if (eq bespoke-modeline-position 'top)
1033 | (setq elfeed-search-header-function #'bespoke-modeline-elfeed-setup-header)))
1034 |
1035 | (with-eval-after-load 'calendar
1036 | (add-hook 'calendar-initial-window-hook
1037 | #'bespoke-modeline-calendar-setup-header))
1038 |
1039 | (with-eval-after-load 'org-capture
1040 | (add-hook 'org-capture-mode-hook
1041 | #'bespoke-modeline--org-capture-turn-off-header-line))
1042 |
1043 | (with-eval-after-load 'esh-mode
1044 | (setq eshell-status-in-mode-line nil))
1045 |
1046 | (with-eval-after-load 'mu4e
1047 | (advice-add 'mu4e~header-line-format :override #'bespoke-modeline))
1048 |
1049 | (if (eq bespoke-modeline-position 'top)
1050 | (setq Info-use-header-line nil))
1051 |
1052 | (if (eq bespoke-modeline-position 'top)
1053 | (setq Buffer-menu-use-header-line nil))
1054 |
1055 | ;; Update selected window
1056 | (bespoke-modeline--update-selected-window)
1057 |
1058 | (setq mode-line-format nil)
1059 | (setq-default mode-line-format nil)
1060 | (setq header-line-format nil)
1061 | (setq-default header-line-format nil)
1062 |
1063 | (bespoke-modeline)
1064 |
1065 | ;; This hook is necessary to register selected window because when
1066 | ;; a modeline is evaluated, the corresponding window is always selected.
1067 | (add-hook 'post-command-hook #'bespoke-modeline--update-selected-window)
1068 | (force-mode-line-update t))
1069 |
1070 |
1071 | (defun bespoke-modeline-mode--deactivate ()
1072 | "Deactivate bespoke mode-line and restore default mode-line"
1073 |
1074 | (custom-reevaluate-setting 'Info-use-header-line)
1075 | (custom-reevaluate-setting 'Buffer-menu-use-header-line)
1076 | (custom-reevaluate-setting 'eshell-status-in-mode-line)
1077 |
1078 | (if (boundp 'ein:header-line-format)
1079 | (setq ein:header-line-format '(:eval (ein:header-line))))
1080 | (if (boundp 'elfeed-search-header-function)
1081 | (setq elfeed-search-header-function #'elfeed-search--header))
1082 |
1083 | (remove-hook 'calendar-initial-window-hook
1084 | #'bespoke-modeline-calendar-setup-header)
1085 | (remove-hook 'org-capture-mode-hook
1086 | #'bespoke-modeline--org-capture-turn-off-header-line)
1087 | (remove-hook 'org-clock-out-hook
1088 | #'bespoke-modeline-org-clock-out)
1089 | (remove-hook 'post-command-hook
1090 | #'bespoke-modeline--update-selected-window)
1091 | (advice-remove 'mu4e~header-line-format #'bespoke-modeline)
1092 |
1093 | (setq mode-line-format bespoke-modeline--saved-mode-line-format)
1094 | (setq-default mode-line-format bespoke-modeline--saved-mode-line-format)
1095 | (setq header-line-format bespoke-modeline--saved-header-line-format)
1096 | (setq-default header-line-format bespoke-modeline--saved-header-line-format))
1097 |
1098 |
1099 | ;;;###autoload
1100 | (define-minor-mode bespoke-modeline-mode
1101 | "Toggle bespoke-modeline minor mode"
1102 | :group 'bespoke-modeline
1103 | :global t
1104 | :init-value nil
1105 |
1106 | (if bespoke-modeline-mode
1107 | (progn
1108 | ;; (bespoke-modeline--set-line-faces)
1109 | (bespoke-modeline-mode--activate))
1110 | (bespoke-modeline-mode--deactivate))
1111 |
1112 | ;; Run any registered hooks
1113 | (run-hooks 'bespoke-modeline-mode-hook))
1114 |
1115 | ;; Toggle functions
1116 | (defun bespoke-modeline-get-current-theme ()
1117 | "Determines the currently enabled theme."
1118 | (or (car custom-enabled-themes) '*default*))
1119 |
1120 | ;;;###autoload
1121 | (defun bespoke-modeline-reload-current-theme ()
1122 | "Reloads the currently activated theme."
1123 | (bespoke-modeline-enable-theme (bespoke-modeline-get-current-theme)))
1124 |
1125 | ;;;###autoload
1126 | (defun bespoke-modeline-enable-theme (theme)
1127 | "Enables the specified color-theme.
1128 | Pass `*default*' to select Emacs defaults."
1129 | (cl-flet* ((disable-all-themes ()
1130 | (mapcar 'disable-theme
1131 | custom-enabled-themes)))
1132 | (disable-all-themes)
1133 | (condition-case nil
1134 | (when (not (eq theme '*default*))
1135 | (load-theme theme t))
1136 | (error nil))))
1137 |
1138 | (defun bespoke-modeline--set-line-faces ()
1139 | (cond ((and (fboundp 'bespoke-modeline)
1140 | (eq bespoke-modeline-position 'top))
1141 | (custom-set-faces
1142 | ;; '(mode-line-active ((t (:inherit fixed-pitch))))
1143 | ;; '(header-line ((t (:height 2))))
1144 | '(mode-line ((t (:height 0.1 :underline "light gray" :overline nil :box nil))))
1145 | '(mode-line-inactive ((t (:height 0.1 :underline "light gray" :overline nil :box nil))))))
1146 | ;; Modeline at footer
1147 | ((and (fboundp 'bespoke-modeline)
1148 | (eq bespoke-modeline-position 'bottom))
1149 | (custom-set-faces
1150 | '(mode-line ((t (:height 1))))
1151 | '(mode-line-inactive ((t (:height 1))))))))
1152 |
1153 | (defun bespoke-modeline-toggle ()
1154 | "Toggle between a modeline in header or one at footer. Note that
1155 | this function reloads the theme to properly set colors and that
1156 | you may need to revert buffers to see the modeline properly."
1157 | (interactive)
1158 | (if (eq bespoke-modeline-position 'top)
1159 | (progn
1160 | (bespoke-modeline-face-clear 'mode-line)
1161 | (setq bespoke-modeline-position 'bottom)
1162 | (bespoke-modeline-mode--deactivate)
1163 | ;; (bespoke-modeline--set-line-faces)
1164 | (bespoke-modeline-mode--activate)
1165 | (bespoke-modeline-reload-current-theme)
1166 | (run-hooks 'bespoke-modeline-mode-hook))
1167 | (progn
1168 | (setq bespoke-modeline-position 'top)
1169 | (bespoke-modeline-mode--deactivate)
1170 | ;; (bespoke-modeline--set-line-faces)
1171 | (setq-default mode-line-format (list (propertize "%_" 'face `(:inherit fringe))))
1172 | (bespoke-modeline-mode--activate)
1173 | (bespoke-modeline-reload-current-theme)
1174 | (run-hooks 'bespoke-modeline-mode-hook))))
1175 |
1176 | (provide 'bespoke-modeline)
1177 | ;;; bespoke-modeline.el ends here
1178 |
--------------------------------------------------------------------------------