Let \addlyrics accept an optional context mod

Let \addlyrics accept an optional context mod

Since \addlyrics always creates a new Lyrics context, there seems to be
little point in not allowing it to have a \with clause.

This change allows the use of the syntax

    \new Voice {...} \addlyrics \with ... {...}

in order to achieve the effect of what previously required

   << \new Voice = "name" {...}
      \new Lyrics \with ... \lyricsto "name" {...}
   >>


I am actually having problems finding any suitable place to document
this: use of \with ... with anything but \new ... does not seem
documented.

[dak, 2015-08-03 08:21:22]

Use only \addlyrics in one regtest rather than mixing with \lyricsto

[lemzwerg, 2015-08-03 09:07:25]

LGTM, thanks.

[thomasmorley651, 2015-08-03 10:24:32]

Can't review parser-code.

Otherwise:
Doing \layout { \context { \Lyrics ... } } will work for the Lyrics created by
\addlyrics as well. Thus it's more than consistent to allow \with { ... } for
\addlyrics. I'd say it was a badly missing feature.

My point: Looks very good to me!

About Documentation:
Put it in:
"
NR 5.1.5 Changing context default settings  	
Changing just one specific context
"
Wherelse?
Maybe as an exception from:
" The \with block must be placed immediately after the \new context-type
command"

Offtopic:

https://codereview.appspot.com/255610043/diff/10003/scm/ly-syntax-constructor...
File scm/ly-syntax-constructors.scm (right):

https://codereview.appspot.com/255610043/diff/10003/scm/ly-syntax-constructor...
scm/ly-syntax-constructors.scm:53: (if (ly:music? (cdr sigcar))
Not related to this patch:
I stumbled across this two days ago with 2.19.24. and found out James and you
already noticed.
Obviously you fixed it. Is there an issue on the tracker for it?

[dak, 2015-08-03 10:42:03]

On 2015/08/03 10:24:32, thomasmorley651 wrote:
> Can't review parser-code.
> 
> Otherwise:
> Doing \layout { \context { \Lyrics ... } } will work for the Lyrics created by
> \addlyrics as well. Thus it's more than consistent to allow \with { ... } for
> \addlyrics. I'd say it was a badly missing feature.

Not all that badly missing: the list wisdom was more or less "for more
complicated things, you need to use \lyricsto".  For this particular complicated
thing, however, the restriction appeared arbitrary.

> My point: Looks very good to me!
> 
> About Documentation:
> Put it in:
> "
> NR 5.1.5 Changing context default settings  	
> Changing just one specific context
> "
> Wherelse?
> Maybe as an exception from:
> " The \with block must be placed immediately after the \new context-type
> command"

I think we should have some table with context starters and mode change commands
somewhere also listing (discouraged but convenient) shorthands like \chords,
\figures, \lyrics and listing which commands start a different mode and which
create a context (and consequently allow for \with ...).

I mean, \addlyrics like \lyrics implies a \new Lyrics while \lyricsto doesn't,
but all of those three imply \lyricmode.

> Offtopic:
> 
>
https://codereview.appspot.com/255610043/diff/10003/scm/ly-syntax-constructor...
> File scm/ly-syntax-constructors.scm (right):
> 
>
https://codereview.appspot.com/255610043/diff/10003/scm/ly-syntax-constructor...
> scm/ly-syntax-constructors.scm:53: (if (ly:music? (cdr sigcar))
> Not related to this patch:
> I stumbled across this two days ago with 2.19.24. and found out James and you
> already noticed.
> Obviously you fixed it. Is there an issue on the tracker for it?

No.  It just happens for erroneous input (in which case you get a followup error
instead of an error message).  I just fixed it on the fly.  If we need a record
for it, feel free to create an issue.  In that case I'm sorry for this drive-by
shooting of a bug.

[pkx166h, 2015-08-03 11:20:37]

On 2015/08/03 10:42:03, dak wrote:
> On 2015/08/03 10:24:32, thomasmorley651 wrote:
> > Can't review parser-code.
> > 
> > Otherwise:
> > Doing \layout { \context { \Lyrics ... } } will work for the Lyrics created
by
> > \addlyrics as well. Thus it's more than consistent to allow \with { ... }
for
> > \addlyrics. I'd say it was a badly missing feature.
> 
> Not all that badly missing: the list wisdom was more or less "for more
> complicated things, you need to use \lyricsto".  For this particular
complicated
> thing, however, the restriction appeared arbitrary.
> 
> > My point: Looks very good to me!
> > 
> > About Documentation:
> > Put it in:
> > "
> > NR 5.1.5 Changing context default settings  	
> > Changing just one specific context
> > "
> > Wherelse?
> > Maybe as an exception from:
> > " The \with block must be placed immediately after the \new context-type
> > command"
> 
> I think we should have some table with context starters and mode change
commands
> somewhere also listing (discouraged but convenient) shorthands like \chords,
> \figures, \lyrics and listing which commands start a different mode and which
> create a context (and consequently allow for \with ...).
> 
> I mean, \addlyrics like \lyrics implies a \new Lyrics while \lyricsto doesn't,
> but all of those three imply \lyricmode.

Could we integrate this into

https://code.google.com/p/lilypond/issues/detail?id=3592

(save a new tracker?)

James

[dak, 2015-08-03 11:37:52]

On 2015/08/03 11:20:37, J_lowe wrote:

> Could we integrate this into
> 
> https://code.google.com/p/lilypond/issues/detail?id=3592
> 
> (save a new tracker?)

Well, "integrate" is a strong word since issue 3592 comes to bury the shortcuts,
not to praise them.  So I think that this is a different issue, even though
documenting the shortcuts would also lay that issue at rest, it having become
pointless.

But I think one good place where all of the context-creating and/or
mode-switching single and combined commands are listed should be enough.  The
most confusing commands so far have been the lyric-related ones, and they have
been cleaned up somewhat with the recent and not so recent changes to \addlyrics
and \lyricsto.

[t.daniels_treda.co.uk, 2015-08-03 21:00:37]

dak@gnu.org wrote Monday, August 03, 2015 11:42 AM

> I think we should have some table with context starters and mode change
> commands somewhere also listing (discouraged but convenient) shorthands
> like \chords, \figures, \lyrics and listing which commands start a
> different mode and which create a context (and consequently allow for
> \with ...).
> 
> I mean, \addlyrics like \lyrics implies a \new Lyrics while \lyricsto
> doesn't, but all of those three imply \lyricmode.

The various modes are described rather superficially in NR 5.4.1.  Maybe this
could be expanded to include the table you mention.

Trevor