Expand pause shortening functionality to include only shortening utterance boundaries

[ultrasound1372]

Rationale

For users that don't use the complete shorten pauses setting, commit c230570 increased the amount of silence between a control and its contents, such as a list and a list item, or a dialog and the focused control inside it. For lack of a better term I call this an utterance boundary. I personally do not like how aggressive the shorten pauses setting is when reading regular text, but neither do I like the increased gap between control announcements presented by this commit. I have been maintaining a local fork with continuous rebasing so I could have the best of both worlds, but I recently realized this may have wider appeal.

Implementation

The class attribute _short_pause and the corresponding shortPause boolean driver setting have been removed, instead replaced by a new pauseMode driver setting and _pause_mode attribute. The logic for this setting was based on that used for sample rate selection so I could create a choice control. The _pause_mode attribute is an integer so as to speed up pause-related checks, using the following numeric meanings.

• 0: Do not shorten pauses. Neither utterance endings nor punctuation have any pause annotations applied. This corresponds to the current behavior of shorten pauses disabled.
• 1: Shorten pauses at text boundaries. This activates the insertion of `p1 annotations at the end of speech sequences alone, the if statement checks for ≥ 1.
• 2: Shorten all pauses including punctuation. Corresponds to the current behavior when shorten pauses is enabled. Adds the annotation at the end of speech sequences and applies the pause regular expressions during text processing.

Notes

One or more of the pause mode descriptions may need to be revised, this was quickly thrown together and it was difficult for me to come up with properly descriptive strings. Once that is done obviously these strings will have to be handed off to translators for a future release.
At the moment, this has no compatibility loading of the old shorten pauses boolean setting, which should probably correspond to modes 0/2 for false/true. I'm unsure exactly how to implement such a thing.

[Mohamed00]

Not sure about the description of the option, I'm thinking it's rather verbose in its current state. I think a better way to word it might be to describe the setting as pauses with the following options.

• Do not shorten.
• Shorten at end of text only.
• Shorten all pauses.

These would then have more detailed descriptions in readme.md.

[ultrasound1372]

I did say they could use some revision, so yes I'd agree with your versions. Text rather than utterance boundary is probably easier for the average user to handle. Though I hope they won't get confused by text boundary...