├── LICENSE
├── README.md
└── viking-mode.el
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 | {description}
294 | Copyright (C) {year} {fullname}
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | {signature of Ty Coon}, 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # viking-mode
2 | Kill first, ask later - an emacs minor mode for killing things quickly
3 |
4 | [](http://melpa.org/#/viking-mode)
5 |
6 | # Demo
7 |
8 | 
9 |
10 | # Introduction
11 |
12 | Viking minor mode enables you to delete things at point with one key
13 | stroke at once. More and more will be deleted if you repeat the key
14 | stroke. As visual feedback the thing to be deleted will be highlighted
15 | shortly.
16 |
17 | The default key binding is C-d, but you may also bind it to C-k or
18 | whatever you wish.
19 |
20 | If you press C-d the first time, the word at point will be deleted
21 | (but if there's no word at point but whitespaces or an empty line,
22 | they will be deleted instead, which is the same as M-SPC).
23 |
24 | Like:
25 |
26 | [keep pressing ctrl] C-d - word | spc
27 | C-d C-d - line remainder
28 | C-d C-d C-d - line
29 | C-d C-d C-d C-d - paragraph
30 | C-d C-d C-d C-d C-d - buffer
31 |
32 | However, this only works when pressing the key in a row. If you do
33 | something else in between, it starts from scratch (i.e. delete word).
34 |
35 | You can also repeat the last delete function with C-S-d (ctrl-shift-d)
36 | multiple times.
37 |
38 | By default viking-mode is greedy: after applying a kill function it
39 | looks if point ends up alone on an empty line or inside whitespaces.
40 | In such a case, those will be deleted as well. The greedy behavior may
41 | be turned off however.
42 |
43 | Another variant is to use viking mode together with the great
44 | expand-region mode (available on melpa). If installed and enabled, a
45 | region is first marked using expand-region and then deleted. This
46 | makes the deletion cascade language aware.
47 |
48 | # Install
49 |
50 | To use, save viking-mode.el to a directory in your load-path.
51 |
52 | Add something like this to your config:
53 |
54 | (require 'viking-mode)
55 | (add-hook 'text-mode-hook 'viking-mode)
56 |
57 | or load it manually
58 |
59 | M-x viking-mode
60 |
61 | However, it's also possible to enable viking-mode globally:
62 |
63 | (viking-global-mode)
64 |
65 | # Customize
66 |
67 | By default viking-mode doesn't really delete things, everything
68 | remains available for yanking in the kill ring. However, you may turn
69 | it into berserk mode by setting 'viking-really-delete to t:
70 |
71 | (setq viking-really-delete t)
72 |
73 | To turn off greedy deleting of whitespace remainders, set
74 | 'viking-greedy-kill to nil:
75 |
76 | (setq viking-greedy-kill nil)
77 |
78 | To enable quick deletion of regions using the normal key binding:
79 |
80 | (setq viking-enable-region-kill t)
81 |
82 | To turn off short blinking of deleted things (visual feedback):
83 |
84 | (setq viking-enable-blinking nil)
85 |
86 | You can change the default key binding by:
87 |
88 | (define-key viking-mode-map (kbd "C-k") 'viking-kill-thing-at-point)
89 |
90 | The key binding to repeat the last kill function can be changed:
91 |
92 | (define-key viking-mode-map (kbd "M-d") 'viking-repeat-last-kill)
93 |
94 | In case you don't like the default key binding cascade, you may also
95 | use separate bindings for each kill function, e.g.:
96 |
97 | (define-key viking-mode-map (kbd "C-d") nil) turn C-d into a prefix-key
98 | (define-key viking-mode-map (kbd "C-d w") 'viking-kill-word)
99 | (define-key viking-mode-map (kbd "C-d r") 'viking-kill-line-from-point)
100 | (define-key viking-mode-map (kbd "C-d l") 'viking-kill-line)
101 | (define-key viking-mode-map (kbd "C-d p") 'viking-kill-paragraph)
102 | (define-key viking-mode-map (kbd "C-d a") 'viking-kill-buffer)
103 |
104 | To use viking-mode with expand-region:
105 |
106 | (setq viking-use-expand-region-when-loaded t)
107 | (require 'expand-region)
108 | (global-set-key (kbd "C-=") 'er/expand-region)
109 |
110 | Also, the font face of the short highlight can be modified:
111 |
112 | M-x customize-face (select viking-blink)
113 |
114 | The kill functions to be called in a row can be customized as well. The
115 | default is this list:
116 |
117 | (setq viking-kill-functions (list 'viking-kill-word
118 | 'viking-kill-line-from-point
119 | 'viking-kill-line
120 | 'viking-kill-paragraph
121 | 'viking-kill-buffer))
122 |
123 | Normally there should be no need to modify it. However, this gives
124 | you much more flexibility.
125 |
126 | Or, modify all available viking-mode variables interactively with:
127 |
128 | M-x customize-group (select viking-mode)
129 |
130 | # Tips
131 |
132 | Besides, the primary function of viking-mode is viking-last-key-repeats,
133 | which returns the number of times the last key have been pressed.
134 | This can be used for other things as well, for example:
135 |
136 | (defun goto-begin()
137 | (interactive)
138 | (let* ((key-times (viking-last-key-repeats)))
139 | (cond
140 | ((eq key-times 3)
141 | (if mark-active
142 | (goto-char (point-min))
143 | (beginning-of-buffer)))
144 | ((eq key-times 2)
145 | (if mark-active () (push-mark))
146 | (move-to-window-line 0))
147 | ((eq key-times 1)
148 | (beginning-of-line)))))
149 |
150 | (defun goto-end ()
151 | (interactive)
152 | (let* ((key-times (viking-last-key-repeats)))
153 | (cond
154 | ((eq key-times 3)
155 | (if mark-active
156 | (goto-char (point-max))
157 | (end-of-buffer)))
158 | ((eq key-times 2)
159 | (if mark-active () (push-mark))
160 | (move-to-window-line -1)
161 | (end-of-line))
162 | ((eq key-times 1)
163 | (end-of-line)))))
164 |
165 | (global-set-key (kbd "") 'goto-begin)
166 | (global-set-key (kbd "") 'goto-end)
167 |
168 | When you put this into your .emacs config, then you can do:
169 |
170 | hit once: goto beginning of current line
171 | repeat: goto beginning of current window
172 | repeat: goto beginning of current buffer
173 |
174 | (and the same with `````` in the other direction)
175 |
176 | # Reporting Bugs
177 |
178 | Goto https://github.com/tlinden/viking-mode and file a new issue.
179 |
180 | # Meta
181 |
182 | Copyright (C) 2016, T.v.Dein
183 |
184 | This file is NOT part of Emacs.
185 |
186 | This program is free software; you can redistribute it and/or modify
187 | it under the terms of the GNU General Public License as published by
188 | the Free Software Foundation; either version 2 of the License, or (at
189 | your option) any later version.
190 |
191 | This program is distributed in the hope that it will be useful, but
192 | WITHOUT ANY WARRANTY; without even the implied warranty of
193 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
194 | General Public License for more details.
195 |
196 | You should have received a copy of the GNU General Public License
197 | along with this program; if not, write to the Free Software
198 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
199 | USA
200 |
201 | Version : 0.08
202 | Author : T.v.Dein
203 | Keywords : kill delete
204 | URL : https://github.com/tlinden/viking-mode
205 | License : GNU General Public License >= 2
206 |
--------------------------------------------------------------------------------
/viking-mode.el:
--------------------------------------------------------------------------------
1 | ;;; viking-mode.el --- kill first, ask later
2 |
3 | ;; Copyright (C) 2016, T.v.Dein
4 |
5 | ;; This file is NOT part of Emacs.
6 |
7 | ;; This program is free software; you can redistribute it and/or
8 | ;; modify it under the terms of the GNU General Public License as
9 | ;; published by the Free Software Foundation; either version 2 of the
10 | ;; License, or (at your option) any later version.
11 |
12 | ;; This program is distributed in the hope that it will be useful, but
13 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 | ;; General Public License for more details.
16 |
17 | ;; You should have received a copy of the GNU General Public License
18 | ;; along with this program; if not, write to the Free Software
19 | ;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 | ;; USA
21 |
22 | ;; Version: 0.08
23 | ;; Author: T.v.Dein
24 | ;; Keywords: kill delete
25 | ;; URL: https://github.com/tlinden/viking-mode
26 | ;; License: GNU General Public License >= 2
27 |
28 | ;;; Commentary:
29 |
30 | ;; Viking minor mode enables you to delete things at point with one
31 | ;; key stroke at once. More and more will be deleted if you repeat the
32 | ;; key stroke. As visual feedback the thing to be deleted will be
33 | ;; highlighted shortly.
34 |
35 | ;; The default key binding is C-d, but you may also bind it to C-k or
36 | ;; whatever you wish.
37 |
38 | ;; If you press C-d the first time, the word at point will be deleted
39 | ;; (but if there's no word at point but whitespaces or an empty line,
40 | ;; they will be deleted instead, which is the same as M-SPC).
41 |
42 | ;; If you press C-d again, the remainder of the line from point will
43 | ;; be deleted. If pressed again, the whole line, then the paragraph
44 | ;; and finally the whole buffer will be deleted.
45 |
46 | ;; Like:
47 | ;; [keep pressing ctrl] C-d - del word | spc
48 | ;; C-d C-d - del line remainder
49 | ;; C-d C-d C-d - del line
50 | ;; C-d C-d C-d C-d - del paragraph
51 | ;; C-d C-d C-d C-d C-d - del buffer
52 |
53 | ;; However, this only works when pressing the key in a row. If you do
54 | ;; something else in between, it starts from scratch (i.e. delete
55 | ;; word).
56 |
57 | ;; You can also repeat the last delete function with C-S-d (ctrl-shift-d)
58 | ;; multiple times.
59 |
60 | ;; By default viking-mode is greedy: after applying a kill function it
61 | ;; looks if point ends up alone on an empty line or inside
62 | ;; whitespaces. In such a case, those will be deleted as well. The
63 | ;; greedy behavior may be turned off however.
64 |
65 | ;; Another variant is to use viking mode together with the great
66 | ;; expand-region mode (available on melpa). If installed and enabled,
67 | ;; a region is first marked using expand-region and then deleted.
68 | ;; This makes the deletion cascade language aware.
69 |
70 | ;;; Install:
71 |
72 | ;; To use, save viking-mode.el to a directory in your load-path.
73 |
74 | ;; Add something like this to your config:
75 |
76 | ;; (require 'viking-mode)
77 | ;; (add-hook 'text-mode-hook 'viking-mode)
78 |
79 | ;; or load it manually, when needed:
80 |
81 | ;; M-x viking-mode
82 |
83 | ;; However, it's also possible to enable viking-mode globally:
84 |
85 | ;; (viking-global-mode)
86 |
87 | ;;; Customize:
88 |
89 | ;; By default viking-mode doesn't really delete things, everything
90 | ;; remains available for yanking in the kill ring. However, you may
91 | ;; turn it into berserk mode by setting 'viking-really-delete to t:
92 |
93 | ;; (setq viking-really-delete t)
94 |
95 | ;; To turn off greedy deleting of whitespace remainders, set
96 | ;; 'viking-greedy-kill to nil:
97 |
98 | ;; (setq viking-greedy-kill nil)
99 |
100 | ;; To enable quick deletion of regions using the normal key binding:
101 |
102 | ;; (setq viking-enable-region-kill t)
103 |
104 | ;; To turn off short blinking of deleted things (visual feedback):
105 |
106 | ;; (setq viking-enable-blinking nil)
107 |
108 | ;; You can change the default key binding by:
109 |
110 | ;; (define-key viking-mode-map (kbd "C-k") 'viking-kill-thing-at-point)
111 |
112 | ;; The key binding to repeat the last kill function can be changed:
113 |
114 | ;; (define-key viking-mode-map (kbd "M-d") 'viking-repeat-last-kill)
115 |
116 | ;; In case you don't like the default key binding cascade, you may
117 | ;; also use separate bindings for each kill function, e.g.:
118 |
119 | ;; (define-key viking-mode-map (kbd "C-d") nil) ;; turn C-d into a prefix-key
120 | ;; (define-key viking-mode-map (kbd "C-d w") 'viking-kill-word)
121 | ;; (define-key viking-mode-map (kbd "C-d r") 'viking-kill-line-from-point)
122 | ;; (define-key viking-mode-map (kbd "C-d l") 'viking-kill-line)
123 | ;; (define-key viking-mode-map (kbd "C-d p") 'viking-kill-paragraph)
124 | ;; (define-key viking-mode-map (kbd "C-d a") 'viking-kill-buffer)
125 |
126 | ;; To use viking-mode with expand-region:
127 |
128 | ;; (setq viking-use-expand-region-when-loaded t)
129 | ;; (require 'expand-region)
130 | ;; (global-set-key (kbd "C-=") 'er/expand-region)
131 |
132 | ;; Also, the font face of the short highlight can be modified:
133 |
134 | ;; M-x customize-face (select viking-blink)
135 |
136 | ;; The kill functions to be called in a row can be customized as well. The
137 | ;; default is this list:
138 |
139 | ;; (setq viking-kill-functions (list 'viking-kill-word
140 | ;; 'viking-kill-line-from-point
141 | ;; 'viking-kill-line
142 | ;; 'viking-kill-paragraph
143 | ;; 'viking-kill-buffer))
144 |
145 | ;; Normally there should be no need to modify it. However, this gives
146 | ;; you much more flexibility.
147 |
148 | ;; Or, modify all available viking-mode variables interactively with:
149 |
150 | ;; M-x customize-group (select viking-mode)
151 |
152 | ;;; Tips:
153 |
154 | ;; Besides, the primary function of viking-mode is viking-last-key-repeats,
155 | ;; which returns the number of times the last key have been pressed.
156 | ;; This can be used for other things as well, for example:
157 |
158 | ;; (defun goto-begin()
159 | ;; (interactive)
160 | ;; (let* ((key-times (viking-last-key-repeats)))
161 | ;; (cond
162 | ;; ((eq key-times 3)
163 | ;; (if mark-active
164 | ;; (goto-char (point-min))
165 | ;; (beginning-of-buffer)))
166 | ;; ((eq key-times 2)
167 | ;; (if mark-active () (push-mark))
168 | ;; (move-to-window-line 0))
169 | ;; ((eq key-times 1)
170 | ;; (beginning-of-line)))))
171 |
172 | ;; (defun goto-end ()
173 | ;; (interactive)
174 | ;; (let* ((key-times (viking-last-key-repeats)))
175 | ;; (cond
176 | ;; ((eq key-times 3)
177 | ;; (if mark-active
178 | ;; (goto-char (point-max))
179 | ;; (end-of-buffer)))
180 | ;; ((eq key-times 2)
181 | ;; (if mark-active () (push-mark))
182 | ;; (move-to-window-line -1)
183 | ;; (end-of-line))
184 | ;; ((eq key-times 1)
185 | ;; (end-of-line)))))
186 |
187 | ;; (global-set-key (kbd "") 'goto-begin)
188 | ;; (global-set-key (kbd "") 'goto-end)
189 |
190 | ;; When you put this into your .emacs config, then you can do:
191 | ;; hit once: goto beginning of current line
192 | ;; repeat: goto beginning of current window
193 | ;; repeat: goto beginning of current buffer
194 |
195 | ;; (and the same with in the other direction)
196 |
197 | ;;; Reporting Bugs:
198 |
199 | ;; Goto https://github.com/tlinden/viking-mode and file a new issue.
200 |
201 | ;;; History:
202 |
203 | ;; The idea to use repeating keys came from the mode home-end.el by
204 | ;; Kai Grossjohann and Toby Speight, which is today part of the
205 | ;; emacs-goodies package (at least I re-discovered it there). I had
206 | ;; the two functions in my .emacs for years. Finally I wrote the
207 | ;; function viking-last-key-repeats which is much more flexible but
208 | ;; is nevertheless based on the idea in home-end.el.
209 |
210 | ;; So, I'd like to say Thanks to those two guys: Not only did you make
211 | ;; my emacs live better for years but also helped me creating this
212 | ;; small minor mode. Therefore, just for completeness, here's their
213 | ;; copyleft:
214 |
215 | ;; home-end.el --- Alternative Home and End commands.
216 | ;; Copyright 1996 Kai Grossjohann and Toby Speight
217 | ;; Copyright 2002-2011 Toby Speight
218 | ;;
219 | ;; home-end.el is free software distributed under the terms of the GNU
220 | ;; General Public Licence, version 3.
221 |
222 |
223 |
224 | ;;; Code:
225 | ;;;; Consts
226 |
227 | (defconst viking-mode-version "0.08" "Viking Mode version.")
228 |
229 | (defgroup viking-mode nil
230 | "Kill first, ask later - an emacs mode for killing things quickly"
231 | :group 'extensions
232 | :group 'tools
233 | :link '(url-link :tag "Repository" "https://github.com/tlinden/viking-mode"))
234 |
235 |
236 | ;;;; Customizable variables
237 | ;;;;; Fonts
238 |
239 | (defface viking-blink
240 | '((t :inherit highlight))
241 | "Level 1."
242 | :group 'viking-mode)
243 |
244 | ;;;;; Modify behavior
245 |
246 | (defcustom viking-blink-time 0.2
247 | "How long should viking highlight a region,
248 | in seconds, specify milliseconds like this: 0.1"
249 | :group 'viking-mode)
250 |
251 | (defcustom viking-really-delete nil
252 | "If set to t, really delete killed things. That is,
253 | nothing will remain available via kill-ring once deleted.
254 | The default is nil: keep deleted things in the kill-ring."
255 | :group 'viking-mode)
256 |
257 | (defcustom viking-greedy-kill t
258 | "If set to t (default), whitespaces and newline at point will be
259 | deleted after the kill function, if any. Uses 'just-one-space."
260 | :group 'viking-mode)
261 |
262 | (defcustom viking-enable-region-kill nil
263 | "If set to true (default: nil), kill the whole region if
264 | mark is set."
265 | :group 'viking-mode)
266 |
267 | (defcustom viking-use-expand-region-when-loaded nil
268 | "If set to true (default: nil) and expand-region is installed
269 | and active for the current major mode, then use its expansions
270 | to mark regions and delete them."
271 | :group 'viking-mode)
272 |
273 | (defcustom viking-kill-functions (list 'viking-kill-word 'viking-kill-line-from-point 'viking-kill-line 'viking-kill-paragraph 'viking-kill-buffer)
274 | "The actual kill functions being called in a row starting with the first entry"
275 | :group 'viking-mode)
276 |
277 | (defcustom viking-enable-blinking t
278 | "If set to true (default) highlight the deleted text shortly
279 | for 'viking-blink-time seconds. Set to nil to disable the feature"
280 | :group 'viking-mode)
281 |
282 | ;;;;; Internal variables
283 |
284 | ;; internal copy of kill functions without the last one executed will
285 | ;; be reset to original list every time key pressed the first time
286 | (defvar viking--current-kill-functions ())
287 |
288 | ;; holds last kill function executed so we can repeat it when needed
289 | (defvar viking--last-kill-function (car viking-kill-functions))
290 |
291 | ;;;; Functions
292 | ;;;;; Utilities
293 |
294 | ;; internal utility functions required by the kill functions
295 |
296 | (defun viking--blink-region(begin end)
297 | "Blink a region shortly. It does this by highlighting the
298 | region between 'begin and 'end using 'font-lock-viking-face
299 | for 'viking-blink-time seconds."
300 | (interactive)
301 | (when viking-enable-blinking
302 | (let* ((rh (make-overlay begin end)))
303 | (progn
304 | (overlay-put rh 'face 'viking-blink)
305 | (sit-for viking-blink-time t)
306 | (delete-overlay rh)
307 | ))))
308 |
309 | (defun viking--get-point (symbol &optional arg)
310 | "Returns the point by evaluating 'symbol, which
311 | should be a point-moving function."
312 | (funcall symbol arg)
313 | (point)
314 | )
315 |
316 | ;; may be used for other purposes as well, see commentary 'Tips'
317 | (defun viking-last-key-repeats ()
318 | "Returns how many times the last key has been pressed as integer."
319 | (interactive)
320 | (let* ((keys (reverse (append (recent-keys) nil))) ;; list of last keys pressed, last @0
321 | (pressed (car keys)) ;; the very last key pressed, i.e. the one bound to this defun
322 | (times 0)) ;; how many times that key have been pressed
323 | (progn
324 | (catch 'nomore ;; don't iterate endless
325 | (dolist (k keys) ;; loop over the key list, (car keys) is the most recent, due to 'reverse above
326 | (if (equal pressed k) ;; one more of the same key pressed in a row
327 | (setq times (+ times 1)) ;; register
328 | (throw 'nomore t)))) ;; another key, break the loop and return the count
329 | times)))
330 |
331 |
332 | (defun viking--point-is-in-space ()
333 | "Return true if point is surrounded by space (which is: [\s\r\n])."
334 | (interactive)
335 | (or
336 | (looking-at "[[:space:]]+")
337 | (eq (point) (line-end-position))))
338 |
339 |
340 | ;;;;; kill/delete wrappers
341 |
342 | (defun viking--kill-region (beg end)
343 | "Deletes or kills a region depending on 'viking-really-delete."
344 | (if viking-really-delete
345 | (delete-region beg end)
346 | (kill-region beg end)))
347 |
348 | (defun viking--really-delete-line () ;; based on code by xah
349 | "kill-line without copy"
350 | (interactive)
351 | (delete-region
352 | (point)
353 | (save-excursion (move-end-of-line 1) (point)))
354 | (delete-char 1)
355 | )
356 |
357 | (defun viking--kill-word-at-point ()
358 | "Kill word at point."
359 | (interactive)
360 | (let
361 | ((beg (viking--get-point 'backward-word 1))
362 | (end (viking--get-point 'forward-word 1)))
363 | (progn
364 | (viking--blink-region beg end)
365 | (viking--kill-region beg end)
366 | (message "word at point deleted"))))
367 |
368 |
369 | (defun viking--kill-word-right ()
370 | "Kill word from line beginning to the right."
371 | (interactive)
372 | (let
373 | ((beg (point))
374 | (end (viking--get-point 'forward-word 1)))
375 | (viking--blink-region beg end)
376 | (viking--kill-region beg end)
377 | (message "word right of point deleted")))
378 |
379 | (defun viking--kill-space(&optional verbose)
380 | "Kill space around point, including newline(s), but the first."
381 | (interactive)
382 | (let* ((lineA 0) (lineB 0)
383 | (beg (save-excursion
384 | (skip-chars-backward " \t\r\n")
385 | (cond ((looking-at "\r\n") ;; keep first newline intact
386 | (forward-char 2))
387 | ((looking-at "\n")
388 | (forward-char 1)))
389 | (setq lineA (line-number-at-pos))
390 | (point)))
391 | (end (save-excursion
392 | (skip-chars-forward " \t\r\n")
393 | (setq lineB (line-number-at-pos))
394 | (point)))
395 | )
396 | (viking--blink-region beg end)
397 | (if (= lineA lineB)
398 | (progn
399 | (just-one-space)
400 | (when (eobp) ;; remaining spaces before eob?
401 | (delete-trailing-whitespace)))
402 | (delete-region beg end))
403 | (when verbose
404 | (message "spaces cleared"))))
405 |
406 | ;; implements #2: behave different inside region
407 | ;; FIXME: maybe also do word->line->region?
408 | ;; Currently it just throws the whole region away
409 | ;; FIXME: if called via expand-region, different output
410 | (defun viking-kill-region()
411 | "Kill region at point, if any"
412 | (interactive)
413 | (if viking-really-delete
414 | (delete-region (mark) (point))
415 | (kill-region (mark) (point)))
416 | (message "region deleted"))
417 |
418 |
419 | (defun viking--next-killf()
420 | "Return next kill function, update 'viking--current-kill-functions and
421 | 'viking--last-kill-function."
422 | (if (and (eq (length viking--current-kill-functions) 1)
423 | (not (equal (car viking--current-kill-functions) 'viking-kill-buffer)))
424 | ;; just return, do not pop
425 | (setq viking--last-kill-function (car viking--current-kill-functions))
426 | ;; else: remove element from the front and return it
427 | (setq viking--last-kill-function (pop viking--current-kill-functions)))
428 | viking--last-kill-function)
429 |
430 |
431 | (defun viking--killw (count)
432 | "execute kill function from the list of kill functions in
433 | 'viking--current-kill-functions, reset it to the contents of
434 | 'viking-kill-functions if COUNT is 1 (thus the command key has been
435 | pressed the first time in a row"
436 | ;; start from scratch
437 | (if (eq count 1)
438 | (setq viking--current-kill-functions viking-kill-functions))
439 |
440 | ;; end of buffer, but it's not empty yet
441 | ;; and the last line, where we are, is empty,
442 | ;; so move one line up in order to keep viking
443 | ;; mode going
444 | (when (and (eobp)
445 | (> (buffer-size) 0)
446 | (eq (line-beginning-position) (point)))
447 | (forward-line -1))
448 |
449 | ;; only call killer if not done killing
450 | (if (and viking--current-kill-functions (not (eobp)))
451 | (funcall (viking--next-killf))
452 | (signal 'end-of-buffer nil)
453 | ))
454 |
455 |
456 | (defun viking--er-killw ()
457 | "executes er/expand-region (if loaded and enabled) and deletes
458 | the region marked by it, thus making viking language aware."
459 | (er/expand-region 1)
460 | (when viking-enable-blinking
461 | (sit-for viking-blink-time))
462 | (viking-kill-region))
463 |
464 |
465 | ;;;;; Public interactive kill functions
466 |
467 | (defun viking-kill-word ()
468 | "If point is on space or newline, delete those (like M-SPC), else kill word at point.
469 | If 'viking-greedy-kill is t, clean up spaces and newlines afterwards."
470 | (interactive)
471 | (if (and viking-enable-region-kill mark-active)
472 | (viking-kill-region) ;; region-kill can only happen on first C-d invokation
473 |
474 | ;; else normal processing
475 | (if (viking--point-is-in-space)
476 | (progn
477 | (viking--kill-space t)
478 | ;; reset kill func list:
479 | (setq viking--current-kill-functions viking-kill-functions))
480 | (progn
481 | (if (or (eq (point) (line-beginning-position))
482 | (memq (preceding-char) '(?\t ?\ )))
483 | (viking--kill-word-right)
484 | (viking--kill-word-at-point)
485 | )
486 | (when viking-greedy-kill ;; clean up afterwards as well?
487 | (viking--kill-space))
488 | ))))
489 |
490 | (defun viking-kill-line ()
491 | "Kill line at point including newline.
492 | If 'viking-greedy-kill is t, clean up spaces and newlines afterwards."
493 | (interactive)
494 | (viking--blink-region (viking--get-point 'beginning-of-line 1)
495 | (viking--get-point 'end-of-line 1))
496 | (move-beginning-of-line 1)
497 | (let ((k kill-whole-line))
498 | (progn
499 | (setq kill-whole-line t) ;; temp enable
500 | (if viking-really-delete
501 | (viking--really-delete-line)
502 | (kill-line)
503 | )
504 | (setq kill-whole-line k)
505 | (when viking-greedy-kill
506 | (viking--kill-space))
507 | ))
508 | (message "line at point deleted"))
509 |
510 | (defun viking-kill-line-from-point ()
511 | "Kill line from point to the right without newline."
512 | (interactive)
513 | (let ((beg (point))
514 | (end (viking--get-point 'end-of-line 1)))
515 | (progn
516 | (viking--blink-region beg end)
517 | (viking--kill-region beg end)
518 | (message "line from point deleted"))))
519 |
520 | (defun viking-kill-paragraph ()
521 | "Kill paragraph at point.
522 | If 'viking-greedy-kill is t, clean up spaces and newlines afterwards."
523 | (interactive)
524 | (let
525 | ((beg (viking--get-point 'backward-paragraph 1))
526 | (end (viking--get-point 'forward-paragraph 1)))
527 | (progn
528 | (viking--blink-region beg end)
529 | (viking--kill-region beg end)
530 | (when viking-greedy-kill
531 | (viking--kill-space))
532 | (message "paragraph at point deleted"))))
533 |
534 | (defun viking-kill-buffer ()
535 | "Kill the whole buffer."
536 | (interactive)
537 | (let ((beg (point-min))
538 | (end (point-max)))
539 | (progn
540 | (viking--blink-region beg end)
541 | (viking--kill-region beg end)
542 | (message "buffer deleted"))))
543 |
544 | ;;;;; Primary key binding functions
545 |
546 |
547 | (defun viking-kill-thing-at-point()
548 | "Delete thing at point. Checks how many times the
549 | calling key has been pressed and runs the appropriate
550 | kill function then."
551 | (interactive)
552 | (if (and (fboundp 'er/expand-region) viking-use-expand-region-when-loaded)
553 | (viking--er-killw)
554 | (viking--killw (viking-last-key-repeats))))
555 |
556 |
557 | (defun viking-repeat-last-kill()
558 | (interactive)
559 | "Repeat the last executed kill function"
560 | (funcall viking--last-kill-function))
561 |
562 |
563 | ;;;; Interface
564 | ;;;###autoload
565 |
566 | ;; the minor mode, can be enabled by major mode via hook or manually
567 | (define-minor-mode viking-mode "kill first, ask later"
568 | :lighter " V"
569 | :group 'viking-mode
570 | :keymap (let ((map (make-sparse-keymap)))
571 | (define-key map (kbd "C-d") 'viking-kill-thing-at-point)
572 | (define-key map (kbd "C-S-D") 'viking-repeat-last-kill)
573 | map))
574 |
575 | ;; just in case someone wants to use it globally
576 | (define-globalized-minor-mode viking-global-mode
577 | viking-mode viking-mode
578 | :group 'viking-mode
579 | )
580 |
581 | ;; un-*ing-believable: I'm done *g*
582 | (provide 'viking-mode)
583 |
584 |
585 | ;;; viking-mode.el ends here
586 |
--------------------------------------------------------------------------------