/***************************************************************************
* This file is part of the Lime Report project *
* Copyright (C) 2015 by Alexander Arin *
* arin_a@bk.ru *
* *
** GNU General Public License Usage **
* *
* This library is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see . *
* *
** GNU Lesser General Public License **
* *
* This library is free software: you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License as *
* published by the Free Software Foundation, either version 3 of the *
* License, or (at your option) any later version. *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library. *
* If not, see . *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
****************************************************************************/
#include
#include
#include
#include "lrreportrender.h"
#include "lrpagedesignintf.h"
#include "lrbanddesignintf.h"
#include "lritemdesignintf.h"
#include "lrscriptenginemanager.h"
#include "serializators/lrxmlreader.h"
#include "serializators/lrxmlwriter.h"
namespace LimeReport{
ReportRender::ReportRender(QObject *parent)
:QObject(parent), m_renderPageItem(0), m_pageCount(0)
{}
void ReportRender::setDatasources(DataSourceManager *value)
{
m_datasources=value;
}
void ReportRender::initDatasources(){
try{
datasources()->setAllDatasourcesToFirst();
} catch(ReportError &exception){
//TODO posible should thow exeption
QMessageBox::critical(0,tr("Error"),exception.what());
return;
}
}
void ReportRender::renderPage(PageDesignIntf* patternPage)
{
m_patternPageItem=patternPage->pageItem();
m_pageCount=1;
m_renderCanceled = false;
BandDesignIntf* reportFooter = m_patternPageItem->bandByType(BandDesignIntf::ReportFooter);
if (reportFooter)
m_reportFooterHeight = reportFooter->height();
initVariables();
initGroupFunctions();
clearPageMap();
startNewPage();
renderBand(m_patternPageItem->bandByType(BandDesignIntf::ReportHeader),StartNewPage);
BandDesignIntf* lastRenderedBand = 0;
for (int i=0;idataBandCount() && !m_renderCanceled;i++){
lastRenderedBand = m_patternPageItem->dataBandAt(i);
initDatasources();
renderDataBand(lastRenderedBand);
if (idataBandCount()-1) closeFooterGroup(lastRenderedBand);
}
if (reportFooter)
renderBand(reportFooter,StartNewPage);
if (lastRenderedBand && lastRenderedBand->keepFooterTogether())
closeFooterGroup(lastRenderedBand);
savePage();
if (!m_renderCanceled)
secondRenderPass();
}
int ReportRender::pageCount()
{
return m_renderedPages.count();
}
PageItemDesignIntf::Ptr ReportRender::pageAt(int index)
{
if ((index>m_renderedPages.count()-1)||(index<0)) throw ReportError("page index out of range");
else return m_renderedPages.at(index);
}
QString ReportRender::renderPageToString(PageDesignIntf *patternPage)
{
renderPage(patternPage);
return toString();
}
ReportPages ReportRender::renderPageToPages(PageDesignIntf *patternPage)
{
renderPage(patternPage);
return m_renderedPages;
}
void ReportRender::initRenderPage()
{
if (!m_renderPageItem) {
m_renderPageItem = new PageItemDesignIntf(m_patternPageItem->pageSize(), m_patternPageItem->pageRect());
m_renderPageItem->initFromItem(m_patternPageItem);
}
}
void ReportRender::initVariables()
{
m_datasources->setReportVariable("#PAGE",1);
m_datasources->setReportVariable("#PAGE_COUNT",0);
}
void ReportRender::clearPageMap()
{
m_renderedPages.clear();
}
void ReportRender::extractGroupsFunction(BandDesignIntf *band)
{
foreach(BaseDesignIntf* item,band->childBaseItems()){
ContentItemDesignIntf* contentItem = dynamic_cast(item);
if (contentItem&&(contentItem->content().contains(QRegExp("\\$S\\s*\\{.*\\}")))){
foreach(QString functionName, DataSourceManager::instance()->groupFunctionNames()){
QRegExp rx(QString(GROUP_FUNCTION_RX).arg(functionName));
QRegExp rxName(QString(GROUP_FUNCTION_NAME_RX).arg(functionName));
if (rx.indexIn(contentItem->content())>=0){
BandDesignIntf* dataBand = m_patternPageItem->bandByName(rx.cap(DATASOURCE_INDEX));
if (dataBand){
GroupFunction* gf = datasources()->addGroupFunction(functionName,rx.cap(VALUE_INDEX),band->objectName(),dataBand->objectName());
if (gf){
connect(dataBand,SIGNAL(bandRendered(BandDesignIntf*)),gf,SLOT(slotBandRendered(BandDesignIntf*)));
}
} else {
GroupFunction* gf = datasources()->addGroupFunction(functionName,rx.cap(VALUE_INDEX),band->objectName(),rx.cap(DATASOURCE_INDEX));
gf->setInvalid(tr("Databand \"%1\" not found").arg(rx.cap(DATASOURCE_INDEX)));
}
} else if (rxName.indexIn(contentItem->content())>=0){
GroupFunction* gf = datasources()->addGroupFunction(functionName,rxName.cap(1),band->objectName(),"");
gf->setInvalid(tr("Wrong using function %1").arg(functionName));
}
}
}
}
}
void ReportRender::replaceGroupsFunction(BandDesignIntf *band)
{
foreach(BaseDesignIntf* item,band->childBaseItems()){
ContentItemDesignIntf* contentItem = dynamic_cast(item);
if (contentItem){
QString content = contentItem->content();
foreach(QString functionName, DataSourceManager::instance()->groupFunctionNames()){
QRegExp rx(QString(GROUP_FUNCTION_RX).arg(functionName));
if (rx.indexIn(content)>=0){
content.replace(rx,QString("%1(%2,%3)").arg(functionName).arg('"'+rx.cap(4)+'"').arg('"'+band->objectName()+'"'));
contentItem->setContent(content);
}
}
}
}
}
void ReportRender::renderBand(BandDesignIntf *patternBand, ReportRender::DataRenderMode mode, bool isLast)
{
QApplication::processEvents();
if (patternBand){
BandDesignIntf* bandClone=renderData(patternBand);
patternBand->emitBandRendered(bandClone);
if ( isLast && bandClone->keepFooterTogether() && bandClone->sliceLastRow() ){
if (m_currentMaxHeight < (bandClone->height()+m_reportFooterHeight))
m_currentMaxHeight -= ((m_currentMaxHeight-bandClone->height())+(bandClone->height()*calcSlicePercent(bandClone->height())));
}
if (!bandClone->isEmpty() || patternBand->printIfEmpty()){
if (!registerBand(bandClone)){
if (bandClone->canBeSplitted(m_currentMaxHeight)){
bandClone = sliceBand(bandClone,patternBand,isLast);
} else {
qreal percent = (bandClone->height()-m_currentMaxHeight)/(bandClone->height()/100);
if (bandClone->maxScalePercent()>=percent){
if (percentmaxScalePercent()){
percent += 2;
bandClone->setScale((100-percent)/100);
bandClone->setHeight(m_currentMaxHeight);
registerBand(bandClone);
}
} else {
if (mode==StartNewPage){
savePage();
startNewPage();
if (!registerBand(bandClone)) {
bandClone->setHeight(m_currentMaxHeight);
registerBand(bandClone);
};
}
else {
bandClone->setHeight(m_currentMaxHeight);
registerBand(bandClone);
}
}
}
}
}
if (patternBand->isFooter())
datasources()->clearGroupFunctionValues(patternBand->objectName());
}
}
void ReportRender::renderDataBand(BandDesignIntf *dataBand)
{
IDataSource* bandDatasource = 0;
if (dataBand)
bandDatasource = datasources()->dataSource(dataBand->datasourceName());
if(bandDatasource && !bandDatasource->eof() && !m_renderCanceled){
QString varName = QLatin1String("line_")+dataBand->objectName().toLower();
datasources()->setReportVariable(varName,1);
renderBand(dataBand->bandHeader());
renderChildHeader(dataBand,PrintNotAlwaysPrintable);
renderGroupHeader(dataBand,bandDatasource);
while(!bandDatasource->eof() && !m_renderCanceled){
if (dataBand->tryToKeepTogether()) openDataGroup(dataBand);
if (dataBand->keepFooterTogether() && !bandDatasource->hasNext())
openFooterGroup(dataBand);
datasources()->updateChildrenData(dataBand->datasourceName());
m_lastDataBand = dataBand;
renderBand(dataBand,StartNewPage,!bandDatasource->hasNext());
renderChildBands(dataBand);
bandDatasource->next();
datasources()->setReportVariable(varName,datasources()->variable(varName).toInt()+1);
foreach (BandDesignIntf* band, dataBand->childrenByType(BandDesignIntf::GroupHeader)){
QString groupLineVar = QLatin1String("line_")+band->objectName().toLower();
if (datasources()->containsVariable(groupLineVar))
datasources()->setReportVariable(groupLineVar,datasources()->variable(groupLineVar).toInt()+1);
}
renderGroupHeader(dataBand,bandDatasource);
if (dataBand->tryToKeepTogether()) closeDataGroup(dataBand);
}
renderBand(dataBand->bandFooter());
renderGroupFooter(dataBand);
//renderChildFooter(dataBand,PrintNotAlwaysPrintable);
datasources()->deleteVariable(varName);
} else if (bandDatasource==0) {
renderBand(dataBand,StartNewPage);
}
}
void ReportRender::renderPageHeader(PageItemDesignIntf *patternPage)
{
BandDesignIntf* band = patternPage->bandByType(BandDesignIntf::PageHeader);
if (band) renderBand(band);
}
void ReportRender::renderPageFooter(PageItemDesignIntf *patternPage)
{
BandDesignIntf* band = patternPage->bandByType(BandDesignIntf::PageFooter);
if (band){
BandDesignIntf* bandClone = dynamic_cast(band->cloneItem(PreviewMode, m_renderPageItem,m_renderPageItem));
replaceGroupsFunction(bandClone);
bandClone->updateItemSize();
bandClone->setItemPos(m_patternPageItem->pageRect().x(),m_patternPageItem->pageRect().bottom()-bandClone->height());
bandClone->setHeight(m_pageFooterHeight);
m_currentMaxHeight+=m_pageFooterHeight;
registerBand(bandClone);
datasources()->clearGroupFunctionValues(band->objectName());
}
}
void ReportRender::renderPageItems(PageItemDesignIntf* patternPage)
{
foreach (BaseDesignIntf* item, patternPage->childBaseItems()) {
ItemDesignIntf* id = dynamic_cast(item);
if (id&&id->itemLocation()==ItemDesignIntf::Page){
BaseDesignIntf* cloneItem = item->cloneItem(m_renderPageItem->itemMode(),
m_renderPageItem,
m_renderPageItem);
cloneItem->updateItemSize();
}
}
}
qreal ReportRender::calcPageFooterHeight(PageItemDesignIntf *patternPage)
{
BandDesignIntf* band = patternPage->bandByType(BandDesignIntf::PageFooter);
if (band){
return band->height();
}
return 0;
}
void ReportRender::renderChildHeader(BandDesignIntf *parent, BandPrintMode printMode)
{
foreach(BandDesignIntf* band,parent->childrenByType(BandDesignIntf::SubDetailHeader)){
bool printAlways=false;
if (band->metaObject()->indexOfProperty("printAlways")>0){
printAlways=band->property("printAlways").toBool();
}
if (printAlways == (printMode==PrintAlwaysPrintable) ) renderBand(band,StartNewPage);
}
}
void ReportRender::renderChildFooter(BandDesignIntf *parent, BandPrintMode printMode)
{
foreach(BandDesignIntf* band,parent->childrenByType(BandDesignIntf::SubDetailFooter)){
bool printAlways=false;
if (band->metaObject()->indexOfProperty("printAlways")>0){
printAlways=band->property("printAlways").toBool();
}
if (printAlways == (printMode==PrintAlwaysPrintable)) renderBand(band,StartNewPage);
}
}
void ReportRender::renderChildBands(BandDesignIntf *parentBand)
{
foreach(BandDesignIntf* band,parentBand->childrenByType(BandDesignIntf::SubDetailBand)){
IDataSource* ds = m_datasources->dataSource(band->datasourceName());
if (ds) ds->first();
renderChildHeader(band,PrintAlwaysPrintable);
renderDataBand(band);
renderChildFooter(band,PrintAlwaysPrintable);
closeFooterGroup(band);
}
}
void ReportRender::renderGroupHeader(BandDesignIntf *parentBand, IDataSource* dataSource)
{
foreach(BandDesignIntf* band,parentBand->childrenByType(BandDesignIntf::GroupHeader)){
IGroupBand* gb = dynamic_cast(band);
if (gb&&gb->isNeedToClose()){
if (band->childBands().count()>0){
dataSource->prior();
foreach (BandDesignIntf* subBand, parentBand->childrenByType(BandDesignIntf::GroupHeader)) {
if ( (subBand->bandIndex() > band->bandIndex()) &&
(subBand->childBands().count()>0)
){
renderBand(subBand->childBands().at(0));
closeDataGroup(subBand);
}
}
renderBand(band->childBands().at(0),StartNewPage);
dataSource->next();
}
closeDataGroup(band);
}
if (!gb->isStarted()){
gb->startGroup();
openDataGroup(band);
renderBand(band,StartNewPage);
}
}
}
void ReportRender::renderGroupFooter(BandDesignIntf *parentBand)
{
foreach(BandDesignIntf* band,parentBand->childrenByType(BandDesignIntf::GroupHeader)){
IGroupBand* gb = dynamic_cast(band);
if (gb->isStarted()){
if (band->childBands().count()>0){
renderBand(band->childBands().at(0),StartNewPage);
}
closeDataGroup(band);
}
}
}
void ReportRender::initGroupFunctions()
{
m_datasources->clearGroupFunction();
foreach(BandDesignIntf* band, m_patternPageItem->childBands()){
if (band->isFooter()) extractGroupsFunction(band);
}
}
void ReportRender::popPageFooterGroupValues(BandDesignIntf *dataBand)
{
BandDesignIntf* pageFooter = m_patternPageItem->bandByType(BandDesignIntf::PageFooter);
if (pageFooter){
foreach(GroupFunction* gf, datasources()->groupFunctionsByBand(pageFooter->objectName())){
if ((gf->dataBandName()==dataBand->objectName())){
// FIXME Probably coincidence Field and Variables
if ((!m_popupedExpression.contains(dataBand))||(!m_popupedExpression.values(dataBand).contains(gf->data()))){
m_popupedExpression.insert(dataBand,gf->data());
m_popupedValues.insert(QString::number((long)dataBand,16)+'|'+gf->data(), gf->values()[gf->values().count()-1]);
gf->values().pop_back();
}
}
}
}
}
void ReportRender::pushPageFooterGroupValues(BandDesignIntf *dataBand)
{
BandDesignIntf* pageFooter = m_patternPageItem->bandByType(BandDesignIntf::PageFooter);
if (pageFooter){
foreach(GroupFunction* gf, datasources()->groupFunctionsByBand(pageFooter->objectName())){
if ((gf->dataBandName()==dataBand->objectName())){
// FIXME Probably coincidence Field and Variables
if ((m_popupedExpression.contains(dataBand))&&(m_popupedExpression.values(dataBand).contains(gf->data()))){
gf->values().push_back(m_popupedValues.value(QString::number((long)dataBand,16)+'|'+gf->data()));
}
}
}
}
}
void ReportRender::closeGroup(BandDesignIntf *band)
{
QMultiMap< BandDesignIntf*, GroupBandsHolder* >::iterator it;
it = m_childBands.find(band);
while (it!=m_childBands.end()&&it.key()==band){
GroupBandsHolder* bl = it.value();
if (bl){
bl->clear();
delete bl;
}
it++;
}
m_childBands.remove(band);
}
void ReportRender::openDataGroup(BandDesignIntf *band)
{
m_childBands.insert(band,new GroupBandsHolder(band->tryToKeepTogether()));
}
void ReportRender::openFooterGroup(BandDesignIntf *band)
{
GroupBandsHolder* holder = new GroupBandsHolder(true);
holder->setIsFooterGroup();
m_childBands.insert(band,holder);
}
void ReportRender::closeDataGroup(BandDesignIntf *band)
{
IGroupBand* groupBand = dynamic_cast(band);
if (groupBand)
groupBand->closeGroup();
closeGroup(band);
}
void ReportRender::closeFooterGroup(BandDesignIntf *band){
closeGroup(band);
}
bool ReportRender::registerBand(BandDesignIntf *band, bool registerInChildren)
{
if (band->height()<=m_currentMaxHeight){
m_currentMaxHeight-=band->height();
if (band->bandType()!=BandDesignIntf::PageFooter){
band->setPos(m_renderPageItem->pageRect().x(),m_currentStartDataPos);
m_currentStartDataPos+=band->height();
band->setBandIndex(++m_currentIndex);
}
m_renderPageItem->registerBand(band);
foreach(QList* list,m_childBands.values()){
if (registerInChildren &&
band->bandType()!=BandDesignIntf::PageHeader &&
band->bandType()!=BandDesignIntf::PageFooter &&
band->bandType()!=BandDesignIntf::ReportHeader &&
band->bandType()!=BandDesignIntf::ReportFooter &&
!list->contains(band)
)
list->append(band);
}
if (band->isData()) m_renderedDataBandCount++;
return true;
} else return false;
}
qreal ReportRender::calcSlicePercent(qreal height){
return (height*3/(m_dataAreaSize))/100;
}
BandDesignIntf* ReportRender::sliceBand(BandDesignIntf *band, BandDesignIntf* patternBand, bool isLast)
{
while (band->height()>m_currentMaxHeight) {
band = saveUppperPartReturnBottom(band,m_currentMaxHeight,patternBand);
if (!band->isEmpty()) {
band->setHeight(0);
band->updateItemSize();
DataBandDesignIntf* data = dynamic_cast(band);
if (isLast && data && data->keepFooterTogether() &&
band->height()sliceLastRow()
){
if (band->height()>(m_currentMaxHeight-m_reportFooterHeight)){
m_currentMaxHeight -= ((m_currentMaxHeight-band->height())+(band->height()*calcSlicePercent(band->height())));
}
}
if (registerBand(band)) break;
}
}
if (band->isEmpty()) {
delete band;
band = 0;
}
return band;
}
void ReportRender::secondRenderPass()
{
foreach(PageItemDesignIntf::Ptr page, m_renderedPages){
foreach(BandDesignIntf* band, page->childBands()){
band->updateItemSize(SecondPass);
}
}
}
BandDesignIntf *ReportRender::saveUppperPartReturnBottom(BandDesignIntf *band, int height, BandDesignIntf* patternBand)
{
int sliceHeight = height;
BandDesignIntf* upperBandPart = dynamic_cast(band->cloneUpperPart(sliceHeight));
BandDesignIntf* bottomBandPart = dynamic_cast(band->cloneBottomPart(sliceHeight));
if (!bottomBandPart->isEmpty()){
//bottomBandPart->updateItemSize(FirstPass,height);
if (patternBand->keepFooterTogether())
closeFooterGroup(patternBand);
}
if (!upperBandPart->isEmpty()){
upperBandPart->updateItemSize(FirstPass,height);
registerBand(upperBandPart);
} else delete upperBandPart;
savePage();
startNewPage();
// if (!bottomBandPart->isEmpty() && patternBand->keepFooterTogether())
// openFooterGroup(patternBand);
delete band;
return bottomBandPart;
}
BandDesignIntf *ReportRender::renderData(BandDesignIntf *patternBand)
{
BandDesignIntf* bandClone = dynamic_cast(patternBand->cloneItem(PreviewMode));
if (patternBand->isFooter()){
replaceGroupsFunction(bandClone);
}
bandClone->updateItemSize();
return bandClone;
}
void ReportRender::startNewPage()
{
m_renderPageItem=0;
initRenderPage();
m_renderPageItem->setObjectName(QLatin1String("ReportPage")+QString::number(m_pageCount));
m_currentMaxHeight=m_renderPageItem->pageRect().height();
m_currentStartDataPos=m_patternPageItem->topMargin()*mmFACTOR;
m_currentIndex=0;
renderPageHeader(m_patternPageItem);
m_pageFooterHeight = calcPageFooterHeight(m_patternPageItem);
m_currentMaxHeight -= m_pageFooterHeight;
m_currentIndex=10;
m_dataAreaSize = m_currentMaxHeight;
m_renderedDataBandCount = 0;
pasteGroups();
renderPageItems(m_patternPageItem);
}
void ReportRender::cutGroups()
{
m_popupedExpression.clear();
m_popupedValues.clear();
foreach(BandDesignIntf* groupBand,m_childBands.keys()){
if (m_childBands.value(groupBand)->tryToKeepTogether()){
foreach(BandDesignIntf* band, *m_childBands.value(groupBand)){
m_renderPageItem->removeBand(band);
popPageFooterGroupValues(band);
band->setParent(0);
band->setParentItem(0);
}
}
}
}
void ReportRender::checkFooterGroup(BandDesignIntf *groupBand)
{
if (m_childBands.contains(groupBand)){
GroupBandsHolder* holder = m_childBands.value(groupBand);
foreach(BandDesignIntf* band, *holder){
qreal percent = band->height()*100 / m_dataAreaSize;
if (m_renderedDataBandCount<=1 || percent>20 ){
holder->removeAll(band);
}
}
}
}
void ReportRender::pasteGroups()
{
BandDesignIntf* groupBand = findEnclosingGroup();
if (groupBand){
foreach(BandDesignIntf* band, *m_childBands.value(groupBand)){
registerBand(band,false);
if (band->isData()) m_renderedDataBandCount++;
pushPageFooterGroupValues(band);
}
foreach(GroupBandsHolder* holder, m_childBands.values())
holder->setTryToKeepTogether(false);
}
m_popupedExpression.clear();
m_popupedValues.clear();
}
BandDesignIntf* ReportRender::findEnclosingGroup()
{
BandDesignIntf* result=0;
int groupIndex = -1;
if (!m_childBands.isEmpty()){
foreach(BandDesignIntf* gb, m_childBands.keys()){
if (m_childBands.value(gb)->tryToKeepTogether()&&
((gb->bandIndex()bandIndex();
}
}
}
return result;
}
void ReportRender::savePage()
{
checkFooterGroup(m_lastDataBand);
cutGroups();
renderPageFooter(m_patternPageItem);
m_pageCount++;
m_datasources->setReportVariable("#PAGE",m_pageCount);
m_datasources->setReportVariable("#PAGE_COUNT",m_pageCount-1);
BandDesignIntf* pageFooter = m_renderPageItem->bandByType(BandDesignIntf::PageFooter);
if (pageFooter) pageFooter->setBandIndex(++m_currentIndex);
m_renderedPages.append(PageItemDesignIntf::Ptr(m_renderPageItem));
emit pageRendered(m_pageCount);
}
QString ReportRender::toString()
{
QScopedPointer writer(new XMLWriter());
foreach(PageItemDesignIntf::Ptr page,m_renderedPages){
writer->putItem(page.data());
}
return writer->saveToString();
}
ReportRender::~ReportRender(){
m_renderedPages.clear();
}
void ReportRender::cancelRender(){
m_renderCanceled = true;
}
}