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