2003-10-10 21:08:55 +00:00
|
|
|
/**
|
2007-04-25 01:24:38 +00:00
|
|
|
* \file RenderPreview.cpp
|
2003-10-10 21:08:55 +00:00
|
|
|
* This file is part of LyX, the document processor.
|
|
|
|
* Licence details can be found in the file COPYING.
|
|
|
|
*
|
|
|
|
* \author Angus Leeming
|
|
|
|
*
|
|
|
|
* Full author contact details are available in file CREDITS.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <config.h>
|
|
|
|
|
2007-04-25 01:24:38 +00:00
|
|
|
#include "insets/RenderPreview.h"
|
2007-04-29 13:39:47 +00:00
|
|
|
#include "insets/Inset.h"
|
2003-10-10 21:08:55 +00:00
|
|
|
|
2003-10-22 22:26:47 +00:00
|
|
|
#include "BufferView.h"
|
2007-04-26 04:41:58 +00:00
|
|
|
#include "Dimension.h"
|
2003-10-22 22:26:47 +00:00
|
|
|
#include "gettext.h"
|
2007-04-26 04:41:58 +00:00
|
|
|
#include "LyX.h"
|
|
|
|
#include "LyXRC.h"
|
|
|
|
#include "MetricsInfo.h"
|
2003-10-10 21:08:55 +00:00
|
|
|
|
2006-10-07 16:15:06 +00:00
|
|
|
#include "frontends/FontMetrics.h"
|
2003-10-10 21:08:55 +00:00
|
|
|
#include "frontends/Painter.h"
|
|
|
|
|
|
|
|
#include "graphics/PreviewImage.h"
|
|
|
|
#include "graphics/PreviewLoader.h"
|
|
|
|
#include "graphics/Previews.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/FileName.h"
|
2003-10-10 21:08:55 +00:00
|
|
|
#include "support/lstrings.h"
|
|
|
|
|
|
|
|
#include <boost/bind.hpp>
|
|
|
|
|
2006-10-21 00:16:43 +00:00
|
|
|
|
|
|
|
namespace lyx {
|
2006-08-13 22:54:59 +00:00
|
|
|
|
2006-11-26 21:30:39 +00:00
|
|
|
using support::FileName;
|
|
|
|
|
2003-10-10 21:08:55 +00:00
|
|
|
using std::string;
|
|
|
|
|
|
|
|
|
2004-04-19 13:31:17 +00:00
|
|
|
LyXRC_PreviewStatus RenderPreview::status()
|
2003-10-10 21:08:55 +00:00
|
|
|
{
|
2004-04-19 13:31:17 +00:00
|
|
|
return graphics::Previews::status();
|
2003-10-10 21:08:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2007-04-29 13:39:47 +00:00
|
|
|
RenderPreview::RenderPreview(Inset const * inset)
|
2004-04-19 13:05:36 +00:00
|
|
|
: parent_(inset)
|
2003-10-10 21:08:55 +00:00
|
|
|
{}
|
|
|
|
|
|
|
|
|
2004-04-13 17:25:23 +00:00
|
|
|
RenderPreview::RenderPreview(RenderPreview const & other,
|
2007-04-29 13:39:47 +00:00
|
|
|
Inset const * inset)
|
2003-10-10 21:08:55 +00:00
|
|
|
: RenderBase(other),
|
|
|
|
boost::signals::trackable(),
|
|
|
|
snippet_(other.snippet_),
|
2004-04-13 17:25:23 +00:00
|
|
|
parent_(inset)
|
2003-10-10 21:08:55 +00:00
|
|
|
{}
|
|
|
|
|
|
|
|
|
2007-08-20 21:30:33 +00:00
|
|
|
RenderPreview::~RenderPreview()
|
|
|
|
{
|
|
|
|
if (ploader_connection_.connected())
|
|
|
|
ploader_connection_.disconnect();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2007-08-30 18:03:17 +00:00
|
|
|
RenderBase * RenderPreview::clone(Inset const * inset) const
|
2003-10-10 21:08:55 +00:00
|
|
|
{
|
2007-08-30 18:03:17 +00:00
|
|
|
return new RenderPreview(*this, inset);
|
2003-10-10 21:08:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2003-10-22 22:26:47 +00:00
|
|
|
namespace {
|
|
|
|
|
2004-04-20 08:42:10 +00:00
|
|
|
graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
|
|
|
|
{
|
|
|
|
graphics::Previews const & previews = graphics::Previews::get();
|
|
|
|
return previews.loader(buffer);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2006-11-11 20:55:40 +00:00
|
|
|
docstring const statusMessage(BufferView const * bv, string const & snippet)
|
2003-10-22 22:26:47 +00:00
|
|
|
{
|
2007-08-21 13:03:55 +00:00
|
|
|
BOOST_ASSERT(bv);
|
2003-10-22 22:26:47 +00:00
|
|
|
|
2007-08-21 13:03:55 +00:00
|
|
|
Buffer const & buffer = bv->buffer();
|
2004-04-20 08:42:10 +00:00
|
|
|
graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
|
2003-10-22 22:26:47 +00:00
|
|
|
graphics::PreviewLoader::Status const status = loader.status(snippet);
|
|
|
|
|
2006-09-09 15:27:44 +00:00
|
|
|
docstring message;
|
2003-10-22 22:26:47 +00:00
|
|
|
switch (status) {
|
|
|
|
case graphics::PreviewLoader::InQueue:
|
|
|
|
case graphics::PreviewLoader::Processing:
|
|
|
|
message = _("Preview loading");
|
|
|
|
break;
|
|
|
|
case graphics::PreviewLoader::Ready:
|
|
|
|
message = _("Preview ready");
|
|
|
|
break;
|
|
|
|
case graphics::PreviewLoader::NotFound:
|
|
|
|
message = _("Preview failed");
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
2006-11-11 20:55:40 +00:00
|
|
|
return message;
|
2003-10-22 22:26:47 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace anon
|
|
|
|
|
|
|
|
|
2004-04-19 13:05:36 +00:00
|
|
|
graphics::PreviewImage const *
|
|
|
|
RenderPreview::getPreviewImage(Buffer const & buffer) const
|
|
|
|
{
|
2004-04-20 08:42:10 +00:00
|
|
|
graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
|
2004-04-19 13:05:36 +00:00
|
|
|
return loader.preview(snippet_);
|
|
|
|
}
|
2004-04-20 08:42:10 +00:00
|
|
|
|
2004-04-19 13:05:36 +00:00
|
|
|
|
2007-09-21 20:39:47 +00:00
|
|
|
void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
|
2003-10-10 21:08:55 +00:00
|
|
|
{
|
2007-08-21 13:03:55 +00:00
|
|
|
BOOST_ASSERT(mi.base.bv);
|
2004-04-19 13:05:36 +00:00
|
|
|
|
|
|
|
graphics::PreviewImage const * const pimage =
|
2007-08-21 13:03:55 +00:00
|
|
|
getPreviewImage(mi.base.bv->buffer());
|
2004-04-19 13:05:36 +00:00
|
|
|
|
|
|
|
if (pimage) {
|
|
|
|
dim.asc = pimage->ascent();
|
|
|
|
dim.des = pimage->descent();
|
|
|
|
dim.wid = pimage->width();
|
2003-10-10 21:08:55 +00:00
|
|
|
} else {
|
2003-10-22 22:26:47 +00:00
|
|
|
dim.asc = 50;
|
|
|
|
dim.des = 0;
|
|
|
|
|
2007-10-28 18:51:54 +00:00
|
|
|
FontInfo font(mi.base.font);
|
|
|
|
font.setFamily(SANS_FAMILY);
|
|
|
|
font.setSize(FONT_SIZE_FOOTNOTE);
|
2006-11-11 20:55:40 +00:00
|
|
|
docstring const stat = statusMessage(mi.base.bv, snippet_);
|
2006-10-17 14:46:45 +00:00
|
|
|
dim.wid = 15 + theFontMetrics(font).width(stat);
|
2003-10-10 21:08:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
dim_ = dim;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void RenderPreview::draw(PainterInfo & pi, int x, int y) const
|
|
|
|
{
|
2007-08-21 13:03:55 +00:00
|
|
|
BOOST_ASSERT(pi.base.bv);
|
2003-10-22 22:26:47 +00:00
|
|
|
|
2004-04-19 13:05:36 +00:00
|
|
|
graphics::PreviewImage const * const pimage =
|
2007-08-21 13:03:55 +00:00
|
|
|
getPreviewImage(pi.base.bv->buffer());
|
2004-04-20 08:42:10 +00:00
|
|
|
graphics::Image const * const image = pimage ? pimage->image() : 0;
|
2004-04-19 13:05:36 +00:00
|
|
|
|
2004-04-20 08:42:10 +00:00
|
|
|
if (image) {
|
2003-10-10 21:08:55 +00:00
|
|
|
pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
|
2004-04-20 08:42:10 +00:00
|
|
|
*image);
|
|
|
|
|
|
|
|
} else {
|
2007-04-29 13:39:47 +00:00
|
|
|
int const offset = Inset::TEXT_TO_INSET_OFFSET;
|
2004-04-20 08:42:10 +00:00
|
|
|
|
|
|
|
pi.pain.rectangle(x + offset,
|
|
|
|
y - dim_.asc,
|
|
|
|
dim_.wid - 2 * offset,
|
|
|
|
dim_.asc + dim_.des,
|
2007-10-25 12:41:02 +00:00
|
|
|
Color_foreground);
|
2003-10-22 22:26:47 +00:00
|
|
|
|
2007-10-28 18:51:54 +00:00
|
|
|
FontInfo font(pi.base.font);
|
|
|
|
font.setFamily(SANS_FAMILY);
|
|
|
|
font.setSize(FONT_SIZE_FOOTNOTE);
|
2004-04-20 08:42:10 +00:00
|
|
|
|
2006-11-11 20:55:40 +00:00
|
|
|
docstring const stat = statusMessage(pi.base.bv, snippet_);
|
2004-04-20 08:42:10 +00:00
|
|
|
pi.pain.text(x + offset + 6,
|
2006-10-11 17:24:46 +00:00
|
|
|
y - theFontMetrics(font).maxAscent() - 4,
|
2006-10-17 14:46:45 +00:00
|
|
|
stat, font);
|
2004-04-20 08:42:10 +00:00
|
|
|
}
|
2003-10-10 21:08:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2003-10-22 22:26:47 +00:00
|
|
|
void RenderPreview::startLoading(Buffer const & buffer) const
|
|
|
|
{
|
2004-04-19 13:31:17 +00:00
|
|
|
if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
|
2003-10-22 22:26:47 +00:00
|
|
|
return;
|
|
|
|
|
2004-04-20 08:42:10 +00:00
|
|
|
graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
|
2003-10-22 22:26:47 +00:00
|
|
|
loader.startLoading();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2006-10-19 16:51:30 +00:00
|
|
|
void RenderPreview::addPreview(docstring const & latex_snippet,
|
2003-10-22 22:26:47 +00:00
|
|
|
Buffer const & buffer)
|
2003-10-10 21:08:55 +00:00
|
|
|
{
|
2004-04-19 13:31:17 +00:00
|
|
|
if (status() == LyXRC::PREVIEW_OFF)
|
2003-10-10 21:08:55 +00:00
|
|
|
return;
|
|
|
|
|
2004-04-20 08:42:10 +00:00
|
|
|
graphics::PreviewLoader & loader = getPreviewLoader(buffer);
|
2003-10-10 21:08:55 +00:00
|
|
|
addPreview(latex_snippet, loader);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2006-10-19 16:51:30 +00:00
|
|
|
void RenderPreview::addPreview(docstring const & latex_snippet,
|
2003-10-22 22:26:47 +00:00
|
|
|
graphics::PreviewLoader & ploader)
|
2003-10-10 21:08:55 +00:00
|
|
|
{
|
2004-04-19 13:31:17 +00:00
|
|
|
if (status() == LyXRC::PREVIEW_OFF)
|
2003-10-10 21:08:55 +00:00
|
|
|
return;
|
|
|
|
|
2006-10-19 16:51:30 +00:00
|
|
|
// FIXME UNICODE
|
|
|
|
// We have to make sure that we call latex with the right encoding
|
2006-10-21 00:16:43 +00:00
|
|
|
snippet_ = support::trim(to_utf8(latex_snippet));
|
2003-10-10 21:08:55 +00:00
|
|
|
if (snippet_.empty())
|
|
|
|
return;
|
|
|
|
|
2004-04-19 13:05:36 +00:00
|
|
|
if (ploader.preview(snippet_))
|
2003-10-10 21:08:55 +00:00
|
|
|
return;
|
|
|
|
|
|
|
|
// If this is the first time of calling, connect to the
|
|
|
|
// PreviewLoader signal that'll inform us when the preview image
|
|
|
|
// is ready for loading.
|
|
|
|
if (!ploader_connection_.connected()) {
|
|
|
|
ploader_connection_ = ploader.connect(
|
|
|
|
boost::bind(&RenderPreview::imageReady, this, _1));
|
|
|
|
}
|
|
|
|
|
|
|
|
ploader.add(snippet_);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void RenderPreview::removePreview(Buffer const & buffer)
|
|
|
|
{
|
|
|
|
if (snippet_.empty())
|
|
|
|
return;
|
|
|
|
|
2004-04-20 08:42:10 +00:00
|
|
|
graphics::PreviewLoader & loader = getPreviewLoader(buffer);
|
2003-10-10 21:08:55 +00:00
|
|
|
loader.remove(snippet_);
|
|
|
|
snippet_.erase();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
|
|
|
|
{
|
|
|
|
// Check the current snippet is the same as that previewed.
|
2004-04-19 13:05:36 +00:00
|
|
|
if (snippet_ == pimage.snippet())
|
|
|
|
LyX::cref().updateInset(parent_);
|
2003-10-10 21:08:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2007-04-29 13:39:47 +00:00
|
|
|
RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
|
2004-04-13 17:25:23 +00:00
|
|
|
: RenderPreview(inset),
|
2006-11-26 21:30:39 +00:00
|
|
|
monitor_(FileName(), 2000)
|
2004-04-13 17:25:23 +00:00
|
|
|
{}
|
|
|
|
|
|
|
|
|
2006-11-26 21:30:39 +00:00
|
|
|
void RenderMonitoredPreview::setAbsFile(FileName const & file)
|
2003-10-10 21:08:55 +00:00
|
|
|
{
|
|
|
|
monitor_.reset(file);
|
2003-10-22 22:26:47 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
|
|
|
|
{
|
|
|
|
RenderPreview::draw(pi, x, y);
|
|
|
|
if (!monitoring())
|
|
|
|
startMonitoring();
|
2003-10-10 21:08:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
boost::signals::connection
|
|
|
|
RenderMonitoredPreview::fileChanged(slot_type const & slot)
|
|
|
|
{
|
|
|
|
return monitor_.connect(slot);
|
|
|
|
}
|
2006-10-21 00:16:43 +00:00
|
|
|
|
|
|
|
} // namespace lyx
|