]> git.donarmstrong.com Git - lilypond.git/blobdiff - TODO
release: 1.1.15
[lilypond.git] / TODO
diff --git a/TODO b/TODO
index 7f9b738c65c41f91cae4624ce14c54f3e80c1091..cbc7bc71578e6bca3cdd6bc9226d010650304d31 100644 (file)
--- a/TODO
+++ b/TODO
@@ -6,16 +6,187 @@ 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/urg
 
-0.2:
-       * junk My_lily_parser::abbrev_beam_type_i_ 
+BUGS:
+       * c4 \! \> c4
 
-       * w32 blurb
+       * tremolo stuff
 
-       * make sure all ex's have a mudela-version
+       * gallina barlines.
+
+       * fix height of / collisions with lyrics (chords), 
+          see input/test/vertical-text.ly
+
+       * repeat/volta:
+         - one volta spanner per score
+         - repeat bars span staffs
+         - placement alternative number
+
+       * who is trying to print too (small/big) piano braces all the time?
+           warning: piano brace too small (16.000pt)
+
+       * latex bla.tex broken (titles / \lilyfooter stuff?)
+
+       * msgfmt -o check?
+
+       * \breathmark TeX macro 
+
+       * configure error if GUILE 1.3 not found
+
+       * configure error if no rtti (gcc 2.8 or egcs-1.1)
+
+       * catch GUILE errors?
+
+       * add new glyphs to font.ly
+
+       * formatting of input stuff. 
+
+       * \notes{ a \< b \cr } vs \notes{ a \< b \! }
+
+       * 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.  
+
+       * space after bars?
+
+       * \type Voice \times 2/3 { [c8 c16 c16 c16 c16] }
+
+       * 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 SkipBars  -> skipBars
+
+       * \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 }
+
+STUFF
+       * uniformise recent feta contributions.
+
+       * check out legal/(c) matters for scores.
+
+       * check out GCC signatures?
+
+       * Align_element::padding  ?
+
+       * uniformise property names.
+
+       * ydirection <-> yDirection
+
+       * typo checks on property names?
+
+       * 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)
+
+       * 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.
+
+       * percussion note heads
+
+       * mi2mu empty staffs.
+
+       * midi_instrument -> midiInstrument
+
+       * horizontal centering of dynamics 
 
-       * notes almost touch barline: whitespace at the begin of the bar 
-        should be at fixed at at least (about) one interline.
-        hack at spring-spacer.cc:662 doesn't work anymore
+       * \font\fontA=feta20.afm (.afm?)
+
+       * gzip RH manpage
+
+       * stable make/config stuff
+
+       * $DEPENDENCIES_OUTPUT support
+
+       * fix BUGs
+
+       * fix weird behaviour when .AFMs/.SCMs not found.
+
+       * Xdvi zooming ?! Try to understand GS garbage collection.
+               gs: Error: /undefined in draw_beam
+               gs: Operand stack:
+
+       * run texhash after installing .tex
+
+       * fix vertical alignment and stafflines
+
+       * 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...)
+
+       * make Tie_req a "command" { <c g> ~ <c g> }
+
+       * revise the Score_priority_align_engraver concept.  It sucks. 
+
+       * 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 }> |
+       }
+
+       * try to use template<Type> iso MACRO(Type)
+
+       - 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.
 
@@ -26,10 +197,6 @@ grep for TODO and ugh/ugr/urg
  
        * deps for ly2dvi
 
-       * fix .txt rules / make dist from freshly configured tar-ball
-
-       * document use of ly2dvi more prominently
-
        * clean up abbrev/plet/beam/abbrevbeam/duration mess in parser.
 
        * minimum length second part broken tie
@@ -43,53 +210,50 @@ grep for TODO and ugh/ugr/urg
 
        * fix variable define/lookup parser global<->paper
 
-       * fix position of bar number
-
-       * fix position of brace in conjunction with bracket
-
        * 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
-         - grav -> engraver
          - measure -> bar
+         - abbrev -> tremolo
          - abbreviation-beam -> (measured/unmeasured) tremolo
+         - partial -> anacrouse
 
-       * libtoolize flowerlib
        * 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
 
-       * use kpsepath to find all TeX dirs
-       - configure.in 
-       - clean-fonts.sh
+       * more intelligent file searching
+       - make LilyPond RPM fully relocatable
 
        * nicen examples:
-       - remove all \multi
        - break-up heavily-nested score blocks
 
        * disable spaces in TeX stuff
        
        * handle ^C for tmp/file creation.
 
+       
        * dots & rest collisions.
 
-       * add a screenshot to the website. :)
-
        * documentation
        - introduction?
        - info?
        - LaTeX?
        - more manpages?
 
-       * naming Mozarella, Madeira, Muella?
-
        * versioning for Feta
 
        * the warning about the negative slur/tie length appears twice
@@ -98,39 +262,95 @@ grep for TODO and ugh/ugr/urg
        * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
        in the middle:
 
-       * the tenuto script is too long and too thin
-
        * the bracket is ugly (wings are too parabolic, should be more circular)
-       * better hshift (dots, distance, head dependent)
-
-       * stem len adjustable
 
