tests/test_hdl_ast.py

   1 import warnings
   2 from enum import Enum
   3
   4 from nmigen.hdl.ast import *
   5
   6 from .utils import *
   7
   8
   9 class UnsignedEnum(Enum):
  10     FOO = 1
  11     BAR = 2
  12     BAZ = 3
  13
  14
  15 class SignedEnum(Enum):
  16     FOO = -1
  17     BAR =  0
  18     BAZ = +1
  19
  20
  21 class StringEnum(Enum):
  22     FOO = "a"
  23     BAR = "b"
  24
  25
  26 class ShapeTestCase(FHDLTestCase):
  27     def test_make(self):
  28         s1 = Shape()
  29         self.assertEqual(s1.width, 1)
  30         self.assertEqual(s1.signed, False)
  31         s2 = Shape(signed=True)
  32         self.assertEqual(s2.width, 1)
  33         self.assertEqual(s2.signed, True)
  34         s3 = Shape(3, True)
  35         self.assertEqual(s3.width, 3)
  36         self.assertEqual(s3.signed, True)
  37
  38     def test_make_wrong(self):
  39         with self.assertRaisesRegex(TypeError,
  40                 r"^Width must be a non-negative integer, not -1$"):
  41             Shape(-1)
  42
  43     def test_compare_wrong(self):
  44         with self.assertRaisesRegex(TypeError,
  45                 r"^Shapes may be compared with other Shapes and \(int, bool\) tuples, not 'hi'$"):
  46             Shape(1, True) == 'hi'
  47
  48     def test_compare_tuple_wrong(self):
  49         with self.assertRaisesRegex(TypeError,
  50                 r"^Shapes may be compared with other Shapes and \(int, bool\) tuples, not \(2, 3\)$"):
  51             Shape(1, True) == (2, 3)
  52
  53     def test_repr(self):
  54         self.assertEqual(repr(Shape()), "unsigned(1)")
  55         self.assertEqual(repr(Shape(2, True)), "signed(2)")
  56
  57     def test_tuple(self):
  58         width, signed = Shape()
  59         self.assertEqual(width, 1)
  60         self.assertEqual(signed, False)
  61
  62     def test_unsigned(self):
  63         s1 = unsigned(2)
  64         self.assertIsInstance(s1, Shape)
  65         self.assertEqual(s1.width, 2)
  66         self.assertEqual(s1.signed, False)
  67
  68     def test_signed(self):
  69         s1 = signed(2)
  70         self.assertIsInstance(s1, Shape)
  71         self.assertEqual(s1.width, 2)
  72         self.assertEqual(s1.signed, True)
  73
  74     def test_cast_shape(self):
  75         s1 = Shape.cast(unsigned(1))
  76         self.assertEqual(s1.width, 1)
  77         self.assertEqual(s1.signed, False)
  78         s2 = Shape.cast(signed(3))
  79         self.assertEqual(s2.width, 3)
  80         self.assertEqual(s2.signed, True)
  81
  82     def test_cast_int(self):
  83         s1 = Shape.cast(2)
  84         self.assertEqual(s1.width, 2)
  85         self.assertEqual(s1.signed, False)
  86
  87     def test_cast_int_wrong(self):
  88         with self.assertRaisesRegex(TypeError,
  89                 r"^Width must be a non-negative integer, not -1$"):
  90             Shape.cast(-1)
  91
  92     def test_cast_tuple(self):
  93         with warnings.catch_warnings():
  94             warnings.filterwarnings(action="ignore", category=DeprecationWarning)
  95             s1 = Shape.cast((1, True))
  96             self.assertEqual(s1.width, 1)
  97             self.assertEqual(s1.signed, True)
  98
  99     def test_cast_tuple_wrong(self):
 100         with warnings.catch_warnings():
 101             warnings.filterwarnings(action="ignore", category=DeprecationWarning)
 102             with self.assertRaisesRegex(TypeError,
 103                     r"^Width must be a non-negative integer, not -1$"):
 104                 Shape.cast((-1, True))
 105
 106     def test_cast_range(self):
 107         s1 = Shape.cast(range(0, 8))
 108         self.assertEqual(s1.width, 3)
 109         self.assertEqual(s1.signed, False)
 110         s2 = Shape.cast(range(0, 9))
 111         self.assertEqual(s2.width, 4)
 112         self.assertEqual(s2.signed, False)
 113         s3 = Shape.cast(range(-7, 8))
 114         self.assertEqual(s3.width, 4)
 115         self.assertEqual(s3.signed, True)
 116         s4 = Shape.cast(range(0, 1))
 117         self.assertEqual(s4.width, 1)
 118         self.assertEqual(s4.signed, False)
 119         s5 = Shape.cast(range(-1, 0))
 120         self.assertEqual(s5.width, 1)
 121         self.assertEqual(s5.signed, True)
 122         s6 = Shape.cast(range(0, 0))
 123         self.assertEqual(s6.width, 0)
 124         self.assertEqual(s6.signed, False)
 125         s7 = Shape.cast(range(-1, -1))
 126         self.assertEqual(s7.width, 0)
 127         self.assertEqual(s7.signed, True)
 128
 129     def test_cast_enum(self):
 130         s1 = Shape.cast(UnsignedEnum)
 131         self.assertEqual(s1.width, 2)
 132         self.assertEqual(s1.signed, False)
 133         s2 = Shape.cast(SignedEnum)
 134         self.assertEqual(s2.width, 2)
 135         self.assertEqual(s2.signed, True)
 136
 137     def test_cast_enum_bad(self):
 138         with self.assertRaisesRegex(TypeError,
 139                 r"^Only enumerations with integer values can be used as value shapes$"):
 140             Shape.cast(StringEnum)
 141
 142     def test_cast_bad(self):
 143         with self.assertRaisesRegex(TypeError,
 144                 r"^Object 'foo' cannot be used as value shape$"):
 145             Shape.cast("foo")
 146
 147
 148 class ValueTestCase(FHDLTestCase):
 149     def test_cast(self):
 150         self.assertIsInstance(Value.cast(0), Const)
 151         self.assertIsInstance(Value.cast(True), Const)
 152         c = Const(0)
 153         self.assertIs(Value.cast(c), c)
 154         with self.assertRaisesRegex(TypeError,
 155                 r"^Object 'str' cannot be converted to an nMigen value$"):
 156             Value.cast("str")
 157
 158     def test_cast_enum(self):
 159         e1 = Value.cast(UnsignedEnum.FOO)
 160         self.assertIsInstance(e1, Const)
 161         self.assertEqual(e1.shape(), unsigned(2))
 162         e2 = Value.cast(SignedEnum.FOO)
 163         self.assertIsInstance(e2, Const)
 164         self.assertEqual(e2.shape(), signed(2))
 165
 166     def test_cast_enum_wrong(self):
 167         with self.assertRaisesRegex(TypeError,
 168                 r"^Only enumerations with integer values can be used as value shapes$"):
 169             Value.cast(StringEnum.FOO)
 170
 171     def test_bool(self):
 172         with self.assertRaisesRegex(TypeError,
 173                 r"^Attempted to convert nMigen value to Python boolean$"):
 174             if Const(0):
 175                 pass
 176
 177     def test_len(self):
 178         self.assertEqual(len(Const(10)), 4)
 179
 180     def test_getitem_int(self):
 181         s1 = Const(10)[0]
 182         self.assertIsInstance(s1, Slice)
 183         self.assertEqual(s1.start, 0)
 184         self.assertEqual(s1.stop, 1)
 185         s2 = Const(10)[-1]
 186         self.assertIsInstance(s2, Slice)
 187         self.assertEqual(s2.start, 3)
 188         self.assertEqual(s2.stop, 4)
 189         with self.assertRaisesRegex(IndexError,
 190                 r"^Cannot index 5 bits into 4-bit value$"):
 191             Const(10)[5]
 192
 193     def test_getitem_slice(self):
 194         s1 = Const(10)[1:3]
 195         self.assertIsInstance(s1, Slice)
 196         self.assertEqual(s1.start, 1)
 197         self.assertEqual(s1.stop, 3)
 198         s2 = Const(10)[1:-2]
 199         self.assertIsInstance(s2, Slice)
 200         self.assertEqual(s2.start, 1)
 201         self.assertEqual(s2.stop, 2)
 202         s3 = Const(31)[::2]
 203         self.assertIsInstance(s3, Cat)
 204         self.assertIsInstance(s3.parts[0], Slice)
 205         self.assertEqual(s3.parts[0].start, 0)
 206         self.assertEqual(s3.parts[0].stop, 1)
 207         self.assertIsInstance(s3.parts[1], Slice)
 208         self.assertEqual(s3.parts[1].start, 2)
 209         self.assertEqual(s3.parts[1].stop, 3)
 210         self.assertIsInstance(s3.parts[2], Slice)
 211         self.assertEqual(s3.parts[2].start, 4)
 212         self.assertEqual(s3.parts[2].stop, 5)
 213
 214     def test_getitem_wrong(self):
 215         with self.assertRaisesRegex(TypeError,
 216                 r"^Cannot index value with 'str'$"):
 217             Const(31)["str"]
 218
 219     def test_shift_left(self):
 220         self.assertRepr(Const(256, unsigned(9)).shift_left(0),
 221                         "(cat (const 0'd0) (const 9'd256))")
 222
 223         self.assertRepr(Const(256, unsigned(9)).shift_left(1),
 224                         "(cat (const 1'd0) (const 9'd256))")
 225         self.assertRepr(Const(256, unsigned(9)).shift_left(5),
 226                         "(cat (const 5'd0) (const 9'd256))")
 227         self.assertRepr(Const(256, signed(9)).shift_left(1),
 228                         "(s (cat (const 1'd0) (const 9'sd-256)))")
 229         self.assertRepr(Const(256, signed(9)).shift_left(5),
 230                         "(s (cat (const 5'd0) (const 9'sd-256)))")
 231
 232         self.assertRepr(Const(256, unsigned(9)).shift_left(-1),
 233                         "(slice (const 9'd256) 1:9)")
 234         self.assertRepr(Const(256, unsigned(9)).shift_left(-5),
 235                         "(slice (const 9'd256) 5:9)")
 236         self.assertRepr(Const(256, signed(9)).shift_left(-1),
 237                         "(s (slice (const 9'sd-256) 1:9))")
 238         self.assertRepr(Const(256, signed(9)).shift_left(-5),
 239                         "(s (slice (const 9'sd-256) 5:9))")
 240         self.assertRepr(Const(256, signed(9)).shift_left(-15),
 241                         "(s (slice (const 9'sd-256) 9:9))")
 242
 243     def test_shift_left_wrong(self):
 244         with self.assertRaisesRegex(TypeError,
 245                 r"^Shift amount must be an integer, not 'str'$"):
 246             Const(31).shift_left("str")
 247
 248     def test_shift_right(self):
 249         self.assertRepr(Const(256, unsigned(9)).shift_right(0),
 250                         "(slice (const 9'd256) 0:9)")
 251
 252         self.assertRepr(Const(256, unsigned(9)).shift_right(-1),
 253                         "(cat (const 1'd0) (const 9'd256))")
 254         self.assertRepr(Const(256, unsigned(9)).shift_right(-5),
 255                         "(cat (const 5'd0) (const 9'd256))")
 256         self.assertRepr(Const(256, signed(9)).shift_right(-1),
 257                         "(s (cat (const 1'd0) (const 9'sd-256)))")
 258         self.assertRepr(Const(256, signed(9)).shift_right(-5),
 259                         "(s (cat (const 5'd0) (const 9'sd-256)))")
 260
 261         self.assertRepr(Const(256, unsigned(9)).shift_right(1),
 262                         "(slice (const 9'd256) 1:9)")
 263         self.assertRepr(Const(256, unsigned(9)).shift_right(5),
 264                         "(slice (const 9'd256) 5:9)")
 265         self.assertRepr(Const(256, signed(9)).shift_right(1),
 266                         "(s (slice (const 9'sd-256) 1:9))")
 267         self.assertRepr(Const(256, signed(9)).shift_right(5),
 268                         "(s (slice (const 9'sd-256) 5:9))")
 269         self.assertRepr(Const(256, signed(9)).shift_right(15),
 270                         "(s (slice (const 9'sd-256) 9:9))")
 271
 272     def test_shift_right_wrong(self):
 273         with self.assertRaisesRegex(TypeError,
 274                 r"^Shift amount must be an integer, not 'str'$"):
 275             Const(31).shift_left("str")
 276
 277     def test_rotate_left(self):
 278         self.assertRepr(Const(256).rotate_left(1),
 279                         "(cat (slice (const 9'd256) 8:9) (slice (const 9'd256) 0:8))")
 280         self.assertRepr(Const(256).rotate_left(7),
 281                         "(cat (slice (const 9'd256) 2:9) (slice (const 9'd256) 0:2))")
 282         self.assertRepr(Const(256).rotate_left(-1),
 283                         "(cat (slice (const 9'd256) 1:9) (slice (const 9'd256) 0:1))")
 284         self.assertRepr(Const(256).rotate_left(-7),
 285                         "(cat (slice (const 9'd256) 7:9) (slice (const 9'd256) 0:7))")
 286
 287     def test_rotate_left_wrong(self):
 288         with self.assertRaisesRegex(TypeError,
 289                 r"^Rotate amount must be an integer, not 'str'$"):
 290             Const(31).rotate_left("str")
 291
 292     def test_rotate_right(self):
 293         self.assertRepr(Const(256).rotate_right(1),
 294                         "(cat (slice (const 9'd256) 1:9) (slice (const 9'd256) 0:1))")
 295         self.assertRepr(Const(256).rotate_right(7),
 296                         "(cat (slice (const 9'd256) 7:9) (slice (const 9'd256) 0:7))")
 297         self.assertRepr(Const(256).rotate_right(-1),
 298                         "(cat (slice (const 9'd256) 8:9) (slice (const 9'd256) 0:8))")
 299         self.assertRepr(Const(256).rotate_right(-7),
 300                         "(cat (slice (const 9'd256) 2:9) (slice (const 9'd256) 0:2))")
 301
 302     def test_rotate_right_wrong(self):
 303         with self.assertRaisesRegex(TypeError,
 304                 r"^Rotate amount must be an integer, not 'str'$"):
 305             Const(31).rotate_right("str")
 306
 307
 308 class ConstTestCase(FHDLTestCase):
 309     def test_shape(self):
 310         self.assertEqual(Const(0).shape(),   unsigned(1))
 311         self.assertIsInstance(Const(0).shape(), Shape)
 312         self.assertEqual(Const(1).shape(),   unsigned(1))
 313         self.assertEqual(Const(10).shape(),  unsigned(4))
 314         self.assertEqual(Const(-10).shape(), signed(5))
 315
 316         self.assertEqual(Const(1, 4).shape(),          unsigned(4))
 317         self.assertEqual(Const(-1, 4).shape(),         signed(4))
 318         self.assertEqual(Const(1, signed(4)).shape(),  signed(4))
 319         self.assertEqual(Const(0, unsigned(0)).shape(), unsigned(0))
 320
 321     def test_shape_wrong(self):
 322         with self.assertRaisesRegex(TypeError,
 323                 r"^Width must be a non-negative integer, not -1$"):
 324             Const(1, -1)
 325
 326     def test_normalization(self):
 327         self.assertEqual(Const(0b10110, signed(5)).value, -10)
 328
 329     def test_value(self):
 330         self.assertEqual(Const(10).value, 10)
 331
 332     def test_repr(self):
 333         self.assertEqual(repr(Const(10)),  "(const 4'd10)")
 334         self.assertEqual(repr(Const(-10)), "(const 5'sd-10)")
 335
 336     def test_hash(self):
 337         with self.assertRaises(TypeError):
 338             hash(Const(0))
 339
 340
 341 class OperatorTestCase(FHDLTestCase):
 342     def test_bool(self):
 343         v = Const(0, 4).bool()
 344         self.assertEqual(repr(v), "(b (const 4'd0))")
 345         self.assertEqual(v.shape(), unsigned(1))
 346
 347     def test_invert(self):
 348         v = ~Const(0, 4)
 349         self.assertEqual(repr(v), "(~ (const 4'd0))")
 350         self.assertEqual(v.shape(), unsigned(4))
 351
 352     def test_as_unsigned(self):
 353         v = Const(-1, signed(4)).as_unsigned()
 354         self.assertEqual(repr(v), "(u (const 4'sd-1))")
 355         self.assertEqual(v.shape(), unsigned(4))
 356
 357     def test_as_signed(self):
 358         v = Const(1, unsigned(4)).as_signed()
 359         self.assertEqual(repr(v), "(s (const 4'd1))")
 360         self.assertEqual(v.shape(), signed(4))
 361
 362     def test_neg(self):
 363         v1 = -Const(0, unsigned(4))
 364         self.assertEqual(repr(v1), "(- (const 4'd0))")
 365         self.assertEqual(v1.shape(), signed(5))
 366         v2 = -Const(0, signed(4))
 367         self.assertEqual(repr(v2), "(- (const 4'sd0))")
 368         self.assertEqual(v2.shape(), signed(5))
 369
 370     def test_add(self):
 371         v1 = Const(0, unsigned(4)) + Const(0, unsigned(6))
 372         self.assertEqual(repr(v1), "(+ (const 4'd0) (const 6'd0))")
 373         self.assertEqual(v1.shape(), unsigned(7))
 374         v2 = Const(0, signed(4)) + Const(0, signed(6))
 375         self.assertEqual(v2.shape(), signed(7))
 376         v3 = Const(0, signed(4)) + Const(0, unsigned(4))
 377         self.assertEqual(v3.shape(), signed(6))
 378         v4 = Const(0, unsigned(4)) + Const(0, signed(4))
 379         self.assertEqual(v4.shape(), signed(6))
 380         v5 = 10 + Const(0, 4)
 381         self.assertEqual(v5.shape(), unsigned(5))
 382
 383     def test_sub(self):
 384         v1 = Const(0, unsigned(4)) - Const(0, unsigned(6))
 385         self.assertEqual(repr(v1), "(- (const 4'd0) (const 6'd0))")
 386         self.assertEqual(v1.shape(), unsigned(7))
 387         v2 = Const(0, signed(4)) - Const(0, signed(6))
 388         self.assertEqual(v2.shape(), signed(7))
 389         v3 = Const(0, signed(4)) - Const(0, unsigned(4))
 390         self.assertEqual(v3.shape(), signed(6))
 391         v4 = Const(0, unsigned(4)) - Const(0, signed(4))
 392         self.assertEqual(v4.shape(), signed(6))
 393         v5 = 10 - Const(0, 4)
 394         self.assertEqual(v5.shape(), unsigned(5))
 395
 396     def test_mul(self):
 397         v1 = Const(0, unsigned(4)) * Const(0, unsigned(6))
 398         self.assertEqual(repr(v1), "(* (const 4'd0) (const 6'd0))")
 399         self.assertEqual(v1.shape(), unsigned(10))
 400         v2 = Const(0, signed(4)) * Const(0, signed(6))
 401         self.assertEqual(v2.shape(), signed(10))
 402         v3 = Const(0, signed(4)) * Const(0, unsigned(4))
 403         self.assertEqual(v3.shape(), signed(8))
 404         v5 = 10 * Const(0, 4)
 405         self.assertEqual(v5.shape(), unsigned(8))
 406
 407     def test_mod(self):
 408         v1 = Const(0, unsigned(4)) % Const(0, unsigned(6))
 409         self.assertEqual(repr(v1), "(% (const 4'd0) (const 6'd0))")
 410         self.assertEqual(v1.shape(), unsigned(4))
 411         v3 = Const(0, signed(4)) % Const(0, unsigned(4))
 412         self.assertEqual(v3.shape(), signed(4))
 413         v5 = 10 % Const(0, 4)
 414         self.assertEqual(v5.shape(), unsigned(4))
 415
 416     def test_mod_wrong(self):
 417         with self.assertRaisesRegex(NotImplementedError,
 418                 r"^Division by a signed value is not supported$"):
 419             Const(0, signed(4)) % Const(0, signed(6))
 420
 421     def test_floordiv(self):
 422         v1 = Const(0, unsigned(4)) // Const(0, unsigned(6))
 423         self.assertEqual(repr(v1), "(// (const 4'd0) (const 6'd0))")
 424         self.assertEqual(v1.shape(), unsigned(4))
 425         v3 = Const(0, signed(4)) // Const(0, unsigned(4))
 426         self.assertEqual(v3.shape(), signed(4))
 427         v5 = 10 // Const(0, 4)
 428         self.assertEqual(v5.shape(), unsigned(4))
 429
 430     def test_floordiv_wrong(self):
 431         with self.assertRaisesRegex(NotImplementedError,
 432                 r"^Division by a signed value is not supported$"):
 433             Const(0, signed(4)) // Const(0, signed(6))
 434
 435     def test_and(self):
 436         v1 = Const(0, unsigned(4)) & Const(0, unsigned(6))
 437         self.assertEqual(repr(v1), "(& (const 4'd0) (const 6'd0))")
 438         self.assertEqual(v1.shape(), unsigned(6))
 439         v2 = Const(0, signed(4)) & Const(0, signed(6))
 440         self.assertEqual(v2.shape(), signed(6))
 441         v3 = Const(0, signed(4)) & Const(0, unsigned(4))
 442         self.assertEqual(v3.shape(), signed(5))
 443         v4 = Const(0, unsigned(4)) & Const(0, signed(4))
 444         self.assertEqual(v4.shape(), signed(5))
 445         v5 = 10 & Const(0, 4)
 446         self.assertEqual(v5.shape(), unsigned(4))
 447
 448     def test_or(self):
 449         v1 = Const(0, unsigned(4)) | Const(0, unsigned(6))
 450         self.assertEqual(repr(v1), "(| (const 4'd0) (const 6'd0))")
 451         self.assertEqual(v1.shape(), unsigned(6))
 452         v2 = Const(0, signed(4)) | Const(0, signed(6))
 453         self.assertEqual(v2.shape(), signed(6))
 454         v3 = Const(0, signed(4)) | Const(0, unsigned(4))
 455         self.assertEqual(v3.shape(), signed(5))
 456         v4 = Const(0, unsigned(4)) | Const(0, signed(4))
 457         self.assertEqual(v4.shape(), signed(5))
 458         v5 = 10 | Const(0, 4)
 459         self.assertEqual(v5.shape(), unsigned(4))
 460
 461     def test_xor(self):
 462         v1 = Const(0, unsigned(4)) ^ Const(0, unsigned(6))
 463         self.assertEqual(repr(v1), "(^ (const 4'd0) (const 6'd0))")
 464         self.assertEqual(v1.shape(), unsigned(6))
 465         v2 = Const(0, signed(4)) ^ Const(0, signed(6))
 466         self.assertEqual(v2.shape(), signed(6))
 467         v3 = Const(0, signed(4)) ^ Const(0, unsigned(4))
 468         self.assertEqual(v3.shape(), signed(5))
 469         v4 = Const(0, unsigned(4)) ^ Const(0, signed(4))
 470         self.assertEqual(v4.shape(), signed(5))
 471         v5 = 10 ^ Const(0, 4)
 472         self.assertEqual(v5.shape(), unsigned(4))
 473
 474     def test_shl(self):
 475         v1 = Const(1, 4) << Const(4)
 476         self.assertEqual(repr(v1), "(<< (const 4'd1) (const 3'd4))")
 477         self.assertEqual(v1.shape(), unsigned(11))
 478
 479     def test_shl_wrong(self):
 480         with self.assertRaisesRegex(TypeError,
 481                 r"^Shift amount must be unsigned$"):
 482             1 << Const(0, signed(6))
 483         with self.assertRaisesRegex(TypeError,
 484                 r"^Shift amount must be unsigned$"):
 485             Const(1, unsigned(4)) << -1
 486
 487     def test_shr(self):
 488         v1 = Const(1, 4) >> Const(4)
 489         self.assertEqual(repr(v1), "(>> (const 4'd1) (const 3'd4))")
 490         self.assertEqual(v1.shape(), unsigned(4))
 491
 492     def test_shr_wrong(self):
 493         with self.assertRaisesRegex(TypeError,
 494                 r"^Shift amount must be unsigned$"):
 495             1 << Const(0, signed(6))
 496         with self.assertRaisesRegex(TypeError,
 497                 r"^Shift amount must be unsigned$"):
 498             Const(1, unsigned(4)) << -1
 499
 500     def test_lt(self):
 501         v = Const(0, 4) < Const(0, 6)
 502         self.assertEqual(repr(v), "(< (const 4'd0) (const 6'd0))")
 503         self.assertEqual(v.shape(), unsigned(1))
 504
 505     def test_le(self):
 506         v = Const(0, 4) <= Const(0, 6)
 507         self.assertEqual(repr(v), "(<= (const 4'd0) (const 6'd0))")
 508         self.assertEqual(v.shape(), unsigned(1))
 509
 510     def test_gt(self):
 511         v = Const(0, 4) > Const(0, 6)
 512         self.assertEqual(repr(v), "(> (const 4'd0) (const 6'd0))")
 513         self.assertEqual(v.shape(), unsigned(1))
 514
 515     def test_ge(self):
 516         v = Const(0, 4) >= Const(0, 6)
 517         self.assertEqual(repr(v), "(>= (const 4'd0) (const 6'd0))")
 518         self.assertEqual(v.shape(), unsigned(1))
 519
 520     def test_eq(self):
 521         v = Const(0, 4) == Const(0, 6)
 522         self.assertEqual(repr(v), "(== (const 4'd0) (const 6'd0))")
 523         self.assertEqual(v.shape(), unsigned(1))
 524
 525     def test_ne(self):
 526         v = Const(0, 4) != Const(0, 6)
 527         self.assertEqual(repr(v), "(!= (const 4'd0) (const 6'd0))")
 528         self.assertEqual(v.shape(), unsigned(1))
 529
 530     def test_mux(self):
 531         s  = Const(0)
 532         v1 = Mux(s, Const(0, unsigned(4)), Const(0, unsigned(6)))
 533         self.assertEqual(repr(v1), "(m (const 1'd0) (const 4'd0) (const 6'd0))")
 534         self.assertEqual(v1.shape(), unsigned(6))
 535         v2 = Mux(s, Const(0, signed(4)), Const(0, signed(6)))
 536         self.assertEqual(v2.shape(), signed(6))
 537         v3 = Mux(s, Const(0, signed(4)), Const(0, unsigned(4)))
 538         self.assertEqual(v3.shape(), signed(5))
 539         v4 = Mux(s, Const(0, unsigned(4)), Const(0, signed(4)))
 540         self.assertEqual(v4.shape(), signed(5))
 541
 542     def test_mux_wide(self):
 543         s = Const(0b100)
 544         v = Mux(s, Const(0, unsigned(4)), Const(0, unsigned(6)))
 545         self.assertEqual(repr(v), "(m (b (const 3'd4)) (const 4'd0) (const 6'd0))")
 546
 547     def test_mux_bool(self):
 548         v = Mux(True, Const(0), Const(0))
 549         self.assertEqual(repr(v), "(m (const 1'd1) (const 1'd0) (const 1'd0))")
 550
 551     def test_bool(self):
 552         v = Const(0).bool()
 553         self.assertEqual(repr(v), "(b (const 1'd0))")
 554         self.assertEqual(v.shape(), unsigned(1))
 555
 556     def test_any(self):
 557         v = Const(0b101).any()
 558         self.assertEqual(repr(v), "(r| (const 3'd5))")
 559
 560     def test_all(self):
 561         v = Const(0b101).all()
 562         self.assertEqual(repr(v), "(r& (const 3'd5))")
 563
 564     def test_xor(self):
 565         v = Const(0b101).xor()
 566         self.assertEqual(repr(v), "(r^ (const 3'd5))")
 567
 568     def test_matches(self):
 569         s = Signal(4)
 570         self.assertRepr(s.matches(), "(const 1'd0)")
 571         self.assertRepr(s.matches(1), """
 572         (== (sig s) (const 1'd1))
 573         """)
 574         self.assertRepr(s.matches(0, 1), """
 575         (r| (cat (== (sig s) (const 1'd0)) (== (sig s) (const 1'd1))))
 576         """)
 577         self.assertRepr(s.matches("10--"), """
 578         (== (& (sig s) (const 4'd12)) (const 4'd8))
 579         """)
 580         self.assertRepr(s.matches("1 0--"), """
 581         (== (& (sig s) (const 4'd12)) (const 4'd8))
 582         """)
 583
 584     def test_matches_enum(self):
 585         s = Signal(SignedEnum)
 586         self.assertRepr(s.matches(SignedEnum.FOO), """
 587         (== (sig s) (const 1'sd-1))
 588         """)
 589
 590     def test_matches_width_wrong(self):
 591         s = Signal(4)
 592         with self.assertRaisesRegex(SyntaxError,
 593                 r"^Match pattern '--' must have the same width as match value \(which is 4\)$"):
 594             s.matches("--")
 595         with self.assertWarnsRegex(SyntaxWarning,
 596                 (r"^Match pattern '10110' is wider than match value \(which has width 4\); "
 597                     r"comparison will never be true$")):
 598             s.matches(0b10110)
 599
 600     def test_matches_bits_wrong(self):
 601         s = Signal(4)
 602         with self.assertRaisesRegex(SyntaxError,
 603                 (r"^Match pattern 'abc' must consist of 0, 1, and - \(don't care\) bits, "
 604                     r"and may include whitespace$")):
 605             s.matches("abc")
 606
 607     def test_matches_pattern_wrong(self):
 608         s = Signal(4)
 609         with self.assertRaisesRegex(SyntaxError,
 610                 r"^Match pattern must be an integer, a string, or an enumeration, not 1\.0$"):
 611             s.matches(1.0)
 612
 613     def test_hash(self):
 614         with self.assertRaises(TypeError):
 615             hash(Const(0) + Const(0))
 616
 617
 618 class SliceTestCase(FHDLTestCase):
 619     def test_shape(self):
 620         s1 = Const(10)[2]
 621         self.assertEqual(s1.shape(), unsigned(1))
 622         self.assertIsInstance(s1.shape(), Shape)
 623         s2 = Const(-10)[0:2]
 624         self.assertEqual(s2.shape(), unsigned(2))
 625
 626     def test_start_end_negative(self):
 627         c  = Const(0, 8)
 628         s1 = Slice(c, 0, -1)
 629         self.assertEqual((s1.start, s1.stop), (0, 7))
 630         s1 = Slice(c, -4, -1)
 631         self.assertEqual((s1.start, s1.stop), (4, 7))
 632
 633     def test_start_end_wrong(self):
 634         with self.assertRaisesRegex(TypeError,
 635                 r"^Slice start must be an integer, not 'x'$"):
 636             Slice(0, "x", 1)
 637         with self.assertRaisesRegex(TypeError,
 638                 r"^Slice stop must be an integer, not 'x'$"):
 639             Slice(0, 1, "x")
 640
 641     def test_start_end_out_of_range(self):
 642         c = Const(0, 8)
 643         with self.assertRaisesRegex(IndexError,
 644                 r"^Cannot start slice 10 bits into 8-bit value$"):
 645             Slice(c, 10, 12)
 646         with self.assertRaisesRegex(IndexError,
 647                 r"^Cannot stop slice 12 bits into 8-bit value$"):
 648             Slice(c, 0, 12)
 649         with self.assertRaisesRegex(IndexError,
 650                 r"^Slice start 4 must be less than slice stop 2$"):
 651             Slice(c, 4, 2)
 652
 653     def test_repr(self):
 654         s1 = Const(10)[2]
 655         self.assertEqual(repr(s1), "(slice (const 4'd10) 2:3)")
 656
 657
 658 class BitSelectTestCase(FHDLTestCase):
 659     def setUp(self):
 660         self.c = Const(0, 8)
 661         self.s = Signal(range(self.c.width))
 662
 663     def test_shape(self):
 664         s1 = self.c.bit_select(self.s, 2)
 665         self.assertIsInstance(s1, Part)
 666         self.assertEqual(s1.shape(), unsigned(2))
 667         self.assertIsInstance(s1.shape(), Shape)
 668         s2 = self.c.bit_select(self.s, 0)
 669         self.assertIsInstance(s2, Part)
 670         self.assertEqual(s2.shape(), unsigned(0))
 671
 672     def test_stride(self):
 673         s1 = self.c.bit_select(self.s, 2)
 674         self.assertIsInstance(s1, Part)
 675         self.assertEqual(s1.stride, 1)
 676
 677     def test_const(self):
 678         s1 = self.c.bit_select(1, 2)
 679         self.assertIsInstance(s1, Slice)
 680         self.assertRepr(s1, """(slice (const 8'd0) 1:3)""")
 681
 682     def test_width_wrong(self):
 683         with self.assertRaises(TypeError):
 684             self.c.bit_select(self.s, -1)
 685
 686     def test_repr(self):
 687         s = self.c.bit_select(self.s, 2)
 688         self.assertEqual(repr(s), "(part (const 8'd0) (sig s) 2 1)")
 689
 690
 691 class WordSelectTestCase(FHDLTestCase):
 692     def setUp(self):
 693         self.c = Const(0, 8)
 694         self.s = Signal(range(self.c.width))
 695
 696     def test_shape(self):
 697         s1 = self.c.word_select(self.s, 2)
 698         self.assertIsInstance(s1, Part)
 699         self.assertEqual(s1.shape(), unsigned(2))
 700         self.assertIsInstance(s1.shape(), Shape)
 701
 702     def test_stride(self):
 703         s1 = self.c.word_select(self.s, 2)
 704         self.assertIsInstance(s1, Part)
 705         self.assertEqual(s1.stride, 2)
 706
 707     def test_const(self):
 708         s1 = self.c.word_select(1, 2)
 709         self.assertIsInstance(s1, Slice)
 710         self.assertRepr(s1, """(slice (const 8'd0) 2:4)""")
 711
 712     def test_width_wrong(self):
 713         with self.assertRaises(TypeError):
 714             self.c.word_select(self.s, 0)
 715         with self.assertRaises(TypeError):
 716             self.c.word_select(self.s, -1)
 717
 718     def test_repr(self):
 719         s = self.c.word_select(self.s, 2)
 720         self.assertEqual(repr(s), "(part (const 8'd0) (sig s) 2 2)")
 721
 722
 723 class CatTestCase(FHDLTestCase):
 724     def test_shape(self):
 725         c0 = Cat()
 726         self.assertEqual(c0.shape(), unsigned(0))
 727         self.assertIsInstance(c0.shape(), Shape)
 728         c1 = Cat(Const(10))
 729         self.assertEqual(c1.shape(), unsigned(4))
 730         c2 = Cat(Const(10), Const(1))
 731         self.assertEqual(c2.shape(), unsigned(5))
 732         c3 = Cat(Const(10), Const(1), Const(0))
 733         self.assertEqual(c3.shape(), unsigned(6))
 734
 735     def test_repr(self):
 736         c1 = Cat(Const(10), Const(1))
 737         self.assertEqual(repr(c1), "(cat (const 4'd10) (const 1'd1))")
 738
 739
 740 class ReplTestCase(FHDLTestCase):
 741     def test_shape(self):
 742         s1 = Repl(Const(10), 3)
 743         self.assertEqual(s1.shape(), unsigned(12))
 744         self.assertIsInstance(s1.shape(), Shape)
 745         s2 = Repl(Const(10), 0)
 746         self.assertEqual(s2.shape(), unsigned(0))
 747
 748     def test_count_wrong(self):
 749         with self.assertRaises(TypeError):
 750             Repl(Const(10), -1)
 751         with self.assertRaises(TypeError):
 752             Repl(Const(10), "str")
 753
 754     def test_repr(self):
 755         s = Repl(Const(10), 3)
 756         self.assertEqual(repr(s), "(repl (const 4'd10) 3)")
 757
 758
 759 class ArrayTestCase(FHDLTestCase):
 760     def test_acts_like_array(self):
 761         a = Array([1,2,3])
 762         self.assertSequenceEqual(a, [1,2,3])
 763         self.assertEqual(a[1], 2)
 764         a[1] = 4
 765         self.assertSequenceEqual(a, [1,4,3])
 766         del a[1]
 767         self.assertSequenceEqual(a, [1,3])
 768         a.insert(1, 2)
 769         self.assertSequenceEqual(a, [1,2,3])
 770
 771     def test_becomes_immutable(self):
 772         a = Array([1,2,3])
 773         s1 = Signal(range(len(a)))
 774         s2 = Signal(range(len(a)))
 775         v1 = a[s1]
 776         v2 = a[s2]
 777         with self.assertRaisesRegex(ValueError,
 778                 r"^Array can no longer be mutated after it was indexed with a value at "):
 779             a[1] = 2
 780         with self.assertRaisesRegex(ValueError,
 781                 r"^Array can no longer be mutated after it was indexed with a value at "):
 782             del a[1]
 783         with self.assertRaisesRegex(ValueError,
 784                 r"^Array can no longer be mutated after it was indexed with a value at "):
 785             a.insert(1, 2)
 786
 787     def test_repr(self):
 788         a = Array([1,2,3])
 789         self.assertEqual(repr(a), "(array mutable [1, 2, 3])")
 790         s = Signal(range(len(a)))
 791         v = a[s]
 792         self.assertEqual(repr(a), "(array [1, 2, 3])")
 793
 794
 795 class ArrayProxyTestCase(FHDLTestCase):
 796     def test_index_shape(self):
 797         m = Array(Array(x * y for y in range(1, 4)) for x in range(1, 4))
 798         a = Signal(range(3))
 799         b = Signal(range(3))
 800         v = m[a][b]
 801         self.assertEqual(v.shape(), unsigned(4))
 802
 803     def test_attr_shape(self):
 804         from collections import namedtuple
 805         pair = namedtuple("pair", ("p", "n"))
 806         a = Array(pair(i, -i) for i in range(10))
 807         s = Signal(range(len(a)))
 808         v = a[s]
 809         self.assertEqual(v.p.shape(), unsigned(4))
 810         self.assertEqual(v.n.shape(), signed(5))
 811
 812     def test_attr_shape_signed(self):
 813         # [unsigned(1), unsigned(1)] → unsigned(1)
 814         a1 = Array([1, 1])
 815         v1 = a1[Const(0)]
 816         self.assertEqual(v1.shape(), unsigned(1))
 817         # [signed(1), signed(1)] → signed(1)
 818         a2 = Array([-1, -1])
 819         v2 = a2[Const(0)]
 820         self.assertEqual(v2.shape(), signed(1))
 821         # [unsigned(1), signed(2)] → signed(2)
 822         a3 = Array([1, -2])
 823         v3 = a3[Const(0)]
 824         self.assertEqual(v3.shape(), signed(2))
 825         # [unsigned(1), signed(1)] → signed(2); 1st operand padded with sign bit!
 826         a4 = Array([1, -1])
 827         v4 = a4[Const(0)]
 828         self.assertEqual(v4.shape(), signed(2))
 829         # [unsigned(2), signed(1)] → signed(3); 1st operand padded with sign bit!
 830         a5 = Array([1, -1])
 831         v5 = a5[Const(0)]
 832         self.assertEqual(v5.shape(), signed(2))
 833
 834     def test_repr(self):
 835         a = Array([1, 2, 3])
 836         s = Signal(range(3))
 837         v = a[s]
 838         self.assertEqual(repr(v), "(proxy (array [1, 2, 3]) (sig s))")
 839
 840
 841 class SignalTestCase(FHDLTestCase):
 842     def test_shape(self):
 843         s1 = Signal()
 844         self.assertEqual(s1.shape(), unsigned(1))
 845         self.assertIsInstance(s1.shape(), Shape)
 846         s2 = Signal(2)
 847         self.assertEqual(s2.shape(), unsigned(2))
 848         s3 = Signal(unsigned(2))
 849         self.assertEqual(s3.shape(), unsigned(2))
 850         s4 = Signal(signed(2))
 851         self.assertEqual(s4.shape(), signed(2))
 852         s5 = Signal(0)
 853         self.assertEqual(s5.shape(), unsigned(0))
 854         s6 = Signal(range(16))
 855         self.assertEqual(s6.shape(), unsigned(4))
 856         s7 = Signal(range(4, 16))
 857         self.assertEqual(s7.shape(), unsigned(4))
 858         s8 = Signal(range(-4, 16))
 859         self.assertEqual(s8.shape(), signed(5))
 860         s9 = Signal(range(-20, 16))
 861         self.assertEqual(s9.shape(), signed(6))
 862         s10 = Signal(range(0))
 863         self.assertEqual(s10.shape(), unsigned(0))
 864         s11 = Signal(range(1))
 865         self.assertEqual(s11.shape(), unsigned(1))
 866
 867     def test_shape_wrong(self):
 868         with self.assertRaisesRegex(TypeError,
 869                 r"^Width must be a non-negative integer, not -10$"):
 870             Signal(-10)
 871
 872     def test_name(self):
 873         s1 = Signal()
 874         self.assertEqual(s1.name, "s1")
 875         s2 = Signal(name="sig")
 876         self.assertEqual(s2.name, "sig")
 877
 878     def test_reset(self):
 879         s1 = Signal(4, reset=0b111, reset_less=True)
 880         self.assertEqual(s1.reset, 0b111)
 881         self.assertEqual(s1.reset_less, True)
 882
 883     def test_reset_enum(self):
 884         s1 = Signal(2, reset=UnsignedEnum.BAR)
 885         self.assertEqual(s1.reset, 2)
 886         with self.assertRaisesRegex(TypeError,
 887                 r"^Reset value has to be an int or an integral Enum$"
 888         ):
 889             Signal(1, reset=StringEnum.FOO)
 890
 891     def test_reset_narrow(self):
 892         with self.assertWarnsRegex(SyntaxWarning,
 893                 r"^Reset value 8 requires 4 bits to represent, but the signal only has 3 bits$"):
 894             Signal(3, reset=8)
 895         with self.assertWarnsRegex(SyntaxWarning,
 896                 r"^Reset value 4 requires 4 bits to represent, but the signal only has 3 bits$"):
 897             Signal(signed(3), reset=4)
 898         with self.assertWarnsRegex(SyntaxWarning,
 899                 r"^Reset value -5 requires 4 bits to represent, but the signal only has 3 bits$"):
 900             Signal(signed(3), reset=-5)
 901
 902     def test_attrs(self):
 903         s1 = Signal()
 904         self.assertEqual(s1.attrs, {})
 905         s2 = Signal(attrs={"no_retiming": True})
 906         self.assertEqual(s2.attrs, {"no_retiming": True})
 907
 908     def test_repr(self):
 909         s1 = Signal()
 910         self.assertEqual(repr(s1), "(sig s1)")
 911
 912     def test_like(self):
 913         s1 = Signal.like(Signal(4))
 914         self.assertEqual(s1.shape(), unsigned(4))
 915         s2 = Signal.like(Signal(range(-15, 1)))
 916         self.assertEqual(s2.shape(), signed(5))
 917         s3 = Signal.like(Signal(4, reset=0b111, reset_less=True))
 918         self.assertEqual(s3.reset, 0b111)
 919         self.assertEqual(s3.reset_less, True)
 920         s4 = Signal.like(Signal(attrs={"no_retiming": True}))
 921         self.assertEqual(s4.attrs, {"no_retiming": True})
 922         s5 = Signal.like(Signal(decoder=str))
 923         self.assertEqual(s5.decoder, str)
 924         s6 = Signal.like(10)
 925         self.assertEqual(s6.shape(), unsigned(4))
 926         s7 = [Signal.like(Signal(4))][0]
 927         self.assertEqual(s7.name, "$like")
 928         s8 = Signal.like(s1, name_suffix="_ff")
 929         self.assertEqual(s8.name, "s1_ff")
 930
 931     def test_decoder(self):
 932         class Color(Enum):
 933             RED  = 1
 934             BLUE = 2
 935         s = Signal(decoder=Color)
 936         self.assertEqual(s.decoder(1), "RED/1")
 937         self.assertEqual(s.decoder(3), "3")
 938
 939     def test_enum(self):
 940         s1 = Signal(UnsignedEnum)
 941         self.assertEqual(s1.shape(), unsigned(2))
 942         s2 = Signal(SignedEnum)
 943         self.assertEqual(s2.shape(), signed(2))
 944         self.assertEqual(s2.decoder(SignedEnum.FOO), "FOO/-1")
 945
 946
 947 class ClockSignalTestCase(FHDLTestCase):
 948     def test_domain(self):
 949         s1 = ClockSignal()
 950         self.assertEqual(s1.domain, "sync")
 951         s2 = ClockSignal("pix")
 952         self.assertEqual(s2.domain, "pix")
 953
 954         with self.assertRaisesRegex(TypeError,
 955                 r"^Clock domain name must be a string, not 1$"):
 956             ClockSignal(1)
 957
 958     def test_shape(self):
 959         s1 = ClockSignal()
 960         self.assertEqual(s1.shape(), unsigned(1))
 961         self.assertIsInstance(s1.shape(), Shape)
 962
 963     def test_repr(self):
 964         s1 = ClockSignal()
 965         self.assertEqual(repr(s1), "(clk sync)")
 966
 967     def test_wrong_name_comb(self):
 968         with self.assertRaisesRegex(ValueError,
 969                 r"^Domain 'comb' does not have a clock$"):
 970             ClockSignal("comb")
 971
 972
 973 class ResetSignalTestCase(FHDLTestCase):
 974     def test_domain(self):
 975         s1 = ResetSignal()
 976         self.assertEqual(s1.domain, "sync")
 977         s2 = ResetSignal("pix")
 978         self.assertEqual(s2.domain, "pix")
 979
 980         with self.assertRaisesRegex(TypeError,
 981                 r"^Clock domain name must be a string, not 1$"):
 982             ResetSignal(1)
 983
 984     def test_shape(self):
 985         s1 = ResetSignal()
 986         self.assertEqual(s1.shape(), unsigned(1))
 987         self.assertIsInstance(s1.shape(), Shape)
 988
 989     def test_repr(self):
 990         s1 = ResetSignal()
 991         self.assertEqual(repr(s1), "(rst sync)")
 992
 993     def test_wrong_name_comb(self):
 994         with self.assertRaisesRegex(ValueError,
 995                 r"^Domain 'comb' does not have a reset$"):
 996             ResetSignal("comb")
 997
 998
 999 class MockUserValue(UserValue):
