summaryrefslogtreecommitdiff
path: root/include/parameters.h
blob: b5731e5a04c4df0ce1b3ccf0639d548fd3171795 (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
/**
 *  Parameters.h
 *
 *  Wrapper around parameters that are passed to a

 *  @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
 *  @copyright 2013 Copernica BV
 */

/**
 *  Namespace
 */
namespace Php {

/**
 *  Forward declarations
 */
class Base;

/**
 *  Class definition
 */
class PHPCPP_EXPORT Parameters : public std::vector<Value>
{
private:
    /**
     *  The base object
     *  @var Base
     */
    Base *_object = nullptr;

protected:
    /**
     *  Protected constructor
     *
     *  The constructor is protected because extension programmers are not
     *  supposed to instantiate parameters objects themselves
     *
     *  @param  object      The 'this' object
     */
    Parameters(Base *object) : _object(object) {}

public:
    /**
     *  Do _not_ add a virtual destructor here.
     *
     *  We are extending a vector, which does not itself
     *  have a virtual destructor, so destructing through
     *  a pointer to this vector has no effect.
     *
     *  By adding a virtual destructor we create a vtable,
     *  which makes the class bigger, causing slicing and
     *  then we are actually introducing the problem that
     *  we are trying to avoid!
     */

    /**
     *  The object that is being called
     *  @return Base
     */
    Base *object() const
    {
        return _object;
    }
};

/**
 *  End of namespace
 */
}