summaryrefslogtreecommitdiffhomepage
path: root/dev/CompilerKit/StringKit.h
blob: eb7ccc3f1b7f3e4ed97f870b65074f7921f73c6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/*
 *	========================================================
 *
 *	CompilerKit
 * 	Copyright (C) 2024-2025 Amlal El Mahrouss, Licensed under the Apache 2.0 license.
 *
 * 	========================================================
 */

#ifndef __NECTI_STRINGKIT__
#define __NECTI_STRINGKIT__

#include <CompilerKit/Defines.h>
#include <CompilerKit/ErrorOr.h>

/// =========================================================== ///
/// @file StringKit.h
/// @author Amlal El Mahrouss
/// @brief StringKit for CompilerKit.
/// =========================================================== ///

namespace CompilerKit {
class StringBuilder;
class BasicString;

/**
 * @brief BasicString class, contains a C string and manages it.
 * @note No need to manage it it's getting deleted by default.
 */

class BasicString final {
 public:
  explicit BasicString() = delete;

  explicit BasicString(SizeType Sz) noexcept : m_Sz(Sz) {
    m_Data = new Char[Sz];
    assert(m_Data);
  }

  ~BasicString() noexcept {
    if (m_Data) {
      memset(m_Data, 0, m_Sz);
      delete[] m_Data;

      m_Data = nullptr;
    }
  }

  NECTI_COPY_DEFAULT(BasicString);

  Char*       Data();
  const Char* CData() const;
  SizeType    Length() const;

  bool operator==(const Char* rhs) const;
  bool operator!=(const Char* rhs) const;

  bool operator==(const BasicString& rhs) const;
  bool operator!=(const BasicString& rhs) const;

  BasicString& operator+=(const Char* rhs);
  BasicString& operator+=(const Char rhs);
  BasicString& operator+=(const BasicString& rhs);

  explicit operator bool() { return m_Data && m_Data[0] != 0; }

  bool operator!() { return !m_Data || m_Data[0] == 0; }

 private:
  Char*    m_Data{nullptr};
  SizeType m_Sz{0};
  SizeType m_Cur{0};

  friend class StringBuilder;
};

/**
 * @brief StringBuilder class
 * @note These results shall call be delete[] after they're used.
 */
struct StringBuilder final {
  static BasicString Construct(const Char* data);
  static BasicString FromInt(const char* fmt, int n);
  static BasicString FromBool(const char* fmt, bool n);
  static BasicString Format(const char* fmt, const char* from);
  static Bool        Equals(const char* lhs, const char* rhs);
};

using BasicStringOr  = ErrorOr<BasicString>;
using BasicStringPtr = BasicString*;
using BasicStringRef = Ref<BasicString>;
}  // namespace CompilerKit

#endif /* ifndef __NECTI_STRINGKIT__ */