1000     def __init__(self, lowered):
1001         super().__init__()
1002         self.lower_count = 0
1003         self.lowered     = lowered
1004
1005     def lower(self):
1006         self.lower_count += 1
1007         return self.lowered
1008
1009
1010 class UserValueTestCase(FHDLTestCase):
1011     def test_shape(self):
1012         uv = MockUserValue(1)
1013         self.assertEqual(uv.shape(), unsigned(1))
1014         self.assertIsInstance(uv.shape(), Shape)
1015         uv.lowered = 2
1016         self.assertEqual(uv.shape(), unsigned(1))
1017         self.assertEqual(uv.lower_count, 1)
1018
1019     def test_lower_to_user_value(self):
1020         uv = MockUserValue(MockUserValue(1))
1021         self.assertEqual(uv.shape(), unsigned(1))
1022         self.assertIsInstance(uv.shape(), Shape)
1023         uv.lowered = MockUserValue(2)
1024         self.assertEqual(uv.shape(), unsigned(1))
1025         self.assertEqual(uv.lower_count, 1)
1026
1027
1028 class SampleTestCase(FHDLTestCase):
1029     def test_const(self):
1030         s = Sample(1, 1, "sync")
1031         self.assertEqual(s.shape(), unsigned(1))
1032
1033     def test_signal(self):
1034         s1 = Sample(Signal(2), 1, "sync")
1035         self.assertEqual(s1.shape(), unsigned(2))
1036         s2 = Sample(ClockSignal(), 1, "sync")
1037         s3 = Sample(ResetSignal(), 1, "sync")
1038
1039     def test_wrong_value_operator(self):
1040         with self.assertRaisesRegex(TypeError,
1041                 (r"^Sampled value must be a signal or a constant, not "
1042                 r"\(\+ \(sig \$signal\) \(const 1'd1\)\)$")):
1043             Sample(Signal() + 1, 1, "sync")
1044
1045     def test_wrong_clocks_neg(self):
1046         with self.assertRaisesRegex(ValueError,
1047                 r"^Cannot sample a value 1 cycles in the future$"):
1048             Sample(Signal(), -1, "sync")
1049
1050     def test_wrong_domain(self):
1051         with self.assertRaisesRegex(TypeError,
1052                 r"^Domain name must be a string or None, not 0$"):
1053             Sample(Signal(), 1, 0)
1054
1055
1056 class InitialTestCase(FHDLTestCase):
1057     def test_initial(self):
1058         i = Initial()
1059         self.assertEqual(i.shape(), unsigned(1))