alignParameters can exploit natural anchors in method/class definitions

[paulp]

Here's an example of the work of alignParameters on the scala library:

def showInput[A](parent: Component = null,
                 message: Any,
                 title: String = uiString("OptionPane.inputDialogTitle"),
                 messageType: Message.Value = Message.Question,
                 icon: Icon = EmptyIcon,
                 entries: Seq[A] = Nil,
                 initial: A): Option[A] = {

Here is what I think that ought to look like. Rather than putting all parameters flush at the left margin, it anchors on : (left and right) and =.

This gives us three columns each with a uniform margin (names, types, and default values) rather than one.

def showInput[A](parent: Component     = null,
                message: Any,
                  title: String        = uiString("OptionPane.inputDialogTitle"),
            messageType: Message.Value = Message.Question,
                   icon: Icon          = EmptyIcon,
                entries: Seq[A]        = Nil,
                initial: A
): Option[A] = {

[mads-hartmann]

+1

[martin-g]

+1

[paulp]

I implemented this in the sense of "it prints to the console the way it should look." I'm afraid it will take me at least twice as long to translate that logic into scalariform's internal representation. Is that enough of a head start to entice anyone else?

[paulp]

By which I mean, if I run scalariform on the "RichWindow.scala" file from which the original example was derived, it prints this to the console (but does not reformat the source this way.)

formatParamClause(
         parent: Component     = null,
        message: Any,
          title: String        = uiString("OptionPane.titleText"),
     optionType: Options.Value = Options.YesNo,
    messageType: Message.Value = Message.Question,
           icon: Icon          = EmptyIcon
)
formatParamClause(
         parent: Component     = null,
        message: Any,
          title: String        = uiString("OptionPane.titleText"),
     optionType: Options.Value = Options.YesNo,
    messageType: Message.Value = Message.Question,
           icon: Icon          = EmptyIcon,
        entries: Seq[Any],
        initial: Int
)
formatParamClause(
         parent: Component     = null,
        message: Any,
          title: String        = uiString("OptionPane.inputDialogTitle"),
    messageType: Message.Value = Message.Question,
           icon: Icon          = EmptyIcon,
        entries: Seq[A]        = Nil,
        initial: A
)
formatParamClause(
         parent: Component     = null,
        message: Any,
          title: String        = uiString("OptionPane.messageDialogTitle"),
    messageType: Message.Value = Message.Info,
           icon: Icon          = EmptyIcon
)
formatParamClause(
    owner: Window,
       gc: java.awt.GraphicsConfiguration = null
)

[mads-hartmann]

Do you have that on a branch? I might have time to take a look at it after wednesday.

[mdr]

That's pretty nice, I'll look to add this as the next feature.

You could have a very long parameter name, and run out of room on the left. In that case, everything would get indented after the opening param:

def foo(   param1: Int,
  myLongParameter: Int,
           param3: Int
): String

[daniel-trinh]

I wasn't able to implement this 100%, but I've gotten something quite similar working:

  def showInput[A](
    parent:      Component     = null,
    message:     Any,
    title:       String        = uiString("OptionPane.inputDialogTitle"),
    messageType: Message.Value = Message.Question,
    icon:        Icon          = EmptyIcon,
    entries:     Seq[A]        = Nil,
    initial:     A): Option[A]

See this PR: #103

Maybe once I've got a few more days to spare, I'll see if I can get this to match the examples above 100%.