lyx_mirror/src/frontends/gtk/ghelpers.C

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

#include <config.h>

// Too hard to make concept checks work with this file
#ifdef _GLIBCXX_CONCEPT_CHECKS
#undef _GLIBCXX_CONCEPT_CHECKS
#endif
#ifdef _GLIBCPP_CONCEPT_CHECKS
#undef _GLIBCPP_CONCEPT_CHECKS
#endif

#include "ghelpers.h"

#include "lyxrc.h"
#include "funcrequest.h"
#include "debug.h"

#include "support/filetools.h"
#include "support/package.h"

#include "gtkmm/icontheme.h"

#include <sstream>

using std::string;
using std::vector;

namespace lyx {
namespace frontend {

// Get a GTK stockID from a lyx function id.
// Return Gtk::Stock::MISSING_IMAGE if no suitable stock found
Gtk::BuiltinStockID getGTKStockIcon(FuncRequest const & func)
{
	switch (func.action) {
		case LFUN_BUFFER_WRITE: return Gtk::Stock::SAVE;
		case LFUN_BUFFER_NEW: return Gtk::Stock::NEW;
		case LFUN_BUFFER_WRITE_AS: return Gtk::Stock::SAVE_AS;
		case LFUN_BUFFER_RELOAD: return Gtk::Stock::REVERT_TO_SAVED;
		case LFUN_SCREEN_RECENTER: return Gtk::Stock::JUSTIFY_CENTER;
		case LFUN_TOC_VIEW: return Gtk::Stock::INDEX;
		case LFUN_BUFFER_CLOSE: return Gtk::Stock::CLOSE;
		case LFUN_LYX_QUIT: return Gtk::Stock::QUIT;
		case LFUN_UNDO: return Gtk::Stock::UNDO;
		case LFUN_REDO: return Gtk::Stock::REDO;
		case LFUN_PASTE: return Gtk::Stock::PASTE;
		case LFUN_PRIMARY_SELECTION_PASTE: return Gtk::Stock::PASTE;
		case LFUN_CUT: return Gtk::Stock::CUT;
		case LFUN_COPY: return Gtk::Stock::COPY;
		case LFUN_FONT_BOLD: return Gtk::Stock::BOLD;
		case LFUN_FONT_ITAL: return Gtk::Stock::ITALIC;
		case LFUN_FILE_OPEN: return Gtk::Stock::OPEN;
		case LFUN_RECONFIGURE: return Gtk::Stock::REFRESH;
		case LFUN_LABEL_GOTO:
		case LFUN_BOOKMARK_GOTO: return Gtk::Stock::JUMP_TO;
		case LFUN_NOTE_NEXT: return Gtk::Stock::GO_FORWARD;
		case LFUN_ACCEPT_ALL_CHANGES: return Gtk::Stock::APPLY;
		case LFUN_REJECT_ALL_CHANGES: return Gtk::Stock::CANCEL;
		case LFUN_DIALOG_SHOW:
			if (func.argument == "findreplace")
				return Gtk::Stock::FIND_AND_REPLACE;
			else if (func.argument == "print")
				return Gtk::Stock::PRINT;
			else if (func.argument == "spellchecker")
				return Gtk::Stock::SPELL_CHECK;
			else if (func.argument == "prefs")
				return Gtk::Stock::PREFERENCES;
			else if (func.argument == "document")
				return Gtk::Stock::PROPERTIES;
			else if (func.argument == "aboutlyx")
				return Gtk::Stock::ABOUT;
			else
				return Gtk::Stock::MISSING_IMAGE;
			break;
		default: return Gtk::Stock::MISSING_IMAGE;
	}
}


Glib::ustring getGTKThemeIcon(FuncRequest const & func)
{
	switch (func.action) {
		case LFUN_TABULAR_INSERT: return "stock_insert-table";
		case LFUN_MATH_MODE: return "stock_insert-math-object";
		case LFUN_FONT_EMPH: return "stock_text_italic";
		case LFUN_DIALOG_SHOW_NEW_INSET:
			if (func.argument == "graphics")
				return "stock_placeholder-picture";
			if (func.argument == "include")
				return "stock_insert-file";
			break;
		case LFUN_DIALOG_SHOW:
			if (func.argument == "spellchecker")
				return "stock_spellcheck";
			else if (func.argument == "character")
				return "stock_font";
			break;
		case LFUN_DEPTH_INCREMENT: return "format-indent-more";
		case LFUN_DEPTH_DECREMENT: return "format-indent-less";
		case LFUN_LAYOUT:
			if (func.argument == "Enumerate")
				return "stock_list_enum";
			else if (func.argument == "Itemize")
				return "stock_list_bullet";
			break;
		case LFUN_FONT_FREE_APPLY: return "stock_font-formatting-toggle";
		case LFUN_THESAURUS_ENTRY: return "stock_thesaurus";
		case LFUN_URL_INSERT: return "stock_insert-url";
		case LFUN_TABULAR_FEATURE:
			if (func.argument == "append-row")
				return "stock_insert-rows";
			else if (func.argument == "append-column")
				return "stock_insert-columns";
			else if (func.argument == "delete-row")
				return "stock_delete-row";
			else if (func.argument == "delete-column")
				return "stock_delete-column";
			else if (func.argument == "valign-top")
				return "stock_cell-align-top";
			else if (func.argument == "valign-middle")
				return "stock_cell-align-center";
			else if (func.argument == "valign-bottom")
				return "stock_cell-align-bottom";
			else if (func.argument == "align-left")
				return "gtk-justify-left";
			else if (func.argument == "align-center")
				return "gtk-justify-center";
			else if (func.argument == "align-right")
				return "gtk-justify-right";
			break;

			case LFUN_BOOKMARK_SAVE: return "stock_add-bookmark";
			case LFUN_NOTE_INSERT: return "stock_insert-note";
			case LFUN_LAYOUT_PARAGRAPH: return "stock_format-paragraph";
			case LFUN_BUFFER_NEWTMPLT: return "stock_new-template";
			//case LFUN_ERT_INSERT: return "gnome-mime-application-x-tex";
	}
	return "";
}


Gtk::Image *getGTKIcon(FuncRequest const & func, Gtk::IconSize const & size)
{
		static Glib::RefPtr<Gtk::IconTheme> theme;
		if (!theme)
			theme = Gtk::IconTheme::get_default();

		// TODO: cache these values somewhere else
		int iconwidth = 16;
		int iconheight = 16;
		Gtk::IconSize::lookup(size, iconwidth, iconheight);

		// TODO: this stuff is called every menu view - needs
		// caching somewhere, or maybe GTK does enough of that for us.
		Gtk::Image *image = NULL;
		Gtk::BuiltinStockID const stockID = getGTKStockIcon(func);
		if (stockID != Gtk::Stock::MISSING_IMAGE) {
			image = Gtk::manage(new Gtk::Image(stockID, size));
		} else {
			Glib::ustring iconname = getGTKThemeIcon (func);
			if (iconname != "") {
				if (theme->has_icon(iconname)) {
					Glib::RefPtr<Gdk::Pixbuf> pbuf = theme->load_icon(iconname, iconwidth, Gtk::ICON_LOOKUP_FORCE_SVG);
					if (pbuf) {
						image = Gtk::manage(new Gtk::Image(pbuf));
					}
				}
			}
		}

		return image;
}


string const getDefaultUnit()
{
	switch (lyxrc.default_papersize) {
		case PAPER_DEFAULT: return "cm";
		case PAPER_USLETTER:
		case PAPER_USLEGAL:
		case PAPER_USEXECUTIVE: return "in"; break;
		case PAPER_A3:
		case PAPER_A4:
		case PAPER_A5:
		case PAPER_B5: return "cm"; break;
	}
	// shut up compiler
	return "cm";
}


void unitsComboFromLength(Gtk::ComboBox * combo,
			   Gtk::TreeModelColumn<Glib::ustring> const & stringcol,
			   LyXLength const & len,
			   std::string const & defunit)
{
	string unit = stringFromUnit(len.unit());
	if (unit.empty())
		unit = defunit;

	Gtk::TreeModel::iterator it = combo->get_model()->children().begin();
	Gtk::TreeModel::iterator end = combo->get_model()->children().end();
	for (; it != end ; ++it) {
		if ((*it)[stringcol] == unit) {
			combo->set_active(it);
			return;
		}
	}

	// Fallen through, we didn't find the target length!
	combo->set_active(0);
	lyxerr << "unitsComboFromLength: couldn't find "
		"target unit '" << unit << "'\n";
}


vector<string> const buildLengthUnitList(bool const userelative)
{
	vector<string> data;
	if (userelative) {
		data = vector<string>(unit_name_gui, unit_name_gui + num_units);
	} else {
		for (int i = 0; i < num_units; ++i) {
			string str(unit_name_gui[i]);
			if (str.find("%") == string::npos)
				data.push_back(unit_name_gui[i]);
		}
	}
	return data;
}


string const findGladeFile(string const & name)
{
	// First, search in the installation directories.

	string filename = lyx::support::libFileSearch("glade", name, "glade");

	if (!filename.empty())
		return filename;

	// Second, search in the src tree.
	string const dir =
		lyx::support::addPath(lyx::support::package().top_srcdir(),
				      "src/frontends/gtk/glade");

	filename = lyx::support::changeExtension(name, ".glade");
	filename = lyx::support::addName(dir, filename);

	if (!lyx::support::isFileReadable(filename)) {
		lyxerr << "Unable to find glade file \"" << name
		       << "\". libglade is going to crash..." << std::endl;
	}

	return filename;
}

} // namespace frontend
} // namespace lyx