Thunderbird:Backend Hacking Guide For Newbies

Back to ...

	THIS PAGE IS A WORKING DRAFT
	The page may be difficult to navigate, and some information on its subject might be incomplete and/or evolving rapidly. If you have any questions or ideas, please add them as a new topic on the discussion page.

Back-end Programming for Thunderbird (draft)

So, you love C/C++ and want to contribute to Thunderbird, but you are new to Mozilla development in general, and don't know what frameworks, technologies, tools involved in it. You are at the right place, this page is prepared for you.

First, a little bit background. Thunderbird is a cross-platform mail application developed on top of Mozilla framework. It's an open-source application used by millions, and evolving around its contributors. Mozilla framework is the central toolkit, and C/C++ is the core language for back-end programming. Tier 1 platforms for Thunderbird are Windows, Linux and Mac OS X (both PPC and Intel). So, when you develop code for Thunderbird, you have the obligation to make sure that your code works on all of these platforms, unless it's a platform specific patch.

Mozilla development process is large scale and highly distributed. Tools play an essential role to coordinate this collective effort. Every hacker MUST get familiar with these tools to involve.

Tool Arsenal for Mozilla Development

Build Prerequisites

• Compiler editor settings

• Windows
• Linux
• Mac OS X
• Others

If you wish to build the palm sync extension, you will need to install the Palm CDK (requires free registration).

Debuggers

• MSVC (Windows)
• gdb (Linux, Mac OS X)
• ??

Bug Tracking (and More)

Note: Bugzilla is where people who don't even build / debug can contribute, so this should be at the top of the list. nth10sd 11:13, 17 April 2008 (PDT)

In Mozilla development process 'bug' is a broader term than its conventional meaning which is software defect. A bug means anything related to the product and the development process including feature requests, performance improvements and even process improvements. You can file a bug about almost anything that you think that would contribute to the success of the project.

• Bugzilla Page

A good way to start understanding the Mozilla development process is to join others during a bugday and get familiar with bug triaging. You can find more on bugdays and bug triaging at the following links:

• Thunderbird Bug Triage
• Thunderbird Bugday

Source Control Management

• CVS <link>
• Bonsai <link>

Patching

• Patch

Collaboration

• Pastebin <link>

Build Automation

• Thunderbird Tinderbox
• Tinderstatus for watching Tinderbox status from SeaMonkey or Firefox.
• Performance:Tinderbox_Tests
• MailNews:Performance_Testing
• How to set up a tinderbox (e.g. for standalone/test use)

Community

• IRC
  • Chatzilla
• Newsgroups
• ....

Development Process

Review, Super review <link>

• Licensing

Getting the Source

- <link>

Setting up the Development Environment

• Windows

Note for Windows programmers: If you develop code mostly on Windows and   looking for the same Visual Studio comfort ....

• Mac
• Linux

Building the Code

<link>

Important Components of Mozilla Framework

PL

What is PL? How it is different than platform's C runtime, Secure C functions, etc...

NSPR

NSPR is a cross-platform framework to provide Mozilla application with OS-agnostic facilities such as threading, I/O operations, networking, logging and more. It is crucial for a Mozilla C/C++ hacker to be familiar with this framework in order to work with Thunderbird backend.

Although NSPR documentation is not up-to-date, still it is a very good starting point before you go and check the source code. You can find NSPR documentation at the following links.

• The Netscape Portable Runtime Page
• The Netscape Portable Runtime Reference

NECKO

The mozilla networking library, Necko, is an extensible, scriptable API for client-side networking tasks built on XPCOM and NSPR. It provides:

• generic and extensible framework for fetching URLs
• async framework for pumping data to consumers (i.e., non-blocking i/o)
• generic cache service (LRU data store for mozilla)
• async DNS resolution
• implementations of common protocols (http, ftp, file, imap, etc.)

More info at:

• Necko Home Page
• Source Code
• FAQ
• Necko Interfaces
• Embedding Network Library
• Creating a New Protocol Handler
• Newsgroup - news://news.mozilla.org/netscape.public.mozilla.netlib
• IRC - irc://irc.mozilla.org/#mozilla

XPCOM

XPCOM is Mozilla's simplified cross-platform component object model. IDL firebot: uuid, <link>

• Using nsCOMPtr
• Reference Management
  • Ownership Guide
  • Weak References
• Creating XPCOM Components
• XPCOM string guide

XUL

What is XUL

Best Practices

Memory allocation

<link>

nsCOMPtr<>

<link>

Assertions

....

Understand how to log, trace etc.

• Performance:Leak_Tools
• Debugging Memory Leaks
• QA:Home_Page:Firefox_3.0_TestPlan:Leaks:LeakTesting-How-To
• Mail Logging/Troubleshotting
• LDAP Protocol Logging

...

Understanding threading, Proxy etc.. !!!

... + <link>

Unit Testing (TUnit, cppUnit etc..)

• Mozilla Automated Testing
• MailNews:Performance_Testing

....

Development tools

 o Locklint
 o Firebug
 o

Common Idioms, and Patterns

.... Event sinks, bounded buffers, monitors etc.. .... PR_SUCESS, PR_FAIL ....

Advanced Topics

... Instrumentation, optimization, performance etc...

Sample Projects

• Sample project to learn how to patch and how to submit a patch
• Using NSPR in your applications

 MSVC project
 XCODE project
 SlickeEdit project??
 Eclipse??

• XPCOM: Developing an XP component and running it in a standalone application

 MSVC project
 XCODE project
 SlickeEdit project??
 Eclipse??

• ...

Components of Thunderbird

• MIME
• IMAP
• Address Book
• ...