-// -*- C++ -*-
+/**
+ * \file Bullet.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Allan Rae
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
/* Completes the implementation of the Bullet class
* It defines the various LaTeX commands etc. required to
* generate the bullets in the bullet-panel's.
- *
- * This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright (C) 1997-1998 Allan Rae
- * and the LyX Team
- *
- * ====================================================== */
+ */
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "Bullet.h"
+#include <boost/assert.hpp>
+
+namespace lyx {
+
+using std::string;
+
+
+/** The four LaTeX itemize environment default bullets
+ */
+extern
+Bullet const ITEMIZE_DEFAULTS[4] = { Bullet(0, 8),//"\\(\\bullet\\)"
+ Bullet(0, 0),//"\\normalfont\\bfseries{--}"
+ Bullet(0, 6),//"\\(\\ast\\)"
+ Bullet(0, 10) };//"\\(\\cdot\\)"
+
// will need these later if still using full text as below
// \usepackage{latexsym,pifont,amssymb}
// and wasysym when that panel is created
-Bullet::Bullet(const int f, const int c, const int s)
- : font(f), character(c), size(s), user_text(0)
+Bullet::Bullet(int f, int c, int s)
+ : font(f), character(c), size(s), user_text(0)
{
if (f < MIN || f >= FONTMAX) {
font = MIN;
size = MIN;
}
generateText();
-#ifdef DEBUG_AS_DEFAULT
testInvariant();
-#endif
}
-string Bullet::getText()
+
+Bullet::Bullet(docstring const & t)
+ : font(MIN), character(MIN), size(MIN), user_text(1), text(t)
+{
+ testInvariant();
+}
+
+
+void Bullet::setCharacter(int c)
+{
+ if (c < MIN || c >= CHARMAX) {
+ character = MIN;
+ } else {
+ character = c;
+ }
+ user_text = 0;
+ testInvariant();
+}
+
+
+void Bullet::setFont(int f)
+{
+ if (f < MIN || f >= FONTMAX) {
+ font = MIN;
+ } else {
+ font = f;
+ }
+ user_text = 0;
+ testInvariant();
+}
+
+
+void Bullet::setSize(int s)
+{
+ if (s < MIN || s >= SIZEMAX) {
+ size = MIN;
+ } else {
+ size = s;
+ }
+ user_text = 0;
+ testInvariant();
+}
+
+
+void Bullet::setText(docstring const & t)
+{
+ font = character = size = MIN;
+ user_text = 1;
+ text = t;
+ testInvariant();
+}
+
+
+int Bullet::getCharacter() const
+{
+ return character;
+}
+
+
+int Bullet::getFont() const
+{
+ return font;
+}
+
+
+int Bullet::getSize() const
+{
+ return size;
+}
+
+
+Bullet & Bullet::operator=(Bullet const & b)
+{
+ b.testInvariant();
+ font = b.font;
+ character = b.character;
+ size = b.size;
+ user_text = b.user_text;
+ text = b.text;
+ this->testInvariant();
+ return *this;
+}
+
+
+docstring const & Bullet::getText() const
{
if (user_text == 0) {
generateText();
}
-bool operator == (const Bullet & b1, const Bullet & b2)
+bool operator==(const Bullet & b1, const Bullet & b2)
{
bool result = false;
/*--------------------Private Member Functions-------------------*/
-void Bullet::generateText()
+void Bullet::generateText() const
{
// Assumption:
// user hasn't defined their own text and/or I haven't generated
}
-string const & Bullet::bulletSize(const short & s)
+docstring const Bullet::bulletSize(int s)
{
// use a parameter rather than hard code `size' in here
// in case some future function may want to retrieve
// an arbitrary entry.
// See additional comments in bulletEntry() below.
- static string const BulletSize[SIZEMAX] = {
- "\\tiny", "\\scriptsize", "\\footnotesize", "\\small", "\\normalsize",
+ static char const * BulletSize[SIZEMAX] = {
+ "\\tiny", "\\scriptsize", "\\footnotesize", "\\small", "\\normalsize",
"\\large", "\\Large", "\\LARGE", "\\huge", "\\Huge"
};
- return BulletSize[s];
+ return from_ascii(BulletSize[s]);
}
-string const & Bullet::bulletEntry(const short & f, const short & c)
+docstring const Bullet::bulletEntry(int f, int c)
{
// Despite how this may at first appear the static local variables
// are only initialized once..
// The single 2-dim array had to be changed to multiple 1-dim arrays
// to get around a compiler bug in an earler version of gcc (< 2.7.2.1)
// static string const BulletPanels[FONTMAX][CHARMAX] = {
- static string const BulletPanel0[CHARMAX] = {
- /* standard */
+ static char const * BulletPanel0[CHARMAX] = {
+ /* standard */
"\\normalfont\\bfseries{--}", "\\(\\vdash\\)",
"\\(\\dashv\\)", "\\(\\flat\\)", "\\(\\natural\\)",
- "\\(\\sharp\\)", "\\(\\ast\\)", "\\(\\star\\)",
+ "\\(\\sharp\\)", "\\(\\ast\\)", "\\(\\star\\)",
"\\(\\bullet\\)", "\\(\\circ\\)", "\\(\\cdot\\)",
"\\(\\dagger\\)", "\\(\\bigtriangleup\\)",
"\\(\\bigtriangledown\\)", "\\(\\triangleleft\\)",
"\\(\\oplus\\)", "\\(\\ominus\\)", "\\(\\otimes\\)",
"\\(\\oslash\\)", "\\(\\odot\\)", "\\(\\spadesuit\\)",
"\\(\\diamond\\)", "\\(\\Diamond\\)", "\\(\\Box\\)",
- "\\(\\diamondsuit\\)", "\\(\\heartsuit\\)",
+ "\\(\\diamondsuit\\)", "\\(\\heartsuit\\)",
"\\(\\clubsuit\\)", "\\(\\rightarrow\\)", "\\(\\leadsto\\)",
- "\\(\\rightharpoonup\\)", "\\(\\rightharpoondown\\)",
+ "\\(\\rightharpoonup\\)", "\\(\\rightharpoondown\\)",
"\\(\\Rightarrow\\)", "\\(\\succ\\)"
};
- static string const BulletPanel1[CHARMAX] = {
+ static char const * BulletPanel1[CHARMAX] = {
/* amssymb */
"\\(\\Rrightarrow\\)", "\\(\\rightarrowtail\\)",
"\\(\\twoheadrightarrow\\)", "\\(\\rightsquigarrow\\)",
"\\(\\blacktriangledown\\)", "\\(\\blacklozenge\\)",
"\\(\\blacksquare\\)"
};
- static string const BulletPanel2[CHARMAX] = {
+ static char const * BulletPanel2[CHARMAX] = {
/* psnfss1 */
"\\ding{108}", "\\ding{109}",
"\\ding{119}", "\\Pisymbol{psy}{197}",
"\\ding{166}", "\\ding{167}",
"\\ding{226}", "\\ding{227}"
};
- static string const BulletPanel3[CHARMAX] = {
+ static char const * BulletPanel3[CHARMAX] = {
/* psnfss2 */
"\\ding{37}", "\\ding{38}",
"\\ding{34}", "\\ding{36}",
"\\ding{171}", "\\ding{168}",
"\\ding{169}", "\\ding{170}"
};
- static string const BulletPanel4[CHARMAX] = {
+ static char const * BulletPanel4[CHARMAX] = {
/* psnfss3 */
"\\ding{65}", "\\ding{76}",
"\\ding{75}", "\\ding{72}",
"\\ding{102}", "\\ding{96}",
"\\ding{95}", "\\ding{97}"
};
- static string const BulletPanel5[CHARMAX] = {
+ static char const * BulletPanel5[CHARMAX] = {
/* psnfss4 */
"\\ding{223}", "\\ding{224}",
"\\ding{225}", "\\ding{232}",
"\\ding{231}", "\\Pisymbol{psy}{45}"
}; /* string const BulletPanels[][] */
- static string const * BulletPanels[FONTMAX] = {
+ static char const ** BulletPanels[FONTMAX] = {
BulletPanel0, BulletPanel1,
BulletPanel2, BulletPanel3,
BulletPanel4, BulletPanel5
};
- return BulletPanels[f][c];
+ return from_ascii(BulletPanels[f][c]);
}
+
+void Bullet::testInvariant() const
+{
+#ifdef ENABLE_ASSERTIONS
+ BOOST_ASSERT(font >= MIN);
+ BOOST_ASSERT(font < FONTMAX);
+ BOOST_ASSERT(character >= MIN);
+ BOOST_ASSERT(character < CHARMAX);
+ BOOST_ASSERT(size >= MIN);
+ BOOST_ASSERT(size < SIZEMAX);
+ BOOST_ASSERT(user_text >= -1);
+ BOOST_ASSERT(user_text <= 1);
+ // now some relational/operational tests
+ if (user_text == 1) {
+ BOOST_ASSERT(font == -1 && (character == -1 && size == -1));
+ // BOOST_ASSERT(!text.empty()); // this isn't necessarily an error
+ }
+ // else if (user_text == -1) {
+ // BOOST_ASSERT(!text.empty()); // this also isn't necessarily an error
+ // }
+ // else {
+ // // user_text == 0
+ // BOOST_ASSERT(text.empty()); // not usually true
+ // }
+#endif
+}
+
+
+} // namespace lyx
projects / lyx.git / blobdiff