PlatformEnvironment Class Reference

#include <PlatformEnvironment.h>

Inheritance diagram for PlatformEnvironment:

Public Member Functions
	PlatformEnvironment (PEBLVideoMode mode, PEBLVideoDepth depth, bool windowed, bool resizeable, bool unicode)
	Standard Constructor.
virtual	~PlatformEnvironment ()
	Standard Destructor.
void	Initialize ()
	This method initiates everything needed to display the main window.
virtual bool	Draw ()
PEBLVideoMode	GetVideoMode ()
PEBLVideoDepth	GetVideoDepth ()
bool	GetWindowed ()
Variant	GetScreenModes (int screen=-1)
Variant	GetResizeable ()
virtual bool	SetProperty (std::string, Variant v)
virtual Variant	GetProperty (std::string) const
virtual int	ShowCursor (int val)
virtual int	SetCursorPosition (int x, int y)
virtual Variant	GetCursorPosition ()
virtual void	SetKeyRepeat (bool onoff)
virtual Variant	GetMouseState ()
virtual bool	GetUnicode ()
virtual int	GetNumJoysticks ()
virtual Variant	GetJoystick (int index)
virtual std::string	GetSystemLocale ()
virtual bool	IsSystemLocaleRTL ()
	PlatformEnvironment (PEBLVideoMode mode, PEBLVideoDepth depth, bool windowed, bool resizeable, bool unicode)
virtual	~PlatformEnvironment ()
void	Initialize ()
virtual bool	Draw ()
PEBLVideoMode	GetVideoMode ()
PEBLVideoDepth	GetVideoDepth ()
bool	GetWindowed ()
Variant	GetScreenModes (int screen=-1)
Variant	GetResizeable ()
virtual bool	SetProperty (std::string, Variant v)
virtual Variant	GetProperty (std::string) const
virtual int	ShowCursor (int val)
virtual int	SetCursorPosition (int x, int y)
virtual Variant	GetCursorPosition ()
virtual void	SetKeyRepeat (bool onoff)
virtual Variant	GetMouseState ()
virtual bool	GetUnicode ()
virtual int	GetNumJoysticks ()
virtual Variant	GetJoystick (int index)
virtual std::string	GetSystemLocale ()
virtual bool	IsSystemLocaleRTL ()
Public Member Functions inherited from PEnvironment
	PEnvironment ()
virtual	~PEnvironment ()
virtual bool	IsInitialized ()
virtual bool	AddWindow (PWindow *window)
virtual PWindow *	GetWindow (int index=0)
virtual bool	RemoveWindow (PWindow *window)
Public Member Functions inherited from PEBLObjectBase
	PEBLObjectBase ()
	Standard Constructor.
	PEBLObjectBase (ComplexDataType cdt)
	Standard Constructor.
	PEBLObjectBase (const PEBLObjectBase &pob)
virtual	~PEBLObjectBase ()
	Standard Destructor.
virtual bool	InitializeProperty (std::string name, Variant v)
Variant	GetProperty (std::string) const
virtual ObjectValidationError	ValidateProperty (std::string, Variant v) const
virtual ObjectValidationError	ValidateProperty (std::string) const
ComplexDataType	GetType ()
virtual std::string	ObjectName () const
virtual std::ostream &	PrintProperties (std::ostream &out)
virtual Variant	GetPropertyList ()

Protected Member Functions
virtual std::ostream &	SendToStream (std::ostream &out) const
virtual std::ostream &	SendToStream (std::ostream &out) const

Additional Inherited Members
Protected Attributes inherited from PEnvironment
bool	mIsInitialized
std::list< PWindow * >	mWindows
Protected Attributes inherited from PEBLObjectBase
ComplexDataType	mCDT
std::map< std::string, Variant >	mProperties

Detailed Description

This class initializes the the SDL environment, which may include the video and audio interfaces, the ttf renderer, etc.

Headless platform environment - minimal initialization without SDL Used for validation mode where no actual display is needed

Definition at line 61 of file sdl/PlatformEnvironment.h.

Constructor & Destructor Documentation

PlatformEnvironment() [1/2]

