1 /*-------------------------------------------------------------------------
4 * Displays available options under grand unified configuration scheme
6 * Options whose flag bits are set to GUC_NO_SHOW_ALL, GUC_NOT_IN_SAMPLE,
7 * or GUC_DISALLOW_IN_FILE are not displayed, unless the user specifically
8 * requests that variable by name
10 * Portions Copyright (c) 1996-2005, PostgreSQL Global Development Group
13 * $PostgreSQL: pgsql/src/backend/utils/misc/help_config.c,v 1.15 2005/02/22 04:38:05 momjian Exp $
15 *-------------------------------------------------------------------------
23 #include "utils/guc.h"
24 #include "utils/guc_tables.h"
25 #include "utils/help_config.h"
29 * This union allows us to mix the numerous different types of structs
30 * that we are organizing.
34 struct config_generic generic;
35 struct config_bool bool;
36 struct config_real real;
37 struct config_int integer;
38 struct config_string string;
42 static void printMixedStruct(mixedStruct *structToPrint);
43 static bool displayStruct(mixedStruct *structToDisplay);
49 struct config_generic **guc_vars;
53 /* Initialize the guc_variables[] array */
54 build_guc_variables();
56 guc_vars = get_guc_variables();
57 numOpts = GetNumConfigOptions();
59 for (i = 0; i < numOpts; i++)
61 mixedStruct *var = (mixedStruct *) guc_vars[i];
63 if (displayStruct(var))
64 printMixedStruct(var);
72 * This function will return true if the struct passed to it
73 * should be displayed to the user.
76 displayStruct(mixedStruct *structToDisplay)
78 return !(structToDisplay->generic.flags & (GUC_NO_SHOW_ALL |
80 GUC_DISALLOW_IN_FILE));
85 * This function prints out the generic struct passed to it. It will print out
86 * a different format, depending on what the user wants to see.
89 printMixedStruct(mixedStruct *structToPrint)
91 printf("%s\t%s\t%s\t",
92 structToPrint->generic.name,
93 GucContext_Names[structToPrint->generic.context],
94 _(config_group_names[structToPrint->generic.group]));
96 switch (structToPrint->generic.vartype)
100 printf("BOOLEAN\t%s\t\t\t",
101 (structToPrint->bool.reset_val == 0) ?
106 printf("INTEGER\t%d\t%d\t%d\t",
107 structToPrint->integer.reset_val,
108 structToPrint->integer.min,
109 structToPrint->integer.max);
113 printf("REAL\t%g\t%g\t%g\t",
114 structToPrint->real.reset_val,
115 structToPrint->real.min,
116 structToPrint->real.max);
120 printf("STRING\t%s\t\t\t",
121 structToPrint->string.boot_val);
125 write_stderr("internal error: unrecognized run-time parameter type\n");
130 (structToPrint->generic.short_desc == NULL) ? "" : _(structToPrint->generic.short_desc),
131 (structToPrint->generic.long_desc == NULL) ? "" : _(structToPrint->generic.long_desc));