X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCounters.cpp;h=2daac53224dca0a4f26e6850d3b7d7a228e6c1be;hb=f5f2f5b7eaca90ba9bbddee3cea54708c9b98a36;hp=ead94fccbee4bd475ba02e00b3231cd97a4ceb0d;hpb=e9d19b82d492c1cce34e5c2be453f56bb0e33c30;p=lyx.git

diff --git a/src/Counters.cpp b/src/Counters.cpp
index ead94fccbe..2daac53224 100644
--- a/src/Counters.cpp
+++ b/src/Counters.cpp
@@ -14,6 +14,7 @@
 #include <config.h>
 
 #include "Counters.h"
+#include "Layout.h"
 #include "Lexer.h"
 
 #include "support/convert.h"
@@ -32,14 +33,15 @@ namespace lyx {
 
 
 Counter::Counter()
+	: initial_value_(0)
 {
 	reset();
 }
 
 
-Counter::Counter(docstring const & mc, docstring const & ls, 
-		 docstring const & lsa)
-	: master_(mc), labelstring_(ls), labelstringappendix_(lsa)
+Counter::Counter(docstring const & mc, docstring const & ls,
+                docstring const & lsa)
+	: initial_value_(0), master_(mc), labelstring_(ls), labelstringappendix_(lsa)
 {
 	reset();
 }
@@ -51,13 +53,17 @@ bool Counter::read(Lexer & lex)
 		CT_WITHIN = 1,
 		CT_LABELSTRING,
 		CT_LABELSTRING_APPENDIX,
+		CT_PRETTYFORMAT,
+		CT_INITIALVALUE,
 		CT_END
 	};
 
 	LexerKeyword counterTags[] = {
 		{ "end", CT_END },
+	  { "initialvalue", CT_INITIALVALUE},
 		{ "labelstring", CT_LABELSTRING },
 		{ "labelstringappendix", CT_LABELSTRING_APPENDIX },
+		{ "prettyformat", CT_PRETTYFORMAT },
 		{ "within", CT_WITHIN }
 	};
 
@@ -70,7 +76,7 @@ bool Counter::read(Lexer & lex)
 			case Lexer::LEX_UNDEF:
 				lex.printError("Unknown counter tag `$$Token'");
 				continue;
-			default: 
+			default:
 				break;
 		}
 		switch (le) {
@@ -80,6 +86,22 @@ bool Counter::read(Lexer & lex)
 				if (master_ == "none")
 					master_.erase();
 				break;
+			case CT_INITIALVALUE:
+				lex.next();
+				initial_value_ = lex.getInteger();
+				// getInteger() returns -1 on error, and larger
+				// negative values do not make much sense.
+				// In the other case, we subtract one, since the
+				// counter will be incremented before its first use.
+				if (initial_value_ <= -1)
+					initial_value_ = 0;
+				else
+					initial_value_ -= 1;
+				break;
+			case CT_PRETTYFORMAT:
+				lex.next();
+				prettyformat_ = lex.getDocString();
+				break;
 			case CT_LABELSTRING:
 				lex.next();
 				labelstring_ = lex.getDocString();
@@ -102,6 +124,7 @@ bool Counter::read(Lexer & lex)
 	return getout;
 }
 
+
 void Counter::set(int v)
 {
 	value_ = v;
@@ -128,7 +151,7 @@ void Counter::step()
 
 void Counter::reset()
 {
-	value_ = 0;
+	value_ = initial_value_;
 }
 
 
@@ -138,6 +161,15 @@ docstring const & Counter::master() const
 }
 
 
+bool Counter::checkAndRemoveMaster(docstring const & cnt)
+{
+	if (master_ != cnt)
+		return false;
+	master_ = docstring();
+	return true;
+}
+
+
 docstring const & Counter::labelString(bool in_appendix) const
 {
 	return in_appendix ? labelstringappendix_ : labelstring_;
@@ -150,8 +182,15 @@ Counter::StringMap & Counter::flatLabelStrings(bool in_appendix) const
 }
 
 
+Counters::Counters() : appendix_(false), subfloat_(false), longtable_(false)
+{
+	layout_stack_.push_back(0);
+	counter_stack_.push_back(from_ascii(""));
+}
+
+
 void Counters::newCounter(docstring const & newc,
-			  docstring const & masterc, 
+			  docstring const & masterc,
 			  docstring const & ls,
 			  docstring const & lsa)
 {
@@ -171,18 +210,20 @@ bool Counters::hasCounter(docstring const & c) const
 }
 
 
