TODO 58.4 KB
Newer Older
1 2
Emacs TODO List                                                   -*-outline-*-

3
Copyright (C) 2001-2019 Free Software Foundation, Inc.
4 5
See the end of the file for license conditions.

6

7 8 9
If you are ready to start working on any of these TODO items, we
appreciate your help; please write to emacs-devel@gnu.org so we can be
aware that the problem is being addressed, and talk with you how to do
10 11 12 13 14 15
it best.  Also to check that it hasn't been done already, since we
don't always remember to update this file!  It is best to consult
the latest version of this file in the Emacs source code repository.

Since Emacs is an FSF-copyrighted package, please be prepared to sign
legal papers to transfer the copyright on your work to the FSF.
16 17 18 19 20 21
Copyright assignment is a simple process.  Residents of some countries
can do it entirely electronically.  We can help you get started, and
answer any questions you may have (or point you to the people with the
answers), at the emacs-devel@gnu.org mailing list.

For more information about getting involved, see the CONTRIBUTE file.
22 23

As well as the issues listed here, there are bug reports at
24
<https://debbugs.gnu.org>.  Bugs tagged "easy" ought to be suitable for
25 26 27 28 29 30
beginners to work on, but unfortunately we are not very good at using
this tag.  Bugs tagged "help" are ones where assistance is required,
but may be difficult to fix.  Bugs with severity "important" or higher
are the ones we consider more important, but these also may be
difficult to fix.  Bugs with severity "minor" may be simpler, but this
is not always true.
31

32 33 34 35 36 37 38 39 40 41 42 43 44 45
* Speed up Elisp execution
** Speed up function calls
Change src/bytecode.c so that calls from byte-code functions to byte-code
functions don't go through Ffuncall/funcall_lambda/exec_byte_code but instead
stay within exec_byte_code.

** Improve the byte-compiler to recognize immutable (lexical) bindings
and get rid of them if they're used only once and/or they're bound to
a constant expression.

Such things aren't present in hand-written code, but macro expansion and
defsubst can often end up generating things like
(funcall (lambda (arg) (body)) actual) which then get optimized to
(let ((arg actual)) (body)) but should additionally get optimized further
46
when 'actual' is a constant/copyable expression.
47 48 49 50 51 52 53 54 55

** Add an "indirect goto" byte-code and use it for local lambda expressions.
E.g. when you have code like

   (let ((foo (lambda (x) bar)))
     (dosomething
      (funcall foo toto)
      (blabla (funcall foo titi))))

56
turn those 'funcalls' into jumps and their return into indirect jumps back.
57 58 59 60 61 62 63 64 65 66 67 68 69

** Compile efficiently local recursive functions

Similar to the previous point, we should be able to handle something like

   (letrec ((loop () (blabla) (if (toto) (loop))))
     (loop))

which ideally should generate the same byte-code as

   (while (progn (blabla) (toto)))

* Things that were planned for Emacs-24
70 71

** concurrency: including it as an "experimental" compile-time option
72 73
  sounds good.  Of course there might still be big questions around "which form
  of concurrency" we'll want.
74
** better support for dynamic embedded graphics: I like this idea (my
Glenn Morris's avatar
Glenn Morris committed
75
  mpc.el code could use it for the volume widget), though I wonder if the
76 77 78 79 80 81 82 83 84
  resulting efficiency will be sufficient.
** Spread Semantic.
** Improve the "code snippets" support: consolidate skeleton.el, tempo.el,
  and expand.el (any other?) and then advertise/use/improve it.
** Improve VC: yes, there's a lot of work to be done there :-(

** Random things that cross my mind right now that I'd like to see (some of
them from my local hacks), but it's not obvious at all whether they'll
make it.
85 86
*** prog-mode could/should provide a better fill-paragraph default
  that uses syntax-tables to recognize string/comment boundaries.
87 88 89 90 91 92 93
*** provide more completion-at-point-functions.  Make existing
  in-buffer completion use completion-at-point.
*** "functional" function-key-map that would make it easy to add (and
  remove) mappings like "FOO-mouse-4 -> FOO-scroll-down",
  "FOO-tab -> ?\FOO-\t", "uppercase -> lowercase", "[fringe KEY...] ->
  [KEY]", "H-FOO -> M-FOO", "C-x C-y FOO -> H-FOO", ...

Glenn Morris's avatar
Glenn Morris committed
94 95 96 97
* Things related to elpa.gnu.org.

** Move idlwave to elpa.gnu.org.
Need to sync up the Emacs and external versions.
98
See <https://lists.gnu.org/r/emacs-devel/2014-07/msg00008.html>
99

100
** Move Org mode to elpa.gnu.org.
101 102
See <https://lists.gnu.org/r/emacs-devel/2014-08/msg00300.html>
<https://lists.gnu.org/r/emacs-devel/2014-11/msg00257.html>
103 104

** Move verilog-mode to elpa.gnu.org.
105
See <https://lists.gnu.org/r/emacs-devel/2015-02/msg01180.html>
106 107

** Move vhdl-mode to elpa.gnu.org.
108
See <https://lists.gnu.org/r/emacs-devel/2015-02/msg01180.html>
109

110
* Simple tasks. These don't require much Emacs knowledge, they are
111 112
suitable for anyone from beginners to experts.

113 114
** Convert modes that use view-mode to be derived from special-mode instead.

Eli Zaretskii's avatar
Eli Zaretskii committed
115
** Major modes should have a menu entry.
116

117
** Check if all items on the mode-line have a suitable tooltip for all modes.
118

Dan Nicolaescu's avatar
Dan Nicolaescu committed
119 120 121
** edebug and debugger-mode should have a toolbar.
It can use the same icons as gud.

122 123 124
** Check what minor modes don't use define-minor-mode and convert them
to use it.

125
** Convert all defvars with leading '*' in the doc-strings into defcustoms
Glenn Morris's avatar
Glenn Morris committed
126 127
of appropriate :type and :group.

128
** Remove any leading '*'s from defcustom doc-strings.
129
[done?] [A lot of them are in CC Mode.]
Glenn Morris's avatar
Glenn Morris committed
130 131 132 133 134 135

** Remove unnecessary autoload cookies from defcustoms.
This needs a bit of care, since often people have become used to
expecting such variables to always be defined, eg when they modify
things in their .emacs.

136 137
** See if other files can use generated-autoload-file (see eg ps-print).

138 139 140 141
** Write more tests.  Pick a fixed bug from the database, write a test
case to make sure it stays fixed.  Or pick your favorite programming
major-mode, and write a test for its indentation.  Or a version
control backend, and write a test for its status parser.  Etc.
142
See the 'test' directory for examples.
143

144
* Small but important fixes needed in existing features:
145

146 147 148 149 150 151
** Flymake's customization mechanism needs to be both simpler (fewer
levels of indirection) and better documented, so it is easier to
understand.  I find it quite hard to figure out what compilation
command it will use.

I suggest totally rewriting that part of Flymake, using the simplest
Paul Eggert's avatar
Paul Eggert committed
152
mechanism that suffices for the specific needs.  That will be easy
153 154
for users to customize.

Kim F. Storm's avatar
Kim F. Storm committed
155 156 157
** Distribute a bar cursor of width > 1 evenly between the two glyphs
   on each side of the bar (what to do at the edges?).

158
** revert-buffer should eliminate overlays and the mark.
159
   For related problems consult the thread starting with
160
   https://lists.gnu.org/r/emacs-devel/2005-11/msg01346.html
161

162 163
** erase-buffer should perhaps disregard read-only properties of text.

164
** Fix the kill/yank treatment of invisible text.  At the moment,
Glenn Morris's avatar
Glenn Morris committed
165
  invisible text is placed in the kill-ring, so that the contents of
