]> git.donarmstrong.com Git - mothur.git/blobdiff - mothur.h
added MPI code, broke up chimera.seqs into 5 separated commands, added parse.sff...
[mothur.git] / mothur.h
index 8065dd4cc74284f11dbca4808eb2c8893a74b7c8..dcb026c310ef7052116bb61f5b3517e24ae1e39e 100644 (file)
--- a/mothur.h
+++ b/mothur.h
@@ -47,6 +47,9 @@
 #include <ctime>
 #include <limits>
 
+#ifdef USE_MPI
+       #include "mpi.h"
+#endif
 /***********************************************************************/
 
 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
@@ -58,8 +61,6 @@
                #include <readline/history.h>
        #endif
 
-       //#include <readline/readline.h>
-       //#include <readline/history.h>
 #else
        #include <conio.h> //allows unbuffered screen capture from stdin
        #include <direct.h> //get cwd
@@ -193,12 +194,11 @@ string toString(const T&x, int i){
     return output.str();
 }
 /***********************************************************************/
-
 inline int openOutputFileAppend(string fileName, ofstream& fileHandle){
        
        fileHandle.open(fileName.c_str(), ios::app);
        if(!fileHandle) {
-               cout << "Error: Could not open " <<  fileName << endl; 
+               cout << "Error: Could not open " << fileName << endl;
                return 1;
        }
        else {
@@ -240,74 +240,6 @@ inline string getline(ifstream& fileHandle) {
        }
 }
 
-/**************************************************************************************************/
-
-inline void mothurOut(string message) {
-       try{
-               ofstream out;
-               string logFileName = "mothur.logFile";
-               openOutputFileAppend(logFileName, out);
-               
-               cout << message;
-               out << message;
-               
-               out.close();
-       }
-       catch(exception& e) {
-               cout << "Error in mothur class mothurOut" << endl;
-               exit(1);
-       }
-}
-/**************************************************************************************************/
-
-inline void mothurOut(string message, string precision) {
-       try{
-               ofstream out;
-               string logFileName = "mothur.logFile";
-               openOutputFileAppend(logFileName, out);
-               
-               cout << precision << message;
-               out << precision << message;
-               
-               out.close();
-       }
-       catch(exception& e) {
-               cout << "Error in mothur class mothurOut" << endl;
-               exit(1);
-       }
-}
-
-/**************************************************************************************************/
-
-inline void mothurOutEndLine() {
-       try {
-               ofstream out;
-               string logFileName = "mothur.logFile";
-               openOutputFileAppend(logFileName, out);
-               
-               cout << endl;  
-               out << endl;
-               
-               out.close();
-       }
-       catch(exception& e) {
-               cout << "error in mothur mothurOutEndLine" << endl;
-               exit(1);
-       }
-}
-
-
-/**************************************************************************************************/
-
-inline void errorOut(exception& e, string object, string function) {
-       
-               mothurOut("Error: ");
-               mothurOut(toString(e.what()));
-               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.");
-               mothurOutEndLine();
-       
-}
-
 /***********************************************************************/
 
 inline bool isTrue(string f){
@@ -433,8 +365,8 @@ inline string getPathName(string longName){
  
        string rootPathName = longName;
        
-       if(longName.find_last_of('/') != longName.npos){
-               int pos = longName.find_last_of('/')+1;
+       if(longName.find_last_of("/\\") != longName.npos){
+               int pos = longName.find_last_of("/\\")+1;
                rootPathName = longName.substr(0, pos);
        }
        
@@ -475,7 +407,7 @@ inline bool isBlank(string fileName){
        ifstream fileHandle;
        fileHandle.open(fileName.c_str());
        if(!fileHandle) {
-               mothurOut("Error: Could not open " + fileName);  mothurOutEndLine();
+               cout << "Error: Could not open " << fileName << endl;
                return false;
        }else {
                //check for blank file
@@ -487,6 +419,7 @@ inline bool isBlank(string fileName){
 /***********************************************************************/
 
 inline string getFullPathName(string fileName){
+       try{
        
        string path = hasPath(fileName);
        string newFileName;
@@ -503,11 +436,13 @@ inline string getFullPathName(string fileName){
                        if (path.rfind("./") == -1) { return fileName; } //already complete name
                        else { newFileName = fileName.substr(fileName.rfind("./")+2); } //save the complete part of the name
                        
-                       char* cwdpath;
+                       char* cwdpath = new char[1024];
+
                        size_t size;
                        cwdpath=getcwd(cwdpath,size);
-                       cwd = cwdpath;
                
+                       cwd = cwdpath;
+                       
                        //rip off first '/'
                        string simpleCWD;
                        if (cwd.length() > 0) { simpleCWD = cwd.substr(1); }
@@ -521,9 +456,10 @@ inline string getFullPathName(string fileName){
                        }
                        //get last one              // ex. ../../../filename = /user/work/desktop/filename
                        dirs.push_back(simpleCWD);  //ex. dirs[0] = user, dirs[1] = work, dirs[2] = desktop
-                               
+                       
+               
                        int index = dirs.size()-1;
-                               
+               
                        while((pos = path.rfind("./")) != -1) { //while you don't have a complete path
                                if (path[(pos-1)] == '.') { //you want your parent directory ../
                                        path = path.substr(0, pos-1);
@@ -532,7 +468,7 @@ inline string getFullPathName(string fileName){
                                }else if (path[(pos-1)] == '/') { //you want the current working dir ./
                                        path = path.substr(0, pos);
                                }else if (pos == 1) { break; 
-                               }else {  mothurOut("cannot resolve path for " + fileName); mothurOutEndLine(); return fileName; }
+                               }else { cout << "cannot resolve path for " <<  fileName << endl; return fileName; }
                        }
                
                        for (int i = index; i >= 0; i--) {
@@ -572,7 +508,7 @@ inline string getFullPathName(string fileName){
                                }else if (path[(pos-1)] == '\\') { //you want the current working dir ./
                                        path = path.substr(0, pos);
                                }else if (pos == 1) { break; 
-                               }else {  mothurOut("cannot resolve path for " + fileName); mothurOutEndLine(); return fileName; }
+                               }else {  cout << "cannot resolve path for " <<  fileName << endl;  return fileName; }
                        }
                
                        for (int i = index; i >= 0; i--) {
@@ -583,7 +519,11 @@ inline string getFullPathName(string fileName){
                        
                #endif
        }
-       
+       }
+       catch(exception& e) {
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function getFullPathName. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
+               exit(1);
+       }       
 }
 /***********************************************************************/
 
@@ -591,50 +531,69 @@ inline int openInputFile(string fileName, ifstream& fileHandle, string m){
        
        //get full path name
        string completeFileName = getFullPathName(fileName);
-       //string completeFileName = fileName;
 
        fileHandle.open(completeFileName.c_str());
        if(!fileHandle) {
-               mothurOut("Error: Could not open " + completeFileName);  mothurOutEndLine();
                return 1;
-       }
-       else {
+       }else {
                //check for blank file
                gobble(fileHandle);
                return 0;
-       }
-       
+       }       
 }
 /***********************************************************************/
 
 inline int openInputFile(string fileName, ifstream& fileHandle){
+       
        //get full path name
        string completeFileName = getFullPathName(fileName);
-       
+
        fileHandle.open(completeFileName.c_str());
        if(!fileHandle) {
-               mothurOut("Error: Could not open " + completeFileName);  mothurOutEndLine();
+               cout << "Error: Could not open " << completeFileName << endl;
                return 1;
        }
        else {
                //check for blank file
                gobble(fileHandle);
-               if (fileHandle.eof()) { mothurOut(completeFileName + " is blank. Please correct."); mothurOutEndLine();  return 1;  }
+               if (fileHandle.eof()) { cout << completeFileName << " is blank. Please correct." << endl;  return 1;  }
                
                return 0;
        }
        
 }
+/***********************************************************************/
+
+inline int renameFile(string oldName, string newName){
+       
+       ifstream inTest;
+       int exist = openInputFile(newName, inTest, "");
+       
+#if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)          
+       if (exist == 0) { //you could open it so you want to delete it
+               inTest.close();
+               string command = "rm " + newName;
+               system(command.c_str());
+       }
+                       
+       string command = "mv " + oldName + " " + newName;
+       system(command.c_str());
+#else
+       remove(newName.c_str());
+       int renameOk = rename(oldName.c_str(), newName.c_str());
+#endif
+       return 0;
+}
 
 /***********************************************************************/
 
 inline int openOutputFile(string fileName, ofstream& fileHandle){
-
+       
        string completeFileName = getFullPathName(fileName);
        
        fileHandle.open(completeFileName.c_str(), ios::trunc);
        if(!fileHandle) {
-               mothurOut("Error: Could not open " + completeFileName);  mothurOutEndLine();
+               cout << "Error: Could not open " << completeFileName << endl;
                return 1;
        }
        else {
@@ -680,9 +639,9 @@ inline void splitAtDash(string& estim, vector<string>& container) {
                container.push_back(estim);
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "splitAtDash");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function splitAtDash. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
 
 /***********************************************************************/
@@ -702,9 +661,9 @@ inline void splitAtDash(string& estim, set<string>& container) {
                container.insert(estim);
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "splitAtDash");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function splitAtDash. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
 /***********************************************************************/
 //This function parses the line options and puts them in a set
@@ -726,9 +685,9 @@ inline void splitAtDash(string& estim, set<int>& container) {
                container.insert(lineNum);
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "splitAtDash");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function splitAtDash. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
 /***********************************************************************/
 //This function parses the a string and puts peices in a vector
@@ -747,9 +706,9 @@ inline void splitAtComma(string& estim, vector<string>& container) {
                container.push_back(estim);
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "splitAtComma");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function splitAtComma. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
 /***********************************************************************/
 
@@ -766,9 +725,9 @@ inline void splitAtComma(string& prefix, string& suffix){
 
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "splitAtComma");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function splitAtComma. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
 /***********************************************************************/
 
@@ -786,9 +745,9 @@ inline void splitAtEquals(string& key, string& value){
                }
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "splitAtEquals");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function splitAtEquals. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
 /**************************************************************************************************/
 
@@ -800,72 +759,32 @@ inline bool inUsersGroups(string groupname, vector<string> Groups) {
                return false;
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "inUsersGroups");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function inUsersGroups. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
-
 /**************************************************************************************************/
-
-inline void mothurOutJustToLog(string message) {
-       try {
-               ofstream out;
-               string logFileName = "mothur.logFile";
-               openOutputFileAppend(logFileName, out);
-               
-               out << message;
-               
-               out.close();
-       }
-       catch(exception& e) {
-               errorOut(e, "mothur", "mothurOutJustToLog");
-               exit(1);
-       }
-}
-
-
-/**************************************************************************************************/
-
-inline void mothurOut(float num) {
-       try {
-               ofstream out;
-               string logFileName = "mothur.logFile";
-               openOutputFileAppend(logFileName, out);
-               
-               cout << num;  
-               out << num;
-               
-               out.close();
-       }
-       catch(exception& e) {
-               cout << "Error in mothur class mothurOut float" << endl;
-               exit(1);
-       }
-}
-/***********************************************************************/
-inline void mothurOut(double value) {
+//returns true if any of the strings in first vector are in second vector
+inline bool inUsersGroups(vector<string> groupnames, vector<string> Groups) {
        try {
-               ofstream out;
-               string logFileName = "mothur.logFile";
-               openOutputFileAppend(logFileName, out);
                
-               cout << value;  
-               out << value;
-               
-               out.close();
+               for (int i = 0; i < groupnames.size(); i++) {
+                       if (inUsersGroups(groupnames[i], Groups)) { return true; }
+               }
+               return false;
        }
        catch(exception& e) {
-               cout << "Error in mothur class mothurOut double" << endl;
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function inUsersGroups. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
-
 /***********************************************************************/
 //this function determines if the user has given us labels that are smaller than the given label.
 //if so then it returns true so that the calling function can run the previous valid distance.
 //it's a "smart" distance function.  It also checks for invalid labels.
 inline bool anyLabelsToProcess(string label, set<string>& userLabels, string errorOff) {
        try {
+               
                set<string>::iterator it;
                vector<float> orderFloat;
                map<string, float> userMap;  //the conversion process removes trailing 0's which we need to put back
@@ -889,7 +808,7 @@ inline bool anyLabelsToProcess(string label, set<string>& userLabels, string err
                                orderFloat.push_back(-1.0);
                                userMap["unique"] = -1.0;
                        }else {
-                               if (errorOff == "") {  mothurOut(*it + " is not a valid label."); mothurOutEndLine();  }
+                               if (errorOff == "") {  cout << *it << " is not a valid label." << endl;  }
                                userLabels.erase(*it); 
                                it--;
                        }
@@ -907,11 +826,11 @@ inline bool anyLabelsToProcess(string label, set<string>& userLabels, string err
                        if (orderFloat[i] < labelFloat) {
                                smaller = true;
                                if (orderFloat[i] == -1) { 
-                                       if (errorOff == "") { mothurOut("Your file does not include the label unique."); mothurOutEndLine(); }
+                                       if (errorOff == "") { cout << "Your file does not include the label unique." << endl; }
                                        userLabels.erase("unique");
                                }
                                else {  
-                                       if (errorOff == "") { mothurOut("Your file does not include the label "); mothurOutEndLine(); }
+                                       if (errorOff == "") { cout << "Your file does not include the label " << endl; }
                                        string s = "";
                                        for (it2 = userMap.begin(); it2!= userMap.end(); it2++) {  
                                                if (it2->second == orderFloat[i]) {  
@@ -921,7 +840,7 @@ inline bool anyLabelsToProcess(string label, set<string>& userLabels, string err
                                                        break;
                                                }
                                        }
-                                       if (errorOff == "") { mothurOut(s + ". I will use the next smallest distance. "); mothurOutEndLine(); }
+                                       if (errorOff == "") {cout << s <<  ". I will use the next smallest distance. " << endl; }
                                }
                        //since they are sorted once you find a bigger one stop looking
                        }else { break; }
@@ -931,9 +850,9 @@ inline bool anyLabelsToProcess(string label, set<string>& userLabels, string err
                                                
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "anyLabelsToProcess");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function anyLabelsToProcess. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
 
 /**************************************************************************************************/
@@ -955,9 +874,9 @@ inline void appendFiles(string temp, string filename) {
                output.close();
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "appendFiles");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function appendFiles. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
 }
 
 /**************************************************************************************************/
@@ -1018,10 +937,82 @@ inline string sortFile(string distFile){
                return outfile;
        }
        catch(exception& e) {
-               errorOut(e, "mothur", "sortFile");
+               cout << "Standard Error: " << e.what() << " has occurred in the mothur.h function sortfile. Please contact Pat Schloss at mothur.bugs@gmail.com." << "\n";
                exit(1);
-       }
+       }       
+}
+/**************************************************************************************************/
+inline vector<long> setFilePosFasta(string filename, int& num) {
+
+                       vector<long> positions;
+                       ifstream inFASTA;
+                       openInputFile(filename, inFASTA);
+                               
+                       string input;
+                       while(!inFASTA.eof()){
+                               input = getline(inFASTA); gobble(inFASTA);
+                               if (input.length() != 0) {
+                                       if(input[0] == '>'){    long pos = inFASTA.tellg(); positions.push_back(pos - input.length() - 1);      }
+                               }
+                       }
+                       inFASTA.close();
+               
+                       num = positions.size();
+               
+                       FILE * pFile;
+                       long size;
+               
+                       //get num bytes in file
+                       pFile = fopen (filename.c_str(),"rb");
+                       if (pFile==NULL) perror ("Error opening file");
+                       else{
+                               fseek (pFile, 0, SEEK_END);
+                               size=ftell (pFile);
+                               fclose (pFile);
+                       }
+               
+                       positions.push_back(size);
+               
+                       return positions;
 }
+/**************************************************************************************************/
+inline vector<long> setFilePosEachLine(string filename, int& num) {
+
+                       vector<long> positions;
+                       ifstream in;
+                       openInputFile(filename, in);
+                               
+                       string input;
+                       while(!in.eof()){
+                               long lastpos = in.tellg();
+                               input = getline(in); gobble(in);
+                               if (input.length() != 0) {
+                                       long pos = in.tellg(); 
+                                       if (pos != -1) { positions.push_back(pos - input.length() - 1); }
+                                       else {  positions.push_back(lastpos);  }
+                               }
+                       }
+                       in.close();
+               
+                       num = positions.size();
+               
+                       FILE * pFile;
+                       long size;
+               
+                       //get num bytes in file
+                       pFile = fopen (filename.c_str(),"rb");
+                       if (pFile==NULL) perror ("Error opening file");
+                       else{
+                               fseek (pFile, 0, SEEK_END);
+                               size=ftell (pFile);
+                               fclose (pFile);
+                       }
+               
+                       positions.push_back(size);
+               
+                       return positions;
+}
+
 /**************************************************************************************************/
 #endif