PlatformEnvironment::PlatformEnvironment	(	PEBLVideoMode	mode,
		PEBLVideoDepth	depth,
		bool	windowed,
		bool	resizeable,
		bool	unicode
	)

Standard Constructor.

Definition at line 62 of file sdl/PlatformEnvironment.cpp.

                                                                                    :
    PEBLObjectBase(CDT_ENVIRONMENT),
    mVideoMode(mode),
    mVideoDepth(depth),
    mWindowed(windowed),
    mUnicode(unicode),
    mResizeable(resizeable),
    mNumJoysticks(0)
{
    mIsInitialized = false;
}

References PEnvironment::mIsInitialized.

~PlatformEnvironment() [1/2]

PlatformEnvironment::~PlatformEnvironment ( )

virtual

Standard Destructor.

Definition at line 77 of file sdl/PlatformEnvironment.cpp.

{
    mWindows.clear();
 
    //    SDL_Quit();  //this can cause a crash; SDL_Quit needs to be called at very end.
    // especially if there are global SDL objects like gWin remaining.
    //probably need to explicitly delete the globalvariable map;for now SDL_quit gets
    //called essentially in main().
}

References PEnvironment::mWindows.

PlatformEnvironment() [2/2]

PlatformEnvironment::PlatformEnvironment	(	PEBLVideoMode	mode,
		PEBLVideoDepth	depth,
		bool	windowed,
		bool	resizeable,
		bool	unicode
	)

~PlatformEnvironment() [2/2]

virtual PlatformEnvironment::~PlatformEnvironment ( )

virtual

Member Function Documentation

Draw() [1/2]

bool PlatformEnvironment::Draw ( )

virtual

This method 'draws' the environment; it iterates through each window in the environment and calls the draw method on each.

Definition at line 199 of file sdl/PlatformEnvironment.cpp.

{
    //Iterate through all child windows and draw them
    list<PWindow*>::iterator p;
    for(p=mWindows.begin(); p!= mWindows.end(); p++)
        {
 
 
            if(*p)
                (*p)->Draw();
        }
 
    return true;
}

References PEnvironment::mWindows.

Referenced by PEBLObjects::Draw(), PEBLEnvironment::GetInput0(), main(), and PlatformEventQueue::Prime().

Draw() [2/2]

virtual bool PlatformEnvironment::Draw ( )

virtual

GetCursorPosition() [1/2]

Variant PlatformEnvironment::GetCursorPosition ( )

virtual

Definition at line 260 of file sdl/PlatformEnvironment.cpp.

{
    int x = 0;
    int y = 0;
    SDL_PumpEvents();
    SDL_GetMouseState(&x,&y);
 
    PList * newlist = new PList();
    newlist->PushBack(Variant(x));
    newlist->PushBack(Variant(y));
    counted_ptr<PEBLObjectBase> newlist2 = counted_ptr<PEBLObjectBase>(newlist);
    PComplexData *   pcd = new PComplexData(newlist2);
    return Variant(pcd);
}

References PList::PushBack().

Referenced by PEBLEnvironment::GetCursorPosition().

GetCursorPosition() [2/2]

virtual Variant PlatformEnvironment::GetCursorPosition ( )

virtual

GetJoystick() [1/2]

Variant PlatformEnvironment::GetJoystick ( int  index )

virtual

Definition at line 329 of file sdl/PlatformEnvironment.cpp.

{
 
    if(index < 1 || index > SDL_NumJoysticks())
        {
            PError::SignalFatalError("Requesting an invalid joystick");
        }
    //    SDL_Joystick * joystick = SDL_JoystickOpen(int index);
    PlatformJoystick* joystick = new PlatformJoystick(index+1);
 
 
 
    counted_ptr<PEBLObjectBase> tmp = counted_ptr<PEBLObjectBase>(joystick);
 
    PComplexData *   pcd = new PComplexData(tmp);
    return Variant(pcd);
 
}

References PError::SignalFatalError().

GetJoystick() [2/2]

virtual Variant PlatformEnvironment::GetJoystick ( int  index )

virtual

GetMouseState() [1/2]

