ProFormaError.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
namespace OpenMS
{
 
  enum class ProFormaErrorCode
  {
    UNEXPECTED_CHARACTER,       
    UNCLOSED_BRACKET,           
    UNMATCHED_BRACKET,          
    INVALID_CV_PREFIX,          
    INVALID_CV_ACCESSION,       
    INVALID_AMINO_ACID,         
    INVALID_MASS_VALUE,         
    INVALID_FORMULA,            
    UNKNOWN_MONOSACCHARIDE,     
    DANGLING_CROSSLINK_LABEL,   
    EMPTY_SEQUENCE,             
    INVALID_CHARGE,             
    INVALID_OCCURRENCE_SPECIFIER, 
    UNEXPECTED_END_OF_INPUT,    
    INTERNAL_ERROR              
  };
 
  OPENMS_DLLAPI const char* proFormaErrorCodeToString(ProFormaErrorCode code);
 
  class OPENMS_DLLAPI ProFormaParseError :
    public Exception::ParseError
  {
  public:
    ProFormaParseError(
      const char* file,
      int line,
      const char* function,
      ProFormaErrorCode error_code,
      size_t error_position,
      const String& input,
      const String& message
    ) noexcept;
 
    ProFormaErrorCode getErrorCode() const noexcept
    {
      return code_;
    }
 
    size_t getPosition() const noexcept
    {
      return position_;
    }
 
    const String& getContextBefore() const noexcept
    {
      return context_before_;
    }
 
    const String& getContextAfter() const noexcept
    {
      return context_after_;
    }
 
    const String& getExpected() const noexcept
    {
      return expected_;
    }
 
    const String& getFound() const noexcept
    {
      return found_;
    }
 
    String getFormattedMessage() const;
 
    void setExpectedFound(const String& expected, const String& found);
 
  private:
    ProFormaErrorCode code_;      
    size_t position_;             
    String context_before_;       
    String context_after_;        
    String expected_;             
    String found_;                
 
    void extractContext_(const String& input, size_t pos);
  };
 
} // namespace OpenMS