Fix some more docstring etc. quoting problems
[emacs.git] / etc / TODO
1 Emacs TODO List                                                   -*-outline-*-
3 Copyright (C) 2001-2015 Free Software Foundation, Inc.
4 See the end of the file for license conditions.
7 If you are ready to start working on any of these TODO items, we
8 appreciate your help; please write to so we can be
9 aware that the problem is being addressed, and talk with you how to do
10 it best.  Also to check that it hasn't been done already, since we
11 don't always remember to update this file!  It is best to consult
12 the latest version of this file in the Emacs source code repository.
14 Since Emacs is an FSF-copyrighted package, please be prepared to sign
15 legal papers to transfer the copyright on your work to the FSF.
16 For more details on this, see the section "Copyright Assignment"
17 in etc/CONTRIBUTE.  That file also contains some more practical
18 details about getting involved.
20 As well as the issues listed here, there are bug reports at
21 <>.  Bugs tagged "easy" ought to be suitable for
22 beginners to work on, but unfortunately we are not very good at using
23 this tag.  Bugs tagged "help" are ones where assistance is required,
24 but may be difficult to fix.  Bugs with severity "important" or higher
25 are the ones we consider more important, but these also may be
26 difficult to fix.  Bugs with severity "minor" may be simpler, but this
27 is not always true.
29 * Speed up Elisp execution
30 ** Speed up function calls
31 Change src/bytecode.c so that calls from byte-code functions to byte-code
32 functions don't go through Ffuncall/funcall_lambda/exec_byte_code but instead
33 stay within exec_byte_code.
35 ** Add new 'switch' byte-code
36 This byte-code would take one argument from the stack (the object to test)
37 and one argument from the constant-pool (a switch table, implemented as an
38 eq-hashtable) and would jump to the "label" contained in the hashtable.
40 Then add a 'case' special-form that can be compiled to this byte-code.
41 This would behave just like cl-case, but instead of expanding to cond+eq it
42 would be its own special form and would be compiled specially.
44 Then change pcase to use 'case' when applicable.
46 Then change the byte-compiler to recognize (cond ((eq x 'foo) bar) ...)
47 and turn it into a 'case' for more efficient execution.
49 ** Improve the byte-compiler to recognize immutable (lexical) bindings
50 and get rid of them if they're used only once and/or they're bound to
51 a constant expression.
53 Such things aren't present in hand-written code, but macro expansion and
54 defsubst can often end up generating things like
55 (funcall (lambda (arg) (body)) actual) which then get optimized to
56 (let ((arg actual)) (body)) but should additionally get optimized further
57 when 'actual' is a constant/copyable expression.
59 ** Add an "indirect goto" byte-code and use it for local lambda expressions.
60 E.g. when you have code like
62    (let ((foo (lambda (x) bar)))
63      (dosomething
64       (funcall foo toto)
65       (blabla (funcall foo titi))))
67 turn those 'funcalls' into jumps and their return into indirect jumps back.
69 ** Compile efficiently local recursive functions
71 Similar to the previous point, we should be able to handle something like
73    (letrec ((loop () (blabla) (if (toto) (loop))))
74      (loop))
76 which ideally should generate the same byte-code as
78    (while (progn (blabla) (toto)))
80 * Things that were planned for Emacs-24
82 ** concurrency: including it as an "experimental" compile-time option
83   sounds good.  Of course there might still be big questions around "which form
84   of concurrency" we'll want.
85 ** better support for dynamic embedded graphics: I like this idea (my
86   mpc.el code could use it for the volume widget), though I wonder if the
87   resulting efficiency will be sufficient.
88 ** Spread Semantic.
89 ** Improve the "code snippets" support: consolidate skeleton.el, tempo.el,
90   and expand.el (any other?) and then advertise/use/improve it.
91 ** Improve VC: yes, there's a lot of work to be done there :-(
93 ** Random things that cross my mind right now that I'd like to see (some of
94 them from my local hacks), but it's not obvious at all whether they'll
95 make it.
96 *** prog-mode could/should provide a better fill-paragraph default
97   that uses syntax-tables to recognize string/comment boundaries.
98 *** provide more completion-at-point-functions.  Make existing
99   in-buffer completion use completion-at-point.
100 *** "functional" function-key-map that would make it easy to add (and
101   remove) mappings like "FOO-mouse-4 -> FOO-scroll-down",
102   "FOO-tab -> ?\FOO-\t", "uppercase -> lowercase", "[fringe KEY...] ->
103   [KEY]", "H-FOO -> M-FOO", "C-x C-y FOO -> H-FOO", ...
105 * Things related to
107 ** Move idlwave to
108 Need to sync up the Emacs and external versions.
109 See <>
111 ** Move Org mode to
112 See <>
113 <>
115 ** Move verilog-mode to
116 See <>
118 ** Move vhdl-mode to
119 See <>
121 * Simple tasks. These don't require much Emacs knowledge, they are
122 suitable for anyone from beginners to experts.
124 ** Convert modes that use view-mode to be derived from special-mode instead.
126 ** Major modes should have a menu entry.
128 ** Check if all items on the mode-line have a suitable tooltip for all modes.
130 ** edebug and debugger-mode should have a toolbar.
131 It can use the same icons as gud.
133 ** Check what minor modes don't use define-minor-mode and convert them
134 to use it.
136 ** Convert all defvars with leading '*' in the doc-strings into defcustoms
137 of appropriate :type and :group.
139 ** Remove any leading '*'s from defcustom doc-strings.
140 [done?] [A lot of them are in CC Mode.]
142 ** Remove unnecessary autoload cookies from defcustoms.
143 This needs a bit of care, since often people have become used to
144 expecting such variables to always be defined, eg when they modify
145 things in their .emacs.
147 ** See if other files can use generated-autoload-file (see eg ps-print).
149 ** Write more tests.  Pick a fixed bug from the database, write a test
150 case to make sure it stays fixed.  Or pick your favorite programming
151 major-mode, and write a test for its indentation.  Or a version
152 control backend, and write a test for its status parser.  Etc.
153 See test/automated for examples.
155 * Small but important fixes needed in existing features:
157 ** Flymake's customization mechanism needs to be both simpler (fewer
158 levels of indirection) and better documented, so it is easier to
159 understand.  I find it quite hard to figure out what compilation
160 command it will use.
162 I suggest totally rewriting that part of Flymake, using the simplest
163 mechanism that suffices for the specific needs.  That will be easy
164 for users to customize.
166 ** Distribute a bar cursor of width > 1 evenly between the two glyphs
167    on each side of the bar (what to do at the edges?).
169 ** revert-buffer should eliminate overlays and the mark.
170    For related problems consult the thread starting with
173 ** erase-buffer should perhaps disregard read-only properties of text.
175 ** Fix the kill/yank treatment of invisible text.  At the moment,
176   invisible text is placed in the kill-ring, so that the contents of
177   the ring may not correspond to the text as displayed to the user.
178   It ought to be possible to omit text which is invisible (due to a
179   text-property, overlay, or selective display) from the kill-ring.
181 ** Feature to change cursor shape when Emacs is idle (for more than
182   a specified time).
184 ** The buttons at the top of a custom buffer should not omit
185   variables whose values are currently hidden.
187 ** Clean up the variables in browse-url.  Perhaps use a shell command string to
188   specify the browser instead of the mushrooming set of functions.
189   See also ESR's proposal for a BROWSER environment variable
190   <URL:>.
192 ** Enhance scroll-bar to handle tall line (similar to line-move).
194 ** In Custom buffers, put the option that turns a mode on or off first,
195   using a heuristic of some kind?
197 ** Define recompute-arg and recompute-arg-if for fix_command to use.
198   See rms message of 11 Dec 05 in
200   and the rest of that discussion.
202 ** In Emacs Info, examples of using Customize should be clickable
203    and they should create Custom buffers.
205 ** The toolbar should show keyboard equivalents in its tooltips.
207 ** Add function to redraw the tool bar.
209 ** Redesign the load-history data structure so it can cope better
210   with evaluating definitions of the same function from different files,
211   recording which file the latest definition came from.
213 ** make back_comment use syntax-ppss or equivalent.
215 ** Consider improving src/sysdep.c's search for a fqdn.
218 ** Find a proper fix for rcirc multiline nick adding.
221 ** Check for any included packages that define obsolete bug-reporting commands.
222 Change them to use report-emacs-bug.
223 *** Related functions:
224 **** gnus-bug
225 **** report-calc-bug
226 **** org-submit-bug-report
227 **** lm-report-bug
228 **** tramp-bug
229 **** c-submit-bug-report
230 **** ffap-bug and ffap-submit-bug (obsoleted)
231 [Do all of them need changing?]
233 ** Allow fringe indicators to display a tooltip (provide a help-echo property?)
235 ** Add a defcustom that supplies a function to name numeric backup files,
236 like make-backup-file-name-function for non-numeric backup files.
238 ** 'dired-mode' should specify the semantics of 'buffer-modified-p' for
239 dired buffers and DTRT WRT 'auto-revert-mode'.
241 ** Check uses of prin1 for error-handling.
244 * Important features:
246 ** "Emacs as word processor"
248     rms writes:
249     25 years ago I hoped we would extend Emacs to do WYSIWYG word
250     processing.  That is why we added text properties and variable
251     width fonts.  However, more features are still needed to achieve this.
253 ** Extend text-properties and overlays
254 *** Several text-property planes
255 This would get us rid of font-lock-face property (and I'd be happy to
256 get rid of char-property-alias-alist as well) since font-lock would
257 simply use the 'face' property in the 'font-lock' plane.
259 Basically 'put-text-property' and friends would take an extra argument PLANE
260 (maybe the best backward-compatible way to do that is to make it so that
261 PROPERTY can be a cons cell (PLANE . PROP)).  So font-lock would
262 do (put-text-property start end '(font-lock . face) value).
264 All the properties coming from the various planes would get merged via an Elisp
265 function (so it can merge 'face' differently than 'keymap' or it could give
266 different priorities to different planes (we could imagine enabling/disabling
267 planes)).  The merging would not happen lazily while looking up properties but
268 instead it would take place eagerly in 'add-text-properties'.  This is based on
269 the idea that it's much more frequent to lookup properties than to
270 modify them.  Also, when properties are looked up during redisplay, we
271 generally can't run Elisp code, whereas we generally can do that when
272 properties are added.
274 *** Move overlays to intervals.c
276 Currently overlays are implemented as (two) sorted singly linked lists (one
277 for overlays_before some position and one for overlay_after that
278 position, for some quirky definition of "before" and "after").
279 The function 'overlay-recenter' changes the position used for the split
280 (and is called internally in various situations).
282 Each overlay is itself implemented with two markers (which keep track of
283 the overlay-start and overlay-end).  Markers are implemented as
284 a non-sorted singly linked list of markers.  So every text
285 insertion/deletion requires O(N) time, where N is the number of markers
286 since we have to go down that list to update those markers that are
287 affected by the modification.
289 You can start in src/buffer.[ch], maybe grepping for overlays_before for
290 a starting point.
292 Text-properties, OTOH, are implemented with a (mostly) balanced binary
293 tree.  This is implemented in src/intervals.[ch].
295 So we'd like to change overlays so that they don't use markers (and we
296 don't keep them in two sorted singly-linked lists) any more.  Instead,
297 we'll store them inside the balanced binary tree used for
298 text-properties.  I think we can use the "augmented tree" approach
299 described in
301 To ease up debugging during development, I'd guess the implementation
302 would first add the new stuff, keeping the old stuff (i.e. add to
303 Lisp_Overlay whichever fields are needed for the new code, while keeping
304 the old ones, add needed overlay fields to the intervals tree, but keep
305 the old fields, the overlays_before etc...).  This way, you can add
306 consistency checks that make sure the new code computes the same results
307 as the old code.  And once that works well, we can remove the old code
308 and old fields.
310 ** Having tabs above a window to switch buffers in it.
312 ** "Perspectives" are named persistent window configurations.  We have
313 had the window configuration mechanism in GNU Emacs since the
314 beginning but we have never developed a good user interface to take
315 advantage of them.  Eclipse's user interface seems to be good.
317 Perspectives work well even if you do the equivalent of C-x 4 C-f
318 because of the distinction between view windows vs file windows.  In
319 Emacs this is more or less the "dedicated window" feature, but we have
320 never really made it work for this.
322 Perspectives also need to interact with the tabs.
324 ** FFI (foreign function interface)
325 See eg
327 One way of doing this is to start with fx's dynamic loading, and use it
328 to implement things like auto-loaded buffer parsers and database
329 access in cases which need more than Lisp.
331 ** Replace unexec with a more portable form of dumping
332 See eg
335 One way is to provide portable undumping using mmap (per gerd design).
337 ** Imenu could be extended into a file-structure browsing mechanism
338 using code like that of customize-groups.
340 ** Display something in the margin on lines that have compilation errors.
342 ** Compilation error navigation bar, parallel to the scroll bar,
343 indicating where in the buffer there are compilation errors.
344 Perhaps we could arrange to display these error indications on top
345 of the scroll bar itself.  That depends on to what extent toolkit
346 scroll bars are extensible.
348 ** Provide user-friendly ways to list all available font families,
349   list fonts, display a font as a sample, etc.  [fx is looking at
350   multilingual font selection for the Unicode branch of Emacs.]
352 ** Provide a convenient way to select a color with the mouse.
354 ** Rewrite the face code to be simpler, clearer and faster.
356 ** Program Enriched mode to read and save in RTF.  [Is there actually a
357   decent single definition of RTF?  Maybe see info at
358]  This task seems to be addressed
359   by, which is still in
360   very early stages.
362   Another place to look is the Wikipedia article at
365   It currently points to the latest spec of RTF v1.9.1 at
368 ** Implement primitive and higher-level functions to allow filling
369   properly with variable-pitch faces.
371 ** Implement intelligent search/replace, going beyond query-replace
372   (see
374 ** Implement other text formatting properties.
375 *** Footnotes that can appear either in place or at the end of the page.
376 *** text property that says "don't break line in middle of this".
377    Don't break the line between two characters that have the
378    same value of this property.
379 *** Discretionary hyphens that are not visible when they are at end of line.
381 ** Internationalize Emacs's messages.
383 ** Set up a facility to save backtraces when errors happen during
384 specified filters, specified timers, and specified hooks.
386 ** Install's no-flicker change.
388 ** Add a "current vertical pixel level" value that goes with point,
389   so that motion commands can also move through tall images.
390   This value would be to point as window-vscroll is to window-start.
392 ** Address internationalization of symbols names essentially
393   as documentation, e.g. in command names and Custom.
395 ** Make the Lucid menu widget display multilingual text.  [This
396   probably needs to be done from actual Emacs buffers, either directly
397   in the menu or by rendering in an unmapped window and copying the
398   pixels.  The current code assumes a specific locale; that isn't good
399   enough even if X can render the arbitrary text] [The gtk
400   port now displays multilingual text in menus, but only insofar as
401   Emacs can encode it as utf-8 and gtk can display the result.]
402   Maybe making Lucid menus work like Gtk's (i.e. just force utf-8) is good
403   enough now that Emacs can encode most chars into utf-8.
405 ** The GNUstep port needs some serious attention, ideally from someone
406 familiar with GNUstep and Objective C.
408 * Other features we would like:
410 ** A more modern printing interface.  One that pops up a dialog that lets
411 you choose printer, page style, etc.
412 Integration with the Gtk print dialog is apparently difficult.  See eg:
416 ** Allow frames(terminals) created by emacsclient to inherit their environment
417 from the emacsclient process.
419 ** Give Tar mode all the features of Archive mode.
421 ** Create a category of errors called 'process-error'
422   for some or all errors associated with using subprocesses.
424 ** Maybe reinterpret 'parse-error' as a category of errors
425   and put some other errors under it.
427 ** Make byte-compile warn when a doc string is too wide.
429 ** Make byte-optimization warnings issue accurate line numbers.
431 ** Record the sxhash of the default value for customized variables
432   and notify the user (maybe by adding a menu item or toolbar button,
433   as the detection can occur during autoload time) when the default
434   changes (meaning that new versions of the Lisp source with a changed
435   default value got installed) and offer ediff on the respective
436   customization buffers.
438 ** Emacs Lisp mode could put an overlay on the defun for every
439   function that has advice.  The overlay could have 'after-text' like
440   " [Function has advice]".  It might look like (defun foo [Function
441   has advice] (x y) The overlay could also be a button that you could
442   use to view the advice.
444 ** Add a function to get the insertion-type of the markers in an overlay.
446 ** ange-ftp
447 *** understand sftp
448    This is hard to make work because sftp doesn't print status messages.
450 *** Use MLS for ange-ftp-insert-directory if a list of files is specified.
452 ** Ability to map a key, including all modified-combinations.
453    E.g map mouse-4 to wheel-up as well as M-mouse-4 -> M-wheel-up
454    M-C-mouse-4 -> M-C-wheel-up, H-S-C-M-s-double-mouse-4 ->
455    H-S-C-M-s-double-wheel-up, ...
457 ** Beefed-up syntax-tables.
458 *** recognize multi-character syntactic entities like 'begin' and 'end'.
459 *** nested string-delimiters (for PostScript's (foo(bar)baz) strings).
460 *** support for infix operators (with precedence).
461 *** support for the $ (paired delimiter) in parse-partial-sexp.
462 *** support for hook-chars whose effect on the parsing-state is specified
463         by elisp code.  Thus a char could both close a string and open a comment
464         at the same time and do it in a context-sensitive way.
465 *** ability to add mode-specific data to the partial-parse-state.
467 ** Add a way to convert a keyboard macro to equivalent Lisp code.
469 ** Have a command suggestion help system that recognizes patterns
470   of commands which could be replaced with a simpler common command.
471   It should not make more than one suggestion per 10 minutes.
473 ** Add a way to define input methods by computing them (when first used)
474   from other input methods.  Then redefine C-x 8 to use a
475   user-selected input method, with the default being the union of
476   latin-1-prefix and latin-1-postfix.
478 ** Implement a clean way to use different major modes for
479   different parts of a buffer.  This could be useful in editing
480   Bison input files, for instance, or other kinds of text
481   where one language is embedded in another language.  See
482 and also
483   mmm-mode, as reference for approaches taken by others.
485 ** Arrange a way for an input method to return the first character
486   immediately, then replace it later.  So that C-s a with
487   input method latin-1-postfix would immediately search for an a.
489 ** Give start-process the ability to direct standard-error
490   output to a different filter.
492 ** Give desktop.el a feature to switch between different named desktops.
494 ** Add a cpio mode, more or less like tar mode.
496 ** Save undo information in special temporary files, and reload it
497   when needed for undoing.  This could extend undo capacity.
498   undo-tree, in ELPA, already does this; its saving code could be
499   integrated without requiring the use of undo-tree.
501 ** Change the Windows NT menu code
502   so that it handles the deep_p argument and avoids
503   regenerating the whole menu bar menu tree except
504   when the user tries to use the menubar.
506   This requires the RIT to forward the WM_INITMENU message to
507   the main thread, and not return from that message until the main
508   thread has processed the MENU_BAR_ACTIVATE_EVENT and regenerated
509   the whole menu bar.  In the mean time, it should process other messages.
511 ** Get some major packages installed: W3 (development version needs
512   significant work), PSGML, _possibly_ ECB.
514   Check the assignments file for other packages which might go in and
515   have been missed.
517 ** Make compiler warnings about functions that might be undefined at run time
518  smarter, so that they know which files are required by the file being
519  compiled and don't warn about functions defined in them.
521 ** Split out parts of lisp.h.
523 ** Update the FAQ.
525 ** Allow auto-compression-mode to use zlib calls if zlib is available.
526   [It's required for PNG, so may be linked anyhow.]
528 ** Improve the GC (generational, incremental).  (We may be able to use
529   the Boehm collector.)  [See the Boehm-GC branch in CVS for work on this.]
531 ** Check what hooks would help Emacspeak -- see the defadvising in W3.
533 ** Add definitions for symbol properties, for documentation purposes.
535 ** Temporarily remove scroll bars when they are not needed, typically
536   when a buffer can be fully displayed in its window.
538 ** Provide an optional feature which computes a scroll bar slider's
539   size and its position from lines instead of characters.
541 ** Allow unknown image types to be rendered via an external program
542   converting them to, say, PBM (in the same way as PostScript?). [does
543   doc-view.el do this, or could it be extended to do this?
544   Does ImageMagick obsolete this idea?]
546 ** Allow displaying an X window from an external program in a buffer,
547   e.g. to render graphics from Java applets.  [gerd and/or wmperry
548   thought this was feasible.]
550 ** Allow images (not just text) in the margin to be mouse-sensitive.
551   (Requires recursing through display properties).  Provide some way
552   to simulate mouse-clicks on marginal text without a mouse.
554 ** Extend ps-print to deal with multiple font sizes, images, and extra
555   encodings.
557 ** Use the XIE X extension, if available, for image display.
559 ** Make monochrome images display using the foreground and background
560   colors of the applicable faces.
562 ** Make 'format-time-string' preserve text properties like 'format'.
564 ** Optionally make the cursor a little thinner at the end of a line
565   or the end of the buffer.
567 ** Port the conservative stack marking code of Emacs's garbage collector
568   to more systems, so that we can completely get rid of GCPROs.  Note
569   that Boehm garbage collector provides this.
571 ** Reorder defcustom's in each package so that the more important
572   options come first in the Customize buffers.  This could be done by
573   either rearranging the file (since options are shown in the order
574   they appear in the *.el files), or by adding a few :set-after attributes.
576 ** Maybe document the features of libraries missing from the manual (or
577   ancillary manuals, including the Lisp manual in some cases).
578   This is not worth doing for all of these packages and we need not
579   aim for completeness, but some may be worth documenting.
581   Here's a list which is probably not complete/correct: align, allout,
582   artist, ansi-color, array, calculator, cdl, cmuscheme,
583   completion, delim-col, dirtrack, double, echistory, elide-head,
584   easymenu, expand, flow-ctrl, format [format-alist],
585   generic/generic-x [various modes], kermit, log-edit,
586   makesum, midnight [other than in Kill Buffer node],
587   mouse-copy [?], mouse-drag, mouse-sel, net-utils, rcompile,
588   snmp-mode [?], soundex [should be interactive?], strokes [start from
589   the web page], talk, thingatpt [interactive functions?], type-break,
590   vcursor, xscheme, zone-mode [?], mlconvert [?], iso-cvt,
591   feedmail [?], uce, gametree, page-ext,
592   refbib, refer, scribe, texinfo, underline,
593   cmacexp, hideif, mantemp [obsolete?], pcomplete, xml,
594   cvs-status (should be described in PCL-CVS manual); other progmodes,
595   probably in separate manual.
597 ** Convert the XPM bitmaps to PPM, replace the PBMs with them and scrap
598   the XPMs so that the color versions work generally.  (Requires care
599   with the color used for the transparent regions.)
601 ** Convenient access to the 'values' variable.  It would be nice to have an
602   interface that would show you the printed reps of the elements of the
603   list in a menu, let you select one of the values, and put it into some
604   other variable, without changing the value of 'values'.
606 ** (Controlled by a flag) make open and close syntax match exactly,
607   i.e. '(' doesn't match ']'.
609 ** Specify parameter ID-FORMAT in all calls to 'file-attributes' and
610   'directory-files-and-attributes' where attributes UID or GID are used.
611   Whenever possible, use value 'string.
612   When done, change meaning of default value from 'integer to 'string.
613   If value 'integer is used nowhere, remove the parameter ID-FORMAT from
614   the definition of 'file-attributes' and 'directory-files-and-attributes'
615   and from the calls.
617 ** Make language-info-alist customizable.  Currently a user can customize
618   only the variable 'current-language-environment'.
620 ** Improve language environment handling so that Emacs can fit
621   better to a users locale.  Currently Emacs uses utf-8 language
622   environment for all utf-8 locales, thus a user in ja_JP.UTF-8 locale
623   are also put in utf-8 lang. env.  In such a case, it is
624   better to use Japanese lang. env. but prefer utf-8 coding system.
626 ** Enhance locale handling:  handle language, territory and charset
627   orthogonally and de-emphasize language environments.  Use the locale
628   to set up more things, such as fontsets, the default Ispell
629   dictionary, diary format, calendar holidays and display, quoting
630   characters and phrase boundaries, sentence endings, collation for
631   sorting (at least for unicodes), HTTP Accept-language, patterns for
632   directory listings and compilation messages, yes-or-no replies,
633   common menu items when the toolkit supports it ...  'locale-info'
634   needs extending for LC_COLLATE &c.  [fx started on this.]
636 ** Eliminate the current restriction on header printing by ps-print.
637   Currently, a header can contain only single 1-byte charset in
638   addition to ASCII.
640 ** In ps-print, provide an user friendly interface to specify fonts.
642 ** Enhance word boundary detection for such a script that doesn't use
643   space at word boundary (e.g. Thai).
645 ** Implement interface programs with major Japanese conversion server
646   in lib-src so that they can be used from the input method
647   "japanese".  Currently, most Japanese users are using external
648   packages (e.g. tamago, anthy) or an input method via XIM.
650 ** Let LEIM handle the Mode_switch key like XIM does (i.e. a toggle like C-\
651    but which can also be used as a modifier).
653 ** Improve Help buffers: Change the face of previously visited links (like
654    Info, but also with regard to namespace), and give the value of
655    lisp expressions, e.g auto-mode-alist, the right face.
657 ** Possibly make 'list-holidays' eval items in the calendar-holidays variable.
658    See thread
659    <>.
660    [ will look at this after 22.1]
662 ** Possibly make cal-dst use the system timezone database directly.
663    See thread
664    <>
666 ** Possibly add a "close" button to the modeline.
667    The idea is to add an "X" of some kind, that when clicked deletes
668    the window associated with that modeline.
671 * Things to be done for specific packages or features
673 ** NeXTstep port
675 *** Bugs
677 **** The event loop does not redraw.
678      A problem is that redraw don't happen during resize,
679      because we can't break out from the NSapp loop during resize.
680      There was a special trick to detect mouse press in the lower right
681      corner and track mouse movements, but this did not work well, and was
682      not scalable to the new Lion "resize on every window edge" behavior.
683      [As of trunk r109635, 2012-08-15, the event loop no longer polls.]
685 **** (mouse-avoidance-mode 'banish) then minimize Emacs, will pop window back
686 up on top of all others (probably fixed in bug#17439)
688 **** free_frame_resources, face colors
690 **** Numeric keysetting bug.
692 *** Mac-related
694 **** Open file:/// URLs.
696 **** Put frame autopositioning into C code somewhere -- if loc = same, offset.
698 **** Automap ctrl-mouse-1 to mouse-3.
700 **** Deal with Finder aliases somehow.
702 **** Ctrl-F2 won't pull up menus.
704 *** Other / Low Priority:
706 **** Better recognition of Unicode scripts / Greek / composition.
708 **** Undo for color-drag face customization.
710 ** Bidirectional editing
712 *** Support reordering structured text
713 Two important use cases: (1) comments and strings in program sources,
714 and (2) text with markup, like HTML or XML.
716 One idea is to invent a special text property that would instruct the
717 display engine to reorder only the parts of buffer text covered by
718 that property.  The display engine will then push its state onto the
719 iterator stack, restrict the bidi iterator to accessing only the
720 portion of buffer text covered by the property, reorder the text, then
721 pop its state from stack and continue as usual.  This will require
722 minor changes in the bidi_it structure.
724 This design requires Lisp-level code to put the text properties on the
725 relevant parts of the buffer text.  That could be done using JIT
726 fontifications, or as a preliminary processing when the file is
727 visited.  With HTML/XML, the code that puts text properties needs to
728 pay attention to the bidi directives embedded in the HTML/XML stream.
730 *** Allow the user to control the direction of the UI
732 **** Introduce user option to control direction of mode line.
733 One problem is the header line, which is produced by the same routines
734 as the mode line.  While it makes sense to have the mode-line
735 direction controlled by a single global variable, header lines are
736 buffer-specific, so they need a separate treatment in this regard.
738 **** User options to control direction of menu bar and tool bar.
739 For the tool bar, it's relatively easy: set it.paragraph_embedding
740 in redisplay_tool_bar according to the user variable, and make
741 f->desired_tool_bar_string multibyte with STRING_SET_MULTIBYTE.  Some
742 minor changes will be needed to set the right_box_line_p and
743 left_box_line_p flags correctly for the R2L tool bar.
745 However, it makes no sense to display the tool bar right to left if
746 the menu bar cannot be displayed in the same direction.
748 R2L menu bar is tricky for the same reasons as the mode line.  In
749 addition, toolkit builds create their menu bars in toolkit-specific
750 parts of code, bypassing xdisp.c, so those parts need to be enhanced
751 with toolkit-specific code to display the menu bar right to left.
753 ** ImageMagick support
755 *** image-type-header-regexps priorities the jpeg loader over the
756 ImageMagick one.  This is not wrong, but how should a user go about
757 preferring the ImageMagick loader?  The user might like zooming etc in jpegs.
759 Try (setq image-type-header-regexps nil) for a quick hack to prefer
760 ImageMagick over the jpg loader.
762 *** For some reason it's unbearably slow to look at a page in a large
763 image bundle using the :index feature.  The ImageMagick "display"
764 command is also a bit slow, but nowhere near as slow as the Emacs
765 code.  It seems ImageMagick tries to unpack every page when loading the
766 bundle.  This feature is not the primary usecase in Emacs though.
768 ImageMagick 6.6.2-9 introduced a bugfix for single page djvu load.  It
769 is now much faster to use the :index feature, but still not very fast.
771 *** Try to cache the num pages calculation.  It can take a while to
772 calculate the number of pages, and if you need to do it for each page
773 view, page-flipping becomes uselessly slow.
775 *** Integrate with image-dired.
777 *** Integrate with docview.
779 *** Integrate with image-mode.
780 Some work has been done, e.g. M-x image-transform-fit-to-height will
781 fit the image to the height of the Emacs window.
783 *** Look for optimizations for handling images with low depth.
784 Currently the code seems to default to 24 bit RGB which is costly for
785 images with lower bit depth.
787 *** Decide what to do with some uncommitted imagemagick support
788 functions for image size etc.
790 ** nxml mode
792 *** High priority
794 **** Command to insert an element template, including all required
795 attributes and child elements.  When there's a choice of elements
796 possible, we could insert a comment, and put an overlay on that
797 comment that makes it behave like a button with a pop-up menu to
798 select the appropriate choice.
800 **** Command to tag a region.  With a schema should complete using legal
801 tags, but should work without a schema as well.
803 **** Provide a way to conveniently rename an element.  With a schema should
804 complete using legal tags, but should work without a schema as well.
806 *** Outlining
808 **** Implement C-c C-o C-q.
810 **** Install pre/post command hook for moving out of invisible section.
812 **** Put a modify hook on invisible sections that expands them.
814 **** Integrate dumb folding somehow.
816 **** An element should be able to be its own heading.
818 **** Optimize to avoid complete buffer scan on each command.
820 **** Make it work with HTML-style headings (i.e. level indicated by
821 name of heading element rather than depth of section nesting).
823 **** Recognize root element as a section provided it has a title, even
824 if it doesn't match section-element-name-regex.
826 **** Support for incremental search automatically making hidden text visible.
828 **** Allow title to be an attribute.
830 **** Command that says to recognize the tag at point as a section/heading.
832 **** Explore better ways to determine when an element is a section
833 or a heading.
835 **** rng-next-error needs to either ignore invisible portion or reveal it
836 (maybe use isearch oriented text properties).
838 **** Errors within hidden section should be highlighted by underlining the
839 ellipsis.
841 **** Make indirect buffers work.
843 **** How should nxml-refresh outline recover from non well-formed tags?
845 **** Hide tags in title elements?
847 **** Use overlays instead of text properties for holding outline state?
848 Necessary for indirect buffers to work?
850 **** Allow an outline to go in the speedbar.
852 **** Split up outlining manual section into subsections.
854 **** More detail in the manual about each outlining command.
856 **** More menu entries for hiding/showing?
858 **** Indication of many lines have been hidden?
860 *** Locating schemas
862 **** Should rng-validate-mode give the user an opportunity to specify a
863 schema if there is currently none? Or should it at least give a hint
864 to the user how to specify a non-vacuous schema?
866 **** Support for adding new schemas to schema-locating files.
867 Add documentElement and namespace elements.
869 **** C-c C-w should be able to report current type id.
871 **** Implement doctypePublicId.
873 **** Implement typeIdBase.
875 **** Implement typeIdProcessingInstruction.
877 **** Support xml:base.
879 **** Implement group.
881 **** Find preferred prefix from schema-locating files.  Get rid of
882 rng-preferred-prefix-alist.
884 **** Inserting document element with vacuous schema should complete using
885 document elements declared in schema locating files, and set schema
886 appropriately.
888 **** Add a ruleType attribute to the <include> element?
890 **** Allow processing instruction in prolog to contain the compact syntax
891 schema directly.
893 **** Use RDDL to locate a schema based on the namespace URI.
895 **** Should not prompt to add redundant association to schema locating file.
897 **** Command to reload current schema.
899 *** Schema-sensitive features
901 **** Should filter dynamic markup possibilities using schema validity, by
902 adding hook to nxml-mode.
904 **** Dynamic markup word should (at least optionally) be able to look in
905 other buffers that are using nxml-mode.
907 **** Should clicking on Invalid move to next error if already on an error?
909 **** Take advantage of a:documentation.  Needs change to schema format.
911 **** Provide feasible validation (as in Jing) toggle.
913 **** Save the validation state as a property on the error overlay to enable
914 more detailed diagnosis.
916 **** Provide an Error Summary buffer showing all the validation errors.
918 **** Pop-up menu.  What is useful?  Tag a region (should be grayed out if
919 the region is not balanced).  Suggestions based on error messages.
921 **** Have configurable list of namespace URIs so that we can provide
922 namespace URI completion on extension elements or with schema-less documents.
924 **** Allow validation to handle XInclude.
926 **** ID/IDREF support.
928 *** Completion
930 **** Make it work with icomplete.  Only use a function to complete when
931 some of the possible names have undeclared namespaces.
933 **** How should C-return in mixed text work?
935 **** When there's a vacuous schema, C-return after < will insert the end-tag.
936 Is this a bug or a feature?
938 **** After completing start-tag, ensure we don't get unhelpful message
939 from validation
941 **** Syntax table for completion.
943 **** Should complete start-tag name with a space if namespace attributes
944 are required.
946 **** When completing start-tag name with no prefix and it doesn't match
947 should try to infer namespace from local name.
949 **** Should completion pay attention to characters after point?  If so, how?
951 **** When completing start-tag name, add required atts if only one required
952 attribute.
954 **** When completing attribute name, add attribute value if only one value
955 is possible.
957 **** After attribute-value completion, insert space after close delimiter
958 if more attributes are required.
960 **** Complete on enumerated data values in elements.
962 **** When in context that allows only elements, should get tag
963 completion without having to type < first.
965 **** When immediately after start-tag name, and name is valid and not
966 prefix of any other name, should C-return complete on attribute names?
968 **** When completing attributes, more consistent to ignore all attributes
969 after point.
971 **** Inserting attribute value completions needs to be sensitive to what
972 delimiter is used so that it quotes the correct character.
974 **** Complete on encoding-names in XML decl.
976 **** Complete namespace declarations by searching for all namespaces
977 mentioned in the schema.
979 *** Well-formed XML support
981 **** Deal better with Mule-UCS
983 **** Deal with UTF-8 BOM when reading.
985 **** Complete entity names.
987 **** Provide some support for entity names for MathML.
989 **** Command to repeat the last tag.
991 **** Support for changing between character references and characters.
992 Need to check that context is one in which character references are
993 allowed.  xmltok prolog parsing will need to distinguish parameter
994 literals from other kinds of literal.
996 **** Provide a comment command to bind to M-; that works better than the
997 normal one.
999 **** Make indenting in a multi-line comment work.
1001 **** Structure view.  Separate buffer displaying element tree.
1002 Be able to navigate from structure view to document and vice-versa.
1004 **** Flash matching >.
1006 **** Smart selection command that selects increasingly large syntactically
1007 coherent chunks of XML.  If point is in an attribute value, first
1008 select complete value; then if command is repeated, select value plus
1009 delimiters, then select attribute name as well, then complete
1010 start-tag, then complete element, then enclosing element, etc.
1012 **** ispell integration.
1014 **** Block-level items in mixed content should be indented, e.g:
1015   <para>This is list:
1016     <ul>
1017       <li>item</li>
1019 **** Provide option to indent like this:
1020     <para>This is a paragraph
1021      occupying multiple lines.</para>
1023 **** Option to add make a / that closes a start-tag electrically insert a
1024 space for the XHTML guys.
1026 **** C-M-q should work.
1028 *** Datatypes
1030 **** Figure out workaround for CJK characters with regexps.
1032 **** Does category C contain Cn?
1034 **** Do ENTITY datatype properly.
1036 *** XML Parsing Library
1038 **** Parameter entity parsing option, nil (never), t (always),
1039 unless-standalone (unless standalone="yes" in XML declaration).
1041 **** When a file is currently being edited, there should be an option to
1042 use its buffer instead of the on-disk copy.
1044 *** Handling all XML features
1046 **** Provide better support for editing external general parsed entities.
1047 Perhaps provide a way to force ignoring undefined entities; maybe turn
1048 this on automatically with <?xml encoding=""?> (with no version
1049 pseudo-att).
1051 **** Handle internal general entity declarations containing elements.
1053 **** Handle external general entity declarations.
1055 **** Handle default attribute declarations in internal subset.
1057 **** Handle parameter entities (including DTD).
1059 *** RELAX NG
1061 **** Do complete schema checking, at least optionally.
1063 **** Detect include/external loops during schema parse.
1065 **** Coding system detection for schemas.  Should use utf-8/utf-16 per the
1066 spec.  But also need to allow encodings other than UTF-8/16 to support
1067 CJK charsets that Emacs cannot represent in Unicode.
1069 *** Catching XML errors
1071 **** Check public identifiers.
1073 **** Check default attribute values.
1075 *** Performance
1077 **** Explore whether overlay-recenter can cure overlays performance problems.
1079 **** Cache schemas.  Need to have list of files and mtimes.
1081 **** Make it possible to reduce rng-validate-chunk-size significantly,
1082 perhaps to 500 bytes, without bad performance impact: don't do
1083 redisplay on every chunk; pass continue functions on other uses of
1084 rng-do-some-validation.
1086 **** Cache after first tag.
1088 **** Introduce a new name class that is a choice between names (so that
1089 we can use member)
1091 **** intern-choice should simplify after patterns with same 1st/2nd args
1093 **** Large numbers of overlays slow things down dramatically.  Represent
1094 errors using text properties.  This implies we cannot incrementally
1095 keep track of the number of errors, in order to determine validity.
1096 Instead, when validation completes, scan for any characters with an
1097 error text property; this seems to be fast enough even with large
1098 buffers.  Problem with error at end of buffer, where there's no
1099 character; need special variable for this.  Need to merge face from
1100 font-lock with the error face: use :inherit attribute with list of two
1101 faces.  How do we avoid making rng-valid depend on nxml-mode?
1103 *** Error recovery
1105 **** Don't stop at newline in looking for close of start-tag.
1107 **** Use indentation to guide recovery from mismatched end-tags
1109 **** Don't keep parsing when currently not well-formed but previously
1110 well-formed
1112 **** Try to recover from a bad start-tag by popping an open element if
1113 there was a mismatched end-tag unaccounted for.
1115 **** Try to recover from a bad start-tag open on the hypothesis that there
1116 was an error in the namespace URI.
1118 **** Better recovery from ill-formed XML declarations.
1120 *** Usability improvements
1122 **** Should print a "Parsing..." message during long movements.
1124 **** Provide better position for reference to undefined pattern error.
1126 **** Put Well-formed in the mode-line when validating against any-content.
1128 **** Trim marking of illegal data for leading and trailing whitespace.
1130 **** Show Invalid status as soon as we are sure it's invalid, rather than
1131 waiting for everything to be completely up to date.
1133 **** When narrowed, Valid or Invalid status should probably consider only
1134 validity of narrowed region.
1136 *** Bug fixes
1138 **** Need to give an error for a document like: <foo/><![CDATA[  ]]>
1140 **** Make nxml-forward-balanced-item work better for the prolog.
1142 **** Make filling and indenting comments work in the prolog.
1144 **** Should delete RNC Input buffers.
1146 **** Figure out what regex use for NCName and use it consistently,
1148 **** Should have not-well-formed tokens in ref.
1150 **** Require version in XML declaration? Probably not because prevents
1151 use for external parsed entities.  At least forbid standalone without version.
1153 **** Reject schema that compiles to rng-not-allowed-ipattern.
1155 **** Move point backwards on schema parse error so that it's on the right token.
1157 *** Internal
1159 **** Use rng-quote-string consistently.
1161 **** Use parsing library for XML to texinfo conversion.
1163 **** Rename xmltok.el to nxml-token.el.  Use nxml-t- prefix instead of
1164 xmltok-.  Change nxml-t-type to nxml-t-token-type, nxml-t-start to
1165 nxml-t-token-start.
1167 **** Can we set fill-prefix to nil and rely on indenting?
1169 **** xmltok should make available replacement text of entities containing
1170 elements
1172 **** In rng-valid, instead of using modification-hooks and
1173 insert-behind-hooks on dependent overlays, use same technique as nxml-mode.
1175 **** Port to XEmacs.  Issues include: Unicode (XEmacs seems to be based on
1176 Mule-UCS); overlays/text properties vs extents; absence of
1177 fontification-functions hook.
1179 *** Fontification
1181 **** Allow face to depend on element qname, attribute qname, attribute
1182 value.  Use list with pairs of (R . F), where R specifies regexps and
1183 F specifies faces.  How can this list be made to depend on the document type?
1185 *** Other
1187 **** Support RELAX NG XML syntax (use XML parsing library).
1189 **** Support W3C XML Schema (use XML parsing library).
1191 **** Command to infer schema from current document (like trang).
1193 *** Schemas
1195 **** XSLT schema should take advantage of RELAX NG to express cooccurrence
1196 constraints on attributes (e.g. xsl:template).
1198 *** Documentation
1200 **** Move material from README to manual.
1202 **** Document encodings.
1204 *** Notes
1206 **** How can we allow an error to be displayed on a different token from
1207 where it is detected?  In particular, for a missing closing ">" we
1208 will need to display it at the beginning of the following token.  At the
1209 moment, when we parse the following token the error overlay will get cleared.
1211 **** How should rng-goto-next-error deal with narrowing?
1213 **** Perhaps should merge errors having same start position even if they
1214 have different ends.
1216 **** How to handle surrogates? One possibility is to be compatible with
1217 utf8.e: represent as sequence of 4 chars.  But utf-16 is incompatible
1218 with this.
1220 **** Should we distinguish well-formedness errors from invalidity errors?
1221 (I think not: we may want to recover from a bad start-tag by implying
1222 an end-tag.)
1224 **** Seems to be a bug with Emacs, where a mouse movement that causes
1225 help-echo text to appear counts as pending input but does not cause
1226 idle timer to be restarted.
1228 **** Use XML to represent this file.
1230 **** I had a TODO which said simply "split-string".  What did I mean?
1232 **** Investigate performance on large files all on one line.
1234 *** Issues for Emacs versions >= 22
1236 **** Take advantage of UTF-8 CJK support.
1238 **** Supply a next-error-function.
1240 **** Investigate this NEWS item "Emacs now tries to set up buffer coding
1241 systems for HTML/XML files automatically."
1243 **** Take advantage of the pointer text property.
1245 **** Leverage char-displayable-p.
1247 * Internal changes
1249 ** Cleanup all the GC_ mark bit stuff -- there is no longer any distinction
1250    since the mark bit is no longer stored in the Lisp_Object itself.
1252 ** Refine the 'predicate' arg to read-file-name.
1253    Currently, it mixes up the predicate to apply when doing completion and the
1254    one to use when terminating the selection.
1256 ** Merge ibuffer.el and buff-menu.el.
1257    More specifically do what's needed to make ibuffer.el the default,
1258    or just an extension of buff-menu.el.
1260 ** Replace linum.el with nlinum.el
1263 ** Merge sendmail.el and messages.el.
1264    Probably not a complete merge, but at least arrange for messages.el to be
1265    a derived mode of sendmail.el.  Or arrange for messages.el to be split
1266    into a small core and "the rest" so that we use less resources as long as
1267    we stick to the features provided in sendmail.el.
1269 ** Replace gmalloc.c with the modified Doug Lea code from the current
1270    GNU libc so that the special mmapping of buffers can be removed --
1271    that apparently loses under Solaris, at least. [fx has mostly done
1272    this.]
1274 ** Rewrite make-docfile to be clean and maintainable.
1275    It might be better to replace it with Lisp, using the byte compiler.
1278 ** Add an inferior-comint-minor-mode to capture the common set of operations
1279    offered by major modes that offer an associated inferior
1280    comint-derived mode.  I.e. basically make cmuscheme.el/inf-lisp.el generic.
1281    For use by sml-mode, python-mode, tex-mode, scheme-mode, lisp-mode,
1282    haskell-mode, tuareg-mode, ...
1284 ** Add "link" button class
1285    Add a standard button-class named "link", and make all other link-like
1286    button classes inherit from it.  Set the default face of the "link" button
1287    class to the standard "link" face.
1289 * Wishlist items:
1291 ** Maybe replace etags.c with a Lisp implementation.
1294 ** Maybe replace lib-src/rcs2log with a Lisp implementation.
1295 It wouldn't have to be a complete replacement, just enough
1296 for vc-rcs-update-changelog.
1298 * Other known bugs:
1300 ** 'make-frame' forgets unhandled parameters, at least for X11 frames.
1302 ** a two-char comment-starter whose two chars are symbol constituents will
1303 not be noticed if it appears within a word.
1305 \f
1306 This file is part of GNU Emacs.
1308 GNU Emacs is free software: you can redistribute it and/or modify
1309 it under the terms of the GNU General Public License as published by
1310 the Free Software Foundation, either version 3 of the License, or
1311 (at your option) any later version.
1313 GNU Emacs is distributed in the hope that it will be useful,
1314 but WITHOUT ANY WARRANTY; without even the implied warranty of
1316 GNU General Public License for more details.
1318 You should have received a copy of the GNU General Public License
1319 along with GNU Emacs.  If not, see <>.