Variant PlatformEnvironment::GetMouseState ( )

virtual

Definition at line 287 of file sdl/PlatformEnvironment.cpp.

{
    int x = 0;
    int y = 0;
    SDL_PumpEvents();
    int button = SDL_GetMouseState(&x,&y);
    int b1 = button & SDL_BUTTON(1);
    int b2 = button & SDL_BUTTON(2);
    int b3 = button & SDL_BUTTON(3);
 
    PList * newlist = new PList();
    newlist->PushBack(Variant(x));
    newlist->PushBack(Variant(y));
    newlist->PushBack(Variant(b1));
    newlist->PushBack(Variant(b2));
    newlist->PushBack(Variant(b3));
 
    counted_ptr<PEBLObjectBase> newlist2 = counted_ptr<PEBLObjectBase>(newlist);
    PComplexData *   pcd = new PComplexData(newlist2);
    return Variant(pcd);
}

References PList::PushBack().

Referenced by PEBLEnvironment::GetMouseState().

GetMouseState() [2/2]

virtual Variant PlatformEnvironment::GetMouseState ( )

virtual

GetNumJoysticks() [1/2]

int PlatformEnvironment::GetNumJoysticks ( )

virtual

Definition at line 312 of file sdl/PlatformEnvironment.cpp.

{
    //Initialize joystick subsystem if has not yet been.
    if(SDL_InitSubSystem(SDL_INIT_JOYSTICK)<0)
        {
            PError::SignalWarning("No joysticks available");
        }
    int num   =  SDL_NumJoysticks();
 
    return num;
}

References PError::SignalWarning().

Referenced by PEBLEnvironment::GetNumJoysticks().

GetNumJoysticks() [2/2]

virtual int PlatformEnvironment::GetNumJoysticks ( )

virtual

GetProperty() [1/2]

Variant PlatformEnvironment::GetProperty ( std::string  name ) const

virtual

Definition at line 222 of file sdl/PlatformEnvironment.cpp.

{
    return PEBLObjectBase::GetProperty(name);
}

References PEBLObjectBase::GetProperty().

GetProperty() [2/2]

virtual Variant PlatformEnvironment::GetProperty ( std::string  ) const

virtual

GetResizeable() [1/2]

Variant PlatformEnvironment::GetResizeable ( )

inline

Definition at line 80 of file sdl/PlatformEnvironment.h.

{return mResizeable;};

Referenced by PEBLObjects::MakeWindow().

GetResizeable() [2/2]

Variant PlatformEnvironment::GetResizeable ( )

inline

Definition at line 52 of file validator/PlatformEnvironment.h.

{ return mResizeable; };

GetScreenModes() [1/2]

Variant PlatformEnvironment::GetScreenModes

(

int

screen = -1

)

Definition at line 349 of file sdl/PlatformEnvironment.cpp.

{
 
 
    int low,hi;
 
    int numdisplays = SDL_GetNumVideoDisplays();
 
    if(screen<0 | screen >=numdisplays)
        {
            low=0;
            hi = numdisplays;
        }
    else
        {
            low = screen;
            hi = screen+1;
        }
 
 
 
   // Uint32 f;
    PList * baselist = new PList();
    PComplexData * pcd=NULL;
 
 
    //Get a list of available resolutions and try these out.
 
 
    int nummodes = 0;
    int totalmodes = 0;
    SDL_DisplayMode mode = { SDL_PIXELFORMAT_UNKNOWN, 0, 0, 0, 0 };
    for(int i = low; i < hi; i++)  //go through each screen specified.
        {
            nummodes = SDL_GetNumDisplayModes(i); //We should query each display here.
            totalmodes += nummodes;
 
            for(int modeid = 0;modeid < nummodes; modeid++)
                {
 
                    SDL_GetDisplayMode(i,modeid,&mode);
 
                    PList * newlist = new PList();
 
                    newlist->PushBack(Variant(mode.w));
                    newlist->PushBack(Variant(mode.h));
                    newlist->PushBack(Variant(i));  //add screen ID
                    newlist->PushBack(Variant(mode.refresh_rate));
 
                    counted_ptr<PEBLObjectBase> newlist2 = counted_ptr<PEBLObjectBase>(newlist);
                    pcd = new PComplexData(newlist2);
                    baselist->PushBack(Variant(pcd));
 
                }
        }
 
 
    counted_ptr<PEBLObjectBase> baselist2 = counted_ptr<PEBLObjectBase>(baselist);
    pcd = new PComplexData(baselist2);
    return Variant(pcd);
}

