wiki:Browser_Directory_Overview

Version 2 (modified by Meeh, 5 weeks ago) (diff)

I2P Browser source directory overview

This article provides an overview of what the various directories in the I2P Browser source code directories contains.

The code for all projects in the Mozilla family (such as Firefox, Thunderbird, etc.) is combined into a single source tree. The tree contains the source code as well as the code required to build each project on supported platforms (Linux, Windows, macOS, etc). This document describes the directory structure that can be pulled by client.mk — i.e., directories that are used by at least some of the Mozilla project's client products. There are other directories in the Mozilla CVS repository, such as those for Web tools and those for the Classic codebase.

Root directory

.cargo

Configuration files for the Cargo package manager.

.vscode

Configuration files used by the Visual Studio Code IDE when working in the mozilla-central tree.

accessible

Files for accessibility (i.e., MSAA (Microsoft Active Accessibility), ATK (Accessibility Toolkit, used by GTK+ 2) support files). See Accessibility.

addon-sdk

The add-on SDK for creating Firefox add-ons using standard Web Technologies.

browser

Contains the front end code (in XUL, Javascript, XBL, and C++) for the Firefox browser. Many of these files started off as a copy of files in xpfe/.

browser/extensions

Contains PDF.js and Shumway built-in extensions.

browser/themes

Contains images and CSS files to skin the browser for each OS (Linux, Mac and Windows)

build

Miscellaneous files used by the build process. See also config/.

caps

Capability-based web page security management. It contains C++ interfaces and code for determining the capabilities of content based on the security settings or certificates (e.g., VeriSign?). See Component Security.

chrome

Chrome registry (See here) used with toolkit/. These files were originally copies of files in rdf/chrome/ (SeaMonkey? still uses these).

config

More files used by the build process, common includes for the makefiles, etc. See also build/.

db

Container for database-accessing modules.

db/sqlite3

The SQLite database, used by storage.

devtools

The Firefox Developer Tools server and client components.

docshell

Implementation of the docshell, the main object managing things related to a document window. Each frame has its own docshell. It contains methods for loading URIs, managing URI content listeners, etc. It is the outermost layer of the embedding API used to embed a Gecko browser into an application.

dom

IDL definitions of the interfaces defined by the DOM specifications and Mozilla extensions to those interfaces (implementations of these interfaces are primarily, but not completely, in content/). The parts of the connection between JavaScript? and the implementations of DOM objects that are specific both to JavaScript? and to the DOM. (The parts that are not DOM-specific, i.e., the generic binding between XPCOM and JavaScript?, live in js/src/xpconnect/.) Implementations of a few of the core "DOM Level 0" objects, such as window, window.navigator, window.location, etc.

editor

The editor directory contains C++ interfaces, C++ code, and XUL/Javascript for the embeddable editor component, which is used for the HTML Editor("Composer"), for plain and HTML mail composition, and for text fields and text areas throughout the product. The editor is designed like a "browser window with editing features": it adds some special classes for editing text and managing transaction undo/redo, but reuses browser code for nearly everything else.

Contains:

The backend for HTML and text editing. This is not only used for the mail composer and the page editor composer, but also for rich text editing inside webpages. Textarea and input fields are using such an editor as well (in the plaintext variant). See Mozilla Editor. The frontend for the HTML editor that is part of SeaMonkey?. embedding This directory contains IDL, headers, and support files needed in order to embed Gecko in applications.

extensions

Contains several extensions to mozilla, which can be enabled at compile-time using the —enable-extensions configure argument.

Note that some of these are now built specially and not using the —enable-extensions option. For example, disabling xmlextras is done using —disable-xmlextras.

extensions/auth

Implementation of the negotiate auth method for HTTP and other protocols. Has code for SSPI, GSSAPI, etc. See Integrated Authentication.

extensions/cookie

Permissions backend for cookies, images, etc., as well as the user interface to these permissions and other cookie features.

extensions/pref

Preference-related extensions.

extensions/spellcheck

Spellchecker for mailnews and composer.

extensions/universalchardet

Detects the character encoding of text.

gfx

