File: molFileFactory.C

package info (click to toggle)
ball 1.5.0%2Bgit20180813.37fc53c-6
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 239,888 kB
  • sloc: cpp: 326,149; ansic: 4,208; python: 2,303; yacc: 1,778; lex: 1,099; xml: 958; sh: 322; makefile: 95
file content (374 lines) | stat: -rw-r--r-- 10,639 bytes parent folder | download | duplicates (6)
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
#include <BALL/FORMAT/molFileFactory.h>

#include <BALL/FORMAT/genericMolFile.h>
#include <BALL/FORMAT/antechamberFile.h>
#include <BALL/FORMAT/PDBFile.h>
#include <BALL/FORMAT/HINFile.h>
#include <BALL/FORMAT/MOLFile.h>
#include <BALL/FORMAT/MOL2File.h>
#include <BALL/FORMAT/SDFile.h>
#include <BALL/FORMAT/XYZFile.h>
#include <BALL/FORMAT/dockResultFile.h>

#include <boost/iostreams/filtering_streambuf.hpp>
#include <boost/iostreams/filtering_stream.hpp>
#include <boost/iostreams/copy.hpp>
#include <boost/iostreams/filter/gzip.hpp>

#include <BALL/DATATYPE/string.h>

namespace BALL
{


  String MolFileFactory::getSupportedFormats()
  {
    String formats = "mol2,sdf,drf,pdb,ac,ent,brk,hin,mol,xyz,mol2.gz,sdf.gz,drf.gz,pdb.gz,ac.gz,ent.gz,brk.gz,hin.gz,mol.gz,xyz.gz";
    return formats;
  }

  bool MolFileFactory::isFileExtensionSupported(String filename)
  {
    vector<String> exts;
    String s = getSupportedFormats();
    s.split(exts,",");
    for (Size i=0; i<exts.size(); i++)
    {
      if (filename.hasSuffix(exts[i]))
      {
        return true;
      }
    }
    return false;
  }

  GenericMolFile* MolFileFactory::open(const String& name, File::OpenMode open_mode)
  {
    bool compression = false;
    String filename = name;

    if (name.hasSuffix(".gz"))
    {
      compression = true;
    }
    else if (open_mode == std::ios::in && !isFileExtensionSupported(filename)) // check whether file is zipped
    {
      std::ifstream zipped_file(filename.c_str(), std::ios_base::in | std::ios_base::binary);
      boost::iostreams::filtering_istream in;
      in.push(boost::iostreams::gzip_decompressor());
      in.push(zipped_file);
      bool ok = false;
      try
      {
        string s;
        ok = bool(std::getline(in,s));
      }
      catch (const boost::iostreams::gzip_error& e)
      {
        compression = false;
      }
      if (ok) compression = true;
    }

    if (compression)
    {
      compression = true;
      String unzipped_filename;
      if (name.hasSuffix(".gz"))
      {
        String tmp = name.before(".gz");
        String ext = tmp.substr(tmp.find_last_of("."));
        File::createTemporaryFilename(unzipped_filename, ext);
      }
      else // unknown extension
      {
        File::createTemporaryFilename(unzipped_filename);
      }

      if (open_mode == std::ios::in)
      {
        std::ifstream zipped_file(name.c_str(), std::ios_base::in | std::ios_base::binary);
        boost::iostreams::filtering_istream in;
        in.push(boost::iostreams::gzip_decompressor());
        in.push(zipped_file);
        std::ofstream unzipped_file(unzipped_filename.c_str());
        boost::iostreams::copy(in, unzipped_file);
      }

      filename = unzipped_filename;
    }
    
    GenericMolFile* gmf = 0;
    if (filename.hasSuffix(".ac") || filename.hasSuffix(".AC"))
    {
      gmf = new AntechamberFile(filename, open_mode);
    }
    else if(filename.hasSuffix(".pdb") || filename.hasSuffix(".ent") || filename.hasSuffix(".brk") ||
      filename.hasSuffix(".PDB") || filename.hasSuffix(".ENT") || filename.hasSuffix(".BRK"))
    {
      gmf = new PDBFile(filename, open_mode);
    }
    else if(filename.hasSuffix(".hin") || filename.hasSuffix(".HIN"))
    {
      gmf = new HINFile(filename, open_mode);
    }
    else if(filename.hasSuffix(".mol") || filename.hasSuffix(".MOL"))
    {
      gmf = new MOLFile(filename, open_mode);
    }
    else if(filename.hasSuffix(".sdf") || filename.hasSuffix(".SDF"))
    {
      gmf = new SDFile(filename, open_mode);
    }
    else if(filename.hasSuffix(".mol2") || filename.hasSuffix(".MOL2"))
    {
      gmf = new MOL2File(filename, open_mode);
    }
    else if(filename.hasSuffix(".xyz") || filename.hasSuffix(".XYZ"))
    {
      gmf = new XYZFile(filename, open_mode);
    }
    else if(filename.hasSuffix(".drf") || filename.hasSuffix(".DRF"))
    {
      gmf = new DockResultFile(filename, open_mode);
    }
    else
    {
      if (open_mode == std::ios::in)
      {
        gmf = detectFormat(filename);
        // Make sure that temporary input-file is deleted when GenericMolFile is closed.
        if (gmf && compression)
        {
          gmf->defineInputAsTemporary();
        }
        return gmf;
      }
      return NULL;
    }

    if (compression)
    {
      if (open_mode == std::ios::in)
      {
        // Make sure that temporary input-file is deleted when GenericMolFile is closed.
        gmf->defineInputAsTemporary();
      }
      else
      {
        // Make sure that temporary output-file is compressed and then deleted when GenericMolFile is closed.
        gmf->enableOutputCompression(name);
      }
    }
    
    return gmf;
  }

