lilypond-1.1.5
[lilypond.git] / TODO
bloba94bbad6d9627b739d057d79052bd782fd11f250
1 Features you cannot find in the doco as working, should be mentioned here.
3 This is an assorted collection of stuff that will be done, might be
4 done, or is an idea that I want to think about
6 Most of the items are marked in the code as well, with full explanation. 
7 grep for TODO and ugh/ugr/urg
10 BUGS:
11         * latex bla.tex broken (titles / \lilyfooter stuff?)
13         * --safe:  disallow backslashes, disallow \include.
15         * fix rounding stuff in number->string
17         * msgfmt -o check?
19         * \breathmark TeX macro 
21         * configure error if GUILE 1.3 not found
23         * catch GUILE errors?
25         * add new glyphs to font.ly
27         * formatting of input stuff. 
29         * \notes{ a \< b \cr } vs \notes{ a \< b \! }
31         * if possible, it might be nice for a warning to appear if someone does
32         \translator with no name and without assigning it to an
33         identifier.  
35         * space after bars?
37         * [/3 c8 c16 c c c]/1
38   
39         * fix singleStaffBracket
40   
41         * repeat bars: need distance after ":|" and before "|:"
43         * The time signature warnings still remain, will be fixed later.
45         Summary of minor spelling irregularities:
46         -  capitalization/use of underscores in property names
48         * fix Score.skipBars
50         * repeat bars: need distance after ":|" and before "|:"
52         * \shape 1st dim skipped? 
54         * fix marks/barnumbers/marginal notes
56         * broken scripts:
57         lbheel = \script { "bheel" 0 0 -1  0 0 }
58         rbheel = \script { "bheel" 0 0 1 0 0 }
59         lbtoe = \script { "btoe" 0 0 -1 0 0 }
60         rbtoe = \script { "btoe" 0 0 1 0 0 }
61         lfheel = \script { "fheel" 0 0 -1  0 0 }
62         rfheel = \script { "fheel" 0 0 1 0 0 }
63         lftoe = \script { "ftoe" 0 0 -1 0 0 }
64         rftoe = \script { "ftoe" 0 0 1 0 0 }
65         
66         and also
67         
68         portato= \script { "portato" 0 -1 0 1 0 }
70         * Align_element::padding  ?
72         * uniformise property names.
74         * ydirection <-> yDirection
76         * typo checks on property names?
78         * make engraver hacking robust.
80         * use streambufs and iostream
81         to provide IO handling for TeX stream, mudela stream, data-file.
83         * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
85         * strip EXEs before installing
87         * zip target for binary windows dist (JBR)
89         * text continuations
91         * revise documentation
93         * abbrev -> tremolo
95         * junking \skip req in lyrics
97         * Language:
98         - \type -> \context ?
99         - \translator -> ?
100         - fix \partial 
101         - \bla {} vs \bla ; 
102         - mix engraver hacking with music ?
103         - \once\property  KEY = VAL
104         - \addtranslator, \removetranslator
105         - junk ^ and _ for scripts
106         - junk _ for lyrics.
107         - abstract grammar.
109         * install TeX stuff into tex/generic directory.
111         * percussion note heads
113         * mi2mu empty staffs.
115         * include MIDI list 
117         * midi_instrument -> midiInstrument
119         * horizontal centering of dynamics 
121         * \font\fontA=feta20.afm (.afm?)
123         * gzip RH manpage
125         * stable make/config stuff
127         * stemup/stemdown; see test/updown.fly
128           - check examples; add \type Staff hither and thether
130         * $DEPENDENCIES_OUTPUT support
132         * use a fake-yodl.sh to mimick yodl when yodl is not installed
134         * fix BUGs
136         * fix weird behaviour when .AFMs not found.
138         * Xdvi zooming ?!
139                 gs: Error: /undefined in draw_beam
140                 gs: Operand stack:
142         * run texhash after installing .tex
144         * fix vertical alignment and stafflines
146         * GrandStaff needs more work -- I want a single word
147         `harpsichord' to the left of the grandstaff, not one on each
148         stave.  (Organ staff -- with separate pedal -- but common
149         properties may be something to think about.  Of course for
150         organ you want to be able to give stop indications on the way
151         through, so the \property Voice.Instrument would be a stop,
152         and \property GrandStaff.instrument would be PipeOrgan...)
154         * make Tie_req a "command" { <c g> ~ <c g> }
156         * bib ep1988
158         * revise the Score_priority_align_engraver concept.  It sucks. 
160         * ly2xdvi, ly2ps
162         * make new VoiceOne, VoiceTwo, VoiceThree contexts with
163 ydirection and hshift preset
165         * *.yo: fix pod manpage layout legacy
167         * text-items clash with stems/beams
169         * --include, -I option for ly2dvi (pass on to lily)
171         * fix placement of beam-less abbrev
173         * \meter 3/4;
174         <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
175          {\voicetwo cis,4 r r | r2. | r1 }> |
176         }
178         * try to use template<Type> iso MACRO(Type)
180         - NEWS: ... Musical_pitch (analogous to Duration and Rhythmic_req)
181           think about, analogous to pitch: 
182            * { a4 a16 } c <-- duration of c?
183            * <a4 b8> c <-- duration of c?
185         * \tempo 4. = 90;
187         * fix audio-items (don't use (input) requests, but copy data)
189         * junk My_lily_parser::abbrev_beam_type_i_ 
191         * make sure all ex's have a mudela-version
193         * do rest-collisions for Multi_measure_rests as well.
195         * split error/warning in error/warning/non_fatal_error
197         * add a Duration_convert member to Duration_iter to set parameters.
198         Junk global duration settings. 
200         * deps for ly2dvi
202         * clean up abbrev/plet/beam/abbrevbeam/duration mess in parser.
204         * minimum length second part broken tie
206         * en-,discouraged linebreaking: 
207           - handle DISALLOW < penalty > FORCE
208           - discourage breaking of slurs
210         * multibar rest
211           - symbol(s)
213         * fix variable define/lookup parser global<->paper
215         * fix title/instrument placements; see input/test/title.ly
217         * <\voiceone c4. \voicetwo c4>
219         * add full cello suites to web site (kom op, Maarten!)
221         * Rethink Time_description
222           * \cadenza , \meter, \grouping should all be \properties
224         * rename
225           - plet -> tuplet
226           - measure -> bar
227           - abbreviation-beam -> (measured/unmeasured) tremolo
228           - partial -> anacrouse
230         * shared lib
232         * robustify Beam (in case of no stems, 32nd notes)
234         * decentralised spring factory
236         * move paper vars into engraver properties
238         * check for groff / troff/ nroff et
240         * more intelligent file searching
241         - make LilyPond RPM fully relocatable
243         * nicen examples:
244         - break-up heavily-nested score blocks
246         * disable spaces in TeX stuff
247         
248         * handle ^C for tmp/file creation.
250         * dots & rest collisions.
252         * documentation
253         - introduction?
254         - info?
255         - LaTeX?
256         - more manpages?
258         * versioning for Feta
260         * the warning about the negative slur/tie length appears twice
261         which is irritating.
263         * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
264         in the middle:
266         * the bracket is ugly (wings are too parabolic, should be more circular)
268         * better hshift (dots, distance, head dependent)
270         * clefs (AG): The "8" should appear closer to the actual clef,
271           touching it.
273         * put errorlevel in Input class
275         * junk nesting slurs
277         * integrate midi-elts from mi2mu and lily?
279         * score-bar-scripts
280         FMR: Free memory read:
281           * This is occurring while in:
282                 Bar_column::do_substitute_dependency(Score_element*,Score_element*) [bar
283         -column.cc:29]
284                 Score_element::unlink() [score-elem.cc:383]
285                 Paper_score::set_breaking(const Array<Column_x_positions>&) [p-score.cc:
286         150]
287                 Paper_score::calc_breaking() [p-score.cc:189]
288                 Paper_score::process() [p-score.cc:203]
289                 Score::run_translator(Music_output_def*) [score.cc:117]
290           * Reading 4 bytes from 0x65d3a0 in the heap.
291           * Address 0x65d3a0 is 160 bytes into a freed  block at 0x65d300 of 208 bytes.
292           * This block was allocated from:
293                 malloc         [rtlib.o]
294                 __builtin_new  [libgcc.a]
295                 Span_score_bar::clone()const [span-score-bar.hh:20]
296                 Item::copy_breakable_items() [item.cc:69]
297                 Item::do_breakable_col_processing() [item.cc:89]
298                 Score_element::calcalute_dependencies(int,int,void(Score_element::*)()*)
299          [score-elem.cc:171]
300           * There have been 22 frees since this block was freed from:
301                 free           [rtlib.o]
302                 __builtin_delete [libgcc.a]
303                 Span_score_bar::~Span_score_bar() [span-score-bar.hh:18]
304                 Paper_score::set_breaking(const Array<Column_x_positions>&) [p-score.cc:
305         156]
306                 Paper_score::calc_breaking() [p-score.cc:189]
307                 Paper_score::process() [p-score.cc:203]
308         Postprocessing elements... 
309         TeX output to score-bar-scripts.tex...
312 3RD PARTY BUGS:
314         * redhat (v?) graphical install bomb-out?
316         * GNU diff 2.7: diff -rN does not see a new directory with empty file
318         * GNU patch 2.1: <must find simple example> if patch chokes on a
319           hunk, or on allegedly unsorted hunks in a diff, it may stop 
320           without a trace of failure (create .rej file, print error or 
321           dump core) and just ignore any further diffs.
323         * glibc 2.0:
325           f = fopen ("/dev/null", "r")
326           assert (feof (f))
328 3RD PARTY PROJECTS:
330         * GNU indent: handle C++
332         * GNU patch 
333           - 'double-fix' mode: ignore identical fix, rather than suggest 
334             to revert patch direction when (more or less? exactly) the same 
335             thing is fixed
337 PROJECTS
339         * Scripts:
340         - fix position of bar number
341         - stack scripts in chords:
342           % fingering:        footing:
343             < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
344         - script-spacing
345         - slur parts as a script
346         - stack parameterised scripts for fingering and footing:
348         * convert-mudela:
349         - automatically add  a \version if not present.
350         - better parsing
351         - make smarter
352         - convert-mudela -e empty.ly
354         * emacs mudela-mode
355         -  should handle block comments too.
356         -  handle lexer modes (\header, \melodic, \lyric) etc.
357         -  indentation
358         -  notenames?
359         -  fontlock: \melodic \melodic
361         * use properties for:
362         - plet?
363         - Staff_sym size
364         - default tempo.
365         - font size
366         - bartypes (get rid of derived Span_bar_engravers)
367         - cadenza mode? 
369         * page handling:
370         - PS output
371         - optimal pagebreaking.
373         * Unicode support? -> man 7 unicode
374         - 16 bit Strings
375         - -u switch
376         - detect of 16/8 bit files
377         - examples to go with it.
379         * Spring_spacer:
380         - write a faster Spring_spacer (without matrices if possible)
381         - relate energybound to linelen unitspace fontsize etc.
382         - used fixed point fp?
384         * \header
385         - output header info to MIDI too.
387         * a musical dictionary. See Documentation/vocabulary-*, other
388         languages:
389         - explanations
390         - italian
391         - german
392         - dutch
393         - swedish
394          .. ?
396         * chords
397         - guitar chords
398         - chord names
399         - basso continuo
400         - Syntax/parser
401         - MIDI output?
402         - typesetting
404         * Debug logs:
405         - derive lily_stream, Dstream, texstream from ostream?
406         - indentable stream as baseclass for TeX stream, lily stream, Dstream.
407         - use dstream feature in mi2mu
408         - integrate IO checking into stream class
410         * input converters
411         - NIFF?
412         - ABC? 
413         - SMDL?
415         * add to MIDI output:
416         - tempo change
417         - ornaments (and trills?)
418         - repeat
419         - slurs
420         - accents
421         - dynamics
422         - account for rhythmic position in measure
423         - etc.
425         * grace notes
426         - make separate class for Grace_*_engravers 
427         (which is at Voice_gravs level)
428         - make encapsulated spacing problems.
430         * accidentals per Voice_group
432         * Output class, handles : (smallish)
433         - help text /(c) notice?
434         - version line
435         - warning /errors/progress
436         - abort on error/warning; exit status
437         - quiet/ignore-version options
438         - logfile output
440         * piano staff
442         * elaborate Staff_side baseclass:
443         - scripts
444         - text
445         - slur start/end
447         * PS 
448         - speed up PS code.
449         - PS lines to .eps files
450         - write custom prolog
453         * Output an output format independent (ofi) typeset file; and 
454           make ofi2 TeX, MusiXTex, Display PostScript, PostScript,
455           Ascii... interpreters. (difficult)
457         - NIFF ?
458         - Common Music Notation
459         - PostScript output (esp. Beams, Slurs, etc)
460         - Move all Score_elems, into libmutype.a
461         - SGML
463         * Documentation
464         - Doc (C) stuff of sheet music
465         - a better format?  SGML?  TeX?  Info?
466         - a better tutorial
468         * more spanners (smallish)
469         - Glissando
470         - trill
472         * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
473         - [c8. c32 c32]
474         - doc on Rhythmic_grouping
475         - general shaving on Beam and Stem
476         - use plet grouping
477         - separate visual from rhythmic info even more
478         - beams over bars
479         - endbeam req should be *after* the duration, so you can do
480         < { [c4]    }
481           { c8. c16 } >
484         * lines:
485         - Ledger lines, should be separate item: Ledger_lines, Ledger_lines
486         - set different line sizes / thicknesses
487         - beam stem showthrough, inter beam sizes (french vs german style)
489         * Collisions
490         - left/right note balls should be handled by Collision:
491         < \multi 2; { \stem 1; <b c> } { <f as b> } >
493         * Keys:
494         - merge key{item} & localkey{item}?
495         - spacing, national styles?
497         * Support for TAB
498         - redo Notehead to allow digits as heads
499         - add a \tablature {} lexer mode for easy entering
501         * should adjust stemlength for flag number.
503         * breaking:
504         - caching breakpoints
505         - saving them
506         - specify number of lines
508         * markers
510 INPUTLANGUAGE
512         * c4 4 4 4 for c4 c4 c4 c4?
514         * neatly (and readably) expressing concurrent
515         voices
517         * <c f a>4 ?
519         * Viola mode?
521                 @c c g e g 
522         for
523                 c g es g, 
525                 @A c g e g
526         for
527                 cis gis e gis
529         * relative mode for pitch entering
531         * bracket: volta 1,2
533         * configure pitch_byte
535         * rest name configurable
537 SMALLISH PROJECTS
539         * limit memory usage; the full coriolan takes up too much resources.
541         * fix confusing naming in Engraver vs Engraver_group_engraver (context)
543         * progress when creating MIDI elts.
545         * A range for context errors (eg. mark both { and }. )
547         * lyric in staff  (sharpsharp in staff, text below)
549         * half sharps/flats
551         * write Dynamic_line (to group dynamics horizontally)
553         * use Real for all y positions.
554         - use translate_axis( .. ,Y_AXIS)  iso separate variables.
556         * half-sharps, half-flats
558         * adaptive accidental spacing.
560         * handle EOF graciously in error messages.
562         * centered whole rest
564         * declare notenametab?
566         * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
568         * Flower types:
569         - A decent scalar type
570         - String hash
571         - Pointer hash
573         * binsearch/hash for identifiers
575         * stafftypes: voice names/ instrument names.
577         * lily \tempo
579         * C meter iso 4/4, idem for alla breve, etc.
581         * textspanner: center position
583         *   % toe to bheel   four to five
584             %   ^_u            4_5  
585             %     -                           
586             %  --|x--         --|x--
587             %  --|---         --|---
588             %  --|---         --|---
589           (where "to" is a tiny bow)
591         * auxilliary file for caching info.
593         * Text_crescendo
595         * clean solution for staffsize in items.
597         * revise calcideal
599         * volta
601 IDEAS
604         * Output data structures of Mudela in XML/SGML.
606         * create libmudela, or liblily_frontend
608         * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
610         * use an embedded language: Python, Scheme
611         for: 
612                 - Score_elems
613                 - Translators
615         * y -dims in internote? Staff-space? X-dimensions?
617         * Spacing_request for manually adjusting spacing
619         * caching breakpoints
621         * breath marks 
623         * used fixedpoint arithmetic for min. energy.
625         * move towards incremental algorithms.
627         * far fetched language ideas
628         - design meta-language like TeX and Metafont
629         - programming/macros input
631         * versioning stuff (cvt mudela, mudela, etc.)
633         * Klavarskribo?
635         * lyrics in chords still fuck up.
637         * Use hooks/dependency graphs for properties