Difference between revisions of "SimpleWebKit"

From GNUstepWiki
Jump to navigation Jump to search
(colorize sttus cells)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{Framework|
 +
shortdescription = A native web rendering engine, WebKit API compatible and drop-in replacement. |
 +
currentversion = [unreleased] |
 +
releasedate = not released yet |
 +
license = GPLv2+ |
 +
overview =  Native WebKit implementation. |
 +
features =
 +
|
 +
maintainer = * Nikolaus Schaller |
 +
relatedlinks =  QuantumSTEP: [http://www.quantum-step.com] |
 +
category = [[Category:Networking Frameworks]]
 +
}}
 
=== SimpleWebKit ===
 
=== SimpleWebKit ===
  
−
(for further editing)
+
== Background Information ==
  
 
* originated in mySTEP
 
* originated in mySTEP
−
* is completely written in Objective-C (1.0) so that it can be compiled on any system
+
* is completely written in Objective-C (1.0) so that it can be compiled on any system, even with gcc 2.95.3
 
* aims at providing the most popular documented methods of Full WebKit for the classes WebView, WebFrame, WebDataSource, etc.
 
* aims at providing the most popular documented methods of Full WebKit for the classes WebView, WebFrame, WebDataSource, etc.
 
* aims at rendering (X)HTML as well as possible (but not perfectly)
 
* aims at rendering (X)HTML as well as possible (but not perfectly)
−
* is work in heavy progress - so expect larger changes throughout the whole project
+
* uses NSAttributedStrings passed into NSTextView as the rendering backend
 +
* already displays many pages
 
* is used in the [[Vespucci.app]] Web Browser application for GNUstep
 
* is used in the [[Vespucci.app]] Web Browser application for GNUstep
 +
 +
== Source Code ==
 +
 +
svn co http://svn.gna.org/svn/gnustep/libs/simplewebkit/trunk
 +
 +
svn+ssh://user@svn.gna.org/svn/gnustep/libs/simplewebkit/trunk
 +
 +
http://svn.gna.org/viewcvs/gnustep/libs/simplewebkit/trunk
 +
 +
== How to compile ==
 +
 +
  mkdir SWK
 +
  cd SWK
 +
  svn co http://svn.gna.org/svn/gnustep/libs/simplewebkit/trunk
 +
  cd trunk
 +
  make
  
 
== Status ==
 
== Status ==
  
−
Features of the code in SVN trunk:
+
{| border="1"
 +
|+ Web Standards
 +
!
 +
! Status
 +
! Notes
 +
|-
 +
| Cookies
 +
|
 +
|
 +
|-
 +
|CSS1
 +
|
 +
|
 +
|-
 +
|CSS2
 +
|
 +
|
 +
|-
 +
|HTML4
 +
|
 +
|
 +
|-
 +
|HTML5
 +
|
 +
|
 +
|-
 +
|HTTP 1.1
 +
|
 +
|
 +
|-
 +
|HTTP Authentication
 +
|
 +
|
 +
|-
 +
|HTTPS
 +
|
 +
|
 +
|-
 +
|JavaScript
 +
|
 +
|Parsing relatively complete. Engine not working.
 +
|-
 +
|}
 +
 
 +
 
 +
{| border="1"
 +
|+ Important HTML features
 +
!
 +
!Status
 +
!Notes
 +
|-
 +
|Forms
 +
|style="background:orange" |
 +
|Basic form elements (fieds, buttons) work.
 +
|-
 +
|Frames
 +
|style="background:orange" | Basic
 +
| Basic frames work.
 +
|+
 +
|Image maps
 +
|
 +
|
 +
|-
 +
| Lists
 +
|style="background:orange" |
 +
| Parsed, displayed, not formatted correctly. Ordered lists do not count.
 +
|-
 +
|Tables
 +
|style="background:red" |
 +
|Partially supported only on Cocoa. Formatting is rough. GNUstep and myStep lack support.
 +
|}
 +
 
 +
{| border="1"
 +
|+ CSS
 +
! !! Status !! Notes
 +
|-
 +
|@import || ||
 +
|-
 +
|Selectors || ||
 +
|-
 +
|background-attachment || ||
 +
|+
 +
|background-color || ||
 +
|+
 +
|background-image || ||
 +
|+
 +
|background-position || ||
 +
|+
 +
|background-repeat || ||
 +
|+
 +
|background (shorthand) || ||
 +
|+
 +
|border-collapse || ||
 +
|+
 +
|border-color || ||
 +
|+
 +
|border-spacing || ||
 +
|+
 +
|border-style || ||
 +
|+
 +
|border-[top|right|bottom|left] || ||
 +
|+
 +
|border-*-color || ||
 +
|+
 +
|border-*-style || ||
 +
|+
 +
|border-*-width || ||
 +
|+
 +
|bottom
 +
|+
 +
|}
 +