  GenericMolFile* MolFileFactory::open(const String& name, File::OpenMode open_mode, String default_format, bool forced)
  {
    //If we do not force the default format, we start as in others
    //else skip to avoid unnecessary computation
    if(!forced)
    {
      //try to read/write using filename with suffix (try recognise if necessary)
      GenericMolFile* file = open(name, open_mode);
      if (file)
      {
        return file;
      }
    }
    
    //if forced or if filetype could not be recognised by ending use default format
    GenericMolFile* file = 0;

    bool compression = false;
    String filename = name;
    String zipped_filename = "";

    
    if (default_format.hasSuffix(".gz"))
    {
      compression = true;
      zipped_filename = filename;
      default_format = default_format.before(".gz");
      String unzipped_filename;
      File::createTemporaryFilename(unzipped_filename, default_format);
      if (open_mode == std::ios::in)
        {
          std::ifstream zipped_file(zipped_filename.c_str(), std::ios_base::in | std::ios_base::binary);
          boost::iostreams::filtering_istream in;
          in.push(boost::iostreams::gzip_decompressor());
          in.push(zipped_file);
          std::ofstream unzipped_file(unzipped_filename.c_str());
          boost::iostreams::copy(in, unzipped_file);
        }
      filename = unzipped_filename;
    }


    if (default_format == "ac")
    {
      file = new AntechamberFile(filename, open_mode);
    }
    else if(default_format == "pdb" || default_format == "ent" || default_format == "brk")
    {
      file = new PDBFile(filename, open_mode);
    }
    else if(default_format == "hin")
    {
      file = new HINFile(filename, open_mode);
    }
    else if(default_format == "mol")
    {
      file = new MOLFile(filename, open_mode);
    }
    else if(default_format == "sdf")
    {
      file = new SDFile(filename, open_mode);
    }
    else if(default_format == "mol2")
    {
      file = new MOL2File(filename, open_mode);
    }
    else if(default_format == "xyz")
    {
      file = new XYZFile(filename, open_mode);
    }
    else if(default_format == "drf")
    {
      file = new DockResultFile(filename, open_mode);
    }


    if (compression)
    {
      if (open_mode == std::ios::in)
      {
        // Make sure that temporary input-file is deleted when GenericMolFile is closed.
        file->defineInputAsTemporary();
      }
      else
      {
        // Make sure that temporary output-file is compressed and then deleted when GenericMolFile is closed.
        file->enableOutputCompression(zipped_filename);
      }
    }

    return file;
    }
  

  GenericMolFile* MolFileFactory::open(const String& name, File::OpenMode open_mode, GenericMolFile* default_format_file)
  {
    GenericMolFile* file = open(name, open_mode);
    if (file)
    {
      return file;
    }

    if (open_mode == std::ios::out)
    {
      bool compression = false;
      String filename = name;
      String zipped_filename = "";
      if (default_format_file->isCompressedFile())
      {
        compression = true;
        zipped_filename = filename;
        String unzipped_filename;
        File::createTemporaryFilename(unzipped_filename);
        filename = unzipped_filename;
      }

      if (dynamic_cast<AntechamberFile*>(default_format_file))
      {
        file = new AntechamberFile(filename, open_mode);
      }
      else if(dynamic_cast<PDBFile*>(default_format_file))
      {
        file = new PDBFile(filename, open_mode);
      }
      else if(dynamic_cast<HINFile*>(default_format_file))
      {
        file = new HINFile(filename, open_mode);
      }
      else if(dynamic_cast<SDFile*>(default_format_file))
      {
        file = new SDFile(filename, open_mode);
      }
      else if(dynamic_cast<MOL2File*>(default_format_file))
      {
        file = new MOL2File(filename, open_mode);
      }
      else if(dynamic_cast<MOLFile*>(default_format_file))
      {
        file = new MOLFile(filename, open_mode);
      }
      else if(dynamic_cast<XYZFile*>(default_format_file))
      {
        file = new XYZFile(filename, open_mode);
      }
      else if(dynamic_cast<DockResultFile*>(default_format_file))
      {
        file = new DockResultFile(filename, open_mode);
      }
      // Make sure that temporary output-file is compressed and then deleted when GenericMolFile is closed.
      if (compression)
      {
        file->enableOutputCompression(zipped_filename);
      }
    }
    return file;
  }

  GenericMolFile* MolFileFactory::detectFormat(const String& name)
  {
    LineBasedFile input(name, std::ios::in);
    bool empty_file = true;

    // Read at most 400 lines.
    // If no format-indicator is found, return NULL
    for (Size no=1; no < 400 && input.readLine(); no++)
    {
      String& line = input.getLine();
      if (!line.trim().empty())
      {
        empty_file = false;
      }
      if (line.hasPrefix("@<TRIPOS>MOLECULE"))
      {
        input.close();
        return new MOL2File(name, std::ios::in);
      }
      else if (line.hasPrefix("$$$$") || line.hasPrefix("M  END"))
      {
        input.close();
        return new SDFile(name, std::ios::in);
      }
      else if (line.hasPrefix("<dockingfile>"))
      {
        input.close();
        return new DockResultFile(name, std::ios::in);
      }
      else if (line.hasPrefix("HEADER") || line.hasPrefix("ATOM") || line.hasPrefix("USER"))
      {
        input.close();
        return new PDBFile(name, std::ios::in);
      }
    }

    if (empty_file)
    {
      Log.error() << std::endl << "[Error:] Specified input file is empty!" << std::endl << std::endl;
    }
    else
    {
      Log.error() << std::endl << "[Error:] Specified input file has unknown extension and its format could not be detected automatically!" << std::endl << std::endl;
    }
    
    input.close();
    
    return NULL;
  }
}