lyx_mirror/src/ColorSet.h

// -*- C++ -*-
/**
 * \file ColorSet.h
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Asger Alstrup
 * \author Lars Gullik Bjønnes
 * \author Matthias Ettrich
 * \author Jean-Marc Lasgouttes
 * \author Angus Leeming
 * \author John Levon
 * \author André Pönitz
 * \author Martin Vermeer
 *
 * Full author contact details are available in file CREDITS.
 */

#ifndef COLORSET_H
#define COLORSET_H

#include "Color.h"

#include <map>
#include <string>

namespace lyx {

/**
 * \class ColorSet
 *
 * A class holding color definitions and associated names for
 * LaTeX, X11, the GUI, and LyX internally.
 *
 * A color can be one of the following kinds:
 *
 * - A real, predefined color, such as black, white, red or green.
 * - A logical color, such as no color, inherit, math
 */


// made copyable for same reasons as LyXRC was made copyable. See there for
// explanation.

class ColorSet
{
public:
	///
	ColorSet();

	/** set the given LyX color to the color defined by the X11 hex name given
	 *  \returns true if successful. The optional third argument passes
	 *  a color for dark mode.
	 */
	bool setColor(ColorCode col, std::string const & x11hexname,
		      std::string const & x11darkhexname = std::string());

	/** set the given LyX color to the color defined by the X11
	 *  hex name given \returns true if successful. A new color entry
	 *  is created if the color is unknown. The optional third argument passes
	 *  a color for dark mode.
	 */
	bool setColor(std::string const & lyxname, std::string const & x11hexname,
		      std::string const & x11darkhexname = std::string());

	/** set the given LyX color to a latexcolor if not yet defined
	 *  \returns true if successful. A new color entry
	 *  is created if the color is unknown.
	 */
	bool setLaTeXName(std::string const & lyxname, std::string const & latexname);

	/** set the GUI name of a given LyX color to a guiname if not yet defined
	 *  \returns true if successful.
	 */
	bool setGUIName(std::string const & lyxname, std::string const & guiname);

	/// Get the GUI name of \c color.
	docstring const getGUIName(ColorCode c) const;

	/// Get the X11 hexname of \c color.
	std::string const getX11HexName(ColorCode c, bool const darkmode = false) const;

	/// Get the X11 hexname of \c color.
	std::pair<std::string, std::string> const getAllX11HexNames(ColorCode c) const;

	/// Get the LaTeX name of \c color.
	std::string const getLaTeXName(ColorCode c) const;

	/// Get the LyX name of \c color.
	std::string const getLyXName(ColorCode c) const;

	/// \returns the ColorCode associated with the LyX name.
	ColorCode getFromLyXName(std::string const & lyxname) const;
	/// \returns the ColorCode associated with the LaTeX name.
	ColorCode getFromLaTeXName(std::string const & latexname) const;

private:
	///
	void addColor(ColorCode c, std::string const & lyxname);
	///
	class Information {
	public:
		/// the name as it appears in the GUI
		std::string guiname;
		/// the name used in LaTeX
		std::string latexname;
		/// the name for X11
		std::string x11hexname;
		/// matching X11 color for dark mode
		std::string x11darkhexname;
		/// the name for LyX
		std::string lyxname;
	};

	/// initialise a color entry
	struct ColorEntry;
	void fill(ColorEntry const & entry);

	///
	typedef std::map<ColorCode, Information> InfoTab;
	/// the table of color Information
	InfoTab infotab;

	typedef std::map<std::string, ColorCode> Transform;
	/// the transform between LyX color name string and integer code.
	Transform lyxcolors;
	/// the transform between LaTeX color name string and integer code.
	Transform latexcolors;
};


/// the current color definitions
extern ColorSet lcolor;
/// the system color definitions
extern ColorSet system_lcolor;

} // namespace lyx

#endif // COLORSET_H