1 //===-- lldb-private-enumerations.h -----------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLDB_lldb_private_enumerations_h_
11 #define LLDB_lldb_private_enumerations_h_
13 namespace lldb_private {
15 //----------------------------------------------------------------------
17 //----------------------------------------------------------------------
21 eStepTypeTrace, ///< Single step one instruction.
22 eStepTypeTraceOver, ///< Single step one instruction, stepping over.
23 eStepTypeInto, ///< Single step into a specified context.
24 eStepTypeOver, ///< Single step over a specified context.
25 eStepTypeOut, ///< Single step out a specified context.
26 eStepTypeScripted ///< A step type implemented by the script interpreter.
29 //----------------------------------------------------------------------
31 //----------------------------------------------------------------------
32 typedef enum AddressType
34 eAddressTypeInvalid = 0,
35 eAddressTypeFile, ///< Address is an address as found in an object or symbol file
36 eAddressTypeLoad, ///< Address is an address as in the current target inferior process
37 eAddressTypeHost ///< Address is an address in the process that is running this code
40 //----------------------------------------------------------------------
41 // Votes - Need a tri-state, yes, no, no opinion...
42 //----------------------------------------------------------------------
50 typedef enum ArchitectureType
59 //----------------------------------------------------------------------
60 /// Settable state variable types.
62 //----------------------------------------------------------------------
64 //typedef enum SettableVariableType
67 // eSetVarTypeBoolean,
70 // eSetVarTypeDictionary,
73 //} SettableVariableType;
75 typedef enum VarSetOperationType
77 eVarSetOperationReplace,
78 eVarSetOperationInsertBefore,
79 eVarSetOperationInsertAfter,
80 eVarSetOperationRemove,
81 eVarSetOperationAppend,
82 eVarSetOperationClear,
83 eVarSetOperationAssign,
84 eVarSetOperationInvalid
85 } VarSetOperationType;
87 typedef enum ArgumentRepetitionType
89 eArgRepeatPlain, // Exactly one occurrence
90 eArgRepeatOptional, // At most one occurrence, but it's optional
91 eArgRepeatPlus, // One or more occurrences
92 eArgRepeatStar, // Zero or more occurrences
93 eArgRepeatRange, // Repetition of same argument, from 1 to n
94 eArgRepeatPairPlain, // A pair of arguments that must always go together ([arg-type arg-value]), occurs exactly once
95 eArgRepeatPairOptional, // A pair that occurs at most once (optional)
96 eArgRepeatPairPlus, // One or more occurrences of a pair
97 eArgRepeatPairStar, // Zero or more occurrences of a pair
98 eArgRepeatPairRange, // A pair that repeats from 1 to n
99 eArgRepeatPairRangeOptional // A pair that repeats from 1 to n, but is optional
100 } ArgumentRepetitionType;
102 typedef enum SortOrder
109 typedef enum ObjCRuntimeVersions {
110 eObjC_VersionUnknown = 0,
113 } ObjCRuntimeVersions;
116 //----------------------------------------------------------------------
117 // LazyBool is for boolean values that need to be calculated lazily.
118 // Values start off set to eLazyBoolCalculate, and then they can be
119 // calculated once and set to eLazyBoolNo or eLazyBoolYes.
120 //----------------------------------------------------------------------
121 typedef enum LazyBool {
122 eLazyBoolCalculate = -1,
127 //------------------------------------------------------------------
129 //------------------------------------------------------------------
130 typedef enum NameMatchType
135 eNameMatchStartsWith,
137 eNameMatchRegularExpression
142 //------------------------------------------------------------------
143 /// Instruction types
144 //------------------------------------------------------------------
145 typedef enum InstructionType
147 eInstructionTypeAny, // Support for any instructions at all (at least one)
148 eInstructionTypePrologueEpilogue, // All prologue and epilogue instructions that push and pop register values and modify sp/fp
149 eInstructionTypePCModifying, // Any instruction that modifies the program counter/instruction pointer
150 eInstructionTypeAll // All instructions of any kind
155 //------------------------------------------------------------------
156 /// Format category entry types
157 //------------------------------------------------------------------
158 typedef enum FormatCategoryItem
160 eFormatCategoryItemSummary = 0x0001,
161 eFormatCategoryItemRegexSummary = 0x0002,
162 eFormatCategoryItemFilter = 0x0004,
163 eFormatCategoryItemRegexFilter = 0x0008,
164 eFormatCategoryItemSynth = 0x0010,
165 eFormatCategoryItemRegexSynth = 0x0020,
166 eFormatCategoryItemValue = 0x0040,
167 eFormatCategoryItemRegexValue = 0x0080,
168 eFormatCategoryItemValidator = 0x0100,
169 eFormatCategoryItemRegexValidator = 0x0200
170 } FormatCategoryItem;
172 //------------------------------------------------------------------
173 /// Expression execution policies
174 //------------------------------------------------------------------
176 eExecutionPolicyOnlyWhenNeeded,
177 eExecutionPolicyNever,
178 eExecutionPolicyAlways
181 //----------------------------------------------------------------------
182 // Ways that the FormatManager picks a particular format for a type
183 //----------------------------------------------------------------------
184 typedef enum FormatterChoiceCriterion
186 eFormatterChoiceCriterionDirectChoice = 0x00000000,
187 eFormatterChoiceCriterionStrippedPointerReference = 0x00000001,
188 eFormatterChoiceCriterionNavigatedTypedefs = 0x00000002,
189 eFormatterChoiceCriterionRegularExpressionSummary = 0x00000004,
190 eFormatterChoiceCriterionRegularExpressionFilter = 0x00000004,
191 eFormatterChoiceCriterionDynamicObjCDiscovery = 0x00000008,
192 eFormatterChoiceCriterionStrippedBitField = 0x00000010,
193 eFormatterChoiceCriterionWentToStaticValue = 0x00000020
194 } FormatterChoiceCriterion;
196 //----------------------------------------------------------------------
197 // Synchronicity behavior of scripted commands
198 //----------------------------------------------------------------------
199 typedef enum ScriptedCommandSynchronicity
201 eScriptedCommandSynchronicitySynchronous,
202 eScriptedCommandSynchronicityAsynchronous,
203 eScriptedCommandSynchronicityCurrentValue // use whatever the current synchronicity is
204 } ScriptedCommandSynchronicity;
206 //----------------------------------------------------------------------
207 // Verbosity mode of "po" output
208 //----------------------------------------------------------------------
209 typedef enum LanguageRuntimeDescriptionDisplayVerbosity
211 eLanguageRuntimeDescriptionDisplayVerbosityCompact, // only print the description string, if any
212 eLanguageRuntimeDescriptionDisplayVerbosityFull, // print the full-blown output
213 } LanguageRuntimeDescriptionDisplayVerbosity;
215 //----------------------------------------------------------------------
216 // Loading modules from memory
217 //----------------------------------------------------------------------
218 typedef enum MemoryModuleLoadLevel {
219 eMemoryModuleLoadLevelMinimal, // Load sections only
220 eMemoryModuleLoadLevelPartial, // Load function bounds but no symbols
221 eMemoryModuleLoadLevelComplete, // Load sections and all symbols
222 } MemoryModuleLoadLevel;
225 //----------------------------------------------------------------------
226 // Result enums for when reading multiple lines from IOHandlers
227 //----------------------------------------------------------------------
228 enum class LineStatus {
229 Success, // The line that was just edited if good and should be added to the lines
230 Error, // There is an error with the current line and it needs to be re-edited before it can be accepted
231 Done // Lines are complete
234 //----------------------------------------------------------------------
235 // Exit Type for inferior processes
236 //----------------------------------------------------------------------
237 typedef enum ExitType {
239 eExitTypeExit, // The exit status represents the return code from normal program exit (i.e. WIFEXITED() was true)
240 eExitTypeSignal, // The exit status represents the signal number that caused the program to exit (i.e. WIFSIGNALED() was true)
241 eExitTypeStop, // The exit status represents the stop signal that caused the program to exit (i.e. WIFSTOPPED() was true)
244 //----------------------------------------------------------------------
245 // Boolean result of running a Type Validator
246 //----------------------------------------------------------------------
247 enum class TypeValidatorResult : bool {
252 } // namespace lldb_private
255 #endif // LLDB_lldb_private_enumerations_h_