1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
|
import SwiftFormat
final class MacroDeclTests: PrettyPrintTestCase {
func testBasicMacroDeclarations_noPackArguments() {
let input =
"""
macro myFun(var1: Int, var2: Double) = #externalMacro(module: "Foo", type: "Bar")
macro reallyLongName(var1: Int, var2: Double, var3: Bool) = #externalMacro(module: "Foo", type: "Bar")
macro myFun() = #externalMacro(module: "Foo", type: "Bar")
"""
let expected =
"""
macro myFun(var1: Int, var2: Double) =
#externalMacro(module: "Foo", type: "Bar")
macro reallyLongName(
var1: Int,
var2: Double,
var3: Bool
) = #externalMacro(module: "Foo", type: "Bar")
macro myFun() = #externalMacro(module: "Foo", type: "Bar")
"""
var config = Configuration.forTesting
config.lineBreakBeforeEachArgument = true
assertPrettyPrintEqual(input: input, expected: expected, linelength: 58, configuration: config)
}
func testBasicMacroDeclarations_packArguments() {
let input =
"""
macro myFun(var1: Int, var2: Double) = #externalMacro(module: "Foo", type: "Bar")
macro reallyLongName(var1: Int, var2: Double, var3: Bool) = #externalMacro(module: "Foo", type: "Bar")
macro myFun() = #externalMacro(module: "Foo", type: "Bar")
"""
let expected =
"""
macro myFun(var1: Int, var2: Double) =
#externalMacro(module: "Foo", type: "Bar")
macro reallyLongName(
var1: Int, var2: Double, var3: Bool
) = #externalMacro(module: "Foo", type: "Bar")
macro myFun() = #externalMacro(module: "Foo", type: "Bar")
"""
var config = Configuration.forTesting
config.lineBreakBeforeEachArgument = false
assertPrettyPrintEqual(input: input, expected: expected, linelength: 58, configuration: config)
}
func testMacroDeclReturns() {
let input =
"""
macro myFun(var1: Int, var2: Double) -> Double = #externalMacro(module: "Foo", type: "Bar")
macro reallyLongName(var1: Int, var2: Double, var3: Bool) -> Double = #externalMacro(module: "Foo", type: "Bar")
macro reallyReallyLongName(var1: Int, var2: Double, var3: Bool) -> Double = #externalMacro(module: "Foo", type: "Bar")
macro tupleFunc() -> (one: Int, two: Double, three: Bool, four: String) = #externalMacro(module: "Foo", type: "Bar")
macro memberTypeReallyReallyLongNameFunc() -> Type.InnerMember = #externalMacro(module: "Foo", type: "Bar")
macro tupleMembersReallyLongNameFunc() -> (Type.Inner, Type2.Inner2) = #externalMacro(module: "Foo", type: "Bar")
"""
let expected =
"""
macro myFun(var1: Int, var2: Double) -> Double =
#externalMacro(module: "Foo", type: "Bar")
macro reallyLongName(var1: Int, var2: Double, var3: Bool)
-> Double = #externalMacro(module: "Foo", type: "Bar")
macro reallyReallyLongName(
var1: Int, var2: Double, var3: Bool
) -> Double = #externalMacro(module: "Foo", type: "Bar")
macro tupleFunc() -> (
one: Int, two: Double, three: Bool, four: String
) = #externalMacro(module: "Foo", type: "Bar")
macro memberTypeReallyReallyLongNameFunc()
-> Type.InnerMember =
#externalMacro(module: "Foo", type: "Bar")
macro tupleMembersReallyLongNameFunc() -> (
Type.Inner, Type2.Inner2
) = #externalMacro(module: "Foo", type: "Bar")
"""
var config = Configuration.forTesting
config.lineBreakBeforeEachArgument = false
assertPrettyPrintEqual(input: input, expected: expected, linelength: 58, configuration: config)
}
func testMacroGenericParameters_noPackArguments() {
let input =
"""
macro myFun<S, T>(var1: S, var2: T) = #externalMacro(module: "Foo", type: "Bar")
macro myFun<S: T & U>(var1: S) = #externalMacro(module: "Foo", type: "Bar")
macro longerNameFun<ReallyLongTypeName: Conform, TypeName>(var1: ReallyLongTypeName, var2: TypeName) = #externalMacro(module: "Foo", type: "Bar")
"""
let expected =
"""
macro myFun<S, T>(var1: S, var2: T) =
#externalMacro(module: "Foo", type: "Bar")
macro myFun<S: T & U>(var1: S) =
#externalMacro(module: "Foo", type: "Bar")
macro longerNameFun<
ReallyLongTypeName: Conform,
TypeName
>(
var1: ReallyLongTypeName,
var2: TypeName
) =
#externalMacro(module: "Foo", type: "Bar")
"""
var config = Configuration.forTesting
config.lineBreakBeforeEachArgument = true
assertPrettyPrintEqual(input: input, expected: expected, linelength: 44, configuration: config)
}
func testMacroGenericParameters_packArguments() {
let input =
"""
macro myFun<S, T>(var1: S, var2: T) = #externalMacro(module: "Foo", type: "Bar")
macro myFun<S: T & U>(var1: S) = #externalMacro(module: "Foo", type: "Bar")
macro longerNameFun<ReallyLongTypeName: Conform, TypeName>(var1: ReallyLongTypeName, var2: TypeName) = #externalMacro(module: "Foo", type: "Bar")
"""
let expected =
"""
macro myFun<S, T>(var1: S, var2: T) =
#externalMacro(module: "Foo", type: "Bar")
macro myFun<S: T & U>(var1: S) =
#externalMacro(module: "Foo", type: "Bar")
macro longerNameFun<
ReallyLongTypeName: Conform, TypeName
>(
var1: ReallyLongTypeName, var2: TypeName
) =
#externalMacro(module: "Foo", type: "Bar")
"""
var config = Configuration.forTesting
config.lineBreakBeforeEachArgument = false
assertPrettyPrintEqual(input: input, expected: expected, linelength: 44, configuration: config)
}
func testMacroWhereClause() {
let input =
"""
macro index<Elements: Collection, Element>(
of element: Element, in collection: Elements
) -> Elements.Index? = #externalMacro(module: "Foo", type: "Bar") where Elements.Element == Element
macro index<Elements: Collection, Element>(
of element: Element,
in collection: Elements
) -> Elements.Index? = #externalMacro(module: "Foo", type: "Bar") where Elements.Element == Element, Element: Equatable
macro index<Elements: Collection, Element>(
of element: Element,
in collection: Elements
) -> Elements.Index? = #externalMacro(module: "Foo", type: "Bar") where Elements.Element == Element, Element: Equatable, Element: ReallyLongProtocolName
"""
let expected =
"""
macro index<Elements: Collection, Element>(
of element: Element, in collection: Elements
) -> Elements.Index? =
#externalMacro(module: "Foo", type: "Bar")
where Elements.Element == Element
macro index<Elements: Collection, Element>(
of element: Element,
in collection: Elements
) -> Elements.Index? =
#externalMacro(module: "Foo", type: "Bar")
where
Elements.Element == Element, Element: Equatable
macro index<Elements: Collection, Element>(
of element: Element,
in collection: Elements
) -> Elements.Index? =
#externalMacro(module: "Foo", type: "Bar")
where
Elements.Element == Element, Element: Equatable,
Element: ReallyLongProtocolName
"""
var config = Configuration.forTesting
config.lineBreakBeforeEachArgument = false
assertPrettyPrintEqual(input: input, expected: expected, linelength: 51, configuration: config)
}
func testMacroWhereClause_lineBreakBeforeEachGenericRequirement() {
let input =
"""
public macro index<Elements: Collection, Element>(
of element: Element, in collection: Elements
) -> Elements.Index? = #externalMacro(module: "Foo", type: "Bar") where Elements.Element == Element
public macro index<Elements: Collection, Element>(
of element: Element,
in collection: Elements
) -> Elements.Index? = #externalMacro(module: "Foo", type: "Bar") where Elements.Element == Element, Element: Equatable
public macro index<Elements: Collection, Element>(
of element: Element,
in collection: Elements
) -> Elements.Index? = #externalMacro(module: "Foo", type: "Bar") where Elements.Element == Element, Element: Equatable, Element: ReallyLongProtocolName
"""
let expected =
"""
public macro index<Elements: Collection, Element>(
of element: Element, in collection: Elements
) -> Elements.Index? =
#externalMacro(module: "Foo", type: "Bar")
where Elements.Element == Element
public macro index<Elements: Collection, Element>(
of element: Element,
in collection: Elements
) -> Elements.Index? =
#externalMacro(module: "Foo", type: "Bar")
where
Elements.Element == Element,
Element: Equatable
public macro index<Elements: Collection, Element>(
of element: Element,
in collection: Elements
) -> Elements.Index? =
#externalMacro(module: "Foo", type: "Bar")
where
Elements.Element == Element,
Element: Equatable,
Element: ReallyLongProtocolName
"""
var config = Configuration.forTesting
config.lineBreakBeforeEachArgument = false
config.lineBreakBeforeEachGenericRequirement = true
assertPrettyPrintEqual(input: input, expected: expected, linelength: 50, configuration: config)
}
func testMacroAttributes() {
let input =
"""
@attached(accessor) public macro MyFun() = #externalMacro(module: "Foo", type: "Bar")
@attached(accessor) @attached(memberAttribute) public macro MyFun() = #externalMacro(module: "Foo", type: "Bar")
@attached(accessor) @attached(member, names: named(_storage)) public macro MyFun() = #externalMacro(module: "Foo", type: "Bar")
@attached(accessor)
@attached(member, names: named(_storage))
public macro MyFun() = #externalMacro(module: "Foo", type: "Bar")
"""
let expected =
"""
@attached(accessor) public macro MyFun() =
#externalMacro(module: "Foo", type: "Bar")
@attached(accessor) @attached(memberAttribute) public macro MyFun() =
#externalMacro(module: "Foo", type: "Bar")
@attached(accessor) @attached(member, names: named(_storage))
public macro MyFun() = #externalMacro(module: "Foo", type: "Bar")
@attached(accessor)
@attached(member, names: named(_storage))
public macro MyFun() = #externalMacro(module: "Foo", type: "Bar")
"""
assertPrettyPrintEqual(input: input, expected: expected, linelength: 69)
}
func testMacroDeclWithoutDefinition() {
let input =
"""
macro myFun()
macro myFun(arg1: Int)
macro myFun() -> Int
macro myFun<T>(arg1: Int)
macro myFun<T>(arg1: Int) where T: S
"""
let expected =
"""
macro myFun()
macro myFun(arg1: Int)
macro myFun() -> Int
macro myFun<T>(arg1: Int)
macro myFun<T>(arg1: Int) where T: S
"""
assertPrettyPrintEqual(input: input, expected: expected, linelength: 50)
}
func testBreaksBeforeOrInsideOutput() {
let input =
"""
macro name<R>(_ x: Int) -> R
"""
let expected =
"""
macro name<R>(_ x: Int)
-> R
"""
assertPrettyPrintEqual(input: input, expected: expected, linelength: 23)
assertPrettyPrintEqual(input: input, expected: expected, linelength: 24)
assertPrettyPrintEqual(input: input, expected: expected, linelength: 27)
}
func testBreaksBeforeOrInsideOutput_prioritizingKeepingOutputTogether() {
let input =
"""
macro name<R>(_ x: Int) -> R
"""
let expected =
"""
macro name<R>(
_ x: Int
) -> R
"""
var config = Configuration.forTesting
config.prioritizeKeepingFunctionOutputTogether = true
assertPrettyPrintEqual(input: input, expected: expected, linelength: 23, configuration: config)
assertPrettyPrintEqual(input: input, expected: expected, linelength: 24, configuration: config)
assertPrettyPrintEqual(input: input, expected: expected, linelength: 27, configuration: config)
}
func testBreaksBeforeOrInsideOutputWithAttributes() {
let input =
"""
@attached(member) @attached(memberAttribute)
macro name<R>(_ x: Int) -> R
"""
let expected =
"""
@attached(member)
@attached(memberAttribute)
macro name<R>(_ x: Int)
-> R
"""
assertPrettyPrintEqual(input: input, expected: expected, linelength: 26)
}
func testBreaksBeforeOrInsideOutputWithAttributes_prioritizingKeepingOutputTogether() {
let input =
"""
@attached(member) @attached(memberAttribute)
macro name<R>(_ x: Int) -> R
"""
let expected =
"""
@attached(member)
@attached(memberAttribute)
macro name<R>(
_ x: Int
) -> R
"""
var config = Configuration.forTesting
config.prioritizeKeepingFunctionOutputTogether = true
assertPrettyPrintEqual(input: input, expected: expected, linelength: 26, configuration: config)
}
func testDoesNotBreakInsideEmptyParens() {
// If the macro name is so long that the parentheses of a no-argument parameter list would
// be pushed past the margin, don't break inside them.
let input =
"""
macro fooBarBaz()
"""
let expected =
"""
macro
fooBarBaz()
"""
assertPrettyPrintEqual(input: input, expected: expected, linelength: 16)
}
}
|