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 . * .ly files
  13 .  * input/star-spangled-banner
  14 .  * mutopia/J.S.Bach/wtk1-fugue2.ly
  15 .  * input/test/grace
  16 .  * fix: text on rests: ridiculous dims
  17 . * m=\notes\relative c''{
  18
  19 c1 | \break
  20 R1*5 |
  21 r2 r4 \bar "||"; \break r |
  22 c2 c |
  23 }
  24
  25 \score{
  26   \type StaffGroup <
  27       \type Staff = staffi {\m}
  28       \type Staff = staffii {\m}
  29     >
  30 }
  31 . * m=\notes\relative c'''{
  32   \time 2/4;
  33
  34   R2*4 | c2 | c2 | c2 | c2 | c2 | c2 | c2 | c2 | c2 | \break
  35   <{R2*10}{s2 \mark "A"; }> | % Too narrow space for the first rest in
  36 1.1.29
  37   r4 r8 [g16 \p ( a ] |
  38 [ ) g8-. fis16 ( g ][ ) fis8-. f16 ( g ] |
  39 [ ) f8-. e16 ( f ][ ) e8-. es16 ( f ] |
  40 [ ) es8 \f c16 ( d][es8 d16 c ] |
  41 ) d4 r8 [g16 \p ( a ] |
  42 [ ) g8-. fis16 ( g ][ ) fis8-. f16 ( g ] | \break
  43 ) c2 | c2 | c2 | c2 | c2 | c2 | c2 | c2 | c2 |
  44 }
  45
  46 \score{
  47   \m
  48   \paper{
  49     \translator{
  50       \ScoreContext
  51       SkipBars = 1;
  52     }
  53     \translator {
  54       \OrchestralPartStaffContext
  55     }
  56   }
  57 }
  58 . * - Look at input/test/span-bars.ly. The staff lines extend too far
  59   to the left on the note systems including the GrandStaff.
  60 . * fix midi output:
  61 .  * default duration?  d
  62      duration must be not entered explicitely on first note.
  63 . * fix singleStaffBracket
  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 . * minVerticalAlign for StaffGroups.
  74 . * declaring \score
  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
  83 .* TODO before 1.2
  84 . * Check gcc 2.8.1 compatibility
  85 . * make "in-between" engraver (Tie, Extender)
  86 . * use Drul_array for Interval.
  87 . * compulsory hshift
  88 . * ties to tie only notes of the same pitch, so that
  89         < a~  a,>  a
  90 works as you'd expect it to.
  91 . * 1. Can Lily be told where to start numbering?
  92 . * do scaled fonts.
  93 . * profile atom smobs
  94 . * Try to use Killing_cons iso. Pointer_list
  95 . * make dependencies () a virtual function.
  96 . * fix Repeated_music design
  97 . * one big ly2dvi input that includes *all* tests.
  98 . * Don't use boolean properties (0,1), instead check existence
  99 of property.
 100 . * store req -> element, element -> element causes for warnings
 101 . * junk Text_def, use G_text_item in stead.
 102 . * junk Script_def
 103 . * fix partial measures in meaningful way.
 104 . * fix AFM for BlueSky AFM files.
 105 . * working notehead style.
 106 . * add scripts to bars eg.  |^"bla"
 107 . * relative mode for mi2mu
 108 . * uniformise recent feta contributions.
 109 .  * use SCM and Molecules for {accordeon stuff, }
 110 .  * bigger and fatter 4/4 C
 111 . * sort out directory stuff.
 112 .  * --prefix option?
 113 .  * -I option per filetype?
 114 .  * kpathsea?
 115 . * todo doc left/rightbeamcount
 116 . * doc Single_malt_grouping_item
 117 . * ly2dvi/lilypond logfile.
 118 . * How can I specify a chord whose duration is longer than a whole note?
 119  \type ChordNames { \chord{ A1*2-min } }
 120
 121 gives me a parse error.  And \times doesn't work either.  I can't use
 122 a spacer note.  So it seems to be impossible to have long chords of
 123 general length.  Of course, in the example above I can use \breve.
 124 But what if I want a chord that lasts for 3 whole notes?  Or what
 125 about 2.5 whole notes?  Is there a mechanism for getting this kind of
 126 length?
 127
 128
 129
 130 Use of semicolons is still rather confusing.  They are obligatory
 131 after some types of assignments and illegal after others.
 132
 133   \property foo=bar               illegal
 134   foo = 3 at top level            illegal
 135   foo = 3 inside \paper           obligatory
 136   foo = \notes{ ...} top level    illegal
 137   foo = \translator{ } in \paper  obligatory
 138
 139 As far as I can tell, the sole accomplishment of this syntactic
 140 irregularity is to keep the user as confused as possible.
 141
 142
 143 I was trying to get interstaff beams to work and did this:
 144
 145 \score{
 146 \type GrandStaff <
 147 \type Staff=one \notes\relative c'{
 148   \stemup
 149   [c8 c \translator Staff=two \stemup c c]
 150   \translator Staff=one
 151   \stemdown
 152   [ b8 \translator Staff=two a8]
 153   \translator Staff=one
 154   c4
 155   }
 156 \type Staff=two \notes{ \clef bass; s1 }
 157 >
 158 \paper{
 159                 \translator{
 160                         \GrandStaffContext
 161                         minVerticalAlign = 3.0*\staffheight;
 162                         maxVerticalAlign = 3.0*\staffheight;
 163                 }
 164   linewidth = -1.;
 165 }
 166 }
 167
 168 The beams are at the right angle, but they aren't in the right place.
 169 . * fractional chord durs.
 170 . * hang Item on Spanner
 171 . * remove Interval dim_ from Dimension_cache and rename the struct.
 172 . * do --safe for PS output?
 173 . * convert-mudela --output
 174 . * Staff_margin (with a partial measure.)
 175 . * fix pletvisibility properties:
 176 .  * bracket on/off/no-bracket-when-beam
 177 .  * num on/off/no-num-when-beam
 178 . * fix: standchen.
 179 . * junk backlinks?
 180 . * junk text{sharp,flat,etc}
 181 . * fix convert-mudela manpage
 182 . * decimal point in \paper {}
 183 . * {  \voiceone <a'4.*2/3  d''4.*2/3 fis''4.*2/3>  [g''8 fis'' e''] d''4 |}
 184          and=20
 185          { \voicetwo  d'4 d'2.*2/3 } spacing
 186 . * tied notes for MIDI
 187 . * sharp /flat on trills (in MIDI ??)
 188 . * scm-ify \property values.
 189 . * move class Lookup {} into scm
 190 . * collisions/voices \voiceone \voicetwo are broken; see
 191 . * msgfmt -o check?
 192 . * \breathmark TeX macro
 193 . * catch GUILE errors?
 194 . * add new glyphs to font.ly
 195 . * formatting of input stuff.
 196 . * \notes{ a \< b \cr } vs \notes{ a \< b \! }
 197 . * if possible, it might be nice for a warning to appear if someone does
 198         \translator with no name and without assigning it to an
 199         identifier.
 200 . * space after bars?
 201 . * 'hinterfleisch' before bar (e.g. wtk1-fugue2)?
 202 . * \type Voice \times 2/3 { [c8 c16 c16 c16 c16] }
 203 . * repeat bars: need distance after ":|" and before "|:"
 204 . * Summary of minor spelling irregularities:
 205 .  *  capitalization/use of underscores in property names
 206 .  * fix SkipBars  -> skipBars
 207
 208 . * broken scripts:
 209         lbheel = \script { "bheel" 0 0 -1  0 0 }
 210         rbheel = \script { "bheel" 0 0 1 0 0 }
 211         lbtoe = \script { "btoe" 0 0 -1 0 0 }
 212         rbtoe = \script { "btoe" 0 0 1 0 0 }
 213         lfheel = \script { "fheel" 0 0 -1  0 0 }
 214         rfheel = \script { "fheel" 0 0 1 0 0 }
 215         lftoe = \script { "ftoe" 0 0 -1 0 0 }
 216         rftoe = \script { "ftoe" 0 0 1 0 0 }
 217         and also
 218         portato= \script { "portato" 0 -1 0 1 0 }
 219 . * ly2dvi
 220 .  * bottomnote for ly2dvi
 221 .  * cf'able ly2dvi  tagline.
 222 .  * deps for ly2dvi
 223 .* STUFF
 224 . * check out legal/(c) matters for scores.
 225 . * Align_element::padding  ?
 226 . * uniformise property names...
 227 .  * ydirection <-> yDirection
 228 .  * rather allow '_' in identifiers first (i.e. junk ^ and _),
 229             and do y_direction?
 230 .  * typo checks on property names?
 231 . * use streambufs and iostream
 232         to provide IO handling for TeX stream, mudela stream, data-file.
 233 . * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
 234 . * strip EXEs before installing
 235 . * zip target for binary windows dist (JBR)
 236 . * junking \skip req in lyrics
 237 . * Language:
 238 .  * \type -> \context ?
 239 .  * \translator -> ?
 240 .  * fix \partial
 241 .  * \bla {} vs \bla ;
 242 .  * mix engraver hacking with music ?
 243 .  * \once\property  KEY = VAL
 244 .  * \addtranslator, \removetranslator
 245 .  * junk ^ and _ for scripts
 246 .  * junk _ for lyrics.
 247 .  * abstract grammar.
 248 . * percussion note heads
 249 . * mi2mu empty staffs.
 250 . * horizontal centering of dynamics
 251 . * gzip RH manpage
 252 . * stable make/config stuff
 253 . * $DEPENDENCIES_OUTPUT support
 254 . * Xdvi zooming ?! Try to understand GS garbage collection.
 255                 gs: Error: /undefined in draw_beam
 256                 gs: Operand stack:
 257 . * fix vertical alignment and stafflines
 258 . * GrandStaff needs more work -- I want a single word
 259         `harpsichord' to the left of the grandstaff, not one on each
 260         stave.  (Organ staff -- with separate pedal -- but common
 261         properties may be something to think about.  Of course for
 262         organ you want to be able to give stop indications on the way
 263         through, so the \property Voice.Instrument would be a stop,
 264         and \property GrandStaff.instrument would be PipeOrgan...)
 265 . * revise the Score_priority_align_engraver concept.  It sucks.
 266 . * make new VoiceOne, VoiceTwo, VoiceThree contexts with
 267 ydirection and hshift preset
 268 . * *.yo: fix pod manpage layout legacy
 269 . * text-items clash with stems/beams
 270 . * --include, -I option for ly2dvi (pass on to lily)
 271 . * fix placement of beam-less abbrev
 272 . * \meter 3/4;
 273         <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
 274          {\voicetwo cis,4 r r | r2. | r1 }> |
 275         }
 276 . * try to use template<Type> iso MACRO(Type)
 277 .  * Musical_pitch (analogous to Duration and Rhythmic_req)
 278           think about, analogous to pitch:
 279            * { a4 a16 } c <-- duration of c?
 280            * < a4 b8 > c <-- duration of c?
 281 . * \tempo 4. = 90;
 282 . * fix audio-items (don't use (input) requests, but copy data)
 283 . * make sure all ex's have a mudela-version
 284 . * do rest-collisions for Multi_measure_rests as well.
 285 . * split error/warning in error/warning/non_fatal_error
 286 . * add a Duration_convert member to Duration_iter to set parameters.
 287         Junk global duration settings.
 288 . * minimum length second part broken tie
 289 . * en-,discouraged linebreaking:
 290 .  * handle DISALLOW < penalty > FORCE
 291 .  * discourage breaking of slurs
 292 . * fix variable define/lookup parser global<->paper
 293 . * fix title/instrument placements; see input/test/title.ly
 294 . * <\voiceone c4. \voicetwo c4>
 295 . * add full cello suites to web site (kom op, Maarten!)
 296 . * Rethink Time_description
 297           * \cadenza , \meter, \grouping should all be \properties
 298 . * rename
 299 .  * measure -> bar
 300 .  * abbrev -> tremolo
 301 .  * abbreviation-beam -> (measured/unmeasured) tremolo
 302 .  * partial -> anacrouse
 303 . * shared lib
 304 . * robustify Beam (in case of no stems, 32nd notes)
 305 . * decentralised spring factory
 306 . * move paper vars into engraver properties
 307 . * check for groff / troff/ nroff et
 308 . * more intelligent file searching
 309 . * make LilyPond RPM fully relocatable
 310 . * disable spaces in TeX stuff
 311 . * handle ^C for tmp/file creation.
 312 . * dots & rest collisions.
 313 . * documentation
 314 .  * introduction?
 315 .  * info?
 316 .  * LaTeX?
 317 .  * more manpages?
 318 . * versioning for Feta
 319 . * the warning about the negative slur/tie length appears twice
 320         which is irritating.
 321 . * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
 322         in the middle:
 323 . * the bracket is ugly (wings are too parabolic, should be more circular)
 324 . * better hshift (dots, distance, head dependent)
 325 . * clefs (AG): The "8" should appear closer to the actual clef,
 326 touching it.
 327 . * put errorlevel in Input class
 328 . * junk nesting slurs
 329 . * integrate midi-elts from mi2mu and lily?
 330 .* 3RD PARTY BUGS
 331 . * GNU diff 2.7: diff -rN does not see a new directory with empty file
 332 . * check out GCC signatures?
 333 . * glibc 2.0:
 334           f = fopen ("/dev/null", "r")
 335           assert (feof (f))
 336 .* 3RD PARTY PROJECTS:
 337 . * make GCC warn about ctor that leaves member vars  uninitialised.
 338 . * GNU patch
 339 .  * 'double-fix' mode: ignore identical fix, rather than suggest
 340             to revert patch direction when (more or less? exactly) the same
 341             thing is fixed
 342 .* PROJECTS
 343 . * Scripts:
 344 .  * fix position of bar number
 345 .  * stack scripts in chords:
 346           % fingering:        footing:
 347             < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
 348 .  * script-spacing
 349 .  * slur parts as a script
 350 .  * stack parameterised scripts for fingering and footing:
 351
 352 . * convert-mudela:
 353 .  * automatically add  a \version if not present.
 354 .  * better parsing
 355 .  * make smarter
 356 .  * convert-mudela -e empty.ly
 357
 358 . * emacs mudela-mode
 359 .  *  should handle block comments too.
 360 .  *  handle lexer modes (\header, \melodic, \lyric) etc.
 361 .  *  indentation
 362 .  *  notenames?
 363 .  *  fontlock: \melodic \melodic
 364
 365 . * use properties for:
 366 .  * Staff_sym size
 367 .  * default tempo.
 368 .  * cadenza mode?
 369
 370 . * page handling:
 371 .  * PS output
 372 .  * optimal pagebreaking.
 373
 374 . * Unicode support? -> man 7 unicode
 375 .  * 16 bit Strings
 376 .  * -u switch
 377 .  * detect of 16/8 bit files
 378 .  * examples to go with it.
 379
 380 . * Spring_spacer:
 381 .  * write a faster Spring_spacer (without matrices if possible)
 382 .  * relate energybound to linelen unitspace fontsize etc.
 383 .  * used fixed point fp?
 384
 385 . * \header
 386 .  * output header info to MIDI too.
 387
 388 . * a musical dictionary. See Documentation/vocabulary-*, other
 389         languages:
 390 .  * explanations
 391 .  * italian
 392 .  * german
 393 .  * dutch
 394 .  * swedish
 395          .. ?
 396
 397 . * chords
 398 .  * guitar chords (fret diagrams)
 399 .  * other chord name styles (american(?) style)
 400 .  * basso continuo
 401 .  * MIDI output?
 402
 403 . * Debug logs:
 404 .  * derive lily_stream, Dstream, texstream from ostream?
 405 .  * indentable stream as baseclass for TeX stream, lily stream, Dstream.
 406 .  * use dstream feature in mi2mu
 407 .  * integrate IO checking into stream class
 408
 409 . * input converters
 410 .  * NIFF?
 411 .  * ABC?
 412 .  * SMDL?
 413
 414 . * add to MIDI output:
 415 .  * tempo change
 416 .  * ornaments (and trills?)
 417 .  * repeat/volta
 418 .  * slurs
 419 .  * accents
 420 .  * dynamics
 421 .  * account for rhythmic position in measure
 422 .  * etc.
 423
 424 . * grace notes
 425 .  * make separate class for Grace_*_engravers
 426         (which is at Voice_gravs level)
 427 .  * make encapsulated spacing problems.
 428
 429 . * accidentals per Voice_group
 430
 431 . * Output class, handles : (smallish)
 432 .  * help text /(c) notice?
 433 .  * version line
 434 .  * warning /errors/progress
 435 .  * abort on error/warning; exit status
 436 .  * quiet/ignore-version options
 437 .  * logfile output
 438
 439 . * PS
 440 .  * speed up PS code.
 441 .  * PS lines to .eps files
 442 .  * write custom prolog
 443
 444 .  * NIFF ?
 445 .  * Common Music Notation
 446 .  * PostScript output (esp. Beams, Slurs, etc)
 447 .  * Move all Score_elems, into libmutype.a
 448 .  * SGML
 449
 450 . * Documentation
 451 .  * Doc (C) stuff of sheet music
 452 .  * a better format?  SGML?  TeX?  Info?
 453 .  * a better tutorial
 454
 455 . * more spanners (smallish)
 456 .  * Glissando
 457 .  * trill
 458
 459 . * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
 460 .  * [c8. c32 c32]
 461 .  * doc on Rhythmic_grouping
 462 .  * general shaving on Beam and Stem
 463 .  * use plet grouping
 464 .  * separate visual from rhythmic info even more
 465 .  * beams over bars
 466
 467 . * lines:
 468 .  * Ledger lines, should be separate item: Ledger_lines
 469 .  * set different line sizes / thicknesses
 470 .  * beam stem showthrough, inter beam sizes (french vs german style)
 471
 472 . * Collisions
 473 .  * left/right note balls should be handled by Collision:
 474         < \multi 2; { \stem 1; <b c> } { <f as b> } >
 475
 476 . * Keys:
 477 .  * merge key{item} & localkey{item}?
 478 .  * spacing, national styles?
 479
 480 . * Support for TAB
 481 .  * redo Notehead to allow digits as heads
 482 .  * add a \tablature {} lexer mode for easy entering
 483
 484 . * should adjust stemlength for flag number.
 485
 486 . * breaking:
 487 .  * caching breakpoints
 488 .  * saving them
 489 .  * specify number of lines
 490
 491 .* INPUTLANGUAGE
 492
 493 . * c4 4 4 4 for c4 c4 c4 c4?
 494 . * <c f a>4 ?
 495 . * Viola mode?
 496
 497                 @c c g e g
 498         for
 499                 c g es g,
 500
 501                 @A c g e g
 502         for
 503                 cis gis e gis
 504 . * configure pitch_byte
 505 . * rest name configurable
 506
 507
 508 .* SMALLISH PROJECTS
 509
 510 . * fix confusing naming in Engraver vs Engraver_group_engraver (context)
 511
 512 . * progress when creating MIDI elts.
 513
 514 . * A range for context errors (eg. mark both { and }. )
 515
 516 . * lyric in staff  (sharpsharp in staff, text below)
 517
 518 . * half sharps/flats
 519
 520 . * write Dynamic_line (to group dynamics horizontally)
 521
 522 . * use Real for all y positions.
 523
 524 . * half-sharps, half-flats
 525
 526 . * adaptive accidental spacing.
 527
 528 . * handle EOF graciously in error messages.
 529
 530 . * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
 531
 532 . * stafftypes: voice names/ instrument names.
 533
 534 . * lily \tempo
 535
 536 . *   % toe to bheel   four to five
 537             %   ^_u            4_5
 538             %     -
 539             %  --|x--         --|x--
 540             %  --|---         --|---
 541             %  --|---         --|---
 542           (where "to" is a tiny bow)
 543
 544 . * auxilliary file for caching info.
 545
 546 . * Text_crescendo
 547
 548 . * clean solution for staffsize in items.
 549
 550 . * revise calcideal
 551
 552 .* IDEAS
 553 . * Output data structures of Mudela in XML/SGML.
 554 . * create libmudela, or liblily_frontend
 555 . * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
 556 . * Spacing_request for manually adjusting spacing
 557 . * caching breakpoints
 558 . * used fixedpoint arithmetic for min. energy.
 559 . * move towards incremental algorithms.
 560 . * versioning stuff (cvt mudela, mudela, etc.)
 561 . * dynamic loading of engravers?
 562 .* SMOBS
 563 Han-Wen Nienhuys <hanwen@cs.uu.nl> writes:
 564
 565 > mcmanus@IDT.NET writes:
 566 > > > I want different C++ objects (with scheme embedded) to be linked by
 567 > > > C++ pointers.  I want to access these other objects from the Scheme
 568 > > > code, and I want access to these pointers from C++.
 569 > >
 570 > > You can do this with a  combination of smob's and primitive functions,
 571 > > though it may not be  be exactly what you wanted.   You would have one
 572 > > smob  for each class in  your application, and then  you would write a
 573 > > primitive function that would return the objects  that are linked to a
 574 > > base object.
 575 >
 576 > And the smob and the C++ class are interlinked?  Like
 577 >
 578 >       class Foo_class {
 579 >               Foo_smob *smob_ptr_;
 580 >       }
 581 >
 582 >       struct Foo_smob {
 583 >               Foo_class *class_ptr_
 584 >       }
 585
 586 Usually you can get away without having this interlinked structure.
 587 One piece of information you need when exporting objects to scheme is
 588 the smob tag for your class.  You might store this value (a long) into
 589 a class static variable, or a file static variable.  I'll use a class
 590 static variable in this example.
 591
 592 I typically use code that works like this (untested code ahead):
 593
 594 class Foo_class {
 595     static long *Foo_smob_tag;
 596     SCM obj; // representation as a scheme object, description comes later
 597 }
 598
 599 // call this once on startup
 600 void init_Foo_class {
 601     static scm_smobfuns type_rec;
 602
 603     type_rec.mark = foo_mark;
 604     type_rec.free = foo_free;
 605     type_rec.print = foo_display;
 606     type_rec.equalp = 0;
 607     Foo_class::Foo_smob_tag = new int(scm_new_smob(type_rec));
 608 }
 609
 610 When you want to export an object to scheme, you put a pointer to the
 611 object itself in the cdr of the cell, and the tag in the car of the
 612 cell.  The code looks like this:
 613
 614 // Is this a Foo?
 615 static int
 616 foo_p(SCM obj)
 617 {
 618     return(SCM_NIMP(obj) && SCM_CAR(obj) == Foo_class::Foo_smob_tag);
 619 }
 620
 621 // given a Scheme representation, return, a C++ representation
 622 static Foo_class *
 623 foo_unbox(SCM obj)
 624 {
 625     return((Foo_class*)SCM_CDR(obj));
 626 }
 627
 628 // the SCM representation of the object is stored inside itself
 629 // this will become useful when destructor gets called
 630 static SCM
 631 foo_box(Foo_class *foo)
 632 {
 633     SCM_DEFER_INTS;
 634     SCM_NEWCELL(foo->obj);
 635     SCM_SETCAR(foo->obj, Foo_class::Foo_smob_tag);
 636     SCM_SETCDR(foo->obj, (SCM)foo);
 637     SCM_ALLOW_INTS;
 638     return foo->obj;
 639 }
 640
 641 > C++ determines life time, so what is the strategy?
 642
 643 What happens now when the destructor gets called?  Lets set the cdr to
 644 NULL, and then check for that in all of the primitive functions that
 645 use your smob.  We'll call this notion 'live'; a scheme object is
 646 'live' if the C++ representation still exists, it's dead if the C++
 647 object is gone.  You can still have references to dead objects in
 648 scheme code; it's just an error to use them.  This idea is stolen from
 649 Emacs's handling of buffers ('buffer-live-p' and friends).
 650
 651 Add another function, foo_live_p:
 652
 653 static int
 654 foo_live_p(SCM obj)
 655 {
 656     return(foo_p(obj) && SCM_CDR(obj) != NULL);
 657 }
 658
 659 In you destructor, you need to do:
 660
 661 ~Foo_class()
 662 {
 663     SCM_CDR(this->obj, NULL);
 664 }
 665
 666 When writing new primitives, now just check foo_live_p().
 667
 668 I hope the above helps,
 669
 670 -russ
 671
 672
 673 --
 674 "Even if you are on the right track, you'll get run over
 675 if you just sit there."
 676              --Will Rogers (1879-1935)
 677
 678 * OUTLINE SETUP
 679 .* .EMACS
 680 ;;; from outline.el
 681 (defvar outline-font-lock-keywords
 682   '(;; Highlight headings according to the level.
 683     ;; must change this to allout node layout
 684     ;;("^\\(\\*+\\)[ \t]*\\(.+\\)?[ \t]*$"
 685     ("^\\([.]*[ ]*[*]\\)[ \t]*\\(.*\\)$"
 686      (1 font-lock-string-face)
 687      (2 (let ((len (- (match-end 1) (match-beginning 1))))
 688           (or (cdr (assq len '((1 . font-lock-function-name-face)
 689                                (2 . font-lock-keyword-face)
 690                                (3 . font-lock-comment-face))))
 691               font-lock-variable-name-face))
 692         nil t))
 693     ;; Highlight citations of the form [1] and [Mar94].
 694     ("\\[\\([A-Z][A-Za-z]+\\)*[0-9]+\\]" . font-lock-type-face))
 695   "Additional expressions to highlight in Outline mode.")
 696
 697 (add-hook 'outline-mode-hook
 698           '(lambda ()
 699             (setq font-lock-maximum-decoration t)
 700             (setq font-lock-maximum-decoration t)
 701             (make-local-variable 'font-lock-defaults)
 702             (setq font-lock-defaults '(outline-font-lock-keywords t))
 703             (font-lock-mode global-font-lock-mode)
 704         ))
 705
 706 (require 'allout)
 707 (outline-init 't)