llappviewer.h

Go to the documentation of this file.

#ifndef LL_LLAPPVIEWER_H
#define LL_LLAPPVIEWER_H

class LLTextureCache;
class LLWorkerThread;
class LLTextureFetch;
class LLWatchdogTimeout;
class LLCommandLineParser;

class LLAppViewer : public LLApp
{
public:
        LLAppViewer();
        virtual ~LLAppViewer();

    static LLAppViewer* instance() {return sInstance; } 

        //
        // Main application logic
        //
        virtual bool init();                    // Override to do application initialization
        virtual bool cleanup();                 // Override to do application cleanup
        virtual bool mainLoop(); // Override for the application main loop.  Needs to at least gracefully notice the QUITTING state and exit.

        // Application control
        void forceQuit(); // Puts the viewer into 'shutting down without error' mode.
        void requestQuit(); // Request a quit. A kinder, gentler quit.
        void userQuit(); // The users asks to quit. Confirm, then requestQuit()
    void earlyExit(const LLString& msg); // Display an error dialog and forcibly quit.
    void forceExit(S32 arg); // exit() immediately (after some cleanup).
    void abortQuit();  // Called to abort a quit request.

    bool quitRequested() { return mQuitRequested; }
    bool logoutRequestSent() { return mLogoutRequestSent; }

        void closeDebug();

        const LLOSInfo& getOSInfo() const { return mSysOSInfo; }

        // Report true if under the control of a debugger. A null-op default.
        virtual bool beingDebugged() { return false; } 

        S32 getCrashBehavior() const { return mCrashBehavior; } 
        void setCrashBehavior(S32 cb);
        virtual void handleCrashReporting() = 0; // What to do with crash report?
        virtual void handleSyncCrashTrace() = 0; // any low-level crash-prep that has to happen in the context of the crashing thread before the crash report is delivered.
        static void handleViewerCrash(); // Hey! The viewer crashed. Do this, soon.
        static void handleSyncViewerCrash(); // Hey! The viewer crashed. Do this right NOW in the context of the crashing thread.

        // Thread accessors
        static LLTextureCache* getTextureCache() { return sTextureCache; }
        static LLWorkerThread* getImageDecodeThread() { return sImageDecodeThread; }
        static LLTextureFetch* getTextureFetch() { return sTextureFetch; }

        const std::string& getSerialNumber() { return mSerialNumber; }
        
        bool getPurgeCache() const { return mPurgeCache; }
        
        const LLString& getSecondLifeTitle() const; // The Second Life title.
        const LLString& getWindowTitle() const; // The window display name.

    // Helpers for URIs
    void addLoginURI(const std::string& uri);
    void setHelperURI(const std::string& uri);
    const std::vector<std::string>& getLoginURIs() const;
    const std::string& getHelperURI() const;
    void resetURIs() const;

    void forceDisconnect(const LLString& msg); // Force disconnection, with a message to the user.
    void badNetworkHandler(); // Cause a crash state due to bad network packet.

        bool hasSavedFinalSnapshot() { return mSavedFinalSnapshot; }
        void saveFinalSnapshot(); 

    void loadNameCache();
    void saveNameCache();

    bool isInProductionGrid();

        void removeMarkerFile(bool leave_logout_marker = false);
        
    // LLAppViewer testing helpers.
    // *NOTE: These will potentially crash the viewer. Only for debugging.
    virtual void forceErrorLLError();
    virtual void forceErrorBreakpoint();
    virtual void forceErrorBadMemoryAccess();
    virtual void forceErrorInifiniteLoop();
    virtual void forceErrorSoftwareException();

        // *NOTE: There are currently 3 settings files: 
        // "Global", "PerAccount" and "CrashSettings"
        // The list is found in app_settings/settings_files.xml
        // but since they are used explicitly in code,
        // the follow consts should also do the trick.
        static const std::string sGlobalSettingsName; 
        static const std::string sPerAccountSettingsName; 
        static const std::string sCrashSettingsName; 

        void loadSettingsFromDirectory(ELLPath path_index);

        std::string getSettingsFileName(const std::string& file);

        // For thread debugging. 
        // llstartup needs to control this.
        // llworld, send_agent_pause() also controls this.
        void startMainloopTimeout(F32 secs = -1.0f);
        void stopMainloopTimeout();

protected:
        virtual bool initWindow(); // Initialize the viewer's window.
        virtual bool initLogging(); // Initialize log files, logging system, return false on failure.
        virtual void initConsole() {}; // Initialize OS level debugging console.
        virtual bool initHardwareTest() { return true; } // A false result indicates the app should quit.

    virtual bool initParseCommandLine(LLCommandLineParser& clp) 
        { return true; } // Allow platforms to specify the command line args.
        
        virtual std::string generateSerialNumber() = 0; // Platforms specific classes generate this.


private:

        bool initThreads(); // Initialize viewer threads, return false on failure.
        bool initConfiguration(); // Initialize settings from the command line/config file.

        bool initCache(); // Initialize local client cache.
        void purgeCache(); // Clear the local cache. 