166 167
  the ring may not correspond to the text as displayed to the user.
  It ought to be possible to omit text which is invisible (due to a
Glenn Morris's avatar
Glenn Morris committed
168 169
  text-property, overlay, or selective display) from the kill-ring.

170 171 172
** Feature to change cursor shape when Emacs is idle (for more than
  a specified time).

173 174 175
** The buttons at the top of a custom buffer should not omit
  variables whose values are currently hidden.

176 177 178 179 180
** Clean up the variables in browse-url.  Perhaps use a shell command string to
  specify the browser instead of the mushrooming set of functions.
  See also ESR's proposal for a BROWSER environment variable
  <URL:http://www.catb.org/~esr/BROWSER/browse-url.patch>.

181 182
** Enhance scroll-bar to handle tall line (similar to line-move).

183 184 185 186
** In Custom buffers, put the option that turns a mode on or off first,
  using a heuristic of some kind?

** Define recompute-arg and recompute-arg-if for fix_command to use.
Eli Zaretskii's avatar
Eli Zaretskii committed
187
  See rms message of 11 Dec 05 in
188
  https://lists.gnu.org/r/emacs-pretest-bug/2005-12/msg00165.html,
Eli Zaretskii's avatar
Eli Zaretskii committed
189
  and the rest of that discussion.
190 191 192 193

** In Emacs Info, examples of using Customize should be clickable
   and they should create Custom buffers.

194 195
** The toolbar should show keyboard equivalents in its tooltips.

196 197
** Add function to redraw the tool bar.

198 199 200
** Redesign the load-history data structure so it can cope better
  with evaluating definitions of the same function from different files,
  recording which file the latest definition came from.
Kim F. Storm's avatar
Kim F. Storm committed
201

202 203
** make back_comment use syntax-ppss or equivalent.

Glenn Morris's avatar
Glenn Morris committed
204
** Consider improving src/sysdep.c's search for a fqdn.
205
https://lists.gnu.org/r/emacs-devel/2007-04/msg00782.html
Glenn Morris's avatar
Glenn Morris committed
206 207

** Find a proper fix for rcirc multiline nick adding.
208
https://lists.gnu.org/r/emacs-devel/2007-04/msg00684.html
Glenn Morris's avatar
Glenn Morris committed
209

210 211
** Check for any included packages that define obsolete bug-reporting commands.
Change them to use report-emacs-bug.
212 213 214 215 216 217 218 219
*** Related functions:
**** gnus-bug
**** report-calc-bug
**** org-submit-bug-report
**** lm-report-bug
**** tramp-bug
**** c-submit-bug-report
[Do all of them need changing?]
220

Nick Roberts's avatar
Nick Roberts committed
221 222
** Allow fringe indicators to display a tooltip (provide a help-echo property?)

223 224 225
** Add a defcustom that supplies a function to name numeric backup files,
like make-backup-file-name-function for non-numeric backup files.

226 227
** 'dired-mode' should specify the semantics of 'buffer-modified-p' for
dired buffers and DTRT WRT 'auto-revert-mode'.
228

Glenn Morris's avatar
Glenn Morris committed
229
** Check uses of prin1 for error-handling.
230
https://lists.gnu.org/r/emacs-devel/2008-08/msg00456.html
Glenn Morris's avatar
Glenn Morris committed
231

232
* Important features:
Glenn Morris's avatar
Glenn Morris committed
233 234

** "Emacs as word processor"
235
https://lists.gnu.org/r/emacs-devel/2013-11/msg00515.html
Glenn Morris's avatar
Glenn Morris committed
236
    rms writes:
Paul Eggert's avatar
Paul Eggert committed
237
    25 years ago I hoped we would extend Emacs to do WYSIWYG word
Glenn Morris's avatar
Glenn Morris committed
238 239 240
    processing.  That is why we added text properties and variable
    width fonts.  However, more features are still needed to achieve this.

241
** Extend text-properties and overlays
242 243 244
*** Several text-property planes
This would get us rid of font-lock-face property (and I'd be happy to
get rid of char-property-alias-alist as well) since font-lock would
245
simply use the 'face' property in the 'font-lock' plane.
246

