]> git.donarmstrong.com Git - lilypond.git/blobdiff - TODO
patch::: 1.1.24.mb1: Re: LilyPond 1.1.24 "Hacking Apart Together"
[lilypond.git] / TODO
diff --git a/TODO b/TODO
index b22fe9a2447bc07bb0e6d4b811dd15d83969a889..b7ed39218c3e22927f3cc972690192040ca63ca5 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,5 +1,5 @@
-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
@@ -7,9 +7,91 @@ 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
 
+**************
+I also found a few bugs:
+
+* The examples in input/test/bar-scripts.ly and score-bar-scripts.ly
+  don't work. The problem seems to be that you can't define a 
+  a score identifier and then use it in the \score block.
+
+* Instrument names in the margin. Example: 
+  input/test/hara-kiri.ly. The text should of course
+  be to the left of the staff lines.
+**************
+
+       * check widths of TFM, something's wrong here. 
+
+       * hang Item on Spanner
+
+       * junk Text_def, use G_text_item in stead.
+
+       * remove Interval dim_ from Dimension_cache and rename the struct.
+
+       * do --safe for PS output?
+
+       * staff_margin (with a partial measure.)
+
+       * fix "I've been drinking too much"
+
+       * add scripts to bars eg.  |^"bla" 
+
+       * fix Staff_margin_engraver.
+
+       * fix pletvisibility properties:
+         - bracket on/off/no-bracket-when-beam
+         - num on/off/no-num-when-beam
+
+       * fix: standchen.
+
+       * junk backlinks?
+
+       * junk text{sharp,flat,etc}
+
+       * fix convert-mudela manpage
+
+       * automatic staff selection.
+
+       * decimal point in \paper {}
+
+       *{  \voiceone <a'4.*2/3  d''4.*2/3 fis''4.*2/3>  [g''8 fis'' e''] d''4 |}
+        and=20
+        { \voicetwo  d'4 d'2.*2/3 } spacing
+
+       * tied notes for MIDI
+
+       * sharp /flat on trills (in MIDI ??)
+
+       * scm-ify \property values.
+
+       * move class Lookup {} into scm
 
 BUGS:
-       * disallow backslashes
+
+       * fix: text on rests: rediculous dims
+
+       * ly2dvi
+         - deps for ly2dvi
+
+       * fix midi output:
+          - default duration?  duration must be not entered
+            explicitely on first note.
+
+       * turn slope-damping on/off
+
+       * c4 \! \> c4
+
+       * tremolo stuff
+
+       * gallina barlines.
+
+       * fix height of / collisions with lyrics (chords), 
+          see input/test/vertical-text.ly; input/test/repeat.ly
+
+       * latex bla.tex broken (titles / \lilyfooter stuff?)
+
+       * check/set minimum slur/tie length
+
+       * msgfmt -o check?
 
        * \breathmark TeX macro 
 
@@ -27,20 +109,18 @@ BUGS:
 
        * space after bars?
 
-       * [/3 c8 c16 c c c]/1
-  
+       * 'hinterfleisch' before bar (e.g. wtk1-fugue2)?
+
+       * \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.
+       * repeat bars: need distance after ":|" and before "|:"
 
        Summary of minor spelling irregularities:
        -  capitalization/use of underscores in property names
 
-       * fix Score.skipBars
-
-       * repeat bars: need distance after ":|" and before "|:"
+       * fix SkipBars  -> skipBars
 
        * \shape 1st dim skipped? 
 
@@ -60,15 +140,20 @@ BUGS:
        
        portato= \script { "portato" 0 -1 0 1 0 }
 
-       * Align_element::padding  ?
+STUFF
+       * uniformise recent feta contributions.
 
-       * uniformise property names.
+       * check out legal/(c) matters for scores.
 
-       * ydirection <-> yDirection
+       * check out GCC signatures?
 
-       * typo checks on property names?
+       * Align_element::padding  ?
 
-       * make engraver hacking robust.
+       * uniformise property names...
+         - ydirection <-> yDirection
+         - rather allow '_' in identifiers first (i.e. junk ^ and _),
+           and do y_direction?
+         - typo checks on property names?
 
        * use streambufs and iostream
        to provide IO handling for TeX stream, mudela stream, data-file.
@@ -79,12 +164,6 @@ BUGS:
 
        * zip target for binary windows dist (JBR)
 
-       * text continuations
-
-       * revise documentation
-
-       * abbrev -> tremolo
-
        * junking \skip req in lyrics
 
        * Language:
@@ -99,16 +178,10 @@ BUGS:
        - junk _ for lyrics.
        - abstract grammar.
 
-       * install TeX stuff into tex/generic directory.
-
        * percussion note heads
 
        * mi2mu empty staffs.
 
-       * include MIDI list 
-
-       * midi_instrument -> midiInstrument
-
        * horizontal centering of dynamics 
 
        * \font\fontA=feta20.afm (.afm?)
@@ -117,23 +190,14 @@ BUGS:
 
        * 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 weird behaviour when .AFMs/.SCMs not found.
 
-       * fix BUGs
-
-       * fix weird behaviour when .AFMs not found.
-
-       * Xdvi zooming ?!
+       * 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
@@ -144,14 +208,8 @@ BUGS:
        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> }
