OSDLBasic.h

Go to the documentation of this file.

#ifndef OSDL_BASIC_H_
#define OSDL_BASIC_H_


#include "OSDLException.h"  // for OSDL::Exception


#include "Ceylan.h"         // for Ceylan::Module, Version, etc.



namespace OSDL
{


    #define CHECK_OSDL_VERSIONS()                                            \
        Ceylan::LibtoolVersion headerVersion(                                \
            OSDL::actualOSDLHeaderLibtoolVersion ) ;                         \
        if ( ! /* library version */                                         \
                OSDL::GetVersion().isCompatibleWith( headerVersion ) )       \
            Ceylan::emergencyShutdown(                                       \
                "OSDL library version currently linked ("                    \
                + OSDL::GetVersion().toString()                              \
                + ") is not compatible with the one read from the OSDL "     \
                "header files used to compile this application ("            \
                + headerVersion.toString() + "), aborting." ) ;


    
    
    namespace Video
    {
    
        // Managed by the common module.
        class VideoModule ;
        
    }
    
    
    namespace Events
    {
    
        // Managed by the common module.
        class EventsModule ;
        
    }

        
    namespace Audio
    {
    
        // Managed by the common module.
        class AudioModule ;
        
    }
            
            
    // Managed by the common module.
    class CDROMDriveHandler ;
    
    
    OSDL_DLL const Ceylan::LibtoolVersion & GetVersion() throw() ;

    
    OSDL_DLL void stop() throw() ;
                
        
    class OSDL_DLL CommonModule : public Ceylan::Module
    {



        OSDL_DLL friend CommonModule & getCommonModule( Ceylan::Flags flags )
            throw() ;
        
        
        OSDL_DLL friend bool hasExistingCommonModule() throw() ;
        
        
        OSDL_DLL friend CommonModule & getExistingCommonModule() throw() ;
        
        
        
        
        OSDL_DLL friend void stop() throw() ;



        public:
        
        
            typedef Ceylan::Sint32 BackendReturnCode ;


            static const BackendReturnCode BackendSuccess ;
            
            
            static const BackendReturnCode BackendError ;
        
        
            virtual bool hasVideoModule() const throw() ; 

                    
            virtual Video::VideoModule & getVideoModule() 
                const throw( OSDL::Exception ) ;
            
            
            
            virtual bool hasEventsModule() const throw() ; 

            
            virtual Events::EventsModule & getEventsModule() 
                const throw( OSDL::Exception ) ;
            


            virtual bool hasAudioModule() const throw() ; 

            
            virtual Audio::AudioModule & getAudioModule() 
                const throw( OSDL::Exception ) ;
            
            
            
            virtual Ceylan::Flags getFlags() const throw() ;




            virtual bool hasCDROMDriveHandler() const throw() ; 

            
            virtual CDROMDriveHandler & getCDROMDriveHandler() 
                const throw( OSDL::Exception ) ;
            
            

            virtual const std::string toString( 
                Ceylan::VerbosityLevels level = Ceylan::high ) const throw() ;



            // Static section.
            
            
            static std::string InterpretFlags( Ceylan::Flags flags ) throw() ;
    
    
            static std::string DescribeEnvironmentVariables() throw() ; 


            static bool IsBackendInitialized() throw() ;
            

            /*
             * These flags can apply to Surfaces <b>created by setMode</b>,
             * i.e. all the display Surfaces.
             * 
             * The legal flags for setMode form a subset of the Surface 
             * flags, with one flag being added, NoFrame. 
             *
             * @note These flags are not to be mixed up with the Surface 
             * flags' ones.
             *
             * @see OSDL::Video::Surface             
             */


            static const Ceylan::Flags UseTimer ;              

            static const Ceylan::Flags UseAudio ;
                           
            static const Ceylan::Flags UseVideo ;
                           
            static const Ceylan::Flags UseCDROM ;              


            static const Ceylan::Flags UseJoystick ;               


            static const Ceylan::Flags UseKeyboard ;               


            static const Ceylan::Flags UseMouse ;              


            static const Ceylan::Flags UseEverything ;             


            static const Ceylan::Flags NoParachute ;               


            static const Ceylan::Flags UseEventThread ;




        protected:
        
            
            static Ceylan::Flags AutoCorrectFlags( Ceylan::Flags inputFlags )
                throw() ;
                    
                    
            Video::VideoModule * _video ;
            
            Events::EventsModule * _events ;            
            
            Audio::AudioModule * _audio ;
            
            Ceylan::Flags _flags ;  
            
            CDROMDriveHandler * _cdromHandler ;
            
            
            // Static attributes :  


            static bool _BackendInitialized ;
                
            static CommonModule * _CurrentCommonModule ;


            static std::string _SDLEnvironmentVariables[] ;



        private:        
        
        
            explicit CommonModule( Ceylan::Flags flags ) 
                throw ( OSDL::Exception ) ;
    
    
            virtual ~CommonModule() throw() ;   
            
                    
        
    } ;     



    OSDL_DLL CommonModule & getCommonModule( Ceylan::Flags flags ) throw() ;
        
        
    OSDL_DLL bool hasExistingCommonModule() throw() ;
    
    
    OSDL_DLL CommonModule & getExistingCommonModule() throw() ;
        
    
}



#endif // OSDL_BASIC_H_

---