Features of the Subversion (SVN) trunk code:
 
* parses (X)HTML into a DOM tree
 
* parses (X)HTML into a DOM tree
−
* renders approx. 50% of the HTML 4.0 tags in a reasonable way (e.g. < font color="#667788">, < center>, < h2>, works)
+
* renders approx. 98% of the HTML 4.0 tags in a reasonable way (e.g. < font color="#667788">, < center>, < h2>, works)
 
* makes <a> links clickable and processes them
 
* makes <a> links clickable and processes them
−
* loads <img>, is prepared  for<script> etc. i.e. loads them as subresources
+
* loads <img>
−
* is prepared to handle <frame>
+
* loads <script> etc. asynchronously i.e. loads them as subresources
−
* is prepared to handle <form>
+
* loads CSS etc. asynchronously i.e. loads them as subresources
−
* has a ECMAScript engine that parses 90% of the syntax and evaluates expressions (missing are Statements and the native Objects incl. "document", "window", "event" etc.)
+
* handles <frame>
 +
* handles <form>
 +
* handles < table > (if the NSTextView backend can handle)
 +
* has an ECMAScript engine that parses 90% of the syntax and evaluates expressions (missing are Statements and the native Objects including "document", "window", "event" etc.)
  
 
Missing:
 
Missing:
−
* properly handle < table>, < ul> etc.
 
−
* really process forms and POST results
 
 
* properly compile and run <script>
 
* properly compile and run <script>
−
* completion of ECMAScript engine
+
* completion of the ECMAScript engine
−
* all CSS processing
+
* properly parse and apply CSS
  
−
== SWK Browser (running on MacOS X 10.4) ==
+
== SWK Browser ==
  
 
SWK Browser is part of the SimpleWebKit project and more or less a test bed for it, although it has most features of a full browser.
 
SWK Browser is part of the SimpleWebKit project and more or less a test bed for it, although it has most features of a full browser.
Line 39: Line 180:
 
* has a JavaScript console
 
* has a JavaScript console
 
   
 
   
−
We have also compiled Simple WebKit and SWK Browser against Cocoa so that it runs natively on a Mac.
+
We have compiled Simple WebKit and SWK Browser with Cocoa so that it runs natively on a Mac.
 +
 
 +
SWK Browser has been ported to GNUstep as well and runs using NIB loading without any additional code change.
  
