1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
|
/******************************************************************************
*
* osis2mod.cpp - Utility to import a module in OSIS format
*
* $Id: osis2mod.cpp 3177 2014-04-17 04:24:37Z greg.hellings $
*
* Copyright 2003-2014 CrossWire Bible Society (http://www.crosswire.org)
* CrossWire Bible Society
* P. O. Box 2528
* Tempe, AZ 85280-2528
*
* This program 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 version 2.
*
* This program 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.
*
*/
#ifdef _MSC_VER
#pragma warning( disable: 4251 )
#endif
#include <ctype.h>
#include <stdio.h>
#include <fcntl.h>
#include <errno.h>
#include <stdlib.h>
#include <stack>
#include <vector>
#include <iostream>
#include <fstream>
#include <utilstr.h>
#include <swmgr.h>
#include <rawtext.h>
#include <rawtext4.h>
#include <swbuf.h>
#include <utilxml.h>
#include <listkey.h>
#include <versekey.h>
#include <ztext.h>
#include <lzsscomprs.h>
#include <zipcomprs.h>
#include <cipherfil.h>
#ifdef _ICU_
#include <utf8nfc.h>
#include <latin1utf8.h>
#endif
#ifndef NO_SWORD_NAMESPACE
using namespace sword;
#endif
using namespace std;
int debug = 0; // mask of debug flags
const int DEBUG_WRITE = 1; // writing to module
const int DEBUG_VERSE = 2; // verse start and end
const int DEBUG_QUOTE = 4; // quotes, especially Words of Christ (WOC)
const int DEBUG_TITLE = 8; // titles
const int DEBUG_INTERVERSE = 16; // inter-verse maerial
const int DEBUG_XFORM = 32; // transformations
const int DEBUG_REV11N = 64; // versification
const int DEBUG_REF = 128; // parsing of osisID and osisRef
const int DEBUG_STACK = 256; // cleanup of references
const int DEBUG_OTHER = 512; // ins and outs of books, chapters and verses
// Exit codes
const int EXIT_BAD_ARG = 1; // Bad parameter given for program
const int EXIT_NO_WRITE = 2; // Could not open the module for writing
const int EXIT_NO_CREATE = 3; // Could not create the module
const int EXIT_NO_READ = 4; // Could not open the input file for reading.
const int EXIT_BAD_NESTING = 5; // BSP or BCV nesting is bad
#ifdef _ICU_
UTF8NFC normalizer;
Latin1UTF8 converter;
#endif
int normalized = 0;
int converted = 0;
SWText *module = 0;
VerseKey currentVerse;
SWBuf v11n = "KJV";
char activeOsisID[255];
char currentOsisID[255];
SWBuf activeVerseText;
ListKey currentKeyIDs = ListKey();
std::vector<ListKey> linkedVerses;
static bool inCanonicalOSISBook = true; // osisID is for a book that is not in Sword's canon
static bool normalize = true; // Whether to normalize UTF-8 to NFC
bool isOSISAbbrev(const char *buf) {
VersificationMgr *vmgr = VersificationMgr::getSystemVersificationMgr();
const VersificationMgr::System *av11n = vmgr->getVersificationSystem(currentVerse.getVersificationSystem());
return av11n->getBookNumberByOSISName(buf) >= 0;
}
/**
* Determine whether the string contains a valid unicode sequence.
* The following table give the pattern of a valid UTF-8 character.
* Unicode Range 1st 2nd 3rd 4th
* U-00000000 - U-0000007F 0nnnnnnn
* U-00000080 - U-000007FF 110nnnnn 10nnnnnn
* U-00000800 - U-0000FFFF 1110nnnn 10nnnnnn 10nnnnnn
* U-00010000 - U-001FFFFF 11110nnn 10nnnnnn 10nnnnnn 10nnnnnn
* Note:
* 1. The latest UTF-8 RFC allows for a max of 4 bytes.
* Earlier allowed 6.
* 2. The number of bits of the leading byte before the first 0
* is the total number of bytes.
* 3. The "n" are the bits of the unicode codepoint.
* This routine does not check to see if the code point is in the range.
* It could.
*
* param txt the text to check
* return 1 if all high order characters form a valid unicode sequence
* -1 if there are no high order characters.
* Note: this is also a valid unicode sequence
* 0 if there are high order characters that do not form
* a valid unicode sequence
* author DM Smith
*/
int detectUTF8(const char *txt) {
unsigned int countUTF8 = 0;
int count = 0;
// Cast it to make masking and shifting easier
const unsigned char *p = (const unsigned char*) txt;
while (*p) {
// Is the high order bit set?
if (*p & 0x80) {
// Then count the number of high order bits that are set.
// This determines the number of following bytes
// that are a part of the unicode character
unsigned char i = *p;
for (count = 0; i & 0x80; count++) {
i <<= 1;
}
// Validate count:
// Count 0: bug in code that would cause core walking
// Count 1: is a pattern of 10nnnnnn,
// which does not signal the start of a unicode character
// Count 5 to 8: 111110nn, 1111110n and 11111110 and 11111111
// are not legal starts, either
if (count < 2 || count > 4) return 0;
// At this point we expect (count - 1) following characters
// of the pattern 10nnnnnn
while (--count && *++p) {
// The pattern of each following character must be: 10nnnnnn
// So, compare the top 2 bits.
if ((0xc0 & *p) != 0x80) return 0;
}
// Oops, we've run out of bytes too soon: Cannot be UTF-8
if (count) return 0;
// We have a valid UTF-8 character, so count it
countUTF8++;
}
// Advance to the next character to examine.
p++;
}
// At this point it is either UTF-8 or 7-bit ascii
return countUTF8 ? 1 : -1;
}
void prepareSWText(const char *osisID, SWBuf &text)
{
// Always check on UTF8 and report on non-UTF8 entries
int utf8State = detectUTF8(text.c_str());
// Trust, but verify.
if (!normalize && !utf8State) {
cout << "WARNING(UTF8): " << osisID << ": Should be converted to UTF-8 (" << text << ")" << endl;
}
#ifdef _ICU_
if (normalize) {
// Don't need to normalize text that is ASCII
// But assume other non-UTF-8 text is Latin1 (cp1252) and convert it to UTF-8
if (!utf8State) {
cout << "INFO(UTF8): " << osisID << ": Converting to UTF-8 (" << text << ")" << endl;
converter.processText(text, (SWKey *)2); // note the hack of 2 to mimic a real key. TODO: remove all hacks
converted++;
// Prepare for double check. This probably can be removed.
// But for now we are running the check again.
// This is to determine whether we need to normalize output of the conversion.
utf8State = detectUTF8(text.c_str());
}
// Double check. This probably can be removed.
if (!utf8State) {
cout << "ERROR(UTF8): " << osisID << ": Converting to UTF-8 (" << text << ")" << endl;
}
if (utf8State > 0) {
SWBuf before = text;
normalizer.processText(text, (SWKey *)2); // note the hack of 2 to mimic a real key. TODO: remove all hacks
if (before != text) {
normalized++;
}
}
}
#endif
}
// This routine converts an osisID or osisRef into one that SWORD can parse into a verse list
// An osisRef is made up of:
// a single osisID
// an osisID-osisID
// or
// an osisRef osisRef
//
// An osisID can have a work prefix which is terminated by a : and may have a grain
// which is started by a !
//
// However, SWORD cannot handle work prefixes or grains and expects ranges to be
// separated with a single;
void prepareSWVerseKey(SWBuf &buf) {
// This routine modifies the buf in place
char* s = buf.getRawData();
char* p = s;
bool inRange = false;
while (*p) {
if (inRange) {
if (debug & DEBUG_REF) {
cout << "DEBUG(REF): Copy range marker:" << *p << endl;;
}
// Range markers are copied as is
*s++ = *p++;
}
// Look ahead to see if we are in a work prefix
// but don't look past an osisID
char *n = p;
while (*n && *n != ':' && *n != ' ' && *n != '-') {
n++;
}
// We have found a work prefix
if (*n == ':') {
// set p to skip the work prefix
p = n + 1;
if (debug & DEBUG_REF) {
cout << "DEBUG(REF): Found a work prefix ";
for (char *x = s; x <= n; x++) {
cout << *x;
}
cout << endl;
}
}
// Now we are in the meat of an osisID.
// Copy it to its end but stop on a grain marker of '!'
if (debug & DEBUG_REF) {
cout << "DEBUG(REF): Copy osisID:";
}
while (*p && *p != '!' && *p != ' ' && *p != '-') {
if (debug & DEBUG_REF) {
cout << *p;
}
*s++ = *p++;
}
if (debug & DEBUG_REF) {
cout << endl;
}
// The ! and everything following until we hit
// the end of the osisID is part of the grain reference
if (*p == '!') {
n = p;
while (*n && *n != ' ' && *n != '-') {
n++;
}
if (debug & DEBUG_REF) {
cout << "DEBUG(REF): Found a grain suffix ";
for (char *x = p; x < n; x++) {
cout << *x;
}
cout << endl;
}
p = n;
}
// At this point we have processed an osisID
// if we are not in a range and the next characer is a -
// then we are entering a range
inRange = !inRange && *p == '-';
if (debug & DEBUG_REF) {
if (inRange) {
cout << "DEBUG(REF): Found a range" << endl;
}
}
// between ranges and stand alone osisIDs we might have whitespace
if (!inRange && *p == ' ') {
// skip this and subsequent spaces
while (*p == ' ') {
p++;
}
// replacing them all with a ';'
*s++ = ';';
if (debug & DEBUG_REF) {
cout << "DEBUG(REF): replacing space with ;. Remaining: " << p << endl;
}
}
}
// Determine whether we have modified the buffer
// We have modified the buffer if s is not sitting on the null byte of the original
if (*s) {
// null terminate the reference
*s = '\0';
// Since we modified the swbuf, we need to tell it what we have done
buf.setSize(s - buf.c_str());
if (debug & DEBUG_REF) {
cout << "DEBUG(REF): shortended keyVal to`" << buf.c_str() << "`"<< endl;
}
}
}
/**
* Determine whether a verse as given is valid for the versification.
* This is done by comparing the before and after of normalization.
*/
bool isValidRef(const char *buf) {
// Create a VerseKey that does not do auto normalization
// Note: need to turn on headings so that a heading does not get normalized anyway
// And set it to the reference under question
VerseKey before;
before.setVersificationSystem(currentVerse.getVersificationSystem());
before.setAutoNormalize(false);
before.setIntros(true);
before.setText(buf);
// If we are a heading we must bail
// These will autonormalize to the last verse of the prior chapter
if (!before.getTestament() || !before.getBook() || !before.getChapter() || !before.getVerse()) {
return true;
}
// Create a VerseKey that does do auto normalization
// And set it to the reference under question
VerseKey after;
after.setVersificationSystem(currentVerse.getVersificationSystem());
after.setAutoNormalize(true);
after.setText(buf);
if (before == after)
{
return true;
}
// If we have gotten here the reference is not in the selected versification.
// cout << "INFO(V11N): " << before << " is not in the " << currentVerse.getVersificationSystem() << " versification." << endl;
if (debug & DEBUG_REV11N) {
cout << "DEBUG(V11N): " << before << " normalizes to " << after << endl;
}
return false;
}
/**
* This routine is used to ensure that all the text in the input is saved to the module.
* Assumption: The input orders all the verses for a chapter in numerical order. Thus, any
* verses that are not in the chosen versification (v11n) follow those that are.
*
* The prior implementation of this adjusted the verse to the last one that is in the chosen v11n.
* If it the chapter were extra, then it is appended to the last verse of the last
* chapter in the chosen v11n for that book. If it is just extra verses for a chapter, then it is
* appended to the last verse of the chapter.
*
* The problem with this is when a OSIS verse refers to more than one verse, e.g.
* osisID="Gen.1.29 Gen.1.30 Gen.1.31" (Gen.1.31 is the last verse of the chapter in the chosen v11n)
* and then it is followed by Gen.1.32.
*
* This routine assumes that linking is postponed to the end so that in the example Gen.1.30-31
* are not linked but rather empty. This routine will then find the last verse in the computed
* chapter that has content.
*
* Alternative, we could have done linking as we went, but this routine would have needed
* to find the first entry in the link set and elsewhere in the code when appending to a
* verse, it would need to be checked for adjacent links and those would have needed to be adjusted.
*
* param key the key that may need to be adjusted
*/
void makeValidRef(VerseKey &key) {
VerseKey saveKey;
saveKey.setVersificationSystem(key.getVersificationSystem());
saveKey.setAutoNormalize(false);
saveKey.setIntros(true);
saveKey = key;
// Since isValidRef returned false constrain the key to the nearest prior reference.
// If we are past the last chapter set the reference to the last chapter
int chapterMax = key.getChapterMax();
if (key.getChapter() > chapterMax) {
key.setChapter(chapterMax);
}
// Either we set the chapter to the last chapter and now need to set to the last verse in the chapter
// Or the verse is beyond the end of the chapter.
// In any case we need to constrain the verse to it's chapter.
int verseMax = key.getVerseMax();
key.setVerse(verseMax);
if (debug & DEBUG_REV11N) {
cout << "DEBUG(V11N) Chapter max:" << chapterMax << ", Verse Max:" << verseMax << endl;
}
// There are three cases we want to handle:
// In the examples we are using the KJV versification where the last verse of Matt.7 is Matt.7.29.
// In each of these cases the out-of-versification, extra verse is Matt.7.30.
// 1) The "extra" verse follows the last verse in the chapter.
// <verse osisID="Matt.7.29">...</verse><verse osisID="Matt.7.30">...</verse>
// In this case re-versify Matt.7.30 as Matt.7.29.
//
// 2) The "extra" verse follows a range (a set of linked verses).
// <verse osisID="Matt.7.28-Matt.7.29">...</verse><verse osisID="Matt.7.30">...</verse>
// In this case, re-versify Matt.7.30 as Matt.7.28, the first verse in the linked set.
// Since we are post-poning linking, we want to re-reversify to the last entry in the module.
//
// 3) The last verse in the chapter is not in the input. There may be other verses missing as well.
// <verse osisID="Matt.7.8">...</verse><verse osisID="Matt.7.30">...</verse>
// In this case we should re-versify Matt.7.30 as Matt.7.29.
// However, since this and 2) are ambiguous, we'll re-reversify to the last entry in the module.
while (!key.popError() && !module->hasEntry(&key)) {
key.decrement(1);
}
cout << "INFO(V11N): " << saveKey.getOSISRef()
<< " is not in the " << key.getVersificationSystem()
<< " versification. Appending content to " << key.getOSISRef() << endl;
}
void writeEntry(SWBuf &text, bool force = false) {
char keyOsisID[255];
static const char* revision = "<milestone type=\"x-importer\" subType=\"x-osis2mod\" n=\"$Rev: 3177 $\"/>";
static bool firstOT = true;
static bool firstNT = true;
if (!inCanonicalOSISBook) {
return;
}
strcpy(keyOsisID, currentVerse.getOSISRef());
// set keyOsisID to anything that an osisID cannot be.
if (force) {
strcpy(keyOsisID, "-force");
}
static VerseKey lastKey;
lastKey.setVersificationSystem(currentVerse.getVersificationSystem());
lastKey.setAutoNormalize(0);
lastKey.setIntros(1);
VerseKey saveKey;
saveKey.setVersificationSystem(currentVerse.getVersificationSystem());
saveKey.setAutoNormalize(0);
saveKey.setIntros(1);
saveKey = currentVerse;
// If we have seen a verse and the supplied one is different then we output the collected one.
if (*activeOsisID && strcmp(activeOsisID, keyOsisID)) {
if (!isValidRef(lastKey)) {
makeValidRef(lastKey);
}
currentVerse = lastKey;
prepareSWText(activeOsisID, activeVerseText);
// Put the revision into the module
int testmt = currentVerse.getTestament();
if ((testmt == 1 && firstOT) || (testmt == 2 && firstNT)) {
VerseKey t;
t.setVersificationSystem(currentVerse.getVersificationSystem());
t.setAutoNormalize(0);
t.setIntros(1);
t = currentVerse;
currentVerse.setBook(0);
currentVerse.setChapter(0);
currentVerse.setVerse(0);
module->setEntry(revision);
currentVerse = t;
switch (testmt) {
case 1:
firstOT = false;
break;
case 2:
firstNT = false;
break;
}
}
// If the entry already exists, then append this entry to the text.
// This is for verses that are outside the chosen versification. They are appended to the prior verse.
// The space should not be needed if we retained verse tags.
if (module->hasEntry(¤tVerse)) {
module->flush();
SWBuf currentText = module->getRawEntry();
cout << "INFO(WRITE): Appending entry: " << currentVerse.getOSISRef() << ": " << activeVerseText << endl;
activeVerseText = currentText + " " + activeVerseText;
}
if (debug & DEBUG_WRITE) {
cout << "DEBUG(WRITE): " << activeOsisID << ":" << currentVerse.getOSISRef() << ": " << activeVerseText << endl;
}
module->setEntry(activeVerseText);
activeVerseText = "";
}
// The following is for initial verse content and for appending interverse content.
if (activeVerseText.length()) {
activeVerseText += text;
}
else {
// Eliminate leading whitespace on the beginning of each verse
text.trimStart();
activeVerseText = text;
}
// text has been consumed so clear it out.
text = "";
currentVerse = saveKey;
lastKey = currentVerse;
strcpy(activeOsisID, keyOsisID);
}
void linkToEntry(VerseKey &linkKey, VerseKey &dest) {
// Only link verses that are in the versification.
if (!isValidRef(linkKey)) {
return;
}
VerseKey saveKey;
saveKey.setVersificationSystem(currentVerse.getVersificationSystem());
saveKey.setAutoNormalize(0);
saveKey.setIntros(1);
saveKey = currentVerse;
currentVerse = linkKey;
cout << "INFO(LINK): Linking " << currentVerse.getOSISRef() << " to " << dest.getOSISRef() << "\n";
module->linkEntry(&dest);
currentVerse = saveKey;
}
// Return true if the content was handled or is to be ignored.
// false if the what has been seen is to be accumulated and considered later.
bool handleToken(SWBuf &text, XMLTag token) {
// Everything between the begin book tag and the first begin chapter tag is inBookIntro
static bool inBookIntro = false;
// Everything between the begin chapter tag and the first begin verse tag is inChapterIntro
static bool inChapterIntro = false;
// Flags indicating whether we are processing the content of a chapter
static bool inChapter = false;
// Flags indicating whether we are processing the content of a verse
static bool inVerse = false;
// Flags indicating whether we are processing the content of to be prepended to a verse
static bool inPreVerse = false;
static int genID = 1;
// Flag indicating whether we are in "Words of Christ"
static bool inWOC = false;
// Tag for WOC quotes within a verse
static XMLTag wocTag = "<q who=\"Jesus\" marker=\"\">";
// Flag used to indicate where useful text begins
static bool firstDiv = false;
static bool headerEnded = false;
// Retain the sID of book, chapter and verse (commentary) divs so that we can find them again.
// This relies on transformBSP.
static SWBuf sidBook = "";
static SWBuf sidChapter = "";
static SWBuf sidVerse = "";
// Stack of quote elements used to handle Words of Christ
static std::stack<XMLTag> quoteStack;
// Stack of elements used to validate that books, chapters and verses are well-formed
// This goes beyond simple xml well-formed and also considers milestoned div, chapter and verse
// to be begin and end tags, too.
// It is an error if books and chapters are not well formed (though not required by OSIS)
// It is a warning that verses are not well formed (because some clients are not ready)
static std::stack<XMLTag> tagStack;
// The following are used to validate well-formedness
static int chapterDepth = 0;
static int bookDepth = 0;
static int verseDepth = 0;
int tagDepth = tagStack.size();
SWBuf tokenName = token.getName();
bool isEndTag = token.isEndTag() || token.getAttribute("eID");
SWBuf typeAttr = token.getAttribute("type");
SWBuf eidAttr = token.getAttribute("eID");
// process start tags
if (!isEndTag) {
// Remember non-empty start tags
if (!token.isEmpty()) {
tagStack.push(token);
if (debug & DEBUG_STACK) {
cout << "DEBUG(STACK): " << currentOsisID << ": push (" << tagStack.size() << ") " << token.getName() << endl;
}
}
// throw away everything up to the first div (that is outside the header)
if (!firstDiv) {
if (headerEnded && (tokenName == "div")) {
if (debug & DEBUG_OTHER) {
cout << "DEBUG(FOUND): Found first div and pitching prior material: " << text << endl;
}
// TODO: Save off the content to use it to suggest the module's conf.
firstDiv = true;
text = "";
}
else {
// Collect the content so it can be used to suggest the module's conf.
return false;
}
}
//-- WITH osisID OR annotateRef -------------------------------------------------------------------------
// Handle Book, Chapter, and Verse (or commentary equivalent)
if (token.getAttribute("osisID") || token.getAttribute("annotateRef")) {
// BOOK START, <div type="book" ...>
if (tokenName == "div" && typeAttr == "book") {
if (inBookIntro || inChapterIntro) { // this one should never happen, but just in case
if (debug & DEBUG_TITLE) {
cout << "DEBUG(TITLE): " << currentOsisID << ": OOPS INTRO " << endl;
cout << "\tinChapterIntro = " << inChapterIntro << endl;
cout << "\tinBookIntro = " << inBookIntro << endl;
}
currentVerse.setTestament(0);
currentVerse.setBook(0);
currentVerse.setChapter(0);
currentVerse.setVerse(0);
writeEntry(text);
}
currentVerse = token.getAttribute("osisID");
currentVerse.setChapter(0);
currentVerse.setVerse(0);
strcpy(currentOsisID, currentVerse.getOSISRef());
sidBook = token.getAttribute("sID");
inChapter = false;
inVerse = false;
inPreVerse = false;
inBookIntro = true;
inChapterIntro = false;
if (debug & DEBUG_TITLE) {
cout << "DEBUG(TITLE): " << currentOsisID << ": Looking for book introduction" << endl;
}
bookDepth = tagStack.size();
chapterDepth = 0;
verseDepth = 0;
inCanonicalOSISBook = isOSISAbbrev(token.getAttribute("osisID"));
if (!inCanonicalOSISBook) {
cout << "WARNING(V11N): New book is " << token.getAttribute("osisID") << " and is not in " << v11n << " versification, ignoring" << endl;
}
else if (debug & DEBUG_OTHER) {
cout << "DEBUG(FOUND): New book is " << currentVerse.getOSISRef() << endl;
}
return false;
}
// CHAPTER START, <chapter> or <div type="chapter" ...>
if ((tokenName == "chapter") ||
(tokenName == "div" && typeAttr == "chapter")
) {
if (inBookIntro) {
if (debug & DEBUG_TITLE) {
cout << "DEBUG(TITLE): " << currentOsisID << ": BOOK INTRO "<< text << endl;
}
writeEntry(text);
}
currentVerse = token.getAttribute("osisID");
currentVerse.setVerse(0);
if (debug & DEBUG_OTHER) {
cout << "DEBUG(FOUND): Current chapter is " << currentVerse.getOSISRef() << " (" << token.getAttribute("osisID") << ")" << endl;
}
strcpy(currentOsisID, currentVerse.getOSISRef());
sidChapter = token.getAttribute("sID");
inChapter = true;
inVerse = false;
inPreVerse = false;
inBookIntro = false;
inChapterIntro = true;
if (debug & DEBUG_TITLE) {
cout << "DEBUG(TITLE): " << currentOsisID << ": Looking for chapter introduction" << endl;
}
chapterDepth = tagStack.size();
verseDepth = 0;
return false;
}
// VERSE, <verse ...> OR COMMENTARY START, <div annotateType="xxx" ...>
if ((tokenName == "verse") ||
(tokenName == "div" && token.getAttribute("annotateType"))
) {
if (debug & DEBUG_OTHER) {
cout << "DEBUG(FOUND): Entering verse" << endl;
}
if (inChapterIntro) {
if (debug & DEBUG_TITLE) {
cout << "DEBUG(TITLE): " << currentOsisID << ": Done looking for chapter introduction" << endl;
}
if (text.length()) {
if (debug & DEBUG_TITLE) {
cout << "DEBUG(TITLE): " << currentOsisID << ": CHAPTER INTRO "<< text << endl;
}
writeEntry(text);
}
}
// Did we have pre-verse material that needs to be marked?
if (inPreVerse) {
char genBuf[200];
sprintf(genBuf, "<div type=\"x-milestone\" subType=\"x-preverse\" eID=\"pv%d\"/>", genID++);
text.append(genBuf);
}
// Get osisID for verse or annotateRef for commentary
SWBuf keyVal = token.getAttribute(tokenName == "verse" ? "osisID" : "annotateRef");
// Massage the key into a form that parseVerseList can accept
prepareSWVerseKey(keyVal);
// The osisID or annotateRef can be more than a single verse
// The first or only one is the currentVerse
// Use the last verse seen (i.e. the currentVerse) as the basis for recovering from bad parsing.
// This should never happen if the references are valid OSIS references
ListKey verseKeys = currentVerse.parseVerseList(keyVal, currentVerse, true);
int memberKeyCount = verseKeys.getCount();
if (memberKeyCount) {
currentVerse = verseKeys.getElement(0);
// See if this osisID or annotateRef refers to more than one verse.
// If it does, save it until all verses have been seen.
// At that point we will output links.
// This can be done by incrementing, which will produce an error
// if there is only one verse.
verseKeys.setPosition(TOP);
verseKeys.increment(1);
if (!verseKeys.popError()) {
linkedVerses.push_back(verseKeys);
}
}
else {
cout << "ERROR(REF): Invalid osisID/annotateRef: " << token.getAttribute((tokenName == "verse") ? "osisID" : "annotateRef") << endl;
}
strcpy(currentOsisID, currentVerse.getOSISRef());
if (debug & DEBUG_OTHER) {
cout << "DEBUG(FOUND): New current verse is " << currentVerse.getOSISRef() << endl;
cout << "DEBUG(FOUND): osisID/annotateRef is adjusted to: " << keyVal << endl;
}
sidVerse = token.getAttribute("sID");
inVerse = true;
inPreVerse = false;
inBookIntro = false;
inChapterIntro = false;
verseDepth = tagStack.size();
// Include the token if it is not a verse
if (tokenName != "verse") {
text.append(token);
}
else if (debug & DEBUG_VERSE)
{
// transform the verse into a milestone
XMLTag t = "<milestone resp=\"v\" />";
// copy all the attributes of the verse element to the milestone
StringList attrNames = token.getAttributeNames();
for (StringList::iterator loop = attrNames.begin(); loop != attrNames.end(); loop++) {
const char* attr = (*loop).c_str();
t.setAttribute(attr, token.getAttribute(attr));
}
text.append(t);
}
if (inWOC) {
text.append(wocTag);
}
return true;
}
} // done with Handle Book, Chapter, and Verse (or commentary equivalent)
// Now consider everything else.
// Handle WOC quotes.
// Note this requires transformBSP to make them into milestones
// Otherwise have to do it here
if (tokenName == "q") {
quoteStack.push(token);
if (debug & DEBUG_QUOTE) {
cout << "DEBUG(QUOTE): " << currentOsisID << ": quote top(" << quoteStack.size() << ") " << token << endl;
}
if (token.getAttribute("who") && !strcmp(token.getAttribute("who"), "Jesus")) {
inWOC = true;
// Output per verse WOC markup.
text.append(wocTag);
// Output the quotation mark if appropriate, inside the WOC.
// If there is no marker attribute, let the SWORD engine manufacture one.
// If there is a marker attribute and it has content, then output that.
// If the marker attribute is present and empty, then there is nothing to do.
// And have it within the WOC markup
if (!token.getAttribute("marker") || token.getAttribute("marker")[0]) {
token.setAttribute("who", 0); // remove the who="Jesus"
text.append(token);
}
return true;
}
return false;
}
// Have we found the start of pre-verse material?
// Pre-verse material follows the following rules
// 1) Between the opening of a book and the first chapter, all the material is handled as an introduction to the book.
// 2) Between the opening of a chapter and the first verse, the material is split between the introduction of the chapter
// and the first verse of the chapter.
// A <div> with a type of section will be taken as surrounding verses.
// A <title> of type other than main, chapter or sub, will be taken as a title for the verse.
// Once one of these conditions is met, the division between chapter introduction and pre-verse is set.
// 3) Between verses, the material is split between the prior verse and the next verse.
// Basically, while end and empty tags are found, they belong to the prior verse.
// Once a begin tag is found, it belongs to the next verse.
if (!inPreVerse && !inBookIntro) {
if (inChapterIntro) {
// Determine when we are no longer in a chapter heading, but in pre-verse material:
// If we see one of the following:
// a section div
// a title that is not main, chapter or sub or unclassified (no type attribute)
if ((tokenName == "div" && typeAttr == "section") ||
(tokenName == "title" && typeAttr.length() != 0 && typeAttr != "main" && typeAttr != "chapter" && typeAttr != "sub")
) {
if (debug & DEBUG_TITLE) {
cout << "DEBUG(TITLE): " << currentOsisID << ": Done looking for chapter introduction" << endl;
}
if (text.length()) {
if (debug & DEBUG_TITLE) {
cout << "DEBUG(TITLE): " << currentOsisID << ": CHAPTER INTRO "<< text << endl;
}
// Since we have found the boundary, we need to write out the chapter heading
writeEntry(text);
}
// And we are no longer in the chapter heading
inChapterIntro = false;
// But rather, we are now in pre-verse material
inPreVerse = true;
}
}
else if (!inVerse && inChapter) {
inPreVerse = true;
}
if (inPreVerse) {
char genBuf[200];
sprintf(genBuf, "<div type=\"x-milestone\" subType=\"x-preverse\" sID=\"pv%d\"/>", genID);
text.append(genBuf);
}
}
if (debug & DEBUG_INTERVERSE) {
if (!inVerse && !inBookIntro && !inChapterIntro) {
cout << "DEBUG(INTERVERSE): " << currentOsisID << ": interverse start token " << token << ":" << text.c_str() << endl;
}
}
return false;
} // Done with procesing start and empty tags
// Process end tags
else {
if (tagStack.empty()) {
cout << "FATAL(NESTING): " << currentOsisID << ": tag expected" << endl;
exit(EXIT_BAD_NESTING);
}
// Note: empty end tags have the eID attribute
if (!token.isEmpty()) {
XMLTag topToken = tagStack.top();
tagDepth = tagStack.size();
if (debug & DEBUG_STACK) {
cout << "DEBUG(STACK): " << currentOsisID << ": pop(" << tagDepth << ") " << topToken.getName() << endl;
}
tagStack.pop();
if (tokenName != topToken.getName()) {
cout << "FATAL(NESTING): " << currentOsisID << ": Expected " << topToken.getName() << " found " << tokenName << endl;
// exit(EXIT_BAD_NESTING); // (OSK) I'm sure this validity check is a good idea, but there's a but somewhere that's killing the converter here.
// So I'm disabling this line. Unvalidated OSIS files shouldn't be run through the converter anyway.
// (DM) This has nothing to do with well-form or valid. It checks milestoned elements for proper nesting.
}
}
// We haven't seen the first div outside the header so there is little to do.
if (!firstDiv) {
if (tokenName == "header") {
headerEnded = true;
if (debug & DEBUG_OTHER) {
cout << "DEBUG(FOUND): End of header found" << endl;
}
}
// Collect the content so it can be used to suggest the module's conf.
return false;
}
// VERSE and COMMENTARY END
if ((tokenName == "verse") ||
(tokenName == "div" && eidAttr == sidVerse)
) {
if (tagDepth != verseDepth) {
cout << "WARNING(NESTING): verse " << currentOsisID << " is not well formed:(" << verseDepth << "," << tagDepth << ")" << endl;
}
// If we are in WOC then we need to terminate the <q who="Jesus" marker=""> that was added earlier in the verse.
if (inWOC) {
text.append("</q>");
}
// Include the token if it is not a verse
if (tokenName != "verse") {
text.append(token);
}
else if (debug & DEBUG_VERSE)
{
// transform the verse into a milestone
XMLTag t = "<milestone resp=\"v\" />";
// copy all the attributes of the verse element to the milestone
StringList attrNames = token.getAttributeNames();
for (StringList::iterator loop = attrNames.begin(); loop != attrNames.end(); loop++) {
const char* attr = (*loop).c_str();
t.setAttribute(attr, token.getAttribute(attr));
}
text.append(t);
}
writeEntry(text);
inVerse = false;
inPreVerse = false;
verseDepth = 0;
return true;
}
// Handle WOC quotes.
// Note this requires transformBSP to make them into milestones
// Otherwise have to manage it here
if (tokenName == "q") {
XMLTag topToken = quoteStack.top();
if (debug & DEBUG_QUOTE) {
cout << "DEBUG(QUOTE): " << currentOsisID << ": quote pop(" << quoteStack.size() << ") " << topToken << " -- " << token << endl;
}
quoteStack.pop();
// If we have found an end tag for a <q who="Jesus"> then we are done with the WOC
// and we need to terminate the <q who="Jesus" marker=""> that was added earlier in the verse.
if (token.getAttribute("who") && !strcmp(token.getAttribute("who"), "Jesus")) {
if (debug & DEBUG_QUOTE) {
cout << "DEBUG(QUOTE): " << currentOsisID << ": (" << quoteStack.size() << ") " << topToken << " -- " << token << endl;
}
inWOC = false;
const char *sID = topToken.getAttribute("sID");
const char *eID = token.getAttribute("eID");
if (!sID) {
sID = "";
}
if (!eID) {
eID = "";
}
if (strcmp(sID, eID)) {
cout << "ERROR(NESTING): improper nesting " << currentOsisID << ": matching (sID,eID) not found. Looking at (" << sID << "," << eID << ")" << endl;
}
// Output the quotation mark if appropriate, inside the WOC.
// If there is no marker attribute, let the SWORD engine manufacture one.
// If there is a marker attribute and it has content, then output that.
// If the marker attribute is present and empty, then there is nothing to do.
// And have it within the WOC markup
if (!token.getAttribute("marker") || token.getAttribute("marker")[0]) {
token.setAttribute("who", 0); // remove the who="Jesus"
text.append(token);
}
// Now close the WOC
text.append("</q>");
return true;
}
return false;
}
// Look for the end of document, book and chapter
// Also for material that goes with last entry
if (!inVerse && !inBookIntro && !inChapterIntro) {
// Is this the end of a chapter.
if ((tokenName == "chapter") ||
(tokenName == "div" && eidAttr == sidChapter)
) {
text.append(token);
writeEntry(text);
inChapter = false;
sidChapter = "";
chapterDepth = 0;
verseDepth = 0;
return true;
}
// Is it the end of a book
if (tokenName == "div" && eidAttr == sidBook) {
text.append(token);
writeEntry(text);
bookDepth = 0;
chapterDepth = 0;
verseDepth = 0;
return true;
}
// Do not include the end of an osis document
if (tokenName == "osisText" || tokenName == "osis") {
bookDepth = 0;
chapterDepth = 0;
verseDepth = 0;
text = "";
return true;
}
// When we are not inPreVerse, the interverse tags get appended to the preceeding verse.
if (!inPreVerse) {
text.append(token);
writeEntry(text);
if (debug & DEBUG_INTERVERSE) {
cout << "DEBUG(INTERVERSE): " << currentOsisID << ": appending interverse end tag: " << tokenName << "(" << tagDepth << "," << chapterDepth << "," << bookDepth << ")" << endl;
}
return true;
}
if (debug & DEBUG_INTERVERSE) {
cout << "DEBUG(INTERVERSE): " << currentOsisID << ": interverse end tag: " << tokenName << "(" << tagDepth << "," << chapterDepth << "," << bookDepth << ")" << endl;
}
return false;
}
return false;
} // done with Processing end tags
return false;
}
/**
* Support normalizations necessary for a SWORD module.
* OSIS allows for document structure (Book, Section, Paragraph or BSP)
* to overlap Bible versification (Book, Chapter, Verse).
* Most SWORD applications need to display verses in isolation or in HTML table cells,
* requiring each stored entry (i.e. verses) to be well-formed xml.
* This routine normalizes container elements which could cross verse boundaries into milestones.
* For most of these OSIS elements, there is a milestone form. However, p is not milestoneable.
* For this reason, p is transformed into div elements with type x-p.
* param t the tag to transform
* return the transformed tag or the original one
*/
XMLTag transformBSP(XMLTag t) {
static std::stack<XMLTag> bspTagStack;
static int sID = 1;
char buf[11];
// Support simplification transformations
if (t.isEmpty()) {
if (debug & DEBUG_XFORM) {
cout << "DEBUG(XFORM): " << currentOsisID << ": xform empty " << t << endl;
}
return t;
}
SWBuf tagName = t.getName();
if (!t.isEndTag()) {
// Transform <p> into <div type="x-p"> and milestone it
if (tagName == "p") {
t.setText("<div type=\"x-p\" />");
sprintf(buf, "gen%d", sID++);
t.setAttribute("sID", buf);
}
// Transform <tag> into <tag sID="">, where tag is a milestoneable element.
// The following containers are milestoneable.
// abbr, closer, div, foreign, l, lg, salute, signed, speech
// Leaving out:
// abbr When would this ever cross a boundary?
// seg as it is used for a divineName hack
// foreign so that it can be easily italicized
else if (tagName == "chapter" ||
tagName == "closer" ||
tagName == "div" ||
tagName == "l" ||
tagName == "lg" ||
tagName == "q" ||
tagName == "salute" ||
tagName == "signed" ||
tagName == "speech" ||
tagName == "verse"
) {
t.setEmpty(true);
sprintf(buf, "gen%d", sID++);
t.setAttribute("sID", buf);
}
bspTagStack.push(t);
if (debug & DEBUG_XFORM) {
cout << "DEBUG(XFORM): " << currentOsisID << ": xform push (" << bspTagStack.size() << ") " << t << " (tagname=" << tagName << ")" << endl;
XMLTag topToken = bspTagStack.top();
cout << "DEBUG(XFORM): " << currentOsisID << ": xform top(" << bspTagStack.size() << ") " << topToken << endl;
}
}
else {
if (!bspTagStack.empty()) {
XMLTag topToken = bspTagStack.top();
if (debug & DEBUG_XFORM) {
cout << "DEBUG(XFORM): " << currentOsisID << ": xform pop(" << bspTagStack.size() << ") " << topToken << endl;
}
bspTagStack.pop();
// Look for the milestoneable container tags handled above.
if (tagName == "chapter" ||
tagName == "closer" ||
tagName == "div" ||
tagName == "l" ||
tagName == "lg" ||
tagName == "p" ||
tagName == "q" ||
tagName == "salute" ||
tagName == "signed" ||
tagName == "speech" ||
tagName == "verse"
) {
// make this a clone of the start tag with sID changed to eID
// Note: in the case of </p> the topToken is a <div type="x-p">
t = topToken;
t.setAttribute("eID", t.getAttribute("sID"));
t.setAttribute("sID", 0);
}
}
else {
cout << "FATAL(TAGSTACK): " << currentOsisID << ": closing tag without opening tag" << endl;
}
}
return t;
}
/**
* Write out all links in the module.
* Waiting is necessary because writeEntry might ultimately append
* text to a verse moving it's offset in the data file.
* While we are minimizing it by postponing the write until we have
* gathered the next verse, the following scenario is happening:
* A module is using linked verses and has some verses that are not
* in the chosen versification. If the out-of-canon verse happens following
* a linked verse, the out-of-canon verse is appended to the prior
* verse. Care has to be taken that the linked verses all point to
* the first of the set.
*/
void writeLinks()
{
// Link all the verses
VerseKey destKey;
destKey.setVersificationSystem(currentVerse.getVersificationSystem());
destKey.setAutoNormalize(0);
destKey.setIntros(1);
VerseKey linkKey;
linkKey.setVersificationSystem(currentVerse.getVersificationSystem());
linkKey.setAutoNormalize(0);
linkKey.setIntros(1);
for (unsigned int i = 0; i < linkedVerses.size(); i++) {
// The verseKeys is a list of verses
// where the first is the real verse
// and the others link to it.
ListKey verseKeys = linkedVerses[i];
verseKeys.setPosition(TOP);
destKey = verseKeys.getElement();
verseKeys.increment(1);
while (!verseKeys.popError()) {
linkKey = verseKeys.getElement();
verseKeys.increment(1);
linkToEntry(linkKey, destKey);
}
}
}
void usage(const char *app, const char *error = 0, const bool verboseHelp = false) {
if (error) fprintf(stderr, "\n%s: %s\n", app, error);
fprintf(stderr, "OSIS Bible/commentary module creation tool for The SWORD Project\n");
fprintf(stderr, "\nusage: %s <output/path> <osisDoc> [OPTIONS]\n", app);
fprintf(stderr, " <output/path>\t\t an existing folder that the module will be written\n");
fprintf(stderr, " <osisDoc>\t\t path to the validated OSIS document, or '-' to\n");
fprintf(stderr, "\t\t\t\t read from standard input\n");
fprintf(stderr, " -a\t\t\t augment module if exists (default is to create new)\n");
fprintf(stderr, " -z\t\t\t use ZIP compression (default no compression)\n");
fprintf(stderr, " -Z\t\t\t use LZSS compression (default no compression)\n");
fprintf(stderr, " -b <2|3|4>\t\t compression block size (default 4):\n");
fprintf(stderr, "\t\t\t\t 2 - verse; 3 - chapter; 4 - book\n");
fprintf(stderr, " -c <cipher_key>\t encipher module using supplied key\n");
fprintf(stderr, "\t\t\t\t (default no enciphering)\n");
#ifdef _ICU_
fprintf(stderr, " -N\t\t\t do not convert UTF-8 or normalize UTF-8 to NFC\n");
if (verboseHelp) {
fprintf(stderr, "\t\t\t\t (default is to convert to UTF-8, if needed,\n");
fprintf(stderr, "\t\t\t\t and then normalize to NFC)\n");
fprintf(stderr, "\t\t\t\t Note: UTF-8 texts should be normalized to NFC.\n");
}
#endif
fprintf(stderr, " -s <2|4>\t\t bytes used to store entry size (default is 2).\n");
if (verboseHelp) {
fprintf(stderr, "\t\t\t\t Note: useful for commentaries with very large\n");
fprintf(stderr, "\t\t\t\t entries in uncompressed modules\n");
fprintf(stderr, "\t\t\t\t (2 bytes to store size equal 65535 characters)\n");
}
fprintf(stderr, " -v <v11n>\t\t specify a versification scheme to use (default is KJV)\n");
fprintf(stderr, "\t\t\t\t Note: The following are valid values for v11n:");
VersificationMgr *vmgr = VersificationMgr::getSystemVersificationMgr();
StringList av11n = vmgr->getVersificationSystems();
for (StringList::iterator loop = av11n.begin(); loop != av11n.end(); loop++) {
if ((distance(av11n.begin(), loop) % 3) == 0) {
fprintf(stderr, "\n\t\t\t\t %-12s", (*loop).c_str());
}
else {
fprintf(stderr, "\t%-12s", (*loop).c_str());
}
}
fprintf(stderr, "\n");
if (verboseHelp) {
fprintf(stderr, " -d <flags>\t\t turn on debugging (default is 0)\n");
fprintf(stderr, "\t\t\t\t Note: This flag may change in the future.\n");
fprintf(stderr, "\t\t\t\t Flags: The following are valid values:\n");
fprintf(stderr, "\t\t\t\t\t0 - no debugging\n");
fprintf(stderr, "\t\t\t\t\t1 - writes to module, very verbose\n");
fprintf(stderr, "\t\t\t\t\t2 - verse start and end\n");
fprintf(stderr, "\t\t\t\t\t4 - quotes, esp. Words of Christ\n");
fprintf(stderr, "\t\t\t\t\t8 - titles\n");
fprintf(stderr, "\t\t\t\t\t16 - inter-verse material\n");
fprintf(stderr, "\t\t\t\t\t32 - BSP to BCV transformations\n");
fprintf(stderr, "\t\t\t\t\t64 - v11n exceptions\n");
fprintf(stderr, "\t\t\t\t\t128 - parsing of osisID and osisRef\n");
fprintf(stderr, "\t\t\t\t\t256 - internal stack\n");
fprintf(stderr, "\t\t\t\t\t512 - miscellaneous\n");
fprintf(stderr, "\t\t\t\t This argument can be used more than once. (Or\n");
fprintf(stderr, "\t\t\t\t the flags may be added together.)\n");
}
fprintf(stderr, " -h \t\t\t print verbose usage text\n");
fprintf(stderr, "\n");
fprintf(stderr, "See http://www.crosswire.org/wiki/osis2mod for more details.\n");
fprintf(stderr, "\n");
exit(EXIT_BAD_ARG);
}
void processOSIS(istream& infile) {
typedef enum {
CS_NOT_IN_COMMENT, // or seen starting "<"
CS_SEEN_STARTING_EXCLAMATION,
CS_SEEN_STARTING_HYPHEN,
CS_IN_COMMENT,
CS_SEEN_ENDING_HYPHEN,
CS_SEEN_SECOND_ENDING_HYPHEN,
CS_SEEN_ENDING_GREATER_THAN
} t_commentstate;
activeOsisID[0] = '\0';
strcpy(currentOsisID,"N/A");
currentVerse.setVersificationSystem(v11n);
currentVerse.setAutoNormalize(false);
currentVerse.setIntros(true); // turn on mod/testmnt/book/chap headings
currentVerse.setPersist(true);
module->setKey(currentVerse);
module->setPosition(TOP);
SWBuf token;
SWBuf text;
bool incomment = false;
t_commentstate commentstate = CS_NOT_IN_COMMENT;
bool intoken = false;
bool inWhitespace = false;
bool seeingSpace = false;
unsigned char curChar = '\0';
while (infile.good()) {
int possibleChar = infile.get();
// skip the character if it is bad. infile.good() will catch the problem
if (possibleChar == -1) {
continue;
}
curChar = (unsigned char) possibleChar;
// All newlines are simply whitespace
// Does a SWORD module actually require this?
if (curChar == '\n') {
curChar = ' ';
}
if (!intoken && curChar == '<') {
intoken = true;
token = "<";
continue;
}
// Handle XML comments starting with "<!--", ending with "-->"
if (intoken && !incomment) {
switch (commentstate) {
case CS_NOT_IN_COMMENT :
if (curChar == '!') {
commentstate = CS_SEEN_STARTING_EXCLAMATION;
token.append((char) curChar);
continue;
} else {
break;
}
case CS_SEEN_STARTING_EXCLAMATION :
if (curChar == '-') {
commentstate = CS_SEEN_STARTING_HYPHEN;
token.append((char) curChar);
continue;
} else {
commentstate = CS_NOT_IN_COMMENT;
break;
}
case CS_SEEN_STARTING_HYPHEN :
if (curChar == '-') {
incomment = true;
commentstate = CS_IN_COMMENT;
token.append((char) curChar);
if (debug & DEBUG_OTHER) {
cout << "DEBUG(COMMENTS): in comment" << endl;
}
continue;
} else {
commentstate = CS_NOT_IN_COMMENT;
break;
}
default:
cout << "FATAL(COMMENTS): unknown commentstate on comment start: " << commentstate << endl;
exit(EXIT_BAD_NESTING);
}
}
if (incomment) {
switch (commentstate) {
case CS_IN_COMMENT:
if (curChar == '-') {
commentstate = CS_SEEN_ENDING_HYPHEN;
continue;
} else {
// ignore the character
continue;
}
case CS_SEEN_ENDING_HYPHEN :
if (curChar == '-') {
commentstate = CS_SEEN_SECOND_ENDING_HYPHEN;
continue;
} else {
// ignore character
commentstate = CS_IN_COMMENT;
continue;
}
case CS_SEEN_SECOND_ENDING_HYPHEN :
if (curChar == '>') {
intoken = false;
incomment = false;
commentstate = CS_NOT_IN_COMMENT;
if (debug & DEBUG_OTHER) {
cout << "DEBUG(COMMENTS): out of comment" << endl;
}
continue;
} else {
// ignore character
commentstate = CS_IN_COMMENT;
continue;
}
default:
cout << "FATAL(COMMENTS): unknown commentstate on comment end: " << commentstate << endl;
exit(EXIT_BAD_NESTING);
}
}
// Outside of tokens merge adjacent whitespace
if (!intoken) {
seeingSpace = isspace(curChar)!=0;
if (seeingSpace) {
if (inWhitespace) {
continue;
}
// convert all whitespace to blanks
curChar = ' ';
}
inWhitespace = seeingSpace;
}
if (intoken && curChar == '>') {
intoken = false;
inWhitespace = false;
token.append('>');
// take this isalpha if out to check for bugs in text
if (isalpha(token[1]) ||
(((token[1] == '/') || (token[1] == '?')) && isalpha(token[2]))) {
//cout << "Handle:" << token.c_str() << endl;
XMLTag t = transformBSP(token.c_str());
if (!handleToken(text, t)) {
text.append(t);
}
} else {
cout << "WARNING(PARSE): malformed token: " << token << endl;
}
continue;
}
if (intoken) {
token.append((char) curChar);
}
else {
switch (curChar) {
case '>' : text.append(">"); break;
case '<' : text.append("<"); break;
default : text.append((char) curChar); break;
}
}
}
// Force the last entry from the text buffer.
text = "";
writeEntry(text, true);
writeLinks();
#ifdef _ICU_
if (converted) fprintf(stderr, "osis2mod converted %d verses to UTF-8\n", converted);
if (normalized) fprintf(stderr, "osis2mod normalized %d verses to NFC\n", normalized);
#endif
}
int main(int argc, char **argv) {
fprintf(stderr, "You are running osis2mod: $Rev: 3177 $\n");
if (argc > 1) {
for (int i = 1; i < argc; i++) {
if (!strcmp(argv[i], "-h") || !strcmp(argv[i], "--help")) {
usage(*argv, "", true);
}
}
}
// Let's test our command line arguments
if (argc < 3) {
usage(*argv);
}
// variables for arguments, holding defaults
const char* program = argv[0];
const char* path = argv[1];
const char* osisDoc = argv[2];
int append = 0;
SWBuf compType = "";
bool isCommentary = false;
int iType = 4;
int entrySize = 0;
SWBuf cipherKey = "";
SWCompress *compressor = 0;
for (int i = 3; i < argc; i++) {
if (!strcmp(argv[i], "-a")) {
append = 1;
}
else if (!strcmp(argv[i], "-z")) {
if (compType.size()) usage(*argv, "Cannot specify both -z and -Z");
if (entrySize) usage(*argv, "Cannot specify both -z and -s");
compType = "ZIP";
}
else if (!strcmp(argv[i], "-Z")) {
if (compType.size()) usage(*argv, "Cannot specify both -z and -Z");
if (entrySize) usage(*argv, "Cannot specify both -Z and -s");
compType = "LZSS";
}
else if (!strcmp(argv[i], "-b")) {
if (i+1 < argc) {
iType = atoi(argv[++i]);
if ((iType >= 2) && (iType <= 4)) continue;
}
usage(*argv, "-b requires one of <2|3|4>");
}
else if (!strcmp(argv[i], "-N")) {
normalize = false;
}
else if (!strcmp(argv[i], "-c")) {
if (i+1 < argc) cipherKey = argv[++i];
else usage(*argv, "-c requires <cipher_key>");
}
else if (!strcmp(argv[i], "-v")) {
if (i+1 < argc) v11n = argv[++i];
else usage(*argv, "-v requires <v11n>");
}
else if (!strcmp(argv[i], "-s")) {
if (compType.size()) usage(*argv, "Cannot specify -s and -z or -Z");
if (i+1 < argc) {
entrySize = atoi(argv[++i]);
if (entrySize == 2 || entrySize == 4) {
continue;
}
}
usage(*argv, "-s requires one of <2|4>");
}
else if (!strcmp(argv[i], "-C")) {
isCommentary = true;
}
else if (!strcmp(argv[i], "-d")) {
if (i+1 < argc) debug |= atoi(argv[++i]);
else usage(*argv, "-d requires <flags>");
}
else usage(*argv, (((SWBuf)"Unknown argument: ")+ argv[i]).c_str());
}
if (isCommentary) isCommentary = true; // avoid unused warning for now
if (compType == "ZIP") {
#ifndef EXCLUDEZLIB
compressor = new ZipCompress();
#else
usage(*argv, "ERROR: SWORD library not compiled with ZIP compression support.\n\tBe sure libzip is available when compiling SWORD library");
#endif
}
else if (compType == "LZSS") {
compressor = new LZSSCompress();
}
#ifndef _ICU_
if (normalize) {
normalize = false;
cout << "WARNING(UTF8): " << program << " is not compiled with support for ICU. Assuming -N." << endl;
}
#endif
if (debug & DEBUG_OTHER) {
cout << "DEBUG(ARGS):\n\tpath: " << path << "\n\tosisDoc: " << osisDoc << "\n\tcreate: " << append << "\n\tcompressType: " << compType << "\n\tblockType: " << iType << "\n\tcipherKey: " << cipherKey.c_str() << "\n\tnormalize: " << normalize << endl;
}
if (!append) { // == 0 then create module
// Try to initialize a default set of datafiles and indicies at our
// datapath location passed to us from the user.
if (compressor) {
if (zText::createModule(path, iType, v11n)) {
fprintf(stderr, "ERROR: %s: couldn't create module at path: %s \n", program, path);
exit(EXIT_NO_CREATE);
}
}
else if (entrySize == 4) {
if (RawText4::createModule(path, v11n)) {
fprintf(stderr, "ERROR: %s: couldn't create module at path: %s \n", program, path);
exit(EXIT_NO_CREATE);
}
}
else {
if (RawText::createModule(path, v11n)) {
fprintf(stderr, "ERROR: %s: couldn't create module at path: %s \n", program, path);
exit(EXIT_NO_CREATE);
}
}
}
// Do some initialization stuff
if (compressor) {
// Create a compressed text module allowing very large entries
// Taking defaults except for first, fourth, fifth and last argument
module = new zText(
path, // ipath
0, // iname
0, // idesc
iType, // iblockType
compressor, // icomp
0, // idisp
ENC_UNKNOWN, // enc
DIRECTION_LTR, // dir
FMT_UNKNOWN, // markup
0, // lang
v11n // versification
);
}
else if (entrySize == 4) {
// Create a raw text module allowing very large entries
// Taking defaults except for first and last argument
module = new RawText4(
path, // ipath
0, // iname
0, // idesc
0, // idisp
ENC_UNKNOWN, // encoding
DIRECTION_LTR, // dir
FMT_UNKNOWN, // markup
0, // ilang
v11n // versification
);
}
else {
// Create a raw text module allowing reasonable sized entries
// Taking defaults except for first and last argument
module = new RawText(
path, // ipath
0, // iname
0, // idesc
0, // idisp
ENC_UNKNOWN, // encoding
DIRECTION_LTR, // dir
FMT_UNKNOWN, // markup
0, // ilang
v11n // versification
);
}
SWFilter *cipherFilter = 0;
if (cipherKey.length()) {
fprintf(stderr, "Adding cipher filter with phrase: %s\n", cipherKey.c_str() );
cipherFilter = new CipherFilter(cipherKey.c_str());
module->addRawFilter(cipherFilter);
}
if (!module->isWritable()) {
fprintf(stderr, "The module is not writable. Writing text to it will not work.\nExiting.\n" );
exit(EXIT_NO_WRITE);
}
// Either read from std::cin (aka stdin), when the argument is a '-'
// or from a specified file.
if (!strcmp(osisDoc, "-")) {
processOSIS(cin);
}
else {
// Let's see if we can open our input file
ifstream infile(osisDoc);
if (infile.fail()) {
fprintf(stderr, "ERROR: %s: couldn't open input file: %s \n", program, osisDoc);
exit(EXIT_NO_READ);
}
processOSIS(infile);
infile.close();
}
delete module;
if (cipherFilter)
delete cipherFilter;
fprintf(stderr, "SUCCESS: %s: has finished its work and will now rest\n", program);
exit(0); // success
}
|