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_
18 // Other libraries and framework includes
20 #include "llvm/ADT/ArrayRef.h"
21 #include "llvm/ADT/StringRef.h"
23 class StringExtractor {
25 enum { BigEndian = 0, LittleEndian = 1 };
26 //------------------------------------------------------------------
27 // Constructors and Destructors
28 //------------------------------------------------------------------
30 StringExtractor(llvm::StringRef packet_str);
31 StringExtractor(const char *packet_cstr);
32 StringExtractor(const StringExtractor &rhs);
33 virtual ~StringExtractor();
35 //------------------------------------------------------------------
37 //------------------------------------------------------------------
38 const StringExtractor &operator=(const StringExtractor &rhs);
40 void Reset(llvm::StringRef str) {
45 // Returns true if the file position is still valid for the data
46 // contained in this string extractor object.
47 bool IsGood() const { return m_index != UINT64_MAX; }
49 uint64_t GetFilePos() const { return m_index; }
51 void SetFilePos(uint32_t idx) { m_index = idx; }
60 std::string &GetStringRef() { return m_packet; }
62 const std::string &GetStringRef() const { return m_packet; }
64 bool Empty() { return m_packet.empty(); }
66 size_t GetBytesLeft() {
67 if (m_index < m_packet.size())
68 return m_packet.size() - m_index;
72 char GetChar(char fail_value = '\0');
74 char PeekChar(char fail_value = '\0') {
75 const char *cstr = Peek();
83 uint8_t GetHexU8(uint8_t fail_value = 0, bool set_eof_on_fail = true);
85 bool GetHexU8Ex(uint8_t &ch, bool set_eof_on_fail = true);
87 bool GetNameColonValue(llvm::StringRef &name, llvm::StringRef &value);
89 int32_t GetS32(int32_t fail_value, int base = 0);
91 uint32_t GetU32(uint32_t fail_value, int base = 0);
93 int64_t GetS64(int64_t fail_value, int base = 0);
95 uint64_t GetU64(uint64_t fail_value, int base = 0);
97 uint32_t GetHexMaxU32(bool little_endian, uint32_t fail_value);
99 uint64_t GetHexMaxU64(bool little_endian, uint64_t fail_value);
101 size_t GetHexBytes(llvm::MutableArrayRef<uint8_t> dest,
102 uint8_t fail_fill_value);
104 size_t GetHexBytesAvail(llvm::MutableArrayRef<uint8_t> dest);
106 uint64_t GetHexWithFixedSize(uint32_t byte_size, bool little_endian,
107 uint64_t fail_value);
109 size_t GetHexByteString(std::string &str);
111 size_t GetHexByteStringFixedLength(std::string &str, uint32_t nibble_length);
113 size_t GetHexByteStringTerminatedBy(std::string &str, char terminator);
116 if (m_index < m_packet.size())
117 return m_packet.c_str() + m_index;
123 m_index = UINT64_MAX;
126 //------------------------------------------------------------------
127 // For StringExtractor only
128 //------------------------------------------------------------------
129 std::string m_packet; // The string in which to extract data.
130 uint64_t m_index; // When extracting data from a packet, this index
131 // will march along as things get extracted. If set
132 // to UINT64_MAX the end of the packet data was
133 // reached when decoding information
136 #endif // utility_StringExtractor_h_