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 . * junk separate mudela versioning.
  13 . * indent = 0.0 with linewidth=-1.0
  14 . * PostScript
  15 .  * header for PS enteredby = "bla <bla@bar.com>"
  16 .  * ps/lily.ps see comments.
  17 . * By the way, I'm not sure the translation of 'C, G, and F clef'
  18 > should include Alto, Violin, Bass <clef translated>.
  19 [..]
  20
  21 I understand your point.  It should be changed.
  22
  23
  24 >
  25 > The terms C-clef, G-clef, F-clef stand for the signs, being
  26 > mutated forms of a C, a G and an F.
  27 >
  28 > The terms Violin Clef etc. stand for the signs being used in
  29 > special positions on the staff.
  30 >
  31 > The G-clef-sign indicates g' on the line around which the
  32 > snake centers. It is a Violin Clef if it is centered around the
  33 > second line (from below), and a French Violin Clef if it is
  34 > centered around the lowest.
  35 >
  36 > The C-clef indicates c' on the line that gets
  37 > 'pinched' by it. It is a Soprano, Mezzosoprano (English?), Alto, Tenor
  38 > and (don't remember exactly, maybe Baritone) Clef, depending on
  39 > the line (from highest to lowest).
  40 >
  41 > The F-clef-sign indicates f on the line between
  42 > the two dots. If it's on the second line from above, it is called
  43 > Bass Clef. If it's on the middle line, it is called (maybe
  44 > Baritone) Clef too, because it indicates the same pitches as the
  45 > C-Clef on the highest line. So, you could write an Alto Clef by
  46 > putting the F-clef sign on the lowest line (but that's _very_
  47 > uncommon).
  48 >
  49 > Sorry, this is written very messy because I'm in a hurry,
  50 > but I hope you understand what I want to say.
  51 >
  52 . * didot / big point.
  53 . * midi key.
  54 . * Repeats
  55 .  * input/bugs/rep.ly (moved from test)
  56 .  * unfold broken:
  57 .   * without alternatives: repeat unfold 4 { a b c d }
  58 .   * count > alternatives: repeat unfold 79 { a b c d }
  59 \alternative { { c c c c } { d d d d } }
  60 .  * kind of 'initial property' iso fold/volta(semi)/unfold strings
  61 . * fix singleStaffBracket
  62 . * declare performers in \midi
  63 . * fix MIDI
  64 . * \shape 1st dim skipped?
  65 . * turn slope-damping on/off
  66 . * We need feta-din*.mf files for more sizes than 10.
  67 . * fix dynamics decently, ie. use kerning & ligatures.
  68 . * dots & rest collisions?
  69 . * mudela-book.py
  70 .  * fix \mudelafile{} to have decent functionality
  71 .  * P.P.S. It can be cool in mudela-book to distinguish in
  72 pre,postMudelaExample, whether MudelaExample is epsed or not: ( if
  73 this fragment is floating eps, than 1, otherwise 2). say
  74 preMudelaExample[eps]{}, and change it in document body sometimes.
  75 .  * use less RE's
  76 . * slurs colllide with lyrics.
  77 . * Is there any reasonable way to do this: I would like to have one file
  78 that can generate the same tune in two different modes without having
  79 to go through and rewrite all the music in the other mode.
  80
  81 Lyrics and scripts collide.
  82 . * Phrasing:  Indicating the textual underlay of a piece, or
  83 otherwise dividing a piece into phrases.
  84
  85 There are distinct ways of specifying the first two (although at
  86 present, they're not properly distinguished) but no distinct way to
  87 specify the third.  Should there be?
  88 . * rest collision minimum dist.
  89 . * a note with a circle after it, meaning:
  90
  91    note + circle = note + 1/4 of its length
  92
  93    the circle is like a dot that's not filled in.  for example, on
  94    page three, the c-sharp on the second line should be a quarter with
  95    a circle, not a quarter tied to a sixteenth.  is this at all
  96    possible with lily?
  97 . * tuplets that are written as "number : note", for example
  98    "3 : [image of a half note here]".  possible?
  99 . * repeat engraver, gallina.ly
 100
 101 . * Matanya's tips:
 102 .  * accidentals closer to note head
 103 .  * to space the staffs/staffgroups contained in the score.
 104 .  * heavier beams?
 105
 106 .* Cleanups needed
 107 . * Beam
 108 . * Stem
 109 . * Slur
 110 . * Rhythmic_grouping
 111 . * Duration
 112 . * clef engraver
 113 . * parser
 114
 115 .* TODO before 1.2
 116 . * Morally pure LilyPond.
 117 .  * Remove non-free software links.
 118 .  * Remove meta article LilyPond.
 119 . * break priority setting from SCM.
 120 . * Gade score
 121 .  * remove [] in favour of auto-beamer
 122 . * hangOnClef with non-breakable clefs.
 123 . * Aha, the problem is the new TeX code generation for changing fonts.
 124 > (The explanation below is mostly intended for Han-Wen and Jan)
 125 > Before, the font was changed with macros declared separately for
 126 > pure TeX and LaTeX, but now all the fonts are declared directly in
 127 > the generated code using the low-level TeX commands. This circumvents
 128 > the fontencoding mechanism of LaTeX and is a potential source of
 129 > problems also for us users of the Latin-1 character set.
 130 > I think it still works since the inputencoding latin1 is
 131 > declared by ly2dvi, but it still means that e.g. an o with
 132 > umlaut is typeset as a combination of the two symbols 'o' and
 133 > 'umlaut' instead of as a single character, as would be the case
 134 > if fontencoding OT1 had been used. This shouldn't give any
 135 > difference in layout, though. One of the main argument for using
 136 > fontencoding OT1 is for the hyphenation mechanism to work, an
 137 > argument that's clearly irrelevant in our application. Yet we
 138 > see the problem for August.
 139 . * Abstraction for engravers:
 140 .  * make "in-between" engraver (Tie, Extender)
 141 .  * make wide_spanner_engraver (line_group_spanner, staff_symbol)
 142 . * remove Interval dim_ from Dimension_cache and rename the struct.
 143 . * do scaled fonts generally
 144 . * The Lilypond accidental symbols are available through the TeX macros,
 145 \textflat, \textsharp and \textnatural defined in the init file
 146 lilyponddefs.tex. All the symbols are defined in the files fetaXX.tex
 147 where XX corresponds to the size. I don't know where (or even if) they
 148 are installed but they are generated in the mf/out/ directory during the
 149 compilation.
 150 . * make dependencies () a virtual function.
 151 . * one big ly2dvi input that includes *all* tests.
 152 . * store req -> element, element -> element causes for warnings
 153 . * include examples in RPM.
 154 . * fix partial measures in meaningful way.
 155 . * add scripts to bars eg.  |^"bla"
 156 . * relative mode for mi2mu
 157 . * uniformise recent feta contributions.
 158 .  * use SCM and Molecules for {accordeon stuff, }
 159 .  * bigger and fatter 4/4 C
 160 . * sort out directory stuff.
 161 .  * --prefix option?
 162 .  * -I option per filetype?
 163 .  * kpathsea?
 164 . * ly2dvi/lilypond logfile.
 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 . * broken scripts:
 190         lbheel = \script { "bheel" 0 0 -1  0 0 }
 191         rbheel = \script { "bheel" 0 0 1 0 0 }
 192         lbtoe = \script { "btoe" 0 0 -1 0 0 }
 193         rbtoe = \script { "btoe" 0 0 1 0 0 }
 194         lfheel = \script { "fheel" 0 0 -1  0 0 }
 195         rfheel = \script { "fheel" 0 0 1 0 0 }
 196         lftoe = \script { "ftoe" 0 0 -1 0 0 }
 197         rftoe = \script { "ftoe" 0 0 1 0 0 }
 198         and also
 199         portato= \script { "portato" 0 -1 0 1 0 }
 200 . * ly2dvi
 201 .  * bottomnote for ly2dvi
 202 .  * deps for ly2dvi
 203
 204 .* STUFF
 205 . * compulsory hshift
 206 . * Give # lines in linebreaking.
 207 . * arrows on slurs.
 208 . * rewrite context defs using Scheme
 209 . * \selectmusic to cut pieces from music.
 210 . * TODO: merge atom & molecule; make  tree from molecule.
 211 . * Align_element::padding  ?
 212 . * typo checks on property names?
 213 . * use streambufs and iostream
 214         to provide IO handling for TeX stream, mudela stream, data-file.
 215 . * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
 216 . * strip EXEs before installing
 217 . * zip target for binary windows dist (JBR)
 218 . * junking \skip req in lyrics
 219 . * mi2mu empty staffs.
 220 . * use Fourier transformation for rhythmic quantisation.
 221 . * horizontal centering of dynamics
 222 . * $DEPENDENCIES_OUTPUT support
 223 . * fix vertical alignment and stafflines
 224 . * declaring Performers
 225 . * *.yo: fix pod manpage layout legacy
 226 . * text-items clash with stems/beams
 227 . * --include, -I option for ly2dvi (pass on to lily)
 228 . * fix placement of beam-less abbrev
 229 . * \meter 3/4;
 230         <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
 231          {\voicetwo cis,4 r r | r2. | r1 }> |
 232         }
 233 . * Musical_pitch (analogous to Duration and Rhythmic_req)
 234           think about, analogous to pitch:
 235            * { a4 a16 } c <-- duration of c?
 236            * < a4 b8 > c <-- duration of c?
 237 . * \tempo 4. = 90;
 238 . * fix audio-items (don't use (input) requests, but copy data)
 239 . * make sure all ex's have a mudela-version
 240 . * do rest-collisions for Multi_measure_rests as well.
 241 . * split error/warning in error/warning/non_fatal_error
 242 . * add a Duration_convert member to Duration_iter to set parameters.
 243         Junk global duration settings.
 244 . * en-,discouraged linebreaking:
 245 .  * handle DISALLOW < penalty > FORCE
 246 .  * discourage breaking of slurs
 247 . * fix variable define/lookup parser global<->paper
 248 . * fix title/instrument placements; see input/test/title.ly
 249 . * <\voiceone c4. \voicetwo c4>
 250 . * add full cello suites to web site (kom op, Maarten!)
 251 . * add mudela-book-doc source to webstie.
 252 . * Rethink Time_description
 253 \cadenza , \meter, \grouping should all be \properties
 254 . * rename
 255 .  * measure -> bar
 256 .  * abbrev -> tremolo
 257 .  * abbreviation-beam -> (measured/unmeasured) tremolo
 258 .  * partial -> anacrouse
 259 . * robustify Beam (in case of no stems, 32nd notes)
 260 . * move paper vars into engraver properties
 261 . * check for groff / troff/ nroff et
 262 . * more intelligent file searching
 263 . * disable spaces in TeX stuff
 264 . * handle ^C for tmp/file creation.
 265 . * make LilyPond RPM fully relocatable
 266 . * dots & rest collisions.
 267 . * the warning about the negative slur/tie length appears twice
 268 which is irritating.
 269 . * better hshift (dots, distance, head dependent)
 270 . * clefs (AG): The "8" should appear closer to the actual clef,
 271 touching it.
 272 . * put errorlevel in Input class
 273 . * junk nesting slurs
 274 . * integrate midi-elts from mi2mu and lily?
 275 . * distinguish between unset and empty properties.
 276
 277 .* FONT
 278 . * the bracket is ugly (wings are too parabolic, should be more circular)
 279 . * versioning for Feta
 280 . * rewrite dynamic signs.  They're kind of spaghetti now.
 281 . * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
 282         in the middle:
 283 . * design macro for penstroke with rounded endings
 284 . * timesig C: fat yet less curved.  Check out relations.
 285 . * design decent macro for bulbed endings
 286 . * printer dependencies.
 287 . * versioning
 288 . * lo-res fixes.
 289 . * work out sizes of character fonts.
 290 . * more symbols
 291 .  * piano pedals: Ped/*
 292 .  * maxima notehead
 293 .  * coda signs: Segno, O+
 294 .  * glissando, arpeggio
 295 .  * lengthened trill
 296 . * include important spacing dims in fetalog
 297 . * scalability: use blot_diameter everywhere, make font chubbier for
 298     small sizes.
 299
 300 .* 3RD PARTY BUGS
 301 . * GNU diff 2.7: diff -rN does not see a new directory with empty file
 302 . * mf-to-table -> add space before ; in AFM output.  (-> check AFM
 303     spec. Is this a bug in afm2tfm?)
 304 . * check out GCC signatures?
 305 . * glibc 2.0:
 306           f = fopen ("/dev/null", "r")
 307           assert (feof (f))
 308
 309 . * tetex: mfplain.mem
 310 .* 3RD PARTY PROJECTS:
 311 . * make GCC warn about ctor that leaves member vars  uninitialised.
 312 . * GNU patch
 313 .  * 'double-fix' mode: ignore identical fix, rather than suggest
 314             to revert patch direction when (more or less? exactly) the same
 315             thing is fixed
 316 .* PROJECTS
 317 . * Scripts:
 318 .  * stack scripts in chords:
 319           % fingering:        footing:
 320             < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
 321 .  * script-spacing
 322 .  * slur parts as a script
 323 .  * stack parameterised scripts for fingering and footing:
 324
 325 . * convert-mudela:
 326 .  * automatically add  a \version if not present.
 327 .  * better parsing
 328 .  * make smarter
 329 .  * convert-mudela -e empty.ly
 330
 331 . * emacs mudela-mode
 332 .  *  should handle block comments too.
 333 .  *  handle lexer modes (\header, \melodic, \lyric) etc.
 334 .  *  indentation
 335 .  *  notenames?
 336 .  *  fontlock: \melodic \melodic
 337
 338 . * use properties for:
 339 .  * default tempo.
 340 .  * cadenza mode?
 341
 342 . * page handling:
 343 .  * PS output
 344 .  * optimal pagebreaking.
 345
 346 . * Unicode support? -> man 7 unicode
 347 .  * 16 bit Strings
 348 .  * -u switch
 349 .  * detect of 16/8 bit files
 350 .  * examples to go with it.
 351
 352 . * \header
 353 .  * output header info to MIDI too.
 354
 355 . * a musical dictionary. See Documentation/vocabulary-*, other
 356 languages:
 357 .  * explanations
 358 .  * italian
 359 .  * german
 360 .  * dutch
 361 .  * swedish
 362          .. ?
 363
 364 . * chords
 365 .  * guitar chords (fret diagrams)
 366 .  * other chord name styles (american(?) style)
 367 .  * basso continuo
 368 .  * MIDI output?
 369
 370 . * Debug logs:
 371 .  * derive lily_stream, Dstream, texstream from ostream?
 372 .  * indentable stream as baseclass for TeX stream, lily stream, Dstream.
 373 .  * use dstream feature in mi2mu
 374 .  * integrate IO checking into stream class
 375
 376 . * input converters
 377 .  * NIFF?
 378 .  * ABC?
 379 .  * SMDL?
 380
 381 . * add to MIDI output:
 382 .  * tempo change
 383 .  * ornaments (and trills?)
 384 .  * slurs
 385 .  * accents
 386 .  * dynamics
 387 > Would it be hard to add support for proper dynamics in MIDI output?  I
 388 > would really like to have this feature...
 389
 390 Concretely spoken, for dynamics you have to write a performer
 391 (Dynamics_performer), that will take the input requests. If I
 392 understand correctly, every MIDI note played must have its dynamic
 393 strength set separately.  That means the the Dynamics_performer must
 394 set the strength of every Audio_note it finds.  This means that one
 395 has to modify existing Audio items.  The best way of doing this is
 396 with a broadcast/acknowledge process.
 397
 398 So the best way of handling this, is
 399
 400   1 supporting dynamic settings in Audio_note
 401
 402   2 Write a Dynamics_performer that will modify
 403   any notes it finds to set appropriate strengths.
 404
 405 I'd say that the work involved is not hard, but you have to be fluent
 406 with C++ and need some insight into the working of Notation Contexts
 407 and friends.  I guess I could do it in a day or so, but if you are not
 408 so fluent with the inner workings of LilyPond, it could take you some
 409 more time (A few more days?).
 410
 411 Please note, that I am *not* going to code this myself: my days are
 412 valuable, and I think I have more interesting things to do than fixing
 413 the MIDI output (I don't even have a soundcard).  But I *do* want to help
 414 you or other people with implementing this, so if you need help, don't
 415 hesitate to ask.
 416 .  * account for rhythmic position in measure
 417 .  * etc.
 418
 419 . * grace notes
 420 .  * make separate class for Grace_*_engravers
 421         (which is at Voice_gravs level)
 422 .  * make encapsulated spacing problems.
 423
 424 . * accidentals per Voice_group
 425
 426 . * Output class, handles : (smallish)
 427 .  * help text /(c) notice?
 428 .  * version line
 429 .  * warning /errors/progress
 430 .  * abort on error/warning; exit status
 431 .  * quiet/ignore-version options
 432 .  * logfile output
 433
 434 . * PS
 435 .  * speed up PS code.
 436 .  * PS lines to .eps files
 437 .  * write custom prolog
 438
 439 . * SGML input
 440
 441 . * Documentation
 442 .  * remove links to non-free SW.
 443 .  * internal documentation
 444 .  * a general paper.
 445 .  * \properties
 446 .   * left/rightbeamcount
 447 .   * various other new properties.
 448 .  * introduction?
 449 .  * info?
 450 .  * LaTeX?
 451 .  * more manpages?
 452 .  * Doc (C) stuff of sheet music
 453 .  * a better format?  SGML?  TeX?  Info?
 454 .  * a better tutorial
 455
 456 . * more spanners (smallish)
 457 .  * Glissando
 458 .  * trill
 459
 460 . * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
 461 .  * [c8. c32 c32]
 462 .  * doc on Rhythmic_grouping
 463 .  * general shaving on Beam and Stem
 464 .  * use plet grouping
 465 .  * separate visual from rhythmic info even more
 466 .  * beams over bars
 467
 468 . * lines:
 469 .  * Ledger lines, should be separate item: Ledger_lines
 470 .  * set different line sizes / thicknesses
 471 .  * beam stem showthrough, inter beam sizes (french vs german style)
 472
 473 . * Collisions
 474 .  * left/right note balls should be handled by Collision:
 475         < \multi 2; { \stem 1; <b c> } { <f as b> } >
 476
 477 . * Keys:
 478 .  * merge key{item} & localkey{item}?
 479 .  * spacing, national styles?
 480
 481 . * Support for TAB
 482 .  * redo Notehead to allow digits as heads
 483 .  * add a \tablature {} lexer mode for easy entering
 484
 485 . * should adjust stemlength for flag number.
 486
 487 . * breaking:
 488 .  * caching breakpoints
 489 .  * saving them
 490 .  * specify number of lines
 491
 492 .* INPUTLANGUAGE
 493 . * \rhythms 4 16 16 16 16; c c c c c -> c4 c16 etc.
 494 . * Language:
 495 .  * \translator -> ?
 496 .  * fix \partial
 497 .  * \bla {} vs \bla ;
 498 .  * mix engraver hacking with music ?
 499 .  * \once\property  KEY = VAL
 500 .  * \addtranslator, \removetranslator
 501 .  * junk ^ and _ for scripts
 502 .  * junk _ for lyrics.
 503 .  * abstract grammar.
 504 . * Figure out semicolons.
 505 . * c4 4 4 4 for c4 c4 c4 c4?
 506 . * <c f a>4 ?
 507 . * Viola mode?
 508
 509                 @c c g e g
 510         for
 511                 c g es g,
 512
 513                 @A c g e g
 514         for
 515                 cis gis e gis
 516 . * configure pitch_byte
 517 . * rest name configurable
 518
 519
 520 .* SMALLISH PROJECTS
 521
 522 . * Faulenzer sign (% repeat).  Perhaps also use \repeat syntax?
 523
 524 . * fix confusing naming in Engraver vs Engraver_group_engraver (context)
 525
 526 . * progress when creating MIDI elts.
 527
 528 . * A range for context errors (eg. mark both { and }. )
 529
 530 . * lyric in staff  (sharpsharp in staff, text below)
 531
 532 . * half sharps/flats
 533
 534 . * write Dynamic_line (to group dynamics horizontally)
 535
 536 . * use Real for all y positions.
 537
 538 . * half-sharps, half-flats
 539
 540 . * adaptive accidental spacing.
 541
 542 . * handle EOF graciously in error messages.
 543
 544 . * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
 545
 546 . * stafftypes: voice names/ instrument names.
 547
 548 . * lily \tempo
 549
 550 . *   % toe to bheel   four to five
 551             %   ^_u            4_5
 552             %     -
 553             %  --|x--         --|x--
 554             %  --|---         --|---
 555             %  --|---         --|---
 556           (where "to" is a tiny bow)
 557
 558 . * auxilliary file for caching info.
 559
 560 . * Text_crescendo
 561
 562 . * revise calcideal
 563
 564 .* IDEAS
 565 . * Output data structures of Mudela in XML/SGML.
 566 . * create libmudela, or liblily_frontend
 567 . * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
 568 . * Spacing_request for manually adjusting spacing
 569 . * caching breakpoints
 570 . * used fixedpoint arithmetic for min. energy.
 571 . * move towards incremental algorithms.
 572 . * versioning stuff (cvt mudela, mudela, etc.)
 573 . * dynamic loading of engravers?
 574 .* SMOBS
 575 Han-Wen Nienhuys <hanwen@cs.uu.nl> writes:
 576
 577 >       class Foo_class {
 578 >               Foo_smob *smob_ptr_;
 579 >       }
 580 >
 581 >       struct Foo_smob {
 582 >               Foo_class *class_ptr_
 583 >       }
 584
 585 Usually you can get away without having this interlinked structure.
 586 One piece of information you need when exporting objects to scheme is
 587 the smob tag for your class.  You might store this value (a long) into
 588 a class static variable, or a file static variable.  I'll use a class
 589 static variable in this example.
 590
 591 I typically use code that works like this (untested code ahead):
 592
 593 class Foo_class {
 594     static long *Foo_smob_tag;
 595     SCM obj; // representation as a scheme object, description comes later
 596 }
 597
 598 // call this once on startup
 599 void init_Foo_class {
 600     static scm_smobfuns type_rec;
 601
 602     type_rec.mark = foo_mark;
 603     type_rec.free = foo_free;
 604     type_rec.print = foo_display;
 605     type_rec.equalp = 0;
 606     Foo_class::Foo_smob_tag = new int(scm_new_smob(type_rec));
 607 }
 608
 609 When you want to export an object to scheme, you put a pointer to the
 610 object itself in the cdr of the cell, and the tag in the car of the
 611 cell.  The code looks like this:
 612
 613 // Is this a Foo?
 614 static int
 615 foo_p(SCM obj)
 616 {
 617     return(SCM_NIMP(obj) && SCM_CAR(obj) == Foo_class::Foo_smob_tag);
 618 }
 619
 620 // given a Scheme representation, return, a C++ representation
 621 static Foo_class *
 622 foo_unbox(SCM obj)
 623 {
 624     return((Foo_class*)SCM_CDR(obj));
 625 }
 626
 627 // the SCM representation of the object is stored inside itself
 628 // this will become useful when destructor gets called
 629 static SCM
 630 foo_box(Foo_class *foo)
 631 {
 632     SCM_DEFER_INTS;
 633     SCM_NEWCELL(foo->obj);
 634     SCM_SETCAR(foo->obj, Foo_class::Foo_smob_tag);
 635     SCM_SETCDR(foo->obj, (SCM)foo);
 636     SCM_ALLOW_INTS;
 637     return foo->obj;
 638 }
 639
 640 > C++ determines life time, so what is the strategy?
 641
 642 What happens now when the destructor gets called?  Lets set the cdr to
 643 NULL, and then check for that in all of the primitive functions that
 644 use your smob.  We'll call this notion 'live'; a scheme object is
 645 'live' if the C++ representation still exists, it's dead if the C++
 646 object is gone.  You can still have references to dead objects in
 647 scheme code; it's just an error to use them.  This idea is stolen from
 648 Emacs's handling of buffers ('buffer-live-p' and friends).
 649
 650 Add another function, foo_live_p:
 651
 652 static int
 653 foo_live_p(SCM obj)
 654 {
 655     return(foo_p(obj) && SCM_CDR(obj) != NULL);
 656 }
 657
 658 In you destructor, you need to do:
 659
 660 ~Foo_class()
 661 {
 662     SCM_CDR(this->obj, NULL);
 663 }
 664
 665 When writing new primitives, now just check foo_live_p().
 666
 667 I hope the above helps,
 668
 669
 670 * OUTLINE SETUP
 671 .* .EMACS
 672 ;;; from outline.el
 673 (defvar outline-font-lock-keywords
 674   '(;; Highlight headings according to the level.
 675     ;; must change this to allout node layout
 676     ;;("^\\(\\*+\\)[ \t]*\\(.+\\)?[ \t]*$"
 677     ("^\\([.]*[ ]*[*]\\)[ \t]*\\(.*\\)$"
 678      (1 font-lock-string-face)
 679      (2 (let ((len (- (match-end 1) (match-beginning 1))))
 680           (or (cdr (assq len '((1 . font-lock-function-name-face)
 681                                (2 . font-lock-keyword-face)
 682                                (3 . font-lock-comment-face))))
 683               font-lock-variable-name-face))
 684         nil t))
 685     ;; Highlight citations of the form [1] and [Mar94].
 686     ("\\[\\([A-Z][A-Za-z]+\\)*[0-9]+\\]" . font-lock-type-face))
 687   "Additional expressions to highlight in Outline mode.")
 688
 689 (add-hook 'outline-mode-hook
 690           '(lambda ()
 691             (setq font-lock-maximum-decoration t)
 692             (setq font-lock-maximum-decoration t)
 693             (make-local-variable 'font-lock-defaults)
 694             (setq font-lock-defaults '(outline-font-lock-keywords t))
 695             (font-lock-mode global-font-lock-mode)
 696         ))
 697
 698 (require 'allout)
 699 (outline-init 't)