vpi 0.5.0

Safe and ergonomic Rust bindings to the Verilog and SystemVerilog VPI C API for writing VPI applications in Rust.
Documentation
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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
use num_derive::{FromPrimitive, ToPrimitive};
use num_traits::FromPrimitive;
use vpi_sys::PLI_INT32;

use crate::{Handle, ObjectType, Value, ValueType};

/// VPI property identifiers used with `vpi_get` and `vpi_get_str`.
///
/// Values map directly to `vpi_sys::vpi*` property constants.
#[repr(i32)]
#[derive(FromPrimitive, ToPrimitive, Debug, Clone, PartialEq, Eq)]
pub enum Property {
    /// -1: undefined property
    Undefined = vpi_sys::vpiUndefined,

    // Basic object properties (1-18)
    /// 1: type of object
    Type = vpi_sys::vpiType as i32,
    /// 2: local name of object
    Name = vpi_sys::vpiName as i32,
    /// 3: full hierarchical name
    FullName = vpi_sys::vpiFullName as i32,
    /// 4: size of gate, net, port, etc.
    Size = vpi_sys::vpiSize as i32,
    /// 5: file name in which object is used
    File = vpi_sys::vpiFile as i32,
    /// 6: line number where object is used
    LineNo = vpi_sys::vpiLineNo as i32,
    /// 7: top-level module (boolean)
    TopModule = vpi_sys::vpiTopModule as i32,
    /// 8: cell (boolean)
    CellInstance = vpi_sys::vpiCellInstance as i32,
    /// 9: module definition name
    DefName = vpi_sys::vpiDefName as i32,
    /// 10: source protected module (boolean)
    Protected = vpi_sys::vpiProtected as i32,
    /// 11: module time unit
    TimeUnit = vpi_sys::vpiTimeUnit as i32,
    /// 12: module time precision
    TimePrecision = vpi_sys::vpiTimePrecision as i32,
    /// 13: default net type
    DefNetType = vpi_sys::vpiDefNetType as i32,
    /// 14: unconnected port drive strength
    UnconnDrive = vpi_sys::vpiUnconnDrive as i32,
    /// 15: file name where module is defined
    DefFile = vpi_sys::vpiDefFile as i32,
    /// 16: line number for module definition
    DefLineNo = vpi_sys::vpiDefLineNo as i32,
    /// 17: scalar (boolean)
    Scalar = vpi_sys::vpiScalar as i32,
    /// 18: vector (boolean)
    Vector = vpi_sys::vpiVector as i32,

    // Net and port properties (19-29)
    /// 19: port is explicitly named (boolean)
    ExplicitName = vpi_sys::vpiExplicitName as i32,
    /// 20: direction of port
    Direction = vpi_sys::vpiDirection as i32,
    /// 21: connected by name (boolean)
    ConnByName = vpi_sys::vpiConnByName as i32,
    /// 22: net subtypes
    NetType = vpi_sys::vpiNetType as i32,
    /// 23: explicitly scalared (boolean)
    ExplicitScalared = vpi_sys::vpiExplicitScalared as i32,
    /// 24: explicitly vectored (boolean)
    ExplicitVectored = vpi_sys::vpiExplicitVectored as i32,
    /// 25: expanded vector net (boolean)
    Expanded = vpi_sys::vpiExpanded as i32,
    /// 26: implicitly declared net (boolean)
    ImplicitDecl = vpi_sys::vpiImplicitDecl as i32,
    /// 27: charge decay strength of net
    ChargeStrength = vpi_sys::vpiChargeStrength as i32,
    /// 28: variable array (boolean)
    Array = vpi_sys::vpiArray as i32,
    /// 29: port index
    PortIndex = vpi_sys::vpiPortIndex as i32,

    // Gate and terminal properties (30-40)
    /// 30: index of primitive terminal
    TermIndex = vpi_sys::vpiTermIndex as i32,
    /// 31: 0-strength of net or gate
    Strength0 = vpi_sys::vpiStrength0 as i32,
    /// 32: 1-strength of net or gate
    Strength1 = vpi_sys::vpiStrength1 as i32,
    /// 33: primitive subtypes
    PrimType = vpi_sys::vpiPrimType as i32,
    /// 34: polarity of module path
    Polarity = vpi_sys::vpiPolarity as i32,
    /// 35: data path polarity
    DataPolarity = vpi_sys::vpiDataPolarity as i32,
    /// 36: edge type of module path
    Edge = vpi_sys::vpiEdge as i32,
    /// 37: path delay connection subtypes
    PathType = vpi_sys::vpiPathType as i32,
    /// 38: timing check subtypes
    TchkType = vpi_sys::vpiTchkType as i32,
    /// 39: operation subtypes (see `OpType` enum)
    OpType = vpi_sys::vpiOpType as i32,
    /// 40: constant subtypes
    ConstType = vpi_sys::vpiConstType as i32,

