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