OSDLBasic.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL library 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 Lesser General Public License and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#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() ;


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



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




        public:
        
        
        
            typedef Ceylan::Sint32 BackendReturnCode ;



            static const BackendReturnCode BackendSuccess ;
            
            
            
            static const BackendReturnCode BackendError ;
        
        
        
            Ceylan::System::Microsecond getRuntimeDuration() const ;
        
                
        
            virtual bool hasVideoModule() const ; 


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

            
            
            virtual Events::EventsModule & getEventsModule() const ;
            


            virtual bool hasAudioModule() const ; 

            
            virtual Audio::AudioModule & getAudioModule() const ;
            
            
            virtual void removeAudioModule() ;
            
            
            
            virtual Ceylan::Flags getFlags() const ;




            virtual bool isGUIEnabled() const ;


            virtual void enableGUI() ;


            virtual void disableGUI() ;




            virtual bool hasCDROMDriveHandler() const ; 

            
            virtual CDROMDriveHandler & getCDROMDriveHandler() const ;
            
            

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




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


            static bool IsBackendInitialized() ;
            


            /*
             * 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 UseEvents ;             


            static const Ceylan::Flags UseGUI ;            


            static const Ceylan::Flags UseEverything ;             


            static const Ceylan::Flags NoParachute ;               


            static const Ceylan::Flags UseEventThread ;





        protected:
        
            
            
            static Ceylan::Flags AutoCorrectFlags( Ceylan::Flags inputFlags ) ;
                
                    
                    
            Video::VideoModule * _video ;
            
            
            
            Events::EventsModule * _events ;            
            
            
            
            Audio::AudioModule * _audio ;
            
            
            bool _useGUI ;
            
            
            
            Ceylan::Flags _flags ;  
            
            
            
            CDROMDriveHandler * _cdromHandler ;
            
            
            
            Ceylan::System::Second _startingSecond ;
            
            
            Ceylan::System::Microsecond _startingMicrosecond ;
            
            
            
            
            // Static attributes:   



            static bool _BackendInitialized ;
                
                
            static CommonModule * _CurrentCommonModule ;



            static const std::string _SDLEnvironmentVariables[] ;




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




    // Friend section.
    
    

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



#endif // OSDL_BASIC_H_

---