    // Additional properties (41-70)
    /// 41: blocking assignment (boolean)
    Blocking = vpi_sys::vpiBlocking as i32,
    /// 42: case statement subtypes
    CaseType = vpi_sys::vpiCaseType as i32,
    /// 43: assign part of decl (boolean)
    NetDeclAssign = vpi_sys::vpiNetDeclAssign as i32,
    /// 44: HDL function & system function type
    FuncType = vpi_sys::vpiFuncType as i32,
    /// 45: user-defined system task/func (boolean)
    UserDefn = vpi_sys::vpiUserDefn as i32,
    /// 46: object still scheduled (boolean)
    Scheduled = vpi_sys::vpiScheduled as i32,
    /// 47: default delay mode for a module
    DefDelayMode = vpi_sys::vpiDefDelayMode as i32,
    /// 48: default decay time for a module
    DefDecayTime = vpi_sys::vpiDefDecayTime as i32,
    /// 49: reentrant task/func frame is active
    Active = vpi_sys::vpiActive as i32,
    /// 50: task/func object is automatic
    Automatic = vpi_sys::vpiAutomatic as i32,
    /// 51: configuration cell
    Cell = vpi_sys::vpiCell as i32,
    /// 52: configuration config file
    Config = vpi_sys::vpiConfig as i32,
    /// 53: bit-select/part-select indices are constant
    ConstantSelect = vpi_sys::vpiConstantSelect as i32,
    /// 54: decompile the object
    Decompile = vpi_sys::vpiDecompile as i32,
    /// 55: attribute defined for the object
    DefAttribute = vpi_sys::vpiDefAttribute as i32,
    /// 56: delay subtype
    DelayType = vpi_sys::vpiDelayType as i32,
    /// 57: object type of an iterator
    IteratorType = vpi_sys::vpiIteratorType as i32,
    /// 58: configuration library
    Library = vpi_sys::vpiLibrary as i32,
    /// 59: object is a multidimensional array
    MultiArray = vpi_sys::vpiMultiArray as i32,
    /// 60: offset from LSB
    Offset = vpi_sys::vpiOffset as i32,
    /// 61: net subtype after resolution
    Resolved = vpi_sys::vpiResolvedNetType as i32,
    /// 62: unique ID for save/restart data
    SaveRestartID = vpi_sys::vpiSaveRestartID as i32,
    /// 63: name of save/restart data file
    SaveRestartLocation = vpi_sys::vpiSaveRestartLocation as i32,
    /// 64: reentrant task/func frame is valid
    Valid = vpi_sys::vpiValid as i32,
    /// 65: true for signed objects
    Signed = vpi_sys::vpiSigned as i32,
    /// 66: execute simulator's $stop, control operation
    Stop = vpi_sys::vpiStop as i32,
    /// 67: execute simulator's $finish, control operation
    Finish = vpi_sys::vpiFinish as i32,
    /// 68: execute simulator's $reset, control operation
    Reset = vpi_sys::vpiReset as i32,
    /// 69: set simulator's interactive scope
    SetInteractiveScope = vpi_sys::vpiSetInteractiveScope as i32,
    /// 70: true when a param is declared as localparam
    LocalParam = vpi_sys::vpiLocalParam as i32,

    // Extended properties (71-74, added with 1364-2001 and 1364-2005)
    /// 71: Mod path has an ifnone statement
    ModPathHasIfNone = vpi_sys::vpiModPathHasIfNone as i32,
    /// 72: Indexed part-select type
    IndexedPartSelectType = vpi_sys::vpiIndexedPartSelectType as i32,
    /// 73: TRUE for a one-dimensional reg array
    IsMemory = vpi_sys::vpiIsMemory as i32,
    /// 74: TRUE for protected design information
    IsProtected = vpi_sys::vpiIsProtected as i32,

    #[cfg(feature = "sv")]
    // SystemVerilog properties (600-670)
    /// 600: top-level module
    Top = vpi_sys::vpiTop as i32,
    #[cfg(feature = "sv")]
    /// 602: design unit (package, module, etc.)
    Unit = vpi_sys::vpiUnit as i32,
    #[cfg(feature = "sv")]
    /// 603: join type of fork-join block
    JoinType = vpi_sys::vpiJoinType as i32,
    #[cfg(feature = "sv")]
    /// 604: access type (fork-join, extern, DPI)
    AccessType = vpi_sys::vpiAccessType as i32,
    #[cfg(feature = "sv")]
    /// 606: array type (static, dynamic, associative, queue)
    ArrayType = vpi_sys::vpiArrayType as i32,
    #[cfg(feature = "sv")]
    /// 607: array member
    ArrayMember = vpi_sys::vpiArrayMember as i32,
    #[cfg(feature = "sv")]
    /// 608: object is randomized
    IsRandomized = vpi_sys::vpiIsRandomized as i32,
    #[cfg(feature = "sv")]
    /// 609: local variable declarations
    LocalVarDecls = vpi_sys::vpiLocalVarDecls as i32,
    #[cfg(feature = "sv")]
    /// 610: randomization type (rand, randc, `not_rand`)
    RandType = vpi_sys::vpiRandType as i32,
    #[cfg(feature = "sv")]
    /// 611: interface or modport port type
    PortType = vpi_sys::vpiPortType as i32,
    #[cfg(feature = "sv")]
    /// 612: variable is a constant
    ConstantVariable = vpi_sys::vpiConstantVariable as i32,
    #[cfg(feature = "sv")]
    /// 615: struct/union member
    StructUnionMember = vpi_sys::vpiStructUnionMember as i32,
    #[cfg(feature = "sv")]
    /// 620: visibility of class member (public, protected, local)
    Visibility = vpi_sys::vpiVisibility as i32,
    #[cfg(feature = "sv")]
    /// 624: always block type (`always_comb`, `always_ff`, `always_latch`)
    AlwaysType = vpi_sys::vpiAlwaysType as i32,
    #[cfg(feature = "sv")]
    /// 625: distribution constraint type
    DistType = vpi_sys::vpiDistType as i32,
    #[cfg(feature = "sv")]
    /// 630: data is packed
    Packed = vpi_sys::vpiPacked as i32,
    #[cfg(feature = "sv")]
    /// 632: tagged union or type
    Tagged = vpi_sys::vpiTagged as i32,
    #[cfg(feature = "sv")]
    /// 635: class is virtual
    Virtual = vpi_sys::vpiVirtual as i32,
    #[cfg(feature = "sv")]
    /// 636: class has actual object
    HasActual = vpi_sys::vpiHasActual as i32,
    #[cfg(feature = "sv")]
    /// 638: constraint is enabled
    IsConstraintEnabled = vpi_sys::vpiIsConstraintEnabled as i32,
    #[cfg(feature = "sv")]
    /// 639: constraint is soft
    Soft = vpi_sys::vpiSoft as i32,
    #[cfg(feature = "sv")]
    /// 640: type of built-in class
    ClassType = vpi_sys::vpiClassType as i32,
    #[cfg(feature = "sv")]
    /// 645: is a class method
    Method = vpi_sys::vpiMethod as i32,
    #[cfg(feature = "sv")]
    /// 649: clock is inferred
    IsClockInferred = vpi_sys::vpiIsClockInferred as i32,
    #[cfg(feature = "sv")]
    /// 650: qualifier for case/priority
    Qualifier = vpi_sys::vpiQualifier as i32,
    #[cfg(feature = "sv")]
    /// 651: input edge type
    InputEdge = vpi_sys::vpiInputEdge as i32,
    #[cfg(feature = "sv")]
    /// 652: output edge type
    OutputEdge = vpi_sys::vpiOutputEdge as i32,
    #[cfg(feature = "sv")]
    /// 653: is generic module
    Generic = vpi_sys::vpiGeneric as i32,
    #[cfg(feature = "sv")]
    /// 654: compatibility mode
    CompatibilityMode = vpi_sys::vpiCompatibilityMode as i32,
    #[cfg(feature = "sv")]
    /// 655: packed array member
    PackedArrayMember = vpi_sys::vpiPackedArrayMember as i32,
    #[cfg(feature = "sv")]
    /// 656: strength of temporal operator
    OpStrong = vpi_sys::vpiOpStrong as i32,
    #[cfg(feature = "sv")]
    /// 657: deferred assertion
    IsDeferred = vpi_sys::vpiIsDeferred as i32,
    #[cfg(feature = "sv")]
    /// 658: memory allocation scheme
    AllocScheme = vpi_sys::vpiAllocScheme as i32,
    #[cfg(feature = "sv")]
    /// 659: is a cover sequence
    IsCoverSequence = vpi_sys::vpiIsCoverSequence as i32,
    #[cfg(feature = "sv")]
    /// 660: unique object ID
    ObjId = vpi_sys::vpiObjId as i32,
    #[cfg(feature = "sv")]
    /// 661: start line number
    StartLine = vpi_sys::vpiStartLine as i32,
    #[cfg(feature = "sv")]
    /// 662: column number
    Column = vpi_sys::vpiColumn as i32,
    #[cfg(feature = "sv")]
    /// 663: end line number
    EndLine = vpi_sys::vpiEndLine as i32,
    #[cfg(feature = "sv")]
    /// 664: end column number
    EndColumn = vpi_sys::vpiEndColumn as i32,
    #[cfg(feature = "sv")]
    /// 665: DPI pure function
    DPIPure = vpi_sys::vpiDPIPure as i32,
    #[cfg(feature = "sv")]
    /// 666: DPI context function
    DPIContext = vpi_sys::vpiDPIContext as i32,
    #[cfg(feature = "sv")]
    /// 667: DPI C string handling
    DPICStr = vpi_sys::vpiDPICStr as i32,
    #[cfg(feature = "sv")]
    /// 668: DPI C identifier
    DPICIdentifier = vpi_sys::vpiDPICIdentifier as i32,
    #[cfg(feature = "sv")]
    /// 669: is a module port
    IsModPort = vpi_sys::vpiIsModPort as i32,
    #[cfg(feature = "sv")]
    /// 670: is a final block
    IsFinal = vpi_sys::vpiIsFinal as i32,
}

