lyx_mirror/src/frontends/xforms/FormBase.C

/**
 * \file FormBase.C
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Angus Leeming
 *
 * Full author contact details are available in file CREDITS
 */

#include <config.h>

#ifdef __GNUG__
#pragma implementation
#endif

#include "FormBase.h"

#include "ControlButtons.h"
#include "xformsBC.h"
#include "xforms_resize.h"
#include "Tooltips.h"
#include "xforms_helpers.h" // formatted

#include "gettext.h"        // _()
#include "BoostFormat.h"

#include "support/LAssert.h"
#include "support/filetools.h" //  LibFileSearch

#include FORMS_H_LOCATION

extern "C" {

// These should be in forms.h but aren't
void fl_show_tooltip(const char *, int, int);

void fl_hide_tooltip();

// Callback function invoked by xforms when the dialog is closed by the
// window manager.
static int C_WMHideCB(FL_FORM * form, void *);

// Callback function invoked by the xforms pre-handler routine.
static int C_PrehandlerCB(FL_OBJECT *, int, FL_Coord, FL_Coord, int, void *);

} // extern "C"


FormBase::FormBase(string const & t, bool allowResize)
	: ViewBase(),
	  warning_posted_(false), message_widget_(0),
	  minw_(0), minh_(0), allow_resize_(allowResize),
	  title_(t), icon_pixmap_(0), icon_mask_(0),
	  tooltips_(new Tooltips())
{}


FormBase::~FormBase()
{
	if (icon_pixmap_)
		XFreePixmap(fl_get_display(), icon_pixmap_);

	delete tooltips_;
}


Tooltips & FormBase::tooltips()
{
	return *tooltips_;
}


void FormBase::redraw()
{
	if (form() && form()->visible)
		fl_redraw_form(form());
}


xformsBC & FormBase::bc()
{
	return static_cast<xformsBC &>(getController().bc());
	// return dynamic_cast<GUIbc &>(controller_ptr_->bc());
}


void FormBase::prepare_to_show()
{
	double const scale = get_scale_to_fit(form());
	if (scale > 1.001)
		scale_form_horizontally(form(), scale);

	// work around dumb xforms sizing bug
	minw_ = form()->w;
	minh_ = form()->h;

	fl_set_form_atclose(form(), C_WMHideCB, 0);

	// set the title for the minimized form
	if (!getController().IconifyWithMain())
		fl_winicontitle(form()->window, title_.c_str());

	//  assign an icon to the form
	string const iconname = LibFileSearch("images", "lyx", "xpm");
	if (!iconname.empty()) {
		unsigned int w, h;
		icon_pixmap_ = fl_read_pixmapfile(fl_root,
						  iconname.c_str(),
						  &w,
						  &h,
						  &icon_mask_,
						  0, 0, 0);
		fl_set_form_icon(form(), icon_pixmap_, icon_mask_);
	}
}


void FormBase::show()
{
	// build() is/should be called from the controller, so form() should
	// always exist.
	lyx::Assert(form());

	// we use minw_ to flag whether the dialog has ever been shown.
	// In turn, prepare_to_show() initialises various bits 'n' pieces
	// (including minw_).
	if (minw_ == 0) {
		prepare_to_show();
	}

	// make sure the form is up to date.
	fl_freeze_form(form());
	update();
	fl_unfreeze_form(form());

	if (form()->visible) {
		fl_raise_form(form());
		/* This XMapWindow() will hopefully ensure that
		 * iconified dialogs are de-iconified. Mad props
		 * out to those crazy Xlib guys for forgetting a
		 * XDeiconifyWindow(). At least WindowMaker, when
		 * being notified of the redirected MapRequest will
		 * specifically de-iconify. From source, fvwm2 seems
		 * to do the same.
		 */
		XMapWindow(fl_get_display(), form()->window);
	} else {
		// calls to fl_set_form_minsize/maxsize apply only to the next
		// fl_show_form(), so this comes first.
		fl_set_form_minsize(form(), minw_, minh_);
		if (!allow_resize_)
			fl_set_form_maxsize(form(), minw_, minh_);

		string const maximize_title = "LyX: " + title_;
		int const iconify_policy =
			getController().IconifyWithMain() ? FL_TRANSIENT : 0;

		fl_show_form(form(),
			     FL_PLACE_MOUSE | FL_FREE_SIZE,
			     iconify_policy,
			     maximize_title.c_str());
	}
}