References NULL, and PList::PushBack().

Referenced by PEBLEnvironment::GetVideoModes().

GetScreenModes() [2/2]

Variant PlatformEnvironment::GetScreenModes

(

int

screen = -1

)

GetSystemLocale() [1/2]

std::string PlatformEnvironment::GetSystemLocale ( )

virtual

Implements PEnvironment.

Definition at line 415 of file sdl/PlatformEnvironment.cpp.

                                               {
    SDL_Locale *locales = SDL_GetPreferredLocales();
    if (!locales) {
        return "";  // Error or not supported on this platform
    }
 
    // Get the first (primary) locale
    std::string result = "";
    if (locales[0].language) {
        result = locales[0].language;
 
        // Append country code if available (e.g., "en_US", "zh_CN")
        if (locales[0].country) {
            result += "_";
            result += locales[0].country;
        }
    }
 
    SDL_free(locales);
    return result;  // e.g., "ar", "en_US", "zh_CN", "he_IL", "ko_KR"
}

Referenced by PEBLString::GetSystemLocale(), and IsSystemLocaleRTL().

GetSystemLocale() [2/2]

virtual std::string PlatformEnvironment::GetSystemLocale ( )

inlinevirtual

Implements PEnvironment.

Definition at line 69 of file validator/PlatformEnvironment.h.

{ return ""; }

GetUnicode() [1/2]

virtual bool PlatformEnvironment::GetUnicode ( )

inlinevirtual

Definition at line 93 of file sdl/PlatformEnvironment.h.

{return mUnicode;};

GetUnicode() [2/2]

virtual bool PlatformEnvironment::GetUnicode ( )

inlinevirtual

Definition at line 63 of file validator/PlatformEnvironment.h.

{ return mUnicode; };

GetVideoDepth() [1/2]

PEBLVideoDepth PlatformEnvironment::GetVideoDepth ( )

inline

Definition at line 76 of file sdl/PlatformEnvironment.h.

{return mVideoDepth;};

Referenced by PEBLObjects::MakeWindow().

GetVideoDepth() [2/2]

PEBLVideoDepth PlatformEnvironment::GetVideoDepth ( )

inline

Definition at line 48 of file validator/PlatformEnvironment.h.

{ return mVideoDepth; };

GetVideoMode() [1/2]

PEBLVideoMode PlatformEnvironment::GetVideoMode ( )

inline

Definition at line 75 of file sdl/PlatformEnvironment.h.

{return mVideoMode;};

Referenced by PEBLObjects::MakeWindow().

GetVideoMode() [2/2]

PEBLVideoMode PlatformEnvironment::GetVideoMode ( )

inline

Definition at line 47 of file validator/PlatformEnvironment.h.

{ return mVideoMode; };

GetWindowed() [1/2]

bool PlatformEnvironment::GetWindowed ( )

inline

Definition at line 77 of file sdl/PlatformEnvironment.h.

{return mWindowed;};

Referenced by PEBLObjects::MakeWindow().

GetWindowed() [2/2]

bool PlatformEnvironment::GetWindowed ( )

inline

Definition at line 49 of file validator/PlatformEnvironment.h.

{ return mWindowed; };

Initialize() [1/2]

void PlatformEnvironment::Initialize ( )

virtual

This method initiates everything needed to display the main window.

Implements PEnvironment.

Definition at line 99 of file sdl/PlatformEnvironment.cpp.

