errorTypes.h

Go to the documentation of this file.

 
#ifndef NSBACI_TYPES_ERRORTYPES_H
#define NSBACI_TYPES_ERRORTYPES_H
 
#include <string>
#include <variant>
 
#include "fileTypes.h"

namespace nsbaci::types {

enum class ErrSeverity { Warning, Error, Fatal };

enum class ErrType {
  // File path errors
  emptyPath,          // Path string is empty
  invalidPath,        // Path is malformed or invalid
  invalidExtension,   // File does not have .nsb extension
  directoryNotFound,  // Parent directory doesn't exist
  fileNotFound,       // File doesn't exist
  notARegularFile,    // Path points to directory, symlink, etc.
 
  // Permission errors
  permissionDenied,  // No read/write access
 
  // I/O errors
  openFailed,   // Could not open file
  readFailed,   // Error while reading
  writeFailed,  // Error while writing
 
  // Compilation errors
  compilationError,  // Syntax or semantic error during compilation
 
  // Generic
  unknown  // Unspecified error
};
 
using ErrMessage = std::string;

struct ErrorBase {
  // this severity serves as an indicator to what icon to use in the error, the
  // string that appears in the top of the dialog, additional buttons for things
  // like restart when the error is fatal...
  ErrSeverity severity;
  ErrMessage message;
  // useful to show the reason for things. For example, if when trying to save a
  // file to a sensible location, if the app doesn't have privileges, the ui can
  // show a message of type: "/Error/ X could not be saved in Y. Reason:
  // Permission Denied. Try starting the app in admin mode. [Ok]"
  ErrType type;
};

struct CompileError {
  int line = 0;
  int column = 0;
};

struct SaveError {
  File associatedFile;
};

struct LoadError {
  File associatedFile;
};

struct RuntimeError {};

using ErrorPayload =
    std::variant<SaveError, LoadError, CompileError, RuntimeError>;
 
}  // namespace nsbaci::types
 
#endif  // NSBACI_TYPES_ERRORTYPES_H