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
|
/* GDB parameters implemented in Guile.
Copyright (C) 2008-2024 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "value.h"
#include "charset.h"
#include "gdbcmd.h"
#include "cli/cli-decode.h"
#include "completer.h"
#include "language.h"
#include "arch-utils.h"
#include "guile-internal.h"
/* A union that can hold anything described by enum var_types. */
union pascm_variable
{
/* Hold an boolean value. */
bool boolval;
/* Hold an integer value. */
int intval;
/* Hold an auto_boolean. */
enum auto_boolean autoboolval;
/* Hold an unsigned integer value, for uinteger. */
unsigned int uintval;
/* Hold a string, for the various string types. */
std::string *stringval;
/* Hold a string, for enums. */
const char *cstringval;
};
/* A GDB parameter.
Note: Parameters are added to gdb using a two step process:
1) Call make-parameter to create a <gdb:parameter> object.
2) Call register-parameter! to add the parameter to gdb.
It is done this way so that the constructor, make-parameter, doesn't have
any side-effects. This means that the smob needs to store everything
that was passed to make-parameter. */
struct param_smob
{
/* This always appears first. */
gdb_smob base;
/* The parameter name. */
char *name;
/* The last word of the command.
This is needed because add_cmd requires us to allocate space
for it. :-( */
char *cmd_name;
/* One of the COMMAND_* constants. */
enum command_class cmd_class;
/* Guile parameter type name. */
const char *pname;
/* The type of the parameter. */
enum var_types type;
/* Extra literals, such as `unlimited', accepted in lieu of a number. */
const literal_def *extra_literals;
/* The docs for the parameter. */
char *set_doc;
char *show_doc;
char *doc;
/* The corresponding gdb command objects.
These are NULL if the parameter has not been registered yet, or
is no longer registered. */
set_show_commands commands;
/* The value of the parameter. */
union pascm_variable value;
/* For an enum parameter, the possible values. The vector lives in GC
space, it will be freed with the smob. */
const char * const *enumeration;
/* The set_func function or #f if not specified.
This function is called *after* the parameter is set.
It returns a string that will be displayed to the user. */
SCM set_func;
/* The show_func function or #f if not specified.
This function returns the string that is printed. */
SCM show_func;
/* The <gdb:parameter> object we are contained in, needed to
protect/unprotect the object since a reference to it comes from
non-gc-managed space (the command context pointer). */
SCM containing_scm;
};
/* Guile parameter types as in PARAMETER_TYPES later on. */
enum scm_param_types
{
param_boolean,
param_auto_boolean,
param_zinteger,
param_uinteger,
param_zuinteger,
param_zuinteger_unlimited,
param_string,
param_string_noescape,
param_optional_filename,
param_filename,
param_enum,
};
/* Translation from Guile parameters to GDB variable types. Keep in the
same order as SCM_PARAM_TYPES due to C++'s lack of designated initializers. */
static const struct
{
/* The type of the parameter. */
enum var_types type;
/* Extra literals, such as `unlimited', accepted in lieu of a number. */
const literal_def *extra_literals;
}
param_to_var[] =
{
{ var_boolean },
{ var_auto_boolean },
{ var_integer },
{ var_uinteger, uinteger_unlimited_literals },
{ var_uinteger },
{ var_pinteger, pinteger_unlimited_literals },
{ var_string },
{ var_string_noescape },
{ var_optional_filename },
{ var_filename },
{ var_enum }
};
/* Wraps a setting around an existing param_smob. This abstraction
is used to manipulate the value in S->VALUE in a type safe manner using
the setting interface. */
static setting
make_setting (param_smob *s)
{
enum var_types type = s->type;
if (var_type_uses<bool> (type))
return setting (type, &s->value.boolval);
else if (var_type_uses<int> (type))
return setting (type, &s->value.intval, s->extra_literals);
else if (var_type_uses<auto_boolean> (type))
return setting (type, &s->value.autoboolval);
else if (var_type_uses<unsigned int> (type))
return setting (type, &s->value.uintval, s->extra_literals);
else if (var_type_uses<std::string> (type))
return setting (type, s->value.stringval);
else if (var_type_uses<const char *> (type))
return setting (type, &s->value.cstringval);
else
gdb_assert_not_reached ("unhandled var type");
}
static const char param_smob_name[] = "gdb:parameter";
/* The tag Guile knows the param smob by. */
static scm_t_bits parameter_smob_tag;
/* Keywords used by make-parameter!. */
static SCM command_class_keyword;
static SCM parameter_type_keyword;
static SCM enum_list_keyword;
static SCM set_func_keyword;
static SCM show_func_keyword;
static SCM doc_keyword;
static SCM set_doc_keyword;
static SCM show_doc_keyword;
static SCM initial_value_keyword;
static SCM auto_keyword;
static int pascm_is_valid (param_smob *);
static const char *pascm_param_type_name (enum scm_param_types type);
static SCM pascm_param_value (const setting &var, int arg_pos,
const char *func_name);
/* Administrivia for parameter smobs. */
static int
pascm_print_param_smob (SCM self, SCM port, scm_print_state *pstate)
{
param_smob *p_smob = (param_smob *) SCM_SMOB_DATA (self);
SCM value;
gdbscm_printf (port, "#<%s", param_smob_name);
gdbscm_printf (port, " %s", p_smob->name);
if (! pascm_is_valid (p_smob))
scm_puts (" {invalid}", port);
gdbscm_printf (port, " %s ", p_smob->pname);
value = pascm_param_value (make_setting (p_smob), GDBSCM_ARG_NONE, NULL);
scm_display (value, port);
scm_puts (">", port);
scm_remember_upto_here_1 (self);
/* Non-zero means success. */
return 1;
}
/* Create an empty (uninitialized) parameter. */
static SCM
pascm_make_param_smob (void)
{
param_smob *p_smob = (param_smob *)
scm_gc_malloc (sizeof (param_smob), param_smob_name);
SCM p_scm;
memset (p_smob, 0, sizeof (*p_smob));
p_smob->cmd_class = no_class;
p_smob->type = var_boolean; /* ARI: var_boolean */
p_smob->set_func = SCM_BOOL_F;
p_smob->show_func = SCM_BOOL_F;
p_scm = scm_new_smob (parameter_smob_tag, (scm_t_bits) p_smob);
p_smob->containing_scm = p_scm;
gdbscm_init_gsmob (&p_smob->base);
return p_scm;
}
/* Returns non-zero if SCM is a <gdb:parameter> object. */
static int
pascm_is_parameter (SCM scm)
{
return SCM_SMOB_PREDICATE (parameter_smob_tag, scm);
}
/* (gdb:parameter? scm) -> boolean */
static SCM
gdbscm_parameter_p (SCM scm)
{
return scm_from_bool (pascm_is_parameter (scm));
}
/* Returns the <gdb:parameter> object in SELF.
Throws an exception if SELF is not a <gdb:parameter> object. */
static SCM
pascm_get_param_arg_unsafe (SCM self, int arg_pos, const char *func_name)
{
SCM_ASSERT_TYPE (pascm_is_parameter (self), self, arg_pos, func_name,
param_smob_name);
return self;
}
/* Returns a pointer to the parameter smob of SELF.
Throws an exception if SELF is not a <gdb:parameter> object. */
static param_smob *
pascm_get_param_smob_arg_unsafe (SCM self, int arg_pos, const char *func_name)
{
SCM p_scm = pascm_get_param_arg_unsafe (self, arg_pos, func_name);
param_smob *p_smob = (param_smob *) SCM_SMOB_DATA (p_scm);
return p_smob;
}
/* Return non-zero if parameter P_SMOB is valid. */
static int
pascm_is_valid (param_smob *p_smob)
{
return p_smob->commands.set != nullptr;
}
/* A helper function which return the default documentation string for
a parameter (which is to say that it's undocumented). */
static char *
get_doc_string (void)
{
return xstrdup (_("This command is not documented."));
}
/* Subroutine of pascm_set_func, pascm_show_func to simplify them.
Signal the error returned from calling set_func/show_func. */
static void
pascm_signal_setshow_error (SCM exception, const char *msg)
{
/* Don't print the stack if this was an error signalled by the command
itself. */
if (gdbscm_user_error_p (gdbscm_exception_key (exception)))
{
gdb::unique_xmalloc_ptr<char> excp_text
= gdbscm_exception_message_to_string (exception);
error ("%s", excp_text.get ());
}
else
{
gdbscm_print_gdb_exception (SCM_BOOL_F, exception);
error ("%s", msg);
}
}
/* A callback function that is registered against the respective
add_setshow_* set_func prototype. This function will call
the Scheme function "set_func" which must exist.
Note: ARGS is always passed as NULL. */
static void
pascm_set_func (const char *args, int from_tty, struct cmd_list_element *c)
{
param_smob *p_smob = (param_smob *) c->context ();
SCM self, result, exception;
gdb_assert (gdbscm_is_procedure (p_smob->set_func));
self = p_smob->containing_scm;
result = gdbscm_safe_call_1 (p_smob->set_func, self, gdbscm_user_error_p);
if (gdbscm_is_exception (result))
{
pascm_signal_setshow_error (result,
_("Error occurred setting parameter."));
}
if (!scm_is_string (result))
error (_("Result of %s set-func is not a string."), p_smob->name);
gdb::unique_xmalloc_ptr<char> msg = gdbscm_scm_to_host_string (result, NULL,
&exception);
if (msg == NULL)
{
gdbscm_print_gdb_exception (SCM_BOOL_F, exception);
error (_("Error converting show text to host string."));
}
/* GDB is usually silent when a parameter is set. */
if (*msg.get () != '\0')
gdb_printf ("%s\n", msg.get ());
}
/* A callback function that is registered against the respective
add_setshow_* show_func prototype. This function will call
the Scheme function "show_func" which must exist and must return a
string that is then printed to FILE. */
static void
pascm_show_func (struct ui_file *file, int from_tty,
struct cmd_list_element *c, const char *value)
{
param_smob *p_smob = (param_smob *) c->context ();
SCM value_scm, self, result, exception;
gdb_assert (gdbscm_is_procedure (p_smob->show_func));
value_scm = gdbscm_scm_from_host_string (value, strlen (value));
if (gdbscm_is_exception (value_scm))
{
error (_("Error converting parameter value \"%s\" to Scheme string."),
value);
}
self = p_smob->containing_scm;
result = gdbscm_safe_call_2 (p_smob->show_func, self, value_scm,
gdbscm_user_error_p);
if (gdbscm_is_exception (result))
{
pascm_signal_setshow_error (result,
_("Error occurred showing parameter."));
}
gdb::unique_xmalloc_ptr<char> msg = gdbscm_scm_to_host_string (result, NULL,
&exception);
if (msg == NULL)
{
gdbscm_print_gdb_exception (SCM_BOOL_F, exception);
error (_("Error converting show text to host string."));
}
gdb_printf (file, "%s\n", msg.get ());
}
/* A helper function that dispatches to the appropriate add_setshow
function. */
static set_show_commands
add_setshow_generic (enum var_types param_type,
const literal_def *extra_literals,
enum command_class cmd_class,
char *cmd_name, param_smob *self,
char *set_doc, char *show_doc, char *help_doc,
cmd_func_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list)
{
set_show_commands commands;
switch (param_type)
{
case var_boolean:
commands = add_setshow_boolean_cmd (cmd_name, cmd_class,
&self->value.boolval, set_doc,
show_doc, help_doc, set_func,
show_func, set_list, show_list);
break;
case var_auto_boolean:
commands = add_setshow_auto_boolean_cmd (cmd_name, cmd_class,
&self->value.autoboolval,
set_doc, show_doc, help_doc,
set_func, show_func, set_list,
show_list);
break;
case var_uinteger:
commands = add_setshow_uinteger_cmd (cmd_name, cmd_class,
&self->value.uintval,
extra_literals, set_doc,
show_doc, help_doc, set_func,
show_func, set_list, show_list);
break;
case var_integer:
commands = add_setshow_integer_cmd (cmd_name, cmd_class,
&self->value.intval,
extra_literals, set_doc,
show_doc, help_doc, set_func,
show_func, set_list, show_list);
break;
case var_pinteger:
commands = add_setshow_pinteger_cmd (cmd_name, cmd_class,
&self->value.intval,
extra_literals, set_doc,
show_doc, help_doc, set_func,
show_func, set_list, show_list);
break;
case var_string:
commands = add_setshow_string_cmd (cmd_name, cmd_class,
self->value.stringval, set_doc,
show_doc, help_doc, set_func,
show_func, set_list, show_list);
break;
case var_string_noescape:
commands = add_setshow_string_noescape_cmd (cmd_name, cmd_class,
self->value.stringval,
set_doc, show_doc, help_doc,
set_func, show_func, set_list,
show_list);
break;
case var_optional_filename:
commands = add_setshow_optional_filename_cmd (cmd_name, cmd_class,
self->value.stringval,
set_doc, show_doc, help_doc,
set_func, show_func,
set_list, show_list);
break;
case var_filename:
commands = add_setshow_filename_cmd (cmd_name, cmd_class,
self->value.stringval, set_doc,
show_doc, help_doc, set_func,
show_func, set_list, show_list);
break;
case var_enum:
/* Initialize the value, just in case. */
make_setting (self).set<const char *> (self->enumeration[0]);
commands = add_setshow_enum_cmd (cmd_name, cmd_class, self->enumeration,
&self->value.cstringval, set_doc,
show_doc, help_doc, set_func, show_func,
set_list, show_list);
break;
default:
gdb_assert_not_reached ("bad param_type value");
}
/* Register Scheme object against the commandsparameter context. Perform this
task against both lists. */
commands.set->set_context (self);
commands.show->set_context (self);
return commands;
}
/* Return an array of strings corresponding to the enum values for
ENUM_VALUES_SCM.
Throws an exception if there's a problem with the values.
Space for the result is allocated from the GC heap. */
static const char * const *
compute_enum_list (SCM enum_values_scm, int arg_pos, const char *func_name)
{
long i, size;
char **enum_values;
const char * const *result;
SCM_ASSERT_TYPE (gdbscm_is_true (scm_list_p (enum_values_scm)),
enum_values_scm, arg_pos, func_name, _("list"));
size = scm_ilength (enum_values_scm);
if (size == 0)
{
gdbscm_out_of_range_error (FUNC_NAME, arg_pos, enum_values_scm,
_("enumeration list is empty"));
}
enum_values = XCNEWVEC (char *, size + 1);
i = 0;
while (!scm_is_eq (enum_values_scm, SCM_EOL))
{
SCM value = scm_car (enum_values_scm);
SCM exception;
if (!scm_is_string (value))
{
freeargv (enum_values);
SCM_ASSERT_TYPE (0, value, arg_pos, func_name, _("string"));
}
enum_values[i] = gdbscm_scm_to_host_string (value, NULL,
&exception).release ();
if (enum_values[i] == NULL)
{
freeargv (enum_values);
gdbscm_throw (exception);
}
++i;
enum_values_scm = scm_cdr (enum_values_scm);
}
gdb_assert (i == size);
result = gdbscm_gc_dup_argv (enum_values);
freeargv (enum_values);
return result;
}
static const scheme_integer_constant parameter_types[] =
{
{ "PARAM_BOOLEAN", param_boolean }, /* ARI: param_boolean */
{ "PARAM_AUTO_BOOLEAN", param_auto_boolean },
{ "PARAM_ZINTEGER", param_zinteger },
{ "PARAM_UINTEGER", param_uinteger },
{ "PARAM_ZUINTEGER", param_zuinteger },
{ "PARAM_ZUINTEGER_UNLIMITED", param_zuinteger_unlimited },
{ "PARAM_STRING", param_string },
{ "PARAM_STRING_NOESCAPE", param_string_noescape },
{ "PARAM_OPTIONAL_FILENAME", param_optional_filename },
{ "PARAM_FILENAME", param_filename },
{ "PARAM_ENUM", param_enum },
END_INTEGER_CONSTANTS
};
/* Return non-zero if PARAM_TYPE is a valid parameter type. */
static int
pascm_valid_parameter_type_p (int param_type)
{
int i;
for (i = 0; parameter_types[i].name != NULL; ++i)
{
if (parameter_types[i].value == param_type)
return 1;
}
return 0;
}
/* Return PARAM_TYPE as a string. */
static const char *
pascm_param_type_name (enum scm_param_types param_type)
{
int i;
for (i = 0; parameter_types[i].name != NULL; ++i)
{
if (parameter_types[i].value == param_type)
return parameter_types[i].name;
}
gdb_assert_not_reached ("bad parameter type");
}
/* Return the value of a gdb parameter as a Scheme value.
If the var_type of VAR is not supported, then a <gdb:exception> object is
returned. */
static SCM
pascm_param_value (const setting &var, int arg_pos, const char *func_name)
{
switch (var.type ())
{
case var_string:
case var_string_noescape:
case var_optional_filename:
case var_filename:
{
const std::string &str = var.get<std::string> ();
return gdbscm_scm_from_host_string (str.c_str (), str.length ());
}
case var_enum:
{
const char *str = var.get<const char *> ();
if (str == nullptr)
str = "";
return gdbscm_scm_from_host_string (str, strlen (str));
}
case var_boolean:
{
if (var.get<bool> ())
return SCM_BOOL_T;
else
return SCM_BOOL_F;
}
case var_auto_boolean:
{
enum auto_boolean ab = var.get<enum auto_boolean> ();
if (ab == AUTO_BOOLEAN_TRUE)
return SCM_BOOL_T;
else if (ab == AUTO_BOOLEAN_FALSE)
return SCM_BOOL_F;
else
return auto_keyword;
}
case var_uinteger:
case var_integer:
case var_pinteger:
{
LONGEST value
= (var.type () == var_uinteger
? static_cast<LONGEST> (var.get<unsigned int> ())
: static_cast<LONGEST> (var.get<int> ()));
if (var.extra_literals () != nullptr)
for (const literal_def *l = var.extra_literals ();
l->literal != nullptr;
l++)
if (value == l->use)
return scm_from_latin1_keyword (l->literal);
if (var.type () == var_pinteger)
gdb_assert (value >= 0);
if (var.type () == var_uinteger)
return scm_from_uint (static_cast<unsigned int> (value));
else
return scm_from_int (static_cast<int> (value));
}
default:
break;
}
return gdbscm_make_out_of_range_error (func_name, arg_pos,
scm_from_int (var.type ()),
_("program error: unhandled type"));
}
/* Set the value of a parameter of type P_SMOB->TYPE in P_SMOB->VAR from VALUE.
ENUMERATION is the list of enum values for enum parameters, otherwise NULL.
Throws a Scheme exception if VALUE_SCM is invalid for TYPE. */
static void
pascm_set_param_value_x (param_smob *p_smob,
const char * const *enumeration,
SCM value, int arg_pos, const char *func_name)
{
setting var = make_setting (p_smob);
switch (var.type ())
{
case var_string:
case var_string_noescape:
case var_optional_filename:
case var_filename:
SCM_ASSERT_TYPE (scm_is_string (value)
|| (var.type () != var_filename
&& gdbscm_is_false (value)),
value, arg_pos, func_name,
_("string or #f for non-PARAM_FILENAME parameters"));
if (gdbscm_is_false (value))
var.set<std::string> ("");
else
{
SCM exception;
gdb::unique_xmalloc_ptr<char> string
= gdbscm_scm_to_host_string (value, nullptr, &exception);
if (string == nullptr)
gdbscm_throw (exception);
var.set<std::string> (string.release ());
}
break;
case var_enum:
{
int i;
SCM exception;
SCM_ASSERT_TYPE (scm_is_string (value), value, arg_pos, func_name,
_("string"));
gdb::unique_xmalloc_ptr<char> str
= gdbscm_scm_to_host_string (value, nullptr, &exception);
if (str == nullptr)
gdbscm_throw (exception);
for (i = 0; enumeration[i]; ++i)
{
if (strcmp (enumeration[i], str.get ()) == 0)
break;
}
if (enumeration[i] == nullptr)
{
gdbscm_out_of_range_error (func_name, arg_pos, value,
_("not member of enumeration"));
}
var.set<const char *> (enumeration[i]);
break;
}
case var_boolean:
SCM_ASSERT_TYPE (gdbscm_is_bool (value), value, arg_pos, func_name,
_("boolean"));
var.set<bool> (gdbscm_is_true (value));
break;
case var_auto_boolean:
SCM_ASSERT_TYPE (gdbscm_is_bool (value)
|| scm_is_eq (value, auto_keyword),
value, arg_pos, func_name,
_("boolean or #:auto"));
if (scm_is_eq (value, auto_keyword))
var.set<enum auto_boolean> (AUTO_BOOLEAN_AUTO);
else if (gdbscm_is_true (value))
var.set<enum auto_boolean> (AUTO_BOOLEAN_TRUE);
else
var.set<enum auto_boolean> (AUTO_BOOLEAN_FALSE);
break;
case var_integer:
case var_uinteger:
case var_pinteger:
{
const literal_def *extra_literals = p_smob->extra_literals;
enum tribool allowed = TRIBOOL_UNKNOWN;
enum var_types var_type = var.type ();
bool integer = scm_is_integer (value);
bool keyword = scm_is_keyword (value);
std::string buffer = "";
size_t count = 0;
LONGEST val;
if (extra_literals != nullptr)
for (const literal_def *l = extra_literals;
l->literal != nullptr;
l++, count++)
{
if (count != 0)
buffer += ", ";
buffer = buffer + "#:" + l->literal;
if (keyword
&& allowed == TRIBOOL_UNKNOWN
&& scm_is_eq (value,
scm_from_latin1_keyword (l->literal)))
{
val = l->use;
allowed = TRIBOOL_TRUE;
}
}
if (allowed == TRIBOOL_UNKNOWN)
{
if (extra_literals == nullptr)
SCM_ASSERT_TYPE (integer, value, arg_pos, func_name,
_("integer"));
else if (count > 1)
SCM_ASSERT_TYPE (integer, value, arg_pos, func_name,
string_printf (_("integer or one of: %s"),
buffer.c_str ()).c_str ());
else
SCM_ASSERT_TYPE (integer, value, arg_pos, func_name,
string_printf (_("integer or %s"),
buffer.c_str ()).c_str ());
val = (var_type == var_uinteger
? static_cast<LONGEST> (scm_to_uint (value))
: static_cast<LONGEST> (scm_to_int (value)));
if (extra_literals != nullptr)
for (const literal_def *l = extra_literals;
l->literal != nullptr;
l++)
{
if (l->val.has_value () && val == *l->val)
{
allowed = TRIBOOL_TRUE;
val = l->use;
break;
}
else if (val == l->use)
allowed = TRIBOOL_FALSE;
}
}
if (allowed == TRIBOOL_UNKNOWN)
{
if (val > UINT_MAX || val < INT_MIN
|| (var_type == var_uinteger && val < 0)
|| (var_type == var_integer && val > INT_MAX)
|| (var_type == var_pinteger && val < 0)
|| (var_type == var_pinteger && val > INT_MAX))
allowed = TRIBOOL_FALSE;
}
if (allowed == TRIBOOL_FALSE)
gdbscm_out_of_range_error (func_name, arg_pos, value,
_("integer out of range"));
if (var_type == var_uinteger)
var.set<unsigned int> (static_cast<unsigned int> (val));
else
var.set<int> (static_cast<int> (val));
break;
}
default:
gdb_assert_not_reached ("bad parameter type");
}
}
/* Free function for a param_smob. */
static size_t
pascm_free_parameter_smob (SCM self)
{
param_smob *p_smob = (param_smob *) SCM_SMOB_DATA (self);
if (var_type_uses<std::string> (p_smob->type))
{
delete p_smob->value.stringval;
p_smob->value.stringval = nullptr;
}
return 0;
}
/* Parameter Scheme functions. */
/* (make-parameter name
[#:command-class cmd-class] [#:parameter-type param-type]
[#:enum-list enum-list] [#:set-func function] [#:show-func function]
[#:doc <string>] [#:set-doc <string>] [#:show-doc <string>]
[#:initial-value initial-value]) -> <gdb:parameter>
NAME is the name of the parameter. It may consist of multiple
words, in which case the final word is the name of the new parameter,
and earlier words must be prefix commands.
CMD-CLASS is the kind of command. It should be one of the COMMAND_*
constants defined in the gdb module.
PARAM_TYPE is the type of the parameter. It should be one of the
PARAM_* constants defined in the gdb module.
If PARAM-TYPE is PARAM_ENUM, then ENUM-LIST is a list of strings that
are the valid values for this parameter. The first value is the default.
SET-FUNC, if provided, is called after the parameter is set.
It is a function of one parameter: the <gdb:parameter> object.
It must return a string to be displayed to the user.
Setting a parameter is typically a silent operation, so typically ""
should be returned.
SHOW-FUNC, if provided, returns the string that is printed.
It is a function of two parameters: the <gdb:parameter> object
and the current value of the parameter as a string.
DOC, SET-DOC, SHOW-DOC are the doc strings for the parameter.
INITIAL-VALUE is the initial value of the parameter.
The result is the <gdb:parameter> Scheme object.
The parameter is not available to be used yet, however.
It must still be added to gdb with register-parameter!. */
static SCM
gdbscm_make_parameter (SCM name_scm, SCM rest)
{
const SCM keywords[] = {
command_class_keyword, parameter_type_keyword, enum_list_keyword,
set_func_keyword, show_func_keyword,
doc_keyword, set_doc_keyword, show_doc_keyword,
initial_value_keyword, SCM_BOOL_F
};
int cmd_class_arg_pos = -1, param_type_arg_pos = -1;
int enum_list_arg_pos = -1, set_func_arg_pos = -1, show_func_arg_pos = -1;
int doc_arg_pos = -1, set_doc_arg_pos = -1, show_doc_arg_pos = -1;
int initial_value_arg_pos = -1;
char *s;
char *name;
int cmd_class = no_class;
int param_type = param_boolean; /* ARI: param_boolean */
SCM enum_list_scm = SCM_BOOL_F;
SCM set_func = SCM_BOOL_F, show_func = SCM_BOOL_F;
char *doc = NULL, *set_doc = NULL, *show_doc = NULL;
SCM initial_value_scm = SCM_BOOL_F;
const char * const *enum_list = NULL;
SCM p_scm;
param_smob *p_smob;
gdbscm_parse_function_args (FUNC_NAME, SCM_ARG1, keywords, "s#iiOOOsssO",
name_scm, &name, rest,
&cmd_class_arg_pos, &cmd_class,
¶m_type_arg_pos, ¶m_type,
&enum_list_arg_pos, &enum_list_scm,
&set_func_arg_pos, &set_func,
&show_func_arg_pos, &show_func,
&doc_arg_pos, &doc,
&set_doc_arg_pos, &set_doc,
&show_doc_arg_pos, &show_doc,
&initial_value_arg_pos, &initial_value_scm);
/* If doc is NULL, leave it NULL. See add_setshow_cmd_full. */
if (set_doc == NULL)
set_doc = get_doc_string ();
if (show_doc == NULL)
show_doc = get_doc_string ();
s = name;
name = gdbscm_canonicalize_command_name (s, 0);
xfree (s);
if (doc != NULL)
{
s = doc;
doc = gdbscm_gc_xstrdup (s);
xfree (s);
}
s = set_doc;
set_doc = gdbscm_gc_xstrdup (s);
xfree (s);
s = show_doc;
show_doc = gdbscm_gc_xstrdup (s);
xfree (s);
if (!gdbscm_valid_command_class_p (cmd_class))
{
gdbscm_out_of_range_error (FUNC_NAME, cmd_class_arg_pos,
scm_from_int (cmd_class),
_("invalid command class argument"));
}
if (!pascm_valid_parameter_type_p (param_type))
{
gdbscm_out_of_range_error (FUNC_NAME, param_type_arg_pos,
scm_from_int (param_type),
_("invalid parameter type argument"));
}
if (enum_list_arg_pos > 0 && param_type != param_enum)
{
gdbscm_misc_error (FUNC_NAME, enum_list_arg_pos, enum_list_scm,
_("#:enum-values can only be provided with PARAM_ENUM"));
}
if (enum_list_arg_pos < 0 && param_type == param_enum)
{
gdbscm_misc_error (FUNC_NAME, GDBSCM_ARG_NONE, SCM_BOOL_F,
_("PARAM_ENUM requires an enum-values argument"));
}
if (set_func_arg_pos > 0)
{
SCM_ASSERT_TYPE (gdbscm_is_procedure (set_func), set_func,
set_func_arg_pos, FUNC_NAME, _("procedure"));
}
if (show_func_arg_pos > 0)
{
SCM_ASSERT_TYPE (gdbscm_is_procedure (show_func), show_func,
show_func_arg_pos, FUNC_NAME, _("procedure"));
}
if (param_type == param_enum)
{
/* Note: enum_list lives in GC space, so we don't have to worry about
freeing it if we later throw an exception. */
enum_list = compute_enum_list (enum_list_scm, enum_list_arg_pos,
FUNC_NAME);
}
/* If initial-value is a function, we need the parameter object constructed
to pass it to the function. A typical thing the function may want to do
is add an object-property to it to record the last known good value. */
p_scm = pascm_make_param_smob ();
p_smob = (param_smob *) SCM_SMOB_DATA (p_scm);
/* These are all stored in GC space so that we don't have to worry about
freeing them if we throw an exception. */
p_smob->name = name;
p_smob->cmd_class = (enum command_class) cmd_class;
p_smob->pname
= pascm_param_type_name (static_cast<enum scm_param_types> (param_type));
p_smob->type = param_to_var[param_type].type;
p_smob->extra_literals = param_to_var[param_type].extra_literals;
p_smob->doc = doc;
p_smob->set_doc = set_doc;
p_smob->show_doc = show_doc;
p_smob->enumeration = enum_list;
p_smob->set_func = set_func;
p_smob->show_func = show_func;
scm_set_smob_free (parameter_smob_tag, pascm_free_parameter_smob);
if (var_type_uses<std::string> (p_smob->type))
p_smob->value.stringval = new std::string;
if (initial_value_arg_pos > 0)
{
if (gdbscm_is_procedure (initial_value_scm))
{
initial_value_scm = gdbscm_safe_call_1 (initial_value_scm,
p_smob->containing_scm, NULL);
if (gdbscm_is_exception (initial_value_scm))
gdbscm_throw (initial_value_scm);
}
pascm_set_param_value_x (p_smob, enum_list,
initial_value_scm,
initial_value_arg_pos, FUNC_NAME);
}
return p_scm;
}
/* Subroutine of gdbscm_register_parameter_x to simplify it.
Return non-zero if parameter NAME is already defined in LIST. */
static int
pascm_parameter_defined_p (const char *name, struct cmd_list_element *list)
{
struct cmd_list_element *c;
c = lookup_cmd_1 (&name, list, NULL, NULL, 1);
/* If the name is ambiguous that's ok, it's a new parameter still. */
return c != NULL && c != CMD_LIST_AMBIGUOUS;
}
/* (register-parameter! <gdb:parameter>) -> unspecified
It is an error to register a pre-existing parameter. */
static SCM
gdbscm_register_parameter_x (SCM self)
{
param_smob *p_smob
= pascm_get_param_smob_arg_unsafe (self, SCM_ARG1, FUNC_NAME);
char *cmd_name;
struct cmd_list_element **set_list, **show_list;
if (pascm_is_valid (p_smob))
scm_misc_error (FUNC_NAME, _("parameter is already registered"), SCM_EOL);
cmd_name = gdbscm_parse_command_name (p_smob->name, FUNC_NAME, SCM_ARG1,
&set_list, &setlist);
xfree (cmd_name);
cmd_name = gdbscm_parse_command_name (p_smob->name, FUNC_NAME, SCM_ARG1,
&show_list, &showlist);
p_smob->cmd_name = gdbscm_gc_xstrdup (cmd_name);
xfree (cmd_name);
if (pascm_parameter_defined_p (p_smob->cmd_name, *set_list))
{
gdbscm_misc_error (FUNC_NAME, SCM_ARG1, self,
_("parameter exists, \"set\" command is already defined"));
}
if (pascm_parameter_defined_p (p_smob->cmd_name, *show_list))
{
gdbscm_misc_error (FUNC_NAME, SCM_ARG1, self,
_("parameter exists, \"show\" command is already defined"));
}
gdbscm_gdb_exception exc {};
try
{
p_smob->commands = add_setshow_generic
(p_smob->type, p_smob->extra_literals,
p_smob->cmd_class, p_smob->cmd_name, p_smob,
p_smob->set_doc, p_smob->show_doc, p_smob->doc,
(gdbscm_is_procedure (p_smob->set_func) ? pascm_set_func : NULL),
(gdbscm_is_procedure (p_smob->show_func) ? pascm_show_func : NULL),
set_list, show_list);
}
catch (const gdb_exception &except)
{
exc = unpack (except);
}
GDBSCM_HANDLE_GDB_EXCEPTION (exc);
/* Note: At this point the parameter exists in gdb.
So no more errors after this point. */
/* The owner of this parameter is not in GC-controlled memory, so we need
to protect it from GC until the parameter is deleted. */
scm_gc_protect_object (p_smob->containing_scm);
return SCM_UNSPECIFIED;
}
/* (parameter-value <gdb:parameter>) -> value
(parameter-value <string>) -> value */
static SCM
gdbscm_parameter_value (SCM self)
{
SCM_ASSERT_TYPE (pascm_is_parameter (self) || scm_is_string (self),
self, SCM_ARG1, FUNC_NAME, _("<gdb:parameter> or string"));
if (pascm_is_parameter (self))
{
param_smob *p_smob = pascm_get_param_smob_arg_unsafe (self, SCM_ARG1,
FUNC_NAME);
return pascm_param_value (make_setting (p_smob), SCM_ARG1, FUNC_NAME);
}
else
{
SCM except_scm;
struct cmd_list_element *alias, *prefix, *cmd;
char *newarg;
int found = -1;
gdbscm_gdb_exception except {};
gdb::unique_xmalloc_ptr<char> name
= gdbscm_scm_to_host_string (self, NULL, &except_scm);
if (name == NULL)
gdbscm_throw (except_scm);
newarg = concat ("show ", name.get (), (char *) NULL);
try
{
found = lookup_cmd_composition (newarg, &alias, &prefix, &cmd);
}
catch (const gdb_exception &ex)
{
except = unpack (ex);
}
xfree (newarg);
GDBSCM_HANDLE_GDB_EXCEPTION (except);
if (!found)
{
gdbscm_out_of_range_error (FUNC_NAME, SCM_ARG1, self,
_("parameter not found"));
}
if (!cmd->var.has_value ())
{
gdbscm_out_of_range_error (FUNC_NAME, SCM_ARG1, self,
_("not a parameter"));
}
return pascm_param_value (*cmd->var, SCM_ARG1, FUNC_NAME);
}
}
/* (set-parameter-value! <gdb:parameter> value) -> unspecified */
static SCM
gdbscm_set_parameter_value_x (SCM self, SCM value)
{
param_smob *p_smob = pascm_get_param_smob_arg_unsafe (self, SCM_ARG1,
FUNC_NAME);
pascm_set_param_value_x (p_smob, p_smob->enumeration,
value, SCM_ARG2, FUNC_NAME);
return SCM_UNSPECIFIED;
}
/* Initialize the Scheme parameter support. */
static const scheme_function parameter_functions[] =
{
{ "make-parameter", 1, 0, 1, as_a_scm_t_subr (gdbscm_make_parameter),
"\
Make a GDB parameter object.\n\
\n\
Arguments: name\n\
[#:command-class <cmd-class>] [#:parameter-type <parameter-type>]\n\
[#:enum-list <enum-list>]\n\
[#:set-func function] [#:show-func function]\n\
[#:doc string] [#:set-doc string] [#:show-doc string]\n\
[#:initial-value initial-value]\n\
name: The name of the command. It may consist of multiple words,\n\
in which case the final word is the name of the new parameter, and\n\
earlier words must be prefix commands.\n\
cmd-class: The class of the command, one of COMMAND_*.\n\
The default is COMMAND_NONE.\n\
parameter-type: The kind of parameter, one of PARAM_*\n\
The default is PARAM_BOOLEAN.\n\
enum-list: If parameter-type is PARAM_ENUM, then this specifies the set\n\
of values of the enum.\n\
set-func: A function of one parameter: the <gdb:parameter> object.\n\
Called *after* the parameter has been set. Returns either \"\" or a\n\
non-empty string to be displayed to the user.\n\
If non-empty, GDB will add a trailing newline.\n\
show-func: A function of two parameters: the <gdb:parameter> object\n\
and the string representation of the current value.\n\
The result is a string to be displayed to the user.\n\
GDB will add a trailing newline.\n\
doc: The \"doc string\" of the parameter.\n\
set-doc: The \"doc string\" when setting the parameter.\n\
show-doc: The \"doc string\" when showing the parameter.\n\
initial-value: The initial value of the parameter." },
{ "register-parameter!", 1, 0, 0,
as_a_scm_t_subr (gdbscm_register_parameter_x),
"\
Register a <gdb:parameter> object with GDB." },
{ "parameter?", 1, 0, 0, as_a_scm_t_subr (gdbscm_parameter_p),
"\
Return #t if the object is a <gdb:parameter> object." },
{ "parameter-value", 1, 0, 0, as_a_scm_t_subr (gdbscm_parameter_value),
"\
Return the value of a <gdb:parameter> object\n\
or any gdb parameter if param is a string naming the parameter." },
{ "set-parameter-value!", 2, 0, 0,
as_a_scm_t_subr (gdbscm_set_parameter_value_x),
"\
Set the value of a <gdb:parameter> object.\n\
\n\
Arguments: <gdb:parameter> value" },
END_FUNCTIONS
};
void
gdbscm_initialize_parameters (void)
{
parameter_smob_tag
= gdbscm_make_smob_type (param_smob_name, sizeof (param_smob));
scm_set_smob_print (parameter_smob_tag, pascm_print_param_smob);
gdbscm_define_integer_constants (parameter_types, 1);
gdbscm_define_functions (parameter_functions, 1);
command_class_keyword = scm_from_latin1_keyword ("command-class");
parameter_type_keyword = scm_from_latin1_keyword ("parameter-type");
enum_list_keyword = scm_from_latin1_keyword ("enum-list");
set_func_keyword = scm_from_latin1_keyword ("set-func");
show_func_keyword = scm_from_latin1_keyword ("show-func");
doc_keyword = scm_from_latin1_keyword ("doc");
set_doc_keyword = scm_from_latin1_keyword ("set-doc");
show_doc_keyword = scm_from_latin1_keyword ("show-doc");
initial_value_keyword = scm_from_latin1_keyword ("initial-value");
auto_keyword = scm_from_latin1_keyword ("auto");
}
|