mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-13 14:32:04 +00:00
2a47858dda
file has been changed to "space" to match the identifier used for the inset in
Inset.cpp and for the dialog in GuiView.cpp.
In future, we will want to get a similar uniformity elsewhere: The identifier
used in the LyX file should match the one used as inset identifier. The easy
way to do this, in the code, is to have insets write themselves this way:
os << insetName(lyxCode()) << " ";
rather than at present:
os << "space ";
Similar things could then happen elsewhere. E.g., if the dialog names are in
sync with the inset names, then we could do something like:
hideDialogs(insetName(lyxCode()), this);
rather than
hideDialogs("space", this);
and perhaps even put that into the Inset destructor rather than have specific
versions in each inset---with a test for whether there is such a dialog, of
course.
But this is all for later.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@25016 a592a061-630c-0410-9148-cb99ea01b6c8
590 lines
16 KiB
C++
590 lines
16 KiB
C++
/**
|
|
* \file factory.cpp
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author André Pönitz
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#include <config.h>
|
|
|
|
#include "factory.h"
|
|
|
|
#include "Buffer.h"
|
|
#include "BufferParams.h"
|
|
#include "FloatList.h"
|
|
#include "FuncRequest.h"
|
|
#include "Lexer.h"
|
|
#include "LyX.h"
|
|
#include "TextClass.h"
|
|
|
|
#include "insets/InsetBibitem.h"
|
|
#include "insets/InsetBibtex.h"
|
|
#include "insets/InsetCaption.h"
|
|
#include "insets/InsetCitation.h"
|
|
#include "insets/InsetFlex.h"
|
|
#include "insets/InsetEnvironment.h"
|
|
#include "insets/InsetERT.h"
|
|
#include "insets/InsetListings.h"
|
|
#include "insets/InsetExternal.h"
|
|
#include "insets/InsetFloat.h"
|
|
#include "insets/InsetFloatList.h"
|
|
#include "insets/InsetFoot.h"
|
|
#include "insets/InsetGraphics.h"
|
|
#include "insets/InsetInclude.h"
|
|
#include "insets/InsetIndex.h"
|
|
#include "insets/InsetInfo.h"
|
|
#include "insets/InsetNomencl.h"
|
|
#include "insets/InsetLabel.h"
|
|
#include "insets/InsetLine.h"
|
|
#include "insets/InsetMarginal.h"
|
|
#include "insets/InsetNewline.h"
|
|
#include "insets/InsetNewpage.h"
|
|
#include "insets/InsetNote.h"
|
|
#include "insets/InsetBox.h"
|
|
#include "insets/InsetBranch.h"
|
|
#include "insets/InsetOptArg.h"
|
|
#include "insets/InsetNewpage.h"
|
|
#include "insets/InsetRef.h"
|
|
#include "insets/InsetSpace.h"
|
|
#include "insets/InsetTabular.h"
|
|
#include "insets/InsetTOC.h"
|
|
#include "insets/InsetHyperlink.h"
|
|
#include "insets/InsetVSpace.h"
|
|
#include "insets/InsetWrap.h"
|
|
|
|
#include "mathed/MathMacroTemplate.h"
|
|
#include "mathed/InsetMathHull.h"
|
|
|
|
#include "frontends/alert.h"
|
|
|
|
#include "support/debug.h"
|
|
#include "support/lstrings.h"
|
|
#include "support/ExceptionMessage.h"
|
|
|
|
#include "support/lassert.h"
|
|
|
|
#include <sstream>
|
|
|
|
using namespace std;
|
|
using namespace lyx::support;
|
|
|
|
namespace lyx {
|
|
|
|
namespace Alert = frontend::Alert;
|
|
|
|
|
|
Inset * createInsetHelper(Buffer & buf, FuncRequest const & cmd)
|
|
{
|
|
BufferParams const & params = buf.params();
|
|
|
|
try {
|
|
|
|
switch (cmd.action) {
|
|
|
|
case LFUN_LINE_INSERT:
|
|
return new InsetLine;
|
|
|
|
case LFUN_NEWPAGE_INSERT: {
|
|
string const name = cmd.getArg(0);
|
|
InsetNewpageParams inp;
|
|
if (name.empty() || name == "newpage")
|
|
inp.kind = InsetNewpageParams::NEWPAGE;
|
|
else if (name == "pagebreak")
|
|
inp.kind = InsetNewpageParams::PAGEBREAK;
|
|
else if (name == "clearpage")
|
|
inp.kind = InsetNewpageParams::CLEARPAGE;
|
|
else if (name == "cleardoublepage")
|
|
inp.kind = InsetNewpageParams::CLEARDOUBLEPAGE;
|
|
return new InsetNewpage(inp);
|
|
}
|
|
|
|
case LFUN_FLEX_INSERT: {
|
|
string s = cmd.getArg(0);
|
|
return new InsetFlex(buf, s);
|
|
}
|
|
|
|
case LFUN_NOTE_INSERT: {
|
|
string arg = cmd.getArg(0);
|
|
if (arg.empty())
|
|
arg = "Note";
|
|
return new InsetNote(buf, arg);
|
|
}
|
|
|
|
case LFUN_BOX_INSERT: {
|
|
string arg = cmd.getArg(0);
|
|
if (arg.empty())
|
|
arg = "Boxed";
|
|
return new InsetBox(buf, arg);
|
|
}
|
|
|
|
case LFUN_BRANCH_INSERT: {
|
|
docstring arg = cmd.argument();
|
|
if (arg.empty())
|
|
arg = from_ascii("none");
|
|
return new InsetBranch(buf, InsetBranchParams(arg));
|
|
}
|
|
|
|
case LFUN_ERT_INSERT:
|
|
return new InsetERT(buf);
|
|
|
|
case LFUN_LISTING_INSERT:
|
|
return new InsetListings(buf);
|
|
|
|
case LFUN_FOOTNOTE_INSERT:
|
|
return new InsetFoot(buf);
|
|
|
|
case LFUN_MARGINALNOTE_INSERT:
|
|
return new InsetMarginal(buf);
|
|
|
|
case LFUN_OPTIONAL_INSERT:
|
|
return new InsetOptArg(buf);
|
|
|
|
case LFUN_BIBITEM_INSERT:
|
|
return new InsetBibitem(InsetCommandParams(BIBITEM_CODE));
|
|
|
|
case LFUN_FLOAT_INSERT: {
|
|
// check if the float type exists
|
|
string const argument = to_utf8(cmd.argument());
|
|
if (buf.params().documentClass().floats().typeExist(argument))
|
|
return new InsetFloat(buf, argument);
|
|
lyxerr << "Non-existent float type: " << argument << endl;
|
|
}
|
|
|
|
case LFUN_FLOAT_WIDE_INSERT: {
|
|
// check if the float type exists
|
|
string const argument = to_utf8(cmd.argument());
|
|
if (params.documentClass().floats().typeExist(argument)) {
|
|
auto_ptr<InsetFloat> p(new InsetFloat(buf, argument));
|
|
p->setWide(true, params);
|
|
return p.release();
|
|
}
|
|
lyxerr << "Non-existent float type: " << argument << endl;
|
|
return 0;
|
|
}
|
|
|
|
case LFUN_WRAP_INSERT: {
|
|
string const argument = to_utf8(cmd.argument());
|
|
if (argument == "figure" || argument == "table")
|
|
return new InsetWrap(buf, argument);
|
|
lyxerr << "Non-existent wrapfig type: " << argument << endl;
|
|
return 0;
|
|
}
|
|
|
|
case LFUN_INDEX_INSERT:
|
|
return new InsetIndex(buf);
|
|
|
|
case LFUN_NOMENCL_INSERT: {
|
|
InsetCommandParams icp(NOMENCL_CODE);
|
|
icp["symbol"] = cmd.argument();
|
|
return new InsetNomencl(icp);
|
|
}
|
|
|
|
case LFUN_TABULAR_INSERT: {
|
|
if (cmd.argument().empty())
|
|
return 0;
|
|
istringstream ss(to_utf8(cmd.argument()));
|
|
int r = 0, c = 0;
|
|
ss >> r >> c;
|
|
if (r <= 0)
|
|
r = 2;
|
|
if (c <= 0)
|
|
c = 2;
|
|
return new InsetTabular(buf, r, c);
|
|
}
|
|
|
|
case LFUN_CAPTION_INSERT:
|
|
return new InsetCaption(buf);
|
|
|
|
case LFUN_INDEX_PRINT:
|
|
return new InsetPrintIndex(InsetCommandParams(INDEX_PRINT_CODE));
|
|
|
|
case LFUN_NOMENCL_PRINT:
|
|
return new InsetPrintNomencl(InsetCommandParams(NOMENCL_PRINT_CODE));
|
|
|
|
case LFUN_TOC_INSERT:
|
|
return new InsetTOC(InsetCommandParams(TOC_CODE));
|
|
|
|
case LFUN_ENVIRONMENT_INSERT:
|
|
return new InsetEnvironment(buf, cmd.argument());
|
|
|
|
case LFUN_INFO_INSERT: {
|
|
InsetInfo * inset = new InsetInfo(buf, to_utf8(cmd.argument()));
|
|
inset->updateInfo();
|
|
return inset;
|
|
}
|
|
|
|
case LFUN_INSET_INSERT: {
|
|
string const name = cmd.getArg(0);
|
|
InsetCode code = insetCode(name);
|
|
switch (code) {
|
|
case NO_CODE:
|
|
lyxerr << "No such inset '" << name << "'.";
|
|
return 0;
|
|
|
|
case BIBITEM_CODE: {
|
|
InsetCommandParams icp(code);
|
|
InsetCommand::string2params(name, to_utf8(cmd.argument()), icp);
|
|
return new InsetBibitem(icp);
|
|
}
|
|
|
|
case BIBTEX_CODE: {
|
|
InsetCommandParams icp(code);
|
|
InsetCommand::string2params(name, to_utf8(cmd.argument()), icp);
|
|
return new InsetBibtex(icp);
|
|
}
|
|
|
|
case CITE_CODE: {
|
|
InsetCommandParams icp(code);
|
|
InsetCommand::string2params(name, to_utf8(cmd.argument()), icp);
|
|
return new InsetCitation(icp);
|
|
}
|
|
|
|
case ERT_CODE: {
|
|
return new InsetERT(buf,
|
|
InsetERT::string2params(to_utf8(cmd.argument())));
|
|
}
|
|
|
|
case LISTINGS_CODE: {
|
|
InsetListingsParams par;
|
|
InsetListings::string2params(to_utf8(cmd.argument()), par);
|
|
return new InsetListings(buf, par);
|
|
}
|
|
|
|
case EXTERNAL_CODE: {
|
|
InsetExternalParams iep;
|
|
InsetExternal::string2params(to_utf8(cmd.argument()), buf, iep);
|
|
auto_ptr<InsetExternal> inset(new InsetExternal(buf));
|
|
inset->setBuffer(buf);
|
|
inset->setParams(iep);
|
|
return inset.release();
|
|
}
|
|
|
|
case GRAPHICS_CODE: {
|
|
InsetGraphicsParams igp;
|
|
InsetGraphics::string2params(to_utf8(cmd.argument()), buf, igp);
|
|
auto_ptr<InsetGraphics> inset(new InsetGraphics(buf));
|
|
inset->setParams(igp);
|
|
return inset.release();
|
|
}
|
|
|
|
case HYPERLINK_CODE: {
|
|
InsetCommandParams icp(code);
|
|
InsetCommand::string2params(name, to_utf8(cmd.argument()), icp);
|
|
return new InsetHyperlink(icp);
|
|
}
|
|
|
|
case INCLUDE_CODE: {
|
|
InsetCommandParams icp(code);
|
|
InsetCommand::string2params(name, to_utf8(cmd.argument()), icp);
|
|
return new InsetInclude(icp);
|
|
}
|
|
|
|
case INDEX_CODE:
|
|
return new InsetIndex(buf);
|
|
|
|
case NOMENCL_CODE: {
|
|
InsetCommandParams icp(code);
|
|
InsetCommand::string2params(name, lyx::to_utf8(cmd.argument()), icp);
|
|
return new InsetNomencl(icp);
|
|
}
|
|
|
|
case LABEL_CODE: {
|
|
InsetCommandParams icp(code);
|
|
InsetCommand::string2params(name, to_utf8(cmd.argument()), icp);
|
|
return new InsetLabel(icp);
|
|
}
|
|
|
|
case REF_CODE: {
|
|
InsetCommandParams icp(code);
|
|
InsetCommand::string2params(name, to_utf8(cmd.argument()), icp);
|
|
return new InsetRef(buf, icp);
|
|
}
|
|
|
|
case SPACE_CODE: {
|
|
InsetSpaceParams isp;
|
|
InsetSpace::string2params(to_utf8(cmd.argument()), isp);
|
|
return new InsetSpace(isp);
|
|
}
|
|
|
|
case TOC_CODE: {
|
|
InsetCommandParams icp(code);
|
|
InsetCommand::string2params(name, to_utf8(cmd.argument()), icp);
|
|
return new InsetTOC(icp);
|
|
}
|
|
|
|
case VSPACE_CODE: {
|
|
VSpace vspace;
|
|
InsetVSpace::string2params(to_utf8(cmd.argument()), vspace);
|
|
return new InsetVSpace(vspace);
|
|
}
|
|
|
|
default:
|
|
lyxerr << "Inset '" << name << "' not permitted with LFUN_INSET_INSERT."
|
|
<< endl;
|
|
return 0;
|
|
|
|
}
|
|
} //end LFUN_INSET_INSERT
|
|
|
|
case LFUN_SPACE_INSERT: {
|
|
string const name = cmd.getArg(0);
|
|
string const len = cmd.getArg(1);
|
|
if (name.empty()) {
|
|
lyxerr << "LyX function 'space-insert' needs an argument." << endl;
|
|
break;
|
|
}
|
|
InsetSpaceParams isp;
|
|
if (name == "normal")
|
|
isp.kind = InsetSpaceParams::NORMAL;
|
|
else if (name == "protected")
|
|
isp.kind = InsetSpaceParams::PROTECTED;
|
|
else if (name == "thin")
|
|
isp.kind = InsetSpaceParams::THIN;
|
|
else if (name == "quad")
|
|
isp.kind = InsetSpaceParams::QUAD;
|
|
else if (name == "qquad")
|
|
isp.kind = InsetSpaceParams::QQUAD;
|
|
else if (name == "enspace")
|
|
isp.kind = InsetSpaceParams::ENSPACE;
|
|
else if (name == "enskip")
|
|
isp.kind = InsetSpaceParams::ENSKIP;
|
|
else if (name == "negthinspace")
|
|
isp.kind = InsetSpaceParams::NEGTHIN;
|
|
else if (name == "hfill")
|
|
isp.kind = InsetSpaceParams::HFILL;
|
|
else if (name == "hfill*")
|
|
isp.kind = InsetSpaceParams::HFILL_PROTECTED;
|
|
else if (name == "dotfill")
|
|
isp.kind = InsetSpaceParams::DOTFILL;
|
|
else if (name == "hrulefill")
|
|
isp.kind = InsetSpaceParams::HRULEFILL;
|
|
else if (name == "hspace") {
|
|
if (len.empty() || !isValidLength(len)) {
|
|
lyxerr << "LyX function 'space-insert hspace' "
|
|
<< "needs a valid length argument." << endl;
|
|
break;
|
|
}
|
|
isp.kind = InsetSpaceParams::CUSTOM;
|
|
isp.length = Length(len);
|
|
}
|
|
else if (name == "hspace*") {
|
|
if (len.empty() || !isValidLength(len)) {
|
|
lyxerr << "LyX function 'space-insert hspace*' "
|
|
<< "needs a valid length argument." << endl;
|
|
break;
|
|
}
|
|
isp.kind = InsetSpaceParams::CUSTOM_PROTECTED;
|
|
isp.length = Length(len);
|
|
}
|
|
else {
|
|
lyxerr << "Wrong argument for LyX function 'space-insert'." << endl;
|
|
break;
|
|
}
|
|
return new InsetSpace(isp);
|
|
}
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
|
|
} catch (ExceptionMessage const & message) {
|
|
if (message.type_ == ErrorException) {
|
|
// This should never happen!
|
|
Alert::error(message.title_, message.details_);
|
|
LyX::cref().exit(1);
|
|
} else if (message.type_ == WarningException) {
|
|
Alert::warning(message.title_, message.details_);
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
Inset * createInset(Buffer & buf, FuncRequest const & cmd)
|
|
{
|
|
Inset * inset = createInsetHelper(buf, cmd);
|
|
if (inset)
|
|
inset->setBuffer(buf);
|
|
return inset;
|
|
}
|
|
|
|
|
|
Inset * readInset(Lexer & lex, Buffer const & buf)
|
|
{
|
|
// consistency check
|
|
if (lex.getString() != "\\begin_inset")
|
|
LYXERR0("Buffer::readInset: Consistency check failed.");
|
|
|
|
auto_ptr<Inset> inset;
|
|
|
|
string tmptok;
|
|
lex >> tmptok;
|
|
|
|
// test the different insets
|
|
|
|
// FIXME It would be better if we did not have this branch and could
|
|
// just do one massive switch for all insets. But at present, it's
|
|
// easier to do it this way, and we can't do the massive switch until
|
|
// the conversion mentioned below. Note that if we do want to do a
|
|
// single switch, we need to remove this "CommandInset" line---or
|
|
// replace it with a single "InsetType" line that would be used in all
|
|
// insets.
|
|
if (tmptok == "CommandInset") {
|
|
lex.next();
|
|
string const insetType = lex.getString();
|
|
lex.pushToken(insetType);
|
|
|
|
InsetCode const code = insetCode(insetType);
|
|
|
|
//FIXME If we do the one massive switch, we cannot do this here, since
|
|
//we do not know in advance that we're dealing with a command inset.
|
|
//Worst case, we could put it in each case below. Better, we could
|
|
//pass the lexer to the constructor and let the params be built there.
|
|
InsetCommandParams inscmd(code);
|
|
inscmd.read(lex);
|
|
|
|
switch (code) {
|
|
case BIBITEM_CODE:
|
|
inset.reset(new InsetBibitem(inscmd));
|
|
break;
|
|
case BIBTEX_CODE:
|
|
inset.reset(new InsetBibtex(inscmd));
|
|
break;
|
|
case CITE_CODE:
|
|
inset.reset(new InsetCitation(inscmd));
|
|
break;
|
|
case HYPERLINK_CODE:
|
|
inset.reset(new InsetHyperlink(inscmd));
|
|
break;
|
|
case INCLUDE_CODE:
|
|
inset.reset(new InsetInclude(inscmd));
|
|
break;
|
|
case INDEX_PRINT_CODE:
|
|
inset.reset(new InsetPrintIndex(inscmd));
|
|
break;
|
|
case LABEL_CODE:
|
|
inset.reset(new InsetLabel(inscmd));
|
|
break;
|
|
case NOMENCL_CODE:
|
|
inset.reset(new InsetNomencl(inscmd));
|
|
break;
|
|
case NOMENCL_PRINT_CODE:
|
|
inset.reset(new InsetPrintNomencl(inscmd));
|
|
break;
|
|
case REF_CODE:
|
|
if (inscmd["name"].empty() && inscmd["reference"].empty())
|
|
return 0;
|
|
inset.reset(new InsetRef(buf, inscmd));
|
|
break;
|
|
case TOC_CODE:
|
|
inset.reset(new InsetTOC(inscmd));
|
|
break;
|
|
case NO_CODE:
|
|
default:
|
|
lyxerr << "unknown CommandInset '" << insetType
|
|
<< "'" << endl;
|
|
while (lex.isOK() && lex.getString() != "\\end_inset")
|
|
lex.next();
|
|
return 0;
|
|
}
|
|
inset->setBuffer(const_cast<Buffer &>(buf));
|
|
} else {
|
|
// FIXME This branch should be made to use inset codes as the preceding
|
|
// branch does. Unfortunately, that will take some doing. It requires
|
|
// converting the representation of the insets in LyX files so that they
|
|
// use the inset names listed in Inset.cpp. Then, as above, the inset names
|
|
// can be translated to inset codes using insetCode(). And the insets'
|
|
// write() routines should use insetName() rather than hardcoding it.
|
|
if (tmptok == "Quotes") {
|
|
inset.reset(new InsetQuotes);
|
|
} else if (tmptok == "External") {
|
|
inset.reset(new InsetExternal(const_cast<Buffer &>(buf)));
|
|
} else if (tmptok == "FormulaMacro") {
|
|
inset.reset(new MathMacroTemplate);
|
|
} else if (tmptok == "Formula") {
|
|
inset.reset(new InsetMathHull);
|
|
} else if (tmptok == "Graphics") {
|
|
inset.reset(new InsetGraphics(const_cast<Buffer &>(buf)));
|
|
} else if (tmptok == "Note") {
|
|
inset.reset(new InsetNote(buf, tmptok));
|
|
} else if (tmptok == "Box") {
|
|
inset.reset(new InsetBox(buf, tmptok));
|
|
} else if (tmptok == "Flex") {
|
|
lex.next();
|
|
string s = lex.getString();
|
|
inset.reset(new InsetFlex(buf, s));
|
|
} else if (tmptok == "Branch") {
|
|
inset.reset(new InsetBranch(buf, InsetBranchParams()));
|
|
} else if (tmptok == "Environment") {
|
|
lex.next();
|
|
inset.reset(new InsetEnvironment(buf, lex.getDocString()));
|
|
} else if (tmptok == "ERT") {
|
|
inset.reset(new InsetERT(buf));
|
|
} else if (tmptok == "listings") {
|
|
inset.reset(new InsetListings(buf));
|
|
} else if (tmptok == "space") {
|
|
inset.reset(new InsetSpace);
|
|
} else if (tmptok == "Tabular") {
|
|
inset.reset(new InsetTabular(buf));
|
|
} else if (tmptok == "Text") {
|
|
inset.reset(new InsetText(buf));
|
|
} else if (tmptok == "VSpace") {
|
|
inset.reset(new InsetVSpace);
|
|
} else if (tmptok == "Foot") {
|
|
inset.reset(new InsetFoot(buf));
|
|
} else if (tmptok == "Marginal") {
|
|
inset.reset(new InsetMarginal(buf));
|
|
} else if (tmptok == "Newpage") {
|
|
inset.reset(new InsetNewpage);
|
|
} else if (tmptok == "Newline") {
|
|
inset.reset(new InsetNewline);
|
|
} else if (tmptok == "OptArg") {
|
|
inset.reset(new InsetOptArg(buf));
|
|
} else if (tmptok == "Float") {
|
|
lex.next();
|
|
string tmptok = lex.getString();
|
|
inset.reset(new InsetFloat(buf, tmptok));
|
|
} else if (tmptok == "Wrap") {
|
|
lex.next();
|
|
string tmptok = lex.getString();
|
|
inset.reset(new InsetWrap(buf, tmptok));
|
|
#if 0
|
|
} else if (tmptok == "Theorem") {
|
|
inset.reset(new InsetList);
|
|
#endif
|
|
} else if (tmptok == "Caption") {
|
|
inset.reset(new InsetCaption(buf));
|
|
} else if (tmptok == "Index") {
|
|
inset.reset(new InsetIndex(buf));
|
|
} else if (tmptok == "FloatList") {
|
|
inset.reset(new InsetFloatList);
|
|
} else if (tmptok == "Info") {
|
|
inset.reset(new InsetInfo(buf));
|
|
} else {
|
|
lyxerr << "unknown Inset type '" << tmptok
|
|
<< "'" << endl;
|
|
while (lex.isOK() && lex.getString() != "\\end_inset")
|
|
lex.next();
|
|
return 0;
|
|
}
|
|
|
|
// Set the buffer reference for proper parsing of some insets
|
|
// (InsetCollapsable for example)
|
|
inset->setBuffer(const_cast<Buffer &>(buf));
|
|
inset->read(lex);
|
|
// Set again the buffer for insets that are created inside this inset
|
|
// (InsetMathHull for example).
|
|
inset->setBuffer(const_cast<Buffer &>(buf));
|
|
}
|
|
return inset.release();
|
|
}
|
|
|
|
|
|
} // namespace lyx
|