1 //===-- OptionValueFileSpec.h -----------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLDB_INTERPRETER_OPTIONVALUEFILESPEC_H
10 #define LLDB_INTERPRETER_OPTIONVALUEFILESPEC_H
11 
12 #include "lldb/Interpreter/CommandCompletions.h"
13 #include "lldb/Interpreter/OptionValue.h"
14 
15 #include "lldb/Utility/FileSpec.h"
16 #include "llvm/Support/Chrono.h"
17 
18 namespace lldb_private {
19 
20 class OptionValueFileSpec : public Cloneable<OptionValueFileSpec, OptionValue> {
21 public:
22   OptionValueFileSpec(bool resolve = true);
23 
24   OptionValueFileSpec(const FileSpec &value, bool resolve = true);
25 
26   OptionValueFileSpec(const FileSpec &current_value,
27                       const FileSpec &default_value, bool resolve = true);
28 
29   ~OptionValueFileSpec() override = default;
30 
31   // Virtual subclass pure virtual overrides
32 
33   OptionValue::Type GetType() const override { return eTypeFileSpec; }
34 
35   void DumpValue(const ExecutionContext *exe_ctx, Stream &strm,
36                  uint32_t dump_mask) override;
37 
38   Status
39   SetValueFromString(llvm::StringRef value,
40                      VarSetOperationType op = eVarSetOperationAssign) override;
41 
42   void Clear() override {
43     m_current_value = m_default_value;
44     m_value_was_set = false;
45     m_data_sp.reset();
46     m_data_mod_time = llvm::sys::TimePoint<>();
47   }
48 
49   void AutoComplete(CommandInterpreter &interpreter,
50                     CompletionRequest &request) override;
51 
52   // Subclass specific functions
53 
54   FileSpec &GetCurrentValue() { return m_current_value; }
55 
56   const FileSpec &GetCurrentValue() const { return m_current_value; }
57 
58   const FileSpec &GetDefaultValue() const { return m_default_value; }
59 
60   void SetCurrentValue(const FileSpec &value, bool set_value_was_set) {
61     m_current_value = value;
62     if (set_value_was_set)
63       m_value_was_set = true;
64     m_data_sp.reset();
65   }
66 
67   void SetDefaultValue(const FileSpec &value) { m_default_value = value; }
68 
69   const lldb::DataBufferSP &GetFileContents();
70 
71   void SetCompletionMask(uint32_t mask) { m_completion_mask = mask; }
72 
73 protected:
74   FileSpec m_current_value;
75   FileSpec m_default_value;
76   lldb::DataBufferSP m_data_sp;
77   llvm::sys::TimePoint<> m_data_mod_time;
78   uint32_t m_completion_mask = CommandCompletions::eDiskFileCompletion;
79   bool m_resolve;
80 };
81 
82 } // namespace lldb_private
83 
84 #endif // LLDB_INTERPRETER_OPTIONVALUEFILESPEC_H
85