lyx_mirror/src/insets/InsetGraphicsParams.cpp

343 lines
8.6 KiB
C++
Raw Normal View History

/**
* \file InsetGraphicsParams.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Baruch Even
* \author Herbert Vo<EFBFBD>
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "InsetGraphicsParams.h"
#include "LyX.h" // for use_gui
#include "Lexer.h"
#include "LyXRC.h"
#include "Buffer.h"
#include "graphics/GraphicsParams.h"
#include "graphics/GraphicsTypes.h"
#include "support/convert.h"
#include "support/debug.h"
#include "support/filetools.h"
#include "support/lyxlib.h"
#include "support/lstrings.h"
Rename files in src/support, step one. src/support/package.h src/support/Package.h Package src/support/package.C.in src/support/Package.C.in Package src/support/path.h src/support/Path.h Path src/support/fs_extras.h src/support/fs_extras.h NOCLASSES src/support/RandomAccessList.h src/support/RandomAccessList.h RandomAccessList src/support/lyxmanip.h src/support/lyxmanip.h NOCLASSES src/support/rename.C src/support/rename.cpp NOCLASSES src/support/abort.C src/support/abort.cpp NOCLASSES src/support/lyxlib.h src/support/lyxlib.h NOCLASSES src/support/ExceptionMessage.h src/support/ExceptionMessage.h ExceptionMessage src/support/copy.C src/support/copy.cpp NOCLASSES src/support/limited_stack.h src/support/limited_stack.h limited_stack src/support/filefilterlist.C src/support/FileFilterList.cpp ['FileFilterList', 'Filter'] src/support/cow_ptr.h src/support/cow_ptr.h cow_ptr src/support/os_unix.C src/support/os_unix.cpp NOCLASSES src/support/socktools.h src/support/socktools.h NOCLASSES src/support/forkedcontr.h src/support/ForkedcallsController.h ForkedcallsController src/support/os.h src/support/os.h NOCLASSES src/support/FileMonitor.h src/support/FileMonitor.h FileMonitor src/support/copied_ptr.h src/support/copied_ptr.h copied_ptr src/support/translator.h src/support/Translator.h Translator src/support/filetools.C src/support/filetools.cpp NOCLASSES src/support/unlink.C src/support/unlink.cpp NOCLASSES src/support/os_win32.C src/support/os_win32.cpp GetFolderPath src/support/lstrings.C src/support/lstrings.cpp NOCLASSES src/support/qstring_helpers.C src/support/qstring_helpers.cpp NOCLASSES src/support/getcwd.C src/support/getcwd.cpp NOCLASSES src/support/systemcall.C src/support/Systemcall.cpp Systemcall src/support/lyxalgo.h src/support/lyxalgo.h NOCLASSES src/support/filefilterlist.h src/support/FileFilterList.h ['FileFilterList', 'Filter'] src/support/unicode.C src/support/unicode.cpp IconvProcessor src/support/userinfo.C src/support/userinfo.cpp NOCLASSES src/support/lyxtime.C src/support/lyxtime.cpp NOCLASSES src/support/kill.C src/support/kill.cpp NOCLASSES src/support/docstring.C src/support/docstring.cpp to_local8bit_failure src/support/os_cygwin.C src/support/os_cygwin.cpp NOCLASSES src/support/lyxsum.C src/support/lyxsum.cpp NOCLASSES src/support/environment.C src/support/environment.cpp NOCLASSES src/support/filetools.h src/support/filetools.h NOCLASSES src/support/textutils.C src/support/textutils.cpp NOCLASSES src/support/mkdir.C src/support/mkdir.cpp NOCLASSES src/support/forkedcall.C src/support/Forkedcall.cpp ['ForkedProcess', 'Forkedcall'] src/support/tempname.C src/support/tempname.cpp NOCLASSES src/support/os_win32.h src/support/os_win32.h GetFolderPath src/support/types.h src/support/types.h NOCLASSES src/support/lstrings.h src/support/lstrings.h NOCLASSES src/support/forkedcallqueue.C src/support/ForkedCallQueue.cpp ForkedCallQueue src/support/qstring_helpers.h src/support/qstring_helpers.h NOCLASSES src/support/convert.C src/support/convert.cpp NOCLASSES src/support/filename.C src/support/FileName.cpp ['FileName', 'DocFileName'] src/support/tests/convert.C src/support/tests/convert.cpp NOCLASSES src/support/tests/filetools.C src/support/tests/filetools.cpp NOCLASSES src/support/tests/lstrings.C src/support/tests/lstrings.cpp NOCLASSES src/support/tests/boost.C src/support/tests/boost.cpp NOCLASSES src/support/docstream.C src/support/docstream.cpp ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/std_istream.h src/support/std_istream.h NOCLASSES src/support/systemcall.h src/support/Systemcall.h Systemcall src/support/chdir.C src/support/chdir.cpp NOCLASSES src/support/std_ostream.h src/support/std_ostream.h NOCLASSES src/support/unicode.h src/support/unicode.h IconvProcessor src/support/path.C src/support/Path.cpp Path src/support/fs_extras.C src/support/fs_extras.cpp NOCLASSES src/support/userinfo.h src/support/userinfo.h NOCLASSES src/support/lyxtime.h src/support/lyxtime.h NOCLASSES src/support/docstring.h src/support/docstring.h to_local8bit_failure src/support/debugstream.h src/support/debugstream.h basic_debugstream src/support/environment.h src/support/environment.h NOCLASSES src/support/textutils.h src/support/textutils.h NOCLASSES src/support/forkedcall.h src/support/Forkedcall.h ['ForkedProcess', 'Forkedcall'] src/support/socktools.C src/support/socktools.cpp NOCLASSES src/support/forkedcallqueue.h src/support/ForkedCallQueue.h ForkedCallQueue src/support/forkedcontr.C src/support/ForkedcallsController.cpp ForkedcallsController src/support/os.C src/support/os.cpp NOCLASSES src/support/convert.h src/support/convert.h NOCLASSES src/support/filename.h src/support/FileName.h ['FileName', 'DocFileName'] src/support/docstream.h src/support/docstream.h ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/FileMonitor.C src/support/FileMonitor.cpp FileMonitor git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18024 a592a061-630c-0410-9148-cb99ea01b6c8
2007-04-26 05:12:52 +00:00
#include "support/Translator.h"
#include <ostream>
using namespace std;
using namespace lyx::support;
namespace lyx {
InsetGraphicsParams::InsetGraphicsParams()
{
init();
}
InsetGraphicsParams::InsetGraphicsParams(InsetGraphicsParams const & igp)
{
// I decided to skip the initialization since the copy will overwrite
// everything anyway.
// init();
copy(igp);
}
void InsetGraphicsParams::operator=(InsetGraphicsParams const & params)
{
// Are we assigning the object into itself?
if (this == &params)
return;
copy(params);
}
void InsetGraphicsParams::init()
{
filename.erase();
lyxscale = 100; // lyx scaling in percentage
display = graphics::DefaultDisplay; // display mode; see preferences
scale = string("100"); // output scaling in percentage
width = Length();
height = Length();
keepAspectRatio = false; // for LaTeX output
draft = false; // draft mode
noUnzip = false; // unzip files
scaleBeforeRotation = false; // scale image before rotating
bb = string(); // bounding box
clip = false; // clip image
rotateAngle = "0"; // angle of rotation in degrees
rotateOrigin.erase(); // Origin of rotation
subcaption = false; // subfigure
subcaptionText.erase(); // subfigure caption
special.erase(); // additional userdefined stuff
}
void InsetGraphicsParams::copy(InsetGraphicsParams const & igp)
{
filename = igp.filename;
lyxscale = igp.lyxscale;
display = igp.display;
scale = igp.scale;
width = igp.width;
height = igp.height;
keepAspectRatio = igp.keepAspectRatio;
draft = igp.draft;
noUnzip = igp.noUnzip;
scaleBeforeRotation = igp.scaleBeforeRotation;
bb = igp.bb;
clip = igp.clip;
rotateAngle = igp.rotateAngle;
rotateOrigin = igp.rotateOrigin;
subcaption = igp.subcaption;
subcaptionText = igp.subcaptionText;
special = igp.special;
}
bool operator==(InsetGraphicsParams const & left,
InsetGraphicsParams const & right)
{
return left.filename == right.filename &&
left.lyxscale == right.lyxscale &&
left.display == right.display &&
left.scale == right.scale &&
left.width == right.width &&
left.height == right.height &&
left.keepAspectRatio == right.keepAspectRatio &&
left.draft == right.draft &&
left.noUnzip == right.noUnzip &&
left.scaleBeforeRotation == right.scaleBeforeRotation &&
left.bb == right.bb &&
left.clip == right.clip &&
left.rotateAngle == right.rotateAngle &&
left.rotateOrigin == right.rotateOrigin &&
left.subcaption == right.subcaption &&
left.subcaptionText == right.subcaptionText &&
left.special == right.special;
}
bool operator!=(InsetGraphicsParams const & left,
InsetGraphicsParams const & right)
{
return !(left == right);
}
void InsetGraphicsParams::Write(ostream & os, Buffer const & buffer) const
{
// Do not write the default values
if (!filename.empty()) {
os << "\tfilename " << filename.outputFilename(buffer.filePath()) << '\n';
os << "\tembed " << (filename.embedded() ? filename.inzipName() : "\"\"") << '\n';
}
if (lyxscale != 100)
os << "\tlyxscale " << lyxscale << '\n';
if (display != graphics::DefaultDisplay)
os << "\tdisplay " << graphics::displayTranslator().find(display) << '\n';
if (!scale.empty() && !float_equal(convert<double>(scale), 0.0, 0.05)) {
if (!float_equal(convert<double>(scale), 100.0, 0.05))
os << "\tscale " << scale << '\n';
} else {
if (!width.zero())
os << "\twidth " << width.asString() << '\n';
if (!height.zero())
os << "\theight " << height.asString() << '\n';
}
if (keepAspectRatio)
os << "\tkeepAspectRatio\n";
if (draft) // draft mode
os << "\tdraft\n";
if (noUnzip)
os << "\tnoUnzip\n";
if (scaleBeforeRotation)
os << "\tscaleBeforeRotation\n";
if (!bb.empty()) // bounding box
os << "\tBoundingBox " << bb << '\n';
if (clip) // clip image
os << "\tclip\n";
if (!rotateAngle.empty()
&& !float_equal(convert<double>(rotateAngle), 0.0, 0.001))
os << "\trotateAngle " << rotateAngle << '\n';
if (!rotateOrigin.empty())
os << "\trotateOrigin " << rotateOrigin << '\n';
if (subcaption)
os << "\tsubcaption\n";
if (!subcaptionText.empty())
os << "\tsubcaptionText \"" << subcaptionText << '\"' << '\n';
if (!special.empty())
os << "\tspecial " << special << '\n';
}
bool InsetGraphicsParams::Read(Lexer & lex, string const & token, string const & bufpath)
{
if (token == "filename") {
lex.eatLine();
filename.set(lex.getString(), bufpath);
} else if (token == "inzipName") {
// this option is currently ignored because only files in
// or under current document path is embeddable, and their
// inzipName is automatically determined.
lex.eatLine();
} else if (token == "embed") {
lex.next();
string const name = lex.getString();
filename.setInzipName(name);
filename.setEmbed(!name.empty());
} else if (token == "lyxscale") {
lex.next();
lyxscale = lex.getInteger();
} else if (token == "display") {
lex.next();
string const type = lex.getString();
display = graphics::displayTranslator().find(type);
} else if (token == "scale") {
lex.next();
scale = lex.getString();
} else if (token == "width") {
lex.next();
width = Length(lex.getString());
scale = string();
} else if (token == "height") {
lex.next();
height = Length(lex.getString());
scale = string();
} else if (token == "keepAspectRatio") {
keepAspectRatio = true;
} else if (token == "draft") {
draft = true;
} else if (token == "noUnzip") {
noUnzip = true;
} else if (token == "scaleBeforeRotation") {
scaleBeforeRotation = true;
} else if (token == "BoundingBox") {
bb.erase();
for (int i = 0; i < 4; ++i) {
if (i != 0)
bb += ' ';
lex.next();
bb += lex.getString();
}
} else if (token == "clip") {
clip = true;
} else if (token == "rotateAngle") {
lex.next();
rotateAngle = lex.getString();
} else if (token == "rotateOrigin") {
lex.next();
rotateOrigin=lex.getString();
} else if (token == "subcaption") {
subcaption = true;
} else if (token == "subcaptionText") {
lex.eatLine();
string sub = lex.getString();
// strip surrounding " "
subcaptionText = sub.substr(1, sub.length() - 2);
} else if (token == "special") {
lex.eatLine();
special = lex.getString();
// catch and ignore following two old-format tokens and their arguments.
// e.g. "size_kind scale" clashes with the setting of the
// "scale <value>" keyword.
} else if (token == "size_kind" || token == "lyxsize_kind") {
lex.next();
lex.getString();
} else {
// If it's none of the above, it's not ours.
return false;
}
return true;
}
graphics::Params InsetGraphicsParams::as_grfxParams() const
{
graphics::Params pars;
pars.filename = filename.availableFile();
pars.icon = filename.embedded() ? "pin.png" : "";
pars.scale = lyxscale;
pars.angle = convert<double>(rotateAngle);
if (clip) {
pars.bb = bb;
// Get the original Bounding Box from the file
string const tmp = readBB_from_PSFile(filename);
LYXERR(Debug::GRAPHICS, "BB_from_File: " << tmp);
if (!tmp.empty()) {
// FIXME: why not convert to unsigned int? (Lgb)
unsigned int const bb_orig_xl = convert<int>(token(tmp, ' ', 0));
unsigned int const bb_orig_yb = convert<int>(token(tmp, ' ', 1));
// new pars.bb values must be >= zero
if (pars.bb.xl > bb_orig_xl)
pars.bb.xl -= bb_orig_xl;
else
pars.bb.xl = 0;
if (pars.bb.xr > bb_orig_xl)
pars.bb.xr -= bb_orig_xl;
else
pars.bb.xr = 0;
if (pars.bb.yb > bb_orig_yb)
pars.bb.yb -= bb_orig_yb;
else
pars.bb.yb = 0;
if (pars.bb.yt > bb_orig_yb)
pars.bb.yt -= bb_orig_yb;
else
pars.bb.yt = 0;
}
// Paranoia check.
int const width = pars.bb.xr - pars.bb.xl;
int const height = pars.bb.yt - pars.bb.yb;
if (width < 0 || height < 0) {
pars.bb.xl = 0;
pars.bb.xr = 0;
pars.bb.yb = 0;
pars.bb.yt = 0;
}
}
if (display == graphics::DefaultDisplay) {
pars.display = graphics::DisplayType(lyxrc.display_graphics);
} else {
pars.display = display;
}
// Override the above if we're not using a gui
if (!use_gui)
pars.display = graphics::NoDisplay;
return pars;
}
} // namespace lyx