lyx_mirror/src/insets/InsetIndex.cpp
Jürgen Spitzmüller 71001a8087 Fix bug 6179 ("|" in index entries not embraced in ERT by lyx2lyx).
* OutputParams.{cpp,h}:
	- new param inIndexEntry
* InsetIndex.cpp (latex):
	- set param.
* InsetErt.cpp (plainText):
	- output active chars in IndexInsets

* lib/lyx2lyx/lyx_1_6.py:
	- embrace "|" in ERT when converting old index entries to collapsables.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@31360 a592a061-630c-0410-9148-cb99ea01b6c8
2009-09-10 12:07:42 +00:00

569 lines
14 KiB
C++

/**
* \file InsetIndex.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
* \author Jürgen Spitzmüller
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "InsetIndex.h"
#include "Buffer.h"
#include "BufferParams.h"
#include "BufferView.h"
#include "ColorSet.h"
#include "DispatchResult.h"
#include "Encoding.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
#include "IndicesList.h"
#include "LaTeXFeatures.h"
#include "Lexer.h"
#include "MetricsInfo.h"
#include "sgml.h"
#include "TocBackend.h"
#include "support/debug.h"
#include "support/docstream.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include "frontends/alert.h"
#include <ostream>
using namespace std;
using namespace lyx::support;
namespace lyx {
/////////////////////////////////////////////////////////////////////
//
// InsetIndex
//
///////////////////////////////////////////////////////////////////////
InsetIndex::InsetIndex(Buffer const & buf, InsetIndexParams const & params)
: InsetCollapsable(buf), params_(params)
{}
int InsetIndex::latex(odocstream & os,
OutputParams const & runparams_in) const
{
OutputParams runparams(runparams_in);
runparams.inIndexEntry = true;
if (buffer().masterBuffer()->params().use_indices && !params_.index.empty()
&& params_.index != "idx") {
os << "\\sindex[";
os << params_.index;
os << "]{";
} else {
os << "\\index";
os << '{';
}
int i = 0;
// get contents of InsetText as LaTeX and plaintext
odocstringstream ourlatex;
InsetText::latex(ourlatex, runparams);
odocstringstream ourplain;
InsetText::plaintext(ourplain, runparams);
docstring latexstr = ourlatex.str();
docstring plainstr = ourplain.str();
// this will get what follows | if anything does
docstring cmd;
// check for the | separator
// FIXME This would go wrong on an escaped "|", but
// how far do we want to go here?
size_t pos = latexstr.find(from_ascii("|"));
if (pos != docstring::npos) {
// put the bit after "|" into cmd...
cmd = latexstr.substr(pos + 1);
// ...and erase that stuff from latexstr
latexstr = latexstr.erase(pos);
// ...and similarly from plainstr
size_t ppos = plainstr.find(from_ascii("|"));
if (ppos < plainstr.size())
plainstr.erase(ppos);
else
LYXERR0("The `|' separator was not found in the plaintext version!");
}
// Separate the entires and subentries, i.e., split on "!"
// FIXME This would do the wrong thing with escaped ! characters
std::vector<docstring> const levels =
getVectorFromString(latexstr, from_ascii("!"), true);
std::vector<docstring> const levels_plain =
getVectorFromString(plainstr, from_ascii("!"), true);
vector<docstring>::const_iterator it = levels.begin();
vector<docstring>::const_iterator end = levels.end();
vector<docstring>::const_iterator it2 = levels_plain.begin();
bool first = true;
for (; it != end; ++it) {
// write the separator except the first time
if (!first)
os << '!';
else
first = false;
// correctly sort macros and formatted strings
// if we do find a command, prepend a plain text
// version of the content to get sorting right,
// e.g. \index{LyX@\LyX}, \index{text@\textbf{text}}
// Don't do that if the user entered '@' himself, though.
if (contains(*it, '\\') && !contains(*it, '@')) {
// Plaintext might return nothing (e.g. for ERTs)
docstring const spart =
(it2 < levels_plain.end() && !(*it2).empty())
? *it2 : *it;
// Now we need to validate that all characters in
// the sorting part are representable in the current
// encoding. If not try the LaTeX macro which might
// or might not be a good choice, and issue a warning.
docstring spart2;
for (size_t n = 0; n < spart.size(); ++n) {
try {
spart2 += runparams.encoding->latexChar(spart[n]);
} catch (EncodingException & /* e */) {
LYXERR0("Uncodable character in index entry. Sorting might be wrong!");
}
}
if (spart != spart2 && !runparams.dryrun) {
// FIXME: warning should be passed to the error dialog
frontend::Alert::warning(_("Index sorting failed"),
bformat(_("LyX's automatic index sorting algorithm faced\n"
"problems with the entry '%1$s'.\n"
"Please specify the sorting of this entry manually, as\n"
"explained in the User Guide."), spart));
}
// remove remaining \'s for the sorting part
docstring const ppart =
subst(spart2, from_ascii("\\"), docstring());
os << ppart;
os << '@';
}
docstring const tpart = *it;
os << tpart;
if (it2 < levels_plain.end())
++it2;
}
// write the bit that followed "|"
if (!cmd.empty())
os << "|" << cmd;
os << '}';
return i;
}
int InsetIndex::docbook(odocstream & os, OutputParams const & runparams) const
{
os << "<indexterm><primary>";
int const i = InsetText::docbook(os, runparams);
os << "</primary></indexterm>";
return i;
}
docstring InsetIndex::xhtml(odocstream &, OutputParams const &) const
{
return docstring();
}
bool InsetIndex::showInsetDialog(BufferView * bv) const
{
bv->showDialog("index", params2string(params_),
const_cast<InsetIndex *>(this));
return true;
}
void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
{
switch (cmd.action) {
case LFUN_INSET_MODIFY: {
if (cmd.getArg(0) == "changetype") {
params_.index = from_utf8(cmd.getArg(1));
break;
}
InsetIndexParams params;
InsetIndex::string2params(to_utf8(cmd.argument()), params);
params_.index = params.index;
break;
}
case LFUN_INSET_DIALOG_UPDATE:
cur.bv().updateDialog("index", params2string(params_));
break;
default:
InsetCollapsable::doDispatch(cur, cmd);
break;
}
}
bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const
{
switch (cmd.action) {
case LFUN_INSET_MODIFY:
if (cmd.getArg(0) == "changetype") {
docstring const newtype = from_utf8(cmd.getArg(1));
Buffer const & realbuffer = *buffer().masterBuffer();
IndicesList const & indiceslist = realbuffer.params().indiceslist();
Index const * index = indiceslist.findShortcut(newtype);
flag.setEnabled(index != 0);
flag.setOnOff(
from_utf8(cmd.getArg(1)) == params_.index);
return true;
}
flag.setEnabled(true);
return true;
case LFUN_INSET_DIALOG_UPDATE: {
Buffer const & realbuffer = *buffer().masterBuffer();
flag.setEnabled(realbuffer.params().use_indices);
return true;
}
default:
return InsetCollapsable::getStatus(cur, cmd, flag);
}
}
docstring const InsetIndex::buttonLabel(BufferView const & bv) const
{
docstring s = _("Idx");
if (decoration() == InsetLayout::CLASSIC)
return isOpen(bv) ? s : getNewLabel(s);
else
return getNewLabel(s);
}
ColorCode InsetIndex::labelColor() const
{
if (params_.index.empty() || params_.index == from_ascii("idx"))
return InsetCollapsable::labelColor();
// FIXME UNICODE
ColorCode c = lcolor.getFromLyXName(to_utf8(params_.index));
if (c == Color_none)
c = InsetCollapsable::labelColor();
return c;
}
docstring InsetIndex::toolTip(BufferView const &, int, int) const
{
docstring tip = _("Index Entry");
if (buffer().params().use_indices && !params_.index.empty()) {
Buffer const & realbuffer = *buffer().masterBuffer();
IndicesList const & indiceslist = realbuffer.params().indiceslist();
tip += " (";
Index const * index = indiceslist.findShortcut(params_.index);
if (!index)
tip += _("unknown type!");
else
tip += index->index();
tip += ")";
}
tip += ": ";
OutputParams rp(&buffer().params().encoding());
odocstringstream ods;
InsetText::plaintext(ods, rp);
tip += ods.str();
return wrapParas(tip);
}
void InsetIndex::write(ostream & os) const
{
os << to_utf8(name());
params_.write(os);
InsetCollapsable::write(os);
}
void InsetIndex::read(Lexer & lex)
{
params_.read(lex);
InsetCollapsable::read(lex);
}
string InsetIndex::params2string(InsetIndexParams const & params)
{
ostringstream data;
data << "index";
params.write(data);
return data.str();
}
void InsetIndex::string2params(string const & in, InsetIndexParams & params)
{
params = InsetIndexParams();
if (in.empty())
return;
istringstream data(in);
Lexer lex;
lex.setStream(data);
lex.setContext("InsetIndex::string2params");
lex >> "index";
params.read(lex);
}
void InsetIndex::addToToc(DocIterator const & cpit)
{
DocIterator pit = cpit;
pit.push_back(CursorSlice(*this));
docstring const item = text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
buffer().tocBackend().toc("index").push_back(TocItem(pit, 0, item));
// Proceed with the rest of the inset.
InsetCollapsable::addToToc(cpit);
}
void InsetIndex::validate(LaTeXFeatures & features) const
{
if (buffer().masterBuffer()->params().use_indices
&& !params_.index.empty()
&& params_.index != "idx")
features.require("splitidx");
}
docstring InsetIndex::contextMenu(BufferView const &, int, int) const
{
return from_ascii("context-index");
}
bool InsetIndex::hasSettings() const
{
return buffer().masterBuffer()->params().use_indices;
}
/////////////////////////////////////////////////////////////////////
//
// InsetIndexParams
//
///////////////////////////////////////////////////////////////////////
void InsetIndexParams::write(ostream & os) const
{
os << ' ';
if (!index.empty())
os << to_utf8(index);
else
os << "idx";
os << '\n';
}
void InsetIndexParams::read(Lexer & lex)
{
if (lex.eatLine())
index = lex.getDocString();
else
index = from_ascii("idx");
}
/////////////////////////////////////////////////////////////////////
//
// InsetPrintIndex
//
///////////////////////////////////////////////////////////////////////
InsetPrintIndex::InsetPrintIndex(InsetCommandParams const & p)
: InsetCommand(p, "index_print")
{}
ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
{
static ParamInfo param_info_;
if (param_info_.empty()) {
param_info_.add("type", ParamInfo::LATEX_OPTIONAL);
param_info_.add("name", ParamInfo::LATEX_REQUIRED);
}
return param_info_;
}
docstring InsetPrintIndex::screenLabel() const
{
bool const printall = suffixIs(getCmdName(), '*');
bool const multind = buffer().masterBuffer()->params().use_indices;
if ((!multind
&& getParam("type") == from_ascii("idx"))
|| (getParam("type").empty() && !printall))
return _("Index");
Buffer const & realbuffer = *buffer().masterBuffer();
IndicesList const & indiceslist = realbuffer.params().indiceslist();
Index const * index = indiceslist.findShortcut(getParam("type"));
if (!index && !printall)
return _("Unknown index type!");
docstring res = printall ? _("All indices") : index->index();
if (!multind)
res += " (" + _("non-active") + ")";
else if (contains(getCmdName(), "printsubindex"))
res += " (" + _("subindex") + ")";
return res;
}
bool InsetPrintIndex::isCompatibleCommand(string const & s)
{
return s == "printindex" || s == "printsubindex"
|| s == "printindex*" || s == "printsubindex*";
}
void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
{
switch (cmd.action) {
case LFUN_INSET_MODIFY: {
if (cmd.argument() == from_ascii("toggle-subindex")) {
string cmd = getCmdName();
if (contains(cmd, "printindex"))
cmd = subst(cmd, "printindex", "printsubindex");
else
cmd = subst(cmd, "printsubindex", "printindex");
setCmdName(cmd);
break;
} else if (cmd.argument() == from_ascii("check-printindex*")) {
string cmd = getCmdName();
if (suffixIs(cmd, '*'))
break;
cmd += '*';
setParam("type", docstring());
setCmdName(cmd);
break;
}
InsetCommandParams p(INDEX_PRINT_CODE);
// FIXME UNICODE
InsetCommand::string2params("index_print",
to_utf8(cmd.argument()), p);
if (p.getCmdName().empty()) {
cur.noUpdate();
break;
}
setParams(p);
break;
}
default:
InsetCommand::doDispatch(cur, cmd);
break;
}
}
bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & status) const
{
switch (cmd.action) {
case LFUN_INSET_MODIFY: {
if (cmd.argument() == from_ascii("toggle-subindex")) {
status.setEnabled(buffer().masterBuffer()->params().use_indices);
status.setOnOff(contains(getCmdName(), "printsubindex"));
return true;
} else if (cmd.argument() == from_ascii("check-printindex*")) {
status.setEnabled(buffer().masterBuffer()->params().use_indices);
status.setOnOff(suffixIs(getCmdName(), '*'));
return true;
} if (cmd.getArg(0) == "index_print"
&& cmd.getArg(1) == "CommandInset") {
InsetCommandParams p(INDEX_PRINT_CODE);
InsetCommand::string2params("index_print",
to_utf8(cmd.argument()), p);
if (suffixIs(p.getCmdName(), '*')) {
status.setEnabled(true);
status.setOnOff(false);
return true;
}
Buffer const & realbuffer = *buffer().masterBuffer();
IndicesList const & indiceslist =
realbuffer.params().indiceslist();
Index const * index = indiceslist.findShortcut(p["type"]);
status.setEnabled(index != 0);
status.setOnOff(p["type"] == getParam("type"));
return true;
} else
return InsetCommand::getStatus(cur, cmd, status);
}
case LFUN_INSET_DIALOG_UPDATE: {
status.setEnabled(buffer().masterBuffer()->params().use_indices);
return true;
}
default:
return InsetCommand::getStatus(cur, cmd, status);
}
}
int InsetPrintIndex::latex(odocstream & os, OutputParams const &) const
{
if (!buffer().masterBuffer()->params().use_indices) {
if (getParam("type") == from_ascii("idx"))
os << "\\printindex{}";
return 0;
}
os << getCommand();
return 0;
}
void InsetPrintIndex::validate(LaTeXFeatures & features) const
{
features.require("makeidx");
if (buffer().masterBuffer()->params().use_indices)
features.require("splitidx");
}
docstring InsetPrintIndex::contextMenu(BufferView const &, int, int) const
{
return buffer().masterBuffer()->params().use_indices ?
from_ascii("context-indexprint") : docstring();
}
bool InsetPrintIndex::hasSettings() const
{
return buffer().masterBuffer()->params().use_indices;
}
docstring InsetPrintIndex::xhtml(odocstream &, OutputParams const &) const
{
return docstring();
}
} // namespace lyx