genode/repos/base/include
Norman Feske eba9c15746 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
2018-01-17 12:14:35 +01:00
..
base Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
cap_session Adjust file headers to refer to the AGPLv3 2017-02-28 12:59:29 +01:00
cpu Adjust file headers to refer to the AGPLv3 2017-02-28 12:59:29 +01:00
cpu_session Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
cpu_thread Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
dataspace Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
deprecated Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
drivers Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
io_mem_session Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
io_port_session API documentation refinements 2017-05-31 13:16:21 +02:00
irq_session Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
log_session Limit max string length in log session for okl4 2017-10-19 13:31:16 +02:00
parent Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
pd_session Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
ram_session Integrate core's RAM service into the PD service 2017-05-31 13:16:14 +02:00
region_map Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
rm_session API documentation refinements 2017-05-31 13:16:21 +02:00
rom_session Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
root Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
session Streamline exception types 2017-05-31 13:16:07 +02:00
spec Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
thread Adjust file headers to refer to the AGPLv3 2017-02-28 12:59:29 +01:00
trace_session Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
util Follow practices suggested by "Effective C++" 2018-01-17 12:14:35 +01:00
README Move repositories to 'repos/' subdirectory 2014-05-14 16:08:00 +02:00

This directory contains include files of interfaces that are exported
by components to be used by other components. Each subdirectory corresponds
to the component exporting the interface.