1 //===-- StringExtractor.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 utility_StringExtractor_h_
11 #define utility_StringExtractor_h_
13 #include "llvm/ADT/ArrayRef.h"
14 #include "llvm/ADT/StringRef.h"
20 class StringExtractor {
22 enum { BigEndian = 0, LittleEndian = 1 };
23 //------------------------------------------------------------------
24 // Constructors and Destructors
25 //------------------------------------------------------------------
27 StringExtractor(llvm::StringRef packet_str);
28 StringExtractor(const char *packet_cstr);
29 StringExtractor(const StringExtractor &rhs);
30 virtual ~StringExtractor();
32 //------------------------------------------------------------------
34 //------------------------------------------------------------------
35 const StringExtractor &operator=(const StringExtractor &rhs);
37 void Reset(llvm::StringRef str) {
42 // Returns true if the file position is still valid for the data contained in
43 // this string extractor object.
44 bool IsGood() const { return m_index != UINT64_MAX; }
46 uint64_t GetFilePos() const { return m_index; }
48 void SetFilePos(uint32_t idx) { m_index = idx; }
57 std::string &GetStringRef() { return m_packet; }
59 const std::string &GetStringRef() const { return m_packet; }
61 bool Empty() { return m_packet.empty(); }
63 size_t GetBytesLeft() {
64 if (m_index < m_packet.size())
65 return m_packet.size() - m_index;
69 char GetChar(char fail_value = '\0');
71 char PeekChar(char fail_value = '\0') {
72 const char *cstr = Peek();
80 uint8_t GetHexU8(uint8_t fail_value = 0, bool set_eof_on_fail = true);
82 bool GetHexU8Ex(uint8_t &ch, bool set_eof_on_fail = true);
84 bool GetNameColonValue(llvm::StringRef &name, llvm::StringRef &value);
86 int32_t GetS32(int32_t fail_value, int base = 0);
88 uint32_t GetU32(uint32_t fail_value, int base = 0);
90 int64_t GetS64(int64_t fail_value, int base = 0);
92 uint64_t GetU64(uint64_t fail_value, int base = 0);
94 uint32_t GetHexMaxU32(bool little_endian, uint32_t fail_value);
96 uint64_t GetHexMaxU64(bool little_endian, uint64_t fail_value);
98 size_t GetHexBytes(llvm::MutableArrayRef<uint8_t> dest,
99 uint8_t fail_fill_value);
101 size_t GetHexBytesAvail(llvm::MutableArrayRef<uint8_t> dest);
103 uint64_t GetHexWithFixedSize(uint32_t byte_size, bool little_endian,
104 uint64_t fail_value);
106 size_t GetHexByteString(std::string &str);
108 size_t GetHexByteStringFixedLength(std::string &str, uint32_t nibble_length);
110 size_t GetHexByteStringTerminatedBy(std::string &str, char terminator);
112 bool ConsumeFront(const llvm::StringRef &str);
115 if (m_index < m_packet.size())
116 return m_packet.c_str() + m_index;
122 m_index = UINT64_MAX;
125 //------------------------------------------------------------------
126 // For StringExtractor only
127 //------------------------------------------------------------------
128 std::string m_packet; // The string in which to extract data.
129 uint64_t m_index; // When extracting data from a packet, this index
130 // will march along as things get extracted. If set to
131 // UINT64_MAX the end of the packet data was reached
132 // when decoding information
135 #endif // utility_StringExtractor_h_