error.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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/>.
 *
 */

#ifndef COMMON_ERROR_H
#define COMMON_ERROR_H

#include "common/str.h"

namespace Common {

enum ErrorCode {
    kNoError = 0,                   

    kNoGameDataFoundError,          
    kUnsupportedGameidError,        
    kUnsupportedColorMode,          
    kAudioDeviceInitFailed,         

    kReadPermissionDenied,          
    kWritePermissionDenied,         

    kPathDoesNotExist,              
    kPathNotDirectory,              
    kPathNotFile,                   

    kCreatingFileFailed,            
    kReadingFailed,                 
    kWritingFailed,                 

    kMetaEnginePluginNotFound,      
    kEnginePluginNotFound,          
    kEnginePluginNotSupportSaves,   

    kUserCanceled,                  

    kUnknownError                   
};

class Error {
protected:
    ErrorCode _code; 
    String _desc;    
public:
    Error(ErrorCode code = kUnknownError);

    Error(ErrorCode code, const String &extra);

    String getDesc() const;

    U32String getTranslatedDesc() const;

    ErrorCode getCode() const { return _code; }
};

} // End of namespace Common

#endif //COMMON_ERROR_H