mirrored from git://git.sv.gnu.org/emacs.git
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
hexl.el
1130 lines (993 loc) · 41.8 KB
/
hexl.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; hexl.el --- edit a file in a hex dump format using the hexl filter -*- lexical-binding: t -*-
;; Copyright (C) 1989, 1994, 1998, 2001-2020 Free Software Foundation,
;; Inc.
;; Author: Keith Gabryelski <ag@wheaties.ai.mit.edu>
;; Maintainer: emacs-devel@gnu.org
;; Keywords: data
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This package implements a major mode for editing binary files. It uses
;; a program called hexl, supplied with the GNU Emacs distribution, that
;; can filter a binary into an editable format or from the format back into
;; binary. For full instructions, invoke `hexl-mode' on an empty buffer and
;; do M-x `describe-mode'.
;;
;; NOTE: Remember to change `hexl-program' or `hexl-options' if needed.
;;
;; Currently hexl only supports big endian hex output with 16 bit
;; grouping.
;;
;; -iso in `hexl-options' will allow iso characters to display in the
;; ASCII region of the screen (if your Emacs supports this) instead of
;; changing them to dots.
;;; Code:
(require 'eldoc)
(eval-when-compile (require 'cl-lib))
;;
;; vars here
;;
(defgroup hexl nil
"Edit a file in a hex dump format using the hexl filter."
:group 'data)
(defcustom hexl-bits 16
"The bit grouping that hexl will use."
:type '(choice (const 8 )
(const 16)
(const 32)
(const 64))
:version "24.3")
(defcustom hexl-program "hexl"
"The program that will hexlify and dehexlify its stdin.
`hexl-program' will always be concatenated with `hexl-options'
and \"-de\" when dehexlifying a buffer."
:type 'string)
(defcustom hexl-iso ""
"If your Emacs can handle ISO characters, this should be set to
\"-iso\" otherwise it should be \"\"."
:type 'string)
(defcustom hexl-options (format "-hex %s" hexl-iso)
"Space separated options to `hexl-program' that suit your needs.
Quoting cannot be used, so the arguments cannot themselves contain spaces.
If you wish to set the `-group-by-X-bits' options, set `hexl-bits' instead,
as that will override any bit grouping options set here."
:type 'string)
(defcustom hexl-follow-ascii t
"If non-nil then highlight the ASCII character corresponding to point."
:type 'boolean
:version "20.3")
(defcustom hexl-mode-hook '(hexl-follow-line hexl-activate-ruler)
"Normal hook run when entering Hexl mode."
:type 'hook
:options '(hexl-follow-line hexl-activate-ruler eldoc-mode))
(defface hexl-address-region
'((t (:inherit header-line)))
"Face used in address area of Hexl mode buffer.")
(defface hexl-ascii-region
'((t (:inherit header-line)))
"Face used in ASCII area of Hexl mode buffer.")
(defvar-local hexl-max-address 0
"Maximum offset into hexl buffer.")
(defvar hexl-mode-map
(let ((map (make-keymap)))
;; Make all self-inserting keys go through hexl-self-insert-command,
;; because we need to convert them to unibyte characters before
;; inserting them into the buffer.
(define-key map [remap self-insert-command] 'hexl-self-insert-command)
(define-key map "\C-m" 'hexl-self-insert-command)
(define-key map [left] 'hexl-backward-char)
(define-key map [right] 'hexl-forward-char)
(define-key map [up] 'hexl-previous-line)
(define-key map [down] 'hexl-next-line)
(define-key map [M-left] 'hexl-backward-short)
(define-key map [?\e left] 'hexl-backward-short)
(define-key map [M-right] 'hexl-forward-short)
(define-key map [?\e right] 'hexl-forward-short)
(define-key map [next] 'hexl-scroll-up)
(define-key map [prior] 'hexl-scroll-down)
(define-key map [home] 'hexl-beginning-of-line)
(define-key map [end] 'hexl-end-of-line)
(define-key map [C-home] 'hexl-beginning-of-buffer)
(define-key map [C-end] 'hexl-end-of-buffer)
(define-key map [deletechar] 'undefined)
(define-key map [deleteline] 'undefined)
(define-key map [insertline] 'undefined)
(define-key map [S-delete] 'undefined)
(define-key map "\177" 'undefined)
(define-key map "\C-a" 'hexl-beginning-of-line)
(define-key map "\C-b" 'hexl-backward-char)
(define-key map "\C-d" 'undefined)
(define-key map "\C-e" 'hexl-end-of-line)
(define-key map "\C-f" 'hexl-forward-char)
(if (not (memq (key-binding (char-to-string help-char))
'(help-command ehelp-command)))
(define-key map (char-to-string help-char) 'undefined))
(define-key map "\C-k" 'undefined)
(define-key map "\C-n" 'hexl-next-line)
(define-key map "\C-o" 'undefined)
(define-key map "\C-p" 'hexl-previous-line)
(define-key map "\C-q" 'hexl-quoted-insert)
(define-key map "\C-t" 'undefined)
(define-key map "\C-v" 'hexl-scroll-up)
(define-key map "\C-w" 'undefined)
(define-key map "\C-y" 'undefined)
(fset 'hexl-ESC-prefix (copy-keymap 'ESC-prefix))
(define-key map "\e" 'hexl-ESC-prefix)
(define-key map "\e\C-a" 'hexl-beginning-of-512b-page)
(define-key map "\e\C-b" 'hexl-backward-short)
(define-key map "\e\C-d" 'hexl-insert-decimal-char)
(define-key map "\e\C-e" 'hexl-end-of-512b-page)
(define-key map "\e\C-f" 'hexl-forward-short)
(define-key map "\e\C-i" 'undefined)
(define-key map "\e\C-j" 'undefined)
(define-key map "\e\C-k" 'undefined)
(define-key map "\e\C-o" 'hexl-insert-octal-char)
(define-key map "\e\C-q" 'undefined)
(define-key map "\e\C-t" 'undefined)
(define-key map "\e\C-x" 'hexl-insert-hex-char)
(define-key map "\eb" 'hexl-backward-word)
(define-key map "\ec" 'undefined)
(define-key map "\ed" 'undefined)
(define-key map "\ef" 'hexl-forward-word)
(define-key map "\eg" 'hexl-goto-hex-address)
(define-key map "\ei" 'undefined)
(define-key map "\ej" 'hexl-goto-address)
(define-key map "\ek" 'undefined)
(define-key map "\el" 'undefined)
(define-key map "\eq" 'undefined)
(define-key map "\es" 'undefined)
(define-key map "\et" 'undefined)
(define-key map "\eu" 'undefined)
(define-key map "\ev" 'hexl-scroll-down)
(define-key map "\ey" 'undefined)
(define-key map "\ez" 'undefined)
(define-key map "\e<" 'hexl-beginning-of-buffer)
(define-key map "\e>" 'hexl-end-of-buffer)
(fset 'hexl-C-c-prefix (copy-keymap mode-specific-map))
(define-key map "\C-c" 'hexl-C-c-prefix)
(define-key map "\C-c\C-c" 'hexl-mode-exit)
(fset 'hexl-C-x-prefix (copy-keymap 'Control-X-prefix))
(define-key map "\C-x" 'hexl-C-x-prefix)
(define-key map "\C-x[" 'hexl-beginning-of-1k-page)
(define-key map "\C-x]" 'hexl-end-of-1k-page)
(define-key map "\C-x\C-p" 'undefined)
(define-key map "\C-x\C-s" 'hexl-save-buffer)
(define-key map "\C-x\C-t" 'undefined)
map))
;; Variable declarations for suppressing warnings from the byte-compiler.
(defvar ruler-mode)
(defvar ruler-mode-ruler-function)
(defvar hl-line-mode)
(defvar hl-line-range-function)
(defvar hl-line-face)
;; Variables where the original values are stored to.
(defvar hexl-mode--old-var-vals ())
(make-variable-buffer-local 'hexl-mode--old-var-vals)
(defvar hexl-ascii-overlay nil
"Overlay used to highlight ASCII element corresponding to current point.")
(make-variable-buffer-local 'hexl-ascii-overlay)
(defvar hexl-font-lock-keywords
'(("^\\([0-9a-f]+:\\).\\{40\\} \\(.+$\\)"
;; "^\\([0-9a-f]+:\\).+ \\(.+$\\)"
(1 'hexl-address-region t t)
(2 'hexl-ascii-region t t)))
"Font lock keywords used in `hexl-mode'.")
(defun hexl-rulerize (string bits)
(let ((size (/ bits 4)) (strlen (length string)) (pos 0) (ruler ""))
(while (< pos strlen)
(setq ruler (concat ruler " " (substring string pos (+ pos size))))
(setq pos (+ pos size)))
(substring ruler 1) ))
(defvar hexl-rulers
(mapcar
(lambda (bits)
(cons bits
(concat " 87654321 "
(hexl-rulerize "00112233445566778899aabbccddeeff" bits)
" 0123456789abcdef")))
'(8 16 32 64)))
;; routines
(put 'hexl-mode 'mode-class 'special)
;; 10 chars for the "address: "
;; 32 chars for the hexlified bytes
;; 1 char for the space
;; 16 chars for the character display
;; X chars for the spaces (128 bits divided by the hexl-bits)
;; 1 char for the newline.
(defun hexl-line-displen ()
"The length of a hexl display line (varies with `hexl-bits')."
(+ 60 (/ 128 (or hexl-bits 16))))
;;;###autoload
(defun hexl-mode (&optional arg)
"\\<hexl-mode-map>A mode for editing binary files in hex dump format.
This is not an ordinary major mode; it alters some aspects
of the current mode's behavior, but not all; also, you can exit
Hexl mode and return to the previous mode using `hexl-mode-exit'.
This function automatically converts a buffer into the hexl format
using the function `hexlify-buffer'.
Each line in the buffer has an \"address\" (displayed in hexadecimal)
representing the offset into the file that the characters on this line
are at and 16 characters from the file (displayed as hexadecimal
values grouped every `hexl-bits' bits, and as their ASCII values).
If any of the characters (displayed as ASCII characters) are
unprintable (control or meta characters) they will be replaced by
periods.
If `hexl-mode' is invoked with an argument the buffer is assumed to be
in hexl format.
A sample format:
HEX ADDR: 0011 2233 4455 6677 8899 aabb ccdd eeff ASCII-TEXT
-------- ---- ---- ---- ---- ---- ---- ---- ---- ----------------
00000000: 5468 6973 2069 7320 6865 786c 2d6d 6f64 This is hexl-mod
00000010: 652e 2020 4561 6368 206c 696e 6520 7265 e. Each line re
00000020: 7072 6573 656e 7473 2031 3620 6279 7465 presents 16 byte
00000030: 7320 6173 2068 6578 6164 6563 696d 616c s as hexadecimal
00000040: 2041 5343 4949 0a61 6e64 2070 7269 6e74 ASCII.and print
00000050: 6162 6c65 2041 5343 4949 2063 6861 7261 able ASCII chara
00000060: 6374 6572 732e 2020 416e 7920 636f 6e74 cters. Any cont
00000070: 726f 6c20 6f72 206e 6f6e 2d41 5343 4949 rol or non-ASCII
00000080: 2063 6861 7261 6374 6572 730a 6172 6520 characters.are
00000090: 6469 7370 6c61 7965 6420 6173 2070 6572 displayed as per
000000a0: 696f 6473 2069 6e20 7468 6520 7072 696e iods in the prin
000000b0: 7461 626c 6520 6368 6172 6163 7465 7220 table character
000000c0: 7265 6769 6f6e 2e0a region..
Movement is as simple as movement in a normal Emacs text buffer.
Most cursor movement bindings are the same: use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line]
to move the cursor left, right, down, and up.
Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are
also supported.
There are several ways to change text in hexl mode:
ASCII characters (character between space (0x20) and tilde (0x7E)) are
bound to self-insert so you can simply type the character and it will
insert itself (actually overstrike) into the buffer.
\\[hexl-quoted-insert] followed by another keystroke allows you to insert the key even if
it isn't bound to self-insert. An octal number can be supplied in place
of another key to insert the octal number's ASCII representation.
\\[hexl-insert-hex-char] will insert a given hexadecimal value (if it is between 0 and 0xFF)
into the buffer at the current point.
\\[hexl-insert-octal-char] will insert a given octal value (if it is between 0 and 0377)
into the buffer at the current point.
\\[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255)
into the buffer at the current point.
\\[hexl-mode-exit] will exit `hexl-mode'.
Note: saving the file with any of the usual Emacs commands
will actually convert it back to binary format while saving.
You can use \\[hexl-find-file] to visit a file in Hexl mode.
\\[describe-bindings] for advanced commands."
(interactive "p")
(unless (eq major-mode 'hexl-mode)
(let ((modified (buffer-modified-p))
(inhibit-read-only t)
(original-point (- (point) (point-min))))
(and (eobp) (not (bobp))
(setq original-point (1- original-point)))
;; If `hexl-mode' is invoked with an argument the buffer is assumed to
;; be in hexl format.
(when (memq arg '(1 nil))
;; If the buffer's EOL type is -dos, we need to account for
;; extra CR characters added when hexlify-buffer writes the
;; buffer to a file.
;; FIXME: This doesn't take into account multibyte coding systems.
(when (eq (coding-system-eol-type buffer-file-coding-system) 1)
(setq original-point (+ (count-lines (point-min) (point))
original-point))
(or (bolp) (setq original-point (1- original-point))))
(hexlify-buffer)
(restore-buffer-modified-p modified))
(setq hexl-max-address
(+ (* (/ (1- (buffer-size)) (hexl-line-displen)) 16) 15))
(condition-case nil
(hexl-goto-address original-point)
(error nil)))
(let ((max-address hexl-max-address))
(major-mode-suspend)
(setq hexl-max-address max-address))
(use-local-map hexl-mode-map)
(setq-local mode-name "Hexl")
(setq-local isearch-search-fun-function #'hexl-isearch-search-function)
(setq-local major-mode 'hexl-mode)
;; (set-syntax-table (standard-syntax-table))
(add-hook 'write-contents-functions #'hexl-save-buffer nil t)
(setq-local require-final-newline nil)
(setq-local font-lock-defaults '(hexl-font-lock-keywords t))
(setq-local revert-buffer-function #'hexl-revert-buffer-function)
(add-hook 'change-major-mode-hook #'hexl-maybe-dehexlify-buffer nil t)
;; Set a callback function for eldoc.
(add-hook 'eldoc-documentation-functions
#'hexl-print-current-point-info nil t)
(eldoc-add-command-completions "hexl-")
(eldoc-remove-command "hexl-save-buffer"
"hexl-current-address")
(if hexl-follow-ascii (hexl-follow-ascii-mode 1)))
(run-mode-hooks 'hexl-mode-hook))
(defun hexl-isearch-search-function ()
(if (and (not isearch-regexp) (not isearch-regexp-function))
(lambda (string &optional bound noerror count)
(funcall
(if isearch-forward 're-search-forward 're-search-backward)
(let ((textre
(if (> (length string) 80)
(regexp-quote string)
(mapconcat (lambda (c) (regexp-quote (string c))) string
"\\(?:\n\\(?:[:a-f0-9]+ \\)+ \\)?"))))
(if (string-match "\\` ?\\([a-f0-9]+ \\)*[a-f0-9]+ ?\\'" string)
(concat textre "\\|"
(mapconcat 'regexp-quote (split-string string " ")
" \\(?: .+\n[a-f0-9]+: \\)?"))
textre))
bound noerror count))
(isearch-search-fun-default)))
(defvar hexl-in-save-buffer nil)
(defun hexl-save-buffer ()
"Save a hexl format buffer as binary in visited file if modified."
(interactive)
(if hexl-in-save-buffer nil
(restore-buffer-modified-p
(if (buffer-modified-p)
(let ((buf (generate-new-buffer " hexl"))
(name (buffer-name))
(start (point-min))
(end (point-max))
modified)
(with-current-buffer buf
(insert-buffer-substring name start end)
(set-buffer name)
(dehexlify-buffer)
;; Prevent infinite recursion.
(let ((hexl-in-save-buffer t))
(save-buffer))
(setq modified (buffer-modified-p))
(delete-region (point-min) (point-max))
(insert-buffer-substring buf start end)
(kill-buffer buf)
modified))
(message "(No changes need to be saved)")
nil))
;; Return t to indicate we have saved t
t))
;;;###autoload
(defun hexl-find-file (filename)
"Edit file FILENAME as a binary file in hex dump format.
Switch to a buffer visiting file FILENAME, creating one if none exists,
and edit the file in `hexl-mode'."
(interactive
(list
(let ((completion-ignored-extensions nil))
(read-file-name "Filename: " nil nil 'ret-must-match))))
;; Ignore the user's setting of default major-mode.
(cl-letf (((default-value 'major-mode) 'fundamental-mode))
(find-file-literally filename))
(if (not (eq major-mode 'hexl-mode))
(hexl-mode)))
(defun hexl-revert-buffer-function (_ignore-auto _noconfirm)
;; FIXME: We don't obey revert-buffer-preserve-modes!
(let ((coding-system-for-read 'no-conversion)
revert-buffer-function)
;; Call the original `revert-buffer' without code conversion; also
;; prevent it from changing the major mode to normal-mode, which
;; calls `set-auto-mode'.
(revert-buffer nil nil t)
;; A couple of hacks are necessary here:
;; 1. change the major-mode to one other than hexl-mode since the
;; function `hexl-mode' does nothing if the current major-mode is
;; already hexl-mode.
;; 2. reset change-major-mode-hook in case that `hexl-mode'
;; previously added hexl-maybe-dehexlify-buffer to it.
(remove-hook 'change-major-mode-hook #'hexl-maybe-dehexlify-buffer t)
(remove-hook 'eldoc-documentation-functions
#'hexl-print-current-point-info t)
(setq major-mode 'fundamental-mode)
(hexl-mode)))
(defun hexl-mode-exit (&optional arg)
"Exit Hexl mode, returning to previous mode.
With arg, don't unhexlify buffer."
(interactive "p")
(if (or (eq arg 1) (not arg))
(let ((modified (buffer-modified-p))
(inhibit-read-only t)
(original-point (1+ (hexl-current-address))))
(dehexlify-buffer)
(remove-hook 'write-contents-functions #'hexl-save-buffer t)
(restore-buffer-modified-p modified)
(goto-char original-point)
;; Maybe adjust point for the removed CR characters.
(when (eq (coding-system-eol-type buffer-file-coding-system) 1)
(setq original-point (- original-point
(count-lines (point-min) (point))))
(or (bobp) (setq original-point (1+ original-point))))
(goto-char original-point)))
(remove-hook 'change-major-mode-hook #'hexl-maybe-dehexlify-buffer t)
(major-mode-restore))
(defun hexl-maybe-dehexlify-buffer ()
"Convert a hexl format buffer to binary.
Ask the user for confirmation."
(if (y-or-n-p "Convert contents back to binary format? ")
(let ((modified (buffer-modified-p))
(inhibit-read-only t)
(original-point (1+ (hexl-current-address))))
(dehexlify-buffer)
(remove-hook 'write-contents-functions #'hexl-save-buffer t)
(restore-buffer-modified-p modified)
(goto-char original-point))))
(defun hexl-current-address (&optional validate)
"Return current hexl-address."
(interactive)
(let ((current-column
(- (% (- (point) (point-min) -1) (hexl-line-displen)) 11))
(hexl-address 0))
(if (< current-column 0)
(if validate
(error "Point is not on a character in the file")
(setq current-column 0)))
(setq hexl-address
(+ (* (/ (- (point) (point-min) -1)
(hexl-line-displen)) 16)
(if (>= current-column (- (hexl-ascii-start-column) 10))
(- current-column (- (hexl-ascii-start-column) 10))
(/ (- current-column
(/ current-column (1+ (/ hexl-bits 4)))) 2))))
(when (called-interactively-p 'interactive)
(message "Current address is %d/0x%08x" hexl-address hexl-address))
hexl-address))
(defun hexl-print-current-point-info (&rest _ignored)
"Return current hexl-address in string.
This function is intended to be used as eldoc callback."
(let ((addr (hexl-current-address)))
(format "Current address is %d/0x%08x" addr addr)))
(defun hexl-ascii-start-column ()
"Column at which the ASCII portion of the hexl display starts."
(+ 43 (/ 128 hexl-bits)))
(defun hexl-address-to-marker (address)
"Return buffer position for ADDRESS."
(interactive "nAddress: ")
(let ((N (* (% address 16) 2)))
(+ (* (/ address 16) (hexl-line-displen)) ; hexl line no * display length
10 ; 10 chars for the "address: " prefix
(point-min) ; base offset (point usually starts at 1, not 0)
(+ N (/ N (/ hexl-bits 4))) )) ) ; char offset into hexl display line
(defun hexl-goto-address (address)
"Go to hexl-mode (decimal) address ADDRESS.
Signal error if ADDRESS is out of range."
(interactive "nAddress: ")
(if (or (< address 0) (> address hexl-max-address))
(error "Out of hexl region"))
(goto-char (hexl-address-to-marker address)))
(defun hexl-goto-hex-address (hex-address)
"Go to Hexl mode address (hex string) HEX-ADDRESS.
Signal error if HEX-ADDRESS is out of range."
(interactive "sHex Address: ")
(hexl-goto-address (hexl-hex-string-to-integer hex-address)))
(defun hexl-hex-string-to-integer (hex-string)
"Return decimal integer for HEX-STRING."
(interactive "sHex number: ")
(let ((hex-num 0))
(while (not (equal hex-string ""))
(setq hex-num (+ (* hex-num 16)
(hexl-hex-char-to-integer (string-to-char hex-string))))
(setq hex-string (substring hex-string 1)))
hex-num))
(defun hexl-octal-string-to-integer (octal-string)
"Return decimal integer for OCTAL-STRING."
(interactive "sOctal number: ")
(let ((oct-num 0))
(while (not (equal octal-string ""))
(setq oct-num (+ (* oct-num 8)
(hexl-oct-char-to-integer
(string-to-char octal-string))))
(setq octal-string (substring octal-string 1)))
oct-num))
;; move point functions
(defun hexl-backward-char (arg)
"Move to left ARG bytes (right if ARG negative) in Hexl mode."
(interactive "p")
(hexl-goto-address (- (hexl-current-address) arg)))
(defun hexl-forward-char (arg)
"Move to right ARG bytes (left if ARG negative) in Hexl mode."
(interactive "p")
(hexl-goto-address (+ (hexl-current-address) arg)))
(defun hexl-backward-short (arg)
"Move to left ARG shorts (right if ARG negative) in Hexl mode."
(interactive "p")
(hexl-goto-address (let ((address (hexl-current-address)))
(if (< arg 0)
(progn
(setq arg (- arg))
(while (> arg 0)
(setq address
(if (> address hexl-max-address)
(progn
(message "End of buffer.")
hexl-max-address)
(if (equal address (logior address 3))
(+ address 4)
(logior address 3))))
(setq arg (1- arg)))
(setq address
(if (> address hexl-max-address)
(progn
(message "End of buffer.")
hexl-max-address)
(logior address 3))))
(while (> arg 0)
(if (not (equal address (logand address -4)))
(setq address (logand address -4))
(if (not (equal address 0))
(setq address (- address 4))
(message "Beginning of buffer.")))
(setq arg (1- arg))))
address)))
(defun hexl-forward-short (arg)
"Move to right ARG shorts (left if ARG negative) in Hexl mode."
(interactive "p")
(hexl-backward-short (- arg)))
(defun hexl-backward-word (arg)
"Move to left ARG words (right if ARG negative) in Hexl mode."
(interactive "p")
(hexl-goto-address (let ((address (hexl-current-address)))
(if (< arg 0)
(progn
(setq arg (- arg))
(while (> arg 0)
(setq address
(if (> address hexl-max-address)
(progn
(message "End of buffer.")
hexl-max-address)
(if (equal address (logior address 7))
(+ address 8)
(logior address 7))))
(setq arg (1- arg)))
(setq address
(if (> address hexl-max-address)
(progn
(message "End of buffer.")
hexl-max-address)
(logior address 7))))
(while (> arg 0)
(if (not (equal address (logand address -8)))
(setq address (logand address -8))
(if (not (equal address 0))
(setq address (- address 8))
(message "Beginning of buffer.")))
(setq arg (1- arg))))
address)))
(defun hexl-forward-word (arg)
"Move to right ARG words (left if ARG negative) in Hexl mode."
(interactive "p")
(hexl-backward-word (- arg)))
(defun hexl-previous-line (arg)
"Move vertically up ARG lines [16 bytes] (down if ARG negative) in Hexl mode.
If there is no byte at the target address move to the last byte in that line."
(interactive "p")
(hexl-next-line (- arg)))
(defun hexl-next-line (arg)
"Move vertically down ARG lines [16 bytes] (up if ARG negative) in Hexl mode.
If there is no byte at the target address move to the last byte in that line."
(interactive "p")
(hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16))))
(if (and (< arg 0) (< address 0))
(progn (message "Out of hexl region.")
(setq address
(% (hexl-current-address) 16)))
(if (and (> address hexl-max-address)
(< (% hexl-max-address 16) (% address 16)))
(setq address hexl-max-address)
(if (> address hexl-max-address)
(progn (message "Out of hexl region.")
(setq
address
(+ (logand hexl-max-address -16)
(% (hexl-current-address) 16)))))))
address)))
(defun hexl-beginning-of-buffer (arg)
"Move to the beginning of the hexl buffer.
Leaves `hexl-mark' at previous position.
With prefix arg N, puts point N bytes of the way from the true beginning."
(interactive "p")
(push-mark)
(hexl-goto-address (+ 0 (1- arg))))
(defun hexl-end-of-buffer (arg)
"Go to `hexl-max-address' minus ARG."
(interactive "p")
(push-mark)
(hexl-goto-address (- hexl-max-address (1- arg))))
(defun hexl-beginning-of-line ()
"Goto beginning of line in Hexl mode."
(interactive)
(goto-char (+ (* (/ (point) (hexl-line-displen)) (hexl-line-displen)) 11)))
(defun hexl-end-of-line ()
"Goto end of line in Hexl mode."
(interactive)
(hexl-goto-address (min hexl-max-address (logior (hexl-current-address) 15))))
(defun hexl-scroll-down (arg)
"Scroll hexl buffer window upward ARG lines; or near full window if no ARG."
(interactive "P")
(setq arg (if (null arg)
(1- (window-height))
(prefix-numeric-value arg)))
(hexl-scroll-up (- arg)))
(defun hexl-scroll-up (arg)
"Scroll hexl buffer window upward ARG lines; or near full window if no ARG.
If there's no byte at the target address, move to the first or last line."
(interactive "P")
(setq arg (if (null arg)
(1- (window-height))
(prefix-numeric-value arg)))
(let* ((movement (* arg 16))
(address (hexl-current-address))
(dest (+ address movement)))
(cond
;; If possible, try to stay at the same offset from the beginning
;; of the 16-byte group, even if we move to the first or last
;; group.
((and (> dest hexl-max-address)
(>= (% hexl-max-address 16) (% address 16)))
(setq dest (+ (logand hexl-max-address -16) (% address 16))))
((> dest hexl-max-address)
(setq dest hexl-max-address))
((< dest 0)
(setq dest (% address 16))))
(if (/= dest (+ address movement))
(message "Out of hexl region."))
(hexl-goto-address dest)
(recenter 0)))
(defun hexl-beginning-of-1k-page ()
"Go to beginning of 1KB boundary."
(interactive)
(hexl-goto-address (logand (hexl-current-address) -1024)))
(defun hexl-end-of-1k-page ()
"Go to end of 1KB boundary."
(interactive)
(hexl-goto-address
(min hexl-max-address (logior (hexl-current-address) 1023))))
(defun hexl-beginning-of-512b-page ()
"Go to beginning of 512 byte boundary."
(interactive)
(hexl-goto-address (logand (hexl-current-address) -512)))
(defun hexl-end-of-512b-page ()
"Go to end of 512 byte boundary."
(interactive)
(hexl-goto-address
(min hexl-max-address (logior (hexl-current-address) 511))))
(defun hexl-quoted-insert (arg)
"Read next input character and insert it.
Useful for inserting control characters and non-ASCII characters given their
numerical code.
You may also type octal digits, to insert a character with that code."
(interactive "p")
(hexl-insert-multibyte-char (read-quoted-char) arg))
;00000000: 0011 2233 4455 6677 8899 aabb ccdd eeff 0123456789ABCDEF
(defun hexl-options (&optional test)
"Combine `hexl-bits' with `hexl-options', altering `hexl-options' as needed
to produce the command line options to pass to the hexl command."
(let ((opts (or test hexl-options)))
(when (memq hexl-bits '(8 16 32 64))
(when (string-match "\\(.*\\)-group-by-[0-9]+-bits\\(.*\\)" opts)
(setq opts (concat (match-string 1 opts)
(match-string 2 opts))))
(setq opts (format "%s -group-by-%d-bits " opts hexl-bits)) )
opts))
;;;###autoload
(defun hexlify-buffer ()
"Convert a binary buffer to hexl format.
This discards the buffer's undo information."
(interactive)
(and (consp buffer-undo-list)
(or (y-or-n-p "Converting to hexl format discards undo info; ok? ")
(error "Aborted"))
(setq buffer-undo-list nil))
;; Don't decode text in the ASCII part of `hexl' program output.
(let ((coding-system-for-read 'raw-text)
(coding-system-for-write buffer-file-coding-system)
(buffer-undo-list t))
(apply 'call-process-region (point-min) (point-max)
(expand-file-name hexl-program exec-directory)
t t nil
;; Manually encode the args, otherwise they're encoded using
;; coding-system-for-write (i.e. buffer-file-coding-system) which
;; may not be what we want (e.g. utf-16 on a non-utf-16 system).
(mapcar (lambda (s)
(if (not (multibyte-string-p s)) s
(encode-coding-string s locale-coding-system)))
(split-string (hexl-options))))
(if (> (point) (hexl-address-to-marker hexl-max-address))
(hexl-goto-address hexl-max-address))))
(defun dehexlify-buffer ()
"Convert a hexl format buffer to binary.
This discards the buffer's undo information."
(interactive)
(and (consp buffer-undo-list)
(or (y-or-n-p "Converting from hexl format discards undo info; ok? ")
(error "Aborted"))
(setq buffer-undo-list nil))
(let ((coding-system-for-write 'raw-text)
(coding-system-for-read buffer-file-coding-system)
(buffer-undo-list t))
(apply 'call-process-region (point-min) (point-max)
(expand-file-name hexl-program exec-directory)
t t nil "-de" (split-string (hexl-options)))))
(defun hexl-char-after-point ()
"Return char for ASCII hex digits at point."
(hexl-htoi (char-after (point))
(char-after (1+ (point)))))
(defun hexl-htoi (lh rh)
"Hex (char) LH (char) RH to integer."
(+ (* (hexl-hex-char-to-integer lh) 16)
(hexl-hex-char-to-integer rh)))
(defun hexl-hex-char-to-integer (character)
"Take a char and return its value as if it was a hex digit."
(if (and (>= character ?0) (<= character ?9))
(- character ?0)
(let ((ch (logior character 32)))
(if (and (>= ch ?a) (<= ch ?f))
(- ch (- ?a 10))
(error "Invalid hex digit `%c'" ch)))))
(defun hexl-oct-char-to-integer (character)
"Take a char and return its value as if it was an octal digit."
(if (and (>= character ?0) (<= character ?7))
(- character ?0)
(error "Invalid octal digit `%c'" character)))
(defun hexl-printable-character (ch)
"Return a displayable string for character CH."
(format "%c" (if (equal hexl-iso "")
(if (or (< ch 32) (>= ch 127))
46
ch)
(if (or (< ch 32) (and (>= ch 127) (< ch 160)))
46
ch))))
(defun hexl-insert-multibyte-char (ch num)
"Insert a possibly multibyte character CH NUM times.
Non-ASCII characters are first encoded with `buffer-file-coding-system',
and their encoded form is inserted byte by byte."
(let ((charset (char-charset ch))
(coding (if (or (null buffer-file-coding-system)
;; coding-system-type equals t means undecided.
(eq (coding-system-type buffer-file-coding-system) t))
(default-value 'buffer-file-coding-system)
buffer-file-coding-system)))
(cond ((and (> ch 0) (< ch 256))
(hexl-insert-char ch num))
((eq charset 'unknown)
(error
"0x%x -- invalid character code; use \\[hexl-insert-hex-string]"
ch))
(t
(let ((encoded (encode-coding-char ch coding))
(internal (char-to-string ch))
internal-hex)
;; If encode-coding-char returns nil, it means our character
;; cannot be safely encoded with buffer-file-coding-system.
;; In that case, we offer to insert the internal representation
;; of that character, byte by byte.
(when (null encoded)
(setq internal (encode-coding-string internal 'utf-8-emacs)
internal-hex
(mapconcat (function (lambda (c) (format "%x" c)))
internal " "))
(if (yes-or-no-p
(format-message
"Insert char 0x%x's internal representation \"%s\"? "
ch internal-hex))
(setq encoded internal)
(error
"Can't encode `0x%x' with this buffer's coding system; %s"
ch
(substitute-command-keys "try \\[hexl-insert-hex-string]"))))
(while (> num 0)
(mapc
(function (lambda (c) (hexl-insert-char c 1))) encoded)
(setq num (1- num))))))))
(defun hexl-self-insert-command (arg)
"Insert this character.
Interactively, with a numeric argument, insert this character that many times.
Non-ASCII characters are first encoded with `buffer-file-coding-system',
and their encoded form is inserted byte by byte."
(interactive "p")
(hexl-insert-multibyte-char last-command-event arg))
(defun hexl-insert-char (ch num)
"Insert the character CH NUM times in a hexl buffer.
CH must be a unibyte character whose value is between 0 and 255."
(if (or (< ch 0) (> ch 255))
(error "Invalid character 0x%x -- must be in the range [0..255]" ch))
(let ((address (hexl-current-address t)))
(while (> num 0)
(let ((hex-position (hexl-address-to-marker address))
(ascii-position
(+ (* (/ address 16) (hexl-line-displen))
(hexl-ascii-start-column)
(point-min)
(% address 16)))
at-ascii-position)
(if (= (point) ascii-position)
(setq at-ascii-position t))
(goto-char hex-position)
(delete-char 2)
(insert (format "%02x" ch))
(goto-char ascii-position)
(delete-char 1)
(insert (hexl-printable-character ch))
(or (= address hexl-max-address)
(setq address (1+ address)))
(hexl-goto-address address)
(if at-ascii-position
(progn
(beginning-of-line)
(forward-char (hexl-ascii-start-column))
(forward-char (% address 16)))))
(setq num (1- num)))))
;; hex conversion
(defun hexl-insert-hex-char (arg)
"Insert a character given by its hexadecimal code ARG times at point."
(interactive "p")
(let ((num (hexl-hex-string-to-integer (read-string "Hex number: "))))
(if (< num 0)
(error "Hex number out of range")
(hexl-insert-multibyte-char num arg))))
(defun hexl-insert-hex-string (str arg)
"Insert hexadecimal string STR at point ARG times.
Embedded whitespace, dashes, and periods in the string are ignored."
(interactive "sHex string: \np")
(setq str (replace-regexp-in-string "[- \t.]" "" str))
(let ((chars '()))
(let ((len (length str))
(idx 0))
(if (eq (logand len 1) 1)
(let ((num (hexl-hex-string-to-integer (substring str 0 1))))
(setq chars (cons num chars))
(setq idx 1)))
(while (< idx len)
(let* ((nidx (+ idx 2))
(num (hexl-hex-string-to-integer (substring str idx nidx))))
(setq chars (cons num chars))
(setq idx nidx))))
(setq chars (nreverse chars))
(while (> arg 0)
(let ((chars chars))
(while chars
(hexl-insert-char (car chars) 1)
(setq chars (cdr chars))))
(setq arg (- arg 1)))))
(defun hexl-insert-decimal-char (arg)
"Insert a character given by its decimal code ARG times at point."
(interactive "p")
(let ((num (string-to-number (read-string "Decimal Number: "))))
(if (< num 0)
(error "Decimal number out of range")
(hexl-insert-multibyte-char num arg))))
(defun hexl-insert-octal-char (arg)
"Insert a character given by its octal code ARG times at point."
(interactive "p")
(let ((num (hexl-octal-string-to-integer (read-string "Octal Number: "))))
(if (< num 0)
(error "Decimal number out of range")
(hexl-insert-multibyte-char num arg))))
(define-minor-mode hexl-follow-ascii-mode
"Minor mode to follow ASCII in current Hexl buffer.