impl Property {
    /// Alias retained for compatibility with legacy naming.
    #[allow(non_upper_case_globals)]
    pub const SysFuncType: Self = Property::FuncType;
}

/// Port direction classification.
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Debug, Clone, PartialEq, Eq)]
pub enum Direction {
    Input = vpi_sys::vpiInput,
    Output = vpi_sys::vpiOutput,
    Inout = vpi_sys::vpiInout,
    MixedIO = vpi_sys::vpiMixedIO,
    NoDirection = vpi_sys::vpiNoDirection,
}

impl std::fmt::Display for Direction {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Direction::Input => write!(f, "Input"),
            Direction::Output => write!(f, "Output"),
            Direction::Inout => write!(f, "Inout"),
            Direction::MixedIO => write!(f, "MixedIO"),
            Direction::NoDirection => write!(f, "NoDirection"),
        }
    }
}

/// Net type classification for net objects.
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Debug, Clone, PartialEq, Eq)]
pub enum NetType {
    Wire = vpi_sys::vpiWire,
    Wand = vpi_sys::vpiWand,
    Wor = vpi_sys::vpiWor,
    Tri = vpi_sys::vpiTri,
    Tri0 = vpi_sys::vpiTri0,
    Tri1 = vpi_sys::vpiTri1,
    TriReg = vpi_sys::vpiTriReg,
    TriAnd = vpi_sys::vpiTriAnd,
    TriOr = vpi_sys::vpiTriOr,
    Supply0 = vpi_sys::vpiSupply0,
    Supply1 = vpi_sys::vpiSupply1,
    None = vpi_sys::vpiNone,
    UWire = vpi_sys::vpiUwire,
}

bitflags::bitflags! {
    /// Edge sensitivity mask values.
    pub struct Edge: u32 {
        const NoEdge = vpi_sys::vpiNoEdge;
        const Edge01 = vpi_sys::vpiEdge01;
        const Edge10 = vpi_sys::vpiEdge10;
        const Edge0x = vpi_sys::vpiEdge0x;
        const Edge1x = vpi_sys::vpiEdge1x;
        const Edgex0 = vpi_sys::vpiEdgex0;
        const Edgex1 = vpi_sys::vpiEdgex1;
        const Posedge = vpi_sys::vpiPosedge;
        const Negedge = vpi_sys::vpiNegedge;
        const AnyEdge = vpi_sys::vpiAnyEdge;
    }
}

/// Literal/constant encoding type.
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Debug, Clone, PartialEq, Eq)]
pub enum ConstType {
    Dec = vpi_sys::vpiDecConst,
    Binary = vpi_sys::vpiBinaryConst,
    Oct = vpi_sys::vpiOctConst,
    Hex = vpi_sys::vpiHexConst,
    Int = vpi_sys::vpiIntConst,
    Real = vpi_sys::vpiRealConst,
    String = vpi_sys::vpiStringConst,
    Time = vpi_sys::vpiTimeConst,

    #[cfg(feature = "sv")]
    /// one-step constant expression (added with 1800-2005)
    OneStep = vpi_sys::vpiOneStepConst,
    #[cfg(feature = "sv")]
    /// unbounded constant (added with 1800-2005)
    Unbounded = vpi_sys::vpiUnboundedConst,
    #[cfg(feature = "sv")]
    /// null constant (added with 1800-2005)
    Null = vpi_sys::vpiNullConst,
}

