File indexing completed on 2024-05-19 04:56:11

 /**
  * \file framenotice.h
  * Warning about tag frame.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 19 May 2017
  *
  * Copyright (C) 2017-2018  Urs Fleisch
  *
  * This file is part of Kid3.
  *
  * Kid3 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 2 of the License, or
  * (at your option) any later version.
  *
  * Kid3 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 this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #pragma once
 
 #include <QObject>
 #include "kid3api.h"
 
 class Frame;
 class FrameCollection;
 
 /**
  * Notice about a frame in a tag.
  */
 class KID3_CORE_EXPORT FrameNotice {
   Q_GADGET
   Q_ENUMS(Warning)
 public:
   /** Warning type. */
   enum Warning {
     None,         /**< No warning */
     Truncated,    /**< Truncated */
     TooLarge,     /**< Size is too large */
     Unique,       /**< Must be unique */
     NlForbidden,  /**< New line is forbidden */
     CrForbidden,  /**< Carriage return is forbidden */
     OwnerEmpty,   /**< Owner must be non-empty */
     Numeric,      /**< Must be numeric */
     NrTotal,      /**< Must be numeric or number/total */
     DayMonth,     /**< Format is DDMM */
     HourMinute,   /**< Format is HHMM */
     Year,         /**< Format is YYYY */
     YearSpace,    /**< Must begin with a year and a space character */
     IsoDate,      /**< Must be ISO 8601 date/time */
     MusicalKey,   /**< Must be musical key, 3 characters, A-G, b, #, m, o */
     LanguageCode, /**< Must be ISO 639-2 language code, 3 lowercase characters */
     IsrcCode,     /**< Must be ISRC code, 12 characters */
     StringList,   /**< Must be list of strings */
     ExcessSpace,  /**< Has excess white space */
     NumWarnings
   };
 
   /**
    * Constructor.
    * @param warning warning type
    */
   FrameNotice(Warning warning = None) { m_warning = warning; }
 
   /**
    * Equality operator.
    * @param rhs right hand side to compare
    * @return true if this == rhs.
    */
   bool operator==(const FrameNotice& rhs) const {
     return m_warning == rhs.m_warning;
   }
 
   /**
    * Bool operator, true if not none.
    */
   operator bool() const { return m_warning != None; }
 
   /**
    * Get warning of notice.
    * @return warning.
    */
   Warning getWarning() const { return m_warning; }
 
   /**
    * Get translated description of notice.
    * @return description, empty if none.
    */
   QString getDescription() const;
 
   /**
    * Get regular expression to validate an ISO 8601 date/time.
    * @return regular expression matching ISO date/time and periods.
    */
   static const QRegularExpression& isoDateTimeRexExp();
 
   /**
    * Check if a picture frame exceeds a given size.
    * TooLarge notice is set in @a frame, if its size is larger than @a maxSize.
    * @param frame picture frame to check
    * @param maxSize maximum size of picture data in bytes
    * @return true if size too large.
    */
   static bool addPictureTooLargeNotice(Frame& frame, int maxSize);
 
   /**
    * Check if frames violate the ID3v2 standard.
    * Violating frames are marked with the corresponding notice.
    * @param frames frames to check
    * @return true if a violation is detected.
    */
   static bool addId3StandardViolationNotice(FrameCollection& frames);
 
 private:
   Warning m_warning;
 };