CSC/ECE 517 Spring 2016/Implement Common Parts of the CSSOM API
Introduction
Cascading Style Sheets (CSS) is a style sheet language used for describing the presentation of a document written in a markup language. Although most often used to set the visual style of web pages and user interfaces written in HTML and XHTML, the language can be applied to any XML document, including plain XML, SVG and XUL, and is applicable to rendering in speech, or on other media. Along with HTML and JavaScript, CSS is a cornerstone technology used by most websites to create visually engaging webpages, user interfaces for web applications, and user interfaces for many mobile applications
CSSOM
CSSOM (CSS object model) defines APIs (including generic parsing and serialization rules) for media queries, selectors, and CSS itself. The core features of the CSSOM are oriented towards providing basic capabilities to author-defined scripts to permit access to and manipulation of style related state information and processes.
Rust
We can organize different languages on a spectrum with control on one end and safety on the other. Languages like C and C++ fall on the end of the side of control, where as on the other side we have languages like Javascript, Ruby, Python, etc. What Rust does is stepping off this line. What it does is not a tradeoff between control and safety, but it provides you both the low level of control found in C and C++, and the high level of safety in JavaScript and Python. The three concepts that distinguish rust from other programming languages are: Ownership, Borrowing and lifetime. Ownership is how Rust achieves its largest goal, memory safety.<ref>https://en.wikipedia.org/wiki/Rust_(programming_language)</ref>
Servo
Servo is a project in Mozilla research to write a parallel layout engine in Rust. It aims to achieve better parallelism, security, modularity and performance. Servo is built with Cargo, the rust package manager. It currently supports 64bit OSX, 64bit Linux, Android, and Gonk(Firefox OS).<ref>https://servo.org</ref>
Project Description
The project is to go through the following steps in a somewhat linear order:
- Compiling servo on a machine and making sure it runs on a specific url. Then emailing the mozilla mailing list to introduce the group.
- Creating a StyleSheet interface which represents an abstract, base style sheet. This creation requires a couple of steps :
- Adding a new IDL file (which contains specifications)
- Creating the Rust file which has implementations of the things specified in IDL.
- Listing the Rust file in mod.rs file.
- After that comes the creation of a StyleSheetList interface. Which represents an ordered collection of CSS style sheets. And basically because it's another interface, again the .webidl and .rs files need to be implemented.
- Adding the attribute
stylesheets
to theDocument.webidl
. - In the three steps just mentioned some guidelines about implementation must be followed, like the return types of certain methods.
- Run the tests specified by the mozilla team.
- Finally updating the interfaces.html, and adding the new interface names.
The Subsequent steps are:
- to make the
stylesheets
member ofDocument
store the associatedElement
along with the actualStylesheet
. Add a member toStyleSheet
for the associated element, and implement theownerNode
attribute ofStyleSheet
using this. - create the CSSStyleSheet interface, containing an
Arc<Stylesheet>
member. Add a method toDocument
that returns a newCSSStyleSheet
instance for a particular index in thestylesheets
member. - create the CSSRule interface.
- create the CSSRuleList interface and implement
CSSStyleSheet.cssRules
. - implement the
insertRule
anddeleteRule
methods ofCSSStyleSheet
by making therules
member of theStylesheet
type contain a RefCell, and using this to mutate the contents of the vector. - create the CSSStyleRule interface and make
cssRules
returnCSSStyleRule
values for appropriate rules.
Implementation
Initial Steps
The following steps were followed to meet the project requirements as per this github page.
Step 1
We had to implement the StyleSheet interface for which we had to create two file: stylesheet.rs and StyleSheet.webidl and included stylesheet interface in the mod.rs file. In the StyleSheet interface we avoided the three methods: ownerNode, parentStyleSheet and media as they could not be trivially implemented and the instructions were clear to avoid such methods.
Step 2
We had to implement StyleSheetList interface for which we had to create two file: stylesheetlist.rs and StyleSheetList.webidl and included stylesheetlist interface in the mod.rs file. We used JS<Document> instead of [ArrayClass] as [ArrayClass] is not yet supported by Servo. In the StyleSheetList interface we did not implement the getter as we do not have a list of stylesheets/scripts/dom.
Step 3
We had to implement a partial interface Document with an attribute as styleSheets. The declaration of the interface was done in Document.webidl and its implementation was done in document.rs file. The implementation returned a new instance of StyleSheetList referencing the current document.
Subsequent Steps
Step 1
We will be making changes in the Document.rs
file to make the stylesheets
member store the associated Element
. We're also going to implement the following:
Step 2
We will also implement the .webidl
and .rs
files for the following:
- CSSStyleSheet interface
- CSSRule interface
- CSSRuleList interface
- CSSStyleRule interface
Testing
Following are the steps to run all the tests: 1. Install the pre-requisites required for servo as mentioned here 2. Run the following commands
cd git clone https://github.com/mohammed-alfatih/servo.git cd servo ./mach build --release
Note: It may take around 30 mins to build
./mach test-wpt /tests/wpt/html/dom/interfaces.html
You will see that all tests pass as expected.
Note: There were no predefined test cases mentioned for our project. So now you will see 0 testcases. As far as we know there is no way to test this from UI.
Conclusion
We added the two new interfaces in tests/wpt/mozilla/tests/mozilla/interfaces.html.
References
<references/>