Second Life viewer sources 1.19.1.0

1 files changed, 123 insertions, 65 deletions

diff --git a/linden/libraries/include/llmozlib.h b/linden/libraries/include/llmozlib2.h
index 647820b..1dd71dc 100644
--- a/linden/libraries/include/llmozlib.h
+++ b/linden/libraries/include/llmozlib2.h
@@ -1,33 +1,40 @@
-/**
- * @file llmozlib.h
- * @brief Linden Lab Mozilla wrapper.
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  *
- * $LicenseInfo:firstyear=2006&license=viewergpl$
- * 
- * Copyright (c) 2006-2008, Linden Research, Inc.
- * 
- * Second Life Viewer Source Code
- * The source code in this file ("Source Code") is provided by Linden Lab
- * to you under the terms of the GNU General Public License, version 2.0
- * ("GPL"), unless you have obtained a separate licensing agreement
- * ("Other License"), formally executed by you and Linden Lab.  Terms of
- * the GPL can be found in doc/GPL-license.txt in this distribution, or
- * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
- * 
- * There are special exceptions to the terms and conditions of the GPL as
- * it is applied to this Source Code. View the full text of the exception
- * in the file doc/FLOSS-exception.txt in this software distribution, or
- * online at http://secondlifegrid.net/programs/open_source/licensing/flossexception
- * 
- * By copying, modifying or distributing this software, you acknowledge
- * that you have read and understood your obligations described above,
- * and agree to abide by those obligations.
- * 
- * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
- * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
- * COMPLETENESS OR PERFORMANCE.
- * $/LicenseInfo$
- */
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is Linden Lab Inc. (http://lindenlab.com) code.
+ *
+ * The Initial Developer of the Original Code is:
+ *   Callum Prentice (callum@ubrowser.com)
+ *
+ * Portions created by the Initial Developer are Copyright (C) 2006
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *  Callum Prentice (callum@ubrowser.com)
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
 
 #ifndef LLMOZLIB_H
 #define LLMOZLIB_H
@@ -43,23 +50,48 @@ class LLEmbeddedBrowserWindow;
 class LLEmbeddedBrowserWindowEvent
 {
         public:
-                LLEmbeddedBrowserWindowEvent( int eventWindowIdIn ) :
-                        mEventWindowId( eventWindowIdIn )
+                LLEmbeddedBrowserWindowEvent( int eventWindowIdIn, std::string uriIn ) :
+                        mEventWindowId( eventWindowIdIn ),
+                        mEventUri( uriIn )
                 {
                 };
 
-                LLEmbeddedBrowserWindowEvent( int eventWindowIdIn, int intValIn ) :
+                // single int passed with the event - e.g. progress
+                LLEmbeddedBrowserWindowEvent( int eventWindowIdIn, std::string uriIn, int intValIn ) :
                         mEventWindowId( eventWindowIdIn ),
+                        mEventUri( uriIn ),
                         mIntVal( intValIn )
                 {
                 };
 
-                LLEmbeddedBrowserWindowEvent( int eventWindowIdIn, std::string stringValIn ) :
+                // string passed with the event
+                LLEmbeddedBrowserWindowEvent( int eventWindowIdIn, std::string uriIn, std::string stringValIn ) :
                         mEventWindowId( eventWindowIdIn ),
+                        mEventUri( uriIn ),
                         mStringVal( stringValIn )
                 {
                 };
 
+                // string and an int passed with the event
+                LLEmbeddedBrowserWindowEvent( int eventWindowIdIn, std::string uriIn, std::string stringValIn, int intValIn ) :
+                        mEventWindowId( eventWindowIdIn ),
+                        mEventUri( uriIn ),
+                        mStringVal( stringValIn ),
+                        mIntVal( intValIn )
+                {
+                };
+
+                // 4 ints passed (semantically as a rectangle but could be anything - didn't want to make a RECT type structure)
+                LLEmbeddedBrowserWindowEvent( int eventWindowIdIn, std::string uriIn, int xIn, int yIn, int widthIn, int heightIn ) :
+                        mEventWindowId( eventWindowIdIn ),
+                        mEventUri( uriIn ),
+                        mXVal( xIn ),
+                        mYVal( yIn ),
+                        mWidthVal( widthIn ),
+                        mHeightVal( heightIn )
+                {
+                };
+
                 virtual ~LLEmbeddedBrowserWindowEvent()
                 {
                 };
@@ -69,6 +101,11 @@ class LLEmbeddedBrowserWindowEvent
                         return mEventWindowId;
                 };
 
+                std::string getEventUri() const
+                {
+                        return mEventUri;
+                };
+
                 int getIntValue() const
                 {
                         return mIntVal;
@@ -79,31 +116,45 @@ class LLEmbeddedBrowserWindowEvent
                         return mStringVal;
                 };
 
+                void getRectValue( int& xOut, int& yOut, int& widthOut, int& heightOut ) const
+                {
+                        xOut = mXVal;
+                        yOut = mYVal;
+                        widthOut = mWidthVal;
+                        heightOut = mHeightVal;
+                };
+
         private:
                 int mEventWindowId;
+                std::string mEventUri;
                 int mIntVal;
                 std::string mStringVal;
+                int mXVal;
+                int mYVal;
+                int mWidthVal;
+                int mHeightVal;
 };
 
 ////////////////////////////////////////////////////////////////////////////////
