release: 1.1.0

[lilypond.git] / TODO

diff --git a/TODO b/TODO
index b38448220b9a332b20937e0db6ad5160eae9665a..e22c3f60e80d26e2dcf43a80a9b9b7a086bf6663 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,99 +1,387 @@
 Features you cannot find in the doco as working, should be mentioned here.
 Features you cannot find in the doco as working, should be mentioned here.

-       
+
+

 This is an assorted collection of stuff that will be done, might be
 done, or is an idea that I want to think about
 
 Most of the items are marked in the code as well, with full explanation. 
 This is an assorted collection of stuff that will be done, might be
 done, or is an idea that I want to think about
 
 Most of the items are marked in the code as well, with full explanation. 

-grep for TODO and ugh/ugr
+grep for TODO and ugh/ugr/urg

 
 

-0.2:
-       * add a screenshot to the website.

 
 

-       * fix stdin input
+BUGS:

 
 

-       * LILYSOURCEDIR

        
        

-       * documentation
+       * add new glyphs to font.ly

 
 

-       * spurious "Junk beam" warnings
+       * formatting of input stuff. 

 
 

-       * standchen: warning: Excentric column (Meter dims?)
+       * \notes{ a \< b \cr } vs \notes{ a \< b \! }

 
 

-       * naming Mozarella, Madeira, Muella?
+       * if possible, it might be nice for a warning to appear if someone does
+       \translator with no name and without assigning it to an
+       identifier.  

 
 

-       * versioning for Feta
+       * space after bars?
+
+       * [/3 c8 c16 c c c]/1
+  
+       * fix singleStaffBracket
+  
+       * repeat bars: need distance after ":|" and before "|:"
+
+       * The time signature warnings still remain, will be fixed later.
+
+       Summary of minor spelling irregularities:
+       -  capitalization/use of underscores in property names
+
+       * fix Score.skipBars
+
+       * repeat bars: need distance after ":|" and before "|:"
+
+       * \shape 1st dim skipped? 
+
+       * fix marks/barnumbers/marginal notes
+
+       * broken scripts:
+       lbheel = \script { "bheel" 0 0 -1  0 0 }
+       rbheel = \script { "bheel" 0 0 1 0 0 }
+       lbtoe = \script { "btoe" 0 0 -1 0 0 }
+       rbtoe = \script { "btoe" 0 0 1 0 0 }
+       lfheel = \script { "fheel" 0 0 -1  0 0 }
+       rfheel = \script { "fheel" 0 0 1 0 0 }
+       lftoe = \script { "ftoe" 0 0 -1 0 0 }
+       rftoe = \script { "ftoe" 0 0 1 0 0 }
+       
+       and also
+       
+       portato= \script { "portato" 0 -1 0 1 0 }
+
+       * Align_element::padding  ?
+
+       * uniformise property names.
+
+       * ydirection <-> yDirection
+
+       * typo checks on property names?
+
+       * make engraver hacking robust.
+
+       * use streambufs and iostream
+       to provide IO handling for TeX stream, mudela stream, data-file.
+
+       * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
+
+       * strip EXEs before installing
+
+       * zip target for binary windows dist (JBR)
+
+       * text continuations
+
+       * revise documentation
+
+       * abbrev -> tremolo
+
+       * junking \skip req in lyrics
+
+       * Language:
+       - \type -> \context ?
+       - \translator -> ?
+       - fix \partial 
+       - \bla {} vs \bla ; 
+       - mix engraver hacking with music ?
+       - \once\property  KEY = VAL
+       - \addtranslator, \removetranslator
+       - junk ^ and _ for scripts
+       - junk _ for lyrics.
+       - abstract grammar.
+
+       * install TeX stuff into tex/generic directory.
+
+       * percussion note heads
+
+       * mi2mu empty staffs.
+
+       * include MIDI list 
+
+       * make GNU style webpages.
+
+       * midi_instrument -> midiInstrument
+
+       * horizontal centering of dynamics 
+
+       * \font\fontA=feta20.afm (.afm?)
+
+       * gzip RH manpage
+
+       * stable make/config stuff
+
+       * stemup/stemdown; see test/updown.fly
+         - check examples; add \type Staff hither and thether
+
+       * $DEPENDENCIES_OUTPUT support
+
+       * use a fake-yodl.sh to mimick yodl when yodl is not installed
+
+       * fix BUGs
+
+       * fix weird behaviour when .AFMs not found.

 
 