-
-       * bib ep1988
-
        * revise the Score_priority_align_engraver concept.  It sucks. 
 
-       * ly2xdvi, ly2ps
-
        * make new VoiceOne, VoiceTwo, VoiceThree contexts with
 ydirection and hshift preset
 
@@ -173,14 +231,12 @@ ydirection and hshift preset
        - 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?
+          * < 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.
@@ -189,10 +245,6 @@ ydirection and hshift preset
 
        * 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
  
@@ -200,9 +252,6 @@ ydirection and hshift preset
          - 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
@@ -215,8 +264,8 @@ ydirection and hshift preset
          * \cadenza , \meter, \grouping should all be \properties
 
        * rename
-         - plet -> tuplet
          - measure -> bar
+         - abbrev -> tremolo
          - abbreviation-beam -> (measured/unmeasured) tremolo
          - partial -> anacrouse
 
@@ -231,10 +280,8 @@ ydirection and hshift preset
        * check for groff / troff/ nroff et
 
        * more intelligent file searching
-       - make LilyPond RPM fully relocatable
 
-       * nicen examples:
-       - break-up heavily-nested score blocks
+       * make LilyPond RPM fully relocatable
 
        * disable spaces in TeX stuff
        
@@ -269,52 +316,47 @@ ydirection and hshift preset
 
        * 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:
-
-       * redhat (v?) graphical install bomb-out?
+****************
+/*
+ICE
+*/
+signature S {
+  int foo ();
+};
+
+signature V {
+  S * s();
+};
+
+
+V*v();
+f ()
+{
+  return v( )->foo ();
+}
+
+/*
+
+  egcs-1.1
+
+foo.cc: In function `int f()':
+foo.cc:6: label `b' used but not defined
+*/
+void
+f ()
+{
+  bool b;
+  if (b && && b)
+        ;      
+}
+***************
+
+       * make GCC warn about ctor that leaves member vars  uninitialised.
 
        * 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")
@@ -322,8 +364,6 @@ ydirection and hshift preset
 
 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 
@@ -389,12 +429,10 @@ PROJECTS
         .. ?
 
        * chords
-       - guitar chords
-       - chord names
+       - guitar chords (fret diagrams)
+       - other chord name styles (american(?) style)
        - basso continuo
-       - Syntax/parser
        - MIDI output?
-       - typesetting
 
        * Debug logs:
        - derive lily_stream, Dstream, texstream from ostream?
@@ -410,7 +448,7 @@ PROJECTS
        * add to MIDI output:
        - tempo change
        - ornaments (and trills?)
-       - repeat
+       - repeat/volta
        - slurs
        - accents
        - dynamics
@@ -432,8 +470,6 @@ PROJECTS
        - quiet/ignore-version options
        - logfile output
 
-       * piano staff
-
        * elaborate Staff_side baseclass:
        - scripts
        - text
@@ -444,7 +480,6 @@ PROJECTS
        - PS lines to .eps files
        - write custom prolog
 
-
        * Output an output format independent (ofi) typeset file; and 
          make ofi2 TeX, MusiXTex, Display PostScript, PostScript,
          Ascii... interpreters. (difficult)
@@ -471,10 +506,6 @@ PROJECTS
        - 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 } >
-
 
        * lines:
        - Ledger lines, should be separate item: Ledger_lines, Ledger_lines
@@ -487,7 +518,6 @@ PROJECTS
 
        * Keys:
        - merge key{item} & localkey{item}?
-       - Major/Minor
        - spacing, national styles?
 
        * Support for TAB
@@ -501,8 +531,6 @@ PROJECTS
        - saving them
        - specify number of lines
 
-       * markers
-
 INPUTLANGUAGE
 
        * c4 4 4 4 for c4 c4 c4 c4?
@@ -524,8 +552,6 @@ INPUTLANGUAGE
 
        * relative mode for pitch entering
 
-       * bracket: volta 1,2
-
        * configure pitch_byte
 
        * rest name configurable
@@ -555,19 +581,10 @@ SMALLISH PROJECTS
 
        * handle EOF graciously in error messages.
 
-       * centered whole rest
-
        * 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.
 
        * lily \tempo
@@ -592,30 +609,18 @@ SMALLISH PROJECTS
 
        * revise calcideal
 
-       * volta
-
 IDEAS
 
-
        * Output data structures of Mudela in XML/SGML.
 
        * create libmudela, or liblily_frontend
 
        * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
 
-       * use an embedded language: Python, Scheme
-       for: 
-               - Score_elems
-               - Translators
-
-       * y -dims in internote? Staff-space? X-dimensions?
-
        * Spacing_request for manually adjusting spacing
 
        * caching breakpoints
 
-       * breath marks 
-
        * used fixedpoint arithmetic for min. energy.
 
        * move towards incremental algorithms.
@@ -628,7 +633,124 @@ IDEAS
 
        * Klavarskribo?
 
-       * lyrics in chords still fuck up.
-
-       * 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)
+
+***************************