haiku-beta6/src/servers/app/drawing/DisplayDriver.cpp

//------------------------------------------------------------------------------
//	Copyright (c) 2001-2002, Haiku, Inc.
//
//	Permission is hereby granted, free of charge, to any person obtaining a
//	copy of this software and associated documentation files (the "Software"),
//	to deal in the Software without restriction, including without limitation
//	the rights to use, copy, modify, merge, publish, distribute, sublicense,
//	and/or sell copies of the Software, and to permit persons to whom the
//	Software is furnished to do so, subject to the following conditions:
//
//	The above copyright notice and this permission notice shall be included in
//	all copies or substantial portions of the Software.
//
//	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//	DEALINGS IN THE SOFTWARE.
//
//	File Name:		DisplayDriver.cpp
//	Author:			DarkWyrm <[email protected]>
//					Gabe Yoder <[email protected]>
//	Description:	Mostly abstract class which handles all graphics output
//					for the server
//  
//------------------------------------------------------------------------------
#include <stdio.h>
#include <string.h>

#include "CursorData.h"
#include "ServerCursor.h"

#include "DisplayDriver.h"

/*!
	\brief Sets up internal variables needed by all DisplayDriver subclasses
*/
DisplayDriver::DisplayDriver()
	: fCursorHandler(this),
	  fDPMSState(B_DPMS_ON),
	  fDPMSCaps(B_DPMS_ON)
{
	fDisplayMode.virtual_width = 640;
	fDisplayMode.virtual_height = 480;
	fDisplayMode.space = B_RGBA32;
}


/*!
	\brief Does nothing
*/
DisplayDriver::~DisplayDriver()
{
}

/*!
	\brief Initializes the driver object.
	\return true if successful, false if not
	
	Initializes the CursorHandler with the default system cursor.

	Derived versions should set up the driver for display,
	including the initial clearing of the screen. If things
	do not go as they should, false should be returned.
*/
bool
DisplayDriver::Initialize()
{
	fCursorHandler.SetCursor(new ServerCursor(default_cursor_data));
	return true;
}

/*!
	\brief Shuts down the driver's video subsystem
	
	Any work done by Initialize() should be undone here. Note that Shutdown() is
	called even if Initialize() was unsuccessful.
*/
void
DisplayDriver::Shutdown()
{
}

/*!
	\brief Hides the cursor.
	
	Hide calls are not nestable, unlike that of the BApplication class. Subclasses should
	call _SetCursorHidden(true) somewhere within this function to ensure that data is
	maintained accurately. Subclasses must include a call to DisplayDriver::HideCursor
	for proper state tracking.
*/
void
DisplayDriver::HideCursor()
{
	Lock();
	fCursorHandler.Hide();	
	Unlock();
}

/*!
	\brief Returns whether the cursor is visible or not.
	\return true if hidden or obscured, false if not.

*/
bool
DisplayDriver::IsCursorHidden()
{
	Lock();
	bool value = fCursorHandler.IsHidden();
	Unlock();

	return value;
}

/*!
	\brief Moves the cursor to the given point.

	The coordinates passed to MoveCursorTo are guaranteed to be within the frame buffer's
	range, but the cursor data itself will need to be clipped. A check to see if the 
	cursor is obscured should be made and if so, a call to _SetCursorObscured(false) 
	should be made the cursor in addition to displaying at the passed coordinates.
*/
void
DisplayDriver::MoveCursorTo(const float &x, const float &y)
{
	Lock();
	fCursorHandler.MoveTo(BPoint(x, y));
	Unlock();
}

/*!
	\brief Shows the cursor.
	
	Show calls are not nestable, unlike that of the BApplication class. Subclasses should
	call _SetCursorHidden(false) somewhere within this function to ensure that data is
	maintained accurately. Subclasses must call DisplayDriver::ShowCursor at some point
	to ensure proper state tracking.
*/
void
DisplayDriver::ShowCursor()
{
	Lock();
	fCursorHandler.Show();
	Unlock();
}

/*!
	\brief Obscures the cursor.
	
	Obscure calls are not nestable. Subclasses should call DisplayDriver::ObscureCursor
	somewhere within this function to ensure that data is maintained accurately. A check
	will be made by the system before the next MoveCursorTo call to show the cursor if
	it is obscured.
*/
void
DisplayDriver::ObscureCursor()
{
	Lock();
	fCursorHandler.Obscure();	
	Unlock();

}

/*!
	\brief Changes the cursor.
	\param cursor The new cursor. Guaranteed to be non-NULL.
	
	The driver does not take ownership of the given cursor. Subclasses should make
	a copy of the cursor passed to it. The default version of this function hides the
	cursory, replaces it, and shows the cursor if previously visible.
*/
void
DisplayDriver::SetCursor(ServerCursor *cursor)
{
	Lock();
	fCursorHandler.SetCursor(cursor);
	Unlock();
}

//! Returns the cursor's current position
BPoint
DisplayDriver::GetCursorPosition()
{
	Lock();
	BPoint pos = fCursorHandler.GetPosition();
	Unlock();
	
	return pos;
}

/*!
	\brief Returns whether or not the cursor is currently obscured
	\return True if obscured, false if not.
*/
bool
DisplayDriver::IsCursorObscured(bool state)
{
	Lock();
	bool obscured = fCursorHandler.IsObscured();
	Unlock();
	
	return obscured;
}

// Protected Internal Functions
/*
	\brief Sets the screen mode to specified resolution and color depth.
	\param mode Data structure as defined in Screen.h
	
	Subclasses must include calls to _SetDepth, _SetHeight, _SetWidth, and _SetMode
	to update the state variables kept internally by the DisplayDriver class.
*/
void
DisplayDriver::SetMode(const display_mode &mode)
{
	fDisplayMode = mode;
}

// GetMode
void
DisplayDriver::GetMode(display_mode *mode)
{
	if (!mode)
		return;
	
	Lock();
	*mode = fDisplayMode;
	Unlock();
}

/*!
	\brief Sets the driver's Display Power Management System state
	\param state The state which the driver should enter
	\return B_OK if successful, B_ERROR for failure
	
	This function will fail if the driver's rendering context does not support a 
	particular DPMS state. Use DPMSCapabilities to find out the supported states.
	The default implementation supports only B_DPMS_ON.
*/
status_t
DisplayDriver::SetDPMSMode(const uint32 &state)
{
	if (state != B_DPMS_ON)
		return B_ERROR;

	fDPMSState = state;

	return B_OK;
}

/*!
	\brief Returns the driver's current DPMS state
	\return The driver's current DPMS state
*/
uint32
DisplayDriver::DPMSMode() const
{
	return fDPMSState;
}

/*!
	\brief Returns the driver's DPMS capabilities
	\return The driver's DPMS capabilities
	
	The capabilities are the modes supported by the driver. The default implementation 
	allows only B_DPMS_ON. Other possible states are B_DPMS_STANDBY, SUSPEND, and OFF.
*/
uint32
DisplayDriver::DPMSCapabilities() const
{
	return fDPMSCaps;
}