File: DaylightParser.cpp

package info (click to toggle)
rdkit 202209.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 203,880 kB
  • sloc: cpp: 334,239; python: 80,247; ansic: 24,579; java: 7,667; sql: 2,123; yacc: 1,884; javascript: 1,358; lex: 1,260; makefile: 576; xml: 229; fortran: 183; cs: 181; sh: 101
file content (312 lines) | stat: -rw-r--r-- 10,880 bytes parent folder | download
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
//
//  Copyright (c) 2007-2021, Novartis Institutes for BioMedical Research Inc.
//  and other RDKit contributors
//  All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Novartis Institutes for BioMedical Research Inc.
//       nor the names of its contributors may be used to endorse or promote
//       products derived from this software without specific prior written
//       permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//

#include <GraphMol/ChemReactions/Reaction.h>
#include <GraphMol/ChemReactions/ReactionParser.h>
#include <GraphMol/SmilesParse/SmilesParse.h>
#include <GraphMol/SmilesParse/SmilesParseOps.h>
#include <boost/range/iterator_range.hpp>

#include <boost/algorithm/string.hpp>
#include <vector>
#include <string>
#include "ReactionUtils.h"

namespace RDKit {
namespace DaylightParserUtils {
std::vector<std::string> splitSmartsIntoComponents(
    const std::string &reactText) {
  std::vector<std::string> res;
  unsigned int pos = 0;
  unsigned int blockStart = 0;
  unsigned int level = 0;
  unsigned int inBlock = 0;
  while (pos < reactText.size()) {
    if (reactText[pos] == '(') {
      if (pos == blockStart) {
        inBlock = 1;
      }
      ++level;
    } else if (reactText[pos] == ')') {
      if (level == 1 && inBlock) {
        // this closes a block
        inBlock = 2;
      }
      --level;
    } else if (level == 0 && reactText[pos] == '.') {
      if (inBlock == 2) {
        std::string element =
            reactText.substr(blockStart + 1, pos - blockStart - 2);
        res.push_back(element);
      } else {
        std::string element = reactText.substr(blockStart, pos - blockStart);
        res.push_back(element);
      }
      blockStart = pos + 1;
      inBlock = 0;
    }
    ++pos;
  }
  if (blockStart < pos) {
    if (inBlock == 2) {
      std::string element =
          reactText.substr(blockStart + 1, pos - blockStart - 2);
      res.push_back(element);
    } else {
      std::string element = reactText.substr(blockStart, pos - blockStart);
      res.push_back(element);
    }
  }
  return res;
}

ROMol *constructMolFromString(const std::string &txt,
                              std::map<std::string, std::string> *replacements,
                              bool useSmiles) {
  ROMol *mol;
  if (!useSmiles) {
    SmartsParserParams ps;
    ps.replacements = replacements;
    ps.allowCXSMILES = false;
    ps.parseName = false;
    ps.mergeHs = false;
    ps.skipCleanup = true;
    mol = SmartsToMol(txt, ps);
  } else {
    SmilesParserParams ps;
    ps.replacements = replacements;
    ps.allowCXSMILES = false;
    ps.parseName = false;
    ps.sanitize = false;
    ps.removeHs = false;
    ps.skipCleanup = true;
    mol = SmilesToMol(txt, ps);
  }
  return mol;
}

}  // end of namespace DaylightParserUtils

namespace {
void removeSpacesAround(std::string &text, size_t pos) {
  auto nextp = pos + 1;
  while (nextp < text.size() && (text[nextp] == ' ' || text[nextp] == '\t')) {
    text.erase(nextp, 1);
  }
  if (pos > 0) {
    nextp = pos - 1;
    while (text[nextp] == ' ' || text[nextp] == '\t') {
      text.erase(nextp, 1);
      if (nextp > 0) {
        --nextp;
      } else {
        break;
      }
    }
  }
}
}  // namespace
ChemicalReaction *RxnSmartsToChemicalReaction(
    const std::string &origText,
    std::map<std::string, std::string> *replacements, bool useSmiles,
    bool allowCXSMILES) {
  std::string text = origText;
  std::string cxPart;
  if (allowCXSMILES) {
    auto sidx = origText.find_first_of("|");
    if (sidx != std::string::npos && sidx != 0) {
      text = origText.substr(0, sidx);
      cxPart = boost::trim_copy(origText.substr(sidx, origText.size() - sidx));
    }
  }
  // remove any spaces at the beginning, end, or before the '>'s
  boost::trim(text);
  std::vector<std::size_t> pos;
  for (std::size_t i = 0; i < text.length(); ++i) {
    if (text[i] == '>' && (i == 0 || text[i - 1] != '-')) {
      pos.push_back(i);
    }
  }
  if (pos.size() < 2) {
    throw ChemicalReactionParserException(
        "a reaction requires at least two > characters");
  }

  // remove spaces around ">" symbols
  for (auto p : boost::make_iterator_range(pos.rbegin(), pos.rend())) {
    removeSpacesAround(text, p);
  }

  // remove spaces around "." symbols
  pos.clear();
  for (std::size_t i = 0; i < text.length(); ++i) {
    if (text[i] == '.') {
      pos.push_back(i);
    }
  }
  for (auto p : boost::make_iterator_range(pos.rbegin(), pos.rend())) {
    removeSpacesAround(text, p);
  }

  // we shouldn't have whitespace left in the reaction string, so go ahead and
  // split and strip:
  auto sidx = text.find_first_of(" \t");
  if (sidx != std::string::npos && sidx != 0) {
    text = text.substr(0, sidx);
  }

  // re-find the '>' characters so that we can split on them
  pos.clear();
  for (std::size_t i = 0; i < text.length(); ++i) {
    if (text[i] == '>' && (i == 0 || text[i - 1] != '-')) {
      pos.push_back(i);
    }
  }

  // there's always the chance that one or more of the ">" was in the name
  // part, so verify that we have exactly two:
  if (pos.size() < 2) {
    throw ChemicalReactionParserException(
        "a reaction requires at least two > characters");
  }
  if (pos.size() > 2) {
    throw ChemicalReactionParserException("multi-step reactions not supported");
  }

  auto pos1 = pos[0];
  auto pos2 = pos[1];

  auto reactText = text.substr(0, pos1);
  std::string agentText;
  if (pos2 != pos1 + 1) {
    agentText = text.substr(pos1 + 1, (pos2 - pos1) - 1);
  }
  auto productText = text.substr(pos2 + 1);

  // recognize changes within the same molecules, e.g., intra molecular bond
  // formation therefore we need to correctly interpret parenthesis and dots
  // in the reaction smarts
  auto reactSmarts = DaylightParserUtils::splitSmartsIntoComponents(reactText);
  auto productSmarts =
      DaylightParserUtils::splitSmartsIntoComponents(productText);

  auto *rxn = new ChemicalReaction();

  for (const auto &txt : reactSmarts) {
    auto mol = DaylightParserUtils::constructMolFromString(txt, replacements,
                                                           useSmiles);
    if (!mol) {
      std::string errMsg = "Problems constructing reactant from SMARTS: ";
      errMsg += txt;
      delete rxn;
      throw ChemicalReactionParserException(errMsg);
    }
    rxn->addReactantTemplate(ROMOL_SPTR(mol));
  }

  for (const auto &txt : productSmarts) {
    auto mol = DaylightParserUtils::constructMolFromString(txt, replacements,
                                                           useSmiles);
    if (!mol) {
      std::string errMsg = "Problems constructing product from SMARTS: ";
      errMsg += txt;
      delete rxn;
      throw ChemicalReactionParserException(errMsg);
    }
    rxn->addProductTemplate(ROMOL_SPTR(mol));
  }
  updateProductsStereochem(rxn);

  // allow a reaction template to have no agent specified
  if (agentText.size() != 0) {
    auto agentMol = DaylightParserUtils::constructMolFromString(
        agentText, replacements, useSmiles);
    if (!agentMol) {
      std::string errMsg = "Problems constructing agent from SMARTS: ";
      errMsg += agentText;
      delete rxn;
      throw ChemicalReactionParserException(errMsg);
    }
    std::vector<ROMOL_SPTR> agents = MolOps::getMolFrags(*agentMol, false);
    delete agentMol;
    for (auto &agent : agents) {
      rxn->addAgentTemplate(agent);
    }
  }

  if (allowCXSMILES && !cxPart.empty()) {
    unsigned int startAtomIdx = 0;
    unsigned int startBondIdx = 0;
    for (auto &mol : boost::make_iterator_range(rxn->beginReactantTemplates(),
                                                rxn->endReactantTemplates())) {
      SmilesParseOps::parseCXExtensions(*static_cast<RWMol *>(mol.get()),
                                        cxPart, startAtomIdx, startBondIdx);
      startAtomIdx += mol->getNumAtoms();
      startBondIdx += mol->getNumBonds();
    }
    for (auto &mol : boost::make_iterator_range(rxn->beginAgentTemplates(),
                                                rxn->endAgentTemplates())) {
      SmilesParseOps::parseCXExtensions(*static_cast<RWMol *>(mol.get()),
                                        cxPart, startAtomIdx, startBondIdx);
      startAtomIdx += mol->getNumAtoms();
      startBondIdx += mol->getNumBonds();
    }
    for (auto &mol : boost::make_iterator_range(rxn->beginProductTemplates(),
                                                rxn->endProductTemplates())) {
      SmilesParseOps::parseCXExtensions(*static_cast<RWMol *>(mol.get()),
                                        cxPart, startAtomIdx, startBondIdx);
      startAtomIdx += mol->getNumAtoms();
      startBondIdx += mol->getNumBonds();
    }
  }

  // final cleanups:
  for (auto &mol : boost::make_iterator_range(rxn->beginReactantTemplates(),
                                              rxn->endReactantTemplates())) {
    SmilesParseOps::CleanupAfterParsing(static_cast<RWMol *>(mol.get()));
  }
  for (auto &mol : boost::make_iterator_range(rxn->beginAgentTemplates(),
                                              rxn->endAgentTemplates())) {
    SmilesParseOps::CleanupAfterParsing(static_cast<RWMol *>(mol.get()));
  }
  for (auto &mol : boost::make_iterator_range(rxn->beginProductTemplates(),
                                              rxn->endProductTemplates())) {
    SmilesParseOps::CleanupAfterParsing(static_cast<RWMol *>(mol.get()));
  }

  // "SMARTS"-based reactions have implicit properties
  rxn->setImplicitPropertiesFlag(true);

  return rxn;
}
}  // namespace RDKit