A powerful and feature-rich JS O N library for MQ L5, designed to bring a modern development experience similar to Python/JS
This is a powerful addition to your MetaTrader 5 toolkit designed to optimize market analysis and performance. This library provides a collection of modular, reusable code. It is utilized by developers to organize common functions, allowing for the integration of complex logic across multiple Expert Advisors, indicators, or scripts without the need for code duplication.
How to Setup and Use A powerful and feature-rich JS O N library for MQ L5, designed to bring a modern development experience similar to Python/JS
1. Storage: Place library files in the MQL/Libraries directory to ensure they are accessible to your projects.
2. Implementation: Include the library in your code using the #import directive, ensuring you match the exact function names and parameters.
3. Compilation: Ensure the library is present in the directory before you compile your main EA or script, as the compiler links them during this phase.
4. Management: Keep libraries organized in sub-folders if you manage many custom functions to maintain a clean project structure.
Frequently Asked Questions
Q: What is a library file used for? A: Libraries store reusable code modules, allowing you to centralize common logic used by multiple EAs or indicators.
Q: Is a library executable? A: No, libraries are non-executable files containing functions; they must be imported into an EA, indicator, or script to function.
Q: Can I update a library while the platform is running? A: You should compile your EA or script after updating a library to ensure the latest code changes are integrated.
Description & Settings
1. Overview
The MQL5 JSON Library is a powerful,feature-rich library designed specifically for parsing, manipulating, and serializing JSON data within the MQL5 environment. It provides a simple and intuitive Document Object Model (DOM) API, aiming to make the JSON handling experience in MQL5 comparable to modern programming languages like JavaScript and Python.
This library is capable of handling a wide range of tasks, from reading simple EA configurations to complex real-time data exchange between systems. Its main functions and features include:
--- Parsing and Creation ---
Load from String or File
: Reliably parses JSON text into manipulable in-memory objects ( JsonParse , JsonFromFile ).
Build from Scratch
: Easily create new JSON objects and arrays programmatically using concise APIs like JsonNewObject and JsonNewArray .
Flexible Parser
: Optionally supports some non-standard features of JSON5, such as code comments and trailing commas, to enhance compatibility with various data sources.
--- Manipulation and Access ---
Intuitive DOM Traversal
: Access data using intuitive syntax with keys ( node["key"] ) and indices ( node[0] ), just like using a Python dictionary or a JavaScript object.
Dynamic Modification
: Freely add, update, or delete key-value pairs in JSON objects and elements in arrays ( Set , Add , Remove ).
--- Advanced Querying and Processing ---
Powerful Query Engine
: Built-in support for
JSON Pointer
(RFC 6901, for direct path access) and
JSONPath
(for complex and fuzzy queries), enabling efficient extraction of one or more data nodes from deeply nested, complex structures, either in bulk or with precision.
Low-Memory Stream Parsing
: Provides JsonStreamParser for processing gigabyte-scale, huge JSON files. It reads the file token by token in an event stream manner without loading the entire file into memory, thus achieving ultimate memory efficiency.
Utility Functions
: Offers advanced features like document cloning ( .Clone() ) and deep merging ( JsonMerge ), which greatly simplify common complex tasks such as merging "default configuration" with "user configuration".
--- Robustness and Safety ---
Automatic Memory Management
: Adopts the RAII (Resource Acquisition Is Initialization) design pattern. JsonDocument is responsible for managing the lifecycle of all its nodes. Developers do not need to manually new / delete any JSON elements, fundamentally eliminating the risk of memory leaks.
Cross-Document Operation Safety
: When assigning a node between different JsonDocument instances, the library automatically performs a safe deep copy (Clone), preventing dangling pointers and accidental data corruption.
Detailed Error Reporting
: When parsing fails, the JsonError object provides detailed information including the error line number, column number, and context, facilitating rapid problem diagnosis.
2. Core Concepts & Memory Management
[!!] 2.1 Namespace - The Key to Integrating Your Project [!!]
Most Important Tip
: All classes in this library (e.g., JsonDocument , JsonNode ) and global functions (e.g., JsonParse ) are encapsulated within a namespace called MQL5_Json .
**How to Use It Correctly:** - **In Header Files (.mqh)**: MQL5 does not allow `using namespace` in the global scope of header files. **Therefore, you must use fully qualified names**. This is the only reliable way in multi-file projects. Incorrect: `JsonDocument doc;` Correct: `MQL5_Json::JsonDocument doc;` - **Inside Functions in Main Program Files (.mq5)**: For convenience, you can use `using namespace MQL5_Json;` inside functions, but to ensure the generality of the examples, all code in this manual will use the fully qualified name approach. **If you encounter the `'JsonNode' - declaration without type` compilation error,** **it is almost always because you forgot to add the `MQL5_Json::` prefix** **to the types and functions.**
[!!] 2.2 Memory Management Model JsonDocument
owns
the data; JsonNode is just a
view
.
[!!] 2.3 Object Passing in MQL5 MQL5 requires that all class objects (including JsonNode ) passed as function arguments
must be passed by reference (using &)
. Incorrect: void myFunction(MQL5_Json::JsonNode node) Correct: void myFunction(MQL5_Json::JsonNode &node
