exceptions.h

Go to the documentation of this file.

/*!\file exceptions.h
        \brief Declerations for the exceptions thrown by
        any PackageManager class.*/

#ifndef __EXCEPTIONS_H__
#define __EXCEPTIONS_H__

#include "pmstring.h"
#include "dependency.h"
#include "packageversion.h"

//!Exception error codes.
/*!Enum for all errorCodes supplied by PortageErrorCode. Check
  with the function that throws the exception to see if the
  message contains any useful information.*/
enum PortageErrorCode
{
        eNotEnoughMem,                  //!<New error - not enough memory for a new.
        eErrorOpeningFile,              //!<Cannot open a file.
        eFileStreamError,               //!<Error with a filestrem.
        eInvalidDescription,    //!<Invalid format of category/name-version string.
        eInvalidVariable,               //!<Invalid variable, not found in ConfigReader.
        eBadFormatOrDependency, //!<An || in a dependency string was not followed by a bracket.
        eNoResults,                             //!<Thrown if there are no results for the Search.
        eBadVersionCompare,             //!<Version compare could not come up with an answer - this is a bug.
        eEmptyVersionCompare,   //!<Empty string passed to version compare.
        eNoVirtualFound,                //!<No Virtual found for the string supplied.
        eVirtualUnavailable             //!<The virtual asked for was unavailable. Possibly masked?
};

//!The main exception class within Sportage.
/*!The main exception class within Sportage. These can be thrown both
   as warnings and fatal errors, check the function to see if the error
   is fatal.*/
struct PortageException
{
        PortageException(PortageErrorCode code){errorCode = code;}      //!<Constructor setting up errorcode.
        ;
        PortageException(PortageErrorCode code, PMString message)       //!<Constructor setting up code and message.
        {
                errorCode = code;
                errorMessage = message;
        };
        
        PortageErrorCode errorCode;     //!<Error code.
        PMString errorMessage;          //!<Message - a useful string to go with the code. Check throwing function to see what it contains.
};

//!Exception thrown by directory readers.
/*!Exception thrown by directory readers. The code is the one received from scandir.*/
struct DirectoryException
{
        DirectoryException(){};                                                 //!<Default constructor.
        DirectoryException(int code, PMString message)  //!<Constructor to set up the variables.
        {
                errorCode = code;
                errorMessage = message;
        };
        int errorCode;                  //!<Error code received from scanf.
        PMString errorMessage;  //!<Message - usually the directory that the error occured on.
};

//!Exception for dependency calculation.
/*!Exception to say when things have gone wrong with dependencies. Usually
  the dependency of version cannot be met. Check with throwing functions however.*/
struct DependencyException
{
        DependencyException(Dependency passedDependency,PackageVersion passedVersion)   //!<Constructor.
        {
                dependency = passedDependency;
                version = passedVersion;
        };
        Dependency dependency;  //!<Dependency that cannot be met (usually).
        PackageVersion version; //!<Version who's dependency cannot be met (usually).
};

#endif

---