/// Function return type classification.
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Debug, Clone, PartialEq, Eq)]
pub enum FuncType {
    Int = vpi_sys::vpiIntFunc,
    Real = vpi_sys::vpiRealFunc,
    Time = vpi_sys::vpiTimeFunc,
    Sized = vpi_sys::vpiSizedFunc,
    SizedSigned = vpi_sys::vpiSizedSignedFunc,
    #[cfg(feature = "sv")]
    Other = vpi_sys::vpiOtherFunc,
}

/// System function return type classification.
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Debug, Clone, PartialEq, Eq)]
pub enum SysFuncType {
    Int = vpi_sys::vpiSysFuncInt,
    Real = vpi_sys::vpiSysFuncReal,
    Time = vpi_sys::vpiSysFuncTime,
    Sized = vpi_sys::vpiSysFuncSized,
}

#[cfg(feature = "sv")]
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Copy, Clone, Debug, PartialEq, Eq)]
/// SystemVerilog randomization qualifier for variables.
pub enum RandType {
    /// Variable is not randomized.
    NotRand = vpi_sys::vpiNotRand,
    /// Variable is randomized with `rand`.
    Rand = vpi_sys::vpiRand,
    /// Variable is randomized with `randc`.
    RandC = vpi_sys::vpiRandC,
}

#[cfg(feature = "sv")]
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Copy, Clone, Debug, PartialEq, Eq)]
/// SystemVerilog distribution style used by distribution constraints.
pub enum DistType {
    /// Equal-distribution constraint.
    Equal = vpi_sys::vpiEqualDist,
    /// Divided-distribution constraint.
    Div = vpi_sys::vpiDivDist,
}

/// Primitive instance subtype.
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Debug, Clone, PartialEq, Eq)]
pub enum PrimType {
    // Logic gates (1-8)
    /// 1: and gate
    And = vpi_sys::vpiAndPrim,
    /// 2: nand gate
    Nand = vpi_sys::vpiNandPrim,
    /// 3: nor gate
    Nor = vpi_sys::vpiNorPrim,
    /// 4: or gate
    Or = vpi_sys::vpiOrPrim,
    /// 5: xor gate
    Xor = vpi_sys::vpiXorPrim,
    /// 6: xnor gate
    Xnor = vpi_sys::vpiXnorPrim,
    /// 7: buffer
    Buf = vpi_sys::vpiBufPrim,
    /// 8: not gate
    Not = vpi_sys::vpiNotPrim,

    // Tri-state and controlled logic gates (9-12)
    /// 9: zero-enabled buffer
    Bufif0 = vpi_sys::vpiBufif0Prim,
    /// 10: one-enabled buffer
    Bufif1 = vpi_sys::vpiBufif1Prim,
    /// 11: zero-enabled not gate
    Notif0 = vpi_sys::vpiNotif0Prim,
    /// 12: one-enabled not gate
    Notif1 = vpi_sys::vpiNotif1Prim,

    // MOS switches (13-15)
    /// 13: nmos switch
    Nmos = vpi_sys::vpiNmosPrim,
    /// 14: pmos switch
    Pmos = vpi_sys::vpiPmosPrim,
    /// 15: cmos switch
    Cmos = vpi_sys::vpiCmosPrim,

    // Resistive MOS switches (16-18)
    /// 16: resistive nmos switch
    Rnmos = vpi_sys::vpiRnmosPrim,
    /// 17: resistive pmos switch
    Rpmos = vpi_sys::vpiRpmosPrim,
    /// 18: resistive cmos switch
    Rcmos = vpi_sys::vpiRcmosPrim,

    // Bidirectional and resistive switches (19-24)
    /// 19: resistive bidirectional
    Rtran = vpi_sys::vpiRtranPrim,
    /// 20: zero-enable resistive bidirectional
    Rtranif0 = vpi_sys::vpiRtranif0Prim,
    /// 21: one-enable resistive bidirectional
    Rtranif1 = vpi_sys::vpiRtranif1Prim,
    /// 22: bidirectional
    Tran = vpi_sys::vpiTranPrim,
    /// 23: zero-enabled bidirectional
    Tranif0 = vpi_sys::vpiTranif0Prim,
    /// 24: one-enabled bidirectional
    Tranif1 = vpi_sys::vpiTranif1Prim,

    // Pull-up/pull-down and UDP (25-28)
    /// 25: pullup
    Pullup = vpi_sys::vpiPullupPrim,
    /// 26: pulldown
    Pulldown = vpi_sys::vpiPulldownPrim,
    /// 27: sequential UDP
    Seq = vpi_sys::vpiSeqPrim,
    /// 28: combinational UDP
    Comb = vpi_sys::vpiCombPrim,
}

/// Timing check subtype.
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Debug, Clone, PartialEq, Eq)]
pub enum TchkType {
    /// 1: $setup timing check
    Setup = vpi_sys::vpiSetup,
    /// 2: $hold timing check
    Hold = vpi_sys::vpiHold,
    /// 3: $period timing check
    Period = vpi_sys::vpiPeriod,
    /// 4: $width timing check
    Width = vpi_sys::vpiWidth,
    /// 5: $skew timing check
    Skew = vpi_sys::vpiSkew,
    /// 6: $recovery timing check
    Recovery = vpi_sys::vpiRecovery,
    /// 7: $nochange timing check
    NoChange = vpi_sys::vpiNoChange,
    /// 8: $setuphold timing check (added with 1364-2001)
    SetupHold = vpi_sys::vpiSetupHold,
    /// 9: $fullskew timing check (added with 1364-2001)
    Fullskew = vpi_sys::vpiFullskew,
    /// 10: $recrem timing check (added with 1364-2001)
    Recrem = vpi_sys::vpiRecrem,
    /// 11: $removal timing check (added with 1364-2001)
    Removal = vpi_sys::vpiRemoval,
    /// 12: $timeskew timing check (added with 1364-2001)
    Timeskew = vpi_sys::vpiTimeskew,
}