void FormBase::hide()
{
#if FL_VERSION < 1
	// Does no harm if none is visible and ensures that the tooltip form
	// is hidden should the dialog be closed from the keyboard.
	fl_hide_tooltip();
#endif

	// xforms sometimes tries to process a hint-type MotionNotify, and
	// use XQueryPointer, without verifying if the window still exists.
	// So we try to clear out motion events in the queue before the
	// DestroyNotify
	XSync(fl_get_display(), false);

	if (form() && form()->visible)
		fl_hide_form(form());
}


void FormBase::setPrehandler(FL_OBJECT * ob)
{
	lyx::Assert(ob);
	fl_set_object_prehandler(ob, C_PrehandlerCB);
}


void FormBase::setMessageWidget(FL_OBJECT * ob)
{
	lyx::Assert(ob && ob->objclass == FL_TEXT);
	message_widget_ = ob;
	fl_set_object_lsize(message_widget_, FL_NORMAL_SIZE);
}


void FormBase::InputCB(FL_OBJECT * ob, long data)
{
	// It is possible to set the choice to 0 when using the
	// keyboard shortcuts. This work-around deals with the problem.
	if (ob && ob->objclass == FL_CHOICE && fl_get_choice(ob) < 1) {
		fl_set_choice(ob, 1);
	}

	bc().input(input(ob, data));
}


ButtonPolicy::SMInput FormBase::input(FL_OBJECT *, long)
{
	return ButtonPolicy::SMI_VALID;
}


// preemptive handler for feedback messages
void FormBase::MessageCB(FL_OBJECT * ob, int event)
{
	lyx::Assert(ob);

	switch (event) {
	case FL_ENTER:
	{
		string const feedback = getFeedback(ob);
		if (feedback.empty() && warning_posted_)
			break;

		warning_posted_ = false;
		postMessage(getFeedback(ob));
		break;
	}

	case FL_LEAVE:
		if (!warning_posted_)
			clearMessage();
		break;

	default:
		break;
	}
}


void FormBase::PrehandlerCB(FL_OBJECT * ob, int event, int key)
{
	lyx::Assert(ob);

	if (ob->objclass == FL_INPUT && event == FL_PUSH && key == 2) {
		// Trigger an input event when pasting in an xforms input object
		// using the middle mouse button.
		InputCB(ob, 0);
		return;
	}

	switch (event) {
	case FL_ENTER:
	case FL_LEAVE:
		if (message_widget_) {
			// Post feedback as the mouse enters the object,
			// remove it as the mouse leaves.
			MessageCB(ob, event);
		}

#if FL_VERSION < 1
		if (ob->objclass == FL_TABFOLDER) {
			// This prehandler is used to work-around an xforms
			// bug and ensures that the form->x, form->y coords of
			// the active tabfolder are up to date.

			// The tabfolder itself can be very narrow, being just
			// the visible border to the tabs.
			// We thus use both FL_ENTER and FL_LEAVE as flags,
			// in case the FL_ENTER event is not caught.

			FL_FORM * const folder = fl_get_active_folder(ob);
			if (folder && folder->window) {
				fl_get_winorigin(folder->window,
						 &(folder->x), &(folder->y));
			}
		}
#endif
		break;
	}

	// Tooltips are not displayed on browser widgets due to an xforms' bug.
	// I have a fix, but it's not yet in the xforms sources.
	// This is a work-around:
	switch (event) {
	case FL_ENTER:
		if (ob->objclass == FL_BROWSER &&
		    ob->tooltip && *(ob->tooltip)) {
			int const x = ob->form->x + ob->x;
			int const y = ob->form->y + ob->y + ob->h + 1;
			fl_show_tooltip(ob->tooltip, x, y);
		}
		break;
	case FL_LEAVE:
	case FL_PUSH:
	case FL_KEYPRESS:
		if (ob->objclass == FL_BROWSER)
			fl_hide_tooltip();
		break;
	}
}


