Source file design.ml
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
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
(** Main GUI skeleton *)
open Cil_types
open Cil_datatype
open Cil
open Printer_tag
open Gtk_helper
let dkey = Gui_parameters.register_category "design"
let dkey_scroll = Gui_parameters.register_category "scroll"
let use_external_viewer = false
class type reactive_buffer = object
inherit error_manager
method buffer : GSourceView.source_buffer
method locs : Pretty_source.Locs.state
method rehighlight: unit
method redisplay: unit
end
class type view_code = object
method scroll : Pretty_source.localizable -> unit
method view_stmt : stmt -> unit
method view_original_stmt : stmt -> location
method view_original : location -> unit
method display_globals : global list -> unit
method select_or_display_global : global -> unit
end
class type main_window_extension_points = object
inherit Launcher.basic_main
inherit view_code
method toplevel : main_window_extension_points
method menu_manager: unit -> Menu_manager.menu_manager
method file_tree : Filetree.t
method file_tree_view : GTree.view
method annot_window : Wtext.text
method pretty_information: 'a. ?scroll:bool -> ('a, Format.formatter, unit) format -> 'a
(** Pretty print a message in the [annot_window]. *)
method launcher : unit -> unit
method source_viewer : GSourceView.source_view
method source_viewer_scroll : GBin.scrolled_window
method display_globals : global list -> unit
method register_source_selector :
(GMenu.menu GMenu.factory -> main_window_extension_points -> button:int
-> Pretty_source.localizable -> unit)
-> unit
method register_source_highlighter :
(reactive_buffer -> localizable ->
start:int -> stop:int -> unit)
-> unit
method register_panel :
(main_window_extension_points ->
(string * GObj.widget *(unit-> unit) option)) -> unit
method rehighlight : unit -> unit
method redisplay : unit -> unit
method reactive_buffer: reactive_buffer
method original_source_viewer : Source_manager.t
method reset : unit -> unit
method error : 'a.
?parent:GWindow.window_skel -> ?reset:bool ->
('a, Format.formatter, unit) format ->
'a
method push_info : 'a. ('a, Format.formatter, unit) format -> 'a
method pop_info : unit -> unit
method show_ids: bool
method help_message : 'a 'b.
(<event : GObj.event_ops ; .. > as 'a)
-> ('b, Format.formatter, unit) format
-> 'b
method lower_notebook : GPack.notebook
end
(** The list of registered extension *)
let (handlers:(main_window_extension_points -> unit) list ref) = ref []
(** Insert an extension *)
let register_extension f =
handlers := f::!handlers
(** Apply all extensions *)
let process_extensions window =
List.iter (fun f -> f window) (List.rev !handlers)
(** The list of reset extensions.
Such extensions are used for example when the current project
is changed. *)
let (reset_handlers:(main_window_extension_points -> unit) list ref) = ref []
(** Insert a reset extension *)
let register_reset_extension f =
reset_handlers := f::!reset_handlers
(** Apply all reset extensions *)
let reset_extensions window =
List.iter (fun f -> f window) (List.rev !reset_handlers)
(** Memoization of the class used to display a list of globals inside
a GTK source view (reactive_buffer) *)
module Globals_GUI = struct
include Hashtbl.Make
(struct
type t = global list
let equal x y =
try List.for_all2 (==) x y
with Invalid_argument _ -> false
let hash = Hashtbl.hash
end)
let tbl: reactive_buffer t = create 17
let find k = find tbl k
let add k = add tbl k
let clear () = clear tbl
end
let filetree_selector
(main_ui:main_window_extension_points)
~was_activated
~activating
globals
=
if not was_activated && activating then begin
let source = main_ui#source_viewer in
(match globals with
| Filetree.File (f, l) ->
Source_manager.load_file
main_ui#original_source_viewer
~filename:f ~line:1
~click_cb:(fun _ ->
()) ();
main_ui#display_globals l
| Filetree.Global (GVarDecl (vi, _)) ->
main_ui#display_globals [Ast.def_or_last_decl vi]
| Filetree.Global g ->
main_ui#display_globals [g];
);
source#scroll_to_mark ~use_align:true ~xalign:0. ~yalign:0.5 `INSERT;
let print_one_global prefix (v,loc) =
main_ui#protect ~cancelable:false
(fun () ->
main_ui#view_original loc;
main_ui#pretty_information "%s '%s'@." prefix v.vname)
in
main_ui#annot_window#clear;
begin match globals with
| Filetree.Global g ->
begin
History.push (History.Global g);
match g with
| GFun ({svar=v},loc) -> print_one_global "Function" (v,loc)
| GVar (v,_,loc) -> print_one_global "Variable" (v,loc)
| GVarDecl (v, loc) -> print_one_global "Variable" (v,loc)
| GFunDecl (_, v, loc) ->
print_one_global "Declared function" (v,loc)
| _ -> ()
end
| Filetree.File (f, globals) ->
let max_length = 40 in
let cons_limit r g l = if !r >= max_length then l else (incr r;g::l) in
let gfun_c,gtyp_c,gcomptagdecl_c,genumtagdecl_c,gvardecl_c,gvar_c=
ref 0,ref 0,ref 0,ref 0,ref 0,ref 0
in
let (gfun,gtype,gcomp,genum,gvardecl,gvar) =
List.fold_right
(fun g (gfun,gtype,gcomp,genum,gvardecl,gvar) ->
match g with
| GFun _ ->
(cons_limit gfun_c g gfun,gtype,gcomp,genum,gvardecl,gvar)
| GFunDecl _ ->
(cons_limit gfun_c g gfun,gtype,gcomp,genum,gvardecl,gvar)
| GType _ -> (gfun,cons_limit gtyp_c g gtype,gcomp,genum,gvardecl,gvar)
| GCompTagDecl _ ->
(gfun,gtype,cons_limit gcomptagdecl_c g gcomp,genum,gvardecl,gvar)
| GEnumTagDecl _ ->
(gfun,gtype,gcomp,cons_limit genumtagdecl_c g genum,gvardecl,gvar)
| GVarDecl _ ->
(gfun,gtype,gcomp,genum,cons_limit gvardecl_c g gvardecl,gvar)
| GVar _ ->
(gfun,gtype,gcomp,genum,gvardecl,cons_limit gvar_c g gvar)
| _ -> (gfun,gtype,gcomp,genum,gvardecl,gvar))
globals
([],[],[],[],[],[])
in
main_ui#pretty_information "@[File %a@]@." Datatype.Filepath.pretty f;
let printing
(head:string)
(ellipsis:bool)
(f:Format.formatter -> 'a -> unit)
(l:'a list)
=
if l <> [] then
main_ui#pretty_information "@[%s @[<hov>%a@]%s@]@\n" head
(Pretty_utils.pp_list ~sep:",@ " f) l
(if ellipsis then "..." else "")
in
printing
"Functions:"
(!gfun_c>=max_length)
(fun fmt -> (function GFun ({svar=v},_) | GFunDecl (_, v, _) ->
Varinfo.pretty fmt v
| _ -> assert false))
gfun;
printing
"Types:"
(!gtyp_c>=max_length)
(function fmt -> (function (GType ({tname=name},_)) ->
Format.pp_print_string fmt name
| _ -> assert false))
gtype;
printing
"Composite types:"
(!gcomptagdecl_c>=max_length)
(function fmt ->
(function GCompTagDecl
({cname=name},_) |GCompTag ({cname=name},_)->
Format.pp_print_string fmt name
| _ -> assert false))
gcomp;
printing
"Enums:"
(!genumtagdecl_c>=max_length)
(function fmt ->
(function GEnumTagDecl
({ename=name},_) | GEnumTag ({ename=name},_)->
Format.pp_print_string fmt name
|_ -> assert false))
genum;
printing
"Declared variables:"
(!gvardecl_c>=max_length)
(function fmt ->
(function GVarDecl (v,_) ->
Varinfo.pretty fmt v
| _ -> assert false))
gvardecl;
printing
"Variables:"
(!gvar_c>=max_length)
(fun fmt -> (function GVar(v,_,_) ->
Varinfo.pretty fmt v
| _ -> assert false))
gvar;
main_ui#pretty_information "%!"
end
end
let pretty_predicate_status fmt p =
if Property.has_status p then
let s = Property_status.get p in
Format.fprintf fmt "Status: %a@." Property_status.pretty s
let to_do_on_real_select
(main_ui:main_window_extension_points)
~button
selected
=
History.push (History.Localizable selected);
if button = 1 then begin
main_ui#annot_window#clear;
end
let go_to_definition selected main_ui =
match selected with
| PLval (_kf, _ki, lv) ->
begin
match lv with
| Var vi, _ when vi.vsource && vi.vglob ->
let typ = Cil.typeOfLval lv in
let glob =
if Cil.isFunctionType typ
then Kernel_function.get_global (Globals.Functions.get vi)
else GVarDecl (vi, Location.unknown)
in
let name =
Pretty_utils.escape_underscores
(Format.asprintf "%a" Varinfo.pretty vi)
in
Some (name, fun () -> ignore (main_ui#select_or_display_global glob))
| _ -> None
end
| PStmt (kf,{skind = Goto (stmt, _)}) ->
begin
match !stmt.labels with
| Label (lbl, _, _) :: _ ->
let name = Pretty_utils.escape_underscores lbl in
Some (name, fun () -> ignore (main_ui#scroll (PStmt (kf, !stmt))))
| _ -> None
end
| _ -> None
let print_code_annotations (main_ui:main_window_extension_points) kf stmt =
Annotations.iter_code_annot
(fun e a ->
let kind =
if Emitter.equal e Emitter.end_user then
"user annotation"
else match Alarms.find a with
| Some _ -> "alarm"
| None ->
Format.asprintf "emitted by %a" Emitter.pretty e
in
main_ui#pretty_information "@[%s: @[<hov>%a@]@]@.%a@."
kind Printer.pp_code_annotation a
(Pretty_utils.pp_list ~sep:"@\n" pretty_predicate_status)
(Property.ip_of_code_annot kf stmt a))
stmt
let print_call_preconditions (main_ui: main_window_extension_points) stmt =
let by_ptr_call = match stmt.skind with
| Instr (Call (_, e, _, _)) -> Some (Kernel_function.get_called e = None)
| Instr (Local_init (_, ConsInit _, _)) -> Some false
| _ -> None
in
match by_ptr_call with
| None -> ()
| Some by_ptr ->
let called_at = Statuses_by_call.all_functions_with_preconditions stmt in
let aux_callee kf =
let warn_missing = false in
let l= Statuses_by_call.all_call_preconditions_at ~warn_missing kf stmt in
let pp_kf fmt =
if by_ptr then
Format.fprintf fmt "of %a:@ " Kernel_function.pretty kf
in
let aux_prop (orig, copy) =
main_ui#pretty_information "@[Precondition %t%a@.%a@]@."
pp_kf Property.pretty orig pretty_predicate_status copy
in
List.iter aux_prop l
in
Kernel_function.Hptset.iter aux_callee called_at
let to_do_on_select
(:GMenu.menu GMenu.factory)
(main_ui:main_window_extension_points)
~button
selected
=
let view_original ?loc stmt =
Gui_parameters.debug ~dkey:dkey_scroll
"view_original: %a, stmt id %d"
(Pretty_utils.pp_opt ~none:"None" Printer.pp_location) loc
stmt.sid;
match loc with
| None -> main_ui#view_original_stmt stmt
| Some loc -> main_ui#view_original loc; loc
in
let current_statement_msg ?loc kf stmt =
main_ui#pretty_information
"Function: %t@."
(fun fmt -> match kf with
| None -> Format.pp_print_string fmt "<none>"
| Some kf -> Kernel_function.pretty fmt kf);
match stmt with
| Kglobal -> main_ui#pretty_information "@."
| Kstmt s ->
let loc = view_original ?loc s in
if main_ui#show_ids then
main_ui#pretty_information
"Statement: %d (%a)@.@." s.sid Printer.pp_location loc
else main_ui#pretty_information "Line %a@.@." Printer.pp_location loc
in
let pp_decl fmt loc =
if Cil_datatype.Location.equal loc Cil_datatype.Location.unknown then ()
else Format.fprintf fmt " (declared at %a)" Printer.pp_location loc
in
let formal_or_local vi =
if vi.vformal then "formal parameter" else "local variable"
in
let pp_defining_fun fmt vi =
match Kernel_function.find_defining_kf vi with
| None -> ()
| Some kf -> Format.fprintf fmt " of function %a" Kernel_function.pretty kf
in
let pp_var_with_decl fmt vi =
if vi.vglob then
Format.fprintf fmt "%sglobal variable%a"
(if vi.vsource then "" else "generated ")
pp_decl vi.vdecl
else
Format.fprintf fmt "%s%s%a%a"
(if vi.vsource then "" else "generated ")
(formal_or_local vi) pp_defining_fun vi pp_decl vi.vdecl
in
if button = 1 then begin
let open Property in match selected with
| PStmtStart _ -> ()
| PStmt (kf, stmt) ->
current_statement_msg (Some kf) (Kstmt stmt);
print_code_annotations main_ui kf stmt;
print_call_preconditions main_ui stmt;
| PIP (IPCodeAnnot {ica_kf;ica_stmt;ica_ca} as ip) ->
current_statement_msg
?loc:(Cil_datatype.Code_annotation.loc ica_ca)
(Some ica_kf) (Kstmt ica_stmt);
if main_ui#show_ids then
main_ui#pretty_information "Code annotation id: %d@." ica_ca.annot_id;
main_ui#pretty_information "%a@." pretty_predicate_status ip
| PIP(IPAllocation _ as ip) ->
main_ui#pretty_information "This is an allocation clause@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP(IPAssigns _ as ip) ->
main_ui#pretty_information "This is an assigns clause@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP(IPFrom _ as ip) ->
main_ui#pretty_information "This is a from clause@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPPredicate {ip_kind = PKRequires _} as ip) ->
main_ui#pretty_information "This is a requires clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPExtended {ie_ext={ext_name}} as ip) ->
main_ui#pretty_information "This clause is a %s extension.@.%a@."
ext_name pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPPredicate {ip_kind = PKTerminates} as ip) ->
main_ui#pretty_information "This is a terminates clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPPredicate {ip_kind = PKEnsures (_,Normal)} as ip) ->
main_ui#pretty_information "This is an ensures clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPPredicate {ip_kind = PKEnsures (_,Exits)} as ip) ->
main_ui#pretty_information "This is an exits clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPPredicate {ip_kind = PKEnsures (_,Returns)} as ip) ->
main_ui#pretty_information "This is a returns clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPPredicate {ip_kind = PKEnsures (_,Breaks)} as ip) ->
main_ui#pretty_information "This is a breaks clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPPredicate {ip_kind = PKEnsures (_,Continues)} as ip) ->
main_ui#pretty_information "This is a continues clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPPredicate {ip_kind = PKAssumes _} as ip) ->
main_ui#pretty_information "This is an assumes clause.@.";
main_ui#view_original (location ip)
| PIP (IPDecrease {id_kinstr=Kglobal} as ip) ->
main_ui#pretty_information
"This is a decreases clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP (IPDecrease {id_kinstr=Kstmt _} as ip) ->
main_ui#pretty_information
"This is a loop variant.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP(IPDisjoint _ as ip) ->
main_ui#pretty_information
"This is a disjoint behaviors clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP(IPComplete _ as ip) ->
main_ui#pretty_information
"This is a complete behaviors clause.@.%a@."
pretty_predicate_status ip;
main_ui#view_original (location ip)
| PIP(IPAxiomatic _ as ip) ->
main_ui#pretty_information "This is an axiomatic.@.";
main_ui#view_original (location ip)
| PIP(IPLemma { il_pred } as ip) ->
main_ui#pretty_information "This is a %a.@."
Cil_printer.pp_lemma_kind il_pred.tp_kind;
main_ui#view_original (location ip)
| PIP(IPTypeInvariant _ as ip) ->
main_ui#pretty_information "This is a type invariant.@.";
main_ui#view_original (location ip)
| PIP(IPGlobalInvariant _ as ip) ->
main_ui#pretty_information "This is a global invariant.@.";
main_ui#view_original (location ip)
| PIP(IPBehavior _ as ip) ->
main_ui#pretty_information "This is a behavior.@.";
main_ui#view_original (location ip)
| PIP (IPPropertyInstance {ii_ip=ip'} as ip) ->
main_ui#pretty_information "@[This is an instance of property `%a'.@]@."
short_pretty ip';
main_ui#view_original (location ip)
| PIP(IPReachable _ | IPOther _) ->
assert false
| PGlobal _g -> main_ui#pretty_information "This is a global.@.";
| PType _t -> main_ui#pretty_information "This is a type.@.";
| PLval (kf, ki,lv) ->
let ty = typeOfLval lv in
if isFunctionType ty then begin
begin
match ki with
| Kstmt s -> ignore (view_original s)
| Kglobal -> ();
end;
main_ui#pretty_information "This is a C function of type `%a'@."
Gui_printers.pp_typ ty
end
else begin
current_statement_msg kf ki;
match lv with
| Var vi,NoOffset ->
main_ui#pretty_information
"Variable %a has type `%a'.@\nIt is a %a.@\n\
%tIt is %sreferenced and its address is %staken.@."
Varinfo.pretty vi
Gui_printers.pp_typ vi.vtype
pp_var_with_decl vi
(fun fmt ->
match vi.vdescr with
| None -> ()
| Some s ->
Format.fprintf fmt
"This is a temporary variable for \"%s\".@\n" s)
(if vi.vreferenced then "" else "not ")
(if vi.vaddrof then "" else "not ")
| _ ->
let typ = typeOfLval lv in
main_ui#pretty_information "This is an lvalue of type %a@."
Gui_printers.pp_typ typ
end
| PExp (_kf, _ki, e) ->
begin
let typ = typeOf e in
match constFoldToInt e with
| Some i ->
begin match e.enode with
| Const (CEnum {eihost}) ->
let typ_enum = TEnum (eihost, []) in
main_ui#pretty_information
"This is a C enumeration constant, \
defined in %a with a value of %a.@."
Gui_printers.pp_typ typ_enum Abstract_interp.Int.pretty i
| _ ->
main_ui#pretty_information
"This is a constant C expression of type %a, equal to %a.@."
Gui_printers.pp_typ typ Abstract_interp.Int.pretty i
end
| None ->
main_ui#pretty_information "This is a pure C expression of type %a.@."
Gui_printers.pp_typ typ
end
| PTermLval (_, _, ip, tlv) ->
main_ui#pretty_information "This is a logical left-value, \
of logic type %a.@."
Printer.pp_logic_type (Cil.typeOfTermLval tlv);
main_ui#view_original (Property.location ip)
| PVDecl (kf,_,vi) ->
if vi.vglob
then begin
main_ui#view_original (Global.loc (Ast.def_or_last_decl vi));
main_ui#pretty_information
"This is the last declaration or definition of %s %a.@\n\
It is %sreferenced and its address is %staken.@."
(if Cil.isFunctionType vi.vtype
then "function" else "global variable")
Varinfo.pretty vi
(if vi.vreferenced then "" else "not ")
(if vi.vaddrof then "" else "not ")
end else begin
main_ui#view_original vi.vdecl;
let kf = Option.get kf in
main_ui#pretty_information
"This is the declaration of %s %a in function %a%t@."
(formal_or_local vi) Varinfo.pretty vi
Kernel_function.pretty kf
(fun fmt -> match vi.vdescr with None -> ()
| Some s -> Format.fprintf fmt
"@\nThis is a temporary variable for \"%s\".@." s)
end
end
else if button = 3 then begin
match go_to_definition selected main_ui with
| None -> ()
| Some (escaped_name, callback) ->
ignore (menu_factory#add_item
("Go to definition of " ^ escaped_name)
~callback)
end
module Feedback =
struct
module F = Property_status.Feedback
let category = function
| F.Never_tried -> "never_tried"
| F.Considered_valid -> "considered_valid"
| F.Valid -> "surely_valid"
| F.Invalid -> "surely_invalid"
| F.Invalid_but_dead -> "invalid_but_dead"
| F.Valid_but_dead -> "valid_but_dead"
| F.Unknown_but_dead -> "unknown_but_dead"
| F.Unknown -> "unknown"
| F.Valid_under_hyp -> "valid_under_hyp"
| F.Invalid_under_hyp -> "invalid_under_hyp"
| F.Inconsistent -> "inconsistent"
let long_category = function
| F.Never_tried -> "Never tried: no status is available for this property"
| F.Considered_valid -> "Considered valid: this is a hypothesis that shall be verified outside Frama-C"
| F.Valid -> "Surely valid: verified (including all of its dependencies)"
| F.Invalid -> "Surely invalid: refuted (and all of its dependencies have been verified)"
| F.Invalid_but_dead -> "Invalid but dead: refuted, but unreachable"
| F.Valid_but_dead -> "Valid but dead: verified, but unreachable"
| F.Unknown_but_dead -> "Unknown but dead: unknown status, and unreachable"
| F.Unknown -> "Unknown: a verification has been attempted, but without conclusion"
| F.Valid_under_hyp -> "Valid under hypotheses: verified (but has dependencies with Unknown status)"
| F.Invalid_under_hyp -> "Invalid under hypotheses: refuted (but has dependencies with Unknown status)"
| F.Inconsistent -> "Inconsistent: got both true and false statuses (possibly cyclic dependencies, or an incorrect axiomatization)"
let fold_category = "fold"
let unfold_category = "unfold"
let declare_markers (source:GSourceView.source_view) =
GSourceView.make_marker_attributes
~source ~category:fold_category ~priority:2
~pixbuf:(Gtk_helper.Icon.(get Fold)) ();
GSourceView.make_marker_attributes
~source ~category:unfold_category ~priority:2
~pixbuf:(Gtk_helper.Icon.(get Unfold)) ();
List.iter
(fun v ->
GSourceView.make_marker_attributes
~source ~category:(category v) ~priority:1
~pixbuf:(Gtk_helper.Icon.get (Gtk_helper.Icon.Feedback v)) ())
[ F.Never_tried;
F.Considered_valid;
F.Valid;
F.Invalid;
F.Invalid_but_dead;
F.Valid_but_dead;
F.Unknown;
F.Unknown_but_dead;
F.Valid_under_hyp;
F.Invalid_under_hyp;
F.Inconsistent ]
let tooltip_marks : (int, string) Hashtbl.t = Hashtbl.create 8
let call_sites : (int, stmt) Hashtbl.t = Hashtbl.create 8
let clear_tables () =
Hashtbl.clear tooltip_marks;
Hashtbl.clear call_sites
let mark (source:GSourceView.source_buffer) ?call_site ~offset validity =
let iter = source#get_iter_at_char offset in
let mark = iter#set_line_offset 0 in
let category = category validity in
source#remove_source_marks ~start:mark ~stop:mark () ;
ignore (source#create_source_mark ~category mark) ;
Hashtbl.replace tooltip_marks iter#line (long_category validity);
match call_site with
| None -> ()
| Some stmt ->
Hashtbl.replace call_sites iter#line stmt;
if Pretty_source.are_preconds_unfolded stmt
then ignore (source#create_source_mark ~category:fold_category mark)
else ignore (source#create_source_mark ~category:unfold_category mark)
end
(** Widgets that might result in a localizable being selected:
- the main ui reactive buffer (pretty-printed source)
- the information panel, when the user clicks on a localizable *)
type localizable_selection_origin = ReactiveBuffer | InformationPanel
(** Global selectors and highlighters *)
let highlighter = ref []
let selector = ref ([] :
((GMenu.menu GMenu.factory -> main_window_extension_points ->
button:int -> Pretty_source.localizable -> unit
) * localizable_selection_origin list) list)
let callback f arg =
try f arg with
| Sys.Break as exn -> raise exn
| exn when Cmdline.catch_at_toplevel exn ->
Gui_parameters.warning "Uncaught exception:@\n%s"
(Cmdline.protect exn) ;
class (host:Gtk_helper.host) (:GMenu.menu) = object
inherit [GMenu.menu] GMenu.factory menu as super
method! add_item ?key ?callback ? string =
let callback = match callback with
None -> None
| Some cb ->
Some (fun () -> ignore (host#full_protect ~cancelable:true cb))
in
super#add_item ?key ?callback ?submenu string
method! add_check_item ?active ?key ?callback string =
let callback = match callback with
None -> None
| Some cb ->
Some (fun b ->
ignore (host#full_protect ~cancelable:false (fun () -> cb b)))
in
super#add_check_item ?active ?key ?callback string
end
let selector_localizable (main_ui:main_window_extension_points) origin ~button localizable =
let =
new protected_menu_factory (main_ui:>Gtk_helper.host) (GMenu.menu())
in
List.iter
(fun (f, origins) ->
if List.mem origin origins then
callback (f popup_factory main_ui ~button) localizable
) !selector;
if button = 3 && popup_factory#menu#children <> [] then
let time = GtkMain.Main.get_current_event_time () in
popup_factory#menu#popup ~button ~time
class reactive_buffer_cl (main_ui:main_window_extension_points)
?(parent_window=main_ui#main_window)
globs :reactive_buffer =
let buffer = Source_viewer.buffer () in
let locs = Pretty_source.Locs.create () in
object(self)
inherit error_manager
~reset:main_ui#reset (parent_window:>GWindow.window_skel)
method buffer = buffer
method locs = locs
method rehighlight = Pretty_source.hilite locs
method redisplay = self#init
method private init =
Feedback.clear_tables ();
let highlighter localizable ~start ~stop =
List.iter
(fun f ->
callback
(fun () -> f (self:>reactive_buffer) localizable ~start ~stop)
())
!highlighter
in
let selector = selector_localizable main_ui ReactiveBuffer in
Pretty_source.display_source
globs
buffer
~host:(self:>Gtk_helper.host)
~highlighter
~selector
locs;
self#rehighlight
initializer
self#init;
Globals_GUI.add globs (self:> reactive_buffer)
end
let dummy_reactive_buffer (parent_window:GWindow.window) =
let buffer = Source_viewer.buffer () in
let locs = Pretty_source.Locs.create () in
object
inherit error_manager (parent_window:>GWindow.window_skel)
method buffer = buffer
method locs = locs
method rehighlight = ()
method redisplay = ()
end
let reactive_buffer main_ui ?parent_window globs =
try
Globals_GUI.find globs
with Not_found ->
new reactive_buffer_cl main_ui ?parent_window globs
let console_view : GText.view option ref = ref None
(** The main application window *)
class main_window () : main_window_extension_points =
let final_w,width = try true,Configuration.find_int "window_width"
with Not_found -> false,(Gdk.Screen.width ())*7/8
in
let final_h,height =try true,Configuration.find_int "window_height"
with Not_found -> false,(Gdk.Screen.height ())*7/8
in
let max_width =
height * 8 / 5
in
let width, height =
if width > max_width
then (if final_w then width else max_width), height
else
let max_height = width * 3 / 4 in
let new_height = min height max_height in
width, if final_h then height else new_height
in
let main_window =
GWindow.window
?icon:framac_icon
~title:"Frama-C"
~position:`CENTER
~resizable:true
~show:false
()
in
let () = main_window#set_default_size ~width ~height in
let () = main_window#set_geometry_hints ~min_size:(1,1) main_window#coerce in
let watch_cursor = Gdk.Cursor.create `WATCH in
let arrow_cursor = Gdk.Cursor.create `LEFT_PTR in
let toplevel_vbox = GPack.box `VERTICAL ~packing:main_window#add () in
let bottom_hbox = GPack.box `HORIZONTAL
~packing:(toplevel_vbox#pack ~expand:false ~fill:false ~from:`END)
()
in
let statusbar = GMisc.statusbar ~packing:bottom_hbox#add () in
let status_context = statusbar#new_context ~name:"messages" in
let progress_bar =
GRange.progress_bar
~pulse_step:0.01
~packing:(bottom_hbox#pack ~fill:false)
()
in
let toplevel_hpaned = GPack.paned `HORIZONTAL
~packing:(toplevel_vbox#pack ~expand:true ~fill:true ~from:`END) ()
in
let _ = toplevel_hpaned#event#connect#button_release
~callback:(fun _ -> save_paned_ratio "toplevel_hpaned" toplevel_hpaned;
false)
in
let filetree_panel_vpaned =
GPack.paned `VERTICAL ~packing:(toplevel_hpaned#add1) ()
in
let _ = filetree_panel_vpaned#event#connect#button_release
~callback:(fun _ ->
save_paned_ratio "filetree_panel_vpaned" filetree_panel_vpaned;
false)
in
let filetree_frame =
GBin.frame ~shadow_type:`ETCHED_OUT ~packing:filetree_panel_vpaned#add1 ()
in
let filetree_scrolled_window =
GBin.scrolled_window
~vpolicy:`AUTOMATIC
~hpolicy:`AUTOMATIC
~packing:filetree_frame#add ()
in
let file_tree_view = GTree.view ~packing:filetree_scrolled_window#add () in
let () = file_tree_view#misc#set_name "file tree" in
let () = file_tree_view#selection#set_mode `SINGLE in
let () = file_tree_view#set_rules_hint true in
let () = file_tree_view#set_headers_clickable true in
let vb_message_sources =
GPack.paned `VERTICAL ~border_width:3 ~packing:toplevel_hpaned#add2 ()
in
let _ = vb_message_sources#event#connect#button_release
~callback:(fun _ ->
save_paned_ratio "vb_message_sources" vb_message_sources;
false)
in
let hb_sources =
GPack.paned `HORIZONTAL ~border_width:3 ~packing:vb_message_sources#add1 ()
in
let _ = hb_sources#event#connect#button_release
~callback:(fun _ -> save_paned_ratio "hb_sources" hb_sources; false)
in
let fr2 =
GBin.frame ~shadow_type:`ETCHED_OUT ~packing:vb_message_sources#add2 ()
in
let lower_notebook =
GPack.notebook ~scrollable:true ~show_tabs:true ~packing:fr2#add ()
in
let tab_label = GMisc.label ~markup:"Information" () in
let annot_sw =
GBin.scrolled_window ~vpolicy:`AUTOMATIC ~hpolicy:`AUTOMATIC
~packing:(fun w -> ignore (lower_notebook#insert_page
~tab_label:tab_label#coerce w))
()
in
let annot_window = new Wtext.text () in
let () = annot_sw#add_with_viewport annot_window#coerce in
let () = Printer.update_printer
(module Gui_printers.LinkPrinter: Printer.PrinterExtension)
in
let fr1 = GBin.frame ~shadow_type:`ETCHED_OUT ~packing:hb_sources#add1 () in
let source_viewer_scroll = GBin.scrolled_window
~vpolicy:`AUTOMATIC
~hpolicy:`AUTOMATIC
~packing:fr1#add ()
in
let source_viewer = Source_viewer.make ~packing:source_viewer_scroll#add () in
let () =
begin
source_viewer#set_show_line_numbers false ;
source_viewer#set_show_line_marks true ;
let _ =
source_viewer#event#connect#motion_notify ~callback:
(fun ev ->
let x = GdkEvent.Motion.x ev in
if x < 20.0 then begin
let y = GdkEvent.Motion.y ev in
let (xbuf, ybuf) = source_viewer#window_to_buffer_coords
~tag:`WIDGET ~x:(int_of_float x) ~y:(int_of_float y)
in
let iterpos =
source_viewer#get_iter_at_location ~x:xbuf ~y:ybuf
in
let line = iterpos#line in
if Hashtbl.mem Feedback.tooltip_marks line then begin
let text = Hashtbl.find Feedback.tooltip_marks line in
source_viewer#misc#set_has_tooltip true;
source_viewer#misc#set_tooltip_text text;
end else begin
source_viewer#misc#set_has_tooltip false;
end
end else
source_viewer#misc#set_has_tooltip false;
; false)
in
Feedback.declare_markers source_viewer ;
end
in
let original_source_viewer = Source_manager.make ~packing:hb_sources#add2 ()
in
let () =
ignore (source_viewer#event#connect#button_press ~callback:
(fun ev -> GdkEvent.Button.button ev = 3));
source_viewer#buffer#place_cursor ~where:source_viewer#buffer#start_iter
in
let original_reactive_buffer = dummy_reactive_buffer main_window in
object (self:#main_window_extension_points)
val mutable launcher = []
val mutable panel = []
val mutable main_window_metrics = { Gtk.width=0; height=0; x=0; y=0}
val mutable file_tree = None
val mutable current_buffer_state: reactive_buffer = original_reactive_buffer
val mutable menu_manager = None
val mutable last_find_text = ""
method toplevel = (self:>main_window_extension_points)
method main_window = main_window
method menu_manager () = match menu_manager with
| None ->
let m =
new Menu_manager.menu_manager
~packing:(toplevel_vbox#pack ~expand:false ~fill:false ~from:`START)
(self :> Gtk_helper.host)
in
menu_manager <- Some m;
m
| Some s ->
s
method file_tree = Option.get file_tree
method file_tree_view = file_tree_view
method annot_window = annot_window
method pretty_information : 'a. ?scroll:bool -> ('a, Format.formatter, unit) format -> 'a
= annot_window#printf
method source_viewer = source_viewer
method source_viewer_scroll = source_viewer_scroll
method private register_source_selector_origin origins f =
selector := (f, origins)::!selector
method register_source_selector f =
self#register_source_selector_origin [InformationPanel; ReactiveBuffer] f
method register_source_highlighter f = highlighter := f::!highlighter
method register_panel f = panel <- f::panel
method private initialize_panels () =
let to_refresh = ref [] in
let sw =
GBin.scrolled_window
~vpolicy:`AUTOMATIC
~hpolicy:`AUTOMATIC
~packing:filetree_panel_vpaned#add2
()
in
let vbox = GPack.vbox ~packing:sw#add_with_viewport () in
let targets = [
{ Gtk.target =
"application/x" ; Gtk.flags = [] ; Gtk.info = 0 }]
in
let dragged_frame = ref None in
List.iter
(fun f ->
let text,widget,refresh = f (self:>main_window_extension_points) in
let key_config = text in
let expander = GBin.expander
~expanded:(Configuration.find_bool ~default:true key_config)
~packing:vbox#pack () in
let label_hb = GPack.hbox () in
let _label = GMisc.label
~markup:("<b>"^text^"</b>")
~packing:label_hb#pack
()
in
expander#set_label_widget (label_hb#coerce);
ignore (expander#connect#activate
~callback:(fun () ->
Configuration.set key_config
(Configuration.ConfBool (not expander#expanded))));
let frame = GBin.frame ~packing:expander#add () in
frame#add widget;
expander#drag#source_set ~modi:[`BUTTON1] ~actions:[`MOVE] targets;
ignore (expander#drag#connect#beginning
~callback:(fun _ -> dragged_frame:=Some (frame,text)));
ignore (expander#drag#connect#ending
~callback:(fun _ -> dragged_frame:=None));
Option.iter
(fun refresh ->
to_refresh:=
(fun ()->
if !Gtk_helper.gui_unlocked && expander#expanded then
refresh ())
::!to_refresh)
refresh)
panel;
let dropper (widget:GObj.widget) =
widget#drag#dest_set ~flags:[`ALL] ~actions:[`MOVE] targets;
ignore (widget#drag#connect#drop
~callback:(fun drag_context ~x:_ ~y:_ ~time:_ ->
match !dragged_frame with
| None -> true
| Some (frame,title) ->
let w = drag_context#source_widget in
let new_w =
GWindow.window ~position:`MOUSE ~title ~show:true () in
let b = GPack.vbox ~packing:new_w#add () in
frame#misc#reparent b#coerce;
ignore (new_w#connect#destroy
~callback:(fun () ->
frame#misc#reparent w;
w#misc#show ()));
w#misc#hide ();
true));
ignore (widget#drag#connect#motion
~callback:(fun drag_context ~x:_ ~y:_ ~time ->
drag_context#status ~time (Some `MOVE);
true));
ignore (widget#drag#connect#leave
~callback:(fun drag_context ~time ->
drag_context#status ~time (Some `MOVE)));
in
dropper main_window#coerce;
dropper source_viewer#coerce;
let refresh_all _ = (List.iter (fun f -> f ()) !to_refresh;true) in
ignore (Glib.Timeout.add ~ms:500 ~callback:refresh_all)
method launcher () =
Launcher.show
~width:(try Configuration.find_int "launcher_width"
with Not_found -> main_window_metrics.Gtk.width/2)
~height:(try Configuration.find_int "launcher_height"
with Not_found -> 2*main_window_metrics.Gtk.height/3)
~host:(self:>Launcher.basic_main)
()
method original_source_viewer = original_source_viewer
method reactive_buffer = current_buffer_state
method display_globals globs =
Gui_parameters.debug ~dkey "display_globals";
let buff = reactive_buffer self#toplevel globs in
current_buffer_state <- buff;
self#source_viewer#set_buffer (buff#buffer:>GText.buffer);
self#rehighlight ()
method select_or_display_global g =
if not (self#toplevel#file_tree#select_global g) then
filetree_selector self#toplevel
~was_activated:false ~activating:true (Filetree.Global g)
method redisplay () =
current_buffer_state#redisplay;
History.show_current ()
method rehighlight () =
current_buffer_state#rehighlight ;
method scroll loc =
Gui_parameters.debug ~dkey:dkey_scroll
"main_ui: scroll: localizable %a" Printer_tag.Localizable.pretty loc;
let history = History.on_current_history () in
let show o =
history (fun () -> History.push (History.Localizable loc));
let iter = self#source_viewer#buffer#get_iter (`OFFSET o) in
Gui_parameters.debug
~dkey:dkey_scroll "scrolling in current view at iter %d,%d"
iter#line iter#line_offset
;
ignore (self#source_viewer#backward_display_line_start iter);
self#source_viewer#buffer#place_cursor ~where:iter;
ignore (self#source_viewer#scroll_to_mark
~use_align:true ~yalign:0.5 ~xalign:0. `INSERT);
let adj = source_viewer_scroll#hadjustment in
adj#set_value adj#lower
in
match Pretty_source.locate_localizable current_buffer_state#locs loc with
| Some (b,_) -> show b
| None ->
begin
match Pretty_source.kf_of_localizable loc with
| Some kf ->
let g = Kernel_function.get_global kf in
self#select_or_display_global g
| None ->
match loc with
| PGlobal g -> self#select_or_display_global g
| _ ->
Gui_parameters.debug ~dkey "does not know how to scroll to loc"
end;
match Pretty_source.locate_localizable current_buffer_state#locs loc with
| Some (b, _) -> show b
| None ->
Gui_parameters.debug ~dkey "Unable to scroll to loc, probably \
not shown in the buffer"
method view_stmt stmt =
let kf = Kernel_function.find_englobing_kf stmt in
let loc = PStmt (kf, stmt) in
self#scroll loc;
ignore (self#view_original_stmt stmt)
method view_original loc =
Gui_parameters.debug ~dkey:dkey_scroll
"main_ui: view_original: location %a" Location.pretty loc;
if not (Location.equal loc Location.unknown) then
Source_manager.load_file
self#original_source_viewer
~filename:(fst loc).Filepath.pos_path
~line:(fst loc).Filepath.pos_lnum
~click_cb:(fun olocz ->
match olocz with
| None -> ()
| Some locz ->
let scroll_to_locz locz =
Wutil.later (fun () ->
Source_manager.selection_locked := true;
self#scroll locz;
)
in
match locz with
| PVDecl (_okf, _, vi) -> begin
try
ignore (Globals.Vars.find vi);
let glob = GVarDecl (vi, loc) in
Wutil.later (fun () ->
Source_manager.selection_locked := true;
self#select_or_display_global glob;
)
with
| Not_found ->
scroll_to_locz locz
end
| PGlobal g -> begin
match g with
| GType _ | GCompTag _ | GCompTagDecl _ | GEnumTag _
| GEnumTagDecl _ -> ()
| _ -> scroll_to_locz locz
end
| _ -> scroll_to_locz locz
)
()
method view_original_stmt st =
let loc = Stmt.loc st in
if use_external_viewer then begin
if not (Location.equal loc Location.unknown) then
let args_for_emacs =
Format.sprintf "emacsclient -n +%d %S"
(fst loc).Filepath.pos_lnum ((fst loc).Filepath.pos_path :> string)
in
Gui_parameters.debug ~dkey "Running %s" args_for_emacs;
ignore (Sys.command args_for_emacs);
end else
self#view_original loc;
loc
method pop_info () =
status_context#pop ();
method private push_info_buffer :
'a. ?buffer:Buffer.t -> ('a, Format.formatter, unit) format -> 'a =
fun ?buffer fmt ->
let b = match buffer with
| None -> Buffer.create 80
| Some b -> b
in
let bfmt = Format.formatter_of_buffer b in
Format.kfprintf
(function fmt ->
Format.pp_print_flush fmt ();
let content = Buffer.contents b in
ignore (status_context#push content))
bfmt
fmt
method push_info fmt = self#push_info_buffer fmt
method show_ids = Gui_parameters.debug_atleast 1
method help_message w fmt =
let buffer = Buffer.create 80 in
let bfmt = Format.formatter_of_buffer buffer in
Format.kfprintf
(function _ ->
ignore (w#event#connect#leave_notify
~callback:(fun _ -> self#pop_info ();true));
ignore (w#event#connect#enter_notify
~callback:(fun _ ->
Format.pp_print_flush bfmt ();
self#push_info_buffer ~buffer "" ;false)))
bfmt
fmt
inherit error_manager (main_window:>GWindow.window_skel)
method private toplevel_vbox = toplevel_vbox
method private toplevel_hpaned = toplevel_hpaned
method private statusbar = statusbar
method lower_notebook = lower_notebook
method private reset_no_extensions () =
Gui_parameters.debug ~dkey "Redisplaying gui";
Globals_GUI.clear ();
current_buffer_state <- original_reactive_buffer;
self#file_tree#reset ();
(self#menu_manager ())#refresh ()
method reset () =
self#reset_no_extensions ();
reset_extensions self#toplevel;
if History.is_empty () then (
self#default_screen ())
else
History.show_current ()
method private default_screen () =
try
let main, _ = Globals.entry_point () in
self#select_or_display_global (Kernel_function.get_global main)
with Globals.No_such_entry_point _ | Not_found ->
source_viewer#buffer#set_text
"Please select a file in the left panel\nor start a new project."
method private focused_find_text use_dialog =
let find_text_in_viewer ~where (viewer : [`GTextViewer of GText.view |`GSourceViewer of GSourceView.source_view]) text =
let buffer, scroll_to_iter =
match viewer with
| `GTextViewer v -> v#buffer,v#scroll_to_iter
| `GSourceViewer v -> v#buffer,v#scroll_to_iter
in
let cursor_iter = buffer#get_iter_at_mark `INSERT in
let after_cursor = cursor_iter#forward_char in
let notify_not_found = ref true in
let found_iters =
match
after_cursor#forward_search
~flags:[]
text
with
| Some _ as iters -> iters
| None ->
let title = "Find " ^ where in
if GToolbox.question_box ~title
(Printf.sprintf "No more occurrences for: %s\n\
Search from beginning?" text)
~buttons:["Yes"; "No"] = 1 then
let cursor_iter = buffer#get_iter `START in
cursor_iter#forward_search
~flags:[]
text
else
(notify_not_found := false; None)
in
match found_iters with
| Some (i1,i2) ->
buffer#place_cursor ~where:i1;
buffer#select_range i1 i2;
ignore (scroll_to_iter i1
~use_align:false
~within_margin:0.025
);
last_find_text <- text
| None -> if !notify_not_found then
GToolbox.message_box ~title:("Not found " ^ where)
(Printf.sprintf "Not found %s: %s" where text)
in
let focused_widget = GtkWindow.Window.get_focus main_window#as_window in
let focused_name = Gobject.Property.get focused_widget GtkBase.Widget.P.name
in
let opt_where_view =
if focused_name = "source" then
Some ("in CIL code", `GSourceViewer source_viewer)
else if focused_name = "original_source" then
let original_buffer = (Source_manager.get_current_source_view
original_source_viewer)
in
Some ("in original code", `GSourceViewer original_buffer)
else if focused_name = "file tree" then
begin
let text =
if use_dialog then
Option.value ~default:""
(Gtk_helper.input_string
~parent:main_window
~title:"Find global" ~ok:"Find" ~cancel:"Cancel"
"Find global:" ~text:last_find_text)
else last_find_text
in
if text <> "" then
match self#file_tree#find_visible_global text with
| None -> GToolbox.message_box ~title:"Global not found"
(Printf.sprintf "Global not found: %s" text)
| Some g ->
last_find_text <- text;
self#select_or_display_global g
else ();
None
end
else
begin
let information_view = annot_window#get_view in
if Gobject.Property.get information_view#as_widget
GtkBase.Widget.P.has_focus then
Some ("in Information",`GTextViewer information_view)
else
let console_view_focused =
match !console_view with
| Some v ->
if Gobject.Property.get v#as_widget GtkBase.Widget.P.has_focus then
Some ("in Console",`GTextViewer v)
else
None
| None -> None
in
if console_view_focused <> None then console_view_focused
else
None
end
in
match opt_where_view with
| None -> ()
| Some (where,viewer) ->
let text =
if use_dialog then
Option.value ~default:""
(Gtk_helper.input_string
~parent:main_window
~title:("Find " ^ where) ~ok:"Find" ~cancel:"Cancel"
("Find text (" ^ where ^ "):") ~text:last_find_text)
else last_find_text
in
if text <> "" then find_text_in_viewer ~where viewer text else ()
initializer
self#set_reset self#reset;
let = self#menu_manager () in
main_window#add_accel_group menu_manager#factory#accel_group;
let _ = source_viewer#event#connect#button_release
~callback:(fun ev ->
let abs_x = int_of_float (GdkEvent.Button.x_root ev) in
let rec get_rel_from_main acc win =
let x = fst (Gdk.Window.get_position win) in
let acc = acc + x in
let win = Gdk.Window.get_parent win in
if Gobject.get_oid win =
Gobject.get_oid main_window#misc#window
then acc
else get_rel_from_main acc win
in
let get_x obj = fst (Gdk.Window.get_position obj#misc#window) in
let window_abs_x = get_x main_window in
let viewer_rel_x =
get_rel_from_main 0 source_viewer#misc#window
in
if abs_x - (window_abs_x + viewer_rel_x) < 20 then
begin
let x, y = GdkEvent.Button.(x ev, y ev) in
let (xbuf, ybuf) = source_viewer#window_to_buffer_coords
~tag:`WIDGET ~x:(int_of_float x) ~y:(int_of_float y)
in
let iterpos =
source_viewer#get_iter_at_location ~x:xbuf ~y:ybuf
in
let line = iterpos#line in
try
let stmt = Hashtbl.find Feedback.call_sites line in
Pretty_source.fold_preconds_at_callsite stmt;
self#reset_no_extensions ();
let has_stabilized = ref false in
let check () =
let iter =
source_viewer#buffer#get_iter (`LINE line)
in
let my_rect = source_viewer#get_iter_location iter in
let visible_rect = source_viewer#visible_rect in
let res =
Gdk.Rectangle.(
y my_rect >= y visible_rect &&
y my_rect <= y visible_rect + height visible_rect
)
in
Gdk.Rectangle.(Gui_parameters.debug ~dkey:dkey_scroll
"my rect is %d (+%d) %d (+%d)@\n\
vis rect is %d (+%d) %d (+%d)@\n\
my rect is visible: %B@."
(x my_rect) (width my_rect) (y my_rect) (height my_rect)
(x visible_rect) (width visible_rect) (y visible_rect)
(height visible_rect) res);
has_stabilized := res;
not res
in
ignore (check());
let proc = Glib.Idle.add check in
let alarm =
Glib.Timeout.add
~ms:500
~callback:
(fun () ->
has_stabilized := true;
Glib.Idle.remove proc;
false)
in
while (not !has_stabilized) do
ignore (Glib.Main.iteration false)
done;
Glib.Timeout.remove alarm;
self#view_stmt stmt;
with Not_found -> ()
end;
false)
in
let = GtkData.AccelGroup.create () in
GtkData.AccelGroup.connect extra_accel_group
~key:GdkKeysyms._F
~modi:[`CONTROL]
~callback:
(fun _ -> self#focused_find_text true);
GtkData.AccelGroup.connect extra_accel_group
~key:GdkKeysyms._F3
~callback:(fun _ -> self#focused_find_text false);
main_window#add_accel_group extra_accel_group;
let lock_gui lock =
filetree_panel_vpaned#misc#set_sensitive (not lock);
if lock then
ignore (Glib.Timeout.add ~ms:50
~callback:(fun () ->
progress_bar#pulse ();
not !Gtk_helper.gui_unlocked));
Gdk.Window.set_cursor
main_window#misc#window
(if lock then watch_cursor else arrow_cursor);
if lock then begin
progress_bar#misc#show ();
ignore (status_context#push "Computing")
end
else begin
status_context#pop();
progress_bar#misc#hide ()
end
in
register_locking_machinery
~lock:(fun _cancelable -> lock_gui true)
~unlock:(fun () -> lock_gui false)
();
ignore (main_window#connect#destroy ~callback:Cmdline.bail_out);
ignore (main_window#misc#connect#size_allocate
~callback:(fun ({Gtk.width=w;Gtk.height=h} as rect) ->
Configuration.set "window_width" (Configuration.ConfInt w);
Configuration.set "window_height" (Configuration.ConfInt h);
if main_window_metrics.Gtk.width <> w
|| main_window_metrics.Gtk.height <> h then
begin
place_paned hb_sources
(Configuration.find_float ~default:0.5 "hb_sources");
place_paned vb_message_sources
(Configuration.find_float ~default:0.71
"vb_message_sources");
place_paned filetree_panel_vpaned
(Configuration.find_float ~default:0.5
"filetree_panel_vpaned");
place_paned toplevel_hpaned
(Configuration.find_float ~default:0.18
"toplevel_hpaned");
end;
main_window_metrics <- rect));
file_tree <- Some (Filetree.make file_tree_view);
self#file_tree#add_select_function (filetree_selector self#toplevel);
process_extensions self#toplevel;
self#register_source_selector to_do_on_select;
self#register_source_selector_origin [ReactiveBuffer] to_do_on_real_select;
self#initialize_panels ();
main_window#show ();
Gdk.Window.set_cursor main_window#misc#window arrow_cursor;
let warnings_tab_label = (GMisc.label ~text:"Messages" ())#coerce in
let warning_manager =
let packing w =
ignore
(lower_notebook#insert_page ~pos:1
~tab_label:warnings_tab_label w);
let nb_messages = Messages.nb_warnings () + Messages.nb_errors () in
let text = Format.sprintf "Messages (%d)" nb_messages in
let label = GtkMisc.Label.cast warnings_tab_label#as_widget in
GtkMisc.Label.set_text label text
in
let callback e _column =
Option.iter
(fun pos ->
Option.iter self#scroll (Printer_tag.loc_to_localizable pos);
self#view_original (pos,pos))
e.Log.evt_source
in
Warning_manager.make ~packing ~callback
in
let outdated_warnings = ref false in
let display_warnings () =
outdated_warnings := false ;
Warning_manager.clear warning_manager;
Messages.iter
(fun event ->
match event.evt_kind with
| Warning | Error -> Warning_manager.append warning_manager event
| _ -> ());
let nb_messages = Messages.nb_warnings () + Messages.nb_errors () in
let text = Format.sprintf "Messages (%d)" nb_messages in
let label = GtkMisc.Label.cast warnings_tab_label#as_widget in
GtkMisc.Label.set_text label text
in
register_reset_extension (fun _ -> display_warnings ());
Messages.add_global_hook (fun () ->
if not !outdated_warnings then
begin
outdated_warnings := true ;
Wutil.later display_warnings
end
);
Messages.reset_once_flag ();
display_warnings ();
ignore (History.create_buttons (self#menu_manager ()));
History.set_display_elt_callback
(function
| History.Global g ->
self#select_or_display_global g
| History.Localizable l ->
self#scroll l
);
self#default_screen ();
menu_manager#refresh ();
Project.register_after_set_current_hook
~user_only:true
(fun _ -> self#reset ());
let pp_def_loc pp typ =
try
let opt_tag_name =
match typ with
| TNamed (ti, _) -> Some (Logic_typing.Typedef, ti.torig_name)
| TComp (ci, _) ->
let tag = if ci.cstruct then Logic_typing.Struct
else Logic_typing.Union
in
let name = if ci.corig_name <> "" then ci.corig_name else ci.cname in
Some (tag, name)
| TEnum (ei, _) ->
let name = if ei.eorig_name <> "" then ei.eorig_name else ei.ename in
Some (Logic_typing.Enum, name)
| _ -> None
in
match opt_tag_name with
| None -> ()
| Some (tag, name) ->
let g = Globals.Types.global tag name in
let loc = Cil_datatype.Global.loc g in
Format.fprintf pp ", defined at %a" Printer.pp_location loc
with
| Not_found -> ()
in
annot_window#links#connect
(fun button (_,_,s) ->
begin
try
let vi = Gui_printers.varinfo_of_link s in
match History.selected_localizable () with
| None -> ()
| Some loc ->
let kfopt = Pretty_source.kf_of_localizable loc in
let ki = Pretty_source.ki_of_localizable loc in
let var_localizable =
Printer_tag.PLval (kfopt, ki, (Var vi, NoOffset))
in
let button = GdkEvent.Button.button button in
if button = 1 then self#pretty_information "@.";
selector_localizable self#toplevel
InformationPanel ~button var_localizable
with Gui_printers.NoMatch -> ()
end;
begin
try
let typ = Gui_printers.typ_of_link s in
match typ with
| TComp _ | TEnum _ | TPtr _ | TArray _ | TNamed _ ->
let base_type = Gui_printers.get_type_specifier typ in
let sizeof_str =
try Format.sprintf "sizeof %d" (Cil.bytesSizeOf base_type)
with Cil.SizeOfError (b, _) -> "unknown size: " ^ b
in
self#pretty_information ~scroll:true
"@.Type information for `%a':@.(%s%a)@. @[%a@]"
Printer.pp_typ base_type sizeof_str pp_def_loc typ
Gui_printers.pp_typ_unfolded base_type
| _ -> ()
with Gui_printers.NoMatch -> ()
end;
try
let loc = Gui_printers.loc_of_link s in
let modi = Gdk.Convert.modifier (GdkEvent.Button.state button) in
let button = GdkEvent.Button.button button in
if button = 1 then
if List.mem `CONTROL modi then
open_in_external_viewer (fst loc).Filepath.pos_path
~line:(fst loc).Filepath.pos_lnum;
self#view_original loc
with Gui_printers.NoMatch -> ())
end
let make_splash () =
GMain.Rc.add_default_file ((Fc_config.datadir:>string) ^"/frama-c.rc");
GMain.Rc.add_default_file ((Fc_config.datadir:>string) ^"/frama-c-user.rc");
let (_:string) = GtkMain.Main.init ~setlocale:false () in
let w =
GWindow.window
~title:"Splash" ~width:640 ~height:480 ~position:`CENTER_ALWAYS
~show:false ?icon:framac_icon
()
in
ignore(w#event#connect#key_press
~callback:(fun key ->
if GdkEvent.Key.keyval key = GdkKeysyms._Escape then
Cmdline.bail_out (); false));
let _ = w#event#connect#delete ~callback:(fun _ -> Cmdline.bail_out ()) in
let tid =
Glib.Timeout.add ~ms:500 ~callback:(fun () -> w#show (); false)
in
let bx = GPack.vbox ~packing:w#add () in
let notebook = GPack.notebook ~packing:bx#add () in
let close_button =
GButton.button
~packing:(bx#pack ~expand:false ~fill:false) ~stock:`CANCEL ()
in
ignore (close_button#connect#released ~callback:Cmdline.bail_out);
let reparent,stdout = Gtk_helper.make_text_page ~pos:2 notebook "Console" in
console_view := Some stdout;
Gtk_helper.log_redirector
(fun s -> stdout#buffer#insert ~iter:stdout#buffer#end_iter s);
let force () =
Glib.Timeout.remove tid;
w#show ()
in
tid, stdout, w, reparent, force
let toplevel play =
Gtk_helper.Configuration.load ();
ignore (Async.on_progress Gtk_helper.refresh_gui) ;
let in_idle () =
let tid, splash_out, splash_w, reparent_console, force_s= make_splash () in
let error_manager =
new Gtk_helper.error_manager (splash_w:>GWindow.window_skel)
in
let init_crash = ref None in
error_manager#protect
~cancelable:true ~parent:(splash_w:>GWindow.window_skel)
(fun () ->
try
play ();
Task.on_idle :=
(fun f -> ignore (Glib.Timeout.add ~ms:50 ~callback:f));
let project_name = Gui_parameters.Project_name.get () in
if project_name = "" then
Project.set_current_as_last_created ()
else
Project.set_current (Project.from_unique_name project_name);
Ast.compute ()
with e ->
force_s (); init_crash := Some e; raise e);
if Ast.is_computed () then
error_manager#protect ~cancelable:false
(fun () ->
let main_ui = new main_window () in
Gtk_helper.gui_unlocked := true;
Glib.Timeout.remove tid;
reparent_console main_ui#lower_notebook;
splash_w#destroy ();
match !init_crash with
| None -> main_ui#lower_notebook#goto_page 0
| Some e ->
main_ui#lower_notebook#goto_page 2;
let end_console = splash_out#buffer#end_iter in
ignore (splash_out#scroll_to_iter ~yalign:0. end_console);
error_manager#error ~reset:true "%s" (Cmdline.protect e);
)
in
ignore (Glib.Idle.add (fun () -> in_idle (); false));
GMain.Main.main ()
let () = Boot.set_toplevel toplevel