aboutsummaryrefslogtreecommitdiff
path: root/build2/utility
blob: a0d040aefcd32390171fd57c851599c2d25048e7 (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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
// file      : build2/utility -*- C++ -*-
// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

#ifndef BUILD2_UTILITY
#define BUILD2_UTILITY

#include <tuple>      // make_tuple()
#include <memory>     // make_shared()
#include <string>     // to_string()
#include <utility>    // move(), forward(), declval(), make_pair()
#include <cassert>    // assert()
#include <iterator>   // make_move_iterator()
#include <functional> // ref(), cref()

#include <butl/utility> // combine_hash(), reverse_iterate(), casecmp(),
                        // lcase(), etc

#include <unordered_set>

#include <build2/types>
#include <build2/b-options>

namespace build2
{
  using std::move;
  using std::forward;
  using std::declval;

  using std::ref;
  using std::cref;

  using std::make_pair;
  using std::make_tuple;
  using std::make_shared;
  using std::make_move_iterator;
  using std::to_string;
  using std::stoul;
  using std::stoull;

  // <butl/utility>
  //
  using butl::reverse_iterate;
  using butl::compare_c_string;
  using butl::compare_pointer_target;
  //using butl::hash_pointer_target;
  using butl::combine_hash;
  using butl::casecmp;
  using butl::case_compare_string;
  using butl::case_compare_c_string;
  using butl::lcase;
  using butl::alpha;
  using butl::alnum;
  using butl::digit;

  using butl::exception_guard;
  using butl::make_exception_guard;

  // Basic string utilities.
  //

  // Trim leading/trailing whitespacec, including '\r'.
  //
  string&
  trim (string&);

  // Find the beginning and end poistions of the next word. Return the size
  // of the word or 0 and set b = e = n if there are no more words. For
  // example:
  //
  // for (size_t b (0), e (0); next_word (s, b, e); )
  // {
  //   string w (s, b, e - b);
  // }
  //
  // Or:
  //
  // for (size_t b (0), e (0), n; n = next_word (s, b, e, ' ', ','); )
  // {
  //   string w (s, b, n);
  // }
  //
  // The second version examines up to the n'th character in the string.
  //
  size_t
  next_word (const string&, size_t& b, size_t& e,
             char d1 = ' ', char d2 = '\0');

  size_t
  next_word (const string&, size_t n, size_t& b, size_t& e,
             char d1 = ' ', char d2 = '\0');

  // Command line options.
  //
  extern options ops;

  // Build system driver process path (argv0.initial is argv[0]).
  //
  extern process_path argv0;

  // Work/home directories (must be initialized in main()) and relative path
  // calculation.
  //
  extern dir_path work;
  extern dir_path home;

  // By default this points to work. Setting this to something else should
  // only be done in tightly controlled, non-concurrent situations (e.g.,
  // state dump). If it is empty, then relative() below returns the original
  // path.
  //
  extern const dir_path* relative_base;

  // If possible and beneficial, translate an absolute, normalized path into
  // relative to the relative_base directory, which is normally work. Note
  // that if the passed path is the same as relative_base, then this function
  // returns empty path.
  //
  template <typename K>
  basic_path<char, K>
  relative (const basic_path<char, K>&);

  // In addition to calling relative(), this function also uses shorter
  // notations such as '~/'. For directories the result includes the trailing
  // slash. If the path is the same as base, returns "./" if current is true
  // and empty string otherwise.
  //
  string
  diag_relative (const path&, bool current = true);

  // Basic process utilities.
  //

  // Start a process with the specified arguments printing the command at
  // verbosity level 3 and higher. Redirect STDOUT to a pipe. If error is
  // false, then redirecting STDERR to STDOUT (this can be used to suppress
  // diagnostics from the child process). Issue diagnostics and throw failed
  // in case of an error.
  //
  process_path
  run_search (const char*& args0);

  process_path
  run_search (const path&, bool init, const dir_path& fallback = dir_path ());

  process
  run_start (const process_path&, const char* args[], bool error);

  inline process
  run_start (const char* args[], bool error)
  {
    return run_start (run_search (args[0]), args, error);
  }

  bool
  run_finish (const char* args[], bool error, process&, const string&);

  // Start the process as above and then call the specified function on each
  // trimmed line of the output until it returns a non-empty object T (tested
  // with T::empty()) which is then returned to the caller.
  //
  // The predicate can move the value out of the passed string but, if error
  // is false, only in case of a "content match" (so that any diagnostics
  // lines are left intact).
  //
  // If ignore_exit is true, then the program's exist status is ignored (if it
  // is false and the program exits with the non-zero status, then an empty T
  // instance is returned).
  //
  // If checksum is not NULL, then feed it the content of each line.
  //
  template <typename T>
  T
  run (const process_path&,
       const char* args[],
       T (*) (string&),
       bool error = true,
       bool ignore_exit = false,
       sha256* checksum = nullptr);

  template <typename T>
  inline T
  run (const char* args[],
       T (*f) (string&),
       bool error = true,
       bool ignore_exit = false,
       sha256* checksum = nullptr)
  {
    return run<T> (run_search (args[0]), args, f, error, ignore_exit, checksum);
  }

  // run <prog>
  //
  template <typename T>
  inline T
  run (const path& prog,
       T (*f) (string&),
       bool error = true,
       bool ignore_exit = false,
       sha256* checksum = nullptr)
  {
    const char* args[] = {prog.string ().c_str (), nullptr};
    return run<T> (args, f, error, ignore_exit, checksum);
  }

  template <typename T>
  inline T
  run (const process_path& pp,
       T (*f) (string&),
       bool error = true,
       bool ignore_exit = false,
       sha256* checksum = nullptr)
  {
    const char* args[] = {pp.recall_string (), nullptr};
    return run<T> (pp, args, f, error, ignore_exit, checksum);
  }

  // run <prog> <arg>
  //
  template <typename T>
  inline T
  run (const path& prog,
       const char* arg,
       T (*f) (string&),
       bool error = true,
       bool ignore_exit = false,
       sha256* checksum = nullptr)
  {
    const char* args[] = {prog.string ().c_str (), arg, nullptr};
    return run<T> (args, f, error, ignore_exit, checksum);
  }

  template <typename T>
  inline T
  run (const process_path& pp,
       const char* arg,
       T (*f) (string&),
       bool error = true,
       bool ignore_exit = false,
       sha256* checksum = nullptr)
  {
    const char* args[] = {pp.recall_string (), arg, nullptr};
    return run<T> (pp, args, f, error, ignore_exit, checksum);
  }

  // Empty string and path.
  //
  extern const std::string empty_string;
  extern const path empty_path;
  extern const dir_path empty_dir_path;

  // Append all the values from a variable to the C-string list. T is either
  // target or scope. The variable is expected to be of type strings.
  //
  struct variable;

  template <typename T>
  void
  append_options (cstrings&, T&, const variable&);

  template <typename T>
  void
  append_options (cstrings&, T&, const char*);

  template <typename T>
  void
  append_options (strings&, T&, const variable&);

  template <typename T>
  void
  append_options (strings&, T&, const char*);

  template <typename T>
  void
  hash_options (sha256&, T&, const variable&);

  template <typename T>
  void
  hash_options (sha256&, T&, const char*);

  // As above but from the strings value directly.
  //
  class value;
  struct lookup;

  void
  append_options (cstrings&, const lookup&);

  void
  append_options (strings&, const lookup&);

  void
  hash_options (sha256&, const lookup&);

  void
  append_options (cstrings&, const strings&);

  void
  append_options (strings&, const strings&);

  void
  hash_options (sha256&, const strings&);

  // Check if a specified option is present in the variable or value. T is
  // either target or scope.
  //
  template <typename T>
  bool
  find_option (const char* option,
               T&,
               const variable&,
               bool ignore_case = false);

  template <typename T>
  bool
  find_option (const char* option,
               T&,
               const char* variable,
               bool ignore_case = false);

  bool
  find_option (const char* option, const lookup&, bool ignore_case = false);

  bool
  find_option (const char* option, const strings&, bool ignore_case = false);

  bool
  find_option (const char* option, const cstrings&, bool ignore_case = false);

  // As above but look for several options.
  //
  template <typename T>
  bool
  find_options (initializer_list<const char*>,
                T&,
                const variable&,
                bool = false);

  template <typename T>
  bool
  find_options (initializer_list<const char*>, T&, const char*, bool = false);

  bool
  find_options (initializer_list<const char*>, const lookup&, bool = false);

  bool
  find_options (initializer_list<const char*>, const strings&, bool = false);

  bool
  find_options (initializer_list<const char*>, const cstrings&, bool = false);

  // As above but look for an option that has the specified prefix.
  //
  template <typename T>
  bool
  find_option_prefix (const char* prefix, T&, const variable&, bool = false);

  template <typename T>
  bool
  find_option_prefix (const char* prefix, T&, const char*, bool = false);

  bool
  find_option_prefix (const char* prefix, const lookup&, bool = false);

  bool
  find_option_prefix (const char* prefix, const strings&, bool = false);

  bool
  find_option_prefix (const char* prefix, const cstrings&, bool = false);

  // As above but look for several option prefixes.
  //
  template <typename T>
  bool
  find_option_prefixes (initializer_list<const char*>,
                        T&,
                        const variable&,
                        bool = false);

  template <typename T>
  bool
  find_option_prefixes (initializer_list<const char*>,
                        T&,
                        const char*,
                        bool = false);

  bool
  find_option_prefixes (initializer_list<const char*>,
                        const lookup&, bool = false);

  bool
  find_option_prefixes (initializer_list<const char*>,
                        const strings&,
                        bool = false);

  bool
  find_option_prefixes (initializer_list<const char*>,
                        const cstrings&,
                        bool = false);

  // Apply the specified substitution (stem) to a '*'-pattern. If pattern
  // is NULL, then return the stem itself. Assume the pattern is valid,
  // i.e., contains a single '*' character.
  //
  string
  apply_pattern (const char* stem, const string* pattern);

  // Parse version string in the X.Y.Z[-{a|b}N] to a version integer in the
  // AABBCCDD form, where:
  //
  // AA - major version number
  // BB - minor version number
  // CC - bugfix version number
  // DD - alpha / beta (DD + 50) version number
  //
  // When DD is not 00, 1 is subtracted from AABBCC. For example:
  //
  // Version     AABBCCDD
  // 2.0.0       02000000
  // 2.1.0       02010000
  // 2.1.1       02010100
  // 2.2.0-a1    02019901
  // 3.0.0-b2    02999952
  //
  // For a version in the 1.2.3- form, it returns (AABBCC-1)01, which is the
  // lowest possible version in the 1.2.3 release set. For example:
  //
  // Version     AABBCCDD
  // 2.2.0-      02019901
  // 1.2.3-      01020201
  //
  // In fact versions 1.2.3- and 1.2.3-a1 are equivalent.
  //
  // Throw invalid_argument if the passed string is not a valid version.
  //
  unsigned int
  to_version (const string&);

  // Pools (@@ perhaps move into a separate header).
  //
  struct string_pool: std::unordered_set<std::string>
  {
    const std::string&
    find (const char* s) {return *emplace (s).first;}

    const std::string&
    find (const std::string& s) {return *emplace (s).first;}
  };

  // Initialize build2 global state (verbosity, home/work directories, etc).
  // Should be called early in main() once.
  //
  void
  init (const char* argv0, uint16_t verbosity);
}

#include <build2/utility.ixx>
#include <build2/utility.txx>

#endif // BUILD2_UTILITY