]> git.lyx.org Git - lyx.git/blobdiff - src/Bullet.C
Fix the missing "Figure #:" label from the caption of a figure float.
[lyx.git] / src / Bullet.C
index 07665ea0467558f948da4835042cc8c08795b24c..2eef9c5bbd7c1d386a844d73cac983e875376b23 100644 (file)
@@ -1,33 +1,35 @@
-// -*- 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 1997-1998 Allan Rae
- *           and the LyX Team
- *
- * ====================================================== */
+ */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "Bullet.h"
 
+#include <boost/assert.hpp>
+
+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\\)"
+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}
@@ -47,13 +49,95 @@ Bullet::Bullet(int f, int c, int s)
                size = MIN;
        }
        generateText();
-#ifdef ENABLE_ASSERTIONS
        testInvariant();
-#endif
 }
 
 
-string Bullet::getText()
+
+Bullet::Bullet(string 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(string 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;
+}
+
+
+string const & Bullet::getText() const
 {
        if (user_text == 0) {
                generateText();
@@ -62,7 +146,7 @@ string Bullet::getText()
 }
 
 
-bool operator == (const Bullet & b1, const Bullet & b2)
+bool operator==(const Bullet & b1, const Bullet & b2)
 {
        bool result = false;
 
@@ -83,7 +167,7 @@ bool operator == (const Bullet & b1, const Bullet & b2)
 /*--------------------Private Member Functions-------------------*/
 
 
-void Bullet::generateText()
+void Bullet::generateText() const
 {
        // Assumption:
        // user hasn't defined their own text and/or I haven't generated
@@ -109,7 +193,7 @@ void Bullet::generateText()
 }
 
 
-string Bullet::bulletSize(short int s)
+string const Bullet::bulletSize(int s)
 {
        // use a parameter rather than hard code `size' in here
        // in case some future function may want to retrieve
@@ -117,7 +201,7 @@ string Bullet::bulletSize(short int s)
        // See additional comments in bulletEntry() below.
 
        static char const * BulletSize[SIZEMAX] = {
-               "\\tiny",  "\\scriptsize", "\\footnotesize", "\\small", "\\normalsize", 
+               "\\tiny",  "\\scriptsize", "\\footnotesize", "\\small", "\\normalsize",
                "\\large", "\\Large",      "\\LARGE",        "\\huge",  "\\Huge"
        };
 
@@ -125,7 +209,7 @@ string Bullet::bulletSize(short int s)
 }
 
 
-string Bullet::bulletEntry(short int f, short int c)
+string const Bullet::bulletEntry(int f, int c)
 {
        // Despite how this may at first appear the static local variables
        // are only initialized once..
@@ -140,10 +224,10 @@ string Bullet::bulletEntry(short int f, short int c)
        // to get around a compiler bug in an earler version of gcc (< 2.7.2.1)
        // static string const BulletPanels[FONTMAX][CHARMAX] = {
        static char const * BulletPanel0[CHARMAX] = {
-               /* standard */ 
+               /* standard */
                "\\normalfont\\bfseries{--}", "\\(\\vdash\\)",
                "\\(\\dashv\\)", "\\(\\flat\\)", "\\(\\natural\\)",
-               "\\(\\sharp\\)", "\\(\\ast\\)", "\\(\\star\\)", 
+               "\\(\\sharp\\)", "\\(\\ast\\)", "\\(\\star\\)",
                "\\(\\bullet\\)", "\\(\\circ\\)", "\\(\\cdot\\)",
                "\\(\\dagger\\)", "\\(\\bigtriangleup\\)",
                "\\(\\bigtriangledown\\)", "\\(\\triangleleft\\)",
@@ -151,9 +235,9 @@ string Bullet::bulletEntry(short int f, short int c)
                "\\(\\oplus\\)", "\\(\\ominus\\)", "\\(\\otimes\\)",
                "\\(\\oslash\\)", "\\(\\odot\\)", "\\(\\spadesuit\\)",
                "\\(\\diamond\\)", "\\(\\Diamond\\)", "\\(\\Box\\)",
-               "\\(\\diamondsuit\\)", "\\(\\heartsuit\\)", 
+               "\\(\\diamondsuit\\)", "\\(\\heartsuit\\)",
                "\\(\\clubsuit\\)", "\\(\\rightarrow\\)", "\\(\\leadsto\\)",
-               "\\(\\rightharpoonup\\)", "\\(\\rightharpoondown\\)", 
+               "\\(\\rightharpoonup\\)", "\\(\\rightharpoondown\\)",
                "\\(\\Rightarrow\\)", "\\(\\succ\\)"
        };
        static char const * BulletPanel1[CHARMAX] = {
@@ -268,3 +352,29 @@ string Bullet::bulletEntry(short int f, short int c)
 
        return 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
+}