{
 
    mIsInitialized = true;
 
#ifdef PEBL_EMSCRIPTEN
#define SDLINIT_FLAGS SDL_INIT_VIDEO
#else
#define SDLINIT_FLAGS SDL_INIT_VIDEO|SDL_INIT_AUDIO|SDL_INIT_TIMER|SDL_INIT_NOPARACHUTE
#endif
    if ( SDL_Init(SDLINIT_FLAGS) < 0 )
        {
 
            cerr << "Unable to init SDL: " <<  SDL_GetError() << endl;;
            mIsInitialized = false;
        }
    else{
 
        std::cerr << "SDL INITIALIZED\n";
        const char* audioDriver = SDL_GetCurrentAudioDriver();
        if(audioDriver) {
            std::cerr << "SDL Audio Driver: " << audioDriver << "\n";
        } else {
            std::cerr << "SDL Audio Driver: NONE\n";
        }
 
#ifdef PEBL_EMSCRIPTEN
        if (TTF_Init() < 0 )
#else
        if (!TTF_WasInit() && TTF_Init() < 0 )
#endif
            {
                /* Initialize the TTF library */
                cerr <<  "Couldn't initialize TTF: " << SDL_GetError() << endl;
                mIsInitialized = false;
            } else
            {
                std::cerr << "TTF INITIALIZED\n";
            }
 
        // Initialize SDL_image for JPEG, PNG, etc.
#ifdef PEBL_EMSCRIPTEN
        // Emscripten: formats specified at compile time via SDL2_IMAGE_FORMATS
        int imgFlags = IMG_INIT_JPG | IMG_INIT_PNG;
#else
        int imgFlags = IMG_INIT_JPG | IMG_INIT_PNG | IMG_INIT_TIF;
#endif
        cerr << "Attempting to initialize SDL_image with flags: " << imgFlags << endl;
        cerr << "  IMG_INIT_JPG = " << IMG_INIT_JPG << endl;
        cerr << "  IMG_INIT_PNG = " << IMG_INIT_PNG << endl;
 
        int imgInitResult = IMG_Init(imgFlags);
        cerr << "IMG_Init returned: " << imgInitResult << endl;
 
        if ((imgInitResult & imgFlags) != imgFlags)
            {
                cerr << "WARNING: SDL_image could not initialize all requested formats!" << endl;
                cerr << "  Requested flags: " << imgFlags << endl;
                cerr << "  Initialized flags: " << imgInitResult << endl;
                cerr << "  IMG_Error: " << IMG_GetError() << endl;
 
                if (!(imgInitResult & IMG_INIT_JPG)) {
                    cerr << "  JPEG support NOT available!" << endl;
                }
                if (!(imgInitResult & IMG_INIT_PNG)) {
                    cerr << "  PNG support NOT available!" << endl;
                }
            } else
            {
                std::cerr << "SDL_image INITIALIZED successfully with all formats" << endl;
                std::cerr << "  JPEG support: YES" << endl;
                std::cerr << "  PNG support: YES" << endl;
            }
 
        // Pre-initialize keycode lookup tables to avoid timing artifacts on first keypress
        // This is critical for psychological experiments with accurate response time measurements
        PEBLUtility::InitializeKeycodeLookups();
 
#define PRINTCONSOLE 0
#if PRINTCONSOLE
        //cout << "reopening console\n";
   //This needs to be done after SDL_Init()
   std::ofstream cct1("CON1");
   std::ofstream cct2("CON2");
 
   freopen( "CON1", "w", stdout );
   freopen( "CON2", "w", stderr );
#endif
 
    }
    //This shouldn't be neded, if platformenvironment gets cleaned up alright,
    //but let's do it anyway.
    //atexit(SDL_Quit);
    //    std::cerr << "SDL INITIALIZATION COMPLETE\n";
}

References PEBLUtility::InitializeKeycodeLookups(), PEnvironment::mIsInitialized, and SDLINIT_FLAGS.

Referenced by main(), and PEBLObjects::MakeEnvironment().

Initialize() [2/2]

void PlatformEnvironment::Initialize ( )

virtual

Implements PEnvironment.

IsSystemLocaleRTL() [1/2]

bool PlatformEnvironment::IsSystemLocaleRTL ( )

virtual

Implements PEnvironment.

