]> 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 893aa58eac5524fb9a561ea9ae05c1b42fd18e23..b7ed39218c3e22927f3cc972690192040ca63ca5 100644 (file)
--- a/TODO
+++ b/TODO
-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. 
 grep for TODO and ugh/ugr/urg
-       * fix plain tex footer line.
 
-      * portable libs for flowerlib/lilylib
+**************
+I also found a few bugs:
 
-       * install TeX stuff into tex/generic directory.
+* 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.
+**************
 
-       * make GNU style webpages.
+       * check widths of TFM, something's wrong here. 
 
-       * There seems to be an install error in lilypond-1.0.0.  Most of the
-       files in the "init" directory don't get installed in the
-       /usr/local/share/lilypond directory.  The files installed are of
-       the form feta*.ly.  In particular init.ly doesn't get installed.
-       I installed the files by hand and then the system seems to work.
+       * hang Item on Spanner
 
-       * I things it's more than appropriate for an GNU project to ship Info
-       files (and manpages) with the source package.  The "Standard" tells to
-       do so (ftp://ftp.gnu.org/pub/gnu/standards/standards.text):
+       * junk Text_def, use G_text_item in stead.
 
+       * remove Interval dim_ from Dimension_cache and rename the struct.
 
-       * a `make check' target (without installing stuff!)
+       * do --safe for PS output?
 
-       * midi_instrument -> midiInstrument
+       * staff_margin (with a partial measure.)
 
-       * horizontal centering of dynamics 
+       * fix "I've been drinking too much"
 
-       * \font\fontA=feta20.afm (.afm?)
+       * add scripts to bars eg.  |^"bla" 
 
-       * gzip RH manpage
+       * fix Staff_margin_engraver.
 
-       * stable make/config stuff
+       * fix pletvisibility properties:
+         - bracket on/off/no-bracket-when-beam
+         - num on/off/no-num-when-beam
 
-       * stemup/stemdown; see test/updown.fly
-         - check examples; add \type Staff hither and thether
+       * fix: standchen.
 
-       * $DEPENDENCIES_OUTPUT support
+       * junk backlinks?
 
-       * use a fake-yodl.sh to mimick yodl when yodl is not installed
+       * junk text{sharp,flat,etc}
 
-       * fix BUGs
+       * fix convert-mudela manpage
 
-       * fix weird behaviour when .AFMs not found.
+       * automatic staff selection.
 
-       * Xdvi zooming ?!
-               gs: Error: /undefined in draw_beam
-               gs: Operand stack:
+       * decimal point in \paper {}
 
-       * run texhash after installing .tex
+       *{  \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
 
-       * fix vertical alignment and stafflines
+       * tied notes for MIDI
 
-       *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...)
+       * sharp /flat on trills (in MIDI ??)
 
+       * scm-ify \property values.
 
-       * make Tie_req a "command" { <c g> ~ <c g> }
+       * move class Lookup {} into scm
 
-       * bib ep1988
+BUGS:
 
-       * mix engraver hacking with music ?
+       * fix: text on rests: rediculous dims
 
-       * revise the Score_priority_align_engraver concept.  It sucks. 
+       * 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 
+
+       * 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?
+
+       * 'hinterfleisch' before bar (e.g. wtk1-fugue2)?
+
+       * \type Voice \times 2/3 { [c8 c16 c16 c16 c16] }
 
-       * ly2xdvi
+       * fix singleStaffBracket
+
+       * repeat bars: need distance after ":|" and before "|:"
+
+       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
+         - 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.
+
+       * 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.
+
+       * horizontal centering of dynamics 
+
+       * \font\fontA=feta20.afm (.afm?)
+
+       * gzip RH manpage
+
+       * stable make/config stuff
+
+       * $DEPENDENCIES_OUTPUT support
+
+       * 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:
+
+       * 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...)
+
+       * revise the Score_priority_align_engraver concept.  It sucks. 
 
        * make new VoiceOne, VoiceTwo, VoiceThree contexts with
 ydirection and hshift preset
 
-       * StepMake install
-         - /usr/bin/make-patch?
-
        * *.yo: fix pod manpage layout legacy
 
        * text-items clash with stems/beams
@@ -100,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.
@@ -116,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
  
@@ -127,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
@@ -142,11 +264,10 @@ ydirection and hshift preset
          * \cadenza , \meter, \grouping should all be \properties
 
        * rename
-         - plet -> tuplet
          - measure -> bar
+         - abbrev -> tremolo
          - abbreviation-beam -> (measured/unmeasured) tremolo
-
-       * libtoolize flowerlib
+         - partial -> anacrouse
 
        * shared lib
 
@@ -159,15 +280,8 @@ ydirection and hshift preset
        * check for groff / troff/ nroff et
 
        * more intelligent file searching
-       - use kpsepath
-       - make LilyPond fully relocatable
 
-       * use kpsepath to find all TeX dirs
-       - configure.in 
-       - clean-fonts.sh
-
-       * nicen examples:
-       - break-up heavily-nested score blocks
+       * make LilyPond RPM fully relocatable
 
        * disable spaces in TeX stuff
        
@@ -196,77 +310,53 @@ ydirection and hshift preset
         * clefs (AG): The "8" should appear closer to the actual clef,
           touching it.
 
-       * give Items/Spanners access to unbroken originals      
-
-       * scoping for properties?
-
-       {       c4
-               \multi 2  < { \stemup .. } { \stemdown .. } >
-               c2 
-       }
-
-       this modifies \stem for the c2
-
        * put errorlevel in Input class
 
        * 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:
-
-       * redhat (v?) graphical install bomb-out?
-
-       * egcs-1.03 ice: stem.cc:327; should localize bug (mine's still 10K)
-
-       * 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
+****************
+/*
+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")
@@ -274,12 +364,7 @@ ydirection and hshift preset
 
 3RD PARTY PROJECTS:
 
-       * GNU indent: handle C++
-
-       * GNU make: move hardcoded builtin rules to runtime ?
-
        * GNU patch 
-         - rewrite ? -> check out GNU patch 2.5
          - 'double-fix' mode: ignore identical fix, rather than suggest 
            to revert patch direction when (more or less? exactly) the same 
            thing is fixed
@@ -307,19 +392,14 @@ PROJECTS
        -  indentation
        -  notenames?
        -  fontlock: \melodic \melodic
 
        * use properties for:
-       - Text_style
-       - default_octave
        - plet?
        - 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
@@ -333,18 +413,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. (contact Derek Wyatt)
-
        * a musical dictionary. See Documentation/vocabulary-*, other
        languages:
-       - explanation
+       - explanations
        - italian
        - german
        - dutch
@@ -352,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?
@@ -373,7 +448,7 @@ PROJECTS
        * add to MIDI output:
        - tempo change
        - ornaments (and trills?)
-       - repeat
+       - repeat/volta
        - slurs
        - accents
        - dynamics
@@ -395,8 +470,6 @@ PROJECTS
        - quiet/ignore-version options
        - logfile output
 
-       * piano staff
-
        * elaborate Staff_side baseclass:
        - scripts
        - text
@@ -407,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)
@@ -418,11 +490,10 @@ PROJECTS
        - 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
 
        * more spanners (smallish)
        - Glissando
@@ -435,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
@@ -451,7 +518,6 @@ PROJECTS
 
        * Keys:
        - merge key{item} & localkey{item}?
-       - Major/Minor
        - spacing, national styles?
 
        * Support for TAB
@@ -465,8 +531,6 @@ PROJECTS
        - saving them
        - specify number of lines
 
-       * markers
-
 INPUTLANGUAGE
 
        * c4 4 4 4 for c4 c4 c4 c4?
@@ -488,8 +552,6 @@ INPUTLANGUAGE
 
        * relative mode for pitch entering
 
-       * bracket: volta 1,2
-
        * configure pitch_byte
 
        * rest name configurable
@@ -511,7 +573,7 @@ SMALLISH PROJECTS
        * 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
 
@@ -519,22 +581,10 @@ SMALLISH PROJECTS
 
        * handle EOF graciously in error messages.
 
-       * 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.
 
        * lily \tempo
@@ -543,10 +593,7 @@ SMALLISH PROJECTS
 
        * textspanner: center position
 
-       * Brackets
-       
-
-            % toe to bheel   four to five
+        *   % toe to bheel   four to five
            %   ^_u            4_5  
            %     -                           
            %  --|x--         --|x--
@@ -562,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.
@@ -596,12 +631,126 @@ IDEAS
 
        * versioning stuff (cvt mudela, mudela, etc.)
 
-       * padded vertical alignment (rods for vertical placement)
-
-       * use String iso Text_def for lyrics.
-
        * 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)
+
+***************************