-bool Counters::read(Lexer & lex, docstring const & name)
+bool Counters::read(Lexer & lex, docstring const & name, bool makenew)
 {
 	if (hasCounter(name)) {
 		LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
 		return counterList_[name].read(lex);
 	}
+
 	LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
 	Counter cnt;
 	bool success = cnt.read(lex);
-	if (success)
+	// if makenew is false, we will just discard what we read
+	if (success && makenew)
 		counterList_[name] = cnt;
-	else
+	else if (!success)
 		LYXERR0("Error reading counter `" << name << "'!");
 	return success;
 }
@@ -224,7 +265,32 @@ int Counters::value(docstring const & ctr) const
 }
 
 
-void Counters::step(docstring const & ctr)
+void Counters::resetSlaves(docstring const & ctr)
+{
+	CounterList::iterator it = counterList_.begin();
+	CounterList::iterator const end = counterList_.end();
+	for (; it != end; ++it) {
+		if (it->second.master() == ctr) {
+			it->second.reset();
+			resetSlaves(it->first);
+		}
+	}
+}
+
+
+void Counters::stepMaster(docstring const & ctr, UpdateType utype)
+{
+	CounterList::iterator it = counterList_.find(ctr);
+	if (it == counterList_.end()) {
+		lyxerr << "step: Counter does not exist: "
+		       << to_utf8(ctr) << endl;
+		return;
+	}
+	step(it->second.master(), utype);
+}
+
+
+void Counters::step(docstring const & ctr, UpdateType utype)
 {
 	CounterList::iterator it = counterList_.find(ctr);
 	if (it == counterList_.end()) {
@@ -234,13 +300,13 @@ void Counters::step(docstring const & ctr)
 	}
 
 	it->second.step();
-	it = counterList_.begin();
-	CounterList::iterator const end = counterList_.end();
-	for (; it != end; ++it) {
-		if (it->second.master() == ctr) {
-			it->second.reset();
-		}
+	if (utype == OutputUpdate) {
+		LBUFERR(!counter_stack_.empty());
+		counter_stack_.pop_back();
+		counter_stack_.push_back(ctr);
 	}
+
+	resetSlaves(ctr);
 }
 
 
@@ -253,12 +319,16 @@ void Counters::reset()
 	CounterList::iterator const end = counterList_.end();
 	for (; it != end; ++it)
 		it->second.reset();
+	counter_stack_.clear();
+	counter_stack_.push_back(from_ascii(""));
+	layout_stack_.clear();
+	layout_stack_.push_back(0);
 }
 
 
 void Counters::reset(docstring const & match)
 {
-	LASSERT(!match.empty(), /**/);
+	LASSERT(!match.empty(), return);
 
 	CounterList::iterator it = counterList_.begin();
 	CounterList::iterator end = counterList_.end();
@@ -269,6 +339,22 @@ void Counters::reset(docstring const & match)
 }
 
 
+bool Counters::remove(docstring const & cnt)
+{
+	bool retval = counterList_.erase(cnt);
+	if (!retval)
+		return false;
+	CounterList::iterator it = counterList_.begin();
+	CounterList::iterator end = counterList_.end();
+	for (; it != end; ++it) {
+		if (it->second.checkAndRemoveMaster(cnt))
+			LYXERR(Debug::TCLASS, "Removed master counter `" +
+					to_utf8(cnt) + "' from counter: " + to_utf8(it->first));
+	}
+	return retval;
+}
+
+
 void Counters::copy(Counters & from, Counters & to, docstring const & match)
 {
 	CounterList::iterator it = counterList_.begin();
@@ -313,9 +399,8 @@ char hebrewCounter(int const n)
 }
 
 
-
 // On the special cases, see http://mathworld.wolfram.com/RomanNumerals.html
-// and for a list of roman numerals up to and including 3999, see 
+// and for a list of roman numerals up to and including 3999, see
 // http://www.research.att.com/~njas/sequences/a006968.txt. (Thanks to Joost
 // for this info.)
 docstring const romanCounter(int const n)