void FormBase::postWarning(string const & warning)
{
	warning_posted_ = true;
	postMessage(warning);
}


void FormBase::clearMessage()
{
	lyx::Assert(message_widget_);

	warning_posted_ = false;

	string const existing = message_widget_->label
		? message_widget_->label : string();
	if (existing.empty())
		return;

	// This trick is needed to get xforms to clear the label...
	fl_set_object_label(message_widget_, "");
	fl_hide_object(message_widget_);
}


void FormBase::postMessage(string const & message)
{
	lyx::Assert(message_widget_);

	int const width = message_widget_->w - 10;
#if USE_BOOST_FORMAT
	boost::format fmter = warning_posted_ ?
		boost::format(_("WARNING! %1$s")) :
		boost::format("%1$s");

	string const str = formatted(boost::io::str(fmter % message),
				     width, FL_NORMAL_SIZE);
#else
	string const tmp = warning_posted_ ?
		_("WARNING!") + string(" ") + message :
		message;

	string const str = formatted(tmp, width, FL_NORMAL_SIZE);
#endif

	fl_set_object_label(message_widget_, str.c_str());
	FL_COLOR const label_color = warning_posted_ ? FL_RED : FL_LCOL;
	fl_set_object_lcol(message_widget_, label_color);

	if (!message_widget_->visible)
		fl_show_object(message_widget_);
}


namespace {

FormBase * GetForm(FL_OBJECT * ob)
{
	lyx::Assert(ob && ob->form && ob->form->u_vdata);
	FormBase * ptr = static_cast<FormBase *>(ob->form->u_vdata);
	return ptr;
}

} // namespace anon


extern "C" {

void C_FormBaseApplyCB(FL_OBJECT * ob, long)
{
	GetForm(ob)->getController().ApplyButton();
}


void C_FormBaseOKCB(FL_OBJECT * ob, long)
{
	GetForm(ob)->getController().OKButton();
}


void C_FormBaseCancelCB(FL_OBJECT * ob, long)
{
	FormBase * form = GetForm(ob);
	form->getController().CancelButton();
}


void C_FormBaseRestoreCB(FL_OBJECT * ob, long)
{
	GetForm(ob)->getController().RestoreButton();
}


void C_FormBaseInputCB(FL_OBJECT * ob, long d)
{
	GetForm(ob)->InputCB(ob, d);
}


static int C_WMHideCB(FL_FORM * form, void *)
{
	// Close the dialog cleanly, even if the WM is used to do so.
	lyx::Assert(form && form->u_vdata);
	FormBase * ptr = static_cast<FormBase *>(form->u_vdata);
	ptr->getController().CancelButton();
	return FL_CANCEL;
}

static int C_PrehandlerCB(FL_OBJECT * ob, int event,
			  FL_Coord, FL_Coord, int key, void *)
{
	// Note that the return value is important in the pre-emptive handler.
	// Don't return anything other than 0.
	lyx::Assert(ob);

	// Don't Assert this one, as it can happen quite naturally when things
	// are being deleted in the d-tor.
	//Assert(ob->form);
	if (!ob->form) return 0;

	FormBase * ptr = static_cast<FormBase *>(ob->form->u_vdata);

	if (ptr)
		ptr->PrehandlerCB(ob, event, key);

	return 0;
}

} // extern "C"