-STUFF
-       * convert-mudela:
-       - automatically add  a \version if not present.
-       - better parsing
-       - make smarter
-       - fix convert-mudela -e *.ly ;
-       - convert-mudela -e empty.ly
-       - redo in python.
+       * better hshift (dots, distance, head dependent)
 
         * clefs (AG): The "8" should appear closer to the actual clef,
           touching it.
 
-       * give Items/Spanners access to unbroken originals      
+       * put errorlevel in Input class
+
+       * junk nesting slurs
 
-       * generalised scopes for Parser/identifiers.
+       * integrate midi-elts from mi2mu and lily?
 
-       * speed up PS code.
+       * 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...
 
-       * scoping for properties
 
-       {       c4
-               \multi 2  < { \stemup .. } { \stemdown .. } >
-               c2 
-       }
+3RD PARTY BUGS:
 
-       this modifies \stem for the c2
+       * make GCC warn about ctor that leaves member vars  uninitialised.
+
+       * 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))
+
+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
+
+       * 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.
@@ -138,52 +358,20 @@ STUFF
        -  indentation
        -  notenames?
        -  fontlock: \melodic \melodic
 
        * 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
 
        * page handling:
        - PS output
        - optimal pagebreaking.
 
-       * put errorlevel in Input class
-
-       * AFM for font input?
-
-
-3RD PARTY BUGS:
-
-       * tried egcs 1.0.2: failed on lily/stem.cc -> flower/include/interval.hh
-         should narrow down and send bug report
-
-       * gcc 2.8.1: see ice and RESIZE_ICE
-
-       * xdvi: PS in magnifying glass.
-
-       * GNU patch 2.1: hardcoded limit of 1024 to the linelength
-
-       * 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.
-
-PROJECTS
-
-       * Unicode support?
+       * Unicode support? -> man 7 unicode
        - 16 bit Strings
        - -u switch
        - detect of 16/8 bit files
@@ -191,18 +379,15 @@ PROJECTS
 
        * Spring_spacer:
        - write a faster Spring_spacer (without matrices if possible)
-       - use straight LP to find minimal "fitting force"
        - relate energybound to linelen unitspace fontsize etc.
-       - used fixed point fp
+       - used fixed point fp?
 
        * \header
        - output header info to MIDI too.
 
-       * Add mudela-output to Rosegarden.
-
        * a musical dictionary. See Documentation/vocabulary-*, other
-languages:
-       - explanation
+       languages:
+       - explanations
        - italian
        - german
        - dutch
@@ -210,14 +395,11 @@ languages:
         .. ?
 
        * chords
-       - guitar chords
-       - chord names
+       - jazz style inversions C/E => <e g c>
+       - guitar chords (fret diagrams)
+       - other chord name styles (american(?) style)
        - basso continuo
-       - Syntax/parser
        - MIDI output?
-       - typesetting
-
-       * integrate midi-elts from mi2mu and lily?
 
        * Debug logs:
        - derive lily_stream, Dstream, texstream from ostream?
@@ -233,7 +415,7 @@ languages:
        * add to MIDI output:
        - tempo change
        - ornaments (and trills?)
-       - repeat
+       - repeat/volta
        - slurs
        - accents
        - dynamics
@@ -262,7 +444,11 @@ languages:
        - text
        - slur start/end
 
-       * cautionary accidental
+       * PS 
+       - speed up PS code.
+       - PS lines to .eps files
+       - write custom prolog
+
 
        * Output an output format independent (ofi) typeset file; and 
          make ofi2 TeX, MusiXTex, Display PostScript, PostScript,
@@ -272,13 +458,14 @@ languages:
        - Common Music Notation
        - PostScript output (esp. Beams, Slurs, etc)
        - Move all Score_elems, into libmutype.a
+       - SGML
+
        * Documentation
        - Doc (C) stuff of sheet music
        - a better format?  SGML?  TeX?  Info?
-       - a tutorial
+       - a better tutorial
 
-       * TeX spanners , use texbeam.cc as an example (smallish)
+       * more spanners (smallish)
        - Glissando
        - trill
 
@@ -290,9 +477,6 @@ languages:
        - separate visual from rhythmic info even more
        - beams over bars
 
-       * Redo fonts
-       - adapt for multiple font sizes.
-
        * lines:
        - Ledger lines, should be separate item: Ledger_lines, Ledger_lines
        - set different line sizes / thicknesses
@@ -304,11 +488,6 @@ languages:
 
        * 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';
        - spacing, national styles?
 
        * Support for TAB
@@ -320,11 +499,8 @@ languages:
        * breaking:
        - caching breakpoints
        - saving them
-       - penalties
        - specify number of lines
 
-       * Rhythmic staff.
-
        * markers
 
 INPUTLANGUAGE
@@ -348,74 +524,53 @@ INPUTLANGUAGE
 
        * relative mode for pitch entering
 
-       * bracket (bracketplets)
-
        * configure pitch_byte
 
        * rest name configurable
 
-       * Raw request syntax
-
 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)
 
+       * half sharps/flats
+
        * 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.
 
        * handle EOF graciously in error messages.
