directory-structure.md

Directory Structure

The project is seperated into different directories. This document explains what each folder contains.

• bin is the auto-generated directory for object files. Note however that the main executable is the ./engine file.
• data is the directory of small parsers/converters.
  • text is the directory for the Unicode header and Unicode String class.
    • encoding is the directory for the encodings.
• docs
• dom is the implementation of the Document Object Model.
• misc is the directory for small stuff not related to any big subjects.
• net is the network layer. This uses — at the moment — POSIX/UNIX sockets and an abstract TLS implementation (this is currently set to use the libssl/OpenSSL library).
  • http is the HTTP/1.1 network layer implementation, which is used to retrieve documents and resources.
• parser is the directory for major parsers (see data for small parser/converters).
  • css is the directory for the CSS parser, which should follow the CSS Standards.
  • html is the directory for the HTML parser, which should follow the HTML Living Standard.
    • tokenizer are the modularized parts of the HTML tokenizer.
    • tree is the directory for the HTML Tree Constructor.
• rendering is the directory for rendering/painting the UI, webpage, etc.
  • drawables is the directory for all things that derive from RenderObject, which is a part of the renderer to draw. This will include text, rects, assets (images, videos, audio, etc.)
  • opengl is the OpenGL implementation of the Renderer class.
  • window is the directory containing window system/manager communicators. These are seperate from the renderer to avoid code duplication between platforms.
• resources contains files which are pulled from the internet or from local storage.
• testing contains GoogleTest files
• tools contains various custom made tools for this project