X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCounters.cpp;h=0133f76bcab455f876c0f05631641313d09dfe32;hb=4ed0312c51704780af1c452d3a82a84171b3725a;hp=b7e473a2a2f28d5e48ce53b5099e80f9779ab332;hpb=af905aaff68c12ab5a2fd8a4fbd49b6d38888552;p=lyx.git

diff --git a/src/Counters.cpp b/src/Counters.cpp
index b7e473a2a2..0133f76bca 100644
--- a/src/Counters.cpp
+++ b/src/Counters.cpp
@@ -6,7 +6,7 @@
  * \author Lars Gullik Bjønnes
  * \author Martin Vermeer
  * \author André Pönitz
- * \author Richard Heck (roman numerals)
+ * \author Richard Kimberly Heck (roman numerals)
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -14,10 +14,13 @@
 #include <config.h>
 
 #include "Counters.h"
+#include "Layout.h"
 #include "Lexer.h"
 
 #include "support/convert.h"
+#include "support/counter_reps.h"
 #include "support/debug.h"
+#include "support/docstring.h"
 #include "support/gettext.h"
 #include "support/lassert.h"
 #include "support/lstrings.h"
@@ -32,14 +35,16 @@ namespace lyx {
 
 
 Counter::Counter()
+	: initial_value_(0), saved_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, docstring const & guiname)
+	: initial_value_(0), saved_value_(0), parent_(mc), labelstring_(ls),
+	  labelstringappendix_(lsa), guiname_(guiname)
 {
 	reset();
 }
@@ -51,13 +56,21 @@ bool Counter::read(Lexer & lex)
 		CT_WITHIN = 1,
 		CT_LABELSTRING,
 		CT_LABELSTRING_APPENDIX,
+		CT_PRETTYFORMAT,
+		CT_INITIALVALUE,
+		CT_GUINAME,
+		CT_LATEXNAME,
 		CT_END
 	};
 
 	LexerKeyword counterTags[] = {
 		{ "end", CT_END },
+		{ "guiname", CT_GUINAME },
+		{ "initialvalue", CT_INITIALVALUE},
 		{ "labelstring", CT_LABELSTRING },
 		{ "labelstringappendix", CT_LABELSTRING_APPENDIX },
+		{ "latexname", CT_LATEXNAME },
+		{ "prettyformat", CT_PRETTYFORMAT },
 		{ "within", CT_WITHIN }
 	};
 
@@ -70,15 +83,31 @@ bool Counter::read(Lexer & lex)
 			case Lexer::LEX_UNDEF:
 				lex.printError("Unknown counter tag `$$Token'");
 				continue;
-			default: 
+			default:
 				break;
 		}
 		switch (le) {
 			case CT_WITHIN:
 				lex.next();
-				master_ = lex.getDocString();
-				if (master_ == "none")
-					master_.erase();
+				parent_ = lex.getDocString();
+				if (parent_ == "none")
+					parent_.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();
@@ -89,6 +118,14 @@ bool Counter::read(Lexer & lex)
 				lex.next();
 				labelstringappendix_ = lex.getDocString();
 				break;
+			case CT_GUINAME:
+				lex.next();
+				guiname_ = lex.getDocString();
+				break;
+			case CT_LATEXNAME:
+				lex.next();
+				latexname_ = lex.getDocString();
+				break;
 			case CT_END:
 				getout = true;
 				break;
@@ -102,6 +139,7 @@ bool Counter::read(Lexer & lex)
 	return getout;
 }
 
+
 void Counter::set(int v)
 {
 	value_ = v;
@@ -120,6 +158,18 @@ int Counter::value() const
 }
 
 
+void Counter::saveValue()
+{
+	saved_value_ = value_;
+}
+
+
+void Counter::restoreValue()
+{
+	value_ = saved_value_;
+}
+
+
 void Counter::step()
 {
 	++value_;
@@ -128,13 +178,22 @@ void Counter::step()
 
 void Counter::reset()
 {
-	value_ = 0;
+	value_ = initial_value_;
+}
+
+
+docstring const & Counter::parent() const
+{
+	return parent_;
 }
 
 
-docstring const & Counter::master() const
+bool Counter::checkAndRemoveParent(docstring const & cnt)
 {
-	return master_;
+	if (parent_ != cnt)
+		return false;
+	parent_ = docstring();
+	return true;
 }
 
 
@@ -150,18 +209,26 @@ Counter::StringMap & Counter::flatLabelStrings(bool in_appendix) const
 }
 
 