Definition at line 439 of file sdl/PlatformEnvironment.cpp.

                                            {
    std::string locale = GetSystemLocale();
    if (locale.empty()) {
        return false;  // Default to LTR if we can't detect
    }
 
    // Extract language code (first 2 characters)
    std::string langCode = locale.substr(0, 2);
    std::transform(langCode.begin(), langCode.end(), langCode.begin(), ::tolower);
 
    // Check if it's Arabic or Hebrew
    return (langCode == "ar" || langCode == "he" || langCode == "iw");
}

References GetSystemLocale().

Referenced by PEBLString::IsSystemLocaleRTL().

IsSystemLocaleRTL() [2/2]

virtual bool PlatformEnvironment::IsSystemLocaleRTL ( )

inlinevirtual

Implements PEnvironment.

Definition at line 70 of file validator/PlatformEnvironment.h.

{ return false; }

SendToStream() [1/2]

std::ostream & PlatformEnvironment::SendToStream ( std::ostream &  out ) const

protectedvirtual

Reimplemented from PEnvironment.

Definition at line 123 of file validator/PlatformEnvironment.cpp.

                                                                   {
    out << "PlatformEnvironment (validator)";
    return out;
}

SendToStream() [2/2]

virtual std::ostream & PlatformEnvironment::SendToStream ( std::ostream &  out ) const

protectedvirtual

Reimplemented from PEnvironment.

SetCursorPosition() [1/2]

int PlatformEnvironment::SetCursorPosition ( int  x, int  y  )

virtual

Definition at line 244 of file sdl/PlatformEnvironment.cpp.

{
    //this will move the mouse in the first window.
    //another method is necessary to move it within an arbitrary window.
    PlatformWindow* pw =dynamic_cast<PlatformWindow*>( mWindows.front());
 
    SDL_SetRelativeMouseMode(SDL_FALSE);
    //cout << "Warping mouse:" <<x << "|" << y<< std::endl;
    SDL_Window *win = pw->PlatformWindow::GetSDLWindow();
    SDL_WarpMouseInWindow(win,x,y);
    //printf("SDL_warp error?: %s\n", SDL_GetError());
 
    return 1;
}

References PEnvironment::mWindows.

Referenced by PEBLEnvironment::SetCursorPosition().

SetCursorPosition() [2/2]

virtual int PlatformEnvironment::SetCursorPosition ( int  x, int  y  )

virtual

SetKeyRepeat() [1/2]

void PlatformEnvironment::SetKeyRepeat ( bool  onoff )

virtual

Definition at line 276 of file sdl/PlatformEnvironment.cpp.

{
    //This is no longer available in SDL2
#ifdef SDL2_DELETE
    if(onoff)
        SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY,SDL_DEFAULT_REPEAT_INTERVAL);
    else
        SDL_EnableKeyRepeat(0,0);
#endif
}

Referenced by PEBLEnvironment::GetInput0().

SetKeyRepeat() [2/2]

virtual void PlatformEnvironment::SetKeyRepeat ( bool  onoff )

virtual

SetProperty() [1/2]

bool PlatformEnvironment::SetProperty ( std::string  name, Variant  v  )

virtual

Reimplemented from PEBLObjectBase.

Definition at line 216 of file sdl/PlatformEnvironment.cpp.

{
    //this class has no settable properties.
    return false;
}

SetProperty() [2/2]

virtual bool PlatformEnvironment::SetProperty ( std::string  , Variant  v  )

virtual

Reimplemented from PEBLObjectBase.

ShowCursor() [1/2]

int PlatformEnvironment::ShowCursor ( int  val )

virtual

Definition at line 230 of file sdl/PlatformEnvironment.cpp.

{
 
    if(val)
        {
            return SDL_ShowCursor(SDL_ENABLE);
        }
    else
        {
            return SDL_ShowCursor(SDL_DISABLE);
        }
}

Referenced by PEBLEnvironment::ShowCursor().

ShowCursor() [2/2]

virtual int PlatformEnvironment::ShowCursor ( int  val )

virtual

---

The documentation for this class was generated from the following files:

• sdl/PlatformEnvironment.h
• validator/PlatformEnvironment.h
• sdl/PlatformEnvironment.cpp
• validator/PlatformEnvironment.cpp