/// Operation subtype for expression objects.
#[repr(u32)]
#[derive(FromPrimitive, ToPrimitive, Debug, Clone, PartialEq, Eq)]
pub enum OpType {
    // Unary operators (1-10)
    /// 1: unary minus
    Minus = vpi_sys::vpiMinusOp,
    /// 2: unary plus
    Plus = vpi_sys::vpiPlusOp,
    /// 3: unary logical not
    Not = vpi_sys::vpiNotOp,
    /// 4: unary bitwise negation
    BitNeg = vpi_sys::vpiBitNegOp,
    /// 5: bitwise reduction AND
    UnaryAnd = vpi_sys::vpiUnaryAndOp,
    /// 6: bitwise reduction NAND
    UnaryNand = vpi_sys::vpiUnaryNandOp,
    /// 7: bitwise reduction OR
    UnaryOr = vpi_sys::vpiUnaryOrOp,
    /// 8: bitwise reduction NOR
    UnaryNor = vpi_sys::vpiUnaryNorOp,
    /// 9: bitwise reduction XOR
    UnaryXor = vpi_sys::vpiUnaryXorOp,
    /// 10: bitwise reduction XNOR
    UnaryXNor = vpi_sys::vpiUnaryXNorOp,

    // Binary arithmetic operators (11-25)
    /// 11: binary subtraction
    Sub = vpi_sys::vpiSubOp,
    /// 12: binary division
    Div = vpi_sys::vpiDivOp,
    /// 13: binary modulus
    Mod = vpi_sys::vpiModOp,

    // Comparison operators (14-21)
    /// 14: equality
    Eq = vpi_sys::vpiEqOp,
    /// 15: inequality
    Neq = vpi_sys::vpiNeqOp,
    /// 16: case equality (x and z aware)
    CaseEq = vpi_sys::vpiCaseEqOp,
    /// 17: case inequality
    CaseNeq = vpi_sys::vpiCaseNeqOp,
    /// 18: greater than
    Gt = vpi_sys::vpiGtOp,
    /// 19: greater than or equal
    Ge = vpi_sys::vpiGeOp,
    /// 20: less than
    Lt = vpi_sys::vpiLtOp,
    /// 21: less than or equal
    Le = vpi_sys::vpiLeOp,

    // Shift operators (22-23)
    /// 22: left shift
    LShift = vpi_sys::vpiLShiftOp,
    /// 23: right shift
    RShift = vpi_sys::vpiRShiftOp,

    // Arithmetic operators (24-25)
    /// 24: addition
    Add = vpi_sys::vpiAddOp,
    /// 25: multiplication
    Mult = vpi_sys::vpiMultOp,

    // Logical operators (26-27)
    /// 26: logical AND
    LogAnd = vpi_sys::vpiLogAndOp,
    /// 27: logical OR
    LogOr = vpi_sys::vpiLogOrOp,

    // Bitwise operators (28-31)
    /// 28: bitwise AND
    BitAnd = vpi_sys::vpiBitAndOp,
    /// 29: bitwise OR
    BitOr = vpi_sys::vpiBitOrOp,
    /// 30: bitwise XOR
    BitXor = vpi_sys::vpiBitXorOp,
    /// 31: bitwise XNOR
    BitXnor = vpi_sys::vpiBitXNorOp,

    // Ternary and higher operators (32-40)
    /// 32: ternary conditional (? :)
    Condition = vpi_sys::vpiConditionOp,
    /// 33: concatenation
    Concat = vpi_sys::vpiConcatOp,
    /// 34: repeated concatenation
    MultiConcat = vpi_sys::vpiMultiConcatOp,
    /// 35: event OR
    EventOr = vpi_sys::vpiEventOrOp,
    /// 36: null operation
    Null = vpi_sys::vpiNullOp,
    /// 37: list of expressions
    List = vpi_sys::vpiListOp,
    /// 38: min:typ:max delay expression
    MinTypMax = vpi_sys::vpiMinTypMaxOp,
    /// 39: posedge
    Posedge = vpi_sys::vpiPosedgeOp,
    /// 40: negedge
    Negedge = vpi_sys::vpiNegedgeOp,

    // Power and arithmetic shifts (41-43)
    /// 41: arithmetic left shift
    ArithLShift = vpi_sys::vpiArithLShiftOp,
    /// 42: arithmetic right shift
    ArithRShift = vpi_sys::vpiArithRShiftOp,
    /// 43: power/exponentiation
    Power = vpi_sys::vpiPowerOp,