247
Basically 'put-text-property' and friends would take an extra argument PLANE
248 249 250 251 252
(maybe the best backward-compatible way to do that is to make it so that
PROPERTY can be a cons cell (PLANE . PROP)).  So font-lock would
do (put-text-property start end '(font-lock . face) value).

All the properties coming from the various planes would get merged via an Elisp
253
function (so it can merge 'face' differently than 'keymap' or it could give
254 255
different priorities to different planes (we could imagine enabling/disabling
planes)).  The merging would not happen lazily while looking up properties but
256
instead it would take place eagerly in 'add-text-properties'.  This is based on
257 258 259 260 261 262 263 264 265 266
the idea that it's much more frequent to lookup properties than to
modify them.  Also, when properties are looked up during redisplay, we
generally can't run Elisp code, whereas we generally can do that when
properties are added.

*** Move overlays to intervals.c

Currently overlays are implemented as (two) sorted singly linked lists (one
for overlays_before some position and one for overlay_after that
position, for some quirky definition of "before" and "after").
267
The function 'overlay-recenter' changes the position used for the split
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
(and is called internally in various situations).

Each overlay is itself implemented with two markers (which keep track of
the overlay-start and overlay-end).  Markers are implemented as
a non-sorted singly linked list of markers.  So every text
insertion/deletion requires O(N) time, where N is the number of markers
since we have to go down that list to update those markers that are
affected by the modification.

You can start in src/buffer.[ch], maybe grepping for overlays_before for
a starting point.

Text-properties, OTOH, are implemented with a (mostly) balanced binary
tree.  This is implemented in src/intervals.[ch].

So we'd like to change overlays so that they don't use markers (and we
don't keep them in two sorted singly-linked lists) any more.  Instead,
we'll store them inside the balanced binary tree used for
text-properties.  I think we can use the "augmented tree" approach
described in https://en.wikipedia.org/wiki/Interval_tree.

To ease up debugging during development, I'd guess the implementation
would first add the new stuff, keeping the old stuff (i.e. add to
Lisp_Overlay whichever fields are needed for the new code, while keeping
the old ones, add needed overlay fields to the intervals tree, but keep
the old fields, the overlays_before etc...).  This way, you can add
consistency checks that make sure the new code computes the same results
as the old code.  And once that works well, we can remove the old code
and old fields.

298 299 300 301 302 303 304 305 306 307 308 309 310 311
** Having tabs above a window to switch buffers in it.

** "Perspectives" are named persistent window configurations.  We have
had the window configuration mechanism in GNU Emacs since the
beginning but we have never developed a good user interface to take
advantage of them.  Eclipse's user interface seems to be good.

Perspectives work well even if you do the equivalent of C-x 4 C-f
because of the distinction between view windows vs file windows.  In
Emacs this is more or less the "dedicated window" feature, but we have
never really made it work for this.

Perspectives also need to interact with the tabs.

Glenn Morris's avatar
Glenn Morris committed
312
** FFI (foreign function interface)
313
See eg https://lists.gnu.org/r/emacs-devel/2013-10/msg00246.html
Glenn Morris's avatar
Glenn Morris committed
314

315 316 317 318
One way of doing this is to start with fx's dynamic loading, and use it
to implement things like auto-loaded buffer parsers and database
access in cases which need more than Lisp.

Glenn Morris's avatar
Glenn Morris committed
319
** Replace unexec with a more portable form of dumping
320 321
See eg https://lists.gnu.org/r/emacs-devel/2014-01/msg01034.html
       https://lists.gnu.org/r/emacs-devel/2014-06/msg00452.html
322 323

One way is to provide portable undumping using mmap (per gerd design).
Glenn Morris's avatar
Glenn Morris committed
324

325 326 327
** Imenu could be extended into a file-structure browsing mechanism
using code like that of customize-groups.

328
** Display something in the margin on lines that have compilation errors.
329 330 331 332 333 334 335

** Compilation error navigation bar, parallel to the scroll bar,
indicating where in the buffer there are compilation errors.
Perhaps we could arrange to display these error indications on top
of the scroll bar itself.  That depends on to what extent toolkit
scroll bars are extensible.

336
** Provide user-friendly ways to list all available font families,
Juanma Barranquero's avatar
Juanma Barranquero committed
337
  list fonts, display a font as a sample, etc.  [fx is looking at
338
  multilingual font selection for the Unicode branch of Emacs.]
339

340 341
** Provide a convenient way to select a color with the mouse.

342
** Rewrite the face code to be simpler, clearer and faster.
343

344
** Program Enriched mode to read and save in RTF.  [Is there actually a
Dave Love's avatar
Dave Love committed
345
  decent single definition of RTF?  Maybe see info at
Eli Zaretskii's avatar
Eli Zaretskii committed
346
  http://latex2rtf.sourceforge.net/.]  This task seems to be addressed
347
  by https://savannah.nongnu.org/projects/emacs-rtf/, which is still in
Eli Zaretskii's avatar
Eli Zaretskii committed
348
  very early stages.
349

350 351 352 353 354 355
  Another place to look is the Wikipedia article at
  http://en.wikipedia.org/wiki/Rich_Text_Format

  It currently points to the latest spec of RTF v1.9.1 at
  http://www.microsoft.com/en-us/download/details.aspx?id=10725

356
** Implement primitive and higher-level functions to allow filling
357 358
  properly with variable-pitch faces.

359
** Implement intelligent search/replace, going beyond query-replace
Chong Yidong's avatar
Chong Yidong committed
360
  (see http://groups.csail.mit.edu/uid/projects/clustering/chi04.pdf).
361

362 363 364
** Implement other text formatting properties.
*** Footnotes that can appear either in place or at the end of the page.
*** text property that says "don't break line in middle of this".
365 366
   Don't break the line between two characters that have the
   same value of this property.
367
*** Discretionary hyphens that are not visible when they are at end of line.
368

369 370
** Internationalize Emacs's messages.

371 372 373
** Set up a facility to save backtraces when errors happen during
specified filters, specified timers, and specified hooks.

374 375
** Install mmc@maruska.dyndns.org's no-flicker change.

376 377 378 379
** Add a "current vertical pixel level" value that goes with point,
  so that motion commands can also move through tall images.
  This value would be to point as window-vscroll is to window-start.

380 381
** Address internationalization of symbols names essentially
  as documentation, e.g. in command names and Custom.
382

383
** Make the Lucid menu widget display multilingual text.  [This
Dave Love's avatar
Dave Love committed
384 385
  probably needs to be done from actual Emacs buffers, either directly
  in the menu or by rendering in an unmapped window and copying the
386 387
  pixels.  The current code assumes a specific locale; that isn't good
  enough even if X can render the arbitrary text] [The gtk
Dave Love's avatar
Dave Love committed
388 389
  port now displays multilingual text in menus, but only insofar as
  Emacs can encode it as utf-8 and gtk can display the result.]
390 391
  Maybe making Lucid menus work like Gtk's (i.e. just force utf-8) is good
  enough now that Emacs can encode most chars into utf-8.
392

393 394 395
** The GNUstep port needs some serious attention, ideally from someone
familiar with GNUstep and Objective C.

396 397
* Other features we would like:

398 399 400
** A more modern printing interface.  One that pops up a dialog that lets
you choose printer, page style, etc.
Integration with the Gtk print dialog is apparently difficult.  See eg:
401 402
https://lists.gnu.org/r/emacs-devel/2009-03/msg00501.html
https://lists.gnu.org/r/emacs-devel/2009-04/msg00034.html
403

404 405
** Allow frames(terminals) created by emacsclient to inherit their environment
from the emacsclient process.
406

407 408
** Give Tar mode all the features of Archive mode.

409
** Create a category of errors called 'process-error'
410 411
  for some or all errors associated with using subprocesses.

412
** Maybe reinterpret 'parse-error' as a category of errors
413 414
  and put some other errors under it.

415 416
** Make byte-compile warn when a doc string is too wide.

417 418
** Make byte-optimization warnings issue accurate line numbers.

419 420 421 422 423 424 425
** Record the sxhash of the default value for customized variables
  and notify the user (maybe by adding a menu item or toolbar button,
  as the detection can occur during autoload time) when the default
  changes (meaning that new versions of the Lisp source with a changed
  default value got installed) and offer ediff on the respective
  customization buffers.

426
** Emacs Lisp mode could put an overlay on the defun for every
427
  function that has advice.  The overlay could have 'after-text' like
428 429 430
  " [Function has advice]".  It might look like (defun foo [Function
  has advice] (x y) The overlay could also be a button that you could
  use to view the advice.
431

432 433
** Add a function to get the insertion-type of the markers in an overlay.

434 435
** ange-ftp
*** understand sftp
436
   This is hard to make work because sftp doesn't print status messages.
Eli Zaretskii's avatar
Eli Zaretskii committed
437

438 439
*** Use MLS for ange-ftp-insert-directory if a list of files is specified.

440 441 442 443
** Ability to map a key, including all modified-combinations.
   E.g map mouse-4 to wheel-up as well as M-mouse-4 -> M-wheel-up
   M-C-mouse-4 -> M-C-wheel-up, H-S-C-M-s-double-mouse-4 ->
   H-S-C-M-s-double-wheel-up, ...
444

445
** Beefed-up syntax-tables.
446
*** recognize multi-character syntactic entities like 'begin' and 'end'.
Juanma Barranquero's avatar
Juanma Barranquero committed
447
*** nested string-delimiters (for PostScript's (foo(bar)baz) strings).
448 449 450 451 452 453 454
*** support for infix operators (with precedence).
*** support for the $ (paired delimiter) in parse-partial-sexp.
*** support for hook-chars whose effect on the parsing-state is specified
	by elisp code.  Thus a char could both close a string and open a comment
	at the same time and do it in a context-sensitive way.
*** ability to add mode-specific data to the partial-parse-state.

455 456
** Add a way to convert a keyboard macro to equivalent Lisp code.

457
** Have a command suggestion help system that recognizes patterns
458 459
  of commands which could be replaced with a simpler common command.
  It should not make more than one suggestion per 10 minutes.
460

461
** Add a way to define input methods by computing them (when first used)
462 463 464 465
  from other input methods.  Then redefine C-x 8 to use a
  user-selected input method, with the default being the union of
  latin-1-prefix and latin-1-postfix.

466
** Implement a clean way to use different major modes for
467 468
  different parts of a buffer.  This could be useful in editing
  Bison input files, for instance, or other kinds of text
Eli Zaretskii's avatar
Eli Zaretskii committed
469 470
  where one language is embedded in another language.  See
  http://www.loveshack.ukfsn.org/emacs/multi-mode.el and also
Glenn Morris's avatar
Glenn Morris committed
471
  mmm-mode, as reference for approaches taken by others.
Dave Love's avatar
#  
Dave Love committed
472

473 474 475
** Arrange a way for an input method to return the first character
  immediately, then replace it later.  So that C-s a with
  input method latin-1-postfix would immediately search for an a.
Dave Love's avatar
#  
Dave Love committed
476

477
** Give start-process the ability to direct standard-error
Dave Love's avatar
#  
Dave Love committed
478 479
  output to a different filter.

480
** Give desktop.el a feature to switch between different named desktops.
481

482 483
** Add a cpio mode, more or less like tar mode.

484 485
** Save undo information in special temporary files, and reload it
  when needed for undoing.  This could extend undo capacity.
486 487
  undo-tree, in ELPA, already does this; its saving code could be
  integrated without requiring the use of undo-tree.
Dave Love's avatar
#  
Dave Love committed
488

489
** Change the Windows NT menu code
Dave Love's avatar
#  
Dave Love committed
490 491 492 493 494 495
  so that it handles the deep_p argument and avoids
  regenerating the whole menu bar menu tree except
  when the user tries to use the menubar.

  This requires the RIT to forward the WM_INITMENU message to
  the main thread, and not return from that message until the main
496
  thread has processed the MENU_BAR_ACTIVATE_EVENT and regenerated
Dave Love's avatar
#  
Dave Love committed
497
  the whole menu bar.  In the mean time, it should process other messages.
498

499
** Get some major packages installed: W3 (development version needs
500
  significant work), PSGML, _possibly_ ECB.
501
  https://lists.gnu.org/r/emacs-devel/2007-05/msg01493.html
Glenn Morris's avatar
Glenn Morris committed
502 503 504
  Check the assignments file for other packages which might go in and
  have been missed.

505 506 507 508
** Make compiler warnings about functions that might be undefined at run time
 smarter, so that they know which files are required by the file being
 compiled and don't warn about functions defined in them.

Glenn Morris's avatar
Glenn Morris committed
509
** Split out parts of lisp.h.
Dave Love's avatar
Dave Love committed
510

511
** Update the FAQ.
Dave Love's avatar
Dave Love committed
512

513
** Allow auto-compression-mode to use zlib calls if zlib is available.
Dave Love's avatar
Dave Love committed
514
  [It's required for PNG, so may be linked anyhow.]
Dave Love's avatar
Dave Love committed
515

516
** Improve the GC (generational, incremental).  (We may be able to use
517
  the Boehm collector.)  [See the Boehm-GC branch in CVS for work on this.]
518

519
** Check what hooks would help Emacspeak -- see the defadvising in W3.
Dave Love's avatar
Dave Love committed
520

521 522
** Add definitions for symbol properties, for documentation purposes.

Martin Rudalics's avatar
Martin Rudalics committed
523 524
** Temporarily remove scroll bars when they are not needed, typically
  when a buffer can be fully displayed in its window.
Dave Love's avatar
Dave Love committed
525

526
** Provide an optional feature which computes a scroll bar slider's
527
  size and its position from lines instead of characters.
Dave Love's avatar
Dave Love committed
528

529
** Allow unknown image types to be rendered via an external program
Glenn Morris's avatar
Glenn Morris committed
530
  converting them to, say, PBM (in the same way as PostScript?). [does
Glenn Morris's avatar
Glenn Morris committed
531 532
  doc-view.el do this, or could it be extended to do this?
  Does ImageMagick obsolete this idea?]
533

534
** Allow displaying an X window from an external program in a buffer,
535 536 537
  e.g. to render graphics from Java applets.  [gerd and/or wmperry
  thought this was feasible.]

538
** Allow images (not just text) in the margin to be mouse-sensitive.
539 540 541
  (Requires recursing through display properties).  Provide some way
  to simulate mouse-clicks on marginal text without a mouse.

542
** Extend ps-print to deal with multiple font sizes, images, and extra
543 544
  encodings.

545
** Use the XIE X extension, if available, for image display.
546

547
** Make monochrome images display using the foreground and background
548 549
  colors of the applicable faces.

550
** Make 'format-time-string' preserve text properties like 'format'.
551

552 553 554
** Optionally make the cursor a little thinner at the end of a line
  or the end of the buffer.

555
** Port the conservative stack marking code of Emacs's garbage collector
Eli Zaretskii's avatar
Eli Zaretskii committed
556 557
  to more systems, so that we can completely get rid of GCPROs.  Note
  that Boehm garbage collector provides this.
558

559
** Reorder defcustom's in each package so that the more important
560 561
  options come first in the Customize buffers.  This could be done by
  either rearranging the file (since options are shown in the order
562
  they appear in the *.el files), or by adding a few :set-after attributes.
563

564
** Maybe document the features of libraries missing from the manual (or
565 566 567 568 569
  ancillary manuals, including the Lisp manual in some cases).
  This is not worth doing for all of these packages and we need not
  aim for completeness, but some may be worth documenting.

  Here's a list which is probably not complete/correct: align, allout,
Xue Fuqiao's avatar
Xue Fuqiao committed
570
  artist, ansi-color, array, calculator, cdl, cmuscheme,
Xue Fuqiao's avatar
Xue Fuqiao committed
571
  completion, delim-col, dirtrack, double, echistory, elide-head,
572
  easymenu, expand, flow-ctrl, format [format-alist],
573 574
  generic/generic-x [various modes], kermit, log-edit,
  makesum, midnight [other than in Kill Buffer node],
575 576 577
  mouse-copy [?], mouse-drag, mouse-sel, net-utils, rcompile,
  snmp-mode [?], soundex [should be interactive?], strokes [start from
  the web page], talk, thingatpt [interactive functions?], type-break,
578
  vcursor, xscheme, zone-mode [?], mlconvert [?], iso-cvt,
579 580
  feedmail [?], uce, gametree, page-ext,
  refbib, refer, scribe, texinfo, underline,
581
  cmacexp, hideif, mantemp [obsolete?], pcomplete, xml,
582 583
  cvs-status (should be described in PCL-CVS manual); other progmodes,
  probably in separate manual.
584

585
** Convert the XPM bitmaps to PPM, replace the PBMs with them and scrap
586 587
  the XPMs so that the color versions work generally.  (Requires care
  with the color used for the transparent regions.)
Dave Love's avatar
Dave Love committed
588

589
** Convenient access to the 'values' variable.  It would be nice to have an
590 591
  interface that would show you the printed reps of the elements of the
  list in a menu, let you select one of the values, and put it into some
592
  other variable, without changing the value of 'values'.
Dave Love's avatar
Dave Love committed
593

594
** (Controlled by a flag) make open and close syntax match exactly,
595
  i.e. '(' doesn't match ']'.
Dave Love's avatar
Dave Love committed
596

597 598
** Specify parameter ID-FORMAT in all calls to 'file-attributes' and
  'directory-files-and-attributes' where attributes UID or GID are used.
599 600 601
  Whenever possible, use value 'string.
  When done, change meaning of default value from 'integer to 'string.
  If value 'integer is used nowhere, remove the parameter ID-FORMAT from
602
  the definition of 'file-attributes' and 'directory-files-and-attributes'
603 604
  and from the calls.

605
** Make language-info-alist customizable.  Currently a user can customize
606
  only the variable 'current-language-environment'.
607 608 609 610 611 612

** Improve language environment handling so that Emacs can fit
  better to a users locale.  Currently Emacs uses utf-8 language
  environment for all utf-8 locales, thus a user in ja_JP.UTF-8 locale
  are also put in utf-8 lang. env.  In such a case, it is
  better to use Japanese lang. env. but prefer utf-8 coding system.
613

614 615 616 617 618 619 620
** Enhance locale handling:  handle language, territory and charset
  orthogonally and de-emphasize language environments.  Use the locale
  to set up more things, such as fontsets, the default Ispell
  dictionary, diary format, calendar holidays and display, quoting
  characters and phrase boundaries, sentence endings, collation for
  sorting (at least for unicodes), HTTP Accept-language, patterns for
  directory listings and compilation messages, yes-or-no replies,
621
  common menu items when the toolkit supports it ...  'locale-info'
622 623
  needs extending for LC_COLLATE &c.  [fx started on this.]

624 625 626 627 628 629 630 631 632
** Eliminate the current restriction on header printing by ps-print.
  Currently, a header can contain only single 1-byte charset in
  addition to ASCII.

** In ps-print, provide an user friendly interface to specify fonts.

** Enhance word boundary detection for such a script that doesn't use
  space at word boundary (e.g. Thai).

633 634 635 636
** Implement interface programs with major Japanese conversion server
  in lib-src so that they can be used from the input method
  "japanese".  Currently, most Japanese users are using external
  packages (e.g. tamago, anthy) or an input method via XIM.
637

638
** Let LEIM handle the Mode_switch key like XIM does (i.e. a toggle like C-\
Glenn Morris's avatar
Glenn Morris committed
639
   but which can also be used as a modifier).
640

Nick Roberts's avatar
Nick Roberts committed
641
** Improve Help buffers: Change the face of previously visited links (like
Glenn Morris's avatar
Glenn Morris committed
642 643
   Info, but also with regard to namespace), and give the value of
   lisp expressions, e.g auto-mode-alist, the right face.
Nick Roberts's avatar
Nick Roberts committed
644

645
** Possibly make 'list-holidays' eval items in the calendar-holidays variable.
Glenn Morris's avatar
Glenn Morris committed
646
   See thread
647
   <https://lists.gnu.org/r/emacs-devel/2006-02/msg01034.html>.
Glenn Morris's avatar
Glenn Morris committed
648 649
   [rgm@gnu.org will look at this after 22.1]

Glenn Morris's avatar
Glenn Morris committed
650 651
** Possibly make cal-dst use the system timezone database directly.
   See thread
652
   <https://lists.gnu.org/r/emacs-pretest-bug/2006-11/msg00060.html>
Glenn Morris's avatar
Glenn Morris committed
653

Glenn Morris's avatar
Glenn Morris committed
654 655 656
** Possibly add a "close" button to the modeline.
   The idea is to add an "X" of some kind, that when clicked deletes
   the window associated with that modeline.
657
   https://lists.gnu.org/r/emacs-devel/2007-09/msg02416.html
Glenn Morris's avatar
Glenn Morris committed
658

659 660
* Things to be done for specific packages or features

661 662
** NeXTstep port

663 664 665 666
*** Missing features

This sections contains features found in other official Emacs ports.

667
**** Support for xwidgets
668

669
Emacs 25 has support for xwidgets, a system to include operating
670
system components into an Emacs buffer.  The components range from
671
simple buttons to webkit (effectively, a web browser).
672

673
Currently, xwidgets works only for the gtk+ framework but it is
674 675
designed to be compatible with multiple Emacs ports.

676
**** Respect 'frame-inhibit-implied-resize'
677

678
When the variable 'frame-inhibit-implied-resize' is non-nil, frames
679 680 681 682 683 684
should not be resized when operations like changing font or toggling
the tool bar is performed.

Unfortunately, the tool bar (and possible other operations) always
resize the frame.

685
**** Support 'proced' (implement 'process-attributes')
686 687

Unfortunately, a user-level process like Emacs does not have the
688
privileges to get information about other processes under macOS.
689 690 691 692 693 694 695 696 697 698

There are other ways to do this:

 1) Spawn "ps" and parse the output ("ps" has superuser privileges).

 2) Sign Emacs as part of the distribution process.

 3) Ask the user to self-sign Emacs, if this feature is of interest.

Anders Lindgren <andlind@gmail.com> has implemented
699
'process-attributes' for macOS, which currently only work when
700 701 702 703 704 705 706 707 708 709 710 711
running Emacs as root.

See this article by Bozhidar Batsov for an overview of Proced:
http://emacsredux.com/blog/2013/05/02/manage-processes-with-proced/

**** Tooltip properties

Tooltip properties like the background color and font are hard-wired,
even though Emacs allows a user to customize such features.

*** New features

712
This section contains features unique to Nextstep and/or macOS.
713 714 715

**** PressAndHold for writing accented character

716
On macOS, many application support the press and hold pattern to
717 718 719 720 721 722 723 724 725 726 727 728
invoke a menu of accented characters.  (See example at
https://support.apple.com/en-us/HT201586 .)

Currently, this doesn't work in Emacs.

Note that "ns-win.el" explicitly disables this.

Note: This feature might not be allowed to be implemented until also
implemented in Emacs for a free system.

**** Floating scroll bars

729
In modern macOS applications, the scroll bar often floats over the
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
content, and is invisible unless actually used.  This makes the user
interface less cluttered and more area could be used to contain text.

With floating scroll bars, the user interface would look like it does
when they are disabled today.  However, they will be made visible when
a scroll action is initiated, e.g. by putting two fingers on a
trackpad.

Note: This feature might not be allowed to be implemented until also
implemented in Emacs for a free system.

*** Features from the "mac" port

This section contains features available in the "mac" Emacs port.

As the "mac" port (as of this writing) isn't an official Emacs port,
it might contain features not following the FSF rule "must exist on
free systems".

The "mac" port is based on the Emacs 22 C-based Carbon interface.
It has been maintained in parallel to the official Cocoa-based NS
interface.  The Carbon interface has been enhanced, and a number of the
features of that interface could be implemented NS.

**** Smooth scrolling -- maybe not a good idea

Today, by default, scrolling with a trackpad makes the text move in
steps of five lines.  (Scrolling with SHIFT scrolls one line at a time.)

The "mac" port provides smooth, pixel-based, scrolling.  This is a very
popular features.  However, there are drawbacks to this method: what
happens if only a fraction of a line is visible at the top of a
window, is the partially visible text considered part of the window or
763
not?  (Technically, what should 'window-start' return.)
764 765 766 767 768 769 770 771 772

An alternative would be to make one-line scrolling the default on NS
(or in Emacs in general).

Note: This feature might not be allowed to be implemented until also
implemented in Emacs for a free system.

**** Mouse gestures

773 774
The "mac" port defines the gestures 'swipe-left/right/up/down',
'magnify-up/down', and 'rotate-left/right'.
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791

It also binds the magnification commands to change the font
size.  (This should be not be done in a specific interface, instead
Emacs should do this binding globally.)

Note: This feature might not be allowed to be implemented until also
implemented in Emacs for a free system.

**** Synthesize bold fonts

*** Open issues

This section contains issues where there is an ongoing debate.

**** Key bindings of CMD and ALT

Currently in the "ns" port, ALT is bound to Meta and CMD is bound to
792
Super -- allowing the user to use typical macOS commands like CMD-A to
793 794 795 796 797 798 799 800 801 802 803 804 805 806
mark everything.

Unfortunately, when using an international keyboard, you can't type
normal characters like "(" etc.

There are many alternative key bindings.  One solution is to bind CMD
to Meta and pass ALT to the system.  In fact, this is what Emacs did up
to, and including, version 22.  Also, this is how the "mac" port binds
the keys.

One could envision asymmetrical variants as well, however, this is
inappropriate for the default setting.

See the discussion on emacs-devel:
807 808
https://lists.gnu.org/r/emacs-devel/2015-12/msg01575.html
https://lists.gnu.org/r/emacs-devel/2016-01/msg00008.html
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825

*** Internal development features

**** Regression test system (or at least a checklist)

Today, after each change to the user interface, Emacs must be manually
tested.  Often, small details are overlooked ("Oh, I didn't test
toggling the tool-bar in one of the full screen modes, when multiple
frame were open -- silly me.")

It would be an enormous help if this could be tested automatically.
Many features are generic, however, the NS interface provides a number
of unique features.

**** Existing packages

Note that there is a generic UI test named frame-test.el, see
826
https://debbugs.gnu.org/21415#284 .
827 828 829 830 831 832 833 834 835 836 837 838 839
The NS interface passes this, with the exception of two toolbar-related errors.

**** Anders frame test

Anders Lindgren <andlind@gmail.com> has implemented some (very basic)
tests for full screen, toolbar, and auto-hiding the menu bar.

**** Make sure all build variants work

Emacs can be build in a number of different ways.  For each feature,
consider if is really is "NS" specific, or if it should be applied to
all build versions.

840 841
- With the "NS" interface.  This is the normal way to build Emacs on
  macOS.
842

843
- With the "X11" interface.  On macOS, this is mainly of interest to
844 845 846 847 848 849
  developers of Emacs to get a "reference" interface implementations.
  However, it might be of interest for people working remotely, as X11
  applications can be used over a network connection.

- Console only.

850 851
*** Bugs

852
**** Incorrect translation of Super modifier with Ctrl or Meta on macOS
853

854
When pressing 'M-s-a', Emacs replies "M-s-å is undefined".  What
855
happened is a mix of Emacs view that Meta and Super has been pressed,
856 857
and macOS view that ALT-a should yield "å" (U+00E5 LATIN SMALL LETTER
A WITH RING ABOVE).
858

859 860
The bug reports suggest two different patches; unfortunately, neither
works properly.  For example:
861 862 863 864 865 866 867

   Use a Swedish keyboard layout

   (setq ns-alternate-modifier nil)

   "CMD-ALT-9"

868
Today, this correctly yields that s-] is undefined.  With either
869 870 871 872 873
of the two patches, Emacs responds that s-9 was pressed.

More investigation is needed to fix this problem.

Links:
874 875 876
- https://debbugs.gnu.org/19977
- https://debbugs.gnu.org/21330
- https://debbugs.gnu.org/21551
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891

**** Toggling the toolbar in fullheight or maximized modes

The toolbar, in the NS interface, is not considered part of the text
area.  When it is toggled, the Emacs frame change height accordingly.

Unfortunately, this also occurs when the frame is in fullheight or
maximized modes (N.B. this is not the same as "fullscreen").  The
effect is that the full frame size either increases (stretching down
below the lower edge of the screen) or decreases (leaving space
between the lower edge of the frame and the lower edge of the screen).

A better solution would be for the frame to retain its size,
i.e. change the text area.

892
This is related to the 'frame-inhibit-implied-resize' issue.
893

894
**** The event loop does not redraw.
895 896 897 898 899 900
A problem is that redraw don't happen during resize,
because we can't break out from the NSapp loop during resize.
There was a special trick to detect mouse press in the lower right
corner and track mouse movements, but this did not work well, and was
not scalable to the new Lion "resize on every window edge" behavior.
[As of trunk r109635, 2012-08-15, the event loop no longer polls.]
901

902
**** (mouse-avoidance-mode 'banish) then minimize Emacs, will pop window back
903
up on top of all others (probably fixed in bug#17439)
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922

**** free_frame_resources, face colors

**** Numeric keysetting bug.

*** Mac-related

**** Open file:/// URLs.

**** Put frame autopositioning into C code somewhere -- if loc = same, offset.

**** Automap ctrl-mouse-1 to mouse-3.

**** Deal with Finder aliases somehow.

**** Ctrl-F2 won't pull up menus.

*** Other / Low Priority:

Juanma Barranquero's avatar
Juanma Barranquero committed
923
**** Better recognition of Unicode scripts / Greek / composition.
924 925 926

**** Undo for color-drag face customization.

927 928
** Bidirectional editing

929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
*** Support reordering structured text
Two important use cases: (1) comments and strings in program sources,
and (2) text with markup, like HTML or XML.

One idea is to invent a special text property that would instruct the
display engine to reorder only the parts of buffer text covered by
that property.  The display engine will then push its state onto the
iterator stack, restrict the bidi iterator to accessing only the
portion of buffer text covered by the property, reorder the text, then
pop its state from stack and continue as usual.  This will require
minor changes in the bidi_it structure.

This design requires Lisp-level code to put the text properties on the
relevant parts of the buffer text.  That could be done using JIT
fontifications, or as a preliminary processing when the file is
visited.  With HTML/XML, the code that puts text properties needs to
pay attention to the bidi directives embedded in the HTML/XML stream.

947 948 949
*** Allow the user to control the direction of the UI

**** Introduce user option to control direction of mode line.
950 951
One problem is the header line, which is produced by the same routines
as the mode line.  While it makes sense to have the mode-line
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
direction controlled by a single global variable, header lines are
buffer-specific, so they need a separate treatment in this regard.

**** User options to control direction of menu bar and tool bar.
For the tool bar, it's relatively easy: set it.paragraph_embedding
in redisplay_tool_bar according to the user variable, and make
f->desired_tool_bar_string multibyte with STRING_SET_MULTIBYTE.  Some
minor changes will be needed to set the right_box_line_p and
left_box_line_p flags correctly for the R2L tool bar.

However, it makes no sense to display the tool bar right to left if
the menu bar cannot be displayed in the same direction.

R2L menu bar is tricky for the same reasons as the mode line.  In
addition, toolkit builds create their menu bars in toolkit-specific
parts of code, bypassing xdisp.c, so those parts need to be enhanced
with toolkit-specific code to display the menu bar right to left.

Glenn Morris's avatar
Glenn Morris committed
970 971 972 973 974 975 976 977 978 979 980
** Custom

*** Extend :set-after to also mean initialize after.
If defcustom A specifies :set-after '(B), then if a user customizes
both A and B, custom will set A after B.  But if the user only customizes
A, then if B is already defined, it gets left at its original setting.
Instead, if B has not been customized it should be re-initialized
(on the assumption that the default value depends on A).
See the places where we manually call custom-reevaluate-setting,
such as for mail-host-address and user-mail-address in startup.el.

981 982 983 984
** ImageMagick support

*** image-type-header-regexps priorities the jpeg loader over the
ImageMagick one.  This is not wrong, but how should a user go about
Paul Eggert's avatar
Paul Eggert committed
985
preferring the ImageMagick loader?  The user might like zooming etc in jpegs.
986 987 988 989

Try (setq image-type-header-regexps nil) for a quick hack to prefer
ImageMagick over the jpg loader.

990
*** For some reason it's unbearably slow to look at a page in a large
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
image bundle using the :index feature.  The ImageMagick "display"
command is also a bit slow, but nowhere near as slow as the Emacs
code.  It seems ImageMagick tries to unpack every page when loading the
bundle.  This feature is not the primary usecase in Emacs though.

ImageMagick 6.6.2-9 introduced a bugfix for single page djvu load.  It
is now much faster to use the :index feature, but still not very fast.

*** Try to cache the num pages calculation.  It can take a while to
calculate the number of pages, and if you need to do it for each page
view, page-flipping becomes uselessly slow.

*** Integrate with image-dired.

1005 1006
*** Integrate with docview.

1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
*** Integrate with image-mode.
Some work has been done, e.g. M-x image-transform-fit-to-height will
fit the image to the height of the Emacs window.

*** Look for optimizations for handling images with low depth.
Currently the code seems to default to 24 bit RGB which is costly for
images with lower bit depth.

*** Decide what to do with some uncommitted imagemagick support
functions for image size etc.

Glenn Morris's avatar
Glenn Morris committed
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
** nxml mode

*** High priority

**** Command to insert an element template, including all required
attributes and child elements.  When there's a choice of elements
possible, we could insert a comment, and put an overlay on that
comment that makes it behave like a button with a pop-up menu to
select the appropriate choice.

**** Command to tag a region.  With a schema should complete using legal
tags, but should work without a schema as well.

**** Provide a way to conveniently rename an element.  With a schema should
complete using legal tags, but should work without a schema as well.

*** Outlining

**** Implement C-c C-o C-q.

**** Install pre/post command hook for moving out of invisible section.

**** Put a modify hook on invisible sections that expands them.

**** Integrate dumb folding somehow.

**** An element should be able to be its own heading.

**** Optimize to avoid complete buffer scan on each command.

**** Make it work with HTML-style headings (i.e. level indicated by
name of heading element rather than depth of section nesting).

**** Recognize root element as a section provided it has a title, even
if it doesn't match section-element-name-regex.

**** Support for incremental search automatically making hidden text visible.

**** Allow title to be an attribute.

**** Command that says to recognize the tag at point as a section/heading.

**** Explore better ways to determine when an element is a section
or a heading.

**** rng-next-error needs to either ignore invisible portion or reveal it
(maybe use isearch oriented text properties).

**** Errors within hidden section should be highlighted by underlining the
ellipsis.

**** Make indirect buffers work.

**** How should nxml-refresh outline recover from non well-formed tags?

**** Hide tags in title elements?

**** Use overlays instead of text properties for holding outline state?
Necessary for indirect buffers to work?

**** Allow an outline to go in the speedbar.

**** Split up outlining manual section into subsections.

**** More detail in the manual about each outlining command.

**** More menu entries for hiding/showing?

**** Indication of many lines have been hidden?

*** Locating schemas

**** Should rng-validate-mode give the user an opportunity to specify a
schema if there is currently none? Or should it at least give a hint
to the user how to specify a non-vacuous schema?

**** Support for adding new schemas to schema-locating files.
Add documentElement and namespace elements.

**** C-c C-w should be able to report current type id.

**** Implement doctypePublicId.

**** Implement typeIdBase.

**** Implement typeIdProcessingInstruction.

**** Support xml:base.

**** Implement group.

**** Find preferred prefix from schema-locating files.  Get rid of
rng-preferred-prefix-alist.

**** Inserting document element with vacuous schema should complete using
document elements declared in schema locating files, and set schema
appropriately.

**** Add a ruleType attribute to the <include> element?

**** Allow processing instruction in prolog to contain the compact syntax
schema directly.

**** Use RDDL to locate a schema based on the namespace URI.

**** Should not prompt to add redundant association to schema locating file.

**** Command to reload current schema.

*** Schema-sensitive features

**** Should filter dynamic markup possibilities using schema validity, by
adding hook to nxml-mode.

**** Dynamic markup word should (at least optionally) be able to look in
other buffers that are using nxml-mode.

**** Should clicking on Invalid move to next error if already on an error?

**** Take advantage of a:documentation.  Needs change to schema format.

**** Provide feasible validation (as in Jing) toggle.

**** Save the validation state as a property on the error overlay to enable
more detailed diagnosis.

**** Provide an Error Summary buffer showing all the validation errors.

Paul Eggert's avatar
Paul Eggert committed
1146
**** Pop-up menu.  What is useful?  Tag a region (should be grayed out if
Glenn Morris's avatar
Glenn Morris committed
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
the region is not balanced).  Suggestions based on error messages.

**** Have configurable list of namespace URIs so that we can provide
namespace URI completion on extension elements or with schema-less documents.

**** Allow validation to handle XInclude.

**** ID/IDREF support.

*** Completion

**** Make it work with icomplete.  Only use a function to complete when
some of the possible names have undeclared namespaces.

**** How should C-return in mixed text work?

**** When there's a vacuous schema, C-return after < will insert the end-tag.
Is this a bug or a feature?

**** After completing start-tag, ensure we don't get unhelpful message
from validation

**** Syntax table for completion.

**** Should complete start-tag name with a space if namespace attributes
are required.

**** When completing start-tag name with no prefix and it doesn't match
should try to infer namespace from local name.

**** Should completion pay attention to characters after point?  If so, how?

**** When completing start-tag name, add required atts if only one required
attribute.

**** When completing attribute name, add attribute value if only one value
is possible.

**** After attribute-value completion, insert space after close delimiter
if more attributes are required.

**** Complete on enumerated data values in elements.

**** When in context that allows only elements, should get tag
completion without having to type < first.

**** When immediately after start-tag name, and name is valid and not
prefix of any other name, should C-return complete on attribute names?

**** When completing attributes, more consistent to ignore all attributes
after point.

**** Inserting attribute value completions needs to be sensitive to what
delimiter is used so that it quotes the correct character.

**** Complete on encoding-names in XML decl.

**** Complete namespace declarations by searching for all namespaces
mentioned in the schema.

*** Well-formed XML support

**** Deal better with Mule-UCS

**** Deal with UTF-8 BOM when reading.

**** Complete entity names.

**** Provide some support for entity names for MathML.

**** Command to repeat the last tag.

**** Support for changing between character references and characters.
Need to check that context is one in which character references are
allowed.  xmltok prolog parsing will need to distinguish parameter
literals from other kinds of literal.

**** Provide a comment command to bind to M-; that works better than the
normal one.

**** Make indenting in a multi-line comment work.

**** Structure view.  Separate buffer displaying element tree.
Be able to navigate from structure view to document and vice-versa.

**** Flash matching >.

**** Smart selection command that selects increasingly large syntactically
coherent chunks of XML.  If point is in an attribute value, first
select complete value; then if command is repeated, select value plus
delimiters, then select attribute name as well, then complete
start-tag, then complete element, then enclosing element, etc.

**** ispell integration.

**** Block-level items in mixed content should be indented, e.g:
  <para>This is list:
    <ul>
      <li>item</li>

**** Provide option to indent like this:
    <para>This is a paragraph
     occupying multiple lines.</para>

**** Option to add make a / that closes a start-tag electrically insert a
space for the XHTML guys.

**** C-M-q should work.

*** Datatypes

**** Figure out workaround for CJK characters with regexps.

**** Does category C contain Cn?

**** Do ENTITY datatype properly.

*** XML Parsing Library

**** Parameter entity parsing option, nil (never), t (always),
unless-standalone (unless standalone="yes" in XML declaration).

**** When a file is currently being edited, there should be an option to
use its buffer instead of the on-disk copy.

*** Handling all XML features

**** Provide better support for editing external general parsed entities.
Perhaps provide a way to force ignoring undefined entities; maybe turn
this on automatically with <?xml encoding=""?> (with no version
pseudo-att).

**** Handle internal general entity declarations containing elements.

**** Handle external general entity declarations.

**** Handle default attribute declarations in internal subset.

**** Handle parameter entities (including DTD).

*** RELAX NG

**** Do complete schema checking, at least optionally.

**** Detect include/external loops during schema parse.

**** Coding system detection for schemas.  Should use utf-8/utf-16 per the
spec.  But also need to allow encodings other than UTF-8/16 to support
CJK charsets that Emacs cannot represent in Unicode.

*** Catching XML errors

**** Check public identifiers.

**** Check default attribute values.

*** Performance

**** Explore whether overlay-recenter can cure overlays performance problems.

**** Cache schemas.  Need to have list of files and mtimes.

**** Make it possible to reduce rng-validate-chunk-size significantly,
perhaps to 500 bytes, without bad performance impact: don't do
redisplay on every chunk; pass continue functions on other uses of
rng-do-some-validation.

**** Cache after first tag.

**** Introduce a new name class that is a choice between names (so that
we can use member)

**** intern-choice should simplify after patterns with same 1st/2nd args

**** Large numbers of overlays slow things down dramatically.  Represent
errors using text properties.  This implies we cannot incrementally
keep track of the number of errors, in order to determine validity.
Instead, when validation completes, scan for any characters with an
error text property; this seems to be fast enough even with large
buffers.  Problem with error at end of buffer, where there's no
character; need special variable for this.  Need to merge face from
font-lock with the error face: use :inherit attribute with list of two
faces.  How do we avoid making rng-valid depend on nxml-mode?

*** Error recovery

**** Don't stop at newline in looking for close of start-tag.

**** Use indentation to guide recovery from mismatched end-tags

**** Don't keep parsing when currently not well-formed but previously
well-formed

**** Try to recover from a bad start-tag by popping an open element if
there was a mismatched end-tag unaccounted for.

**** Try to recover from a bad start-tag open on the hypothesis that there
was an error in the namespace URI.

**** Better recovery from ill-formed XML declarations.

Paul Eggert's avatar
Paul Eggert committed
1348
*** Usability improvements
Glenn Morris's avatar
Glenn Morris committed
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470

**** Should print a "Parsing..." message during long movements.

**** Provide better position for reference to undefined pattern error.

**** Put Well-formed in the mode-line when validating against any-content.

**** Trim marking of illegal data for leading and trailing whitespace.

**** Show Invalid status as soon as we are sure it's invalid, rather than
waiting for everything to be completely up to date.

**** When narrowed, Valid or Invalid status should probably consider only
validity of narrowed region.

*** Bug fixes

**** Need to give an error for a document like: <foo/><![CDATA[  ]]>

**** Make nxml-forward-balanced-item work better for the prolog.

**** Make filling and indenting comments work in the prolog.

**** Should delete RNC Input buffers.

**** Figure out what regex use for NCName and use it consistently,

**** Should have not-well-formed tokens in ref.

**** Require version in XML declaration? Probably not because prevents
use for external parsed entities.  At least forbid standalone without version.

**** Reject schema that compiles to rng-not-allowed-ipattern.

**** Move point backwards on schema parse error so that it's on the right token.

*** Internal

**** Use rng-quote-string consistently.

**** Use parsing library for XML to texinfo conversion.

**** Rename xmltok.el to nxml-token.el.  Use nxml-t- prefix instead of
xmltok-.  Change nxml-t-type to nxml-t-token-type, nxml-t-start to
nxml-t-token-start.

**** Can we set fill-prefix to nil and rely on indenting?

**** xmltok should make available replacement text of entities containing
elements

**** In rng-valid, instead of using modification-hooks and
insert-behind-hooks on dependent overlays, use same technique as nxml-mode.

*** Fontification

**** Allow face to depend on element qname, attribute qname, attribute
value.  Use list with pairs of (R . F), where R specifies regexps and
F specifies faces.  How can this list be made to depend on the document type?

*** Other

**** Support RELAX NG XML syntax (use XML parsing library).

**** Support W3C XML Schema (use XML parsing library).

**** Command to infer schema from current document (like trang).

*** Schemas

**** XSLT schema should take advantage of RELAX NG to express cooccurrence
constraints on attributes (e.g. xsl:template).

*** Documentation

**** Move material from README to manual.

**** Document encodings.

*** Notes

**** How can we allow an error to be displayed on a different token from
where it is detected?  In particular, for a missing closing ">" we
will need to display it at the beginning of the following token.  At the
moment, when we parse the following token the error overlay will get cleared.

**** How should rng-goto-next-error deal with narrowing?

**** Perhaps should merge errors having same start position even if they
have different ends.

**** How to handle surrogates? One possibility is to be compatible with
utf8.e: represent as sequence of 4 chars.  But utf-16 is incompatible
with this.

**** Should we distinguish well-formedness errors from invalidity errors?
(I think not: we may want to recover from a bad start-tag by implying
an end-tag.)

**** Seems to be a bug with Emacs, where a mouse movement that causes
help-echo text to appear counts as pending input but does not cause
idle timer to be restarted.

**** Use XML to represent this file.

**** I had a TODO which said simply "split-string".  What did I mean?

**** Investigate performance on large files all on one line.

*** Issues for Emacs versions >= 22

**** Take advantage of UTF-8 CJK support.

**** Supply a next-error-function.

**** Investigate this NEWS item "Emacs now tries to set up buffer coding
systems for HTML/XML files automatically."

**** Take advantage of the pointer text property.

**** Leverage char-displayable-p.

1471 1472 1473 1474 1475 1476 1477 1478 1479
** RefTeX

*** Provide a wdired-like mode for editing RefTeX TOC buffers.
As a first step, renaming of sections could be supported.  Ultimately,
it would be great if it also supported moving sections, e.g., by
killing and yanking or providing org-mode like "move section
upwards/downwards" commands.  However, that's not so easy in the
presence of multi-file documents.

1480 1481
* Internal changes

Glenn Morris's avatar
Glenn Morris committed
1482
** Cleanup all the GC_ mark bit stuff -- there is no longer any distinction
Chong Yidong's avatar
Chong Yidong committed
1483 1484
   since the mark bit is no longer stored in the Lisp_Object itself.

1485
** Refine the 'predicate' arg to read-file-name.
1486 1487 1488
   Currently, it mixes up the predicate to apply when doing completion and the
   one to use when terminating the selection.

1489 1490 1491 1492
** Merge ibuffer.el and buff-menu.el.
   More specifically do what's needed to make ibuffer.el the default,
   or just an extension of buff-menu.el.

Glenn Morris's avatar
Glenn Morris committed
1493
** Replace linum.el with nlinum.el
1494
   https://lists.gnu.org/r/emacs-devel/2013-08/msg00379.html
Glenn Morris's avatar
Glenn Morris committed
1495

1496 1497 1498 1499 1500
** Merge sendmail.el and messages.el.
   Probably not a complete merge, but at least arrange for messages.el to be
   a derived mode of sendmail.el.  Or arrange for messages.el to be split
   into a small core and "the rest" so that we use less resources as long as
   we stick to the features provided in sendmail.el.
1501

1502
** Replace gmalloc.c with the modified Doug Lea code from the current
1503 1504 1505
   GNU libc so that the special mmapping of buffers can be removed --
   that apparently loses under Solaris, at least. [fx has mostly done
   this.]
1506 1507

** Rewrite make-docfile to be clean and maintainable.
1508
   It might be better to replace it with Lisp, using the byte compiler.
1509
   https://lists.gnu.org/r/emacs-devel/2012-06/msg00037.html
1510 1511 1512

** Add an inferior-comint-minor-mode to capture the common set of operations
   offered by major modes that offer an associated inferior
1513 1514 1515
   comint-derived mode.  I.e. basically make cmuscheme.el/inf-lisp.el generic.
   For use by sml-mode, python-mode, tex-mode, scheme-mode, lisp-mode,
   haskell-mode, tuareg-mode, ...
1516

1517 1518 1519 1520 1521
** Add "link" button class
   Add a standard button-class named "link", and make all other link-like
   button classes inherit from it.  Set the default face of the "link" button
   class to the standard "link" face.

1522 1523 1524
* Wishlist items:

** Maybe replace etags.c with a Lisp implementation.
1525
https://lists.gnu.org/r/emacs-devel/2012-06/msg00354.html
1526 1527 1528 1529 1530

** Maybe replace lib-src/rcs2log with a Lisp implementation.
It wouldn't have to be a complete replacement, just enough
for vc-rcs-update-changelog.

1531 1532
* Other known bugs:

1533
** 'make-frame' forgets unhandled parameters, at least for X11 frames.
1534

1535 1536 1537
** a two-char comment-starter whose two chars are symbol constituents will
not be noticed if it appears within a word.

1538 1539 1540

This file is part of GNU Emacs.

1541
GNU Emacs is free software: you can redistribute it and/or modify
1542
it under the terms of the GNU General Public License as published by
1543 1544
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
1545

1546 1547 1548 1549
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.
1550

1551
You should have received a copy of the GNU General Public License
1552
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
1553 1554 1555 1556

;; Local Variables:
;; coding: utf-8
;; End: