Skip to content

Latest commit

 

History

History
 
 

src

README.md

mORMot Source Code

Folder Content

This folder hosts the source code of the mORMot Open Source framework, version 2.

MPL 1.1/GPL 2.0/LGPL 2.1 three-license

The framework source code is licensed under a disjunctive three-license giving the user the choice of one of the three following sets of free software/open source licensing terms:

  • Mozilla Public License, version 1.1 or later (MPL);
  • GNU General Public License, version 2.0 or later (GPL);
  • GNU Lesser General Public License, version 2.1 or later (LGPL), with linking exception of the FPC modified LGPL. This allows the use of our code in as wide a variety of software projects as possible, while still maintaining copy-left on code we wrote.

See the full licensing terms in the root folder of this repository for more information.

Sub-Folders

The source code tree is split into the following sub-folders:

  • core for low-level shared components like text, RTTI, JSON, compression;
  • lib for external third-party libraries like zlib or openssl;
  • crypt for efficient symmetric/asymmetric cryptography;
  • net for the client/server communication layer;
  • db for our SQLite3 kernel, and SQL/NoSQL direct access;
  • rest for the RESTful client/server processing;
  • orm for high-level ORM features;
  • soa for high-level SOA features;
  • app for hosting (micro)services/daemons and applications;
  • ui for VCL/LCL User Interface oriented components;
  • script for the supported (java)script engines;
  • ddd for Domain-Driven-Design related code;
  • misc for miscellaneous reusable units;
  • tools for some useful tools tied to our framework.

Units Naming

By convention:

  • Unit names are lowercased, to allow simple access on POSIX or Windows file systems;
  • Unit names are dot-separated, and start with the mormot. prefix;
  • Unit names follow their location in the src sub folder, e.g. mormot.core.json.pas is located in the src/core folder.

Types Naming

In respect to mORMot 1.18, some confusing/deprecated naming like TSQLRecord or TSQLRest prefix have been renamed as TOrm and TRest, since our ORM is not SQL-only, but works e.g. with NoSQL engines like MongoDB.

Generally speaking, we followed the Kotlin good naming rules:

When using an acronym as part of a declaration name, capitalize it if it consists of two letters (IOStream); capitalize only the first letter if it is longer (XmlFormatter, HttpInputStream).

Some types have been changed or enhanced:

  • TSQLRawBlob renamed as RawBlob;
  • RawUtf8 is an alias to System.UTF8String type so you can use either of them in your code.

Note that the PUREMORMOT2 conditional can be defined for your project, to disable the type names backward compatible redirection enabled by default. It may be a good idea, because we may relax the backward compatibility in a few years.

Include Files

To clean the design and enhance source maintainability, some units have associated *.inc source files:

  • To regroup Operating-System specific code - e.g. mormot.core.os.posix.inc to include non-Windows OS calls in mormot.core.os.pas;
  • To regroup Compiler-specific code - e.g. mormot.core.rtti.fpc.inc to include FPC RTTI in mormot.core.rtti.pas;
  • To regroup CPU-specific (asm) code - e.g. mormot.crypt.core.asmx64.inc to include x86_64 assembly in mormot.crypt.core.pas.