-// Override these methods to observe browser events
+// derrive from this class and override these methods to observe these events
 class LLEmbeddedBrowserWindowObserver
 {
         public:
                 virtual ~LLEmbeddedBrowserWindowObserver() { };
-
                 typedef LLEmbeddedBrowserWindowEvent EventType;
+
+                virtual void onPageChanged( const EventType& eventIn ) { };
                 virtual void onNavigateBegin( const EventType& eventIn ) { };
                 virtual void onNavigateComplete( const EventType& eventIn ) { };
                 virtual void onUpdateProgress( const EventType& eventIn ) { };
                 virtual void onStatusTextChange( const EventType& eventIn ) { };
                 virtual void onLocationChange( const EventType& eventIn ) { };
                 virtual void onClickLinkHref( const EventType& eventIn ) { };
-                virtual void onClickLinkSecondLife( const EventType& eventIn ) { };
+                virtual void onClickLinkNoFollow( const EventType& eventIn ) { };
 };
 
 ////////////////////////////////////////////////////////////////////////////////
-//
+// main library class
 class LLMozLib
 {
         public:
@@ -113,30 +164,31 @@ class LLMozLib
                 static LLMozLib* getInstance();
 
                 // housekeeping
-                bool init( std::string applicationDirIn, std::string componentDirIn, std::string profileDirIn );
+                bool init( std::string applicationDir, std::string componentDir, std::string profileDir, void* nativeWindowHandleIn );
                 bool reset();
-                bool enableProxy( bool proxyEnabledIn, std::string proxyHostNameIn, int proxyPortIn );
                 bool clearCache();
-                bool enableCookies( bool enabledIn );
-                bool clearAllCookies();
-                bool enablePlugins( bool enabledIn );
                 int getLastError();
                 const std::string getVersion();
                 void setBrowserAgentId( std::string idIn );
+                bool enableProxy( bool proxyEnabledIn, std::string proxyHostNameIn, int proxyPortIn );
+                bool enableCookies( bool enabledIn );
+                bool clearAllCookies();
+                bool enablePlugins( bool enabledIn );
 
-                // browser window
-                int createBrowserWindow( void* nativeWindowHandleIn, int browserWindowWidthIn, int browserWindowHeightIn );
+                // browser window - creation/deletion, mutation etc.
+                int createBrowserWindow( int browserWindowWidthIn, int browserWindowHeightIn );
                 bool destroyBrowserWindow( int browserWindowIdIn );
                 bool setSize( int browserWindowIdIn, int widthIn, int heightIn );
                 bool scrollByLines( int browserWindowIdIn, int linesIn );
-                void setBackgroundColor( int browserWindowIdIn, int redIn, int greenIn, int blueIn );
+                bool setBackgroundColor( int browserWindowIdIn, const int redIn, const int greenIn, const int blueIn );
                 bool setCaretColor( int browserWindowIdIn, const int redIn, const int greenIn, const int blueIn );
+                bool setEnabled( int browserWindowIdIn, bool enabledIn );
 
-                // observer interface
+                // add/remove yourself as an observer on browser events - see LLEmbeddedBrowserWindowObserver declaration
                 bool addObserver( int browserWindowIdIn, LLEmbeddedBrowserWindowObserver* subjectIn );
                 bool remObserver( int browserWindowIdIn, LLEmbeddedBrowserWindowObserver* subjectIn );
 
-                // navigation
+                // navigation - self explanatory
                 bool navigateTo( int browserWindowIdIn, const std::string uriIn );
                 bool navigateStop( int browserWindowIdIn );
                 bool canNavigateBack( int browserWindowIdIn );
@@ -144,39 +196,45 @@ class LLMozLib
                 bool canNavigateForward( int browserWindowIdIn );
                 bool navigateForward( int browserWindowIdIn );
 
+                // javascript access/control
+                std::string evaluateJavascript( int browserWindowIdIn, const std::string scriptIn );
+
                 // set/clear URL to redirect to when a 404 page is reached
                 bool set404RedirectUrl( int browser_window_in, std::string redirect_url );
                 bool clr404RedirectUrl( int browser_window_in );
 
                 // access to rendered bitmap data
-                const unsigned char* grabBrowserWindow( int browserWindowIdIn );
-                const unsigned char* getBrowserWindowPixels( int browserWindowIdIn );
-                const int getBrowserWidth( int browserWindowIdIn );
-                const int getBrowserHeight( int browserWindowIdIn );
-                const int getBrowserDepth( int browserWindowIdIn );
-                const int getBrowserRowSpan( int browserWindowIdIn );
+                const unsigned char* grabBrowserWindow( int browserWindowIdIn );                // renders page to memory and returns pixels
+                const unsigned char* getBrowserWindowPixels( int browserWindowIdIn );   // just returns pixels - no render
+                const bool flipWindow( int browserWindowIdIn, bool flipIn );                    // optionally flip window (pixels) you get back
+                const int getBrowserWidth( int browserWindowIdIn );                                             // current browser width (can vary slightly after page is rendered)
+                const int getBrowserHeight( int browserWindowIdIn );                                    // current height
+                const int getBrowserDepth( int browserWindowIdIn );                                             // depth in bytes
+                const int getBrowserRowSpan( int browserWindowIdIn );                                   // width in pixels * depth in bytes
 
                 // mouse/keyboard interaction
-                bool mouseDown( int browserWindowIdIn, int xPosIn, int yPosIn );
-                bool mouseUp( int browserWindowIdIn, int xPosIn, int yPosIn );
-                
-                // send a mouse left button double click to a browser window at given XY in browser space
-                bool mouseLeftDoubleClick( int browserWindowIdIn, int xPosIn, int yPosIn );
-                
-                bool mouseMove( int browserWindowIdIn, int xPosIn, int yPosIn );
-                bool keyPress( int browserWindowIdIn, int keyCodeIn );
-                bool unicodeInput ( int browserWindowIdIn, unsigned long uni_char );
-                bool focusBrowser( int browserWindowIdIn, bool focusBrowserIn );
+                bool mouseDown( int browserWindowIdIn, int xPosIn, int yPosIn );                        // send a mouse down event to a browser window at given XY in browser space
+                bool mouseUp( int browserWindowIdIn, int xPosIn, int yPosIn );                          // send a mouse up event to a browser window at given XY in browser space
+                bool mouseMove( int browserWindowIdIn, int xPosIn, int yPosIn );                        // send a mouse move event to a browser window at given XY in browser space
+                bool mouseLeftDoubleClick( int browserWindowIdIn, int xPosIn, int yPosIn );     // send a mouse left button double click to a browser window at given XY in browser space
+                bool keyPress( int browserWindowIdIn, int keyCodeIn );                                          // send a key press event to a browser window
+                bool unicodeInput ( int browserWindowIdIn, unsigned long uni_char );            // send a unicode keypress event to a browser window
+                bool focusBrowser( int browserWindowIdIn, bool focusBrowserIn );                        // set/remove focus to given browser window
+
+                // accessor/mutator for scheme that browser doesn't follow - e.g. secondlife.com://
+                void setNoFollowScheme( int browserWindowIdIn, std::string schemeIn );
+                std::string getNoFollowScheme( int browserWindowIdIn );
 
         private:
                 LLMozLib();
                 LLEmbeddedBrowserWindow* getBrowserWindowFromWindowId( int browserWindowIdIn );
                 static LLMozLib* sInstance;
                 const int mMaxBrowserWindows;
-                LLEmbeddedBrowserWindow** mBrowserWindowList;
+                typedef std::map< int, LLEmbeddedBrowserWindow* > BrowserWindowMap;
+                typedef std::map< int, LLEmbeddedBrowserWindow* >::iterator BrowserWindowMapIter;
+                BrowserWindowMap mBrowserWindowMap;
 };
 
-
 // Mozilla virtual keycodes.
 // We don't want to suck in Mozilla headers so we copy these consts
 // from nsIDOMKeyEvent.idl.