-       * bf: abbrevs over whole note
+       * Xdvi zooming ?!
+               gs: Error: /undefined in draw_beam
+               gs: Operand stack:

 
 

-STUFF
+       * run texhash after installing .tex

 
 

-       * give Items/Spanners access to unbroken originals      
+       * fix vertical alignment and stafflines

 
 

-       * scoping for properties
+       * GrandStaff needs more work -- I want a single word
+       `harpsichord' to the left of the grandstaff, not one on each
+       stave.  (Organ staff -- with separate pedal -- but common
+       properties may be something to think about.  Of course for
+       organ you want to be able to give stop indications on the way
+       through, so the \property Voice.Instrument would be a stop,
+       and \property GrandStaff.instrument would be PipeOrgan...)

 
 

-       {       c4
-               \multi 2  < { \stemup .. } { \stemdown .. } >
-               c2 
+       * make Tie_req a "command" { <c g> ~ <c g> }
+
+       * bib ep1988
+
+       * revise the Score_priority_align_engraver concept.  It sucks. 
+
+       * ly2xdvi, ly2ps
+
+       * make new VoiceOne, VoiceTwo, VoiceThree contexts with
+ydirection and hshift preset
+
+       * *.yo: fix pod manpage layout legacy
+
+       * text-items clash with stems/beams
+
+       * --include, -I option for ly2dvi (pass on to lily)
+
+       * fix placement of beam-less abbrev
+
+       * \meter 3/4;
+       <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
+        {\voicetwo cis,4 r r | r2. | r1 }> |

        }
 
        }
 

-       this modifies \stem for the c2
+       * try to use template<Type> iso MACRO(Type)

 
 

-       * use properties for:
-       - Text_style
-       - default_octave
-       - plet?
-       - default_duration?
-       - default abbreviation
-       - Staff_sym size
-       - default tempo.
-       - font size
-       - bartypes (get rid of derived Span_bar_engravers)
-       - cadenza mode? 
-       - MIDI instrument
-       - staff title
+       - NEWS: ... Musical_pitch (analogous to Duration and Rhythmic_req)
+         think about, analogous to pitch: 
+          * { a4 a16 } c <-- duration of c?
+          * <a4 b8> c <-- duration of c?
+
+       * \tempo 4. = 90;
+
+       * fix audio-items (don't use (input) requests, but copy data)
+
+       * junk My_lily_parser::abbrev_beam_type_i_ 
+
+       * make sure all ex's have a mudela-version
+
+       * do rest-collisions for Multi_measure_rests as well.
+
+       * split error/warning in error/warning/non_fatal_error
+
+       * add a Duration_convert member to Duration_iter to set parameters.
+       Junk global duration settings. 
+ 
+       * deps for ly2dvi
+
+       * clean up abbrev/plet/beam/abbrevbeam/duration mess in parser.
+
+       * minimum length second part broken tie
+ 
+       * en-,discouraged linebreaking: 
+         - handle DISALLOW < penalty > FORCE
+         - discourage breaking of slurs
+
+       * multibar rest
+         - symbol(s)
+
+       * fix variable define/lookup parser global<->paper
+
+       * fix title/instrument placements; see input/test/title.ly
+
+       * <\voiceone c4. \voicetwo c4>
+
+       * add full cello suites to web site (kom op, Maarten!)
+
+       * Rethink Time_description
+         * \cadenza , \meter, \grouping should all be \properties
+
+       * rename
+         - plet -> tuplet
+         - measure -> bar
+         - abbreviation-beam -> (measured/unmeasured) tremolo
+         - partial -> anacrouse
+
+       * shared lib
+
+       * robustify Beam (in case of no stems, 32nd notes)
+
+       * decentralised spring factory
+
+       * move paper vars into engraver properties
+
+       * check for groff / troff/ nroff et
+
+       * more intelligent file searching
+       - make LilyPond RPM fully relocatable
+
+       * nicen examples:
+       - break-up heavily-nested score blocks
+
+       * disable spaces in TeX stuff
+       
+       * handle ^C for tmp/file creation.

 
 

-       * optimal pagebreaking.
+       * dots & rest collisions.
+
+       * documentation
+       - introduction?
+       - info?
+       - LaTeX?
+       - more manpages?
+
+       * versioning for Feta
+
+       * the warning about the negative slur/tie length appears twice
+       which is irritating.
+
+       * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
+       in the middle:
+
+       * the bracket is ugly (wings are too parabolic, should be more circular)
+
+       * better hshift (dots, distance, head dependent)
+
+        * clefs (AG): The "8" should appear closer to the actual clef,
+          touching it.

 
        * put errorlevel in Input class
 
 
        * put errorlevel in Input class
 

-       * AFM for font input?
+       * junk nesting slurs
+
+       * integrate midi-elts from mi2mu and lily?
+
+       * cautionary accidental
+
+       * score-bar-scripts
+       FMR: Free memory read:
+         * This is occurring while in:
+               Bar_column::do_substitute_dependency(Score_element*,Score_element*) [bar
+       -column.cc:29]
+               Score_element::unlink() [score-elem.cc:383]
+               Paper_score::set_breaking(const Array<Column_x_positions>&) [p-score.cc:
+       150]
+               Paper_score::calc_breaking() [p-score.cc:189]
+               Paper_score::process() [p-score.cc:203]
+               Score::run_translator(Music_output_def*) [score.cc:117]
+         * Reading 4 bytes from 0x65d3a0 in the heap.
+         * Address 0x65d3a0 is 160 bytes into a freed  block at 0x65d300 of 208 bytes.
+         * This block was allocated from:
+               malloc         [rtlib.o]
+               __builtin_new  [libgcc.a]
+               Span_score_bar::clone()const [span-score-bar.hh:20]
+               Item::copy_breakable_items() [item.cc:69]
+               Item::do_breakable_col_processing() [item.cc:89]
+               Score_element::calcalute_dependencies(int,int,void(Score_element::*)()*)
+        [score-elem.cc:171]
+         * There have been 22 frees since this block was freed from:
+               free           [rtlib.o]
+               __builtin_delete [libgcc.a]
+               Span_score_bar::~Span_score_bar() [span-score-bar.hh:18]
+               Paper_score::set_breaking(const Array<Column_x_positions>&) [p-score.cc:
+       156]
+               Paper_score::calc_breaking() [p-score.cc:189]
+               Paper_score::process() [p-score.cc:203]
+       Postprocessing elements... 
+       TeX output to score-bar-scripts.tex...
+

 
 3RD PARTY BUGS:
 
 
 3RD PARTY BUGS:
 

-       * Rational infty(HUGE_VAL) on glibc / w32
+       * redhat (v?) graphical install bomb-out?
+
+       * GNU diff 2.7: diff -rN does not see a new directory with empty file
+
+       * GNU patch 2.1: <must find simple example> if patch chokes on a
+         hunk, or on allegedly unsorted hunks in a diff, it may stop 
+         without a trace of failure (create .rej file, print error or 
+         dump core) and just ignore any further diffs.
+
+       * glibc 2.0:
+
+         f = fopen ("/dev/null", "r")
+         assert (feof (f))

 
 

-       * Fix profiling. gprof bugreport?
+3RD PARTY PROJECTS:
+
+       * GNU indent: handle C++
+
+       * GNU patch 
+         - 'double-fix' mode: ignore identical fix, rather than suggest 
+           to revert patch direction when (more or less? exactly) the same 
+           thing is fixed

 
 PROJECTS
 
 
 PROJECTS
 

-       * Unicode support?
+       * Scripts:
+       - fix position of bar number
+       - stack scripts in chords:
+         % fingering:        footing:
+           < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
+       - script-spacing
+       - slur parts as a script
+       - stack parameterised scripts for fingering and footing:
+
+       * convert-mudela:
+       - automatically add  a \version if not present.
+       - better parsing
+       - make smarter
+       - convert-mudela -e empty.ly
+
+       * emacs mudela-mode
+       -  should handle block comments too.
+       -  handle lexer modes (\header, \melodic, \lyric) etc.
+       -  indentation
+       -  notenames?
+       -  fontlock: \melodic \melodic
+ 
+
+       * use properties for:
+       - plet?
+       - Staff_sym size
+       - default tempo.
+       - font size
+       - bartypes (get rid of derived Span_bar_engravers)
+       - cadenza mode? 
+
+       * page handling:
+       - PS output
+       - optimal pagebreaking.
+
+       * Unicode support? -> man 7 unicode

        - 16 bit Strings
        - -u switch
        - 16 bit Strings
        - -u switch

-               - detect of 16/8 bit files
+       - detect of 16/8 bit files

        - examples to go with it.
 
        * Spring_spacer:
        - write a faster Spring_spacer (without matrices if possible)
        - examples to go with it.
 
        * Spring_spacer:
        - write a faster Spring_spacer (without matrices if possible)

-       - use straight QP to find minimal "fitting force"
+       - use straight LP to find minimal "fitting force"

        - relate energybound to linelen unitspace fontsize etc.
        - used fixed point fp
 
        * \header
        - relate energybound to linelen unitspace fontsize etc.
        - used fixed point fp
 
        * \header

-       - write perl script for handling it into databases
-       - write TeX macros to generate titles
-       - adapt make-website to use \header info.
-
-       * Makefile stuff:
-       - Use Automake
-       - shared lib on Solaris too.
-       - check libtool
-       - generate stuff in out/default, out/sun5-irix etc iso out/ 
-       and out-sun5/
-
-       * Add mudela-output to Rosegarden.
+       - output header info to MIDI too.

 
        * a musical dictionary. See Documentation/vocabulary-*, other
 
        * a musical dictionary. See Documentation/vocabulary-*, other

-languages:
+       languages:
+       - explanations

        - italian
        - german
        - dutch
        - italian
        - german
        - dutch


@@ -108,8 +396,6 @@ languages:
        - MIDI output?
        - typesetting
 
        - MIDI output?
        - typesetting
 

-       * integrate midi-elts from mi2mu and lily?
-

        * Debug logs:
        - derive lily_stream, Dstream, texstream from ostream?
        - indentable stream as baseclass for TeX stream, lily stream, Dstream.
        * Debug logs:
        - derive lily_stream, Dstream, texstream from ostream?
        - indentable stream as baseclass for TeX stream, lily stream, Dstream.


@@ -123,21 +409,21 @@ languages:
 
        * add to MIDI output:
        - tempo change
 
        * add to MIDI output:
        - tempo change

+       - ornaments (and trills?)

        - repeat
        - slurs
        - repeat
        - slurs

-       - dynamics etc.
+       - accents
+       - dynamics
+       - account for rhythmic position in measure
+       - etc.

 
        * grace notes
        - make separate class for Grace_*_engravers 
        (which is at Voice_gravs level)
        - make encapsulated spacing problems.
 
 
        * grace notes
        - make separate class for Grace_*_engravers 
        (which is at Voice_gravs level)
        - make encapsulated spacing problems.
 

-       * On-demand loading of simple-engravers?
-

        * accidentals per Voice_group
 
        * accidentals per Voice_group
 

-       * Convert all ref/bib stuff into BibTeX.
-

        * Output class, handles : (smallish)
        - help text /(c) notice?
        - version line
        * Output class, handles : (smallish)
        - help text /(c) notice?
        - version line


@@ -153,26 +439,30 @@ languages:
        - text
        - slur start/end
 
        - text
        - slur start/end
 

+       * PS 
+       - speed up PS code.
+       - PS lines to .eps files
+       - write custom prolog
+
+

        * Output an output format independent (ofi) typeset file; and 
        * Output an output format independent (ofi) typeset file; and 

-         make ofi2 TeX, MusixTex, Display PostScript, PostScript,
+         make ofi2 TeX, MusiXTex, Display PostScript, PostScript,

          Ascii... interpreters. (difficult)
 
          Ascii... interpreters. (difficult)
 

-       - poor man's ascii output possible?
-       - MusixTeX output possible? (would have to be done before break calc.)

        - NIFF ?
        - Common Music Notation
        - PostScript output (esp. Beams, Slurs, etc)
        - Move all Score_elems, into libmutype.a
        - NIFF ?
        - Common Music Notation
        - PostScript output (esp. Beams, Slurs, etc)
        - Move all Score_elems, into libmutype.a

- 
+       - SGML
+

        * Documentation
        * Documentation

-       - Doc Mutopia (Music To The People) 

        - Doc (C) stuff of sheet music
        - Doc (C) stuff of sheet music

+       - a better format?  SGML?  TeX?  Info?

        - a tutorial
 
        - a tutorial
 

-       * TeX spanners , use texbeam.cc as an example (smallish)
+       * more spanners (smallish)

        - Glissando
        - trill
        - Glissando
        - trill

-       - bracket

 
        * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
        - [c8. c32 c32]
 
        * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
        - [c8. c32 c32]


@@ -181,9 +471,10 @@ languages:
        - use plet grouping
        - separate visual from rhythmic info even more
        - beams over bars
        - use plet grouping
        - separate visual from rhythmic info even more
        - beams over bars

+       - endbeam req should be *after* the duration, so you can do
+       < { [c4]    }
+         { c8. c16 } >

 
 

-       * Redo fonts
-       - adapt for multiple font sizes.

 
        * lines:
        - Ledger lines, should be separate item: Ledger_lines, Ledger_lines
 
        * lines:
        - Ledger lines, should be separate item: Ledger_lines, Ledger_lines


@@ -196,11 +487,7 @@ languages:
 
        * Keys:
        - merge key{item} & localkey{item}?
 
        * Keys:
        - merge key{item} & localkey{item}?

-       - do conventional keys (C G A, F B E, a e fis, d as des, etc ), 
-         besides lists of flats/sharps, possibly via declaration
-       - key transposition. 
-       - key undo: \key bes; .. . \key; should print natural   
-       - special key: \key bes 'b bis';
+       - Major/Minor

        - spacing, national styles?
 
        * Support for TAB
        - spacing, national styles?
 
        * Support for TAB


@@ -212,24 +499,10 @@ languages:
        * breaking:
        - caching breakpoints
        - saving them
        * breaking:
        - caching breakpoints
        - saving them

-       - allowing users to set them.
-       - penalties

        - specify number of lines
        - specify number of lines

-       - set linelength per line
-
-       * Rhythmic staff.
-
-       * Baroque superstaff
-
-SEVERELY LACKING:
-
-       * SPEED!
-
-       * multibar rests

 
        * markers
 
 
        * markers
 

-

 INPUTLANGUAGE
 
        * c4 4 4 4 for c4 c4 c4 c4?
 INPUTLANGUAGE
 
        * c4 4 4 4 for c4 c4 c4 c4?


@@ -251,48 +524,43 @@ INPUTLANGUAGE
 
        * relative mode for pitch entering
 
 
        * relative mode for pitch entering
 

-       * bracket (bracketplets)
+       * bracket: volta 1,2

 
        * configure pitch_byte
 
        * rest name configurable
 
 
        * configure pitch_byte
 
        * rest name configurable
 

-       * Raw request syntax
-

 SMALLISH PROJECTS
 
 SMALLISH PROJECTS
 

+       * limit memory usage; the full coriolan takes up too much resources.
+
+       * fix confusing naming in Engraver vs Engraver_group_engraver (context)
+

        * progress when creating MIDI elts.
 
        * A range for context errors (eg. mark both { and }. )
 
        * lyric in staff  (sharpsharp in staff, text below)
 
        * progress when creating MIDI elts.
 
        * A range for context errors (eg. mark both { and }. )
 
        * lyric in staff  (sharpsharp in staff, text below)
 

+       * half sharps/flats
+

        * write Dynamic_line (to group dynamics horizontally)
 
        * use Real for all y positions.
        * write Dynamic_line (to group dynamics horizontally)
 
        * use Real for all y positions.

-       - use translate_axis( .. ,Y_AXIS) 
+       - use translate_axis( .. ,Y_AXIS)  iso separate variables.

 
        * half-sharps, half-flats
 
        * adaptive accidental spacing.
 
 
        * half-sharps, half-flats
 
        * adaptive accidental spacing.
 

-       * unix style paths for LILYINCLUDE env
-

        * handle EOF graciously in error messages.
 
        * handle EOF graciously in error messages.
 

-       * caching Item/spanner dimensions.
-

        * centered whole rest
 
        * centered whole rest
 

-        * qtor, btor, mtor-> tor( QUIET_ver ), tor( DEBUG_ver ), etc.
-       - use tors feature in lily (?)
-

        * declare notenametab?
 
        * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
 
        * declare notenametab?
 
        * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
 

-       * parshape
-

        * Flower types:
        - A decent scalar type
        - String hash
        * Flower types:
        - A decent scalar type
        - String hash


@@ -302,27 +570,13 @@ SMALLISH PROJECTS
 
        * stafftypes: voice names/ instrument names.
 
 
        * stafftypes: voice names/ instrument names.
 

-       * TeX stuff:    
-       - Decent TeX titledefs (\tempo, \metron, etc. )
-       - decent TeX page layout
-

        * lily \tempo
 
        * C meter iso 4/4, idem for alla breve, etc.
 
        * textspanner: center position
 
        * lily \tempo
 
        * C meter iso 4/4, idem for alla breve, etc.
 
        * textspanner: center position
 

-       * Brackets
-       
-       * Scripts:
-       - stack scripts in chords:
-         % fingering:        footing:
-           < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
-       - script-spacing
-       - slur parts as a script
-       - stack parameterised scripts for fingering and footing:
-
-            % toe to bheel   four to five
+        *   % toe to bheel   four to five

            %   ^_u            4_5  
            %     -                           
            %  --|x--         --|x--
            %   ^_u            4_5  
            %     -                           
            %  --|x--         --|x--


@@ -342,8 +596,8 @@ SMALLISH PROJECTS
 
 IDEAS
 
 
 IDEAS
 

-       * Output abstract data structures associated with
-Mudela.
+
+       * Output data structures of Mudela in XML/SGML.

 
        * create libmudela, or liblily_frontend
 
 
        * create libmudela, or liblily_frontend
 


@@ -352,9 +606,7 @@ Mudela.
        * use an embedded language: Python, Scheme
        for: 
                - Score_elems
        * use an embedded language: Python, Scheme
        for: 
                - Score_elems

-               - Engraver

                - Translators
                - Translators

-               - Complex mudela?

 
        * y -dims in internote? Staff-space? X-dimensions?
 
 
        * y -dims in internote? Staff-space? X-dimensions?
 


@@ -362,8 +614,6 @@ Mudela.
 
        * caching breakpoints
 
 
        * caching breakpoints
 

-       * #c <-> cis
-

        * breath marks 
 
        * used fixedpoint arithmetic for min. energy.
        * breath marks 
 
        * used fixedpoint arithmetic for min. energy.


@@ -374,38 +624,11 @@ Mudela.
        - design meta-language like TeX and Metafont
        - programming/macros input
 
        - design meta-language like TeX and Metafont
        - programming/macros input
 

-       * Global type registration.
-
-               My_class * p = create_object( My_class )
-               Type t = get_type ( *p );
-               if ( t <= get_type( q ))
-                       ..
-
-       * naming of Voice_group/Voice
-
-       * benchmark band_matrices.
-

        * versioning stuff (cvt mudela, mudela, etc.)
 
        * versioning stuff (cvt mudela, mudela, etc.)
 

-       * a real convert-mudela
-
-       * dots into separate item.
-
-       * use String iso Text_def for lyrics.
-
-       * use position 0 for center of staff iso bottom.
-

        * Klavarskribo?
 
        * lyrics in chords still fuck up.
 
        * Klavarskribo?
 
        * lyrics in chords still fuck up.
 

-       - rewire acknowledge_element() logic with a process_acknowledged()
-
-       * pushgroup/popgroup
-
-
-       * multi threading?
-         - 1 thread per element/ 1 thread per line
-         - 1 thread per Translator
-

        * Use hooks/dependency graphs for properties
        * Use hooks/dependency graphs for properties

+