    #[cfg(feature = "sv")]
    // SystemVerilog sequence and property operators (50-98)
    /// 50: implication operator (->)
    Imply = vpi_sys::vpiImplyOp,
    #[cfg(feature = "sv")]
    /// 51: non-overlapping implication operator (|=>)
    NonOverlapImply = vpi_sys::vpiNonOverlapImplyOp,
    #[cfg(feature = "sv")]
    /// 52: overlapping implication operator (|->)
    OverlapImply = vpi_sys::vpiOverlapImplyOp,
    #[cfg(feature = "sv")]
    /// 53: unary cycle delay operator (##)
    UnaryCycleDelay = vpi_sys::vpiUnaryCycleDelayOp,
    #[cfg(feature = "sv")]
    /// 54: binary cycle delay operator (##)
    CycleDelay = vpi_sys::vpiCycleDelayOp,
    #[cfg(feature = "sv")]
    /// 55: sequence intersection operator
    Intersect = vpi_sys::vpiIntersectOp,
    #[cfg(feature = "sv")]
    /// 56: `first_match` operator
    FirstMatch = vpi_sys::vpiFirstMatchOp,
    #[cfg(feature = "sv")]
    /// 57: throughout operator
    Throughout = vpi_sys::vpiThroughoutOp,
    #[cfg(feature = "sv")]
    /// 58: within operator
    Within = vpi_sys::vpiWithinOp,
    #[cfg(feature = "sv")]
    /// 59: non-consecutive repetition operator ([=])
    Repeat = vpi_sys::vpiRepeatOp,
    #[cfg(feature = "sv")]
    /// 60: consecutive repetition operator ([*])
    ConsecutiveRepeat = vpi_sys::vpiConsecutiveRepeatOp,
    #[cfg(feature = "sv")]
    /// 61: goto repetition operator ([->])
    GotoRepeat = vpi_sys::vpiGotoRepeatOp,
    #[cfg(feature = "sv")]
    /// 62: post-increment operator (++)
    PostInc = vpi_sys::vpiPostIncOp,
    #[cfg(feature = "sv")]
    /// 63: pre-increment operator (++)
    PreInc = vpi_sys::vpiPreIncOp,
    #[cfg(feature = "sv")]
    /// 64: post-decrement operator (--)
    PostDec = vpi_sys::vpiPostDecOp,
    #[cfg(feature = "sv")]
    /// 65: pre-decrement operator (--)
    PreDec = vpi_sys::vpiPreDecOp,
    #[cfg(feature = "sv")]
    /// 66: match operator
    Match = vpi_sys::vpiMatchOp,
    #[cfg(feature = "sv")]
    /// 67: type cast operator (type'())
    Cast = vpi_sys::vpiCastOp,
    #[cfg(feature = "sv")]
    /// 68: iff operator
    Iff = vpi_sys::vpiIffOp,
    #[cfg(feature = "sv")]
    /// 69: wildcard equality operator (==?)
    WildEq = vpi_sys::vpiWildEqOp,
    #[cfg(feature = "sv")]
    /// 70: wildcard inequality operator (!=?)
    WildNeq = vpi_sys::vpiWildNeqOp,
    #[cfg(feature = "sv")]
    /// 71: left-to-right streaming operator ({>>})
    StreamLR = vpi_sys::vpiStreamLROp,
    #[cfg(feature = "sv")]
    /// 72: right-to-left streaming operator ({<<})
    StreamRL = vpi_sys::vpiStreamRLOp,
    #[cfg(feature = "sv")]
    /// 73: .matched sequence operation
    Matched = vpi_sys::vpiMatchedOp,
    #[cfg(feature = "sv")]
    /// 74: .triggered sequence operation
    Triggered = vpi_sys::vpiTriggeredOp,
    #[cfg(feature = "sv")]
    /// 75: assignment pattern operator ('{})
    AssignmentPattern = vpi_sys::vpiAssignmentPatternOp,
    #[cfg(feature = "sv")]
    /// 76: multi-assignment pattern operator ('{n{}})
    MultiAssignmentPattern = vpi_sys::vpiMultiAssignmentPatternOp,
    #[cfg(feature = "sv")]
    /// 77: if operator
    If = vpi_sys::vpiIfOp,
    #[cfg(feature = "sv")]
    /// 78: if-else operator
    IfElse = vpi_sys::vpiIfElseOp,
    #[cfg(feature = "sv")]
    /// 79: composite and operator
    CompAnd = vpi_sys::vpiCompAndOp,
    #[cfg(feature = "sv")]
    /// 80: composite or operator
    CompOr = vpi_sys::vpiCompOrOp,
    #[cfg(feature = "sv")]
    /// 81: type operator
    Type = vpi_sys::vpiTypeOp,
    #[cfg(feature = "sv")]
    /// 82: assignment operator
    Assignment = vpi_sys::vpiAssignmentOp,
    #[cfg(feature = "sv")]
    /// 83: `accept_on` operator
    AcceptOn = vpi_sys::vpiAcceptOnOp,
    #[cfg(feature = "sv")]
    /// 84: `reject_on` operator
    RejectOn = vpi_sys::vpiRejectOnOp,
    #[cfg(feature = "sv")]
    /// 85: `sync_accept_on` operator
    SyncAcceptOn = vpi_sys::vpiSyncAcceptOnOp,
    #[cfg(feature = "sv")]
    /// 86: `sync_reject_on` operator
    SyncRejectOn = vpi_sys::vpiSyncRejectOnOp,
    #[cfg(feature = "sv")]
    /// 87: overlapped `followed_by` operator (|=>)
    OverlapFollowedBy = vpi_sys::vpiOverlapFollowedByOp,
    #[cfg(feature = "sv")]
    /// 88: non-overlapped `followed_by` operator (|->)
    NonOverlapFollowedBy = vpi_sys::vpiNonOverlapFollowedByOp,
    #[cfg(feature = "sv")]
    /// 89: nexttime operator
    Nexttime = vpi_sys::vpiNexttimeOp,
    #[cfg(feature = "sv")]
    /// 90: always operator
    Always = vpi_sys::vpiAlwaysOp,
    #[cfg(feature = "sv")]
    /// 91: eventually operator
    Eventually = vpi_sys::vpiEventuallyOp,
    #[cfg(feature = "sv")]
    /// 92: until operator
    Until = vpi_sys::vpiUntilOp,
    #[cfg(feature = "sv")]
    /// 93: `until_with` operator
    UntilWith = vpi_sys::vpiUntilWithOp,
    #[cfg(feature = "sv")]
    /// 94: implies operator
    Implies = vpi_sys::vpiImpliesOp,
    #[cfg(feature = "sv")]
    /// 95: inside operator
    Inside = vpi_sys::vpiInsideOp,
}

impl OpType {
    /// Alias retained for compatibility with legacy naming.
    #[allow(non_upper_case_globals)]
    pub const BitXNor: Self = OpType::BitXnor;
}

impl Handle {
    /// Reads a numeric property using `vpi_get64` and returns it as `i64`.
    ///
    /// Returns `None` for null handles.
    #[must_use]
    pub fn get_i64(&self, property: Property) -> Option<i64> {
        if self.is_null() {
            return None;
        }

        let value = unsafe { vpi_sys::vpi_get64(property as PLI_INT32, self.as_raw()) };
        Some(value)
    }

    /// Reads a numeric property using `vpi_get64` and returns it as `u64`.
    ///
    /// Returns `None` for null handles or negative raw values.
    #[must_use]
    pub fn get_u64(&self, property: Property) -> Option<u64> {
        let value = self.get_i64(property)?;
        u64::try_from(value).ok()
    }

