summaryrefslogtreecommitdiff
path: root/lib/sbuild/chroot/facet/source.h
blob: ddacf966d675e60a37f609d36f3c73a2516a5ba4 (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
/* Copyright © 2005-2013  Roger Leigh <rleigh@debian.org>
 *
 * schroot is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * schroot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 *********************************************************************/

#ifndef SBUILD_CHROOT_FACET_SOURCE_H
#define SBUILD_CHROOT_FACET_SOURCE_H

#include <sbuild/chroot/facet/facet.h>

namespace sbuild
{
  namespace chroot
  {
    namespace facet
    {

      /**
       * Chroot support for clonable sources.
       *
       * A chroot may offer a "source" facet in addition to its normal
       * "session" copy, to allow for maintenence of the source data.
       * This facet is installed into source chroots to identify them
       * as such, and so modify their session behaviour.
       */
      class source : public facet
      {
      public:
        /// A shared_ptr to a chroot facet object.
        typedef std::shared_ptr<source> ptr;

        /// A shared_ptr to a const chroot facet object.
        typedef std::shared_ptr<const source> const_ptr;

      private:
        /// The constructor.
        source ();

      public:
        /// The destructor.
        virtual ~source ();

        /**
         * Create a chroot facet.
         *
         * @returns a shared_ptr to the new chroot facet.
         */
        static ptr
        create ();

        virtual facet::ptr
        clone () const;

        virtual std::string const&
        get_name () const;
      };

    }
  }
}

#endif /* SBUILD_CHROOT_FACET_SOURCE_H */

/*
 * Local Variables:
 * mode:C++
 * End:
 */