@@ -324,25 +409,25 @@ docstring const romanCounter(int const n)
 		"I",   "II",  "III", "IV", "V",
 		"VI",  "VII", "VIII", "IX"
 	};
-	
+
 	static char const * const tens[9] = {
 		"X", "XX", "XXX", "XL", "L",
 		"LX", "LXX", "LXXX", "XC"
 	};
-	
+
 	static char const * const hunds[9] = {
 		"C", "CC", "CCC", "CD", "D",
 		"DC", "DCC", "DCCC", "CM"
 	};
-	
-	if (n > 1000 || n < 1) 
+
+	if (n >= 1000 || n < 1)
 		return from_ascii("??");
-	
+
 	int val = n;
 	string roman;
 	switch (n) {
 	//special cases
-	case 900: 
+	case 900:
 		roman = "CM";
 		break;
 	case 400:
@@ -379,7 +464,25 @@ docstring const lowerromanCounter(int const n)
 	return lowercase(romanCounter(n));
 }
 
-} // namespace anon
+
+docstring const fnsymbolCounter(int const n)
+{
+	switch(n) {
+	case 1: return docstring(1, 0x002a); //*
+	case 2: return docstring(1, 0x2020); // dagger
+	case 3: return docstring(1, 0x2021); // double dagger
+	case 4: return docstring(1, 0x00A7); // section sign
+	case 5: return docstring(1, 0x00B6); // pilcrow sign
+	case 6: return docstring(1, 0x2016); // vertical bar
+	case 7: return docstring(2, 0x002a); // two *
+	case 8: return docstring(2, 0x2020); // two daggers
+	case 9: return docstring(2, 0x2021); // two double daggers
+	default:
+		return from_ascii("?");
+	};
+}
+
+} // namespace
 
 
 docstring Counters::labelItem(docstring const & ctr,
@@ -410,6 +513,9 @@ docstring Counters::labelItem(docstring const & ctr,
 	if (numbertype == "Roman")
 		return romanCounter(val);
 
+	if (numbertype == "fnsymbol")
+		return fnsymbolCounter(val);
+
 	return convert<docstring>(val);
 }
 
@@ -417,9 +523,9 @@ docstring Counters::labelItem(docstring const & ctr,
 docstring Counters::theCounter(docstring const & counter,
 			       string const & lang) const
 {
-	CounterList::const_iterator it = counterList_.find(counter); 
+	CounterList::const_iterator it = counterList_.find(counter);
 	if (it == counterList_.end())
-		return from_ascii("??");
+		return from_ascii("#");
 	Counter const & ctr = it->second;
 	Counter::StringMap & sm = ctr.flatLabelStrings(appendix());
 	Counter::StringMap::iterator smit = sm.find(lang);
@@ -434,13 +540,11 @@ docstring Counters::theCounter(docstring const & counter,
 }
 
 
-docstring Counters::flattenLabelString(docstring const & counter, 
+docstring Counters::flattenLabelString(docstring const & counter,
 				       bool in_appendix,
 				       string const & lang,
 				       vector<docstring> & callers) const
 {
-	docstring label;
-
 	if (find(callers.begin(), callers.end(), counter) != callers.end()) {
 		// recursion detected
 		lyxerr << "Warning: Recursion in label for counter `"
@@ -448,10 +552,10 @@ docstring Counters::flattenLabelString(docstring const & counter,
 		       << endl;
 		return from_ascii("??");
 	}
-		
-	CounterList::const_iterator it = counterList_.find(counter); 
+
+	CounterList::const_iterator it = counterList_.find(counter);
 	if (it == counterList_.end())
-		return from_ascii("??");
+		return from_ascii("#");
 	Counter const & c = it->second;
 
 	docstring ls = translateIfPossible(c.labelString(in_appendix), lang);
@@ -459,7 +563,7 @@ docstring Counters::flattenLabelString(docstring const & counter,
 	callers.push_back(counter);
 	if (ls.empty()) {
 		if (!c.master().empty())
-			ls = flattenLabelString(c.master(), in_appendix, lang, callers) 
+			ls = flattenLabelString(c.master(), in_appendix, lang, callers)
 				+ from_ascii(".");
 		callers.pop_back();
 		return ls + from_ascii("\\arabic{") + counter + "}";
@@ -472,7 +576,7 @@ docstring Counters::flattenLabelString(docstring const & counter,
 			break;
 		size_t const j = i + 4;
 		size_t k = j;
-		while (k < ls.size() && lowercase(ls[k]) >= 'a' 
+		while (k < ls.size() && lowercase(ls[k]) >= 'a'
 		       && lowercase(ls[k]) <= 'z')
 			++k;
 		docstring const newc = ls.substr(j, k - j);
@@ -493,22 +597,22 @@ docstring Counters::counterLabel(docstring const & format,
 
 	// FIXME: Using regexps would be better, but we compile boost without
 	// wide regexps currently.
+	docstring const the = from_ascii("\\the");
 	while (true) {
-		//lyxerr << "label=" << to_utf8(label) << endl;
-		size_t const i = label.find(from_ascii("\\the"), 0);
+		//lyxerr << "label=" << label << endl;
+		size_t const i = label.find(the, 0);
 		if (i == docstring::npos)
 			break;
 		size_t const j = i + 4;
 		size_t k = j;
-		while (k < label.size() && lowercase(label[k]) >= 'a' 
+		while (k < label.size() && lowercase(label[k]) >= 'a'
 		       && lowercase(label[k]) <= 'z')
 			++k;
-		docstring const newc = label.substr(j, k - j);
-		docstring const repl = theCounter(newc, lang);
-		label.replace(i, k - j + 4, repl);
+		docstring const newc(label, j, k - j);
+		label.replace(i, k - i, theCounter(newc, lang));
 	}
 	while (true) {
-		//lyxerr << "label=" << to_utf8(label) << endl;
+		//lyxerr << "label=" << label << endl;
 
 		size_t const i = label.find('\\', 0);
 		if (i == docstring::npos)
@@ -521,13 +625,76 @@ docstring Counters::counterLabel(docstring const & format,
 			break;
 		docstring const numbertype(label, i + 1, j - i - 1);
 		docstring const counter(label, j + 1, k - j - 1);
-		docstring const rep = labelItem(counter, numbertype);
-		label = docstring(label, 0, i) + rep
-			+ docstring(label, k + 1, docstring::npos);
+		label.replace(i, k + 1 - i, labelItem(counter, numbertype));
 	}
-	//lyxerr << "DONE! label=" << to_utf8(label) << endl;
+	//lyxerr << "DONE! label=" << label << endl;
 	return label;
 }
 
 
+docstring Counters::prettyCounter(docstring const & name,
+			       string const & lang) const
+{
+	CounterList::const_iterator it = counterList_.find(name);
+	if (it == counterList_.end())
+		return from_ascii("#");
+	Counter const & ctr = it->second;
+
+	docstring const value = theCounter(name, lang);
+	docstring const & format =
+	    translateIfPossible(ctr.prettyFormat(), lang);
+	if (format.empty())
+		return value;
+	return subst(format, from_ascii("##"), value);
+}
+
+
+docstring Counters::currentCounter() const
+{
+	LBUFERR(!counter_stack_.empty());
+	return counter_stack_.back();
+}
+
+
+void Counters::setActiveLayout(Layout const & lay)
+{
+	LASSERT(!layout_stack_.empty(), return);
+	Layout const * const lastlay = layout_stack_.back();
+	// we want to check whether the layout has changed and, if so,
+	// whether we are coming out of or going into an environment.
+	if (!lastlay) {
+		layout_stack_.pop_back();
+		layout_stack_.push_back(&lay);
+		if (lay.isEnvironment())
+			beginEnvironment();
+	} else if (lastlay->name() != lay.name()) {
+		layout_stack_.pop_back();
+		layout_stack_.push_back(&lay);
+		if (lastlay->isEnvironment()) {
+			// we are coming out of an environment
+			// LYXERR0("Out: " << lastlay->name());
+			endEnvironment();
+		}
+		if (lay.isEnvironment()) {
+			// we are going into a new environment
+			// LYXERR0("In: " << lay.name());
+			beginEnvironment();
+		}
+	}
+}
+
+
+void Counters::beginEnvironment()
+{
+	counter_stack_.push_back(counter_stack_.back());
+}
+
+
+void Counters::endEnvironment()
+{
+	LASSERT(!counter_stack_.empty(), return);
+	counter_stack_.pop_back();
+}
+
+
 } // namespace lyx