2014-01-10 17:50:34 +01:00
|
|
|
/*
|
2016-12-01 17:37:08 +01:00
|
|
|
* \brief Test for 'Reconstructible'
|
2014-01-10 17:50:34 +01:00
|
|
|
* \author Norman Feske
|
|
|
|
* \date 2013-01-10
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2017-02-20 13:23:52 +01:00
|
|
|
* Copyright (C) 2014-2017 Genode Labs GmbH
|
2014-01-10 17:50:34 +01:00
|
|
|
*
|
|
|
|
* This file is part of the Genode OS framework, which is distributed
|
2017-02-20 13:23:52 +01:00
|
|
|
* under the terms of the GNU Affero General Public License version 3.
|
2014-01-10 17:50:34 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
/* Genode includes */
|
2016-12-01 17:37:08 +01:00
|
|
|
#include <util/reconstructible.h>
|
2017-01-17 12:58:00 +01:00
|
|
|
#include <base/component.h>
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
using namespace Genode;
|
2014-01-10 17:50:34 +01:00
|
|
|
|
|
|
|
struct Object
|
|
|
|
{
|
|
|
|
unsigned const id;
|
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
Object(unsigned id) : id(id) { log("construct Object ", id); }
|
|
|
|
~Object() { log("destruct Object ", id); }
|
2014-01-10 17:50:34 +01:00
|
|
|
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 19:07:09 +02:00
|
|
|
void method() { log("method called on Object ", id); }
|
|
|
|
void const_method() const { log("const method called on Object ", id); }
|
2014-01-10 17:50:34 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
struct Member_with_reference
|
|
|
|
{
|
2017-01-17 12:58:00 +01:00
|
|
|
Object &reference;
|
|
|
|
int const c = 13;
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
Member_with_reference(Object &reference) : reference(reference) {
|
|
|
|
log("construct Member_with_reference"); }
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
~Member_with_reference() { log("destruct Member_with_reference"); }
|
2014-01-10 17:50:34 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
struct Compound
|
|
|
|
{
|
2017-01-17 12:58:00 +01:00
|
|
|
Reconstructible<Member_with_reference> member;
|
Follow practices suggested by "Effective C++"
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:
* A class with virtual functions can no longer publicly inherit base
classed without a vtable. The inherited object may either be moved
to a member variable, or inherited privately. The latter would be
used for classes that inherit 'List::Element' or 'Avl_node'. In order
to enable the 'List' and 'Avl_tree' to access the meta data, the
'List' must become a friend.
* Instead of adding a virtual destructor to abstract base classes,
we inherit the new 'Interface' class, which contains a virtual
destructor. This way, single-line abstract base classes can stay
as compact as they are now. The 'Interface' utility resides in
base/include/util/interface.h.
* With the new warnings enabled, all member variables must be explicitly
initialized. Basic types may be initialized with '='. All other types
are initialized with braces '{ ... }' or as class initializers. If
basic types and non-basic types appear in a row, it is nice to only
use the brace syntax (also for basic types) and align the braces.
* If a class contains pointers as members, it must now also provide a
copy constructor and assignment operator. In the most cases, one
would make them private, effectively disallowing the objects to be
copied. Unfortunately, this warning cannot be fixed be inheriting
our existing 'Noncopyable' class (the compiler fails to detect that
the inheriting class cannot be copied and still gives the error).
For now, we have to manually add declarations for both the copy
constructor and assignment operator as private class members. Those
declarations should be prepended with a comment like this:
/*
* Noncopyable
*/
Thread(Thread const &);
Thread &operator = (Thread const &);
In the future, we should revisit these places and try to replace
the pointers with references. In the presence of at least one
reference member, the compiler would no longer implicitly generate
a copy constructor. So we could remove the manual declaration.
Issue #465
2017-12-21 15:42:15 +01:00
|
|
|
Constructible<Member_with_reference> lazy_member { };
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
Compound(Object &object) : member(object) {
|
|
|
|
log("construct Compound"); }
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
~Compound() { log("destruct Compound"); }
|
2014-01-10 17:50:34 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2014-02-07 14:49:21 +01:00
|
|
|
struct Bool
|
|
|
|
{
|
|
|
|
bool b;
|
|
|
|
|
|
|
|
Bool(Bool const &) = delete;
|
|
|
|
|
|
|
|
Bool(bool const &b) : b(b) { }
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
struct Throwing
|
|
|
|
{
|
|
|
|
Throwing(Bool const &throws)
|
|
|
|
{
|
|
|
|
if (throws.b) {
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 19:07:09 +02:00
|
|
|
log("construct Throwing -> throw exception");
|
2014-02-07 14:49:21 +01:00
|
|
|
throw -1;
|
|
|
|
} else {
|
2017-01-17 12:58:00 +01:00
|
|
|
log("construct Throwing -> don't throw"); }
|
2014-02-07 14:49:21 +01:00
|
|
|
}
|
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
virtual ~Throwing() { log("destruct Throwing"); }
|
2014-02-07 14:49:21 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
struct Main
|
2014-01-10 17:50:34 +01:00
|
|
|
{
|
2017-01-17 12:58:00 +01:00
|
|
|
void call_const_method(Compound const &compound) {
|
|
|
|
compound.member->reference.const_method(); }
|
2014-01-10 17:50:34 +01:00
|
|
|
|
Follow practices suggested by "Effective C++"
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:
* A class with virtual functions can no longer publicly inherit base
classed without a vtable. The inherited object may either be moved
to a member variable, or inherited privately. The latter would be
used for classes that inherit 'List::Element' or 'Avl_node'. In order
to enable the 'List' and 'Avl_tree' to access the meta data, the
'List' must become a friend.
* Instead of adding a virtual destructor to abstract base classes,
we inherit the new 'Interface' class, which contains a virtual
destructor. This way, single-line abstract base classes can stay
as compact as they are now. The 'Interface' utility resides in
base/include/util/interface.h.
* With the new warnings enabled, all member variables must be explicitly
initialized. Basic types may be initialized with '='. All other types
are initialized with braces '{ ... }' or as class initializers. If
basic types and non-basic types appear in a row, it is nice to only
use the brace syntax (also for basic types) and align the braces.
* If a class contains pointers as members, it must now also provide a
copy constructor and assignment operator. In the most cases, one
would make them private, effectively disallowing the objects to be
copied. Unfortunately, this warning cannot be fixed be inheriting
our existing 'Noncopyable' class (the compiler fails to detect that
the inheriting class cannot be copied and still gives the error).
For now, we have to manually add declarations for both the copy
constructor and assignment operator as private class members. Those
declarations should be prepended with a comment like this:
/*
* Noncopyable
*/
Thread(Thread const &);
Thread &operator = (Thread const &);
In the future, we should revisit these places and try to replace
the pointers with references. In the presence of at least one
reference member, the compiler would no longer implicitly generate
a copy constructor. So we could remove the manual declaration.
Issue #465
2017-12-21 15:42:15 +01:00
|
|
|
Main(Env &)
|
2014-01-10 17:50:34 +01:00
|
|
|
{
|
2017-01-17 12:58:00 +01:00
|
|
|
log("--- Reconstructible utility test ---");
|
|
|
|
{
|
|
|
|
Object object_1(1);
|
|
|
|
Object object_2(2);
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
log("create Compound object");
|
|
|
|
Compound compound(object_1);
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
log("compound.member.constructed returns ",
|
|
|
|
compound.member.constructed());
|
|
|
|
log("compound.lazy_member.constructed returns ",
|
|
|
|
compound.lazy_member.constructed());
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
log("construct lazy member");
|
|
|
|
compound.lazy_member.construct(object_2);
|
|
|
|
log("compound.lazy_member.constructed returns ",
|
|
|
|
compound.lazy_member.constructed());
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
log("call method on member (with reference to Object 1)");
|
|
|
|
call_const_method(compound);
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
log("reconstruct member with Object 2 as reference");
|
|
|
|
compound.member.construct(object_2);
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
log("call method on member");
|
|
|
|
call_const_method(compound);
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
log("destruct member");
|
|
|
|
compound.member.destruct();
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
log("try to call method on member, catch exception");
|
|
|
|
try { call_const_method(compound); }
|
|
|
|
catch (typename Reconstructible<Member_with_reference>::Deref_unconstructed_object) {
|
|
|
|
log("got exception, as expected"); }
|
|
|
|
|
|
|
|
log("destruct Compound and Objects 1 and 2");
|
|
|
|
}
|
2014-01-10 17:50:34 +01:00
|
|
|
try {
|
2017-01-17 12:58:00 +01:00
|
|
|
log("construct Throwing object");
|
|
|
|
Bool const b_false(false), b_true(true);
|
|
|
|
Reconstructible<Throwing> inst(b_false);
|
|
|
|
inst.construct(b_true);
|
|
|
|
Genode::error("expected contructor to throw");
|
|
|
|
} catch (int i) {
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 19:07:09 +02:00
|
|
|
log("got exception, as expected"); }
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
log("--- Reconstructible utility test finished ---");
|
2014-01-10 17:50:34 +01:00
|
|
|
}
|
2017-01-17 12:58:00 +01:00
|
|
|
};
|
2014-01-10 17:50:34 +01:00
|
|
|
|
2017-01-17 12:58:00 +01:00
|
|
|
void Component::construct(Env &env) { static Main main(env); }
|