aboutsummaryrefslogtreecommitdiff
path: root/libbpkg/package-name.hxx
blob: ecc9f3b9adadb9cf716ff448cc345c016f7608e8 (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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
// file      : libbpkg/package-name.hxx -*- C++ -*-
// copyright : Copyright (c) 2014-2018 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

#ifndef LIBBPKG_PACKAGE_NAME_HXX
#define LIBBPKG_PACKAGE_NAME_HXX

#include <string>
#include <utility> // move()
#include <ostream>

#include <libbutl/utility.mxx> // casecmp()

#include <libbpkg/export.hxx>
#include <libbpkg/version.hxx>

namespace bpkg
{
  class LIBBPKG_EXPORT package_name
  {
  public:
    // Create package name from string verifying that it complied with the
    // specification and throwing std::invalid_argument if that's not the
    // case. Note that in this case the passed value is guaranteed to be
    // unchanged.
    //
    explicit
    package_name (const std::string& s): package_name (std::string (s)) {}

    explicit
    package_name (std::string&&);

    // Create a special empty package name.
    //
    package_name () = default;

    // Create an arbitrary string that can be used in contexts that expect
    // a package name. For example, a package name pattern for use in ODB query
    // expressions.
    //
    enum raw_string_type {raw_string};
    package_name (std::string s, raw_string_type): value_ (std::move (s)) {}

    bool
    empty () const noexcept {return value_.empty ();}

    const std::string&
    string () const& noexcept {return value_;}

    // Moves the underlying package name string out of the package name object.
    // The object becomes empty. Usage: std::move (name).string ().
    //
    std::string
    string () && {std::string r; r.swap (this->value_); return r;}

    // Package name base and extension (without the dot). If there is no
    // extension, then the base name is the same as the full name and the
    // returned extension is empty.
    //
    std::string
    base () const;

    std::string
    extension () const;

    // Package name sanitized to a canonical variable name. Specifically,
    // '.', '-', and '+' are replaced with '_'.
    //
    std::string
    variable () const;

    // Compare ignoring case. Note that a string is not checked to be a valid
    // package name.
    //
    int compare (const package_name& n) const {return compare (n.value_);}
    int compare (const std::string& n) const {return compare (n.c_str ());}
    int compare (const char* n) const {return butl::casecmp (value_, n);}

  private:
    std::string value_;
  };

  inline bool
  operator< (const package_name& x, const package_name& y)
  {
    return x.compare (y) < 0;
  }

  inline bool
  operator> (const package_name& x, const package_name& y)
  {
    return x.compare (y) > 0;
  }

  inline bool
  operator== (const package_name& x, const package_name& y)
  {
    return x.compare (y) == 0;
  }

  inline bool
  operator<= (const package_name& x, const package_name& y)
  {
    return x.compare (y) <= 0;
  }

  inline bool
  operator>= (const package_name& x, const package_name& y)
  {
    return x.compare (y) >= 0;
  }

  inline bool
  operator!= (const package_name& x, const package_name& y)
  {
    return x.compare (y) != 0;
  }

  template <typename T>
  inline auto
  operator< (const package_name& x, const T& y)
  {
    return x.compare (y) < 0;
  }

  template <typename T>
  inline auto
  operator> (const package_name& x, const T& y)
  {
    return x.compare (y) > 0;
  }

  template <typename T>
  inline auto
  operator== (const package_name& x, const T& y)
  {
    return x.compare (y) == 0;
  }

  template <typename T>
  inline auto
  operator<= (const package_name& x, const T& y)
  {
    return x.compare (y) <= 0;
  }

  template <typename T>
  inline auto
  operator>= (const package_name& x, const T& y)
  {
    return x.compare (y) >= 0;
  }

  template <typename T>
  inline auto
  operator!= (const package_name& x, const T& y)
  {
    return x.compare (y) != 0;
  }

  template <typename T>
  inline auto
  operator< (const T& x, const package_name& y)
  {
    return y > x;
  }

  template <typename T>
  inline auto
  operator> (const T& x, const package_name& y)
  {
    return y < x;
  }

  template <typename T>
  inline auto
  operator== (const T& x, const package_name& y)
  {
    return y == x;
  }

  template <typename T>
  inline auto
  operator<= (const T& x, const package_name& y)
  {
    return y >= x;
  }

  template <typename T>
  inline auto
  operator>= (const T& x, const package_name& y)
  {
    return y <= x;
  }

  template <typename T>
  inline auto
  operator!= (const T& x, const package_name& y)
  {
    return y != x;
  }

  inline std::ostream&
  operator<< (std::ostream& os, const package_name& v)
  {
    return os << v.string ();
  }
}

#endif // LIBBPKG_PACKAGE_NAME_HXX