5 * Created by westcott on 2/25/10.
6 * Copyright 2010 Schloss Lab. All rights reserved.
10 #include "mothurout.h"
13 /******************************************************/
14 MothurOut* MothurOut::getInstance() {
15 if( _uniqueInstance == 0) {
16 _uniqueInstance = new MothurOut();
18 return _uniqueInstance;
20 /*********************************************************************************************/
21 void MothurOut::printCurrentFiles() {
23 if (accnosfile != "") { mothurOut("accnos=" + accnosfile); mothurOutEndLine(); }
24 if (columnfile != "") { mothurOut("column=" + columnfile); mothurOutEndLine(); }
25 if (designfile != "") { mothurOut("design=" + designfile); mothurOutEndLine(); }
26 if (fastafile != "") { mothurOut("fasta=" + fastafile); mothurOutEndLine(); }
27 if (groupfile != "") { mothurOut("group=" + groupfile); mothurOutEndLine(); }
28 if (listfile != "") { mothurOut("list=" + listfile); mothurOutEndLine(); }
29 if (namefile != "") { mothurOut("name=" + namefile); mothurOutEndLine(); }
30 if (oligosfile != "") { mothurOut("oligos=" + oligosfile); mothurOutEndLine(); }
31 if (orderfile != "") { mothurOut("order=" + orderfile); mothurOutEndLine(); }
32 if (ordergroupfile != "") { mothurOut("ordergroup=" + ordergroupfile); mothurOutEndLine(); }
33 if (phylipfile != "") { mothurOut("phylip=" + phylipfile); mothurOutEndLine(); }
34 if (qualfile != "") { mothurOut("qfile=" + qualfile); mothurOutEndLine(); }
35 if (rabundfile != "") { mothurOut("rabund=" + rabundfile); mothurOutEndLine(); }
36 if (relabundfile != "") { mothurOut("relabund=" + relabundfile); mothurOutEndLine(); }
37 if (sabundfile != "") { mothurOut("sabund=" + sabundfile); mothurOutEndLine(); }
38 if (sfffile != "") { mothurOut("sff=" + sfffile); mothurOutEndLine(); }
39 if (sharedfile != "") { mothurOut("shared=" + sharedfile); mothurOutEndLine(); }
40 if (taxonomyfile != "") { mothurOut("taxonomy=" + taxonomyfile); mothurOutEndLine(); }
41 if (treefile != "") { mothurOut("tree=" + treefile); mothurOutEndLine(); }
42 if (flowfile != "") { mothurOut("flow=" + flowfile); mothurOutEndLine(); }
43 if (processors != "1") { mothurOut("processors=" + processors); mothurOutEndLine(); }
47 errorOut(e, "MothurOut", "printCurrentFiles");
51 /*********************************************************************************************/
52 bool MothurOut::hasCurrentFiles() {
54 bool hasCurrent = false;
56 if (accnosfile != "") { return true; }
57 if (columnfile != "") { return true; }
58 if (designfile != "") { return true; }
59 if (fastafile != "") { return true; }
60 if (groupfile != "") { return true; }
61 if (listfile != "") { return true; }
62 if (namefile != "") { return true; }
63 if (oligosfile != "") { return true; }
64 if (orderfile != "") { return true; }
65 if (ordergroupfile != "") { return true; }
66 if (phylipfile != "") { return true; }
67 if (qualfile != "") { return true; }
68 if (rabundfile != "") { return true; }
69 if (relabundfile != "") { return true; }
70 if (sabundfile != "") { return true; }
71 if (sfffile != "") { return true; }
72 if (sharedfile != "") { return true; }
73 if (taxonomyfile != "") { return true; }
74 if (treefile != "") { return true; }
75 if (flowfile != "") { return true; }
76 if (processors != "1") { return true; }
82 errorOut(e, "MothurOut", "hasCurrentFiles");
87 /*********************************************************************************************/
88 void MothurOut::clearCurrentFiles() {
112 catch(exception& e) {
113 errorOut(e, "MothurOut", "clearCurrentFiles");
117 /*********************************************************************************************/
118 void MothurOut::setFileName(string filename) {
120 logFileName = filename;
124 MPI_Comm_rank(MPI_COMM_WORLD, &pid);
126 if (pid == 0) { //only one process should output to screen
129 openOutputFile(filename, out);
135 catch(exception& e) {
136 errorOut(e, "MothurOut", "setFileName");
140 /*********************************************************************************************/
141 void MothurOut::setDefaultPath(string pathname) {
144 //add / to name if needed
145 string lastChar = pathname.substr(pathname.length()-1);
146 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
147 if (lastChar != "/") { pathname += "/"; }
149 if (lastChar != "\\") { pathname += "\\"; }
152 defaultPath = pathname;
155 catch(exception& e) {
156 errorOut(e, "MothurOut", "setDefaultPath");
160 /*********************************************************************************************/
161 void MothurOut::setOutputDir(string pathname) {
163 outputDir = pathname;
165 catch(exception& e) {
166 errorOut(e, "MothurOut", "setOutputDir");
170 /*********************************************************************************************/
171 void MothurOut::closeLog() {
176 MPI_Comm_rank(MPI_COMM_WORLD, &pid);
178 if (pid == 0) { //only one process should output to screen
187 catch(exception& e) {
188 errorOut(e, "MothurOut", "closeLog");
193 /*********************************************************************************************/
194 MothurOut::~MothurOut() {
199 catch(exception& e) {
200 errorOut(e, "MothurOut", "MothurOut");
204 /*********************************************************************************************/
205 void MothurOut::mothurOut(string output) {
210 MPI_Comm_rank(MPI_COMM_WORLD, &pid);
212 if (pid == 0) { //only one process should output to screen
222 catch(exception& e) {
223 errorOut(e, "MothurOut", "MothurOut");
227 /*********************************************************************************************/
228 void MothurOut::mothurOutEndLine() {
232 MPI_Comm_rank(MPI_COMM_WORLD, &pid);
234 if (pid == 0) { //only one process should output to screen
244 catch(exception& e) {
245 errorOut(e, "MothurOut", "MothurOutEndLine");
249 /*********************************************************************************************/
250 void MothurOut::mothurOut(string output, ofstream& outputFile) {
255 MPI_Comm_rank(MPI_COMM_WORLD, &pid);
257 if (pid == 0) { //only one process should output to screen
262 outputFile << output;
268 catch(exception& e) {
269 errorOut(e, "MothurOut", "MothurOut");
273 /*********************************************************************************************/
274 void MothurOut::mothurOutEndLine(ofstream& outputFile) {
278 MPI_Comm_rank(MPI_COMM_WORLD, &pid);
280 if (pid == 0) { //only one process should output to screen
291 catch(exception& e) {
292 errorOut(e, "MothurOut", "MothurOutEndLine");
296 /*********************************************************************************************/
297 void MothurOut::mothurOutJustToLog(string output) {
301 MPI_Comm_rank(MPI_COMM_WORLD, &pid);
303 if (pid == 0) { //only one process should output to screen
312 catch(exception& e) {
313 errorOut(e, "MothurOut", "MothurOutJustToLog");
317 /*********************************************************************************************/
318 void MothurOut::errorOut(exception& e, string object, string function) {
320 //mem_usage(vm, rss);
322 mothurOut("[ERROR]: ");
323 mothurOut(toString(e.what()));
324 mothurOut(" has occurred in the " + object + " class function " + function + ". Please contact Pat Schloss at mothur.bugs@gmail.com, and be sure to include the mothur.logFile with your inquiry.");
327 /*********************************************************************************************/
328 //The following was originally from http://stackoverflow.com/questions/669438/how-to-get-memory-usage-at-run-time-in-c
329 // process_mem_usage(double &, double &) - takes two doubles by reference,
330 // attempts to read the system-dependent data for a process' virtual memory
331 // size and resident set size, and return the results in KB.
333 // On failure, returns 0.0, 0.0
334 int MothurOut::mem_usage(double& vm_usage, double& resident_set) {
335 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
340 // 'file' stat seems to give the most reliable results
342 ifstream stat_stream("/proc/self/stat",ios_base::in);
344 // dummy vars for leading entries in stat that we don't care about
346 string pid, comm, state, ppid, pgrp, session, tty_nr;
347 string tpgid, flags, minflt, cminflt, majflt, cmajflt;
348 string utime, stime, cutime, cstime, priority, nice;
349 string O, itrealvalue, starttime;
351 // the two fields we want
356 stat_stream >> pid >> comm >> state >> ppid >> pgrp >> session >> tty_nr
357 >> tpgid >> flags >> minflt >> cminflt >> majflt >> cmajflt
358 >> utime >> stime >> cutime >> cstime >> priority >> nice
359 >> O >> itrealvalue >> starttime >> vsize >> rss; // don't care about the rest
361 long page_size_kb = sysconf(_SC_PAGE_SIZE) / 1024; // in case x86-64 is configured to use 2MB pages
362 vm_usage = vsize / 1024.0;
363 resident_set = rss * page_size_kb;
365 mothurOut("Memory Usage: vm = " + toString(vm_usage) + " rss = " + toString(resident_set) + "\n");
369 /* //windows memory usage
370 // Get the list of process identifiers.
371 DWORD aProcesses[1024], cbNeeded, cProcesses;
373 if ( !EnumProcesses( aProcesses, sizeof(aProcesses), &cbNeeded ) ){ return 1; }
375 // Calculate how many process identifiers were returned.
376 cProcesses = cbNeeded / sizeof(DWORD);
378 // Print the memory usage for each process
379 for (int i = 0; i < cProcesses; i++ ) {
380 DWORD processID = aProcesses[i];
382 PROCESS_MEMORY_COUNTERS pmc;
384 HANDLE hProcess = OpenProcess((PROCESS_QUERY_INFORMATION | PROCESS_VM_READ), FALSE, processID);
386 // Print the process identifier.
387 printf( "\nProcess ID: %u\n", processID);
389 if (NULL != hProcess) {
391 if ( GetProcessMemoryInfo( hProcess, &pmc, sizeof(pmc)) ) {
392 printf( "\tPageFaultCount: 0x%08X\n", pmc.PageFaultCount );
393 printf( "\tPeakWorkingSetSize: 0x%08X\n", pmc.PeakWorkingSetSize );
394 printf( "\tWorkingSetSize: 0x%08X\n", pmc.WorkingSetSize );
395 printf( "\tQuotaPeakPagedPoolUsage: 0x%08X\n", pmc.QuotaPeakPagedPoolUsage );
396 printf( "\tQuotaPagedPoolUsage: 0x%08X\n", pmc.QuotaPagedPoolUsage );
397 printf( "\tQuotaPeakNonPagedPoolUsage: 0x%08X\n", pmc.QuotaPeakNonPagedPoolUsage );
398 printf( "\tQuotaNonPagedPoolUsage: 0x%08X\n", pmc.QuotaNonPagedPoolUsage );
399 printf( "\tPagefileUsage: 0x%08X\n", pmc.PagefileUsage );
400 printf( "\tPeakPagefileUsage: 0x%08X\n", pmc.PeakPagefileUsage );
402 CloseHandle(hProcess);
412 /***********************************************************************/
413 int MothurOut::openOutputFileAppend(string fileName, ofstream& fileHandle){
415 fileName = getFullPathName(fileName);
417 fileHandle.open(fileName.c_str(), ios::app);
419 mothurOut("[ERROR]: Could not open " + fileName); mothurOutEndLine();
426 catch(exception& e) {
427 errorOut(e, "MothurOut", "openOutputFileAppend");
431 /***********************************************************************/
432 void MothurOut::gobble(istream& f){
436 while(isspace(d=f.get())) { ;}
439 catch(exception& e) {
440 errorOut(e, "MothurOut", "gobble");
444 /***********************************************************************/
445 void MothurOut::gobble(istringstream& f){
448 while(isspace(d=f.get())) {;}
451 catch(exception& e) {
452 errorOut(e, "MothurOut", "gobble");
457 /***********************************************************************/
459 string MothurOut::getline(istringstream& fileHandle) {
464 while (!fileHandle.eof()) {
466 char c = fileHandle.get();
468 //are you at the end of the line
469 if ((c == '\n') || (c == '\r') || (c == '\f')){ break; }
476 catch(exception& e) {
477 errorOut(e, "MothurOut", "getline");
481 /***********************************************************************/
483 string MothurOut::getline(ifstream& fileHandle) {
490 char c = fileHandle.get();
492 //are you at the end of the line
493 if ((c == '\n') || (c == '\r') || (c == '\f') || (c == EOF)){ break; }
500 catch(exception& e) {
501 errorOut(e, "MothurOut", "getline");
505 /***********************************************************************/
507 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
508 #ifdef USE_COMPRESSION
509 inline bool endsWith(string s, const char * suffix){
510 size_t suffixLength = strlen(suffix);
511 return s.size() >= suffixLength && s.substr(s.size() - suffixLength, suffixLength).compare(suffix) == 0;
516 string MothurOut::getRootName(string longName){
519 string rootName = longName;
521 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
522 #ifdef USE_COMPRESSION
523 if (endsWith(rootName, ".gz") || endsWith(rootName, ".bz2")) {
524 int pos = rootName.find_last_of('.');
525 rootName = rootName.substr(0, pos);
526 cerr << "shortening " << longName << " to " << rootName << "\n";
530 if(rootName.find_last_of(".") != rootName.npos){
531 int pos = rootName.find_last_of('.')+1;
532 rootName = rootName.substr(0, pos);
537 catch(exception& e) {
538 errorOut(e, "MothurOut", "getRootName");
542 /***********************************************************************/
544 string MothurOut::getSimpleName(string longName){
546 string simpleName = longName;
549 found=longName.find_last_of("/\\");
551 if(found != longName.npos){
552 simpleName = longName.substr(found+1);
557 catch(exception& e) {
558 errorOut(e, "MothurOut", "getSimpleName");
563 /***********************************************************************/
565 int MothurOut::getRandomIndex(int highest){
568 int random = (int) ((float)(highest+1) * (float)(rand()) / ((float)RAND_MAX+1.0));
572 catch(exception& e) {
573 errorOut(e, "MothurOut", "getRandomIndex");
578 /**********************************************************************/
580 string MothurOut::getPathName(string longName){
582 string rootPathName = longName;
584 if(longName.find_last_of("/\\") != longName.npos){
585 int pos = longName.find_last_of("/\\")+1;
586 rootPathName = longName.substr(0, pos);
591 catch(exception& e) {
592 errorOut(e, "MothurOut", "getPathName");
597 /***********************************************************************/
599 string MothurOut::hasPath(string longName){
604 found=longName.find_last_of("~/\\");
606 if(found != longName.npos){
607 path = longName.substr(0, found+1);
612 catch(exception& e) {
613 errorOut(e, "MothurOut", "hasPath");
618 /***********************************************************************/
620 string MothurOut::getExtension(string longName){
622 string extension = longName;
624 if(longName.find_last_of('.') != longName.npos){
625 int pos = longName.find_last_of('.');
626 extension = longName.substr(pos, longName.length());
631 catch(exception& e) {
632 errorOut(e, "MothurOut", "getExtension");
636 /***********************************************************************/
637 bool MothurOut::isBlank(string fileName){
640 fileName = getFullPathName(fileName);
643 fileHandle.open(fileName.c_str());
645 mothurOut("[ERROR]: Could not open " + fileName); mothurOutEndLine();
648 //check for blank file
650 if (fileHandle.eof()) { fileHandle.close(); return true; }
655 catch(exception& e) {
656 errorOut(e, "MothurOut", "isBlank");
660 /***********************************************************************/
662 string MothurOut::getFullPathName(string fileName){
665 string path = hasPath(fileName);
669 if (path == "") { return fileName; } //its a simple name
670 else { //we need to complete the pathname
671 // ex. ../../../filename
672 // cwd = /user/work/desktop
675 //get current working directory
676 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
678 if (path.find("~") != -1) { //go to home directory
681 char *homepath = NULL;
682 homepath = getenv ("HOME");
683 if ( homepath != NULL) { homeDir = homepath; }
684 else { homeDir = ""; }
686 newFileName = homeDir + fileName.substr(fileName.find("~")+1);
689 if (path.rfind("./") == string::npos) { return fileName; } //already complete name
690 else { newFileName = fileName.substr(fileName.rfind("./")+2); } //save the complete part of the name
692 //char* cwdpath = new char[1024];
694 //cwdpath=getcwd(cwdpath,size);
697 char *cwdpath = NULL;
698 cwdpath = getcwd(NULL, 0); // or _getcwd
699 if ( cwdpath != NULL) { cwd = cwdpath; }
705 if (cwd.length() > 0) { simpleCWD = cwd.substr(1); }
707 //break apart the current working directory
709 while (simpleCWD.find_first_of('/') != string::npos) {
710 string dir = simpleCWD.substr(0,simpleCWD.find_first_of('/'));
711 simpleCWD = simpleCWD.substr(simpleCWD.find_first_of('/')+1, simpleCWD.length());
714 //get last one // ex. ../../../filename = /user/work/desktop/filename
715 dirs.push_back(simpleCWD); //ex. dirs[0] = user, dirs[1] = work, dirs[2] = desktop
718 int index = dirs.size()-1;
720 while((pos = path.rfind("./")) != string::npos) { //while you don't have a complete path
721 if (pos == 0) { break; //you are at the end
722 }else if (path[(pos-1)] == '.') { //you want your parent directory ../
723 path = path.substr(0, pos-1);
725 if (index == 0) { break; }
726 }else if (path[(pos-1)] == '/') { //you want the current working dir ./
727 path = path.substr(0, pos);
728 }else if (pos == 1) { break; //you are at the end
729 }else { cout << "cannot resolve path for " << fileName << endl; return fileName; }
732 for (int i = index; i >= 0; i--) {
733 newFileName = dirs[i] + "/" + newFileName;
736 newFileName = "/" + newFileName;
740 if (path.find("~") != string::npos) { //go to home directory
741 string homeDir = getenv ("HOMEPATH");
742 newFileName = homeDir + fileName.substr(fileName.find("~")+1);
745 if (path.rfind(".\\") == string::npos) { return fileName; } //already complete name
746 else { newFileName = fileName.substr(fileName.rfind(".\\")+2); } //save the complete part of the name
748 char *cwdpath = NULL;
749 cwdpath = getcwd(NULL, 0); // or _getcwd
750 if ( cwdpath != NULL) { cwd = cwdpath; }
753 //break apart the current working directory
755 while (cwd.find_first_of('\\') != -1) {
756 string dir = cwd.substr(0,cwd.find_first_of('\\'));
757 cwd = cwd.substr(cwd.find_first_of('\\')+1, cwd.length());
762 dirs.push_back(cwd); //ex. dirs[0] = user, dirs[1] = work, dirs[2] = desktop
764 int index = dirs.size()-1;
766 while((pos = path.rfind(".\\")) != string::npos) { //while you don't have a complete path
767 if (pos == 0) { break; //you are at the end
768 }else if (path[(pos-1)] == '.') { //you want your parent directory ../
769 path = path.substr(0, pos-1);
771 if (index == 0) { break; }
772 }else if (path[(pos-1)] == '\\') { //you want the current working dir ./
773 path = path.substr(0, pos);
774 }else if (pos == 1) { break; //you are at the end
775 }else { cout << "cannot resolve path for " << fileName << endl; return fileName; }
778 for (int i = index; i >= 0; i--) {
779 newFileName = dirs[i] + "\\" + newFileName;
788 catch(exception& e) {
789 errorOut(e, "MothurOut", "getFullPathName");
793 /***********************************************************************/
795 int MothurOut::openInputFile(string fileName, ifstream& fileHandle, string m){
798 string completeFileName = getFullPathName(fileName);
799 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
800 #ifdef USE_COMPRESSION
801 // check for gzipped or bzipped file
802 if (endsWith(completeFileName, ".gz") || endsWith(completeFileName, ".bz2")) {
803 string tempName = string(tmpnam(0));
804 mkfifo(tempName.c_str(), 0666);
805 int fork_result = fork();
806 if (fork_result < 0) {
807 cerr << "Error forking.\n";
809 } else if (fork_result == 0) {
810 string command = (endsWith(completeFileName, ".gz") ? "zcat " : "bzcat ") + completeFileName + string(" > ") + tempName;
811 cerr << "Decompressing " << completeFileName << " via temporary named pipe " << tempName << "\n";
812 system(command.c_str());
813 cerr << "Done decompressing " << completeFileName << "\n";
814 mothurRemove(tempName);
817 cerr << "waiting on child process " << fork_result << "\n";
818 completeFileName = tempName;
823 fileHandle.open(completeFileName.c_str());
825 //mothurOut("[ERROR]: Could not open " + completeFileName); mothurOutEndLine();
828 //check for blank file
833 catch(exception& e) {
834 errorOut(e, "MothurOut", "openInputFile - no Error");
838 /***********************************************************************/
840 int MothurOut::openInputFile(string fileName, ifstream& fileHandle){
844 string completeFileName = getFullPathName(fileName);
845 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
846 #ifdef USE_COMPRESSION
847 // check for gzipped or bzipped file
848 if (endsWith(completeFileName, ".gz") || endsWith(completeFileName, ".bz2")) {
849 string tempName = string(tmpnam(0));
850 mkfifo(tempName.c_str(), 0666);
851 int fork_result = fork();
852 if (fork_result < 0) {
853 cerr << "Error forking.\n";
855 } else if (fork_result == 0) {
856 string command = (endsWith(completeFileName, ".gz") ? "zcat " : "bzcat ") + completeFileName + string(" > ") + tempName;
857 cerr << "Decompressing " << completeFileName << " via temporary named pipe " << tempName << "\n";
858 system(command.c_str());
859 cerr << "Done decompressing " << completeFileName << "\n";
860 mothurRemove(tempName);
863 cerr << "waiting on child process " << fork_result << "\n";
864 completeFileName = tempName;
870 fileHandle.open(completeFileName.c_str());
872 mothurOut("[ERROR]: Could not open " + completeFileName); mothurOutEndLine();
876 //check for blank file
878 if (fileHandle.eof()) { mothurOut("[ERROR]: " + completeFileName + " is blank. Please correct."); mothurOutEndLine(); }
883 catch(exception& e) {
884 errorOut(e, "MothurOut", "openInputFile");
888 /***********************************************************************/
890 int MothurOut::renameFile(string oldName, string newName){
893 int exist = openInputFile(newName, inTest, "");
895 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
896 if (exist == 0) { //you could open it so you want to delete it
898 string command = "rm " + newName;
899 system(command.c_str());
902 string command = "mv " + oldName + " " + newName;
903 system(command.c_str());
905 mothurRemove(newName);
906 int renameOk = rename(oldName.c_str(), newName.c_str());
911 catch(exception& e) {
912 errorOut(e, "MothurOut", "renameFile");
917 /***********************************************************************/
919 int MothurOut::openOutputFile(string fileName, ofstream& fileHandle){
922 string completeFileName = getFullPathName(fileName);
923 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
924 #ifdef USE_COMPRESSION
925 // check for gzipped file
926 if (endsWith(completeFileName, ".gz") || endsWith(completeFileName, ".bz2")) {
927 string tempName = string(tmpnam(0));
928 mkfifo(tempName.c_str(), 0666);
929 cerr << "Compressing " << completeFileName << " via temporary named pipe " << tempName << "\n";
930 int fork_result = fork();
931 if (fork_result < 0) {
932 cerr << "Error forking.\n";
934 } else if (fork_result == 0) {
935 string command = string(endsWith(completeFileName, ".gz") ? "gzip" : "bzip2") + " -v > " + completeFileName + string(" < ") + tempName;
936 system(command.c_str());
939 completeFileName = tempName;
944 fileHandle.open(completeFileName.c_str(), ios::trunc);
946 mothurOut("[ERROR]: Could not open " + completeFileName); mothurOutEndLine();
953 catch(exception& e) {
954 errorOut(e, "MothurOut", "openOutputFile");
960 /**************************************************************************************************/
961 void MothurOut::appendFiles(string temp, string filename) {
966 //open output file in append mode
967 openOutputFileAppend(filename, output);
968 int ableToOpen = openInputFile(temp, input, "no error");
969 //int ableToOpen = openInputFile(temp, input);
971 if (ableToOpen == 0) { //you opened it
972 while(char c = input.get()){
973 if(input.eof()) { break; }
974 else { output << c; }
981 catch(exception& e) {
982 errorOut(e, "MothurOut", "appendFiles");
987 /**************************************************************************************************/
988 string MothurOut::sortFile(string distFile, string outputDir){
991 //if (outputDir == "") { outputDir += hasPath(distFile); }
992 string outfile = getRootName(distFile) + "sorted.dist";
995 //if you can, use the unix sort since its been optimized for years
996 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
997 string command = "sort -n -k +3 " + distFile + " -o " + outfile;
998 system(command.c_str());
999 #else //you are stuck with my best attempt...
1000 //windows sort does not have a way to specify a column, only a character in the line
1001 //since we cannot assume that the distance will always be at the the same character location on each line
1002 //due to variable sequence name lengths, I chose to force the distance into first position, then sort and then put it back.
1004 //read in file line by file and put distance first
1005 string tempDistFile = distFile + ".temp";
1008 openInputFile(distFile, input);
1009 openOutputFile(tempDistFile, output);
1011 string firstName, secondName;
1014 input >> firstName >> secondName >> dist;
1015 output << dist << '\t' << firstName << '\t' << secondName << endl;
1022 //sort using windows sort
1023 string tempOutfile = outfile + ".temp";
1024 string command = "sort " + tempDistFile + " /O " + tempOutfile;
1025 system(command.c_str());
1027 //read in sorted file and put distance at end again
1029 openInputFile(tempOutfile, input2);
1030 openOutputFile(outfile, output);
1033 input2 >> dist >> firstName >> secondName;
1034 output << firstName << '\t' << secondName << '\t' << dist << endl;
1041 mothurRemove(tempDistFile);
1042 mothurRemove(tempOutfile);
1047 catch(exception& e) {
1048 errorOut(e, "MothurOut", "sortFile");
1052 /**************************************************************************************************/
1053 vector<unsigned long int> MothurOut::setFilePosFasta(string filename, int& num) {
1055 vector<unsigned long int> positions;
1057 openInputFile(filename, inFASTA);
1060 while(!inFASTA.eof()){
1061 input = getline(inFASTA);
1062 if (input.length() != 0) {
1063 if(input[0] == '>'){ unsigned long int pos = inFASTA.tellg(); positions.push_back(pos - input.length() - 1); }
1065 gobble(inFASTA); //has to be here since windows line endings are 2 characters and mess up the positions
1069 num = positions.size();
1074 //get num bytes in file
1075 pFile = fopen (filename.c_str(),"rb");
1076 if (pFile==NULL) perror ("Error opening file");
1078 fseek (pFile, 0, SEEK_END);
1083 unsigned long int size = positions[(positions.size()-1)];
1085 openInputFile(filename, in);
1090 if(in.eof()) { break; }
1095 positions.push_back(size);
1099 catch(exception& e) {
1100 errorOut(e, "MothurOut", "setFilePosFasta");
1104 /**************************************************************************************************/
1105 vector<unsigned long int> MothurOut::setFilePosEachLine(string filename, int& num) {
1107 filename = getFullPathName(filename);
1109 vector<unsigned long int> positions;
1111 openInputFile(filename, in);
1115 unsigned long int lastpos = in.tellg();
1116 input = getline(in);
1117 if (input.length() != 0) {
1118 unsigned long int pos = in.tellg();
1119 if (pos != -1) { positions.push_back(pos - input.length() - 1); }
1120 else { positions.push_back(lastpos); }
1122 gobble(in); //has to be here since windows line endings are 2 characters and mess up the positions
1126 num = positions.size();
1129 unsigned long int size;
1131 //get num bytes in file
1132 pFile = fopen (filename.c_str(),"rb");
1133 if (pFile==NULL) perror ("Error opening file");
1135 fseek (pFile, 0, SEEK_END);
1140 positions.push_back(size);
1144 catch(exception& e) {
1145 errorOut(e, "MothurOut", "setFilePosEachLine");
1149 /**************************************************************************************************/
1151 vector<unsigned long int> MothurOut::divideFile(string filename, int& proc) {
1154 vector<unsigned long int> filePos;
1155 filePos.push_back(0);
1158 unsigned long int size;
1160 filename = getFullPathName(filename);
1162 //get num bytes in file
1163 pFile = fopen (filename.c_str(),"rb");
1164 if (pFile==NULL) perror ("Error opening file");
1166 fseek (pFile, 0, SEEK_END);
1171 //estimate file breaks
1172 unsigned long int chunkSize = 0;
1173 chunkSize = size / proc;
1175 //file to small to divide by processors
1176 if (chunkSize == 0) { proc = 1; filePos.push_back(size); return filePos; }
1178 //for each process seekg to closest file break and search for next '>' char. make that the filebreak
1179 for (int i = 0; i < proc; i++) {
1180 unsigned long int spot = (i+1) * chunkSize;
1183 openInputFile(filename, in);
1187 unsigned long int newSpot = spot;
1190 if (c == '>') { in.putback(c); newSpot = in.tellg(); break; }
1193 //there was not another sequence before the end of the file
1194 unsigned long int sanityPos = in.tellg();
1196 if (sanityPos == -1) { break; }
1197 else { filePos.push_back(newSpot); }
1203 filePos.push_back(size);
1205 //sanity check filePos
1206 for (int i = 0; i < (filePos.size()-1); i++) {
1207 if (filePos[(i+1)] <= filePos[i]) { filePos.erase(filePos.begin()+(i+1)); i--; }
1210 proc = (filePos.size() - 1);
1214 catch(exception& e) {
1215 errorOut(e, "MothurOut", "divideFile");
1219 /**************************************************************************************************/
1220 int MothurOut::divideFile(string filename, int& proc, vector<string>& files) {
1223 vector<unsigned long int> filePos = divideFile(filename, proc);
1225 for (int i = 0; i < (filePos.size()-1); i++) {
1229 openInputFile(filename, in);
1230 in.seekg(filePos[i]);
1231 unsigned long int size = filePos[(i+1)] - filePos[i];
1232 char* chunk = new char[size];
1233 in.read(chunk, size);
1237 string fileChunkName = filename + "." + toString(i) + ".tmp";
1239 openOutputFile(fileChunkName, out);
1241 out << chunk << endl;
1246 files.push_back(fileChunkName);
1251 catch(exception& e) {
1252 errorOut(e, "MothurOut", "divideFile");
1256 /***********************************************************************/
1258 bool MothurOut::isTrue(string f){
1261 for (int i = 0; i < f.length(); i++) { f[i] = toupper(f[i]); }
1263 if ((f == "TRUE") || (f == "T")) { return true; }
1264 else { return false; }
1266 catch(exception& e) {
1267 errorOut(e, "MothurOut", "isTrue");
1272 /***********************************************************************/
1274 float MothurOut::roundDist(float dist, int precision){
1276 return int(dist * precision + 0.5)/float(precision);
1278 catch(exception& e) {
1279 errorOut(e, "MothurOut", "roundDist");
1283 /***********************************************************************/
1285 float MothurOut::ceilDist(float dist, int precision){
1287 return int(ceil(dist * precision))/float(precision);
1289 catch(exception& e) {
1290 errorOut(e, "MothurOut", "ceilDist");
1294 /**********************************************************************************************************************/
1295 int MothurOut::readNames(string namefile, map<string, string>& nameMap) {
1300 openInputFile(namefile, in);
1303 if (control_pressed) { break; }
1305 string firstCol, secondCol;
1306 in >> firstCol >> secondCol; gobble(in);
1308 nameMap[firstCol] = secondCol;
1315 catch(exception& e) {
1316 errorOut(e, "MothurOut", "readNames");
1321 /**********************************************************************************************************************/
1322 map<string, int> MothurOut::readNames(string namefile) {
1325 map<string, int> nameMap;
1329 openInputFile(namefile, in);
1332 if (control_pressed) { break; }
1334 string firstCol, secondCol;
1335 in >> firstCol >> secondCol; gobble(in);
1337 int num = getNumNames(secondCol);
1339 nameMap[firstCol] = num;
1346 catch(exception& e) {
1347 errorOut(e, "MothurOut", "readNames");
1351 /**********************************************************************************************************************/
1352 int MothurOut::readNames(string namefile, vector<seqPriorityNode>& nameVector, map<string, string>& fastamap) {
1358 openInputFile(namefile, in);
1361 if (control_pressed) { break; }
1363 string firstCol, secondCol;
1364 in >> firstCol >> secondCol; gobble(in);
1366 int num = getNumNames(secondCol);
1368 map<string, string>::iterator it = fastamap.find(firstCol);
1369 if (it == fastamap.end()) {
1371 mothurOut("[ERROR]: " + firstCol + " is not in your fastafile, but is in your namesfile, please correct."); mothurOutEndLine();
1373 seqPriorityNode temp(num, it->second, firstCol);
1374 nameVector.push_back(temp);
1382 catch(exception& e) {
1383 errorOut(e, "MothurOut", "readNames");
1388 /***********************************************************************/
1390 int MothurOut::getNumNames(string names){
1396 for(int i=0;i<names.size();i++){
1397 if(names[i] == ','){
1405 catch(exception& e) {
1406 errorOut(e, "MothurOut", "getNumNames");
1410 /***********************************************************************/
1412 void MothurOut::mothurRemove(string filename){
1414 filename = getFullPathName(filename);
1415 remove(filename.c_str());
1417 catch(exception& e) {
1418 errorOut(e, "MothurOut", "mothurRemove");
1422 /**************************************************************************************************/
1424 vector<vector<double> > MothurOut::binomial(int maxOrder){
1426 vector<vector<double> > binomial(maxOrder+1);
1428 for(int i=0;i<=maxOrder;i++){
1429 binomial[i].resize(maxOrder+1);
1438 for(int i=2;i<=maxOrder;i++){
1442 for(int i=2;i<=maxOrder;i++){
1443 for(int j=1;j<=maxOrder;j++){
1444 if(i==j){ binomial[i][j]=1; }
1445 if(j>i) { binomial[i][j]=0; }
1446 else { binomial[i][j]=binomial[i-1][j-1]+binomial[i-1][j]; }
1453 catch(exception& e) {
1454 errorOut(e, "MothurOut", "binomial");
1458 /**************************************************************************************************/
1459 unsigned int MothurOut::fromBase36(string base36){
1461 unsigned int num = 0;
1463 map<char, int> converts;
1528 while (i < base36.length()) {
1530 num = 36 * num + converts[c];
1537 catch(exception& e) {
1538 errorOut(e, "MothurOut", "fromBase36");
1542 /***********************************************************************/
1544 int MothurOut::factorial(int num){
1548 for (int i = 1; i <= num; i++) {
1554 catch(exception& e) {
1555 errorOut(e, "MothurOut", "factorial");
1559 /***********************************************************************/
1561 int MothurOut::getNumSeqs(ifstream& file){
1563 int numSeqs = count(istreambuf_iterator<char>(file),istreambuf_iterator<char>(), '>');
1567 catch(exception& e) {
1568 errorOut(e, "MothurOut", "getNumSeqs");
1572 /***********************************************************************/
1573 void MothurOut::getNumSeqs(ifstream& file, int& numSeqs){
1578 input = getline(file);
1579 if (input.length() != 0) {
1580 if(input[0] == '>'){ numSeqs++; }
1584 catch(exception& e) {
1585 errorOut(e, "MothurOut", "getNumSeqs");
1589 /***********************************************************************/
1591 //This function parses the estimator options and puts them in a vector
1592 void MothurOut::splitAtChar(string& estim, vector<string>& container, char symbol) {
1594 string individual = "";
1595 int estimLength = estim.size();
1596 for(int i=0;i<estimLength;i++){
1597 if(estim[i] == symbol){
1598 container.push_back(individual);
1602 individual += estim[i];
1605 container.push_back(individual);
1608 catch(exception& e) {
1609 errorOut(e, "MothurOut", "splitAtChar");
1614 /***********************************************************************/
1616 //This function parses the estimator options and puts them in a vector
1617 void MothurOut::splitAtDash(string& estim, vector<string>& container) {
1619 string individual = "";
1620 int estimLength = estim.size();
1621 for(int i=0;i<estimLength;i++){
1622 if(estim[i] == '-'){
1623 container.push_back(individual);
1627 individual += estim[i];
1630 container.push_back(individual);
1633 /* string individual;
1635 while (estim.find_first_of('-') != -1) {
1636 individual = estim.substr(0,estim.find_first_of('-'));
1637 if ((estim.find_first_of('-')+1) <= estim.length()) { //checks to make sure you don't have dash at end of string
1638 estim = estim.substr(estim.find_first_of('-')+1, estim.length());
1639 container.push_back(individual);
1643 container.push_back(estim); */
1645 catch(exception& e) {
1646 errorOut(e, "MothurOut", "splitAtDash");
1651 /***********************************************************************/
1652 //This function parses the label options and puts them in a set
1653 void MothurOut::splitAtDash(string& estim, set<string>& container) {
1655 string individual = "";
1656 int estimLength = estim.size();
1657 for(int i=0;i<estimLength;i++){
1658 if(estim[i] == '-'){
1659 container.insert(individual);
1663 individual += estim[i];
1666 container.insert(individual);
1668 // string individual;
1670 // while (estim.find_first_of('-') != -1) {
1671 // individual = estim.substr(0,estim.find_first_of('-'));
1672 // if ((estim.find_first_of('-')+1) <= estim.length()) { //checks to make sure you don't have dash at end of string
1673 // estim = estim.substr(estim.find_first_of('-')+1, estim.length());
1674 // container.insert(individual);
1678 // container.insert(estim);
1681 catch(exception& e) {
1682 errorOut(e, "MothurOut", "splitAtDash");
1686 /***********************************************************************/
1687 //This function parses the line options and puts them in a set
1688 void MothurOut::splitAtDash(string& estim, set<int>& container) {
1693 while (estim.find_first_of('-') != -1) {
1694 individual = estim.substr(0,estim.find_first_of('-'));
1695 if ((estim.find_first_of('-')+1) <= estim.length()) { //checks to make sure you don't have dash at end of string
1696 estim = estim.substr(estim.find_first_of('-')+1, estim.length());
1697 convert(individual, lineNum); //convert the string to int
1698 container.insert(lineNum);
1702 convert(estim, lineNum); //convert the string to int
1703 container.insert(lineNum);
1705 catch(exception& e) {
1706 errorOut(e, "MothurOut", "splitAtDash");
1710 /***********************************************************************/
1711 //This function parses the a string and puts peices in a vector
1712 void MothurOut::splitAtComma(string& estim, vector<string>& container) {
1714 string individual = "";
1715 int estimLength = estim.size();
1716 for(int i=0;i<estimLength;i++){
1717 if(estim[i] == ','){
1718 container.push_back(individual);
1722 individual += estim[i];
1725 container.push_back(individual);
1730 // string individual;
1732 // while (estim.find_first_of(',') != -1) {
1733 // individual = estim.substr(0,estim.find_first_of(','));
1734 // if ((estim.find_first_of(',')+1) <= estim.length()) { //checks to make sure you don't have comma at end of string
1735 // estim = estim.substr(estim.find_first_of(',')+1, estim.length());
1736 // container.push_back(individual);
1740 // container.push_back(estim);
1742 catch(exception& e) {
1743 errorOut(e, "MothurOut", "splitAtComma");
1747 /***********************************************************************/
1749 //This function splits up the various option parameters
1750 void MothurOut::splitAtComma(string& prefix, string& suffix){
1752 prefix = suffix.substr(0,suffix.find_first_of(','));
1753 if ((suffix.find_first_of(',')+2) <= suffix.length()) { //checks to make sure you don't have comma at end of string
1754 suffix = suffix.substr(suffix.find_first_of(',')+1, suffix.length());
1756 while(suffix.at(0) == ' ')
1757 suffix = suffix.substr(1, suffix.length());
1761 catch(exception& e) {
1762 errorOut(e, "MothurOut", "splitAtComma");
1766 /***********************************************************************/
1768 //This function separates the key value from the option value i.e. dist=96_...
1769 void MothurOut::splitAtEquals(string& key, string& value){
1771 if(value.find_first_of('=') != -1){
1772 key = value.substr(0,value.find_first_of('='));
1773 if ((value.find_first_of('=')+1) <= value.length()) {
1774 value = value.substr(value.find_first_of('=')+1, value.length());
1781 catch(exception& e) {
1782 errorOut(e, "MothurOut", "splitAtEquals");
1787 /**************************************************************************************************/
1789 bool MothurOut::inUsersGroups(string groupname, vector<string> Groups) {
1791 for (int i = 0; i < Groups.size(); i++) {
1792 if (groupname == Groups[i]) { return true; }
1796 catch(exception& e) {
1797 errorOut(e, "MothurOut", "inUsersGroups");
1801 /**************************************************************************************************/
1802 //returns true if any of the strings in first vector are in second vector
1803 bool MothurOut::inUsersGroups(vector<string> groupnames, vector<string> Groups) {
1806 for (int i = 0; i < groupnames.size(); i++) {
1807 if (inUsersGroups(groupnames[i], Groups)) { return true; }
1811 catch(exception& e) {
1812 errorOut(e, "MothurOut", "inUsersGroups");
1816 /***********************************************************************/
1817 //this function determines if the user has given us labels that are smaller than the given label.
1818 //if so then it returns true so that the calling function can run the previous valid distance.
1819 //it's a "smart" distance function. It also checks for invalid labels.
1820 bool MothurOut::anyLabelsToProcess(string label, set<string>& userLabels, string errorOff) {
1823 set<string>::iterator it;
1824 vector<float> orderFloat;
1825 map<string, float> userMap; //the conversion process removes trailing 0's which we need to put back
1826 map<string, float>::iterator it2;
1828 bool smaller = false;
1830 //unique is the smallest line
1831 if (label == "unique") { return false; }
1833 if (convertTestFloat(label, labelFloat)) {
1834 convert(label, labelFloat);
1835 }else { //cant convert
1840 //go through users set and make them floats
1841 for(it = userLabels.begin(); it != userLabels.end();) {
1844 if ((*it != "unique") && (convertTestFloat(*it, temp) == true)){
1846 orderFloat.push_back(temp);
1847 userMap[*it] = temp;
1849 }else if (*it == "unique") {
1850 orderFloat.push_back(-1.0);
1851 userMap["unique"] = -1.0;
1854 if (errorOff == "") { mothurOut(*it + " is not a valid label."); mothurOutEndLine(); }
1855 userLabels.erase(it++);
1860 sort(orderFloat.begin(), orderFloat.end());
1862 /*************************************************/
1863 //is this label bigger than any of the users labels
1864 /*************************************************/
1866 //loop through order until you find a label greater than label
1867 for (int i = 0; i < orderFloat.size(); i++) {
1868 if (orderFloat[i] < labelFloat) {
1870 if (orderFloat[i] == -1) {
1871 if (errorOff == "") { mothurOut("Your file does not include the label unique."); mothurOutEndLine(); }
1872 userLabels.erase("unique");
1875 if (errorOff == "") { mothurOut("Your file does not include the label "); mothurOutEndLine(); }
1877 for (it2 = userMap.begin(); it2!= userMap.end(); it2++) {
1878 if (it2->second == orderFloat[i]) {
1880 //remove small labels
1881 userLabels.erase(s);
1885 if (errorOff == "") {mothurOut( s + ". I will use the next smallest distance. "); mothurOutEndLine(); }
1887 //since they are sorted once you find a bigger one stop looking
1894 catch(exception& e) {
1895 errorOut(e, "MothurOut", "anyLabelsToProcess");
1900 /**************************************************************************************************/
1901 bool MothurOut::checkReleaseVersion(ifstream& file, string version) {
1906 string line = getline(file);
1908 //before we added this check
1909 if (line[0] != '#') { good = false; }
1912 line = line.substr(1);
1914 vector<string> versionVector;
1915 splitAtChar(version, versionVector, '.');
1917 //check file version
1918 vector<string> linesVector;
1919 splitAtChar(line, linesVector, '.');
1921 if (versionVector.size() != linesVector.size()) { good = false; }
1923 for (int j = 0; j < versionVector.size(); j++) {
1925 convert(versionVector[j], num1);
1926 convert(linesVector[j], num2);
1928 //if mothurs version is newer than this files version, then we want to remake it
1929 if (num1 > num2) { good = false; break; }
1935 if (!good) { file.close(); }
1936 else { file.seekg(0); }
1940 catch(exception& e) {
1941 errorOut(e, "MothurOut", "checkReleaseVersion");
1945 /**************************************************************************************************/
1946 bool MothurOut::isContainingOnlyDigits(string input) {
1949 //are you a digit in ascii code
1950 for (int i = 0;i < input.length(); i++){
1951 if( input[i]>47 && input[i]<58){}
1952 else { return false; }
1957 catch(exception& e) {
1958 errorOut(e, "MothurOut", "isContainingOnlyDigits");
1962 /**************************************************************************************************/