Mise à jour terminée. Pour connaître les apports de la version 13.8.4 par rapport à notre ancienne version vous pouvez lire les "Release Notes" suivantes :
https://about.gitlab.com/releases/2021/02/11/security-release-gitlab-13-8-4-released/
https://about.gitlab.com/releases/2021/02/05/gitlab-13-8-3-released/

fasta.cpp 8.55 KB
Newer Older
Mikaël Salson's avatar
Mikaël Salson committed
1
/*
2 3 4 5 6 7 8
  This file is part of Vidjil <http://www.vidjil.org>
  Copyright (C) 2011, 2012, 2013, 2014, 2015 by Bonsai bioinformatics 
  at CRIStAL (UMR CNRS 9189, Université Lille) and Inria Lille
  Contributors: 
      Mathieu Giraud <mathieu.giraud@vidjil.org>
      Mikaël Salson <mikael.salson@vidjil.org>
      Marc Duez <marc.duez@vidjil.org>
Mikaël Salson's avatar
Mikaël Salson committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

  "Vidjil" 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.

  "Vidjil" 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 "Vidjil". If not, see <http://www.gnu.org/licenses/>
*/

#include <fstream>
#include <iostream>
#include <iomanip>
#include <algorithm>
#include <cctype>
#include <stdexcept>
#include "fasta.h"

32
#include "../lib/gzstream.h"
33

34 35 36 37 38 39 40 41

// http://stackoverflow.com/a/5840160/4475279
unsigned long long filesize(const char* filename)
{
    std::ifstream in(filename, std::ifstream::ate | std::ifstream::binary);
    return in.tellg();
}

42 43 44 45 46 47 48 49 50 51
void Fasta::init(int extract_field, string extract_separator)
{
  this -> extract_field = extract_field ;
  this -> extract_separator = extract_separator ; 
  total_size = 0;
}

Fasta::Fasta(int extract_field, string extract_separator)
{
  init(extract_field, extract_separator);
Mikaël Salson's avatar
Mikaël Salson committed
52 53 54
}

Fasta::Fasta(const string &input, 
55 56
	     int extract_field, string extract_separator,
             bool verbose) 
Mikaël Salson's avatar
Mikaël Salson committed
57
{
58 59
  init(extract_field, extract_separator);

60
  if (!input.size()) // Do not open empty filenames (D germline if not segmentD)
Mikaël Salson's avatar
Mikaël Salson committed
61 62
    return ;

63
  add(input, verbose);  
64 65
}

66
void Fasta::add(istream &in, bool verbose) {
67
  in >> *this;
68

69
  if (verbose)
70
  cout << "\t" << setw(6) << total_size << " bp in " << setw(3) << size() << " sequences" << endl ;
71 72
}

73
void Fasta::add(const string &filename, bool verbose) {
74
  igzstream is(filename.c_str());
Mikaël Salson's avatar
Mikaël Salson committed
75 76
  if (is.fail())
    {
77
      throw invalid_argument(" !! Error in opening file: "+ filename);
Mikaël Salson's avatar
Mikaël Salson committed
78
    }
79

80
  if (verbose)
81
  cout << " <== " << filename ;
82
  add(is, verbose);
Mikaël Salson's avatar
Mikaël Salson committed
83 84 85
  is.close();
}

86 87 88 89 90
void Fasta::add(Sequence seq) {
  reads.push_back(seq);
  total_size += seq.sequence.size();
}

Mikaël Salson's avatar
Mikaël Salson committed
91
int Fasta::size() const{ return (int)reads.size(); }
Mathieu Giraud's avatar
Mathieu Giraud committed
92 93 94 95 96 97 98 99 100
list<Sequence> Fasta::getAll() const {
  list<Sequence> reads;

  for (int i=0; i < size(); i++) {
    reads.push_back(read(i));
  }

  return reads;
}
Mikaël Salson's avatar
Mikaël Salson committed
101 102 103 104 105 106 107 108 109 110 111 112
const string& Fasta::label(int index) const{ return reads[index].label; }
const string& Fasta::label_full(int index) const{ return reads[index].label_full; }
const Sequence& Fasta::read(int index) const {return reads[index];}
const string& Fasta::sequence(int index) const{ return reads[index].sequence; }

// OnlineFasta

