File indexing completed on 2024-04-28 04:36:30

 /*
     SPDX-FileCopyrightText: 2015 Laszlo Kis-Adam
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef IPROBLEM_H
 #define IPROBLEM_H
 
 #include <QExplicitlySharedDataPointer>
 #include <QVector>
 #include <QMetaType>
 
 #include "interfacesexport.h"
 
 class QIcon;
 
 namespace KDevelop
 {
 class IAssistant;
 class DocumentRange;
 
 /// Interface for the Problem classes
 class KDEVPLATFORMINTERFACES_EXPORT IProblem : public QSharedData
 {
 public:
     using Ptr = QExplicitlySharedDataPointer<IProblem>;
 
     /// The source of the problem. That is which tool / which part found this problem.
     enum Source {
         Unknown,
         Disk,
         Preprocessor,
         Lexer,
         Parser,
         DUChainBuilder,
         SemanticAnalysis,
         ToDo,
         Plugin             /// The source is a problem checker plugin
     };
 
     /// Severity of the problem. That is, how serious is the found problem.
     enum Severity {
         NoSeverity = 0,
         Error = 1,
         Warning = 2,
         Hint = 4
     };
     Q_DECLARE_FLAGS(Severities, Severity)
 
     /// Final location mode of the problem. Used during highlighting.
     enum FinalLocationMode
     {
         /// Location range used "As Is"
         Range = 0,
 
         /// Location range used to highlight whole line.
         ///
         /// Mode applied only if location range is wholly contained within one line
         WholeLine,
 
         /// Location range used to highlight only trimmed part of the line.
         /// For example for the line: "   int x = 0;  \t"
         /// only "int x = 0;" will be highlighted.
         ///
         /// Mode applied only if location range is wholly contained within one line
         TrimmedLine
     };
 
     static QIcon iconForSeverity(IProblem::Severity severity);
 
     IProblem();
     virtual ~IProblem();
 
     /// Returns the source of the problem
     virtual Source source() const = 0;
 
     /// Sets the source of the problem
     virtual void setSource(Source source) = 0;
 
     /// Returns a string containing the source of the problem
     virtual QString sourceString() const = 0;
 
     /// Returns the location of the problem (path, line, column)
     virtual KDevelop::DocumentRange finalLocation() const = 0;
 
     /// Sets the location of the problem (path, line, column)
     virtual void setFinalLocation(const KDevelop::DocumentRange& location) = 0;
 
     /// Returns the final location mode of the problem
     virtual FinalLocationMode finalLocationMode() const = 0;
 
     /// Sets the final location mode of the problem
     virtual void setFinalLocationMode(FinalLocationMode mode) = 0;
 
     /// Returns the short description of the problem.
     virtual QString description() const = 0;
 
     /// Sets the short description of the problem
     virtual void setDescription(const QString& description) = 0;
 
     /// Returns the detailed explanation of the problem.
     virtual QString explanation() const = 0;
 
     /// Sets the detailed explanation of the problem
     virtual void setExplanation(const QString& explanation) = 0;
 
     /// Returns the severity of the problem
     virtual Severity severity() const = 0;
 
     /// Sets the severity of the problem
     virtual void setSeverity(Severity severity) = 0;
 
     /// Returns a string containing the severity of the problem
     virtual QString severityString() const = 0;
 
     /// Returns the diagnostics of the problem.
     virtual QVector<Ptr> diagnostics() const = 0;
 
     /// Sets the diagnostics of the problem
     virtual void setDiagnostics(const QVector<Ptr> &diagnostics) = 0;
 
     /// Adds a diagnostic line to the problem
     virtual void addDiagnostic(const Ptr &diagnostic) = 0;
 
     /// Clears all diagnostics
     virtual void clearDiagnostics() = 0;
 
     /// Returns a solution assistant for the problem, if applicable that is.
     virtual QExplicitlySharedDataPointer<KDevelop::IAssistant> solutionAssistant() const = 0;
 };
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(IProblem::Severities)
 
 }
 
 Q_DECLARE_METATYPE(KDevelop::IProblem::Ptr)
 
 #endif