4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
12 * Full author contact details are available in file CREDITS.
19 #include "support/docstream.h"
34 /** The value INHERIT_* means that the font attribute is
35 inherited from the layout. In the case of layout fonts, the
36 attribute is inherited from the default font.
37 The value IGNORE_* is used with Font::update() when the
38 attribute should not be changed.
42 ROMAN_FAMILY, // fontstruct rely on this to be 0
72 NUM_FAMILIES = INHERIT_FAMILY
78 MEDIUM_SERIES, // fontstruct rely on this to be 0
90 UP_SHAPE, // fontstruct rely on this to be 0
106 SIZE_TINY, // fontstruct rely on this to be 0
135 /// Used for emph, underbar, noun and latex toggles
136 enum FONT_MISC_STATE {
149 /// Trick to overload constructor and make it megafast
174 /** We store the Color::color value as an int to get Color.h out
175 * of the header file.
179 FONT_MISC_STATE emph;
181 FONT_MISC_STATE underbar;
183 FONT_MISC_STATE noun;
185 FONT_MISC_STATE number;
190 /// Shortcut initialization
191 explicit Font(Font::FONT_INIT1);
192 /// Shortcut initialization
193 explicit Font(Font::FONT_INIT2);
194 /// Shortcut initialization
195 explicit Font(Font::FONT_INIT3);
196 /// Shortcut initialization
197 Font(Font::FONT_INIT1, Language const * l);
198 /// Shortcut initialization
199 Font(Font::FONT_INIT2, Language const * l);
200 /// Shortcut initialization
201 Font(Font::FONT_INIT3, Language const * l);
203 /// Decreases font size by one
205 /// Increases font size by one
208 FONT_FAMILY family() const { return bits.family; }
210 FONT_SERIES series() const { return bits.series; }
212 FONT_SHAPE shape() const { return bits.shape; }
214 FONT_SIZE size() const { return bits.size; }
216 FONT_MISC_STATE emph() const { return bits.emph; }
218 FONT_MISC_STATE underbar() const { return bits.underbar; }
220 FONT_MISC_STATE noun() const { return bits.noun; }
222 FONT_MISC_STATE number() const { return bits.number; }
224 Color_color color() const;
226 Language const * language() const { return lang; }
228 bool isRightToLeft() const;
230 bool isVisibleRightToLeft() const;
232 bool isSymbolFont() const;
235 void setFamily(Font::FONT_FAMILY f);
236 void setSeries(Font::FONT_SERIES s);
237 void setShape(Font::FONT_SHAPE s);
238 void setSize(Font::FONT_SIZE s);
239 void setEmph(Font::FONT_MISC_STATE e);
240 void setUnderbar(Font::FONT_MISC_STATE u);
241 void setNoun(Font::FONT_MISC_STATE n);
242 void setNumber(Font::FONT_MISC_STATE n);
243 void setColor(Color_color c);
244 void setLanguage(Language const * l);
246 /// Set family after LyX text format
247 Font & setLyXFamily(std::string const &);
249 /// Set series after LyX text format
250 Font & setLyXSeries(std::string const &);
252 /// Set shape after LyX text format
253 Font & setLyXShape(std::string const &);
255 /// Set size after LyX text format
256 Font & setLyXSize(std::string const &);
258 /// Returns misc flag after LyX text format
259 Font::FONT_MISC_STATE setLyXMisc(std::string const &);
261 /// Sets color after LyX text format
262 Font & setLyXColor(std::string const &);
264 /// Returns size of font in LaTeX text notation
265 std::string const latexSize() const;
267 /** Updates font settings according to request.
268 If an attribute is IGNORE, the attribute is left as it is.
269 When toggleall = true, all properties that matches the font in use
270 will have the effect that the properties is reset to the
271 default. If we have a text that is TYPEWRITER_FAMILY, and is
272 update()'ed with TYPEWRITER_FAMILY, the operation will be as if
273 a INHERIT_FAMILY was asked for. This is necessary for the
274 toggle-user-defined-style button on the toolbar.
276 void update(Font const & newfont,
277 Language const * default_lang,
278 bool toggleall = false);
280 /** Reduce font to fall back to template where possible.
281 Equal fields are reduced to INHERIT */
282 void reduce(Font const & tmplt);
284 /// Realize font from a template (INHERIT are realized)
285 Font & realize(Font const & tmplt);
286 /// Is a given font fully resolved?
287 bool resolved() const;
289 /// Read a font specification from Lexer. Used for layout files.
290 Font & lyxRead(Lexer &);
292 /// Writes the changes from this font to orgfont in .lyx format in file
293 void lyxWriteChanges(Font const & orgfont, std::ostream &) const;
295 /** Writes the head of the LaTeX needed to change to this font.
296 Writes to string, the head of the LaTeX needed to change
297 to this font. Returns number of chars written. Base is the
298 font state active now.
300 int latexWriteStartChanges(odocstream &, BufferParams const & bparams,
301 OutputParams const & runparams,
303 Font const & prev) const;
305 /** Writes the tail of the LaTeX needed to change to this font.
306 Returns number of chars written. Base is the font state we want
309 int latexWriteEndChanges(odocstream &, BufferParams const & bparams,
310 OutputParams const & runparams,
312 Font const & next) const;
315 /// Build GUI description of font state
316 docstring const stateText(BufferParams * params) const;
319 Color_color realColor() const;
323 bool operator==(Font const & font1, Font const & font2);
326 std::ostream & operator<<(std::ostream & os, Font const & font);
328 /// Converts logical attributes to concrete shape attribute
329 // Try hard to inline this as it shows up with 4.6 % in the profiler.
330 inline Font::FONT_SHAPE realShape() const {
332 return SMALLCAPS_SHAPE;
334 return (bits.shape == UP_SHAPE) ? ITALIC_SHAPE : UP_SHAPE;
339 /** Compaq cxx 6.5 requires that the definition be public so that
340 it can compile operator==()
346 Language const * lang;
348 static FontBits sane;
350 static FontBits inherit;
352 static FontBits ignore;
353 /// Updates a misc setting according to request
354 Font::FONT_MISC_STATE setMisc(Font::FONT_MISC_STATE newfont,
355 Font::FONT_MISC_STATE org);
356 /// Did latexWriteStartChanges open an encoding environment?
357 mutable bool open_encoding_;
361 /** \c Font_size is a wrapper for Font::FONT_SIZE.
362 * It can be forward-declared and passed as a function argument without
363 * having to expose Font.h.
368 Font_size(Font::FONT_SIZE val) : val_(val) {}
370 operator Font::FONT_SIZE() const { return val_; }
373 Font::FONT_SIZE val_;
379 bool Font::isSymbolFont() const
382 case Font::SYMBOL_FAMILY:
383 case Font::CMSY_FAMILY:
384 case Font::CMM_FAMILY:
385 case Font::CMEX_FAMILY:
386 case Font::MSA_FAMILY:
387 case Font::MSB_FAMILY:
388 case Font::WASY_FAMILY:
389 case Font::ESINT_FAMILY:
397 std::ostream & operator<<(std::ostream &, Font::FONT_MISC_STATE);
399 bool operator==(Font::FontBits const & lhs, Font::FontBits const & rhs);
402 bool operator!=(Font::FontBits const & lhs, Font::FontBits const & rhs)
404 return !(lhs == rhs);
409 bool operator==(Font const & font1, Font const & font2)
411 return font1.bits == font2.bits && font1.lang == font2.lang;
416 bool operator!=(Font const & font1, Font const & font2)
418 return !(font1 == font2);