    /// Reads a numeric property and returns it as `u32` when supported.
    ///
    /// Returns `None` for null handles or unsupported properties.
    #[must_use]
    pub fn get_u32(&self, property: Property) -> Option<u32> {
        if self.is_null() {
            return None;
        }
        match property {
            Property::Size
            | Property::LineNo
            | Property::TimeUnit
            | Property::TimePrecision
            | Property::DefNetType
            | Property::PortIndex
            | Property::TermIndex => unsafe {
                let value = vpi_sys::vpi_get(property as PLI_INT32, self.as_raw());
                Some(value as u32)
            },
            #[cfg(feature = "sv")]
            Property::RandType | Property::DistType => unsafe {
                let value = vpi_sys::vpi_get(property as PLI_INT32, self.as_raw());
                Some(value as u32)
            },
            _ => None, // For simplicity, only handle common properties here
        }
    }

    /// Reads a string property when supported.
    ///
    /// Returns `None` for null handles, unsupported properties, or invalid UTF-8.
    #[must_use]
    pub fn get_str(&self, property: Property) -> Option<String> {
        if self.is_null() {
            return None;
        }
        match property {
            Property::Name
            | Property::FullName
            | Property::DefName
            | Property::File
            | Property::DefFile
            | Property::Type => unsafe {
                let ptr = vpi_sys::vpi_get_str(property as PLI_INT32, self.as_raw());
                if ptr.is_null() {
                    None
                } else {
                    let c_str = std::ffi::CStr::from_ptr(ptr);
                    if let Ok(str_slice) = c_str.to_str() {
                        Some(str_slice.to_string())
                    } else {
                        None
                    }
                }
            },
            _ => None, // For simplicity, only handle common properties here
        }
    }

    /// Reads a boolean property when supported.
    ///
    /// Returns `None` for null handles or unsupported properties.
    #[must_use]
    pub fn get_bool(&self, property: Property) -> Option<bool> {
        if self.is_null() {
            return None;
        }
        match property {
            Property::TopModule
            | Property::CellInstance
            | Property::Protected
            | Property::Scalar
            | Property::Vector
            | Property::ExplicitName
            | Property::ConnByName
            | Property::ExplicitScalared
            | Property::ExplicitVectored
            | Property::Expanded
            | Property::ImplicitDecl
            | Property::Array
            | Property::Blocking
            | Property::UserDefn
            | Property::Scheduled
            | Property::Signed
            | Property::LocalParam
            | Property::ModPathHasIfNone
            | Property::IsMemory
            | Property::IsProtected => unsafe {
                let value = vpi_sys::vpi_get(property as PLI_INT32, self.as_raw());
                Some(value != 0)
            },
            #[cfg(feature = "sv")]
            Property::IsRandomized | Property::IsConstraintEnabled | Property::Soft => unsafe {
                let value = vpi_sys::vpi_get(property as PLI_INT32, self.as_raw());
                Some(value != 0)
            },
            _ => None, // For simplicity, only handle common properties here
        }
    }

    /// Returns this object's port direction, if available.
    #[must_use]
    pub fn get_direction(&self) -> Option<Direction> {
        if self.is_null() {
            return None;
        }
        let value = unsafe { vpi_sys::vpi_get(Property::Direction as PLI_INT32, self.as_raw()) };
        Direction::from_u32(value as u32)
    }

    /// Returns this object's operation subtype, if available.
    #[must_use]
    pub fn get_op_type(&self) -> Option<OpType> {
        if self.is_null() {
            return None;
        }
        let value = unsafe { vpi_sys::vpi_get(Property::OpType as PLI_INT32, self.as_raw()) };
        OpType::from_u32(value as u32)
    }

    /// Returns this object's primitive subtype, if available.
    #[must_use]
    pub fn get_prim_type(&self) -> Option<PrimType> {
        if self.is_null() {
            return None;
        }
        let value = unsafe { vpi_sys::vpi_get(Property::PrimType as PLI_INT32, self.as_raw()) };
        PrimType::from_u32(value as u32)
    }

    /// Returns this object's timing check subtype, if available.
    #[must_use]
    pub fn get_tchk_type(&self) -> Option<TchkType> {
        if self.is_null() {
            return None;
        }
        let value = unsafe { vpi_sys::vpi_get(Property::TchkType as PLI_INT32, self.as_raw()) };
        TchkType::from_u32(value as u32)
    }

    /// Returns this object's constant subtype, if available.
    #[must_use]
    pub fn get_const_type(&self) -> Option<ConstType> {
        if self.is_null() {
            return None;
        }
        let value = unsafe { vpi_sys::vpi_get(Property::ConstType as PLI_INT32, self.as_raw()) };
        ConstType::from_u32(value as u32)
    }

    #[must_use]
    /// Returns this object's name, if available.
    pub fn get_name(&self) -> Option<String> {
        if self.is_null() {
            return None;
        }
        self.get_str(Property::Name)
    }

    #[must_use]
    /// Returns this object's full hierarchical name, if available.
    pub fn get_full_name(&self) -> Option<String> {
        if self.is_null() {
            return None;
        }
        self.get_str(Property::FullName)
    }

    /// Returns this object's function type, if available.
    #[must_use]
    pub fn get_func_type(&self) -> Option<FuncType> {
        if self.is_null() {
            return None;
        }
        let value = unsafe { vpi_sys::vpi_get(Property::FuncType as PLI_INT32, self.as_raw()) };
        FuncType::from_u32(value as u32)
    }

    /// Returns this object's system function type, if available.
    #[must_use]
    pub fn get_sys_func_type(&self) -> Option<SysFuncType> {
        if self.is_null() {
            return None;
        }
        let value = unsafe { vpi_sys::vpi_get(Property::SysFuncType as PLI_INT32, self.as_raw()) };
        SysFuncType::from_u32(value as u32)
    }

    /// Returns this object's edge mask, if available.
    #[must_use]
    pub fn get_edge(&self) -> Option<Edge> {
        if self.is_null() {
            return None;
        }
        let value = unsafe { vpi_sys::vpi_get(Property::Edge as PLI_INT32, self.as_raw()) };
        Edge::from_bits(value as u32)
    }

    /// Returns this object's VPI object type.
    #[must_use]
    pub fn get_type(&self) -> Option<ObjectType> {
        if self.is_null() {
            return None;
        }
        let value = unsafe { vpi_sys::vpi_get(Property::Type as PLI_INT32, self.as_raw()) };
        ObjectType::from_u32(value as u32)
    }

