1 /**
2  * \file InsetFlex.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Angus Leeming
7  * \author Martin Vermeer
8  * \author Jürgen Spitzmüller
9  *
10  * Full author contact details are available in file CREDITS.
11  */
12 
13 #include <config.h>
14 
15 #include "InsetFlex.h"
16 
17 #include "Buffer.h"
18 #include "BufferParams.h"
19 #include "Cursor.h"
20 #include "FuncRequest.h"
21 #include "FuncStatus.h"
22 #include "Language.h"
23 #include "Lexer.h"
24 #include "ParIterator.h"
25 #include "TextClass.h"
26 
27 #include "support/gettext.h"
28 #include "support/lstrings.h"
29 
30 #include <ostream>
31 
32 using namespace std;
33 
34 namespace lyx {
35 
36 
InsetFlex(Buffer * buf,string const & layoutName)37 InsetFlex::InsetFlex(Buffer * buf, string const & layoutName)
38 	: InsetCollapsible(buf), name_(layoutName)
39 {}
40 
41 
InsetFlex(InsetFlex const & in)42 InsetFlex::InsetFlex(InsetFlex const & in)
43 	: InsetCollapsible(in), name_(in.name_)
44 {}
45 
46 
47 // special code for InsetFlex when there is not the explicit Flex:: prefix
getLayout() const48 InsetLayout const & InsetFlex::getLayout() const
49 {
50 	if (!buffer_)
51 		return DocumentClass::plainInsetLayout();
52 
53 	DocumentClass const & dc = buffer().params().documentClass();
54 	docstring const dname = from_utf8(name_);
55 	if (dc.hasInsetLayout(dname))
56 		return dc.insetLayout(dname);
57 	return dc.insetLayout(from_utf8("Flex:" + name_));
58 }
59 
60 
decoration() const61 InsetLayout::InsetDecoration InsetFlex::decoration() const
62 {
63 	InsetLayout::InsetDecoration const dec = getLayout().decoration();
64 	return dec == InsetLayout::DEFAULT ? InsetLayout::CONGLOMERATE : dec;
65 }
66 
67 
write(ostream & os) const68 void InsetFlex::write(ostream & os) const
69 {
70 	os << "Flex ";
71 	string name;
72 	if (name_.empty())
73 		name = "undefined";
74 	else {
75 		InsetLayout const & il = getLayout();
76 		// use il.name(), since this resolves obsoleted InsetLayout names
77 		if (il.name() == "undefined")
78 			// This is the name of the plain_insetlayout_. We assume that the
79 			// name resolution has failed.
80 			name = name_;
81 		else {
82 			name = to_utf8(il.name());
83 			// Remove the "Flex:" prefix, if it is present
84 			if (support::prefixIs(name, "Flex:"))
85 				name = support::split(name, ':');
86 		}
87 	}
88 	os << name << "\n";
89 	InsetCollapsible::write(os);
90 }
91 
92 
getStatus(Cursor & cur,FuncRequest const & cmd,FuncStatus & flag) const93 bool InsetFlex::getStatus(Cursor & cur, FuncRequest const & cmd,
94 		FuncStatus & flag) const
95 {
96 	switch (cmd.action()) {
97 	case LFUN_INSET_DISSOLVE:
98 		if (!cmd.argument().empty()) {
99 			InsetLayout const & il = getLayout();
100 			InsetLayout::InsetLyXType const type =
101 				translateLyXType(to_utf8(cmd.argument()));
102 			if (il.lyxtype() == type
103 			    || (il.name() == DocumentClass::plainInsetLayout().name()
104 				    && type == InsetLayout::CHARSTYLE)) {
105 				FuncRequest temp_cmd(LFUN_INSET_DISSOLVE);
106 				return InsetCollapsible::getStatus(cur, temp_cmd, flag);
107 			} else
108 				return false;
109 		}
110 		// fall-through
111 	default:
112 		return InsetCollapsible::getStatus(cur, cmd, flag);
113 	}
114 }
115 
116 
doDispatch(Cursor & cur,FuncRequest & cmd)117 void InsetFlex::doDispatch(Cursor & cur, FuncRequest & cmd)
118 {
119 	switch (cmd.action()) {
120 	case LFUN_INSET_DISSOLVE:
121 		if (!cmd.argument().empty()) {
122 			InsetLayout const & il = getLayout();
123 			InsetLayout::InsetLyXType const type =
124 				translateLyXType(to_utf8(cmd.argument()));
125 
126 			if (il.lyxtype() == type
127 			    || (il.name() == DocumentClass::plainInsetLayout().name()
128 				    && type == InsetLayout::CHARSTYLE)) {
129 				FuncRequest temp_cmd(LFUN_INSET_DISSOLVE);
130 				InsetCollapsible::doDispatch(cur, temp_cmd);
131 			} else
132 				cur.undispatched();
133 			break;
134 		}
135 		// fall-through
136 	default:
137 		InsetCollapsible::doDispatch(cur, cmd);
138 		break;
139 	}
140 }
141 
142 
updateBuffer(ParIterator const & it,UpdateType utype)143 void InsetFlex::updateBuffer(ParIterator const & it, UpdateType utype)
144 {
145 	BufferParams const & bp = buffer().masterBuffer()->params();
146 	InsetLayout const & il = getLayout();
147 	docstring custom_label = translateIfPossible(il.labelstring());
148 
149 	Counters & cnts = bp.documentClass().counters();
150 	docstring const & count = il.counter();
151 	bool const have_counter = cnts.hasCounter(count);
152 	if (have_counter) {
153 		Paragraph const & par = it.paragraph();
154 		if (!par.isDeleted(it.pos())) {
155 			cnts.step(count, utype);
156 			custom_label += ' ' +
157 				cnts.theCounter(count, it.paragraph().getParLanguage(bp)->code());
158 		} else
159 			custom_label += ' ' + from_ascii("#");
160 	}
161 	setLabel(custom_label);
162 
163 	bool const save_counter = have_counter && utype == OutputUpdate;
164 	if (save_counter) {
165 		// we assume the counter is local to this inset
166 		// if this turns out to be wrong in some case, we will
167 		// need a layout flag
168 		cnts.saveLastCounter();
169 	}
170 	InsetCollapsible::updateBuffer(it, utype);
171 	if (save_counter)
172 		cnts.restoreLastCounter();
173 }
174 
175 
176 } // namespace lyx
177