FileTypes.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// This software is released under a three-clause BSD license:
//  * 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 any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// 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 ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS 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.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Stephan Aiche, Andreas Bertsch, Marc Sturm, Chris Bielow $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/config.h>
#include <OpenMS/DATASTRUCTURES/String.h>

#include <vector>

namespace OpenMS
{
  struct OPENMS_DLLAPI FileTypes
  {

    enum Type
    {
      UNKNOWN,            
      DTA,                
      DTA2D,              
      MZDATA,             
      MZXML,              
      FEATUREXML,         
      IDXML,              
      CONSENSUSXML,       
      MGF,                
      INI,                
      TOPPAS,             
      TRANSFORMATIONXML,  
      MZML,               
      CACHEDMZML,         
      MS2,                
      PEPXML,             
      PROTXML,            
      MZIDENTML,          
      MZQUANTML,          
      QCML,               
      MZQC,               
      GELML,              
      TRAML,              
      MSP,                
      OMSSAXML,           
      MASCOTXML,          
      PNG,                
      XMASS,              
      TSV,                
      MZTAB,              
      PEPLIST,            
      HARDKLOER,          
      KROENIK,            
      FASTA,              
      EDTA,               
      CSV,                
      TXT,                
      OBO,                
      HTML,               
      ANALYSISXML,        
      XSD,                
      PSQ,                
      MRM,                
      SQMASS,             
      PQP,                
      MS,                 
      OSW,                
      PSMS,               
      PIN,                
      PARAMXML,           
      SPLIB,              
      NOVOR,              
      XQUESTXML,          
      SPECXML,            
      JSON,               
      RAW,                
      OMS,                
      EXE,                
      XML,                
      BZ2,                
      GZ,                 
      SIZE_OF_TYPE        
    };

    static String typeToName(Type type);
    
    static String typeToDescription(Type type);
    
    static Type nameToType(const String& name);

    static String typeToMZML(Type type);
  };

 enum class FilterLayout
  {
    COMPACT,    
    ONE_BY_ONE, 
    BOTH        
  };
  class OPENMS_DLLAPI FileTypeList
  {
  public:
    FileTypeList(const std::vector<FileTypes::Type>& types);

    bool contains(const FileTypes::Type& type) const;

    const std::vector<FileTypes::Type>& getTypes() const
    {
      return type_list_;
    }

    String toFileDialogFilter(const FilterLayout style, bool add_all_filter) const;

    FileTypes::Type fromFileDialogFilter(const String& filter, const FileTypes::Type fallback = FileTypes::Type::UNKNOWN) const;

  private:
    struct FilterElements_
    {
      std::vector<String> items;
      std::vector<FileTypes::Type> types;
    };
    FilterElements_ asFilterElements_(const FilterLayout style, bool add_all_filter) const;

    std::vector<FileTypes::Type> type_list_;
  };

} // namespace OpenMS