Crossfire 0.3a5 Migration

From FirebugWiki

(Difference between revisions)
Jump to: navigation, search
m
m (Replaced content with "#REDIRECT [https://github.com/firebug-crossfire/crossfire/wiki/Crossfire-0.3a4-to-0.3a5-migration 0.3a5 Migration on Github]")
 
(42 intermediate revisions not shown)
Line 1: Line 1:
-
During 0.3a5 development there was a lot of work done to make the protocol more consistent and coherent, as expected, this work brought with it many changes to the protocol and a few changes that are no longer compatible with existing versions of Crossfire.
+
#REDIRECT [https://github.com/firebug-crossfire/crossfire/wiki/Crossfire-0.3a4-to-0.3a5-migration 0.3a5 Migration on Github]
-
 
+
-
This guide will help ease the transition from using a pre-0.3a5 version of Crossfire, with each affected protocol entity described in its own following section.
+
-
 
+
-
=== onScript ===
+
-
 
+
-
The <code>onScript</code> event has been updated to return attributes with consistent names and the meta-data about the script that was loaded.
+
-
:
+
-
The related work item is: [http://code.google.com/p/fbug/issues/detail?id=3476 Issue 3476]
+
-
:
+
-
'''Action Required'''
+
-
:
+
-
The following changes require clients to discontinue using two removed attributes; <code>href</code> and <code>context_href</code> and begin using the new <code>script</code> object.
+
-
:
+
-
'''Details'''
+
-
:
+
-
In the pre-0.3a5 versions of Crossfire the <code>onScript</code> event had the following form:
+
-
:
+
-
<source lang="javascript">
+
-
Content-Length:192
+
-
\r\n\r\n
+
-
{
+
-
  "type":"event",
+
-
  "event":"onScript",
+
-
  "context_id":"xf0.3::8127620",
+
-
  "body":{
+
-
          "context_href":"http://www.google.ca/advanced_search?hl=en/4",
+
-
          "href":"http://www.google.ca/advanced_search?hl=en"
+
-
        }
+
-
}
+
-
</source>
+
-
:
+
-
The following has changed:
+
-
* the <code>body</code> object no longer contains an <code>href</code> or <code>context_href</code> entry
+
-
* the <code>body</code> object now contains the <code>script</code> meta-data object, identical to what is returned via a [[Crossfire_Protocol_Reference#script|script]] request with no included source.
+
-
:
+
-
New event form:
+
-
:
+
-
<source lang="javascript">
+
-
Content-Length:631
+
-
\r\n\r\n
+
-
{
+
-
  "seq":10,
+
-
  "type":"event",
+
-
  "event":"onScript",
+
-
  "context_id":"xf0.3::2531266",
+
-
  "data":{
+
-
          "script": {
+
-
                      "id":"http://www.google.ca/advanced_search?hl=en",
+
-
                      "lineOffset":0,
+
-
                      "columnOffset":0,
+
-
                      "sourceStart":"(function()\u000a",
+
-
                      "sourceLength":311,
+
-
                      "lineCount":311,
+
-
                      "compilationType":"top-level"
+
-
                    }
+
-
          }
+
-
}
+
-
</source>
+
-
:
+
-
The values and kinds of the <code>script</code> object are as follows:
+
-
:
+
-
{| border="1" cellpadding="5" cellspacing="0"
+
-
|-
+
-
| <code>id</code> || a String identifier for the script - never null
+
-
|-
+
-
| <code>lineOffset</code> || a Number representing the line offset of the script - never less than 0
+
-
|-
+
-
| <code>columnOffset</code> || a Number representing the column offset of the script - never less than 0
+
-
|-
+
-
| <code>sourceStart</code> || a String representing the first line of source in the script - never null
+
-
|-
+
-
| <code>sourceLength</code> || a Number representing the entire length of the source of the script - never less than 0
+
-
|-
+
-
| <code>lineCount</code> || a Number representing the total number of lines of source in the script - never less than 0
+
-
|-
+
-
| <code>compilationType</code> || a String describing the kind of the script - see [http://code.google.com/p/fbug/source/browse/branches/firebug1.7/content/firebug/sourceFile.js sourceFile.js] for complete listing of types
+
-
|}
+
-
:
+

Latest revision as of 03:02, 15 May 2012

  1. REDIRECT 0.3a5 Migration on Github
Personal tools