aboutsummaryrefslogtreecommitdiff
path: root/bpkg/manifest
blob: a4bf6f2e9121dddc2c6bb6216ba2025e7f1d76dc (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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
// file      : bpkg/manifest -*- C++ -*-
// copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

#ifndef BPKG_MANIFEST
#define BPKG_MANIFEST

#include <string>
#include <vector>
#include <cstdint>   // uint16
#include <algorithm> // move()

#include <butl/optional>

namespace bpkg
{
  class manifest_parser;
  class manifest_serializer;
  class manifest_name_value;

  using strings = std::vector<std::string>;

  struct version
  {
    // Create a special empty version.
    //
    version (): epoch_ (0), revision_ (0) {}

    explicit
    version (const std::string& v): version (v.c_str ()) /* Delegate */ {}

    explicit
    version (const char* v): version (v, false) /* Delegate */ {}

    // Create the version object from separate epoch, upstream, and
    // revision parts.
    //
    version (std::uint16_t epoch,
             std::string upstream,
             std::uint16_t revision)
        : version (upstream.c_str (), true)  // Delegate

    {
      // Can't initialize in member initializer list due to construction
      // delegation.
      //
      epoch_ = epoch;
      revision_ = revision;
    }

    std::uint16_t
    epoch () const noexcept {return epoch_;}

    std::uint16_t
    revision () const noexcept {return revision_;}

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

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

    std::string
    string () const
    {
      const std::string& v (
        epoch_ != 0 ? std::to_string (epoch_) + "+" + upstream_ : upstream_);

      return revision_ != 0 ? v + "-" + std::to_string (revision_) : v;
    }

    bool
    operator< (const version& v) const noexcept {return compare (v) < 0;}

    bool
    operator> (const version& v) const noexcept {return compare (v) > 0;}

    bool
    operator== (const version& v) const noexcept {return compare (v) == 0;}

    bool
    operator<= (const version& v) const noexcept {return compare (v) <= 0;}

    bool
    operator>= (const version& v) const noexcept {return compare (v) >= 0;}

    bool
    operator!= (const version& v) const noexcept {return compare (v) != 0;}

    int
    compare (const version& v, bool ignore_revision = false) const noexcept
    {
      if (epoch_ != v.epoch_)
        return epoch_ < v.epoch_ ? -1 : 1;

      if (int c = canonical_upstream_.compare (v.canonical_upstream_))
        return c;

      if (!ignore_revision && revision_ != v.revision_)
        return revision_ < v.revision_ ? -1 : 1;

      return 0;
    }

    bool
    empty () const noexcept
    {
      // No sense to test epoch and revision for 0 as properly constructed
      // version object can not have them different from 0 if upstream is
      // empty. Returns true only for objects constructed with the default
      // constructor.
      //
      return upstream_.empty ();
    }

  private:
    version (const char*, bool upstream_only);

  private:
    // Let's keep the members in the order they appear in the string
    // representation.
    //
    std::uint16_t epoch_;
    std::string upstream_;
    std::uint16_t revision_;
    std::string canonical_upstream_; // Upstream part canonical representation.
  };

  // priority
  //
  class priority
  {
  public:
    enum value_type {low, medium, high, security};

    value_type value; // Shouldn't be necessary to access directly.
    std::string comment;

    priority (value_type v = low, std::string c = "")
        : value (v), comment (std::move (c)) {}

    operator value_type () const {return value;}
  };

  // description
  // description-file
  //
  struct description: std::string
  {
    bool file;
    std::string comment;

    // Description constructor.
    //
    explicit
    description (std::string d = "")
        : std::string (std::move (d)), file (false) {}

    // Description file constructor.
    //
    description (std::string f, std::string c)
        : std::string (std::move (f)), file (true), comment (std::move (c)) {}
  };

  // license
  //
  struct licenses: strings
  {
    std::string comment;

    explicit
    licenses (std::string c = ""): comment (std::move (c)) {}
  };

  // change
  // change-file
  //
  struct change: std::string
  {
    bool file;
    std::string comment;

    // Change constructor.
    //
    explicit
    change (std::string c = ""): std::string (std::move (c)), file (false) {}

    // Change file constructor.
    //
    change (std::string f, std::string c)
        : std::string (std::move (f)), file (true), comment (std::move (c)) {}
  };

  // url
  // package-url
  //
  struct url: std::string
  {
    std::string comment;

    explicit
    url (std::string u = "", std::string c = "")
        : std::string (std::move (u)), comment (std::move (c)) {}
  };

  // email
  // package-email
  //
  struct email: std::string
  {
    std::string comment;

    explicit
    email (std::string e = "", std::string c = "")
        : std::string (std::move (e)), comment (std::move (c)) {}
  };

  // depends
  //
  enum class comparison {eq, lt, gt, le, ge};

  struct version_comparison
  {
    version value;
    comparison operation;
  };

  struct dependency
  {
    std::string package;
    butl::optional<version_comparison> version;
  };

  struct dependency_alternatives: std::vector<dependency>
  {
    bool conditional;
    std::string comment;

    explicit
    dependency_alternatives (bool d = false, std::string c = "")
        : conditional (d), comment (std::move (c)) {}
  };

  // requires
  //
  struct requirement_alternatives: strings
  {
    bool conditional;
    std::string comment;

    explicit
    requirement_alternatives (bool d = false, std::string c = "")
        : conditional (d), comment (std::move (c)) {}
  };

  class package_manifest
  {
  public:
    using version_type = bpkg::version;
    using priority_type = bpkg::priority;
    using url_type = bpkg::url;
    using email_type = bpkg::email;
    using description_type = bpkg::description;

    std::string name;
    version_type version;
    butl::optional<priority_type> priority;
    std::string summary;
    std::vector<licenses> license_alternatives;
    strings tags;
    butl::optional<description_type> description;
    std::vector<change> changes;
    url_type url;
    butl::optional<url_type> package_url;
    email_type email;
    butl::optional<email_type> package_email;
    std::vector<dependency_alternatives> dependencies;
    std::vector<requirement_alternatives> requirements;

  public:
    package_manifest (manifest_parser&);
    package_manifest (manifest_parser&, manifest_name_value start);

    void
    serialize (manifest_serializer&) const;
  };

  class repository_location
  {
    // @@ Move all the location verification/canonical name calculation
    //    here.
    //

    // ...
  };

  class repository_manifest
  {
  public:
    std::string location;

  public:
    repository_manifest (manifest_parser&);
    repository_manifest (manifest_parser&, manifest_name_value start);

    void
    serialize (manifest_serializer&) const;
  };

  class manifests
  {
  public:
    std::vector<repository_manifest> repositories;
    std::vector<package_manifest> packages;

  public:
    manifests (manifest_parser&);

    void
    serialize (manifest_serializer&) const;
  };
}

#endif // BPKG_MANIFEST