common/error.h

Go to the documentation of this file.

/* 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#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,             

    // The following are used by --list-saves
    kEnginePluginNotFound,      
    kEnginePluginNotSupportSaves,   

    kUserCanceled,          

    kUnknownError               
};

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

    Error(ErrorCode code, const String &extra);

    const String &getDesc() const { return _desc; }

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

} // End of namespace Common

#endif //COMMON_ERROR_H