TODO

   1 -*-outline-layout:(2 (-1 -1 0 :) 0);outline-stylish-prefixes:nil -*-
   2
   3 * GNU LilyPond TODO
   4 Features you cannot find in the doco as working, should be
   5 mentioned here.  This is an assorted collection of stuff that will be
   6 done, might be done, or is an idea that I want to think about
   7
   8 Most of the items are marked in the code as well
   9 Grep for TODO and ugh/ugr/urg.
  10
  11 .* BUGS
  12 . * header for PS enteredby = "bla <bla@bar.com>"
  13 . * Hash_table::remove ().
  14 . * 1.  With "lilypond -f ps": The black notes with ledger lines seem to
  15 > have extra "blobs" over and to the left of them and all the ledger
  16 > lines from the staff to the note will have a blob too.  For example,
  17 > with the note "a4" there will be a black note at the ledger line where
  18 > "c" would be too.  However, only the "a4" will have the extra blob.
  19 . * ps/lily.ps
  20 . * devise standard for functioning of Vertical_align_element.
  21 . * fix interstaff slurs & beams.
  22 . * staff size for post/prebreaks
  23 . * .ly files
  24 .  * input/star-spangled-banner
  25 .  * input/scripts.ly
  26 .  * mutopia/J.S.Bach/wtk1-fugue2.ly
  27 .  * input/test/grace
  28 .  * fix: text on rests: ridiculous dims
  29 .  * clefs.ly
  30 . * m=\notes\relative c'''{
  31   \time 2/4;
  32
  33   R2*4 | c2 | c2 | c2 | c2 | c2 | c2 | c2 | c2 | c2 | \break
  34   <{R2*10}{s2 \mark "A"; }> | % Too narrow space for the first rest in
  35 1.1.29
  36   r4 r8 [g16 \p ( a ] |
  37 [ ) g8-. fis16 ( g ][ ) fis8-. f16 ( g ] |
  38 [ ) f8-. e16 ( f ][ ) e8-. es16 ( f ] |
  39 [ ) es8 \f c16 ( d][es8 d16 c ] |
  40 ) d4 r8 [g16 \p ( a ] |
  41 [ ) g8-. fis16 ( g ][ ) fis8-. f16 ( g ] | \break
  42 ) c2 | c2 | c2 | c2 | c2 | c2 | c2 | c2 | c2 |
  43 }
  44
  45 \score{
  46   \m
  47   \paper{
  48     \translator{
  49       \ScoreContext
  50       SkipBars = 1;
  51     }
  52     \translator {
  53       \OrchestralPartStaffContext
  54     }
  55   }
  56 }
  57 . * midi key.
  58 . * P.P.S. It can be cool in mudela-book to distinguish in pre,postMudelaExample,
  59 whether MudelaExample is epsed or not: ( if this fragment is floating eps, than 1,
  60 otherwise 2). say preMudelaExample[eps]{}, and change it in document body sometimes.
  61 . * fix singleStaffBracket
  62 . * declare performers in \midi
  63 . * fix MIDI
  64 . * \shape 1st dim skipped?
  65 . * turn slope-damping on/off
  66 . * tremolo stuff
  67 . * fix height of / collisions with lyrics (chords),
  68     see input/test/vertical-text.ly; input/test/repeat.ly
  69 . * We need feta-din*.mf files for more sizes than 10.
  70 . * latex bla.tex broken (titles / \lilyfooter stuff?
  71 . * fix dynamics decently, ie. use kerning & ligatures.
  72 . * support_l_arr_ empty in staff-margin's G_staff_side_item
  73 . * slurs colllide with lyrics.
  74 . * minVerticalAlign for StaffGroups.
  75 . * fix OrchestralScore and Hara-kiri (i.e., fix Coriolan)
  76 . * Phrasing:  Indicating the textual underlay of a piece, or
  77 otherwise dividing a piece into phrases.
  78
  79 There are distinct ways of specifying the first two (although at
  80 present, they're not properly distinguished) but no distinct way to
  81 specify the third.  Should there be?
  82 . * spacing of mmrests.
  83
  84 .* Cleanups needed
  85 . * Beam
  86 . * Stem + Notehead
  87 . * Slur
  88 . * Repeats
  89 . * Rhythmic_grouping
  90 . * Duration
  91 . * Spring generation
  92 . * Collision
  93 . * Rest_collision
  94
  95 .* TODO before 1.2
  96 . * \selectmusic to cut pieces from music.
  97 . * TODO: merge atom & molecule; make  tree from molecule.
  98 . * break priority setting from SCM.
  99 . * Gade score
 100 .  * remove [] in favour of auto-beamer
 101 .  * The minimum distance between different staffs works only within
 102   StaffGroups, not between StaffGroups. The Gade Score looks quite
 103   strange on the pages where the Timpani and/or Brass sections don't
 104   play. I've set the minimum distance with:
 105     \translator {
 106        \OrchestralScoreContext
 107         minVerticalAlign = 2.5*\staffheight;
 108     }
 109 . * hangOnClef with non-breakable clefs.
 110 . * Aha, the problem is the new TeX code generation for changing fonts.
 111 > (The explanation below is mostly intended for Han-Wen and Jan)
 112 > Before, the font was changed with macros declared separately for
 113 > pure TeX and LaTeX, but now all the fonts are declared directly in
 114 > the generated code using the low-level TeX commands. This circumvents
 115 > the fontencoding mechanism of LaTeX and is a potential source of
 116 > problems also for us users of the Latin-1 character set.
 117 > I think it still works since the inputencoding latin1 is
 118 > declared by ly2dvi, but it still means that e.g. an o with
 119 > umlaut is typeset as a combination of the two symbols 'o' and
 120 > 'umlaut' instead of as a single character, as would be the case
 121 > if fontencoding OT1 had been used. This shouldn't give any
 122 > difference in layout, though. One of the main argument for using
 123 > fontencoding OT1 is for the hyphenation mechanism to work, an
 124 > argument that's clearly irrelevant in our application. Yet we
 125 > see the problem for August.
 126 . * Check gcc 2.8.1 compatibility
 127 . * Abstraction for engravers:
 128 .  * make "in-between" engraver (Tie, Extender)
 129 .  * make wide_spanner_engraver (line_group_spanne,r staff_symbol)
 130 . * remove Interval dim_ from Dimension_cache and rename the struct.
 131 . * do scaled fonts generally
 132 . * The Lilypond accidental symbols are available through the TeX macros,
 133 \textflat, \textsharp and \textnatural defined in the init file
 134 lilyponddefs.tex. All the symbols are defined in the files fetaXX.tex
 135 where XX corresponds to the size. I don't know where (or even if) they
 136 are installed but they are generated in the mf/out/ directory during the
 137 compilation.
 138 . * make dependencies () a virtual function.
 139 . * fix Repeated_music design
 140 . * one big ly2dvi input that includes *all* tests.
 141 . * store req -> element, element -> element causes for warnings
 142 . * include examples in RPM.
 143 . * fix partial measures in meaningful way.
 144 . * add scripts to bars eg.  |^"bla"
 145 . * relative mode for mi2mu
 146 . * uniformise recent feta contributions.
 147 .  * use SCM and Molecules for {accordeon stuff, }
 148 .  * bigger and fatter 4/4 C
 149 . * sort out directory stuff.
 150 .  * --prefix option?
 151 .  * -I option per filetype?
 152 .  * kpathsea?
 153
 154 . * ly2dvi/lilypond logfile.
 155 . * How can I specify a chord whose duration is longer than a whole note?
 156  \type ChordNames { \chord{ A1*2-min } }
 157
 158 gives me a parse error.  And \times doesn't work either.  I can't use
 159 a spacer note.  So it seems to be impossible to have long chords of
 160 general length.  Of course, in the example above I can use \breve.
 161 But what if I want a chord that lasts for 3 whole notes?  Or what
 162 about 2.5 whole notes?  Is there a mechanism for getting this kind of
 163 length?
 164
 165 . * fractional chord durs.
 166 . * hang Item on Spanner
 167 . * do --safe for PS output?
 168 . * convert-mudela --output
 169 . * Staff_margin (with a partial measure.)
 170 . * fix pletvisibility properties:
 171 .  * bracket on/off/no-bracket-when-beam
 172 .  * num on/off/no-num-when-beam
 173 . * fix: standchen.
 174 . * junk text{sharp,flat,etc}
 175 . * fix convert-mudela manpage
 176 . * decimal point in \paper {}
 177 . * {  \voiceone <a'4.*2/3  d''4.*2/3 fis''4.*2/3>  [g''8 fis'' e''] d''4 |}
 178          and
 179          { \voicetwo  d'4 d'2.*2/3 } spacing
 180 . * tied notes for MIDI
 181 . * sharp / flat on trills (in MIDI ??)
 182 . * scm-ify \property values.
 183 . * move class Lookup {} into scm
 184 . * msgfmt -o check?
 185 . * \breathmark TeX macro
 186 . * add new glyphs to font.ly
 187 . * formatting of input stuff.
 188 . * \notes{ a \< b \cr } vs \notes{ a \< b \! }
 189 . * space after bars?
 190 . * 'hinterfleisch' before bar (e.g. wtk1-fugue2)?
 191 . * Summary of minor spelling irregularities:
 192 .  *  capitalization/use of underscores in property names
 193 .  * fix SkipBars  -> skipBars
 194 . * broken scripts:
 195         lbheel = \script { "bheel" 0 0 -1  0 0 }
 196         rbheel = \script { "bheel" 0 0 1 0 0 }
 197         lbtoe = \script { "btoe" 0 0 -1 0 0 }
 198         rbtoe = \script { "btoe" 0 0 1 0 0 }
 199         lfheel = \script { "fheel" 0 0 -1  0 0 }
 200         rfheel = \script { "fheel" 0 0 1 0 0 }
 201         lftoe = \script { "ftoe" 0 0 -1 0 0 }
 202         rftoe = \script { "ftoe" 0 0 1 0 0 }
 203         and also
 204         portato= \script { "portato" 0 -1 0 1 0 }
 205 . * ly2dvi
 206 .  * bottomnote for ly2dvi
 207 .  * deps for ly2dvi
 208 .* STUFF
 209 . * compulsory hshift
 210 . * arrows on slurs.
 211 . * Align_element::padding  ?
 212 . * uniformise property names...
 213 .  * ydirection <-> yDirection
 214 .  * rather allow '_' in identifiers first (i.e. junk ^ and _),
 215 and do y_direction?
 216 .  * typo checks on property names?
 217 . * use streambufs and iostream
 218         to provide IO handling for TeX stream, mudela stream, data-file.
 219 . * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
 220 . * strip EXEs before installing
 221 . * zip target for binary windows dist (JBR)
 222 . * junking \skip req in lyrics
 223 . * mi2mu empty staffs.
 224 . * horizontal centering of dynamics
 225 . * $DEPENDENCIES_OUTPUT support
 226 . * Xdvi zooming ?! Try to understand GS garbage collection.
 227 gs: Error: /undefined in draw_beam
 228 gs: Operand stack:
 229 . * fix vertical alignment and stafflines
 230 . * declaring Performers
 231 . * GrandStaff needs more work -- I want a single word
 232         `harpsichord' to the left of the grandstaff, not one on each
 233         stave.  (Organ staff -- with separate pedal -- but common
 234         properties may be something to think about.  Of course for
 235         organ you want to be able to give stop indications on the way
 236         through, so the \property Voice.Instrument would be a stop,
 237         and \property GrandStaff.instrument would be PipeOrgan...)
 238 . * *.yo: fix pod manpage layout legacy
 239 . * text-items clash with stems/beams
 240 . * --include, -I option for ly2dvi (pass on to lily)
 241 . * fix placement of beam-less abbrev
 242 . * \meter 3/4;
 243         <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
 244          {\voicetwo cis,4 r r | r2. | r1 }> |
 245         }
 246 . * Musical_pitch (analogous to Duration and Rhythmic_req)
 247           think about, analogous to pitch:
 248            * { a4 a16 } c <-- duration of c?
 249            * < a4 b8 > c <-- duration of c?
 250 . * \tempo 4. = 90;
 251 . * fix audio-items (don't use (input) requests, but copy data)
 252 . * make sure all ex's have a mudela-version
 253 . * do rest-collisions for Multi_measure_rests as well.
 254 . * split error/warning in error/warning/non_fatal_error
 255 . * add a Duration_convert member to Duration_iter to set parameters.
 256         Junk global duration settings.
 257 . * en-,discouraged linebreaking:
 258 .  * handle DISALLOW < penalty > FORCE
 259 .  * discourage breaking of slurs
 260 . * fix variable define/lookup parser global<->paper
 261 . * fix title/instrument placements; see input/test/title.ly
 262 . * <\voiceone c4. \voicetwo c4>
 263 . * add full cello suites to web site (kom op, Maarten!)
 264 . * Rethink Time_description
 265 \cadenza , \meter, \grouping should all be \properties
 266 . * rename
 267 .  * measure -> bar
 268 .  * abbrev -> tremolo
 269 .  * abbreviation-beam -> (measured/unmeasured) tremolo
 270 .  * partial -> anacrouse
 271 . * robustify Beam (in case of no stems, 32nd notes)
 272 . * move paper vars into engraver properties
 273 . * check for groff / troff/ nroff et
 274 . * more intelligent file searching
 275 . * disable spaces in TeX stuff
 276 . * handle ^C for tmp/file creation.
 277 . * make LilyPond RPM fully relocatable
 278 . * dots & rest collisions.
 279 . * the warning about the negative slur/tie length appears twice
 280 which is irritating.
 281 . * better hshift (dots, distance, head dependent)
 282 . * clefs (AG): The "8" should appear closer to the actual clef,
 283 touching it.
 284 . * put errorlevel in Input class
 285 . * junk nesting slurs
 286 . * integrate midi-elts from mi2mu and lily?
 287
 288 .* FONT
 289 . * the bracket is ugly (wings are too parabolic, should be more circular)
 290 . * versioning for Feta
 291 . * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
 292         in the middle:
 293 . * design macro for penstroke with rounded endings
 294 . * timesig C: fat yet less curved.  Check out relations.
 295 . * design decent macro for bulbed endings
 296 . * printer dependencies.
 297 . * y-refpoint for rests should be the 4th staffline (gclef: b')
 298 . * clean-up eight+ rests
 299 . * versioning
 300 . * lo-res fixes.
 301 . * work out sizes of character fonts.
 302 . * more symbols
 303 .  * piano pedals: Ped/*
 304 .  * maxima notehead
 305 .  * coda signs: Segno, O+
 306 .  * glissando, arpeggio
 307 .  * lengthened trill
 308 . * 128th flags
 309 . * include important spacing dims in fetalog
 310 .* 3RD PARTY BUGS
 311 . * GNU diff 2.7: diff -rN does not see a new directory with empty file
 312 . * check out GCC signatures?
 313 . * glibc 2.0:
 314           f = fopen ("/dev/null", "r")
 315           assert (feof (f))
 316
 317 . * tetex: mfplain.mem
 318 .* 3RD PARTY PROJECTS:
 319 . * make GCC warn about ctor that leaves member vars  uninitialised.
 320 . * GNU patch
 321 .  * 'double-fix' mode: ignore identical fix, rather than suggest
 322             to revert patch direction when (more or less? exactly) the same
 323             thing is fixed
 324 .* PROJECTS
 325 . * Scripts:
 326 .  * fix position of bar number
 327 .  * stack scripts in chords:
 328           % fingering:        footing:
 329             < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
 330 .  * script-spacing
 331 .  * slur parts as a script
 332 .  * stack parameterised scripts for fingering and footing:
 333
 334 . * convert-mudela:
 335 .  * automatically add  a \version if not present.
 336 .  * better parsing
 337 .  * make smarter
 338 .  * convert-mudela -e empty.ly
 339
 340 . * emacs mudela-mode
 341 .  *  should handle block comments too.
 342 .  *  handle lexer modes (\header, \melodic, \lyric) etc.
 343 .  *  indentation
 344 .  *  notenames?
 345 .  *  fontlock: \melodic \melodic
 346
 347 . * use properties for:
 348 .  * default tempo.
 349 .  * cadenza mode?
 350
 351 . * page handling:
 352 .  * PS output
 353 .  * optimal pagebreaking.
 354
 355 . * Unicode support? -> man 7 unicode
 356 .  * 16 bit Strings
 357 .  * -u switch
 358 .  * detect of 16/8 bit files
 359 .  * examples to go with it.
 360
 361 . * Spring_spacer:
 362 .  * write a faster Spring_spacer (without matrices if possible)
 363 .  * relate energybound to linelen unitspace fontsize etc.
 364 .  * used fixed point fp?
 365
 366 . * \header
 367 .  * output header info to MIDI too.
 368
 369 . * a musical dictionary. See Documentation/vocabulary-*, other
 370         languages:
 371 .  * explanations
 372 .  * italian
 373 .  * german
 374 .  * dutch
 375 .  * swedish
 376          .. ?
 377
 378 . * chords
 379 .  * guitar chords (fret diagrams)
 380 .  * other chord name styles (american(?) style)
 381 .  * basso continuo
 382 .  * MIDI output?
 383
 384 . * Debug logs:
 385 .  * derive lily_stream, Dstream, texstream from ostream?
 386 .  * indentable stream as baseclass for TeX stream, lily stream, Dstream.
 387 .  * use dstream feature in mi2mu
 388 .  * integrate IO checking into stream class
 389
 390 . * input converters
 391 .  * NIFF?
 392 .  * ABC?
 393 .  * SMDL?
 394
 395 . * add to MIDI output:
 396 .  * tempo change
 397 .  * ornaments (and trills?)
 398 .  * repeat/volta
 399 .  * slurs
 400 .  * accents
 401 .  * dynamics
 402 > Would it be hard to add support for proper dynamics in MIDI output?  I
 403 > would really like to have this feature...
 404
 405 To answer this, I have to give a little background.  Please say so if
 406 I am being obtuse.
 407
 408 Both audio and notation elements are created decentrally, when
 409 LilyPond says "Interpreting music ... [8][16] etc."  After all
 410 elements are created, they are processed again to calculate all
 411 parameters.  After that is done, they are dumped onto the output (the
 412 MIDI stream or the TeX file).
 413
 414 The audio and notation elements are created by objects called
 415 performer and engraver respectively.  They work by taking a chunk of
 416 input (a so-called request), and using the request to create an audio
 417 or notation element.
 418
 419 After some processing, the engraver sends the created elements to
 420 its enclosing notation/performance context.
 421
 422 In the case of notation, engravers can also modify existing elements
 423 created by sibling engravers.  Eg. the beam-engraver will modify stems
 424 when it creates a beam over a couple of stems.  This is done in
 425 Engraver::do_acknowledge_element () and
 426 Engraver::do_process_acknowledged ().
 427
 428 In the case of audio, there are no mechanisms to modify existing audio
 429 elements. After the audio elements are created, they are sent directly
 430 to the enclosing context (an instance of Performer_group_performer),
 431 through the method Performer::play ()
 432
 433 Concretely spoken, for dynamics you have to write a performer
 434 (Dynamics_performer), that will take the input requests. If I
 435 understand correctly, every MIDI note played must have its dynamic
 436 strength set separately.  That means the the Dynamics_performer must
 437 set the strength of every Audio_note it finds.  This means that one
 438 has to modify existing Audio items.  The best way of doing this is
 439 with a broadcast/acknowledge process.
 440
 441 So the best way of handling this, is
 442
 443   1 supporting dynamic settings in Audio_note
 444
 445   2 mimicking the broadcast/acknowledge mechanism of the Engravers in
 446   the Performers
 447
 448   3 using that mechanism to write a Dynamics_performer that will modify
 449   any notes it finds to set appropriate strengths.
 450
 451 You could also kludge this by deriving from Performer_group_performer
 452 a performer that also sets dynamics within notes, but that is not the
 453 elegant way to do it.
 454
 455 I'd say that the work involved is not hard, but you have to be fluent
 456 with C++ and need some insight into the working of Notation Contexts
 457 and friends.  I guess I could do it in a day or so, but if you are not
 458 so fluent with the inner workings of LilyPond, it could take you some
 459 more time (A few more days?).
 460
 461 Please note, that I am *not* going to code this myself: my days are
 462 valuable, and I think I have more interesting things to do than fixing
 463 the MIDI output (I don't even have a soundcard).  But I *do* want to help
 464 you or other people with implementing this, so if you need help, don't
 465 hesitate to ask.
 466
 467 .  * account for rhythmic position in measure
 468 .  * etc.
 469
 470 . * grace notes
 471 .  * make separate class for Grace_*_engravers
 472         (which is at Voice_gravs level)
 473 .  * make encapsulated spacing problems.
 474
 475 . * accidentals per Voice_group
 476
 477 . * Output class, handles : (smallish)
 478 .  * help text /(c) notice?
 479 .  * version line
 480 .  * warning /errors/progress
 481 .  * abort on error/warning; exit status
 482 .  * quiet/ignore-version options
 483 .  * logfile output
 484
 485 . * PS
 486 .  * speed up PS code.
 487 .  * PS lines to .eps files
 488 .  * write custom prolog
 489
 490 . * SGML input
 491
 492 . * Documentation
 493 .  * remove links to non-free SW.
 494 .  * internal documentation
 495 .  * a general paper.
 496 .  * \properties
 497 .   * left/rightbeamcount
 498 .   * various other new properties.
 499 .  * introduction?
 500 .  * info?
 501 .  * LaTeX?
 502 .  * more manpages?
 503 .  * Doc (C) stuff of sheet music
 504 .  * a better format?  SGML?  TeX?  Info?
 505 .  * a better tutorial
 506
 507 . * more spanners (smallish)
 508 .  * Glissando
 509 .  * trill
 510
 511 . * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
 512 .  * [c8. c32 c32]
 513 .  * doc on Rhythmic_grouping
 514 .  * general shaving on Beam and Stem
 515 .  * use plet grouping
 516 .  * separate visual from rhythmic info even more
 517 .  * beams over bars
 518
 519 . * lines:
 520 .  * Ledger lines, should be separate item: Ledger_lines
 521 .  * set different line sizes / thicknesses
 522 .  * beam stem showthrough, inter beam sizes (french vs german style)
 523
 524 . * Collisions
 525 .  * left/right note balls should be handled by Collision:
 526         < \multi 2; { \stem 1; <b c> } { <f as b> } >
 527
 528 . * Keys:
 529 .  * merge key{item} & localkey{item}?
 530 .  * spacing, national styles?
 531
 532 . * Support for TAB
 533 .  * redo Notehead to allow digits as heads
 534 .  * add a \tablature {} lexer mode for easy entering
 535
 536 . * should adjust stemlength for flag number.
 537
 538 . * breaking:
 539 .  * caching breakpoints
 540 .  * saving them
 541 .  * specify number of lines
 542
 543 .* INPUTLANGUAGE
 544 . * \rhythms 4 16 16 16 16; c c c c c -> c4 c16 etc.
 545 . * Language:
 546 .  * \type -> \context ?
 547 .  * \translator -> ?
 548 .  * fix \partial
 549 .  * \bla {} vs \bla ;
 550 .  * mix engraver hacking with music ?
 551 .  * \once\property  KEY = VAL
 552 .  * \addtranslator, \removetranslator
 553 .  * junk ^ and _ for scripts
 554 .  * junk _ for lyrics.
 555 .  * abstract grammar.
 556 . * Figure out semicolons.
 557 . * c4 4 4 4 for c4 c4 c4 c4?
 558 . * <c f a>4 ?
 559 . * Viola mode?
 560
 561                 @c c g e g
 562         for
 563                 c g es g,
 564
 565                 @A c g e g
 566         for
 567                 cis gis e gis
 568 . * configure pitch_byte
 569 . * rest name configurable
 570
 571
 572 .* SMALLISH PROJECTS
 573
 574 . * fix confusing naming in Engraver vs Engraver_group_engraver (context)
 575
 576 . * progress when creating MIDI elts.
 577
 578 . * A range for context errors (eg. mark both { and }. )
 579
 580 . * lyric in staff  (sharpsharp in staff, text below)
 581
 582 . * half sharps/flats
 583
 584 . * write Dynamic_line (to group dynamics horizontally)
 585
 586 . * use Real for all y positions.
 587
 588 . * half-sharps, half-flats
 589
 590 . * adaptive accidental spacing.
 591
 592 . * handle EOF graciously in error messages.
 593
 594 . * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
 595
 596 . * stafftypes: voice names/ instrument names.
 597
 598 . * lily \tempo
 599
 600 . *   % toe to bheel   four to five
 601             %   ^_u            4_5
 602             %     -
 603             %  --|x--         --|x--
 604             %  --|---         --|---
 605             %  --|---         --|---
 606           (where "to" is a tiny bow)
 607
 608 . * auxilliary file for caching info.
 609
 610 . * Text_crescendo
 611
 612 . * revise calcideal
 613
 614 .* IDEAS
 615 . * Output data structures of Mudela in XML/SGML.
 616 . * create libmudela, or liblily_frontend
 617 . * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
 618 . * Spacing_request for manually adjusting spacing
 619 . * caching breakpoints
 620 . * used fixedpoint arithmetic for min. energy.
 621 . * move towards incremental algorithms.
 622 . * versioning stuff (cvt mudela, mudela, etc.)
 623 . * dynamic loading of engravers?
 624 .* SMOBS
 625 Han-Wen Nienhuys <hanwen@cs.uu.nl> writes:
 626
 627 >       class Foo_class {
 628 >               Foo_smob *smob_ptr_;
 629 >       }
 630 >
 631 >       struct Foo_smob {
 632 >               Foo_class *class_ptr_
 633 >       }
 634
 635 Usually you can get away without having this interlinked structure.
 636 One piece of information you need when exporting objects to scheme is
 637 the smob tag for your class.  You might store this value (a long) into
 638 a class static variable, or a file static variable.  I'll use a class
 639 static variable in this example.
 640
 641 I typically use code that works like this (untested code ahead):
 642
 643 class Foo_class {
 644     static long *Foo_smob_tag;
 645     SCM obj; // representation as a scheme object, description comes later
 646 }
 647
 648 // call this once on startup
 649 void init_Foo_class {
 650     static scm_smobfuns type_rec;
 651
 652     type_rec.mark = foo_mark;
 653     type_rec.free = foo_free;
 654     type_rec.print = foo_display;
 655     type_rec.equalp = 0;
 656     Foo_class::Foo_smob_tag = new int(scm_new_smob(type_rec));
 657 }
 658
 659 When you want to export an object to scheme, you put a pointer to the
 660 object itself in the cdr of the cell, and the tag in the car of the
 661 cell.  The code looks like this:
 662
 663 // Is this a Foo?
 664 static int
 665 foo_p(SCM obj)
 666 {
 667     return(SCM_NIMP(obj) && SCM_CAR(obj) == Foo_class::Foo_smob_tag);
 668 }
 669
 670 // given a Scheme representation, return, a C++ representation
 671 static Foo_class *
 672 foo_unbox(SCM obj)
 673 {
 674     return((Foo_class*)SCM_CDR(obj));
 675 }
 676
 677 // the SCM representation of the object is stored inside itself
 678 // this will become useful when destructor gets called
 679 static SCM
 680 foo_box(Foo_class *foo)
 681 {
 682     SCM_DEFER_INTS;
 683     SCM_NEWCELL(foo->obj);
 684     SCM_SETCAR(foo->obj, Foo_class::Foo_smob_tag);
 685     SCM_SETCDR(foo->obj, (SCM)foo);
 686     SCM_ALLOW_INTS;
 687     return foo->obj;
 688 }
 689
 690 > C++ determines life time, so what is the strategy?
 691
 692 What happens now when the destructor gets called?  Lets set the cdr to
 693 NULL, and then check for that in all of the primitive functions that
 694 use your smob.  We'll call this notion 'live'; a scheme object is
 695 'live' if the C++ representation still exists, it's dead if the C++
 696 object is gone.  You can still have references to dead objects in
 697 scheme code; it's just an error to use them.  This idea is stolen from
 698 Emacs's handling of buffers ('buffer-live-p' and friends).
 699
 700 Add another function, foo_live_p:
 701
 702 static int
 703 foo_live_p(SCM obj)
 704 {
 705     return(foo_p(obj) && SCM_CDR(obj) != NULL);
 706 }
 707
 708 In you destructor, you need to do:
 709
 710 ~Foo_class()
 711 {
 712     SCM_CDR(this->obj, NULL);
 713 }
 714
 715 When writing new primitives, now just check foo_live_p().
 716
 717 I hope the above helps,
 718
 719 -russ
 720
 721
 722 --
 723 "Even if you are on the right track, you'll get run over
 724 if you just sit there."
 725              --Will Rogers (1879-1935)
 726
 727 * OUTLINE SETUP
 728 .* .EMACS
 729 ;;; from outline.el
 730 (defvar outline-font-lock-keywords
 731   '(;; Highlight headings according to the level.
 732     ;; must change this to allout node layout
 733     ;;("^\\(\\*+\\)[ \t]*\\(.+\\)?[ \t]*$"
 734     ("^\\([.]*[ ]*[*]\\)[ \t]*\\(.*\\)$"
 735      (1 font-lock-string-face)
 736      (2 (let ((len (- (match-end 1) (match-beginning 1))))
 737           (or (cdr (assq len '((1 . font-lock-function-name-face)
 738                                (2 . font-lock-keyword-face)
 739                                (3 . font-lock-comment-face))))
 740               font-lock-variable-name-face))
 741         nil t))
 742     ;; Highlight citations of the form [1] and [Mar94].
 743     ("\\[\\([A-Z][A-Za-z]+\\)*[0-9]+\\]" . font-lock-type-face))
 744   "Additional expressions to highlight in Outline mode.")
 745
 746 (add-hook 'outline-mode-hook
 747           '(lambda ()
 748             (setq font-lock-maximum-decoration t)
 749             (setq font-lock-maximum-decoration t)
 750             (make-local-variable 'font-lock-defaults)
 751             (setq font-lock-defaults '(outline-font-lock-keywords t))
 752             (font-lock-mode global-font-lock-mode)
 753         ))
 754
 755 (require 'allout)
 756 (outline-init 't)