OnlineFasta::OnlineFasta(int extract_field, string extract_separator):
  input(NULL), extract_field(extract_field), extract_separator(extract_separator){}

OnlineFasta::OnlineFasta(const string &input, 
                         int extract_field, string extract_separator)
113
  :input(new igzstream(input.c_str())),
Mikaël Salson's avatar
Mikaël Salson committed
114 115 116 117
  extract_field(extract_field), 
  extract_separator(extract_separator)
{
  if (this->input->fail()) {
118
    delete this->input;
119
    throw invalid_argument("!! Error in opening file "+input);
Mikaël Salson's avatar
Mikaël Salson committed
120
  }
Mathieu Giraud's avatar
Mathieu Giraud committed
121 122

  cout << "  <== " << input << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
123 124 125 126 127 128
  input_allocated = true;
  init();
}

OnlineFasta::OnlineFasta(istream &input, 
                         int extract_field, string extract_separator)
129
  :input(&input), extract_field(extract_field),
Mikaël Salson's avatar
Mikaël Salson committed
130 131 132 133 134 135 136 137 138
  extract_separator(extract_separator)
{
  input_allocated = false;
  init();
}

OnlineFasta::~OnlineFasta() {
  if (input_allocated)
    delete input;
139 140
  if (current.seq)
    delete [] current.seq;
Mikaël Salson's avatar
Mikaël Salson committed
141 142 143
}

void OnlineFasta::init() {
144
  char_nb = 0;
Mikaël Salson's avatar
Mikaël Salson committed
145 146
  line_nb = 0;
  line = getInterestingLine();
147
  current.seq = NULL;
Mikaël Salson's avatar
Mikaël Salson committed
148 149
}

150 151 152 153
unsigned long long OnlineFasta::getPos() {
  return char_nb;
}

Mikaël Salson's avatar
Mikaël Salson committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
size_t OnlineFasta::getLineNb() {
  return line_nb;
}

Sequence OnlineFasta::getSequence() {
  return current;
}

bool OnlineFasta::hasNext() {
  return (! input->eof()) || line.length() > 0;
}

void OnlineFasta::next() {
  fasta_state state = FASTX_UNINIT;

  // Reinit the Sequence object
  current.label_full.erase();
  current.label.erase();
  current.sequence.erase();
  current.quality.erase();
174 175
  if (current.seq)
    delete [] current.seq;
Mikaël Salson's avatar
Mikaël Salson committed
176 177 178 179 180 181

  if  (hasNext()) {
    switch(line[0]) {
    case '>': state=FASTX_FASTA; break;
    case '@': state=FASTX_FASTQ_ID; break;
    default: 
182
      throw invalid_argument("The file seems to be malformed!");
Mikaël Salson's avatar
Mikaël Salson committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
    }
    
    // Identifier line
    current.label_full = line.substr(1);
    current.label = extract_from_label(current.label_full, extract_field, extract_separator);

    line = getInterestingLine();
    while (hasNext() && ((state != FASTX_FASTA || line[0] != '>')
                         && (state != FASTX_FASTQ_QUAL || line[0] != '@'))) {

      if (hasNext()) {
        switch(state) {
        case FASTX_FASTA: case FASTX_FASTQ_ID:
          // Sequence
          current.sequence += line;
          break;
        case FASTX_FASTQ_SEQ:
          // FASTQ separator between sequence and quality
201 202
          if (line[0] != '+')
            throw invalid_argument("Expected line starting with + in FASTQ file");
Mikaël Salson's avatar
Mikaël Salson committed
203 204 205 206
          break;
        case FASTX_FASTQ_SEP:
          // Reading quality
          current.quality = line;
207 208
          if (current.quality.length() != current.sequence.length())
            throw invalid_argument("Quality and sequence don't have the same length ");
Mikaël Salson's avatar
Mikaël Salson committed
209 210
          break;
        default:
211
          throw invalid_argument("Unexpected state after reading identifiers line");
Mikaël Salson's avatar
Mikaël Salson committed
212 213 214 215 216 217
        }
        if (state >= FASTX_FASTQ_ID && state <= FASTX_FASTQ_SEP)
          state = (fasta_state)(((int)state) + 1);
      } else {
        unexpectedEOF();
      }
218
      line = getInterestingLine(state);
Mikaël Salson's avatar
Mikaël Salson committed
219 220 221 222 223 224 225
    }

    if (state >= FASTX_FASTQ_ID && state < FASTX_FASTQ_QUAL) 
      unexpectedEOF();

    // Sequence in uppercase
    transform(current.sequence.begin(), current.sequence.end(), current.sequence.begin(), (int (*)(int))toupper);
226 227 228

    // Compute seq
    current.seq = new int[current.sequence.length()];
229
    for (unsigned int i=0; i< current.sequence.length(); i++)
230
      {
231
	current.seq[i] = nuc_to_int(current.sequence[i]) ;
232 233
      }

Mikaël Salson's avatar
Mikaël Salson committed
234 235 236 237
  } else
    unexpectedEOF();
}

