aboutsummaryrefslogtreecommitdiff
path: root/bpkg/package-skeleton.cxx
blob: ebcc044250dbdce3ac51f1f6fa874f84689c84cd (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
// file      : bpkg/package-skeleton.cxx -*- C++ -*-
// license   : MIT; see accompanying LICENSE file

#include <bpkg/package-skeleton.hxx>

#include <libbutl/manifest-serializer.hxx>

#include <bpkg/package.hxx>
#include <bpkg/database.hxx>
#include <bpkg/manifest-utility.hxx>

using namespace std;
using namespace butl;

namespace bpkg
{
  package_skeleton::
  package_skeleton (database& db,
                    const available_package& ap,
                    const strings& cvs,
                    optional<dir_path> src_root)
      : db_ (db),
        available_ (ap),
        config_vars_ (cvs),
        src_root_ (move (src_root))
  {
    // Should not be created for stubs.
    //
    assert (available_.get ().bootstrap_build);

    if (src_root_)
      out_root_ = dir_path (db_.get ().config_orig) /= name ().string ();
  }

  void package_skeleton::
  load ()
  {
    if (loaded_ && !dirty_)
      return;

    const available_package& ap (available_);

    // The overall plan is as follows:
    //
    // 0. Create filesystem state if necessary (could have been created by
    //    another instance, e.g., during simulation).
    //
    // 1. If loaded but dirty, save the accumulated reflect state, and
    //    destroy the old state.
    //
    // 2. Load the state potentially with accumulated reflect state.

    // Create the skeleton filesystem state, if it doesn't exist yet.
    //
    // Note that we create the skeleton directories in the skeletons/
    // subdirectory of the configuration temporary directory to make sure they
    // never clash with other temporary subdirectories (git repositories, etc).
    //
    if (!src_root_)
    {
      auto i (temp_dir.find (db_.get ().config_orig));
      assert (i != temp_dir.end ());

      dir_path d (i->second);
      d /= "skeletons";
      d /= name ().string () + '-' + ap.version.string ();

      src_root_ = d;
      out_root_ = move (d);
    }

    if (!exists (*src_root_))
    {
      // Create the buildfiles.
      //
      // Note that it's probably doesn't matter which naming scheme to use for
      // the buildfiles, unless in the future we allow specifying additional
      // files.
      //
      {
        path bf (*src_root_ / std_bootstrap_file);

        mk_p (bf.directory ());

        // Save the {bootstrap,root}.build files.
        //
        auto save = [] (const string& s, const path& f)
        {
          try
          {
            ofdstream os (f);
            os << s;
            os.close ();
          }
          catch (const io_error& e)
          {
            fail << "unable to write to " << f << ": " << e;
          }
        };

        save (*ap.bootstrap_build, bf);

        if (ap.root_build)
          save (*ap.root_build, *src_root_ / std_root_file);
      }

      // Create the manifest file containing the bare minimum of values
      // which can potentially be required to load the build system state.
      //
      {
        package_manifest m;
        m.name = name ();
        m.version = ap.version;

        // Note that there is no guarantee that the potential build2
        // constraint has already been verified. Thus, we also serialize the
        // depends value, delegating the constraint verification to the
        // version module. Also note that normally the toolchain build-time
        // dependencies are specified first and, if that's the case, their
        // constraints are already verified at this point and so build2 will
        // not fail due to the constraint violation.
        //
        // Also note that the resulting file is not quite a valid package
        // manifest, since it doesn't contain all the required values
        // (summary, etc). It, however, is good enough for build2 which
        // doesn't perform exhaustive manifest validation.
        //
        m.dependencies.reserve (ap.dependencies.size ());
        for (const dependency_alternatives_ex& das: ap.dependencies)
        {
          // Skip the the special (inverse) test dependencies.
          //
          if (!das.type)
            m.dependencies.push_back (das);
        }

        path mf (*src_root_ / manifest_file);

        try
        {
          ofdstream os (mf);
          manifest_serializer s (os, mf.string ());
          m.serialize (s);
          os.close ();
        }
        catch (const manifest_serialization&)
        {
          // We shouldn't be creating a non-serializable manifest, since it's
          // crafted from the parsed values.
          //
          assert (false);
        }
        catch (const io_error& e)
        {
          fail << "unable to write to " << mf << ": " << e;
        }
      }
    }

    loaded_ = true;
    dirty_ = false;
  }
}