−
Download this here: [http://www.quantum-step.com/download/SWKBrowser.app.zip]
+
Download it here: [http://www.quantum-step.com/download/SWKBrowser.app.zip]
  
 
== Screenshots ==
 
== Screenshots ==
  
−
Some first screen shots (made from SWK Browser)
+
Some first screen shots (made from SWK Browser on a Mac)
  
 
[[Image:SimpleWebKit_Example_1.png]]
 
[[Image:SimpleWebKit_Example_1.png]]
Line 69: Line 212:
 
* it provides an estimated content length (for a progress indicator) and the MIMEType of the incoming data stream
 
* it provides an estimated content length (for a progress indicator) and the MIMEType of the incoming data stream
 
* as soon as the header comes in a WebDocomentRepresentation is created and incoming segments are notified
 
* as soon as the header comes in a WebDocomentRepresentation is created and incoming segments are notified
−
* it also collects the incoming data, so that a WebDocomentRepresentation can handle either segments or the collected data
+
* it also collects the incoming data, so that a WebDocumentRepresentation can handle either segments or the collected data
  
 
4. the WebDocumentRepresentation(s)
 
4. the WebDocumentRepresentation(s)
Line 78: Line 221:
 
* so, if you want to handle an additional MIME type, write a class that conforms to the WebDocumentRepresentation protocol
 
* so, if you want to handle an additional MIME type, write a class that conforms to the WebDocumentRepresentation protocol
  
−
5. the DOMHTMLTree
+
5. NSXMLParser
−
* is only for HTML content
+
* a private variant is used that adds a stalling mechanism and selection of the file encoding
−
* is (re)built each time a new segment of HTML data comes in
+
* recognizes the <?xml> tag for XHTML and has a lazy mode for pure HTML
 +
* it also has an Entity table that translates the HTML entities to character strings
 +
 
 +
6. the DOMHTMLTree
 +
* is used only for HTML content
 +
* is built in WebHTMLDocumentRepresentation by parsing segment of HTML data coming in
 
* any change in the DOMHTMLTree is notified to the WebDocumentView (or one of its subviews) by setNeedsLayout
 
* any change in the DOMHTMLTree is notified to the WebDocumentView (or one of its subviews) by setNeedsLayout
 +
* each class of potential DOMHTMLTree records has methods to denote how to handle tags
 +
* the tag to class mapping is table driven
  
−
6. the WebDocumentView(s) an its subviews
+
7. the WebDocumentView(s) an its subviews
 
* are responsible for displaying the contents of its WebDataRepresentation
 
* are responsible for displaying the contents of its WebDataRepresentation
 
* either HTML, Images, PDF or whatever (e.g. SVG, XML, ...)
 
* either HTML, Images, PDF or whatever (e.g. SVG, XML, ...)
Line 91: Line 241:
 
* for HTML, we do a simple trick: the WebDocumentView is an NSTextView and the DOMHTMLTree objects can be traversed to return an attributedString with embedded Tables and NSTextAttachments
 
* for HTML, we do a simple trick: the WebDocumentView is an NSTextView and the DOMHTMLTree objects can be traversed to return an attributedString with embedded Tables and NSTextAttachments
  
−
7. the JavaScript engine
+
8. the JavaScript engine
 
* is programmed according to the specificaion of [[http://www.ecma-international.org/publications/standards/Ecma-262.htm] ECMA-262]
 
* is programmed according to the specificaion of [[http://www.ecma-international.org/publications/standards/Ecma-262.htm] ECMA-262]
 
* uses a simple recursive stateless parser (could be optimized in stack useage and speed by a state-table driven approach)
 
* uses a simple recursive stateless parser (could be optimized in stack useage and speed by a state-table driven approach)
Line 99: Line 249:
 
* uses Foundation for basic types (string, number, boolean, null)
 
* uses Foundation for basic types (string, number, boolean, null)
 
* uses WebScriptObject as the base Object representation
 
* uses WebScriptObject as the base Object representation
−
* DOMObjects are a subclass of WebScriptObjects and therefore provide bridging, so that changing a DOMHTML tree element through JavaScript automativally triggers the appropriate WebDocumentView notification
+
* DOMObjects are a subclass of WebScriptObjects and therefore provide bridging, so that changing a DOMHTML tree element through JavaScript automatically triggers the appropriate WebDocumentView update notification
 +
 
 +
9. the CSS engine
 +
* CSS style sheets are translated into a DOMCSS tree
 +
* @import ed sheets are loaded as needed
 +
* the CSS is not yet applied to the HTML -> NSAttributedString translation

Latest revision as of 09:45, 24 February 2012

A native web rendering engine, WebKit API compatible and drop-in replacement.

Current Version: [unreleased]

  • Released: not released yet
  • Licensed: GPLv2+

Overview

Native WebKit implementation.

Features

Maintainer

  • Nikolaus Schaller

Related Links

QuantumSTEP: [1]


SimpleWebKit

Background Information

  • originated in mySTEP
  • is completely written in Objective-C (1.0) so that it can be compiled on any system, even with gcc 2.95.3
  • aims at providing the most popular documented methods of Full WebKit for the classes WebView, WebFrame, WebDataSource, etc.
  • aims at rendering (X)HTML as well as possible (but not perfectly)
  • uses NSAttributedStrings passed into NSTextView as the rendering backend
  • already displays many pages
  • is used in the Vespucci.app Web Browser application for GNUstep

Source Code

svn co http://svn.gna.org/svn/gnustep/libs/simplewebkit/trunk

svn+ssh://user@svn.gna.org/svn/gnustep/libs/simplewebkit/trunk

http://svn.gna.org/viewcvs/gnustep/libs/simplewebkit/trunk

How to compile

 mkdir SWK
 cd SWK
 svn co http://svn.gna.org/svn/gnustep/libs/simplewebkit/trunk
 cd trunk
 make

Status

Web Standards
Status Notes
Cookies
CSS1
CSS2
HTML4
HTML5
HTTP 1.1
HTTP Authentication
HTTPS
JavaScript Parsing relatively complete. Engine not working.


Important HTML features
Status Notes
Forms Basic form elements (fieds, buttons) work.
Frames Basic Basic frames work.
Image maps
Lists Parsed, displayed, not formatted correctly. Ordered lists do not count.
Tables Partially supported only on Cocoa. Formatting is rough. GNUstep and myStep lack support.
CSS
Status Notes
@import
Selectors
background-attachment
background-color
background-image
background-position
background-repeat
background (shorthand)
border-collapse
border-color
border-spacing
border-style
right|bottom|left]
border-*-color
border-*-style
border-*-width
bottom

Features of the Subversion (SVN) trunk code:

  • parses (X)HTML into a DOM tree
  • renders approx. 98% of the HTML 4.0 tags in a reasonable way (e.g. < font color="#667788">, < center>, < h2>, works)
  • makes <a> links clickable and processes them
  • loads <img>
  • loads <script> etc. asynchronously i.e. loads them as subresources
  • loads CSS etc. asynchronously i.e. loads them as subresources
  • handles <frame>
  • handles <form>
  • handles < table > (if the NSTextView backend can handle)
  • has an ECMAScript engine that parses 90% of the syntax and evaluates expressions (missing are Statements and the native Objects including "document", "window", "event" etc.)

Missing:

  • properly compile and run <script>
  • completion of the ECMAScript engine
  • properly parse and apply CSS

SWK Browser

SWK Browser is part of the SimpleWebKit project and more or less a test bed for it, although it has most features of a full browser. These are

  • multiple documents
  • shows (X)HTML, Images etc.
  • can show page source code
  • can show activities (i.e. subresources)
  • can show a DOM Tree inspector
  • has a JavaScript console

We have compiled Simple WebKit and SWK Browser with Cocoa so that it runs natively on a Mac.

SWK Browser has been ported to GNUstep as well and runs using NIB loading without any additional code change.

Download it here: [2]

Screenshots

Some first screen shots (made from SWK Browser on a Mac)

File:SimpleWebKit Example 1.png

How it Works

1. the WebView

  • is the master view object and there is only one per browser (or browser tab)
  • it holds the mainFrame which represents either the normal <body> or the top level <frame> or <frameset>
  • if there is a <frameset> hierarchy, there are additional child WebFrames

2. the WebFrame

  • is repsonsible for loading and rendering content from a specific URL
  • it uses a WebDataSource to trigger loading and get callbacks
  • it is also the owner of the DOMDocument tree
  • JavaScript statements are evaluated in a frame context
  • it is also the target of user clicks on links since it knows the base URL (through the WebDataSource)

3. the WebDataSource

  • is responsible for loading data from an URL
  • it may cache data and handle/synchronize loading fo subresources (e.g. for an embedded <img> tag)
  • it translates the request and the response URLs
  • it provides an estimated content length (for a progress indicator) and the MIMEType of the incoming data stream
  • as soon as the header comes in a WebDocomentRepresentation is created and incoming segments are notified
  • it also collects the incoming data, so that a WebDocumentRepresentation can handle either segments or the collected data

4. the WebDocumentRepresentation(s)

  • there is one for each MIME type (the WebView provides a mapping database)
  • it is responsible for parsing the incoming data stream (either completely when finished, or partially)
  • and provide a better suitable representation, e.g. an NSImage or a DOMHTMLTree
  • finally, it creates a WebDocumentView as the child of the WebView and attaches it to the WebFrame as the -webFrameView
  • so, if you want to handle an additional MIME type, write a class that conforms to the WebDocumentRepresentation protocol

5. NSXMLParser

  • a private variant is used that adds a stalling mechanism and selection of the file encoding
  • recognizes the <?xml> tag for XHTML and has a lazy mode for pure HTML
  • it also has an Entity table that translates the HTML entities to character strings

6. the DOMHTMLTree

  • is used only for HTML content
  • is built in WebHTMLDocumentRepresentation by parsing segment of HTML data coming in
  • any change in the DOMHTMLTree is notified to the WebDocumentView (or one of its subviews) by setNeedsLayout
  • each class of potential DOMHTMLTree records has methods to denote how to handle tags
  • the tag to class mapping is table driven

7. the WebDocumentView(s) an its subviews

  • are responsible for displaying the contents of its WebDataRepresentation
  • either HTML, Images, PDF or whatever (e.g. SVG, XML, ...)
  • they gets notified about changes either by updates of the WebDataSource (-dadaSourceUpdated:) or directly (-setNeedsLayout:)
  • if one needs layout, it must go to the DOM Tree to find out what has changed and update its size, content, children, layout etc.
  • this is a little tricky/risky since the -layout method is called within -drawRect: - so changing e.g. the View frame is very critical and may result in drawing glitches
  • for HTML, we do a simple trick: the WebDocumentView is an NSTextView and the DOMHTMLTree objects can be traversed to return an attributedString with embedded Tables and NSTextAttachments

8. the JavaScript engine

  • is programmed according to the specificaion of [[3] ECMA-262]
  • uses a simple recursive stateless parser (could be optimized in stack useage and speed by a state-table driven approach)
  • parses the script into a Tree representation in a first step
  • then, evaluates the expressions and statements according to the current environement
  • this allows to store scripts in translated form and reevaluate them when needed (e.g. on mouse events)
  • uses Foundation for basic types (string, number, boolean, null)
  • uses WebScriptObject as the base Object representation
  • DOMObjects are a subclass of WebScriptObjects and therefore provide bridging, so that changing a DOMHTML tree element through JavaScript automatically triggers the appropriate WebDocumentView update notification

9. the CSS engine

  • CSS style sheets are translated into a DOMCSS tree
  • @import ed sheets are loaded as needed
  • the CSS is not yet applied to the HTML -> NSAttributedString translation
Retrieved from "https://mediawiki.gnustep.org/index.php?title=SimpleWebKit&oldid=6306"