238
string OnlineFasta::getInterestingLine(int state) {
Mikaël Salson's avatar
Mikaël Salson committed
239 240 241
  string line;
  while (line.length() == 0 && hasNext() && getline(*input, line)) {
    line_nb++;
242
    char_nb += line.length() + 1;
Mikaël Salson's avatar
Mikaël Salson committed
243
    remove_trailing_whitespaces(line);
244 245 246

    if (line.length() && line[0] == '#' && state != FASTX_FASTQ_SEP)
      line = "" ;
Mikaël Salson's avatar
Mikaël Salson committed
247 248 249 250 251
  }
  return line;
}

void OnlineFasta::unexpectedEOF() {
252
  throw invalid_argument("Unexpected EOF while reading FASTA/FASTQ file");
Mikaël Salson's avatar
Mikaël Salson committed
253 254 255 256 257 258 259 260 261 262 263
}

// Operators

istream& operator>>(istream& in, Fasta& fasta){
	string line;
	Sequence read;
        OnlineFasta of(in, fasta.extract_field, fasta.extract_separator);

        while (of.hasNext()) {
          of.next();
264
          fasta.add(of.getSequence());
Mikaël Salson's avatar
Mikaël Salson committed
265 266 267 268 269 270
        }
	return in;
}

ostream& operator<<(ostream& out, Fasta& fasta){
	for(int i = 0 ; i < fasta.size() ; i++){
271
          out << fasta.read(i);
Mikaël Salson's avatar
Mikaël Salson committed
272 273 274 275 276
	}
	return out;
}

ostream &operator<<(ostream &out, const Sequence &seq) {
277 278 279 280 281 282 283
  bool is_fastq=false;
  if (seq.quality.length() > 0) {
    is_fastq = true;
    out << "@";
  } else
    out << ">";
  out << seq.label << endl;
Mikaël Salson's avatar
Mikaël Salson committed
284
  out << seq.sequence << endl;
285 286 287
  if (is_fastq) {
    out << "+" << endl << seq.quality << endl;
  }
Mikaël Salson's avatar
Mikaël Salson committed
288 289
  return out;
}
290

291
int nb_sequences_in_fasta(string f, bool approx)
292
{
293 294 295
  if (approx)
    return approx_nb_sequences_in_fasta(f);

296 297 298 299 300 301 302 303 304 305
  OnlineFasta *sequences = new OnlineFasta(f, 1, " ");
  int nb_sequences = 0 ;

  while (sequences->hasNext())
    {
      sequences->next();
      nb_sequences++ ;
    }

  cout << "  ==> " << nb_sequences << " sequences" << endl;
306 307

  delete sequences ;
308 309
  return nb_sequences ;
}
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


#define SAMPLE_APPROX_NB_SEQUENCES 200

int approx_nb_sequences_in_fasta(string f)
{
  OnlineFasta *sequences = new OnlineFasta(f, 1, " ");
  int nb_sequences = 0 ;

  while (nb_sequences < SAMPLE_APPROX_NB_SEQUENCES && sequences->hasNext())
    {
      sequences->next();
      nb_sequences++ ;
    }

  cout << "  ==> " ;

  if (sequences->hasNext())
    {
      cout << "approx. " ;
      float ratio = (float) filesize(f.c_str()) / (float) sequences->getPos();
      nb_sequences = (int) (ratio * nb_sequences);
    }

  cout << nb_sequences << " sequences" << endl;

336
  delete sequences ;
337 338
  return nb_sequences ;
}