        void cleanupSavedSettings(); // Sets some config data to current or default values during cleanup.
        void removeCacheFiles(const char *filemask); // Deletes cached files the match the given wildcard.

        void writeSystemInfo(); // Write system info to "debug_info.log"

        bool anotherInstanceRunning(); 
        void initMarkerFile(); 
    
    void idle(); 
    void idleShutdown();
    void idleNetwork();

    void sendLogoutRequest();
    void disconnectViewer();

        // *FIX: the app viewer class should be some sort of singleton, no?
        // Perhaps its child class is the singleton and this should be an abstract base.
        static LLAppViewer* sInstance; 

    bool mSecondInstance; // Is this a second instance of the app?

        LLString mMarkerFileName;
        apr_file_t* mMarkerFile; // A file created to indicate the app is running.

        LLString mLogoutMarkerFileName;
        apr_file_t* mLogoutMarkerFile; // A file created to indicate the app is running.

        
        LLOSInfo mSysOSInfo; 
        S32 mCrashBehavior;
        bool mReportedCrash;

        // Thread objects.
        static LLTextureCache* sTextureCache; 
        static LLWorkerThread* sImageDecodeThread; 
        static LLTextureFetch* sTextureFetch;

        S32 mNumSessions;

        std::string mSerialNumber;
        bool mPurgeCache;
    bool mPurgeOnExit;

        bool mSavedFinalSnapshot;

    bool mQuitRequested;                                // User wants to quit, may have modified documents open.
    bool mLogoutRequestSent;                    // Disconnect message sent to simulator, no longer safe to send messages to the sim.
    S32 mYieldTime;
        LLSD mSettingsFileList;

        LLWatchdogTimeout* mMainloopTimeout;
};

// consts from viewer.h
const S32 AGENT_UPDATES_PER_SECOND  = 10;

// Globals with external linkage. From viewer.h
// *NOTE:Mani - These will be removed as the Viewer App Cleanup project continues.
//
// "// llstartup" indicates that llstartup is the only client for this global.

extern BOOL gHandleKeysAsync; // gSavedSettings used by llviewerdisplay.cpp & llviewermenu.cpp
extern LLString gDisabledMessage; // llstartup
extern BOOL gHideLinks; // used by llpanellogin, lllfloaterbuycurrency, llstartup
extern LLSD gDebugInfo;

extern BOOL     gAllowIdleAFK;
extern BOOL     gAllowTapTapHoldRun;
extern BOOL     gShowObjectUpdates;

extern BOOL gAcceptTOS;
extern BOOL gAcceptCriticalMessage;


typedef enum 
{
        LAST_EXEC_NORMAL = 0,
        LAST_EXEC_FROZE,
        LAST_EXEC_LLERROR_CRASH,
        LAST_EXEC_OTHER_CRASH,
        LAST_EXEC_LOGOUT_FROZE,
        LAST_EXEC_LOGOUT_CRASH
} eLastExecEvent;

extern eLastExecEvent gLastExecEvent; // llstartup

extern U32 gFrameCount;
extern U32 gForegroundFrameCount;

extern LLPumpIO* gServicePump;

// Is the Pacific time zone (aka server time zone)
// currently in daylight savings time?
extern BOOL gPacificDaylightTime;

extern U64      gFrameTime;                                     // The timestamp of the most-recently-processed frame
extern F32              gFrameTimeSeconds;                      // Loses msec precision after ~4.5 hours...
extern F32              gFrameIntervalSeconds;          // Elapsed time between current and previous gFrameTimeSeconds
extern F32              gFPSClamped;                                            // Frames per second, smoothed, weighted toward last frame
extern F32              gFrameDTClamped;
extern U64              gStartTime;

extern LLTimer gRenderStartTime;
extern LLFrameTimer gForegroundTime;

extern F32 gLogoutMaxTime;
extern LLTimer gLogoutTimer;

extern F32 gSimLastTime; 
extern F32 gSimFrames;

extern LLUUID gInventoryLibraryOwner;
extern LLUUID gInventoryLibraryRoot;

extern BOOL             gDisconnected;

// Map scale in pixels per region
extern F32 gMapScale;
extern F32 gMiniMapScale;

extern LLFrameTimer     gRestoreGLTimer;
extern BOOL                     gRestoreGL;
extern BOOL             gUseWireframe;

// VFS globals - gVFS is for general use
// gStaticVFS is read-only and is shipped w/ the viewer
// it has pre-cache data like the UI .TGAs
extern LLVFS    *gStaticVFS;

extern LLMemoryInfo gSysMemory;

extern LLString gLastVersionChannel;

extern LLVector3 gWindVec;
extern LLVector3 gRelativeWindVec;
extern U32      gPacketsIn;
extern BOOL gPrintMessagesThisFrame;

extern LLUUID gSunTextureID;
extern LLUUID gMoonTextureID;

extern BOOL gRandomizeFramerate;
extern BOOL gPeriodicSlowFrame;

#endif // LL_LLAPPVIEWER_H

---