-oo
-       * caching Item/spanner dimensions.
 
        * 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...)
 
        * Flower types:
        - A decent scalar type
-       - String hash
-       - Pointer hash
-
-       * binsearch/hash for identifiers
 
        * 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
 
-       * 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--
@@ -431,8 +586,6 @@ oo
 
        * revise calcideal
 
-       * volta
-
 IDEAS
 
        * Output data structures of Mudela in XML/SGML.
@@ -442,11 +595,9 @@ IDEAS
        * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
 
        * use an embedded language: Python, Scheme
-       for: 
+       for:
                - Score_elems
-               - Engraver
                - Translators
-               - Complex mudela?
 
        * y -dims in internote? Staff-space? X-dimensions?
 
@@ -454,10 +605,6 @@ IDEAS
 
        * caching breakpoints
 
-       * #c <-> cis
-
-       * breath marks 
-
        * used fixedpoint arithmetic for min. energy.
 
        * move towards incremental algorithms.
@@ -466,24 +613,128 @@ IDEAS
        - 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 ))
-                       ..
-
        * versioning stuff (cvt mudela, mudela, etc.)
 
-
-       * dots into separate item.
-
-       * use String iso Text_def for lyrics.
-
        * Klavarskribo?
 
-       * lyrics in chords still fuck up.
-
-       * pushgroup/popgroup
-
-       * Use hooks/dependency graphs for properties
+       * dynamic loading of engravers? 
+
+SMOBS:
+
+****************************************
+Han-Wen Nienhuys <hanwen@cs.uu.nl> writes:
+
+> mcmanus@IDT.NET writes:
+> > > I want different C++ objects (with scheme embedded) to be linked by
+> > > C++ pointers.  I want to access these other objects from the Scheme
+> > > code, and I want access to these pointers from C++.
+> > 
+> > You can do this with a  combination of smob's and primitive functions,
+> > though it may not be  be exactly what you wanted.   You would have one
+> > smob  for each class in  your application, and then  you would write a
+> > primitive function that would return the objects  that are linked to a
+> > base object.
+> 
+> And the smob and the C++ class are interlinked?  Like
+> 
+>      class Foo_class {
+>              Foo_smob *smob_ptr_;
+>      }
+> 
+>      struct Foo_smob {
+>              Foo_class *class_ptr_
+>      }
+
+Usually you can get away without having this interlinked structure.
+One piece of information you need when exporting objects to scheme is
+the smob tag for your class.  You might store this value (a long) into
+a class static variable, or a file static variable.  I'll use a class
+static variable in this example.
+
+I typically use code that works like this (untested code ahead):
+
+class Foo_class {
+    static long *Foo_smob_tag;
+    SCM obj; // representation as a scheme object, description comes later
+}
+
+// call this once on startup
+void init_Foo_class {
+    static scm_smobfuns type_rec;
+
+    type_rec.mark = foo_mark;
+    type_rec.free = foo_free;
+    type_rec.print = foo_display;
+    type_rec.equalp = 0;
+    Foo_class::Foo_smob_tag = new int(scm_new_smob(type_rec));
+}
+
+When you want to export an object to scheme, you put a pointer to the
+object itself in the cdr of the cell, and the tag in the car of the
+cell.  The code looks like this:
+
+// Is this a Foo?
+static int
+foo_p(SCM obj)
+{
+    return(SCM_NIMP(obj) && SCM_CAR(obj) == Foo_class::Foo_smob_tag);
+}
+
+// given a Scheme representation, return, a C++ representation
+static Foo_class *
+foo_unbox(SCM obj)
+{
+    return((Foo_class*)SCM_CDR(obj));
+}
+
+// the SCM representation of the object is stored inside itself
+// this will become useful when destructor gets called
+static SCM
+foo_box(Foo_class *foo)
+{
+    SCM_DEFER_INTS;
+    SCM_NEWCELL(foo->obj);
+    SCM_SETCAR(foo->obj, Foo_class::Foo_smob_tag);
+    SCM_SETCDR(foo->obj, (SCM)foo);
+    SCM_ALLOW_INTS;
+    return foo->obj;
+}
+
+> C++ determines life time, so what is the strategy?
+
+What happens now when the destructor gets called?  Lets set the cdr to
+NULL, and then check for that in all of the primitive functions that
+use your smob.  We'll call this notion 'live'; a scheme object is
+'live' if the C++ representation still exists, it's dead if the C++
+object is gone.  You can still have references to dead objects in
+scheme code; it's just an error to use them.  This idea is stolen from
+Emacs's handling of buffers ('buffer-live-p' and friends).
+
+Add another function, foo_live_p:
+
+static int
+foo_live_p(SCM obj)
+{
+    return(foo_p(obj) && SCM_CDR(obj) != NULL);
+}
+
+In you destructor, you need to do:
+
+~Foo_class()
+{
+    SCM_CDR(this->obj, NULL);
+}
+
+When writing new primitives, now just check foo_live_p().
+
+I hope the above helps,
+
+-russ
+
+
+--
+"Even if you are on the right track, you'll get run over 
+if you just sit there."  
+             --Will Rogers (1879-1935)
+
+***************************