File indexing completed on 2024-04-28 16:13:25

 /*
     SPDX-FileCopyrightText: 2000-2018 Thomas Baumgart tbaumgart @kde.org
 
     This file is part of libalkimia.
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef ALKEXCEPTION_H
 #define ALKEXCEPTION_H
 
 #include <alkimia/alk_export.h>
 
 #include <QString>
 
 /**
   * @file
   * @author Thomas Baumgart
   */
 
 /**
   * This class describes an exception that is thrown by the engine
   * in case of a failure.
   */
 class ALK_NO_EXPORT AlkException
 {
 public:
 
     /**
       * @def ALKEXCEPTION(text)
       * This is the preferred constructor to create a new exception
       * object. It automatically inserts the filename and the source
       * code line into the object upon creation.
       *
       * It is equivalent to AlkException(text, __FILE__, __LINE__)
       */
 #define ALKEXCEPTION(what) AlkException(what, __FILE__, __LINE__)
 
     /**
       * The constructor to create a new ALKEXCEPTION object.
       *
       * @param msg reference to QString containing the message
       * @param file reference to QString containing the name of the sourcefile where
       *             the exception was thrown
       * @param line unsigned long containing the line number of the line where
       *             the exception was thrown in the file.
       *
       * An easier way to use this constructor is to use the macro
       * ALKEXCEPTION(text) instead. It automatically assigns the file
       * and line parameter to the correct values.
       */
     AlkException(const QString &msg, const QString &file, const unsigned long line);
 
     ~AlkException();
 
     /**
       * This method is used to return the message that was passed
       * during the creation of the exception object.
       *
       * @return reference to QString containing the message
       */
     const QString &what() const
     {
         return m_msg;
     }
 
     /**
       * This method is used to return the filename that was passed
       * during the creation of the exception object.
       *
       * @return reference to QString containing the filename
       */
     const QString &file() const
     {
         return m_file;
     }
 
     /**
       * This method is used to return the linenumber that was passed
       * during the creation of the exception object.
       *
       * @return long integer containing the line number
       */
     unsigned long line() const
     {
         return m_line;
     }
 
 private:
     /**
       * This member variable holds the message
       */
     QString m_msg;
 
     /**
       * This member variable holds the filename
       */
     QString m_file;
 
     /**
       * This member variable holds the line number
       */
     unsigned long m_line;
 };
 
 #endif