ksayit/src/docbookclasses.cpp

   1 //
   2 // C++ Implementation: docbookclasses
   3 //
   4 // Description:
   5 //
   6 //
   7 // Author: Robert Vogl <voglrobe@lapislazuli>, (C) 2004
   8 //
   9 // Copyright: See COPYING file that comes with this distribution
  10 //
  11 //
  12 // Qt includes
  13 #include <qwidget.h>
  14 #include <QTextStream>
  15 #include <QPixmap>
  16 #include <QRegExp>
  17
  18 // tests
  19 #include <QFile>
  20
  21
  22 //KDE includes
  23 #include <kdebug.h>
  24 #include <kglobal.h>
  25 #include <klocale.h>
  26 #include <kiconloader.h>
  27 #include <kmessagebox.h>
  28
  29 // App specific includes
  30 #include "parasaxparser.h"
  31 #include "docbookclasses.h"
  32
  33
  34 //////////////////////////////////////
  35 // Interface
  36 //////////////////////////////////////
  37 ListViewInterface::ListViewInterface(ListViewInterface *parent, QString label)
  38     : K3ListViewItem( parent, label )
  39 {
  40 }
  41
  42 ListViewInterface::ListViewInterface(ListViewInterface *parent, ListViewInterface *after, QString label) : K3ListViewItem( parent, after, label )
  43 {
  44 }
  45
  46 ListViewInterface::ListViewInterface(K3ListView *lv, QString label)
  47     : K3ListViewItem( lv, label )
  48 {
  49 }
  50
  51
  52 //////////////////////////////////////
  53 // Classes for Roberts elements
  54 //////////////////////////////////////
  55 /**
  56  * RobDocument
  57  */
  58 RobDocument::RobDocument(K3ListView *lv, QString label)
  59     : ListViewInterface( lv, label )
  60 {
  61     QPixmap pixmap = KIconLoader::global()->loadIcon("help-contents", K3Icon::Small);
  62     this->setPixmap(0, pixmap);
  63     m_iseditable = false;
  64 }
  65
  66 RobDocument::~RobDocument()
  67 {
  68 }
  69
  70 QString RobDocument::getRTFHeader() const
  71 {
  72     QString header = "<H1><center>" + this->text(0) + "</center></H1>";
  73     return header;
  74 }
  75
  76 QString RobDocument::getHeader() const
  77 {
  78     QString header = this->text(0) + '\n';
  79     return header;
  80 }
  81
  82
  83
  84 //////////////////////////////////////
  85 // Classes for Docbook elements
  86 //////////////////////////////////////
  87 /**
  88  * Overview
  89  */
  90 Overview::Overview(ListViewInterface *parent, ListViewInterface *after, QString label)
  91     : ListViewInterface(parent, after, label)
  92 {
  93     QPixmap pixmap = KIconLoader::global()->loadIcon("document-new", K3Icon::Small);
  94     this->setPixmap(0, pixmap);
  95     this->setText(3, "0"); // upmost element
  96     m_iseditable = false;
  97 }
  98
  99 Overview::~Overview()
 100 {
 101 }
 102
 103 QString Overview::getRTFHeader() const
 104 {
 105     QString header = "<H1>" + this->text(0) + "</H1>";
 106     return header;
 107 }
 108
 109 QString Overview::getHeader() const
 110 {
 111     QString header = this->text(0) + '\n';
 112     return header;
 113 }
 114
 115
 116 /**
 117  * Date
 118  */
 119 Date::Date(ListViewInterface *parent, ListViewInterface *after, QString label)
 120     : ListViewInterface(parent, after, label)
 121 {
 122     QPixmap pixmap = KIconLoader::global()->loadIcon("document-new", K3Icon::Small);
 123     this->setPixmap(0, pixmap);
 124     this->setText(3, "00000001");
 125     m_node = QDomNode();
 126     m_iseditable = false;
 127 }
 128
 129 Date::~Date()
 130 {
 131 }
 132
 133 void Date::setNodes( const NodeList_type &list )
 134 {
 135     if ( !list.empty() )
 136         m_node = list.front();
 137 }
 138
 139 void Date::getNodes( NodeList_type &list ) const
 140 {
 141     list.push_back( m_node );
 142 }
 143
 144 QString Date::getRTFHeader() const
 145 {
 146     QString header = "<B>" + this->text(0) + ": </B>";
 147     return header;
 148 }
 149
 150 QString Date::getHeader() const
 151 {
 152     QString header = this->text(0) + ": ";
 153     return header;
 154 }
 155
 156 QString Date::getRTFData() const
 157 {
 158     if ( !m_node.isNull() ){
 159         QString date = m_node.nodeValue() + "<br>";
 160         return date;
 161     } else
 162         return QString();
 163 }
 164
 165 QString Date::getData() const
 166 {
 167     if ( !m_node.isNull() ){
 168         return m_node.nodeValue();
 169     } else
 170         return QString();
 171 }
 172
 173 QString Date::getRawData() const
 174 {
 175     QString ret;
 176
 177     // get content of element
 178     QTextStream in(&ret, QIODevice::WriteOnly);
 179     in.setEncoding(QTextStream::UnicodeUTF8);
 180     in << m_node;
 181
 182     return ret;
 183 }
 184
 185 void Date::setData(const QString &data, QDomDocument &)
 186 {
 187     m_node.setNodeValue(data);
 188     this->setText(1, data); // update ListView
 189 }
 190
 191
 192 /**
 193  * ReleaseInfo
 194  */
 195 ReleaseInfo::ReleaseInfo(ListViewInterface *parent, ListViewInterface *after, QString label)
 196     : ListViewInterface(parent, after, label)
 197 {
 198     QPixmap pixmap = KIconLoader::global()->loadIcon("document-new", K3Icon::Small);
 199     this->setPixmap(0, pixmap);
 200     this->setText(3, "00000002");
 201     m_node = QDomNode();
 202     m_iseditable = false;
 203 }
 204
 205 ReleaseInfo::~ReleaseInfo()
 206 {
 207 }
 208
 209 void ReleaseInfo::setNodes( const NodeList_type &list )
 210 {
 211     if ( !list.empty() )
 212         m_node = list.front();
 213 }
 214
 215 void ReleaseInfo::getNodes( NodeList_type &list ) const
 216 {
 217     list.push_back( m_node );
 218 }
 219
 220 QString ReleaseInfo::getRTFHeader() const
 221 {
 222     QString header = "<B>" + this->text(0) + ": </B>";
 223     return header;
 224 }
 225
 226 QString ReleaseInfo::getHeader() const
 227 {
 228     QString header = this->text(0) + ": ";
 229     return header;
 230 }
 231
 232 QString ReleaseInfo::getRTFData() const
 233 {
 234     if ( !m_node.isNull() ){
 235         QString releaseinfo = m_node.nodeValue() + "<br>";
 236         return releaseinfo;
 237     } else
 238         return QString();
 239 }
 240
 241 QString ReleaseInfo::getData() const
 242 {
 243     if ( !m_node.isNull() ){
 244         return m_node.nodeValue();
 245     } else
 246         return QString();
 247 }
 248
 249 QString ReleaseInfo::getRawData() const
 250 {
 251     QString ret;
 252
 253     // get content of element
 254     QTextStream in(&ret, QIODevice::WriteOnly);
 255     in.setEncoding(QTextStream::UnicodeUTF8);
 256     in << m_node;
 257
 258     return ret;
 259 }
 260
 261 void ReleaseInfo::setData(const QString &data, QDomDocument &)
 262 {
 263     m_node.setNodeValue(data);
 264     this->setText(1, data); // update ListView
 265 }
 266
 267
 268 /**
 269  * Authorgroup
 270  */
 271 AuthorGroup::AuthorGroup(ListViewInterface *parent, ListViewInterface *after, QString label)
 272     : ListViewInterface(parent, after, label)
 273 {
 274     QPixmap pixmap = KIconLoader::global()->loadIcon("kdmconfig", K3Icon::Small);
 275     this->setPixmap(0, pixmap);
 276     this->setText(3, "00000003");
 277     m_iseditable = false;
 278 }
 279
 280 AuthorGroup::~AuthorGroup()
 281 {
 282 }
 283
 284 QString AuthorGroup::getRTFHeader() const
 285 {
 286     QString header = "<H2>" + this->text(0) + "</H2>";
 287     return header;
 288 }
 289
 290 QString AuthorGroup::getHeader() const
 291 {
 292     QString header = this->text(0) + '\n';
 293     return header;
 294 }
 295
 296
 297 /**
 298  * Author
 299  */
 300 Author::Author(ListViewInterface *parent, ListViewInterface *after, QString label)
 301     : ListViewInterface(parent, after, label)
 302 {
 303     QPixmap pixmap = KIconLoader::global()->loadIcon("personal", K3Icon::Small);
 304     this->setPixmap(0, pixmap);
 305     m_node1 = QDomNode();
 306     m_node2 = QDomNode();
 307     m_iseditable = false;
 308 }
 309
 310 Author::~Author()
 311 {
 312 }
 313
 314 void Author::setNodes( const NodeList_type &list )
 315 {
 316     NodeList_type l_list = list;
 317     NodeList_type::iterator it = l_list.begin();
 318     m_node1 = *it;
 319     m_node2 = *(++it);
 320 }
 321
 322 void Author::getNodes( NodeList_type &list ) const
 323 {
 324     list.push_back( m_node1 );
 325     list.push_back( m_node2 );
 326 }
 327
 328
 329 QString Author::getRTFHeader() const
 330 {
 331     QString header = "<B>" + this->text(0) + ": </B>";
 332     return header;
 333 }
 334
 335 QString Author::getHeader() const
 336 {
 337     QString author = this->text(0) + ": ";
 338     return author;
 339 }
 340
 341 QString Author::getRTFData() const
 342 {
 343     QString ret = QString();
 344     if ( !m_node1.isNull() ){
 345         ret = m_node1.nodeValue() + ' ';
 346     }
 347
 348     if ( !m_node2.isNull() ){
 349         ret += m_node2.nodeValue() + "<br>";
 350     }
 351     return ret;
 352 }
 353
 354 QString Author::getData() const
 355 {
 356     QString ret = QString();
 357     if ( !m_node1.isNull() ){
 358         ret = m_node1.nodeValue() + ' ';
 359     }
 360
 361     if ( !m_node2.isNull() ){
 362         ret += m_node2.nodeValue();
 363     }
 364     return ret;
 365 }
 366
 367 QString Author::getRawData() const
 368 {
 369     QString ret = QString();
 370     if ( !m_node1.isNull() ){
 371         ret = m_node1.nodeValue() + ' ';
 372     }
 373
 374     if ( !m_node2.isNull() ){
 375         ret += m_node2.nodeValue();
 376     }
 377     return ret;
 378 }
 379
 380 void Author::setData(const QString &data, QDomDocument &)
 381 {
 382     // canonify string
 383     QString m_data = data;
 384     m_data.replace( QRegExp("\n"), "" ); // remove Newlines
 385     m_data.replace( QRegExp(" {2,}"), " " ); // remove multiple spaces
 386     m_data.replace( QRegExp("[\t|\r]{1,}"), ""); // remove Tabs
 387     // split string "firstname surname"
 388     QString firstname = m_data.section(' ', 0, 0);
 389     QString surname = m_data.section(' ', 1, 1);
 390     // update node elements
 391     m_node1.setNodeValue(firstname);
 392     m_node2.setNodeValue(surname);
 393     // update Listview
 394     this->setText(1, firstname + ' ' + surname);
 395 }
 396
 397
 398 /**
 399  * KeywordSet
 400  */
 401 KeywordSet::KeywordSet(ListViewInterface *parent, ListViewInterface *after, QString label)
 402     : ListViewInterface(parent, after, label)
 403 {
 404     QPixmap pixmap = KIconLoader::global()->loadIcon("txt", K3Icon::Small);
 405     this->setPixmap(0, pixmap);
 406     this->setText(3, "00000004");
 407     m_iseditable = false;
 408 }
 409
 410 KeywordSet::~KeywordSet()
 411 {
 412 }
 413
 414 QString KeywordSet::getRTFHeader() const
 415 {
 416     QString header = "<H2>" + this->text(0) + "</H2>";
 417     return header;
 418 }
 419
 420 QString KeywordSet::getHeader() const
 421 {
 422     QString header = this->text(0) + '\n';
 423     return header;
 424 }
 425
 426
 427 /**
 428  * Keyword
 429  */
 430 Keyword::Keyword(ListViewInterface *parent, ListViewInterface *after, QString label)
 431     : ListViewInterface(parent, after, label)
 432 {
 433     m_node = QDomNode();
 434     m_iseditable = false;
 435 }
 436
 437 Keyword::~Keyword()
 438 {
 439 }
 440
 441 void Keyword::setNodes( const NodeList_type &list )
 442 {
 443     if ( !list.empty() )
 444         m_node = list.front();
 445 }
 446
 447 void Keyword::getNodes( NodeList_type &list ) const
 448 {
 449     list.push_back( m_node );
 450 }
 451
 452 QString Keyword::getRTFData() const
 453 {
 454     if ( !m_node.isNull() ){
 455         QString keyword = m_node.nodeValue() + "<br>";
 456         return keyword;
 457     } else
 458         return QString();
 459 }
 460
 461 QString Keyword::getData() const
 462 {
 463     if ( !m_node.isNull() ){
 464         return m_node.nodeValue();
 465     } else
 466         return QString();
 467 }
 468
 469 QString Keyword::getRawData() const
 470 {
 471     QString ret;
 472
 473     // get content of element
 474     QTextStream in(&ret, QIODevice::WriteOnly);
 475     in.setEncoding(QTextStream::UnicodeUTF8);
 476     in << m_node;
 477
 478     return ret;
 479 }
 480
 481 void Keyword::setData(const QString &data, QDomDocument &)
 482 {
 483     m_node.setNodeValue(data);
 484     this->setText(0, data); // update ListView
 485 }
 486
 487
 488 /**
 489  * Abstract
 490  */
 491 Abstract::Abstract(ListViewInterface *parent, ListViewInterface *after, QString label)
 492     : ListViewInterface(parent, after, label)
 493 {
 494     QPixmap pixmap = KIconLoader::global()->loadIcon("document-new", K3Icon::Small);
 495     this->setPixmap(0, pixmap);
 496     this->setText(3, "00000005");
 497     m_iseditable = false;
 498 }
 499
 500 Abstract::~Abstract()
 501 {
 502 }
 503
 504 QString Abstract::getRTFHeader() const
 505 {
 506     QString header = "<H2>" + this->text(0) + "</H2>";
 507     return header;
 508 }
 509
 510 QString Abstract::getHeader() const
 511 {
 512     QString header = this->text(0) + '\n';
 513     return header;
 514 }
 515
 516
 517 /**
 518  * Para
 519  */
 520 Para::Para(ListViewInterface *parent, ListViewInterface *after, QString label)
 521     : ListViewInterface(parent, after, label)
 522 {
 523     QPixmap pixmap = KIconLoader::global()->loadIcon("leftjust", K3Icon::Small);
 524     this->setPixmap(0, pixmap);
 525     m_node = QDomNode();
 526     m_iseditable = false;
 527 }
 528
 529 Para::~Para()
 530 {
 531 }
 532
 533 void Para::setNodes( const NodeList_type &list )
 534 {
 535     if ( !list.empty() )
 536         m_node = list.front();
 537 }
 538
 539 void Para::getNodes( NodeList_type &list ) const
 540 {
 541     list.push_back( m_node );
 542 }
 543
 544 QString Para::getRTFHeader() const
 545 {
 546     return QString();
 547 }
 548
 549 QString Para::getHeader() const
 550 {
 551     QString header = this->text(0) + '\n';
 552     return header;
 553 }
 554
 555 QString Para::getRTFData() const
 556 {
 557     // get content of element
 558     QString paragraph;
 559     QTextStream in(&paragraph, QIODevice::WriteOnly);
 560     in.setEncoding(QTextStream::UnicodeUTF8);
 561     in << m_node;
 562
 563     // delegate job to SAX-Parser
 564     QString data;
 565     QString ret;
 566
 567     ParaSaxParser *p = ParaSaxParser::Instance();
 568     p->setData( paragraph );
 569     p->getRTFText( data );
 570     ret = "<p>" + data + "</p>";
 571
 572     return ret;
 573 }
 574
 575 QString Para::getData() const
 576 {
 577     // get content of element
 578     QString paragraph;
 579     QTextStream in(&paragraph, QIODevice::WriteOnly);
 580     in.setEncoding(QTextStream::UnicodeUTF8);
 581     in << m_node;
 582
 583     // delegate job to SAX-Parser
 584     QString data;
 585
 586     ParaSaxParser *p = ParaSaxParser::Instance();
 587     p->setData( paragraph );
 588     p->getText( data );
 589
 590     return data;
 591 }
 592
 593 QString Para::getRawData() const
 594 {
 595     QString ret;
 596
 597     // get content of element
 598     QTextStream in(&ret, QIODevice::WriteOnly);
 599     in.setEncoding(QTextStream::UnicodeUTF8);
 600     in << m_node;
 601     // remove opening and closing para-tags
 602     ret.replace( QRegExp("</?(para|Para|PARA)/?>"),"");
 603     ret.replace( QRegExp("^ "),"" );
 604     ret.replace( QRegExp("^\n"), "" );
 605
 606     return ret;
 607 }
 608
 609 void Para::setData(const QString &data, QDomDocument &)
 610 {
 611     kDebug(100200) << "Para::setData()" << endl;
 612
 613     // add tags
 614     QString l_data = "<para>\n" + data + "\n</para>";
 615
 616     // create a temporary document
 617     QString err;
 618     QDomDocument tempDoc;
 619     if ( !tempDoc.setContent(l_data) ){
 620         l_data = "<para><![CDATA[\n" + data + "\n]]></para>";
 621         // try again
 622         if ( !tempDoc.setContent(l_data) ){
 623             err = i18n("Unable to make document persistent.");
 624             kDebug() << err << endl;
 625             // throw err;
 626             return;
 627         }
 628         err = i18n("This paragraph contains mismatching tags. It will will be handled as CDATA.");
 629         KMessageBox::information(0, err, i18n("XML-Error"));
 630     }
 631
 632     // get parent
 633     QDomNode parent = m_node.parentNode();
 634     if ( parent.isNull() ){
 635         kDebug(100200) << "Para::setData(): Structural DocBook format error." << endl;
 636         return;
 637     }
 638
 639     // replace Node
 640     parent.replaceChild(tempDoc, m_node);
 641     m_node = tempDoc;
 642 }
 643
 644
 645 /**
 646  * Chapter
 647  */
 648 Chapter::Chapter(ListViewInterface *parent, ListViewInterface *after, QString label)
 649     : ListViewInterface(parent, after, label)
 650 {
 651     QPixmap pixmap = KIconLoader::global()->loadIcon("leftjust", K3Icon::Small);
 652     this->setPixmap(0, pixmap);
 653     m_iseditable = false;
 654 }
 655
 656 Chapter::~Chapter()
 657 {
 658 }
 659
 660 QString Chapter::getRTFHeader() const
 661 {
 662     QString header = "<H1>" + this->text(0) + "</H1>";
 663     return header;
 664 }
 665
 666 QString Chapter::getHeader() const
 667 {
 668     QString header = this->text(0) + '\n';
 669     return header;
 670 }
 671
 672
 673 /**
 674  * Sect1
 675  */
 676 Sect1::Sect1(ListViewInterface *parent, ListViewInterface *after, QString label)
 677     : ListViewInterface(parent, after, label)
 678 {
 679     QPixmap pixmap = KIconLoader::global()->loadIcon("leftjust", K3Icon::Small);
 680     this->setPixmap(0, pixmap);
 681     m_iseditable = false;
 682 }
 683
 684 Sect1::~Sect1()
 685 {
 686 }
 687
 688 QString Sect1::getRTFHeader() const
 689 {
 690     QString header = "<H2>" + this->text(0) + "</H2>";
 691     return header;
 692 }
 693
 694 QString Sect1::getHeader() const
 695 {
 696     QString header = this->text(0) + '\n';
 697     return header;
 698 }
 699
 700
 701 /**
 702  * Sect2
 703  */
 704 Sect2::Sect2(ListViewInterface *parent, ListViewInterface *after, QString label)
 705     : ListViewInterface(parent, after, label)
 706 {
 707     QPixmap pixmap = KIconLoader::global()->loadIcon("leftjust", K3Icon::Small);
 708     this->setPixmap(0, pixmap);
 709     m_iseditable = false;
 710 }
 711
 712 Sect2::~Sect2()
 713 {
 714 }
 715
 716 QString Sect2::getRTFHeader() const
 717 {
 718     QString header = "<H3>" + this->text(0) + "</H3>";
 719     return header;
 720 }
 721
 722 QString Sect2::getHeader() const
 723 {
 724     QString header = this->text(0) + '\n';
 725     return header;
 726 }
 727
 728
 729 /**
 730  * Sect3
 731  */
 732 Sect3::Sect3(ListViewInterface *parent, ListViewInterface *after, QString label)
 733     : ListViewInterface(parent, after, label)
 734 {
 735     QPixmap pixmap = KIconLoader::global()->loadIcon("leftjust", K3Icon::Small);
 736     this->setPixmap(0, pixmap);
 737     m_iseditable = false;
 738 }
 739
 740 Sect3::~Sect3()
 741 {
 742 }
 743
 744 QString Sect3::getRTFHeader() const
 745 {
 746     QString header = "<B>" + this->text(0) + "</B><br>";
 747     return header;
 748 }
 749
 750 QString Sect3::getHeader() const
 751 {
 752     QString header = this->text(0) + '\n';
 753     return header;
 754 }
 755
 756
 757 /**
 758  * Sect4
 759  */
 760 Sect4::Sect4(ListViewInterface *parent, ListViewInterface *after, QString label)
 761     : ListViewInterface(parent, after, label)
 762 {
 763     QPixmap pixmap = KIconLoader::global()->loadIcon("leftjust", K3Icon::Small);
 764     this->setPixmap(0, pixmap);
 765     m_iseditable = false;
 766 }
 767
 768 Sect4::~Sect4()
 769 {
 770 }
 771
 772 QString Sect4::getRTFHeader() const
 773 {
 774     QString header = "<B>" + this->text(0) + "</B><br>";
 775     return header;
 776 }
 777
 778 QString Sect4::getHeader() const
 779 {
 780     QString header = this->text(0) + '\n';
 781     return header;
 782 }
 783
 784
 785 /**
 786  * Sect5
 787  */
 788 Sect5::Sect5(ListViewInterface *parent, ListViewInterface *after, QString label)
 789     : ListViewInterface(parent, after, label)
 790 {
 791     QPixmap pixmap = KIconLoader::global()->loadIcon("leftjust", K3Icon::Small);
 792     this->setPixmap(0, pixmap);
 793     m_iseditable = false;
 794 }
 795
 796 Sect5::~Sect5()
 797 {
 798 }
 799
 800 QString Sect5::getRTFHeader() const
 801 {
 802     QString header = "<B>" + this->text(0) + "</B><br>";
 803     return header;
 804 }
 805
 806 QString Sect5::getHeader() const
 807 {
 808     QString header = this->text(0) + '\n';
 809     return header;
 810 }
 811