Contains interfaces that abstract the capabilities of platform specific graphics toolkits, along with implementations on various platforms. These interfaces provide methods for things like drawing images, text, and basic shapes. It also contains basic data structures such as points and rectangles used here and in other parts of Mozilla.

It is also the home of the new graphics architecture based on cairo (via a C++ wrapper called thebes). See NewGFXAPIs and GFXEvolution.

gradle

Containing files related to a JVM (Java Virtual Machine) build system.

hal

Contains platform specified functions (e.g. obtaining battery status, sensor information, memory information, Android alarms/vibrate/notifications/orientation, etc)

image

Image rendering library. Contains decoders for the image formats mozilla supports.

intl

Internationalization and localization support. See L10n:NewProjects.

intl/chardet

Code for "sniffing" the character encoding of Web pages.

intl/locale

Code related to determination of locale information from the operating environment.

intl/lwbrk

Code related to line breaking and word breaking.

intl/strres

Code related to string resources used for localization.

intl/uconv

Code that converts (both ways: encoders and decoders) between UTF-16 and many other character encodings.

intl/unicharutil

Code related to implementation of various algorithms for Unicode text, such as case conversion.

ipc

Container for implementations of IPC (Inter-Process Communication).

js

js/src The JavaScript? engine, also known as SpiderMonkey?. See also JavaScript?.

js/xpconnect

Support code for calling JavaScript? code from C++ code and C++ code from JavaScript? code, using XPCOM interfaces. See XPConnect.

layout

Code that implements a tree of rendering objects that describe the types and locations of the objects that are displayed on the screen (such as CSS boxes, tables, form controls, XUL boxes, etc.), and code that manages operations over that rendering tree (such as creating and destroying it, doing layout, painting, and event handling). See documentation and other information.

layout/base

Code that deals with the rendering tree.

layout/forms

Rendering tree objects for HTML form controls.

layout/generic

The basic rendering object interface and the rendering tree objects for basic CSS boxes.

layout/mathml

Rendering tree objects for MathML.

layout/svg

Rendering tree objects for SVG.

layout/tables

Rendering tree objects for CSS/HTML tables.

layout/xul

Additional rendering object interfaces for XUL and the rendering tree objects for XUL boxes.

media

Contains sources of used media libraries for example libpng.

memory

Cross-platform wrappers for memallocs functions etc.

mfbt

Implementations of classes like WeakPtr?. Multi-platform assertions etc. More on MFBT

# mobile ====

mobile/android

Firefox for Android

modules

Compression/Archiving?, math library, font (and font compression), Preferences Library

modules/libjar

Code to read zip files, used for reading the .jar files that contain the files for the mozilla frontend.

modules/libpref

Library for reading and writing preferences.

modules/zlib

Source code of zlib, used at least in the networking library for compressed transfers.

mozglue

Glue library containing various low-level functionality, including a dynamic linker for Android, a DLL block list for Windows, etc.

netwerk

Networking library, also known as Necko. Responsible for doing actual transfers from and to servers, as well as for URI handling and related stuff. See also Network library documentation.

nsprpub

Netscape Portable Runtime. Used as an abstraction layer to things like threads, file I/O, and socket I/O. See Netscape Portable Runtime.

nsprpub/lib

Mostly unused; might be used on Mac?

other-licenses

Contains libraries that are not covered by the MPL but are used in some mozilla code.

parser

Group of structures and functions needed to parse files based on XML/HTML.

parser/expat

Copy of the expat source code, which is the XML parser used by mozilla.

parser/html

The HTML parser (for everything except about:blank).

parser/htmlparser

The legacy HTML parser that's still used for about:blank. Parts of it are also used for managing the conversion of the network bytestream into Unicode in the XML parsing case.

parser/xml

The code for integrating expat (from parser/expat) into Gecko.

probes

Files related to dtrace.

python

Cross module python code.

python/mach

The code for the Mach building tool.

rdf

RDF handling APIs. See RDF and RDF. Also contains the chrome registry code used by SeaMonkey?, although toolkit apps (such as Firefox and Thunderbird) use the copy forked into chrome.

security

Contains NSS and PSM, to support cryptographic functions in mozilla (like S/MIME, SSL, etc). See Network Security Services (NSS) and Personal Security Manager (PSM).