1 //===-- StdStringExtractor.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 utility_StdStringExtractor_h_
10 #define utility_StdStringExtractor_h_
11 
12 #include <stdint.h>
13 #include <string>
14 
15 
16 // Based on StringExtractor, with the added limitation that this file should not
17 // take a dependency on LLVM, as it is used from debugserver.
18 class StdStringExtractor {
19 public:
20   enum { BigEndian = 0, LittleEndian = 1 };
21   // Constructors and Destructors
22   StdStringExtractor();
23   StdStringExtractor(const char *packet_cstr);
24   virtual ~StdStringExtractor();
25 
26   // Returns true if the file position is still valid for the data
27   // contained in this string extractor object.
28   bool IsGood() const { return m_index != UINT64_MAX; }
29 
30   uint64_t GetFilePos() const { return m_index; }
31 
32   void SetFilePos(uint32_t idx) { m_index = idx; }
33 
34   void Clear() {
35     m_packet.clear();
36     m_index = 0;
37   }
38 
39   void SkipSpaces();
40 
41   std::string &GetStringRef() { return m_packet; }
42 
43   const std::string &GetStringRef() const { return m_packet; }
44 
45   bool Empty() { return m_packet.empty(); }
46 
47   size_t GetBytesLeft() {
48     if (m_index < m_packet.size())
49       return m_packet.size() - m_index;
50     return 0;
51   }
52 
53   char GetChar(char fail_value = '\0');
54 
55   char PeekChar(char fail_value = '\0') {
56     const char *cstr = Peek();
57     if (cstr)
58       return cstr[0];
59     return fail_value;
60   }
61 
62   int DecodeHexU8();
63 
64   uint8_t GetHexU8(uint8_t fail_value = 0, bool set_eof_on_fail = true);
65 
66   bool GetHexU8Ex(uint8_t &ch, bool set_eof_on_fail = true);
67 
68   bool GetNameColonValue(std::string &name, std::string &value);
69 
70   int32_t GetS32(int32_t fail_value, int base = 0);
71 
72   uint32_t GetU32(uint32_t fail_value, int base = 0);
73 
74   int64_t GetS64(int64_t fail_value, int base = 0);
75 
76   uint64_t GetU64(uint64_t fail_value, int base = 0);
77 
78   uint32_t GetHexMaxU32(bool little_endian, uint32_t fail_value);
79 
80   uint64_t GetHexMaxU64(bool little_endian, uint64_t fail_value);
81 
82   size_t GetHexBytes(void *dst, size_t dst_len, uint8_t fail_fill_value);
83 
84   size_t GetHexBytesAvail(void *dst, size_t dst_len);
85 
86   uint64_t GetHexWithFixedSize(uint32_t byte_size, bool little_endian,
87                                uint64_t fail_value);
88 
89   size_t GetHexByteString(std::string &str);
90 
91   size_t GetHexByteStringFixedLength(std::string &str, uint32_t nibble_length);
92 
93   size_t GetHexByteStringTerminatedBy(std::string &str, char terminator);
94 
95   const char *Peek() {
96     if (m_index < m_packet.size())
97       return m_packet.c_str() + m_index;
98     return nullptr;
99   }
100 
101 protected:
102   // For StdStringExtractor only
103   std::string m_packet; // The string in which to extract data.
104   uint64_t m_index;     // When extracting data from a packet, this index
105                         // will march along as things get extracted. If set
106                         // to UINT64_MAX the end of the packet data was
107                         // reached when decoding information
108 };
109 
110 #endif // utility_StringExtractor_h_
111