You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
bibletime/bibletime/frontend/cexportmanager.cpp

544 lines
17 KiB

/*********
*
* This file is part of BibleTime's source code, http://www.bibletime.info/.
*
* Copyright 1999-2006 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License version 2.0.
*
**********/
#include "cexportmanager.h"
#include "backend/cswordkey.h"
#include "backend/cswordmoduleinfo.h"
#include "backend/creferencemanager.h"
#include "backend/cswordversekey.h"
#include "backend/centrydisplay.h"
#include "backend/cdisplaytemplatemgr.h"
#include "backend/chtmlexportrendering.h"
#include "backend/cplaintextexportrendering.h"
#include "frontend/cprinter.h"
#include "util/ctoolclass.h"
#include "util/scoped_resource.h"
//TQt includes
#include <tqclipboard.h>
#include <tqptrlist.h>
#include <tqprogressdialog.h>
//KDE includes
#include <kprogress.h>
#include <tdefiledialog.h>
#include <tdelocale.h>
#include <tdeapplication.h>
//Sword includes
#include <swkey.h>
#include <listkey.h>
using namespace Rendering;
using namespace Printing;
CExportManager::CExportManager(const TQString& caption, const bool showProgress, const TQString& progressLabel, const CSwordBackend::FilterOptions filterOptions, const CSwordBackend::DisplayOptions displayOptions) {
m_caption = !caption.isEmpty() ? caption : TQString::fromLatin1("BibleTime");
m_progressLabel = progressLabel;
m_filterOptions = filterOptions;
m_displayOptions = displayOptions;
m_showProgress = showProgress;
m_progressDialog = 0;
};
const bool CExportManager::saveKey(CSwordKey* key, const Format format, const bool addText) {
if (!key) {
return false;
}
if (!key->module()) {
return false;
}
const TQString filename = getSaveFileName(format);
if (filename.isEmpty()) {
return false;
}
CSwordBackend::FilterOptions filterOptions = m_filterOptions;
filterOptions.footnotes = false;
filterOptions.strongNumbers = false;
filterOptions.morphTags = false;
filterOptions.lemmas = false;
filterOptions.scriptureReferences = false;
filterOptions.textualVariants = false;
CHTMLExportRendering::Settings settings(addText);
util::scoped_ptr<CTextRendering> render (
(format == HTML)
? new CHTMLExportRendering(settings, m_displayOptions, filterOptions)
: new CPlainTextExportRendering(settings, m_displayOptions, filterOptions)
);
TQString text;
TQString startKey;
TQString stopKey;
ListCSwordModuleInfo modules;
modules.append(key->module());
CSwordVerseKey *vk = dynamic_cast<CSwordVerseKey*>(key);
if (vk && vk->isBoundSet()) {
text = render->renderKeyRange( TQString::fromUtf8(vk->LowerBound()), TQString::fromUtf8(vk->UpperBound()), modules );
}
else { //no range supported
text = render->renderSingleKey(key->key(), modules);
}
if (!progressWasCancelled()) {
CToolClass::savePlainFile(filename, text, false, (format==HTML) ? TQTextStream::UnicodeUTF8 : TQTextStream::Locale);
closeProgressDialog();
return true;
}
return false;
};
const bool CExportManager::saveKeyList(sword::ListKey* list, CSwordModuleInfo* module, const Format format, const bool addText) {
if (!list->Count())
return false;
const TQString filename = getSaveFileName(format);
if (filename.isEmpty()) {
return false;
}
CSwordBackend::FilterOptions filterOptions = m_filterOptions;
filterOptions.footnotes = false;
filterOptions.strongNumbers = false;
filterOptions.morphTags = false;
filterOptions.lemmas = false;
filterOptions.scriptureReferences = false;
filterOptions.textualVariants = false;
CHTMLExportRendering::Settings settings(addText);
util::scoped_ptr<CTextRendering> render (
(format == HTML)
? new CHTMLExportRendering(settings, m_displayOptions, filterOptions)
: new CPlainTextExportRendering(settings, m_displayOptions, filterOptions)
);
CTextRendering::KeyTree tree;
setProgressRange(list->Count());
CTextRendering::KeyTreeItem::Settings itemSettings;
itemSettings.highlight = false;
*list = sword::TOP;
while (!list->Error() && !progressWasCancelled()) {
tree.append( new CTextRendering::KeyTreeItem(TQString::fromLocal8Bit((const char*)(*list)) , module, itemSettings) );
incProgress();
(*list)++;
}
const TQString text = render->renderKeyTree(tree);
if (!progressWasCancelled()) {
CToolClass::savePlainFile(filename, text, false, (format==HTML) ? TQTextStream::UnicodeUTF8 : TQTextStream::Locale);
closeProgressDialog();
return true;
}
return false;
};
const bool CExportManager::saveKeyList(TQPtrList<CSwordKey>& list, const Format format, const bool addText ) {
if (!list.count())
return false;
const TQString filename = getSaveFileName(format);
if (filename.isEmpty()) {
return false;
}
CSwordBackend::FilterOptions filterOptions = m_filterOptions;
filterOptions.footnotes = false;
filterOptions.strongNumbers = false;
filterOptions.morphTags = false;
filterOptions.lemmas = false;
filterOptions.scriptureReferences = false;
filterOptions.textualVariants = false;
CHTMLExportRendering::Settings settings(addText);
util::scoped_ptr<CTextRendering> render (
(format == HTML)
? new CHTMLExportRendering(settings, m_displayOptions, filterOptions)
: new CPlainTextExportRendering(settings, m_displayOptions, filterOptions)
);
CTextRendering::KeyTree tree;
setProgressRange(list.count());
CTextRendering::KeyTreeItem::Settings itemSettings;
itemSettings.highlight = false;
for (CSwordKey* k = list.first(); k && !progressWasCancelled(); k = list.next()) {
tree.append( new CTextRendering::KeyTreeItem(k->key(), k->module(), itemSettings) );
incProgress();
};
const TQString text = render->renderKeyTree(tree);
if (!progressWasCancelled()) {
CToolClass::savePlainFile(filename, text, false, (format==HTML) ? TQTextStream::UnicodeUTF8 : TQTextStream::Locale);
closeProgressDialog();
return true;
}
return false;
};
const bool CExportManager::copyKey(CSwordKey* key, const Format format, const bool addText) {
if (!key) {
return false;
}
if (!key->module()) {
return false;
}
CSwordBackend::FilterOptions filterOptions = m_filterOptions;
filterOptions.footnotes = false;
filterOptions.strongNumbers = false;
filterOptions.morphTags = false;
filterOptions.lemmas = false;
filterOptions.scriptureReferences = false;
filterOptions.textualVariants = false;
CHTMLExportRendering::Settings settings(addText);
util::scoped_ptr<CTextRendering> render (
(format == HTML)
? new CHTMLExportRendering(settings, m_displayOptions, filterOptions)
: new CPlainTextExportRendering(settings, m_displayOptions, filterOptions)
);
TQString text;
TQString startKey;
TQString stopKey;
ListCSwordModuleInfo modules;
modules.append(key->module());
CSwordVerseKey *vk = dynamic_cast<CSwordVerseKey*>(key);
if (vk && vk->isBoundSet()) {
text = render->renderKeyRange(
TQString::fromUtf8(vk->LowerBound()),
TQString::fromUtf8(vk->UpperBound()),
modules
);
}
else { //no range supported
text = render->renderSingleKey(key->key(), modules);
}
TDEApplication::clipboard()->setText(text);
return true;
};
const bool CExportManager::copyKeyList(sword::ListKey* list, CSwordModuleInfo* module, const Format format, const bool addText) {
if (!list->Count())
return false;
CSwordBackend::FilterOptions filterOptions = m_filterOptions;
filterOptions.footnotes = false;
filterOptions.strongNumbers = false;
filterOptions.morphTags = false;
filterOptions.lemmas = false;
filterOptions.scriptureReferences = false;
filterOptions.textualVariants = false;
CHTMLExportRendering::Settings settings(addText);
util::scoped_ptr<CTextRendering> render (
(format == HTML)
? new CHTMLExportRendering(settings, m_displayOptions, filterOptions)
: new CPlainTextExportRendering(settings, m_displayOptions, filterOptions)
);
CTextRendering::KeyTree tree;
CTextRendering::KeyTreeItem::Settings itemSettings;
itemSettings.highlight = false;
*list = sword::TOP;
while (!list->Error() && !progressWasCancelled()) {
tree.append( new CTextRendering::KeyTreeItem(TQString::fromLocal8Bit((const char*)(*list)) , module, itemSettings) );
(*list)++;
}
const TQString text = render->renderKeyTree(tree);
TDEApplication::clipboard()->setText(text);
return true;
};
const bool CExportManager::copyKeyList(TQPtrList<CSwordKey>& list, const Format format, const bool addText ) {
if (!list.count())
return false;
CSwordBackend::FilterOptions filterOptions = m_filterOptions;
filterOptions.footnotes = false;
filterOptions.strongNumbers = false;
filterOptions.morphTags = false;
filterOptions.lemmas = false;
filterOptions.scriptureReferences = false;
filterOptions.textualVariants = false;
CHTMLExportRendering::Settings settings(addText);
util::scoped_ptr<CTextRendering> render (
(format == HTML)
? new CHTMLExportRendering(settings, m_displayOptions, filterOptions)
: new CPlainTextExportRendering(settings, m_displayOptions, filterOptions)
);
CTextRendering::KeyTree tree;
CTextRendering::KeyTreeItem::Settings itemSettings;
itemSettings.highlight = false;
for (CSwordKey* k = list.first(); k && !progressWasCancelled(); k = list.next()) {
tree.append( new CTextRendering::KeyTreeItem(k->key(), k->module(), itemSettings) );
incProgress();
};
const TQString text = render->renderKeyTree(tree);
TDEApplication::clipboard()->setText(text);
return true;
};
const bool CExportManager::printKeyList(sword::ListKey* list, CSwordModuleInfo* module, CSwordBackend::DisplayOptions displayOptions, CSwordBackend::FilterOptions filterOptions) {
CPrinter::KeyTreeItem::Settings settings;
CPrinter::KeyTree tree;
TQString startKey, stopKey;
setProgressRange(list->Count());
(*list) = sword::TOP;
while (!list->Error() && !progressWasCancelled()) {
sword::VerseKey* vk = dynamic_cast<sword::VerseKey*>(list);
if (vk) {
startKey = TQString::fromUtf8((const char*)(vk->LowerBound()) );
stopKey = TQString::fromUtf8((const char*)(vk->UpperBound()) );
tree.append( new CPrinter::KeyTreeItem(startKey, stopKey, module, settings) );
}
else {
startKey = TQString::fromUtf8((const char*)*list);
tree.append( new CPrinter::KeyTreeItem(startKey, module, settings) );
}
(*list)++;
incProgress();
}
util::scoped_ptr<CPrinter> printer(new CPrinter(0, displayOptions, filterOptions));
if (!progressWasCancelled()) {
printer->printKeyTree(tree);
closeProgressDialog();
return true;
}
return false;
};
const bool CExportManager::printKey( CSwordModuleInfo* module, const TQString& startKey, const TQString& stopKey, CSwordBackend::DisplayOptions displayOptions, CSwordBackend::FilterOptions filterOptions ) {
CPrinter::KeyTreeItem::Settings settings;
settings.keyRenderingFace =
displayOptions.verseNumbers
? CPrinter::KeyTreeItem::Settings::SimpleKey
: CPrinter::KeyTreeItem::Settings::NoKey;
CPrinter::KeyTree tree;
if (startKey != stopKey) {
tree.append( new CPrinter::KeyTreeItem(startKey, stopKey, module, settings) );
}
else {
tree.append( new CPrinter::KeyTreeItem(startKey, module, settings) );
}
util::scoped_ptr<CPrinter> printer(new CPrinter(0, displayOptions, filterOptions));
printer->printKeyTree(tree);
return true;
}
const bool CExportManager::printKey( CSwordKey* key, CSwordBackend::DisplayOptions displayOptions, CSwordBackend::FilterOptions filterOptions) {
CPrinter::KeyTreeItem::Settings settings;
settings.keyRenderingFace =
displayOptions.verseNumbers
? CPrinter::KeyTreeItem::Settings::SimpleKey
: CPrinter::KeyTreeItem::Settings::NoKey;
CPrinter::KeyTree tree;
tree.append( new CPrinter::KeyTreeItem(key->key(), key->module(), settings) );
util::scoped_ptr<CPrinter> printer(new CPrinter(0, displayOptions, filterOptions));
printer->printKeyTree(tree);
return true;
}
/** Prints a key using the hyperlink created by CReferenceManager. */
const bool CExportManager::printByHyperlink( const TQString& hyperlink, CSwordBackend::DisplayOptions displayOptions, CSwordBackend::FilterOptions filterOptions ) {
TQString moduleName;
TQString keyName;
CReferenceManager::Type type;
CReferenceManager::decodeHyperlink(hyperlink, moduleName, keyName, type);
if (moduleName.isEmpty()) {
moduleName = CReferenceManager::preferredModule(type);
}
CPrinter::KeyTree tree;
CPrinter::KeyTreeItem::Settings settings;
settings.keyRenderingFace =
displayOptions.verseNumbers
? CPrinter::KeyTreeItem::Settings::SimpleKey
: CPrinter::KeyTreeItem::Settings::NoKey;
CSwordModuleInfo* module = backend()->findModuleByName(moduleName);
Q_ASSERT(module);
if (module) {
//check if we have a range of entries or a single one
if ((module->type() == CSwordModuleInfo::Bible) || (module->type() == CSwordModuleInfo::Commentary)) {
sword::ListKey verses = sword::VerseKey().ParseVerseList((const char*)keyName.utf8(), "Genesis 1:1", true);
for (int i = 0; i < verses.Count(); ++i) {
sword::VerseKey* element = dynamic_cast<sword::VerseKey*>(verses.GetElement(i));
if (element) {
const TQString startKey = TQString::fromUtf8(element->LowerBound().getText());
const TQString stopKey = TQString::fromUtf8(element->UpperBound().getText());
tree.append( new CPrinter::KeyTreeItem(startKey, stopKey, module, settings) );
}
else if (verses.GetElement(i)) {
const TQString key = TQString::fromUtf8(verses.GetElement(i)->getText());
tree.append( new CPrinter::KeyTreeItem(key, module, settings) );
}
}
}
else {
tree.append( new CPrinter::KeyTreeItem(keyName, module, settings) );
}
}
util::scoped_ptr<CPrinter> printer(new CPrinter(0, displayOptions, filterOptions));
printer->printKeyTree(tree);
return true;
}
const bool CExportManager::printKeyList(const TQStringList& list,CSwordModuleInfo* module, CSwordBackend::DisplayOptions displayOptions, CSwordBackend::FilterOptions filterOptions) {
CPrinter::KeyTreeItem::Settings settings;
settings.keyRenderingFace =
displayOptions.verseNumbers
? CPrinter::KeyTreeItem::Settings::SimpleKey
: CPrinter::KeyTreeItem::Settings::NoKey;
CPrinter::KeyTree tree;
setProgressRange(list.count());
//ToDo: Fix that as soon as we use TQt > 3.1
// const TQStringList::const_iterator end = list.constEnd();
const TQStringList::const_iterator end = list.end();
//ToDo: Fix that as soon as we use TQt > 3.1
// for (TQStringList::const_iterator it = list.constBegin(); (it != end) && !progressWasCancelled(); ++it) {
for (TQStringList::const_iterator it = list.begin(); (it != end) && !progressWasCancelled(); ++it) {
tree.append( new CPrinter::KeyTreeItem(*it, module, settings) );
incProgress();
}
util::scoped_ptr<CPrinter> printer(new CPrinter(0, displayOptions, filterOptions));
if (!progressWasCancelled()) {
printer->printKeyTree(tree);
closeProgressDialog();
return true;
}
return false;
}
/** Returns the string for the filedialogs to show the correct files. */
const TQString CExportManager::filterString( const Format format ) {
switch (format) {
case HTML:
return i18n("*.html *.htm | HTML files\n *.* | All files (*.*)");
case Text:
return i18n("*.txt | Text files\n *.* | All files (*.*)");
default:
return i18n("All files (*.*)");
}
}
/** Returns a filename to save a file. */
const TQString CExportManager::getSaveFileName(const Format format) {
return KFileDialog::getSaveFileName(TQString(), filterString(format), 0, m_caption);
}
/** Returns a string containing the linebreak for the current format. */
const TQString CExportManager::lineBreak(const Format format) {
if (static_cast<bool>(m_displayOptions.lineBreaks))
return (format == HTML) ? TQString::fromLatin1("<br/>\n") : TQString::fromLatin1("\n");
return TQString();
}
/** No descriptions */
void CExportManager::setProgressRange( const int items ) {
if (TQProgressDialog* dlg = progressDialog()) {
dlg->setTotalSteps(items);
dlg->setProgress(0);
dlg->setMinimumDuration(0);
dlg->show();
// dlg->repaint();
TDEApplication::kApplication()->processEvents(); //do not lock the GUI!
}
}
/** Creates the progress dialog with the correct settings. */
TQProgressDialog* const CExportManager::progressDialog() {
if (!m_showProgress) {
return 0;
}
if (!m_progressDialog) {
m_progressDialog = new TQProgressDialog( m_caption, m_progressLabel, 1, 0, "progress", true );
m_progressDialog->setCaption("BibleTime");
}
return m_progressDialog;
}
/** Increments the progress by one item. */
void CExportManager::incProgress() {
if (TQProgressDialog* dlg = progressDialog()) {
dlg->setProgress( dlg->progress() + 1 );
}
}
/** No descriptions */
const bool CExportManager::progressWasCancelled() {
if (TQProgressDialog* dlg = progressDialog()) {
return dlg->wasCancelled();
}
return true;
}
/** Closes the progress dialog immediatly. */
void CExportManager::closeProgressDialog() {
if (TQProgressDialog* dlg = progressDialog()) {
dlg->close();
dlg->reset();
}
TDEApplication::kApplication()->processEvents(); //do not lock the GUI!
}