    /// Returns this object's index value, if available.
    #[must_use]
    pub fn get_index(&self) -> Option<i32> {
        if self.is_null() {
            return None;
        }

        let raw_value = unsafe { vpi_sys::vpi_get(ObjectType::Index as PLI_INT32, self.as_raw()) };
        Some(raw_value)
    }

    /// Returns this object's left range value, if available.
    #[must_use]
    pub fn get_left_range(&self) -> Option<i32> {
        match self.get(ObjectType::LeftRange).get_value(ValueType::Int) {
            Some(Value::Int(value)) => Some(value),
            _ => None,
        }
    }

    /// Returns this object's right range value, if available.
    #[must_use]
    pub fn get_right_range(&self) -> Option<i32> {
        match self.get(ObjectType::RightRange).get_value(ValueType::Int) {
            Some(Value::Int(value)) => Some(value),
            _ => None,
        }
    }

    #[cfg(feature = "sv")]
    /// Iterates packages visible from this scope/root.
    #[must_use]
    pub fn get_packages(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::Package).collect()
    }

    #[cfg(feature = "sv")]
    /// Iterates interface instances visible from this scope/root.
    #[must_use]
    pub fn get_interfaces(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::Interface).collect()
    }

    #[cfg(feature = "sv")]
    /// Iterates program instances visible from this scope/root.
    #[must_use]
    pub fn get_programs(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::Program).collect()
    }

    #[cfg(feature = "sv")]
    /// Iterates virtual interface variables visible from this scope/root.
    #[must_use]
    pub fn get_virtual_interfaces(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::VirtualInterfaceVar).collect()
    }

    #[cfg(feature = "sv")]
    /// Returns whether this object participates in randomization.
    #[must_use]
    pub fn is_randomized(&self) -> Option<bool> {
        self.get_bool(Property::IsRandomized)
    }

    #[cfg(feature = "sv")]
    /// Returns the SystemVerilog randomization qualifier (`rand`, `randc`, etc.).
    #[must_use]
    pub fn get_rand_type(&self) -> Option<RandType> {
        if self.is_null() {
            return None;
        }
        let raw = unsafe { vpi_sys::vpi_get(Property::RandType as PLI_INT32, self.as_raw()) };
        RandType::from_u32(raw as u32)
    }

    #[cfg(feature = "sv")]
    /// Returns whether this constraint object is enabled.
    #[must_use]
    pub fn is_constraint_enabled(&self) -> Option<bool> {
        self.get_bool(Property::IsConstraintEnabled)
    }

    #[cfg(feature = "sv")]
    /// Returns whether this constraint object is declared `soft`.
    #[must_use]
    pub fn is_constraint_soft(&self) -> Option<bool> {
        self.get_bool(Property::Soft)
    }

    #[cfg(feature = "sv")]
    /// Returns distribution style metadata for distribution constraints.
    #[must_use]
    pub fn get_dist_type(&self) -> Option<DistType> {
        if self.is_null() {
            return None;
        }
        let raw = unsafe { vpi_sys::vpi_get(Property::DistType as PLI_INT32, self.as_raw()) };
        DistType::from_u32(raw as u32)
    }

    #[cfg(feature = "sv")]
    /// Iterates class constraints reachable from this object.
    #[must_use]
    pub fn get_constraints(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::Constraint).collect()
    }

    #[cfg(feature = "sv")]
    /// Iterates constraint-ordering nodes (`solve ... before ...`) on this object.
    #[must_use]
    pub fn get_constraint_ordering(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::ConstraintOrdering).collect()
    }

    #[cfg(feature = "sv")]
    /// Iterates constraint items for this constraint object.
    #[must_use]
    pub fn get_constraint_items(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::ConstraintItem).collect()
    }

    #[cfg(feature = "sv")]
    /// Iterates `solve before` edges under a constraint-ordering object.
    #[must_use]
    pub fn get_solve_before(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::SolveBefore).collect()
    }

    #[cfg(feature = "sv")]
    /// Iterates `solve after` edges under a constraint-ordering object.
    #[must_use]
    pub fn get_solve_after(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::SolveAfter).collect()
    }

    #[cfg(feature = "sv")]
    /// Iterates distribution-item nodes (`dist` list entries).
    #[must_use]
    pub fn get_distribution_items(&self) -> Vec<Handle> {
        if self.is_null() {
            return Vec::new();
        }
        self.iterator(ObjectType::DistItem).collect()
    }
}

#[cfg(all(test, feature = "sv"))]
mod tests {
    use super::{DistType, RandType};
    use crate::Handle;

    #[test]
    fn sv_constraint_helpers_on_null_handle_are_safe() {
        let h = Handle::null();
        assert!(h.get_packages().is_empty());
        assert!(h.get_interfaces().is_empty());
        assert!(h.get_programs().is_empty());
        assert!(h.get_virtual_interfaces().is_empty());
        assert_eq!(h.is_randomized(), None);
        assert_eq!(h.get_rand_type(), None);
        assert_eq!(h.is_constraint_enabled(), None);
        assert_eq!(h.is_constraint_soft(), None);
        assert_eq!(h.get_dist_type(), None);
        assert!(h.get_constraints().is_empty());
        assert!(h.get_constraint_ordering().is_empty());
        assert!(h.get_constraint_items().is_empty());
        assert!(h.get_solve_before().is_empty());
        assert!(h.get_solve_after().is_empty());
        assert!(h.get_distribution_items().is_empty());
    }

    #[test]
    fn sv_rand_and_dist_values_match_vpi_constants() {
        assert_eq!(RandType::NotRand as u32, vpi_sys::vpiNotRand);
        assert_eq!(RandType::Rand as u32, vpi_sys::vpiRand);
        assert_eq!(RandType::RandC as u32, vpi_sys::vpiRandC);
        assert_eq!(DistType::Equal as u32, vpi_sys::vpiEqualDist);
        assert_eq!(DistType::Div as u32, vpi_sys::vpiDivDist);
    }
}