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