+Counters::Counters() : appendix_(false), subfloat_(false), longtable_(false)
+{
+	layout_stack_.push_back(nullptr);
+	counter_stack_.push_back(from_ascii(""));
+}
+
+
 void Counters::newCounter(docstring const & newc,
-			  docstring const & masterc, 
+			  docstring const & parentc,
 			  docstring const & ls,
-			  docstring const & lsa)
+			  docstring const & lsa,
+			  docstring const & guiname)
 {
-	if (!masterc.empty() && !hasCounter(masterc)) {
-		lyxerr << "Master counter does not exist: "
-		       << to_utf8(masterc)
+	if (!parentc.empty() && !hasCounter(parentc)) {
+		lyxerr << "Parent counter does not exist: "
+			   << to_utf8(parentc)
 		       << endl;
 		return;
 	}
-	counterList_[newc] = Counter(masterc, ls, lsa);
+	counterList_[newc] = Counter(parentc, ls, lsa, guiname);
 }
 
 
@@ -171,18 +238,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,163 +293,157 @@ int Counters::value(docstring const & ctr) const
 }
 
 
-void Counters::step(docstring const & ctr)
+void Counters::saveValue(docstring const & ctr) const
 {
-	CounterList::iterator it = counterList_.find(ctr);
-	if (it == counterList_.end()) {
-		lyxerr << "step: Counter does not exist: "
+	CounterList::const_iterator const cit = counterList_.find(ctr);
+	if (cit == counterList_.end()) {
+		lyxerr << "value: Counter does not exist: "
 		       << to_utf8(ctr) << endl;
 		return;
 	}
+	Counter const & cnt = cit->second;
+	Counter & ccnt = const_cast<Counter &>(cnt);
+	ccnt.saveValue();
+}
 
-	it->second.step();
-	it = counterList_.begin();
-	CounterList::iterator const end = counterList_.end();
-	for (; it != end; ++it) {
-		if (it->second.master() == ctr) {
-			it->second.reset();
+
+void Counters::restoreValue(docstring const & ctr) const
+{
+	CounterList::const_iterator const cit = counterList_.find(ctr);
+	if (cit == counterList_.end()) {
+		lyxerr << "value: Counter does not exist: "
+		       << to_utf8(ctr) << endl;
+		return;
+	}
+	Counter const & cnt = cit->second;
+	Counter & ccnt = const_cast<Counter &>(cnt);
+	ccnt.restoreValue();
+}
+
+
+void Counters::resetChildren(docstring const & count)
+{
+	for (auto & ctr : counterList_) {
+		if (ctr.second.parent() == count) {
+			ctr.second.reset();
+			resetChildren(ctr.first);
 		}
 	}
 }
 
 
-void Counters::reset()
+void Counters::stepParent(docstring const & ctr, UpdateType utype)
 {
-	appendix_ = false;
-	subfloat_ = false;
-	current_float_.erase();
-	CounterList::iterator it = counterList_.begin();
-	CounterList::iterator const end = counterList_.end();
-	for (; it != end; ++it)
-		it->second.reset();
+	CounterList::iterator it = counterList_.find(ctr);
+	if (it == counterList_.end()) {
+		lyxerr << "step: Counter does not exist: "
+		       << to_utf8(ctr) << endl;
+		return;
+	}
+	step(it->second.parent(), utype);
 }
 
 
-void Counters::reset(docstring const & match)
+void Counters::step(docstring const & ctr, UpdateType utype)
 {
-	LASSERT(!match.empty(), /**/);
+	CounterList::iterator it = counterList_.find(ctr);
+	if (it == counterList_.end()) {
+		lyxerr << "step: Counter does not exist: "
+		       << to_utf8(ctr) << endl;
+		return;
+	}
 
-	CounterList::iterator it = counterList_.begin();
-	CounterList::iterator end = counterList_.end();
-	for (; it != end; ++it) {
-		if (it->first.find(match) != string::npos)
-			it->second.reset();
+	it->second.step();
+	if (utype == OutputUpdate) {
+		LBUFERR(!counter_stack_.empty());
+		counter_stack_.pop_back();
+		counter_stack_.push_back(ctr);
 	}
+
+	resetChildren(ctr);
 }
 
 
-void Counters::copy(Counters & from, Counters & to, docstring const & match)
+docstring const & Counters::guiName(docstring const & cntr) const
 {
-	CounterList::iterator it = counterList_.begin();
-	CounterList::iterator end = counterList_.end();
-	for (; it != end; ++it) {
-		if (it->first.find(match) != string::npos || match == "") {
-			to.set(it->first, from.value(it->first));
-		}
+	CounterList::const_iterator it = counterList_.find(cntr);
+	if (it == counterList_.end()) {
+		lyxerr << "step: Counter does not exist: "
+			   << to_utf8(cntr) << endl;
+		return empty_docstring();
 	}
-}
 
+	docstring const & guiname = it->second.guiName();
+	if (guiname.empty())
+		return cntr;
+	return guiname;
+}
 
-namespace {
 
-char loweralphaCounter(int const n)
+docstring const & Counters::latexName(docstring const & cntr) const
 {
-	if (n < 1 || n > 26)
-		return '?';
-	return 'a' + n - 1;
+	CounterList::const_iterator it = counterList_.find(cntr);
+	if (it == counterList_.end()) {
+		lyxerr << "step: Counter does not exist: "
+			   << to_utf8(cntr) << endl;
+		return empty_docstring();
+	}
+
+	docstring const & latexname = it->second.latexName();
+	if (latexname.empty())
+		return cntr;
+	return latexname;
 }
 
 
-char alphaCounter(int const n)
+void Counters::reset()
 {
-	if (n < 1 || n > 26)
-		return '?';
-	return 'A' + n - 1;
+	appendix_ = false;
+	subfloat_ = false;
+	current_float_.erase();
+	for (auto & ctr : counterList_)
+		ctr.second.reset();
+	counter_stack_.clear();
+	counter_stack_.push_back(from_ascii(""));
+	layout_stack_.clear();
+	layout_stack_.push_back(nullptr);
 }
 
 
-char hebrewCounter(int const n)
+void Counters::reset(docstring const & match)
 {
-	static const char hebrew[22] = {
-		'\xe0', '\xe1', '\xe2', '\xe3', '\xe4', '\xe5', '\xe6', '\xe7', '\xe8',
-		'\xe9', '\xeb', '\xec', '\xee', '\xf0', '\xf1', '\xf2', '\xf4', '\xf6',
-		'\xf7', '\xf8', '\xf9', '\xfa'
-	};
+	LASSERT(!match.empty(), return);
 
-	if (n < 1 || n > 22)
-		return '?';
-	return hebrew[n - 1];
+	for (auto & ctr : counterList_) {
+		if (ctr.first.find(match) != string::npos)
+			ctr.second.reset();
+	}
 }
 
 
-
-// On the special cases, see http://mathworld.wolfram.com/RomanNumerals.html
-// 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)
+bool Counters::copy(docstring const & cnt, docstring const & newcnt)
 {
-	static char const * const ones[9] = {
-		"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) 
-		return from_ascii("??");
-	
-	int val = n;
-	string roman;
-	switch (n) {
-	//special cases
-	case 900: 
-		roman = "CM";
-		break;
-	case 400:
-		roman = "CD";
-		break;
-	default:
-		if (val >= 100) {
-			int hundreds = val / 100;
-			roman = hunds[hundreds - 1];
-			val = val % 100;
-		}
-		if (val >= 10) {
-			switch (val) {
-			//special case
-			case 90:
-				roman = roman + "XC";
-				val = 0; //skip next
-				break;
-			default:
-				int tensnum = val / 10;
-				roman = roman + tens[tensnum - 1];
-				val = val % 10;
-			} // end switch
-		} // end tens
-		if (val > 0)
-			roman = roman + ones[val -1];
-	}
-	return from_ascii(roman);
+	auto const it =	counterList_.find(cnt);
+	if (it == counterList_.end())
+		return false;
+	counterList_[newcnt] = it->second;
+	return true;
 }
 
 
-docstring const lowerromanCounter(int const n)
+bool Counters::remove(docstring const & cnt)
 {
-	return lowercase(romanCounter(n));
+	bool retval = counterList_.erase(cnt);
+	if (!retval)
+		return false;
+	for (auto & ctr : counterList_) {
+		if (ctr.second.checkAndRemoveParent(cnt))
+			LYXERR(Debug::TCLASS, "Removed parent counter `" +
+					to_utf8(cnt) + "' from counter: " + to_utf8(ctr.first));
+	}
+	return retval;
 }
 
-} // namespace anon
-
 
 docstring Counters::labelItem(docstring const & ctr,
 			      docstring const & numbertype) const
@@ -410,6 +473,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 +483,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 +500,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,18 +512,18 @@ 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);
 
 	callers.push_back(counter);
 	if (ls.empty()) {
-		if (!c.master().empty())
-			ls = flattenLabelString(c.master(), in_appendix, lang, callers) 
+		if (!c.parent().empty())
+			ls = flattenLabelString(c.parent(), in_appendix, lang, callers)
 				+ from_ascii(".");
 		callers.pop_back();
 		return ls + from_ascii("\\arabic{") + counter + "}";
@@ -472,7 +536,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);
@@ -501,7 +565,7 @@ docstring Counters::counterLabel(docstring const & format,
 			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, j, k - j);
@@ -528,4 +592,77 @@ docstring Counters::counterLabel(docstring const & format,
 }
 
 
+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();
+}
+
+
+vector<docstring> Counters::listOfCounters() const {
+	vector<docstring> ret;
+	for(auto const & k : counterList_)
+		ret.emplace_back(k.first);
+	return ret;
+}
+
+
 } // namespace lyx