genode/repos/os/include/os/surface.h
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

141 lines
2.8 KiB
C++

/*
* \brief Generic interface to a graphics backend
* \date 2006-08-04
* \author Norman Feske
*/
/*
* Copyright (C) 2006-2017 Genode Labs GmbH
*
* This file is part of the Genode OS framework, which is distributed
* under the terms of the GNU Affero General Public License version 3.
*/
#ifndef _INCLUDE__OS__SURFACE_H_
#define _INCLUDE__OS__SURFACE_H_
#include <util/geometry.h>
#include <util/color.h>
#include <util/interface.h>
namespace Genode {
class Surface_base;
template <typename> class Surface;
}
/*
* A surface is a rectangular space to which drawing operations can be
* applied. All coordinates are specified in pixels. The coordinate origin
* is the top-left corner of the surface.
*/
class Genode::Surface_base
{
private:
/*
* Noncopyable
*/
Surface_base(Surface_base const &);
Surface_base &operator = (Surface_base const &);
public:
typedef Genode::Point<> Point;
typedef Genode::Area<> Area;
typedef Genode::Rect<> Rect;
typedef Genode::Color Color;
enum Pixel_format { UNKNOWN, RGB565, RGB888, ALPHA8 };
struct Flusher : Interface
{
virtual void flush_pixels(Rect rect) = 0;
};
protected:
Rect _clip; /* clipping area */
Area _size; /* boundaries of surface */
Pixel_format _format;
Flusher *_flusher;
/**
* Constructor
*/
Surface_base(Area size, Pixel_format format)
: _clip(Point(0, 0), size), _size(size), _format(format), _flusher(0) { }
public:
virtual ~Surface_base() { }
/**
* Register part of surface to be flushed
*
* This method is called by graphics primitives when surface regions
* are changed.
*/
void flush_pixels(Rect rect)
{
if (_flusher)
_flusher->flush_pixels(rect);
}
/**
* Register pixel flusher
*/
void flusher(Flusher *flusher) { _flusher = flusher; }
/**
* Define/request clipping rectangle
*/
void clip(Rect clip) {
_clip = Rect::intersect(Rect(Point(0, 0), _size), clip); }
Rect clip() const { return _clip; }
bool clip_valid() const { return _clip.valid(); }
Pixel_format pixel_format() const { return _format; }
/**
* Return dimension of surface in pixels
*/
Area size() const { return _size; }
};
/**
* Surface that stores each pixel in one storage unit in a linear buffer
*
* \param PT pixel type
*/
template <typename PT>
class Genode::Surface : public Surface_base
{
private:
/*
* Noncopyable
*/
Surface(Surface const &);
Surface &operator = (Surface const &);
protected:
PT *_addr; /* base address of pixel buffer */
public:
PT *addr() { return _addr; }
/**
* Constructor
*/
Surface(PT *addr, Area size)
: Surface_base(size, PT::format()), _addr(addr) { }
};
#endif /* _INCLUDE__OS__SURFACE_H_ */