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
|
//Copyright 2017 Ryan Wick
//This file is part of Bandage
//Bandage 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.
//Bandage 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.
//You should have received a copy of the GNU General Public License
//along with Bandage. If not, see <http://www.gnu.org/licenses/>.
#include "commoncommandlinefunctions.h"
#include "../graph/assemblygraph.h"
#include <QDir>
#include "../blast/blastsearch.h"
#include <QApplication>
#include <QRegularExpression>
#include "../program/memory.h"
#include <limits>
QStringList getArgumentList(int argc, char *argv[])
{
QStringList arguments;
for (int i = 1; i < argc; ++i)
{
QString argument = argv[i];
arguments.push_back(argument);
}
return arguments;
}
void getSettingsUsage(QStringList * text)
{
QString dashes = "";
for (int i = 0; i < g_memory->terminalWidth - 10; ++i)
dashes += '-';
*text << "Settings: The following options configure the Bandage settings that are available in the Bandage GUI.";
*text << "";
*text << "Colours can be specified using hex values, with or without an alpha channel, (e.g. #FFB6C1 or #7FD2B48C) or using standard colour names (e.g. red, yellowgreen or skyblue). Note that hex colours will either need to be enclosed in quotes (e.g. \"#FFB6C1\") or have the hash symbol escaped (e.g. \\#FFB6C1).";
*text << "";
*text << "Graph scope";
*text << dashes;
*text << "These settings control the graph scope. If the aroundnodes scope is used, then the --nodes option must also be used. If the aroundblast scope is used, a BLAST query must be given with the --query option.";
getGraphScopeOptions(text);
*text << "--double Draw graph in double mode (default: off)";
*text << "";
*text << "Graph size";
*text << dashes;
*text << "--nodelen <float> Node length per megabase " + getRangeAndDefault(g_settings->manualNodeLengthPerMegabase, "auto");
*text << "--minnodlen <float> Minimum node length " + getRangeAndDefault(g_settings->minimumNodeLength);
*text << "--edgelen <float> Edge length " + getRangeAndDefault(g_settings->edgeLength);
*text << "--edgewidth <float> Edge width " + getRangeAndDefault(g_settings->edgeWidth);
*text << "--doubsep <float> Double mode separation " + getRangeAndDefault(g_settings->doubleModeNodeSeparation);
*text << "";
*text << "Graph layout";
*text << dashes;
*text << "--nodseglen <float> Node segment length " + getRangeAndDefault(g_settings->nodeSegmentLength);
*text << "--iter <int> Graph layout iterations " + getRangeAndDefault(g_settings->graphLayoutQuality);
*text << "--linear Linear graph layout (default: off)" ;
*text << "";
*text << "Graph appearance";
*text << dashes;
*text << "--edgecol <col> Colour for edges " + getDefaultColour(g_settings->edgeColour);
*text << "--outcol <col> Colour for node outlines " + getDefaultColour(g_settings->outlineColour);
*text << "--outline <float> Node outline thickness " + getRangeAndDefault(g_settings->outlineThickness);
*text << "--selcol <col> Colour for selections " + getDefaultColour(g_settings->selectionColour);
*text << "--noaa Disable antialiasing (default: antialiasing on)";
*text << "--singlearr Show node arrowheads in single mode (default: nodes are only displayed with arrowheads in double mode)";
*text << "";
*text << "Text appearance";
*text << dashes;
*text << "--textcol <col> Colour for label text " + getDefaultColour(g_settings->textColour);
*text << "--toutcol <col> Colour for text outline " + getDefaultColour(g_settings->textOutlineColour);
*text << "--toutline <float> Surround text with an outline with this thickness " + getRangeAndDefault(g_settings->textOutlineThickness);
*text << "--centre Node labels appear at the centre of the node (default: off, node labels appear over visible parts of nodes)";
*text << "";
*text << "Node width";
*text << dashes;
*text << "Node widths are determined using the following formula:";
*text << "a*b*((c/d)^e-1)+1";
*text << " a = average node width";
*text << " b = depth effect on width";
*text << " c = node depth";
*text << " d = mean depth";
*text << " e = power of depth effect on width";
*text << "--nodewidth <float> Average node width " + getRangeAndDefault(g_settings->averageNodeWidth);
*text << "--depwidth <float> Depth effect on width " + getRangeAndDefault(g_settings->depthEffectOnWidth);
*text << "--deppower <float> Power of depth effect on width " + getRangeAndDefault(g_settings->depthPower);
*text << "";
*text << "Node labels";
*text << dashes;
*text << "--names Label nodes with name (default: off)";
*text << "--lengths Label nodes with length (default: off)";
*text << "--depth Label nodes with depth (default: off)";
*text << "--blasthits Label BLAST hits (default: off)";
*text << "--fontsize <int> Font size for node labels " + getRangeAndDefault(1, 100, g_settings->labelFont.pointSize());
*text << "";
*text << "Node colours";
*text << dashes;
*text << "--colour <scheme> Node colouring scheme, from one of the following options: random, uniform, depth, blastsolid, blastrainbow, custom (default: random if --query option not used, blastsolid if --query option used)";
*text << "";
*text << "Random colour scheme";
*text << dashes;
*text << "These settings only apply when the random colour scheme is used.";
*text << "--ransatpos <int> Positive node saturation " + getRangeAndDefault(g_settings->randomColourPositiveSaturation);
*text << "--ransatneg <int> Negative node saturation " + getRangeAndDefault(g_settings->randomColourNegativeSaturation);
*text << "--ranligpos <int> Positive node lightness " + getRangeAndDefault(g_settings->randomColourPositiveLightness);
*text << "--ranligneg <int> Negative node lightness " + getRangeAndDefault(g_settings->randomColourNegativeLightness);
*text << "--ranopapos <int> Positive node opacity " + getRangeAndDefault(g_settings->randomColourPositiveOpacity);
*text << "--ranopaneg <int> Negative node opacity " + getRangeAndDefault(g_settings->randomColourNegativeOpacity);
*text << "";
*text << "Uniform colour scheme";
*text << dashes;
*text << "These settings only apply when the uniform colour scheme is used.";
*text << "--unicolpos <col> Positive node colour " + getDefaultColour(g_settings->uniformPositiveNodeColour);
*text << "--unicolneg <col> Negative node colour " + getDefaultColour(g_settings->uniformNegativeNodeColour);
*text << "--unicolspe <col> Special node colour " + getDefaultColour(g_settings->uniformNodeSpecialColour);
*text << "";
*text << "Depth colour scheme";
*text << dashes;
*text << "These settings only apply when the depth colour scheme is used.";
*text << "--depcollow <col> Colour for nodes with depth below the low depth value " + getDefaultColour(g_settings->lowDepthColour);
*text << "--depcolhi <col> Colour for nodes with depth above the high depth value " + getDefaultColour(g_settings->highDepthColour);
*text << "--depvallow <float> Low depth value " + getRangeAndDefault(g_settings->lowDepthValue, "auto");
*text << "--depvalhi <float> High depth value " + getRangeAndDefault(g_settings->highDepthValue, "auto");
*text << "";
*text << "BLAST search";
*text << dashes;
*text << "--query <fastafile> A FASTA file of either nucleotide or protein sequences to be used as BLAST queries (default: none)";
*text << "--blastp <param> Parameters to be used by blastn and tblastn when conducting a BLAST search in Bandage (default: none). Format BLAST parameters exactly as they would be used for blastn/tblastn on the command line, and enclose them in quotes.";
*text << "--alfilter <int> Alignment length filter for BLAST hits. Hits with shorter alignments will be excluded " + getRangeAndDefault(g_settings->blastAlignmentLengthFilter);
*text << "--qcfilter <float> Query coverage filter for BLAST hits. Hits with less coverage will be excluded " + getRangeAndDefault(g_settings->blastQueryCoverageFilter);
*text << "--ifilter <float> Identity filter for BLAST hits. Hits with less identity will be excluded " + getRangeAndDefault(g_settings->blastIdentityFilter);
*text << "--evfilter <sci> E-value filter for BLAST hits. Hits with larger e-values will be excluded " + getRangeAndDefault(g_settings->blastEValueFilter);
*text << "--bsfilter <float> Bit score filter for BLAST hits. Hits with lower bit scores will be excluded " + getRangeAndDefault(g_settings->blastBitScoreFilter);
*text << "";
*text << "BLAST query paths";
*text << dashes;
*text << "These settings control how Bandage searches for query paths after conducting a BLAST search.";
*text << "--pathnodes <int> The number of allowed nodes in a BLAST query path " + getRangeAndDefault(g_settings->maxQueryPathNodes);
*text << "--minpatcov <float> Minimum fraction of a BLAST query which must be covered by a query path " + getRangeAndDefault(g_settings->minQueryCoveredByPath);
*text << "--minhitcov <float> Minimum fraction of a BLAST query which must be covered by BLAST hits in a query path " + getRangeAndDefault(g_settings->minQueryCoveredByHits);
*text << "--minmeanid <float> Minimum mean identity of BLAST hits in a query path " + getRangeAndDefault(g_settings->minMeanHitIdentity);
*text << "--maxevprod <sci> Maximum e-value product for all BLAST hits in a query path " + getRangeAndDefault(g_settings->maxEValueProduct);
*text << "--minpatlen <float> Minimum allowed relative path length as compared to the query " + getRangeAndDefault(g_settings->minLengthPercentage);
*text << "--maxpatlen <float> Maximum allowed relative path length as compared to the query " + getRangeAndDefault(g_settings->maxLengthPercentage);
*text << "--minlendis <int> Minimum allowed length discrepancy (in bases) between a BLAST query and its path in the graph " + getRangeAndDefault(g_settings->minLengthBaseDiscrepancy);
*text << "--maxlendis <int> Maximum allowed length discrepancy (in bases) between a BLAST query and its path in the graph " + getRangeAndDefault(g_settings->maxLengthBaseDiscrepancy);
*text << "";
}
void outputText(QString text, QTextStream * out)
{
QStringList list;
list << text;
outputText(list, out);
}
void outputText(QStringList text, QTextStream * out)
{
QStringList wrapped;
bool seenHeaderOrList = false;
for (int i = 0; i < text.size(); ++i)
{
QString line = text[i];
if (isSectionHeader(line) || isListItem(line))
seenHeaderOrList = true;
if (isError(line))
wrapped << wrapText(line, g_memory->terminalWidth, 0, 0);
else if (!seenHeaderOrList)
wrapped << wrapText(line, g_memory->terminalWidth, 0, 0);
else if (isSectionHeader(line) && line.contains("--"))
wrapped << wrapText(line, g_memory->terminalWidth, 0, 30);
else if (isSectionHeader(line))
wrapped << wrapText(line, g_memory->terminalWidth, 0, 10);
else if (isListItem(line))
wrapped << wrapText(line, g_memory->terminalWidth, 2, 4);
else if (isCommand(line))
wrapped << wrapText(line, g_memory->terminalWidth, 10, 23);
else if (isOption(line))
wrapped << wrapText(line, g_memory->terminalWidth, 10, 30);
else
wrapped << wrapText(line, g_memory->terminalWidth, 10, 10);
}
*out << Qt::endl;
for (int i = 0; i < wrapped.size(); ++i)
{
*out << wrapped[i];
*out << Qt::endl;
}
}
//This is in a separate function because the command line tool Bandage reduce
//also displays these.
void getGraphScopeOptions(QStringList * text)
{
*text << "--scope <scope> Graph scope, from one of the following options: entire, aroundnodes, aroundblast, depthrange (default: entire)";
*text << "--nodes <list> A comma-separated list of starting nodes for the aroundnodes scope (default: none)";
*text << "--partial Use partial node name matching (default: exact node name matching)";
*text << "--distance <int> The number of node steps away to draw for the aroundnodes and aroundblast scopes " + getRangeAndDefault(g_settings->nodeDistance);
*text << "--mindepth <float> The minimum allowed depth for the depthrange scope " + getRangeAndDefault(g_settings->minDepthRange);
*text << "--maxdepth <float> The maximum allowed depth for the depthrange scope " + getRangeAndDefault(g_settings->maxDepthRange);
}
//This function checks the values of the Bandage settings.
//If everything is fine, it removes the good arguments/values and returns
//a null string. If there's a problem, it returns an error message.
QString checkForInvalidOrExcessSettings(QStringList * arguments)
{
QStringList argumentsCopy = *arguments;
QStringList validScopeOptions;
validScopeOptions << "entire" << "aroundnodes" << "aroundblast" << "depthrange";
QString error;
error = checkOptionForString("--scope", arguments, validScopeOptions); if (error.length() > 0) return error;
error = checkOptionForString("--nodes", arguments, QStringList(), "a list of node names"); if (error.length() > 0) return error;
checkOptionWithoutValue("--partial", arguments);
error = checkOptionForInt("--distance", arguments, g_settings->nodeDistance, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--mindepth", arguments, g_settings->minDepthRange, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--maxdepth", arguments, g_settings->maxDepthRange, false); if (error.length() > 0) return error;
if (isOptionPresent("--query", arguments) && g_memory->commandLineCommand == NO_COMMAND) return "A graph must be given (e.g. via Bandage load) to use the --query option";
error = checkOptionForFile("--query", arguments); if (error.length() > 0) return error;
error = checkOptionForString("--blastp", arguments, QStringList(), "blastn/tblastn parameters"); if (error.length() > 0) return error;
checkOptionWithoutValue("--double", arguments);
error = checkOptionForFloat("--nodelen", arguments, g_settings->manualNodeLengthPerMegabase, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--minnodlen", arguments, g_settings->minimumNodeLength, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--edgelen", arguments, g_settings->edgeLength, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--doubsep", arguments, g_settings->doubleModeNodeSeparation, false); if (error.length() > 0) return error;
error = checkOptionForInt("--iter", arguments, g_settings->graphLayoutQuality, false); if (error.length() > 0) return error;
checkOptionWithoutValue("--linear", arguments);
error = checkOptionForFloat("--nodseglen", arguments, g_settings->nodeSegmentLength, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--nodewidth", arguments, g_settings->averageNodeWidth, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--depwidth", arguments, g_settings->depthEffectOnWidth, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--deppower", arguments, g_settings->depthPower, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--edgewidth", arguments, g_settings->edgeWidth, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--outline", arguments, g_settings->outlineThickness, false); if (error.length() > 0) return error;
checkOptionWithoutValue("--names", arguments);
checkOptionWithoutValue("--lengths", arguments);
checkOptionWithoutValue("--depth", arguments);
checkOptionWithoutValue("--blasthits", arguments);
error = checkOptionForInt("--fontsize", arguments, IntSetting(0, 1, 100), false); if (error.length() > 0) return error;
error = checkOptionForFloat("--toutline", arguments, g_settings->textOutlineThickness, false); if (error.length() > 0) return error;
checkOptionWithoutValue("--centre", arguments);
error = checkOptionForColour("--edgecol", arguments); if (error.length() > 0) return error;
error = checkOptionForColour("--outcol", arguments); if (error.length() > 0) return error;
error = checkOptionForColour("--selcol", arguments); if (error.length() > 0) return error;
error = checkOptionForColour("--textcol", arguments); if (error.length() > 0) return error;
error = checkOptionForColour("--toutcol", arguments); if (error.length() > 0) return error;
checkOptionWithoutValue("--noaa", arguments);
checkOptionWithoutValue("--singlearr", arguments);
QStringList validColourOptions;
validColourOptions << "random" << "uniform" << "depth" << "blastsolid" << "blastrainbow" << "custom";
error = checkOptionForString("--colour", arguments, validColourOptions); if (error.length() > 0) return error;
error = checkOptionForInt("--ransatpos", arguments, g_settings->randomColourPositiveSaturation, false); if (error.length() > 0) return error;
error = checkOptionForInt("--ransatneg", arguments, g_settings->randomColourNegativeSaturation, false); if (error.length() > 0) return error;
error = checkOptionForInt("--ranligpos", arguments, g_settings->randomColourPositiveLightness, false); if (error.length() > 0) return error;
error = checkOptionForInt("--ranligneg", arguments, g_settings->randomColourNegativeLightness, false); if (error.length() > 0) return error;
error = checkOptionForInt("--ranopapos", arguments, g_settings->randomColourPositiveOpacity, false); if (error.length() > 0) return error;
error = checkOptionForInt("--ranopaneg", arguments, g_settings->randomColourNegativeOpacity, false); if (error.length() > 0) return error;
error = checkOptionForColour("--unicolpos", arguments); if (error.length() > 0) return error;
error = checkOptionForColour("--unicolneg", arguments); if (error.length() > 0) return error;
error = checkOptionForColour("--unicolspe", arguments); if (error.length() > 0) return error;
error = checkOptionForColour("--depcollow", arguments); if (error.length() > 0) return error;
error = checkOptionForColour("--depcolhi", arguments); if (error.length() > 0) return error;
error = checkTwoOptionsForFloats("--depvallow", "--depvalhi", arguments, g_settings->lowDepthValue, g_settings->highDepthValue, true); if (error.length() > 0) return error;
error = checkOptionForInt("--pathnodes", arguments, g_settings->maxQueryPathNodes, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--minpatcov", arguments, g_settings->minQueryCoveredByPath, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--minhitcov", arguments, g_settings->minQueryCoveredByHits, true); if (error.length() > 0) return error;
error = checkOptionForFloat("--minmeanid", arguments, g_settings->minMeanHitIdentity, true); if (error.length() > 0) return error;
error = checkOptionForSciNot("--maxevprod", arguments, g_settings->maxEValueProduct, true); if (error.length() > 0) return error;
error = checkOptionForFloat("--minpatlen", arguments, g_settings->minLengthPercentage, true); if (error.length() > 0) return error;
error = checkOptionForFloat("--maxpatlen", arguments, g_settings->maxLengthPercentage, true); if (error.length() > 0) return error;
error = checkOptionForInt("--minlendis", arguments, g_settings->minLengthBaseDiscrepancy, true); if (error.length() > 0) return error;
error = checkOptionForInt("--maxlendis", arguments, g_settings->maxLengthBaseDiscrepancy, true); if (error.length() > 0) return error;
error = checkOptionForInt("--alfilter", arguments, g_settings->blastAlignmentLengthFilter, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--qcfilter", arguments, g_settings->blastQueryCoverageFilter, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--ifilter", arguments, g_settings->blastIdentityFilter, false); if (error.length() > 0) return error;
error = checkOptionForSciNot("--evfilter", arguments, g_settings->blastEValueFilter, false); if (error.length() > 0) return error;
error = checkOptionForFloat("--bsfilter", arguments, g_settings->blastBitScoreFilter, false); if (error.length() > 0) return error;
//Make sure that the min depth is less than or equal to the max read
//depth.
double minDepth = g_settings->minDepthRange;
double maxDepth = g_settings->maxDepthRange;
if (isOptionPresent("--mindepth", &argumentsCopy))
minDepth = getFloatOption("--mindepth", &argumentsCopy);
if (isOptionPresent("--maxdepth", &argumentsCopy))
maxDepth = getFloatOption("--maxdepth", &argumentsCopy);
if (minDepth > maxDepth)
return "the maximum depth must be greater than or equal to the minimum depth.";
//Make sure that the min path length is less than or equal to the max path
//length.
bool minLengthPercentageOn = g_settings->minLengthPercentage.on;
bool maxLengthPercentageOn = g_settings->maxLengthPercentage.on;
double minLengthPercentage = g_settings->minLengthPercentage;
double maxLengthPercentage = g_settings->maxLengthPercentage;
if (isOptionPresent("--minpatlen", &argumentsCopy))
{
QString optionString = getStringOption("--minpatlen", &argumentsCopy);
if (optionString.toLower() == "off")
minLengthPercentageOn = false;
else
{
minLengthPercentageOn = true;
minLengthPercentage = getFloatOption("--minpatlen", &argumentsCopy);
}
}
if (isOptionPresent("--maxpatlen", &argumentsCopy))
{
QString optionString = getStringOption("--maxpatlen", &argumentsCopy);
if (optionString.toLower() == "off")
maxLengthPercentageOn = false;
else
{
maxLengthPercentageOn = true;
maxLengthPercentage = getFloatOption("--maxpatlen", &argumentsCopy);
}
}
if (minLengthPercentageOn && maxLengthPercentageOn &&
minLengthPercentage > maxLengthPercentage)
return "the maximum BLAST query path length discrepancy must be greater than or equal to the minimum length discrepancy.";
//Make sure that the min length discrepancy is less than or equal to the max
//length discrepancy.
bool minLengthBaseDiscrepancyOn = g_settings->minLengthBaseDiscrepancy.on;
bool maxLengthBaseDiscrepancyOn = g_settings->maxLengthBaseDiscrepancy.on;
int minLengthBaseDiscrepancy = g_settings->minLengthBaseDiscrepancy;
int maxLengthBaseDiscrepancy = g_settings->maxLengthBaseDiscrepancy;
if (isOptionPresent("--minlendis", &argumentsCopy))
{
QString optionString = getStringOption("--minlendis", &argumentsCopy);
if (optionString.toLower() == "off")
minLengthBaseDiscrepancyOn = false;
else
{
minLengthBaseDiscrepancyOn = true;
minLengthBaseDiscrepancy = getIntOption("--minlendis", &argumentsCopy);
}
}
if (isOptionPresent("--maxlendis", &argumentsCopy))
{
QString optionString = getStringOption("--maxlendis", &argumentsCopy);
if (optionString.toLower() == "off")
g_settings->maxLengthBaseDiscrepancy.on = false;
else
{
maxLengthBaseDiscrepancyOn = true;
maxLengthBaseDiscrepancy = getIntOption("--maxlendis", &argumentsCopy);
}
}
if (minLengthBaseDiscrepancyOn && maxLengthBaseDiscrepancyOn &&
minLengthBaseDiscrepancy > maxLengthBaseDiscrepancy)
return "the maximum BLAST query path length discrepancy must be greater than or equal to the minimum length discrepancy.";
bool blastScope = isOptionAndValuePresent("--scope", "aroundblast", &argumentsCopy);
bool queryFile = isOptionPresent("--query", &argumentsCopy);
if (blastScope && !queryFile)
return "A BLAST query must be given with the --query option when the\naroundblast scope is used.";
bool nodesScope = isOptionAndValuePresent("--scope", "aroundnodes", &argumentsCopy);
bool nodesList = isOptionPresent("--nodes", &argumentsCopy);
if (nodesScope && !nodesList)
return "A list of starting nodes must be given with the --nodes option\nwhen the aroundnodes scope is used.";
bool depthScope = isOptionAndValuePresent("--scope", "depthrange", &argumentsCopy);
bool minDepthPresent = isOptionPresent("--mindepth", &argumentsCopy);
bool maxDepthPresent = isOptionPresent("--maxdepth", &argumentsCopy);
if (depthScope && !(minDepthPresent && maxDepthPresent))
return "A depth range must be given with the --mindepth and\n--maxdepth options when the aroundnodes scope is used.";
return checkForExcessArguments(*arguments);
}
void parseSettings(QStringList arguments)
{
if (isOptionPresent("--scope", &arguments))
g_settings->graphScope = getGraphScopeOption("--scope", &arguments);
if (isOptionPresent("--distance", &arguments))
g_settings->nodeDistance = getIntOption("--distance", &arguments);
if (isOptionPresent("--mindepth", &arguments))
g_settings->minDepthRange = getFloatOption("--mindepth", &arguments);
if (isOptionPresent("--maxdepth", &arguments))
g_settings->maxDepthRange = getFloatOption("--maxdepth", &arguments);
if (isOptionPresent("--nodes", &arguments))
g_settings->startingNodes = getStringOption("--nodes", &arguments);
g_settings->startingNodesExactMatch = !isOptionPresent("--partial", &arguments);
if (isOptionPresent("--query", &arguments))
g_settings->blastQueryFilename = getStringOption("--query", &arguments);
if (isOptionPresent("--blastp", &arguments))
g_settings->blastSearchParameters = getStringOption("--blastp", &arguments);
g_settings->doubleMode = isOptionPresent("--double", &arguments);
if (isOptionPresent("--nodelen", &arguments))
{
g_settings->manualNodeLengthPerMegabase = getIntOption("--nodelen", &arguments);
g_settings->nodeLengthMode = MANUAL_NODE_LENGTH;
}
if (isOptionPresent("--edgelen", &arguments))
g_settings->edgeLength = getFloatOption("--edgelen", &arguments);
if (isOptionPresent("--iter", &arguments))
{
int quality = getIntOption("--iter", &arguments);
if (quality < 0)
quality = 0;
if (quality > 4)
quality = 4;
g_settings->graphLayoutQuality = quality;
}
g_settings->linearLayout = isOptionPresent("--linear", &arguments);
if (isOptionPresent("--nodseglen", &arguments))
g_settings->nodeSegmentLength = getFloatOption("--nodseglen", &arguments);
if (isOptionPresent("--nodewidth", &arguments))
g_settings->averageNodeWidth = getFloatOption("--nodewidth", &arguments);
if (isOptionPresent("--depwidth", &arguments))
g_settings->depthEffectOnWidth = getFloatOption("--depwidth", &arguments);
if (isOptionPresent("--deppower", &arguments))
g_settings->depthPower = getFloatOption("--deppower", &arguments);
if (isOptionPresent("--edgewidth", &arguments))
g_settings->edgeWidth = getFloatOption("--edgewidth", &arguments);
if (isOptionPresent("--outline", &arguments))
g_settings->outlineThickness = getFloatOption("--outline", &arguments);
g_settings->antialiasing = !isOptionPresent("--noaa", &arguments);
g_settings->arrowheadsInSingleMode = isOptionPresent("--singlearr", &arguments);
if (isOptionPresent("--edgecol", &arguments))
g_settings->edgeColour = getColourOption("--edgecol", &arguments);
if (isOptionPresent("--outcol", &arguments))
g_settings->outlineColour = getColourOption("--outcol", &arguments);
if (isOptionPresent("--selcol", &arguments))
g_settings->selectionColour = getColourOption("--selcol", &arguments);
if (isOptionPresent("--textcol", &arguments))
g_settings->textColour = getColourOption("--textcol", &arguments);
if (isOptionPresent("--toutcol", &arguments))
g_settings->textOutlineColour = getColourOption("--toutcol", &arguments);
g_settings->positionTextNodeCentre = isOptionPresent("--centre", &arguments);
g_settings->displayNodeNames = isOptionPresent("--names", &arguments);
g_settings->displayNodeLengths = isOptionPresent("--lengths", &arguments);
g_settings->displayNodeDepth = isOptionPresent("--depth", &arguments);
g_settings->displayBlastHits = isOptionPresent("--blasthits", &arguments);
if (isOptionPresent("--fontsize", &arguments))
{
int fontsize = getIntOption("--fontsize", &arguments);
QFont font = g_settings->labelFont;
font.setPointSize(fontsize);
g_settings->labelFont = font;
}
if (isOptionPresent("--toutline", &arguments))
{
double textOutlineThickness = getFloatOption("--toutline", &arguments);
if (textOutlineThickness == 0.0)
g_settings->textOutline = false;
else
{
g_settings->textOutline = true;
g_settings->textOutlineThickness = textOutlineThickness;
}
}
g_settings->nodeColourScheme = getColourSchemeOption("--colour", &arguments);
if (isOptionPresent("--ransatpos", &arguments))
g_settings->randomColourPositiveSaturation = getIntOption("--ransatpos", &arguments);
if (isOptionPresent("--ransatneg", &arguments))
g_settings->randomColourNegativeSaturation = getIntOption("--ransatneg", &arguments);
if (isOptionPresent("--ranligpos", &arguments))
g_settings->randomColourPositiveLightness = getIntOption("--ranligpos", &arguments);
if (isOptionPresent("--ranligneg", &arguments))
g_settings->randomColourNegativeLightness = getIntOption("--ranligneg", &arguments);
if (isOptionPresent("--ranopapos", &arguments))
g_settings->randomColourPositiveOpacity = getIntOption("--ranopapos", &arguments);
if (isOptionPresent("--ranopaneg", &arguments))
g_settings->randomColourNegativeOpacity = getIntOption("--ranopaneg", &arguments);
if (isOptionPresent("--unicolpos", &arguments))
g_settings->uniformPositiveNodeColour = getColourOption("--unicolpos", &arguments);
if (isOptionPresent("--unicolneg", &arguments))
g_settings->uniformNegativeNodeColour = getColourOption("--unicolneg", &arguments);
if (isOptionPresent("--unicolspe", &arguments))
g_settings->uniformNodeSpecialColour = getColourOption("--unicolspe", &arguments);
if (isOptionPresent("--depcollow", &arguments))
g_settings->lowDepthColour = getColourOption("--depcollow", &arguments);
if (isOptionPresent("--depcolhi", &arguments))
g_settings->highDepthColour = getColourOption("--depcolhi", &arguments);
if (isOptionPresent("--depvallow", &arguments))
{
g_settings->lowDepthValue = getFloatOption("--depvallow", &arguments);
g_settings->autoDepthValue = false;
}
if (isOptionPresent("--depvalhi", &arguments))
{
g_settings->highDepthValue = getFloatOption("--depvalhi", &arguments);
g_settings->autoDepthValue = false;
}
if (isOptionPresent("--pathnodes", &arguments))
g_settings->maxQueryPathNodes = getIntOption("--pathnodes", &arguments);
if (isOptionPresent("--minpatcov", &arguments))
g_settings->minQueryCoveredByPath = getFloatOption("--minpatcov", &arguments);
if (isOptionPresent("--minhitcov", &arguments))
{
QString optionString = getStringOption("--minhitcov", &arguments);
if (optionString.toLower() == "off")
g_settings->minQueryCoveredByHits.on = false;
else
{
g_settings->minQueryCoveredByHits.on = true;
g_settings->minQueryCoveredByHits = getFloatOption("--minhitcov", &arguments);
}
}
if (isOptionPresent("--minmeanid", &arguments))
{
QString optionString = getStringOption("--minmeanid", &arguments);
if (optionString.toLower() == "off")
g_settings->minMeanHitIdentity.on = false;
else
{
g_settings->minMeanHitIdentity.on = true;
g_settings->minMeanHitIdentity = getFloatOption("--minmeanid", &arguments);
}
}
if (isOptionPresent("--maxevprod", &arguments))
{
QString optionString = getStringOption("--maxevprod", &arguments);
if (optionString.toLower() == "off")
g_settings->maxEValueProduct.on = false;
else
{
g_settings->maxEValueProduct.on = true;
g_settings->maxEValueProduct = getSciNotOption("--maxevprod", &arguments);
}
}
if (isOptionPresent("--minpatlen", &arguments))
{
QString optionString = getStringOption("--minpatlen", &arguments);
if (optionString.toLower() == "off")
g_settings->minLengthPercentage.on = false;
else
{
g_settings->minLengthPercentage.on = true;
g_settings->minLengthPercentage = getFloatOption("--minpatlen", &arguments);
}
}
if (isOptionPresent("--maxpatlen", &arguments))
{
QString optionString = getStringOption("--maxpatlen", &arguments);
if (optionString.toLower() == "off")
g_settings->maxLengthPercentage.on = false;
else
{
g_settings->maxLengthPercentage.on = true;
g_settings->maxLengthPercentage = getFloatOption("--maxpatlen", &arguments);
}
}
if (isOptionPresent("--minlendis", &arguments))
{
QString optionString = getStringOption("--minlendis", &arguments);
if (optionString.toLower() == "off")
g_settings->minLengthBaseDiscrepancy.on = false;
else
{
g_settings->minLengthBaseDiscrepancy.on = true;
g_settings->minLengthBaseDiscrepancy = getIntOption("--minlendis", &arguments);
}
}
if (isOptionPresent("--maxlendis", &arguments))
{
QString optionString = getStringOption("--maxlendis", &arguments);
if (optionString.toLower() == "off")
g_settings->maxLengthBaseDiscrepancy.on = false;
else
{
g_settings->maxLengthBaseDiscrepancy.on = true;
g_settings->maxLengthBaseDiscrepancy = getIntOption("--maxlendis", &arguments);
}
}
if (isOptionPresent("--alfilter", &arguments))
{
g_settings->blastAlignmentLengthFilter.on = true;
g_settings->blastAlignmentLengthFilter = getIntOption("--alfilter", &arguments);
}
if (isOptionPresent("--qcfilter", &arguments))
{
g_settings->blastQueryCoverageFilter.on = true;
g_settings->blastQueryCoverageFilter = getFloatOption("--qcfilter", &arguments);
}
if (isOptionPresent("--ifilter", &arguments))
{
g_settings->blastIdentityFilter.on = true;
g_settings->blastIdentityFilter = getFloatOption("--ifilter", &arguments);
}
if (isOptionPresent("--evfilter", &arguments))
{
g_settings->blastEValueFilter.on = true;
g_settings->blastEValueFilter = getSciNotOption("--evfilter", &arguments);
}
if (isOptionPresent("--bsfilter", &arguments))
{
g_settings->blastBitScoreFilter.on = true;
g_settings->blastBitScoreFilter = getFloatOption("--bsfilter", &arguments);
}
}
bool checkForHelp(QStringList arguments)
{
int h1 = arguments.indexOf("-h");
int h2 = arguments.indexOf("-help");
int h3 = arguments.indexOf("--help");
return (h1 != -1 || h2 != -1 || h3 != -1);
}
bool checkForHelpAll(QStringList arguments)
{
return (arguments.indexOf("--helpall") != -1);
}
bool checkForVersion(QStringList arguments)
{
int v1 = arguments.indexOf("-v");
int v2 = arguments.indexOf("-version");
int v3 = arguments.indexOf("--version");
return (v1 != -1 || v2 != -1 || v3 != -1);
}
//This function checks the value for an integer-accepting command line option.
//If offOkay is true, then it will also accept "off" as a valid argument.
//Returns empty string if everything is okay and an error message if there's a
//problem. If everything is okay, it also removes the option and its value from
//arguments.
QString checkOptionForInt(QString option, QStringList * arguments, IntSetting setting, bool offOkay)
{
int optionIndex = arguments->indexOf(option);
//If the option isn't found, that's fine.
if (optionIndex == -1)
return "";
int integerIndex = optionIndex + 1;
//If nothing follows the option, that's a problem.
if (integerIndex >= arguments->size())
return option + " must be followed by an integer";
//If the thing following the option isn't an integer, that's a problem.
bool optionIsInt;
int optionInt = arguments->at(integerIndex).toInt(&optionIsInt);
bool optionIsOff = arguments->at(integerIndex).toLower() == "off";
if (offOkay && !(optionIsInt || optionIsOff))
return option + " must be followed by an integer or \"off\"";
if (!offOkay && !optionIsInt)
return option + " must be followed by an integer";
//Check the range of the option.
if (optionIsInt)
{
if (optionInt < setting.min || optionInt > setting.max)
return "Value of " + option + " must be between "
+ QString::number(setting.min) + " and " + QString::number(setting.max) +
" (inclusive)";
}
//If the code got here, the option and its integer are okay.
//Remove them from the arguments.
arguments->removeAt(integerIndex);
arguments->removeAt(optionIndex);
return "";
}
//This function checks the value for a float-accepting command line option.
//If offOkay is true, then it will also accept "off" as a valid argument.
//Returns empty string if everything is okay and an error message if there's a
//problem. If everything is okay, it also removes the option and its value from
//arguments.
QString checkOptionForFloat(QString option, QStringList * arguments, FloatSetting setting, bool offOkay)
{
int optionIndex = arguments->indexOf(option);
//If the option isn't found, that's fine.
if (optionIndex == -1)
return "";
int floatIndex = optionIndex + 1;
//If nothing follows the option, that's a problem.
if (floatIndex >= arguments->size())
return option + " must be followed by a number";
//If the thing following the option isn't a number, that's a problem.
bool optionIsFloat;
double optionFloat = arguments->at(floatIndex).toDouble(&optionIsFloat);
bool optionIsOff = arguments->at(floatIndex).toLower() == "off";
if (offOkay && !(optionIsFloat || optionIsOff))
return option + " must be followed by a number or \"off\"";
if (!offOkay && !optionIsFloat)
return option + " must be followed by a number";
//Check the range of the option.
if (optionIsFloat)
{
if (optionFloat < setting.min || optionFloat > setting.max)
return "Value of " + option + " must be between "
+ QString::number(setting.min) + " and " + QString::number(setting.max) +
" (inclusive)";
}
//If the code got here, the option and its number are okay.
//Remove them from the arguments.
arguments->removeAt(floatIndex);
arguments->removeAt(optionIndex);
return "";
}
//This function checks the value for a scientific notation-accepting command
//line option. If offOkay is true, then it will also accept "off" as a valid
//argument.
//Returns empty string if everything is okay and an error message if there's a
//problem. If everything is okay, it also removes the option and its value from
//arguments.
QString checkOptionForSciNot(QString option, QStringList * arguments,
SciNotSetting setting, bool offOkay)
{
int optionIndex = arguments->indexOf(option);
//If the option isn't found, that's fine.
if (optionIndex == -1)
return "";
int sciNotIndex = optionIndex + 1;
//If nothing follows the option, that's a problem.
if (sciNotIndex >= arguments->size())
return option + " must be followed by a number in scientific notation";
//If the thing following the option isn't a number in scientific notation or
//"off", that's a problem.
bool optionIsSciNot = SciNot::isValidSciNotString(arguments->at(sciNotIndex));
bool optionIsOff = arguments->at(sciNotIndex).toLower() == "off";
if (offOkay && !(optionIsSciNot || optionIsOff))
return option + " must be followed by a number in scientific notation or \"off\"";
if (!offOkay && !optionIsSciNot)
return option + " must be followed by a number in scientific notation";
SciNot optionSciNot = SciNot(arguments->at(sciNotIndex));
//Check the range of the option.
if (optionIsSciNot)
{
if (optionSciNot < setting.min || optionSciNot > setting.max)
return "Value of " + option + " must be between "
+ setting.min.asString(true) + " and " + setting.max.asString(true) +
" (inclusive)";
}
//If the code got here, the option and its number are okay.
//Remove them from the arguments.
arguments->removeAt(sciNotIndex);
arguments->removeAt(optionIndex);
return "";
}
//Returns empty string if everything is okay and an error
//message if there's a problem. If everything is okay, it
//also removes the option and its value from arguments.
QString checkOptionForString(QString option, QStringList * arguments, QStringList validOptionsList, QString validDescription)
{
int optionIndex = arguments->indexOf(option);
//If the option isn't found, that's fine.
if (optionIndex == -1)
return "";
int stringIndex = optionIndex + 1;
QString validOptions;
for (int i = 0; i < validOptionsList.size(); ++i)
{
validOptions += validOptionsList.at(i);
if (i == validOptionsList.size() - 2)
validOptions += " or ";
else if (i < validOptionsList.size() - 2)
validOptions += ", ";
}
if (validOptions == "")
validOptions = validDescription;
//If nothing follows the option, that's a problem.
if (stringIndex >= arguments->size())
return option + " must be followed by " + validOptions;
//If the thing following the option isn't a valid choice, that's a problem.
if (validOptionsList.size() > 0)
{
QString value = arguments->at(stringIndex);
if (!validOptionsList.contains(value, Qt::CaseInsensitive))
return option + " must be followed by " + validOptions;
}
//If the code got here, the option and its string are okay.
//Remove them from the arguments.
arguments->removeAt(stringIndex);
arguments->removeAt(optionIndex);
return "";
}
QString checkOptionForColour(QString option, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
//If the option isn't found, that's fine.
if (optionIndex == -1)
return "";
int colIndex = optionIndex + 1;
//If nothing follows the option, that's a problem.
if (colIndex >= arguments->size())
return option + " must be followed by a 6-digit hex colour (e.g. #FFB6C1), an 8-digit hex colour (e.g. #7FD2B48C) or a standard colour name (e.g. skyblue)";
//If the thing following the option isn't a colour, that's a problem.
QColor colour(arguments->at(colIndex));
if (!colour.isValid())
return option + " must be followed by a 6-digit hex colour (e.g. #FFB6C1), an 8-digit hex colour (e.g. #7FD2B48C) or a standard colour name (e.g. skyblue)";
//If the code got here, the option and its colour are okay.
//Remove them from the arguments.
arguments->removeAt(colIndex);
arguments->removeAt(optionIndex);
return "";
}
QString checkOptionForFile(QString option, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
//If the option isn't found, that's fine.
if (optionIndex == -1)
return "";
int fileIndex = optionIndex + 1;
//If nothing follows the option, that's a problem.
if (fileIndex >= arguments->size())
return option + " must be followed by a filename";
//If the thing that follows the option isn't a file that's a problem
if (!checkIfFileExists(arguments->at(fileIndex)))
return option + " must be followed by a valid filename";
//If the code got here, the option and its file are okay.
//Remove them from the arguments.
arguments->removeAt(fileIndex);
arguments->removeAt(optionIndex);
return "";
}
bool checkIfFileExists(QString filename)
{
QFileInfo checkFile(filename);
return (checkFile.exists() && checkFile.isFile());
}
//This function simply removes an option from arguments if it is found.
void checkOptionWithoutValue(QString option, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
//If the option isn't found, that's fine.
if (optionIndex == -1)
return ;
//If the code got here, the option is okay.
//Remove it from the arguments.
arguments->removeAt(optionIndex);
}
//This function checks to make sure either both or neither of the options
//are used. It can also optionally check to make sure the second is larger
//than the first.
QString checkTwoOptionsForFloats(QString option1, QString option2, QStringList * arguments,
FloatSetting setting1, FloatSetting setting2,
bool secondMustBeEqualOrLarger)
{
//First check each option independently
QStringList argumentsCopy = *arguments;
QString option1Error = checkOptionForFloat(option1, &argumentsCopy, setting1, false);
if (option1Error != "")
return option1Error;
QString option2Error = checkOptionForFloat(option2, &argumentsCopy, setting2, false);
if (option2Error != "")
return option2Error;
//Now make sure either both or neither are present.
if (isOptionPresent(option1, arguments) != isOptionPresent(option2, arguments))
return option1 + " and " + option2 + " must be used together";
if (secondMustBeEqualOrLarger)
{
if (getFloatOption(option2, arguments) < getFloatOption(option1, arguments))
return option2 + " must be greater than or equal to " + option1;
}
//Now remove the options from the arguments before finishing.
checkOptionForFloat(option1, arguments, setting1, false);
checkOptionForFloat(option2, arguments, setting2, false);
return "";
}
bool isOptionPresent(QString option, QStringList * arguments)
{
return (arguments->indexOf(option) > -1);
}
bool isOptionAndValuePresent(QString option, QString value, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
if (optionIndex == -1)
return false;
int valueIndex = optionIndex + 1;
if (valueIndex >= arguments->size())
return false;
QString optionValue = arguments->at(valueIndex);
return (optionValue == value);
}
int getIntOption(QString option, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
if (optionIndex == -1)
return 0;
int integerIndex = optionIndex + 1;
if (integerIndex >= arguments->size())
return 0;
return arguments->at(integerIndex).toInt();
}
double getFloatOption(QString option, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
if (optionIndex == -1)
return 0;
int floatIndex = optionIndex + 1;
if (floatIndex >= arguments->size())
return 0;
return arguments->at(floatIndex).toDouble();
}
SciNot getSciNotOption(QString option, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
if (optionIndex == -1)
return 0;
int sciNotIndex = optionIndex + 1;
if (sciNotIndex >= arguments->size())
return SciNot();
return SciNot(arguments->at(sciNotIndex));
}
NodeColourScheme getColourSchemeOption(QString option, QStringList * arguments)
{
NodeColourScheme defaultScheme = RANDOM_COLOURS;
if (isOptionPresent("--query", arguments))
defaultScheme = BLAST_HITS_SOLID_COLOUR;
int optionIndex = arguments->indexOf(option);
if (optionIndex == -1)
return defaultScheme;
int colourIndex = optionIndex + 1;
if (colourIndex >= arguments->size())
return defaultScheme;
QString colourString = arguments->at(colourIndex).toLower();
if (colourString == "random")
return RANDOM_COLOURS;
else if (colourString == "uniform")
return UNIFORM_COLOURS;
else if (colourString == "depth")
return DEPTH_COLOUR;
else if (colourString == "blastsolid")
return BLAST_HITS_SOLID_COLOUR;
else if (colourString == "blastrainbow")
return BLAST_HITS_RAINBOW_COLOUR;
else if (colourString == "custom")
return CUSTOM_COLOURS;
//Random colours is the default
return defaultScheme;
}
GraphScope getGraphScopeOption(QString option, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
if (optionIndex == -1)
return WHOLE_GRAPH;
int scopeIndex = optionIndex + 1;
if (scopeIndex >= arguments->size())
return WHOLE_GRAPH;
QString scopeString = arguments->at(scopeIndex).toLower();
if (scopeString == "entire")
return WHOLE_GRAPH;
else if (scopeString == "aroundnodes")
return AROUND_NODE;
else if (scopeString == "aroundblast")
return AROUND_BLAST_HITS;
else if (scopeString == "depthrange")
return DEPTH_RANGE;
//Entire graph scope is the default.
return WHOLE_GRAPH;
}
QColor getColourOption(QString option, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
if (optionIndex == -1)
return QColor();
int colIndex = optionIndex + 1;
if (colIndex >= arguments->size())
return QColor();
return QColor(arguments->at(colIndex));
}
QString getStringOption(QString option, QStringList * arguments)
{
int optionIndex = arguments->indexOf(option);
if (optionIndex == -1)
return "";
int stringIndex = optionIndex + 1;
if (stringIndex >= arguments->size())
return "";
return arguments->at(stringIndex);
}
//This function generates an error if excess arguments are left after
//parsing.
QString checkForExcessArguments(QStringList arguments)
{
if (arguments.size() == 0)
return "";
QString invalidOptionText = "Invalid option";
if (arguments.size() > 1)
invalidOptionText += "s";
invalidOptionText += ": ";
for (int i = 0; i < arguments.size(); ++i)
{
invalidOptionText += arguments.at(i);
if (i < arguments.size() - 1)
invalidOptionText += ", ";
}
return invalidOptionText;
}
void getCommonHelp(QStringList * text)
{
*text << "--help View this help message";
*text << "--helpall View all command line settings";
*text << "--version View Bandage version number";
*text << "";
}
bool createBlastTempDirectory()
{
//Running from the command line, it makes more sense to put the temp
//directory in the current directory.
g_blastSearch->m_tempDirectory = "bandage_temp-" + QString::number(QApplication::applicationPid()) + "/";
if (!QDir().mkdir(g_blastSearch->m_tempDirectory))
return false;
g_blastSearch->m_blastQueries.createTempQueryFiles();
return true;
}
void deleteBlastTempDirectory()
{
if (g_blastSearch->m_tempDirectory != "" &&
QDir(g_blastSearch->m_tempDirectory).exists() &&
QDir(g_blastSearch->m_tempDirectory).dirName().contains("bandage_temp"))
QDir(g_blastSearch->m_tempDirectory).removeRecursively();
}
QString getElapsedTime(QDateTime start, QDateTime end)
{
int msecElapsed = start.msecsTo(end);
int secElapsed = msecElapsed / 1000;
msecElapsed = msecElapsed % 1000;
int minElapsed = secElapsed / 60;
secElapsed = secElapsed % 60;
int hoursElapsed = minElapsed / 60;
minElapsed = minElapsed % 60;
QString msecString = QString("%1").arg(msecElapsed, 2, 10, QChar('0'));
QString secString = QString("%1").arg(secElapsed, 2, 10, QChar('0'));
QString minString = QString("%1").arg(minElapsed, 2, 10, QChar('0'));
QString hourString = QString("%1").arg(hoursElapsed, 2, 10, QChar('0'));
return hourString + ":" + minString + ":" + secString + "." + msecString;
}
QStringList wrapText(QString text, int width, int firstLineIndent, int laterLineIndent)
{
QStringList returnList;
QString firstLineSpaces = "";
for (int i = 0; i < firstLineIndent; ++i)
firstLineSpaces += ' ';
QString laterLineSpaces = "";
for (int i = 0; i < laterLineIndent; ++i)
laterLineSpaces += ' ';
text = firstLineSpaces + text;
//If the terminal width is at the minimum, don't bother wrapping.
if (g_memory->terminalWidth <= 50)
{
returnList << text;
return returnList;
}
while (text.length() > width)
{
QString leftString = text.left(width);
int spaceIndex = leftString.lastIndexOf(' ');
if (spaceIndex < width / 2)
spaceIndex = width;
leftString = text.left(spaceIndex);
returnList << rstrip(leftString);
text = laterLineSpaces + text.mid(spaceIndex).trimmed();
}
returnList << text;
return returnList;
}
//http://stackoverflow.com/questions/8215303/how-do-i-remove-trailing-whitespace-from-a-qstring
QString rstrip(const QString& str)
{
int n = str.size() - 1;
for (; n >= 0; --n)
{
if (!str.at(n).isSpace())
return str.left(n + 1);
}
return "";
}
QString getRangeAndDefault(IntSetting setting) {return (setting.on) ? getRangeAndDefault(setting.min, setting.max, setting.val) : getRangeAndDefault(setting.min, setting.max, "off");}
QString getRangeAndDefault(IntSetting setting, QString defaultVal) {return getRangeAndDefault(setting.min, setting.max, defaultVal);}
QString getRangeAndDefault(FloatSetting setting) {return (setting.on) ? getRangeAndDefault(setting.min, setting.max, setting.val) : getRangeAndDefault(setting.min, setting.max, "off");}
QString getRangeAndDefault(FloatSetting setting, QString defaultVal) {return getRangeAndDefault(setting.min, setting.max, defaultVal);}
QString getRangeAndDefault(SciNotSetting setting) {return (setting.on) ? getRangeAndDefault(setting.min.asString(true), setting.max.asString(true), setting.val.asString(true)) : getRangeAndDefault(setting.min.asString(true), setting.max.asString(true), "off");}
QString getRangeAndDefault(int min, int max, int defaultVal) { return getRangeAndDefault(double(min), double(max), QString::number(defaultVal));}
QString getRangeAndDefault(int min, int max, QString defaultVal) {return getRangeAndDefault(double(min), double(max), defaultVal);}
QString getRangeAndDefault(double min, double max, double defaultVal) {return getRangeAndDefault(min, max, QString::number(defaultVal));}
QString getRangeAndDefault(double min, double max, QString defaultVal) {return getRangeAndDefault(QString::number(min), QString::number(max), defaultVal);}
QString getRangeAndDefault(QString min, QString max, QString defaultVal)
{
return "(" + min + " to " + max + ", default: " + defaultVal + ")";
}
QString getDefaultColour(QColor colour)
{
return "(default: " + getColourName(colour.name()) + ")";
}
QString getBandageTitleAsciiArt()
{
return " ____ _ \n | _ \\ | | \n | |_) | __ _ _ __ __| | __ _ __ _ ___ \n | _ < / _` | '_ \\ / _` |/ _` |/ _` |/ _ \\\n | |_) | (_| | | | | (_| | (_| | (_| | __/\n |____/ \\__,_|_| |_|\\__,_|\\__,_|\\__, |\\___|\n __/ | \n |___/ ";
}
bool isOption(QString text)
{
bool option = (text.length() > 2 && text[0] == '-' && text[1] == '-' && text[2] != '-');
QRegularExpression rx("^[\\w ]+:");
return option || text.contains(rx);
}
bool isSectionHeader(QString text)
{
//Make an exception:
if (text.startsWith("Node widths are determined"))
return false;
QRegularExpression rx("^[\\w ]+:");
return text.contains(rx);
}
bool isListItem(QString text)
{
return (text.length() > 1 && text[0] == '*' && text[1] == ' ');
}
bool isCommand(QString text)
{
return text.startsWith("load ") ||
text.startsWith("info ") ||
text.startsWith("image ") ||
text.startsWith("querypaths ") ||
text.startsWith("reduce ");
}
bool isError(QString text)
{
return text.startsWith("Bandage error");
}
void getOnlineHelpMessage(QStringList * text)
{
*text << "Online Bandage help: https://github.com/rrwick/Bandage/wiki";
*text << "";
}
|